Import upstream version 1.2.6+git20210530.1.fc3faca
Kali Janitor
2 years ago
| 0 | pysmb-1.2.7, 30 May 2021 | |
| 1 | ======================== | |
| 2 | ||
| 3 | - Fix compatibility issues on file retrievals with Likewise servers (#177) | |
| 4 | - Improve SMBConnection's connect() method to remove the need to provide sock_family | |
| 5 | parameter for IPv6 addresses in Python 3.x (#180) | |
| 6 | ||
| 7 | pysmb-1.2.6, 9 Dec 2020 | |
| 8 | ======================= | |
| 9 | - Fix bug in SMB1 store file implmentation which generates SMB_COM_WRITE_ANDX | |
| 10 | packets larger than the allowed max buffer size (#175) | |
| 11 | ||
| 12 | pysmb-1.2.5, 18 Oct 2020 | |
| 13 | ======================= | |
| 14 | - Fix bug in filename encoding which leads to failure for file retrieval and upload operations (#170 #171). | |
| 15 | - Improve resetFileAttributes() method in SMBConnection class to allow the | |
| 16 | new attribute to be specified in the reset operation (#172). | |
| 17 | ||
| 18 | pysmb-1.2.4, 6 Oct 2020 | |
| 19 | ======================= | |
| 20 | - Remove dependency on pycrypto as it is no longer under active maintenance | |
| 21 | ||
| 22 | pysmb-1.2.3, 6 Oct 2020 | |
| 23 | ======================= | |
| 24 | - Fix bug in session key generation during session negotiation (#166) | |
| 25 | - Fix bug in SMB message signing which leads to operation failures with Samba services. | |
| 26 | ||
| 27 | pysmb-1.2.2, 5 Sep 2020 | |
| 28 | ======================= | |
| 29 | - Improve SMB URL handlers to support specifying server's machine name and IP | |
| 30 | address. (#162) | |
| 31 | - Improvements to documentation on SMB URLs (#160) | |
| 32 | ||
| 33 | pysmb-1.2.1, 17 May 2020 | |
| 34 | ======================== | |
| 35 | - Fix bug in deleteFiles() method which can fail for certain search patterns. | |
| 36 | ||
| 37 | pysmb-1.2.0, 17 May 2020 | |
| 38 | ========================= | |
| 39 | - Add new parameter, delete_matching_folders, to deleteFiles() method to | |
| 40 | support deletion of child folders that match the search pattern. | |
| 41 | ||
| 42 | pysmb-1.1.29, 16 May 2020 | |
| 43 | ========================= | |
| 44 | - Fix unhandled exception for short NBNS queries #149 | |
| 45 | - Fix wildcard file deletion with servers on SMB2 protocol #33 | |
| 46 | ||
| 47 | pysmb-1.1.28, 23 Nov 2019 | |
| 48 | ======================== | |
| 49 | - SharedFile instances returned from the listPath() method now has a new | |
| 50 | file_id attribute which represents the file reference number given by the SMB server. | |
| 51 | ||
| 52 | pysmb-1.1.27, 9 Jan 2019 | |
| 53 | ======================== | |
| 54 | - Remove support for SMB-2.1 dialect as it seems to have issues with Windows 2008 R2 | |
| 55 | ||
| 56 | pysmb-1.1.26, 5 Jan 2019 | |
| 57 | ======================== | |
| 58 | - Prevents OperationError from being raised when listPath() operation does not | |
| 59 | return any matching file results. | |
| 60 | - SMBConnection is now a context manager #122. | |
| 61 | ||
| 62 | pysmb-1.1.25, 28 July 2018 | |
| 63 | ======================== | |
| 64 | - Fix buggy support for search parameter in listPath() method. Add | |
| 65 | SMB_FILE_ATTRIBUTE_INCL_NORMAL bit constant to include 'normal' files with | |
| 66 | other file types in the returned result. From now on, pysmb defines a 'normal' file | |
| 67 | as a file entry that is not read-only, not hidden, not system, not archive and | |
| 68 | not a directory; it ignores other attributes like compression, indexed, sparse, | |
| 69 | temporary and encryption. listPath() method will now include 'normal' files | |
| 70 | using the default search parameter. | |
| 71 | - Add isNormal property to SharedFile class to support test if the file is a | |
| 72 | 'normal' file (according to pysmb definition of 'normal' file). | |
| 73 | ||
| 74 | pysmb-1.1.24, 19 July 2018 | |
| 75 | ======================== | |
| 76 | - Improve listPath implementation for SMB1 | |
| 77 | - Support for STATUS_PENDING responses across all SMB2 operations. | |
| 78 | ||
| 79 | pysmb-1.1.23, 5 May 2018 | |
| 80 | ======================== | |
| 81 | - Fix bug in listShares() method which fails when the remote server has many shares. | |
| 82 | - Improve echo() method to test and fail if the provided data to echo is not a bytes object. | |
| 83 | - Fix bug in listPath() method where the path to query is not properly terminated. | |
| 84 | ||
| 85 | pysmb-1.1.22, 17 Sep 2017 | |
| 86 | ======================== | |
| 87 | - Fix bug in getAttributes() method which should return only the filename | |
| 88 | instead of the entire path for the filename property for the return result. | |
| 89 | ||
| 90 | pysmb-1.1.21, 9 Sep 2017 | |
| 91 | ======================== | |
| 92 | - Fix bug where timestamp values for SMB1 getAttributes() response are not | |
| 93 | converted properly from FILETIME to epoch time values. | |
| 94 | ||
| 95 | pysmb-1.1.20, 13 Aug 2017 | |
| 96 | ========================= | |
| 97 | - Add getSecurity() method to support security descriptors query via SMB2 | |
| 98 | - Improve retrieveFile() and retrieveFileFromOffset() methods to allow file | |
| 99 | retrievals over SMB2 even when the file is being locked on the server. | |
| 100 | - Silently discards NMB SESSION_KEEPALIVE packets instead of raising warnings. | |
| 101 | - SMB sessionID will be sent in ECHO requests to conform to SMB2 specs. | |
| 102 | - Fix type errors for MD4 functions in python3. | |
| 103 | ||
| 0 | 104 | pysmb-1.1.19, 13 Nov 2016 |
| 1 | ======================== | |
| 105 | ========================= | |
| 2 | 106 | - Ignore STATUS_PENDING during delete and file store operations |
| 3 | 107 | |
| 4 | 108 | pysmb-1.1.18, 9 Apr 2016 |
| 0 | 0 | |
| 1 | Copyright (C) 2001-2015 Michael Teo <miketeo (a) miketeo.net> | |
| 1 | Copyright (C) 2001-2020 Michael Teo <miketeo (a) miketeo.net> | |
| 2 | 2 | |
| 3 | 3 | This software is provided 'as-is', without any express or implied warranty. |
| 4 | 4 | In no event will the author be held liable for any damages arising from the |
| 0 | include LICENSE | |
| 1 | include CHANGELOG | |
| 2 | recursive-include python2 * | |
| 3 | recursive-exclude python2 *.pyc | |
| 4 | recursive-exclude python2 *~ | |
| 5 | recursive-include python3 * | |
| 6 | recursive-exclude python3 *.pyc | |
| 7 | recursive-exclude python3 *~ | |
| 8 | recursive-include sphinx * | |
| 9 | recursive-include docs * | |
| 10 | recursive-exclude docs *.zip |
| 0 | 0 | Metadata-Version: 1.1 |
| 1 | 1 | Name: pysmb |
| 2 | Version: 1.1.19 | |
| 2 | Version: 1.2.7 | |
| 3 | 3 | Summary: pysmb is an experimental SMB/CIFS library written in Python to support file sharing between Windows and Linux machines |
| 4 | 4 | Home-page: https://miketeo.net/projects/pysmb |
| 5 | 5 | Author: Michael Teo |
Binary diff not shown
Binary diff not shown
Binary diff not shown
Binary diff not shown
Binary diff not shown
Binary diff not shown
Binary diff not shown
Binary diff not shown
Binary diff not shown
Binary diff not shown
Binary diff not shown
Binary diff not shown
Binary diff not shown
| 0 | 0 | # Sphinx build info version 1 |
| 1 | 1 | # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. |
| 2 | config: 8ec856095809db2990831edf01ebc5a4 | |
| 2 | config: 6727d573e921f0a52e9dd64da58c662b | |
| 3 | 3 | tags: 645f666f9bcd5a90fca523b33c5a78b7 |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | 0 | |
| 1 | <!DOCTYPE html> | |
| 3 | 2 | |
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>Overview: module code — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>Overview: module code — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../index.html" /> | |
| 26 | </head> | |
| 27 | <body role="document"> | |
| 10 | <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> | |
| 11 | <script src="../_static/jquery.js"></script> | |
| 12 | <script src="../_static/underscore.js"></script> | |
| 13 | <script src="../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../search.html" /> | |
| 16 | </head><body> | |
| 28 | 17 | <div class="related" role="navigation" aria-label="related navigation"> |
| 29 | 18 | <h3>Navigation</h3> |
| 30 | 19 | <ul> |
| 31 | 20 | <li class="right" style="margin-right: 10px"> |
| 32 | 21 | <a href="../genindex.html" title="General Index" |
| 33 | 22 | accesskey="I">index</a></li> |
| 34 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 23 | <li class="right" > | |
| 24 | <a href="../py-modindex.html" title="Python Module Index" | |
| 25 | >modules</a> |</li> | |
| 26 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 27 | <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li> | |
| 35 | 28 | </ul> |
| 36 | </div> | |
| 37 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 38 | <div class="sphinxsidebarwrapper"> | |
| 39 | <div id="searchbox" style="display: none" role="search"> | |
| 40 | <h3>Quick search</h3> | |
| 41 | <form class="search" action="../search.html" method="get"> | |
| 42 | <input type="text" name="q" /> | |
| 43 | <input type="submit" value="Go" /> | |
| 44 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 45 | <input type="hidden" name="area" value="default" /> | |
| 46 | </form> | |
| 47 | <p class="searchtip" style="font-size: 90%"> | |
| 48 | Enter search terms or a module, class or function name. | |
| 49 | </p> | |
| 50 | </div> | |
| 51 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 52 | </div> | |
| 53 | </div> | |
| 29 | </div> | |
| 54 | 30 | |
| 55 | 31 | <div class="document"> |
| 56 | 32 | <div class="documentwrapper"> |
| 63 | 39 | <li><a href="smb/SMBConnection.html">smb.SMBConnection</a></li> |
| 64 | 40 | <li><a href="smb/SMBProtocol.html">smb.SMBProtocol</a></li> |
| 65 | 41 | <li><a href="smb/base.html">smb.base</a></li> |
| 42 | <li><a href="smb/security_descriptors.html">smb.security_descriptors</a></li> | |
| 66 | 43 | <li><a href="smb/smb_structs.html">smb.smb_structs</a></li> |
| 67 | 44 | </ul> |
| 68 | 45 | |
| 46 | <div class="clearer"></div> | |
| 69 | 47 | </div> |
| 48 | </div> | |
| 49 | </div> | |
| 50 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 51 | <div class="sphinxsidebarwrapper"> | |
| 52 | <div id="searchbox" style="display: none" role="search"> | |
| 53 | <h3 id="searchlabel">Quick search</h3> | |
| 54 | <div class="searchformwrapper"> | |
| 55 | <form class="search" action="../search.html" method="get"> | |
| 56 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 57 | <input type="submit" value="Go" /> | |
| 58 | </form> | |
| 59 | </div> | |
| 60 | </div> | |
| 61 | <script>$('#searchbox').show(0);</script> | |
| 70 | 62 | </div> |
| 71 | 63 | </div> |
| 72 | 64 | <div class="clearer"></div> |
| 77 | 69 | <li class="right" style="margin-right: 10px"> |
| 78 | 70 | <a href="../genindex.html" title="General Index" |
| 79 | 71 | >index</a></li> |
| 80 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 72 | <li class="right" > | |
| 73 | <a href="../py-modindex.html" title="Python Module Index" | |
| 74 | >modules</a> |</li> | |
| 75 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 76 | <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li> | |
| 81 | 77 | </ul> |
| 82 | 78 | </div> |
| 83 | 79 | <div class="footer" role="contentinfo"> |
| 84 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 85 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 80 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 81 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 86 | 82 | </div> |
| 87 | 83 | </body> |
| 88 | 84 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | ||
| 3 | ||
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 0 | ||
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>nmb.NetBIOS — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>nmb.NetBIOS — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../../index.html" /> | |
| 26 | <link rel="up" title="Module code" href="../index.html" /> | |
| 27 | </head> | |
| 28 | <body role="document"> | |
| 10 | <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> | |
| 11 | <script src="../../_static/jquery.js"></script> | |
| 12 | <script src="../../_static/underscore.js"></script> | |
| 13 | <script src="../../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../../search.html" /> | |
| 16 | </head><body> | |
| 29 | 17 | <div class="related" role="navigation" aria-label="related navigation"> |
| 30 | 18 | <h3>Navigation</h3> |
| 31 | 19 | <ul> |
| 32 | 20 | <li class="right" style="margin-right: 10px"> |
| 33 | 21 | <a href="../../genindex.html" title="General Index" |
| 34 | 22 | accesskey="I">index</a></li> |
| 35 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 36 | <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> | |
| 23 | <li class="right" > | |
| 24 | <a href="../../py-modindex.html" title="Python Module Index" | |
| 25 | >modules</a> |</li> | |
| 26 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 27 | <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> | |
| 28 | <li class="nav-item nav-item-this"><a href="">nmb.NetBIOS</a></li> | |
| 37 | 29 | </ul> |
| 38 | </div> | |
| 39 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 40 | <div class="sphinxsidebarwrapper"> | |
| 41 | <div id="searchbox" style="display: none" role="search"> | |
| 42 | <h3>Quick search</h3> | |
| 43 | <form class="search" action="../../search.html" method="get"> | |
| 44 | <input type="text" name="q" /> | |
| 45 | <input type="submit" value="Go" /> | |
| 46 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 47 | <input type="hidden" name="area" value="default" /> | |
| 48 | </form> | |
| 49 | <p class="searchtip" style="font-size: 90%"> | |
| 50 | Enter search terms or a module, class or function name. | |
| 51 | </p> | |
| 52 | </div> | |
| 53 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 54 | </div> | |
| 55 | </div> | |
| 30 | </div> | |
| 56 | 31 | |
| 57 | 32 | <div class="document"> |
| 58 | 33 | <div class="documentwrapper"> |
| 60 | 35 | <div class="body" role="main"> |
| 61 | 36 | |
| 62 | 37 | <h1>Source code for nmb.NetBIOS</h1><div class="highlight"><pre> |
| 63 | ||
| 38 | <span></span> | |
| 64 | 39 | <span class="kn">import</span> <span class="nn">os</span><span class="o">,</span> <span class="nn">logging</span><span class="o">,</span> <span class="nn">random</span><span class="o">,</span> <span class="nn">socket</span><span class="o">,</span> <span class="nn">time</span><span class="o">,</span> <span class="nn">select</span> |
| 65 | <span class="kn">from</span> <span class="nn">base</span> <span class="kn">import</span> <span class="n">NBNS</span><span class="p">,</span> <span class="n">NotConnectedError</span> | |
| 66 | <span class="kn">from</span> <span class="nn">nmb_constants</span> <span class="kn">import</span> <span class="n">TYPE_CLIENT</span><span class="p">,</span> <span class="n">TYPE_SERVER</span><span class="p">,</span> <span class="n">TYPE_WORKSTATION</span> | |
| 40 | <span class="kn">from</span> <span class="nn">.base</span> <span class="kn">import</span> <span class="n">NBNS</span><span class="p">,</span> <span class="n">NotConnectedError</span> | |
| 41 | <span class="kn">from</span> <span class="nn">.nmb_constants</span> <span class="kn">import</span> <span class="n">TYPE_CLIENT</span><span class="p">,</span> <span class="n">TYPE_SERVER</span><span class="p">,</span> <span class="n">TYPE_WORKSTATION</span> | |
| 67 | 42 | |
| 68 | 43 | <div class="viewcode-block" id="NetBIOS"><a class="viewcode-back" href="../../api/nmb_NetBIOS.html#nmb.NetBIOS.NetBIOS">[docs]</a><span class="k">class</span> <span class="nc">NetBIOS</span><span class="p">(</span><span class="n">NBNS</span><span class="p">):</span> |
| 69 | 44 | |
| 70 | 45 | <span class="n">log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s1">'NMB.NetBIOS'</span><span class="p">)</span> |
| 71 | 46 | |
| 72 | <div class="viewcode-block" id="NetBIOS.__init__"><a class="viewcode-back" href="../../api/nmb_NetBIOS.html#nmb.NetBIOS.NetBIOS.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">broadcast</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span> <span class="n">listen_port</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> | |
| 47 | <div class="viewcode-block" id="NetBIOS.__init__"><a class="viewcode-back" href="../../api/nmb_NetBIOS.html#nmb.NetBIOS.NetBIOS.__init__">[docs]</a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">broadcast</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">listen_port</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> | |
| 73 | 48 | <span class="sd">"""</span> |
| 74 | 49 | <span class="sd"> Instantiate a NetBIOS instance, and creates a IPv4 UDP socket to listen/send NBNS packets.</span> |
| 75 | 50 | |
| 92 | 67 | <span class="sd"> :return: None</span> |
| 93 | 68 | <span class="sd"> """</span> |
| 94 | 69 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| 95 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span> <span class="o">=</span> <span class="bp">None</span></div> | |
| 70 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span> <span class="o">=</span> <span class="kc">None</span></div> | |
| 96 | 71 | |
| 97 | 72 | <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">ip</span><span class="p">,</span> <span class="n">port</span><span class="p">):</span> |
| 98 | 73 | <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="p">,</span> <span class="s1">'Socket is already closed'</span> |
| 136 | 111 | <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="p">,</span> <span class="s1">'Socket is already closed'</span> |
| 137 | 112 | |
| 138 | 113 | <span class="n">trn_id</span> <span class="o">=</span> <span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mh">0xFFFF</span><span class="p">)</span> |
| 139 | <span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">prepareNetNameQuery</span><span class="p">(</span><span class="n">trn_id</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span> | |
| 114 | <span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">prepareNetNameQuery</span><span class="p">(</span><span class="n">trn_id</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> | |
| 140 | 115 | <span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">ip</span><span class="p">,</span> <span class="n">port</span><span class="p">)</span> |
| 141 | 116 | <span class="n">ret</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pollForQueryPacket</span><span class="p">(</span><span class="n">trn_id</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> |
| 142 | 117 | <span class="k">if</span> <span class="n">ret</span><span class="p">:</span> |
| 143 | <span class="k">return</span> <span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="n">TYPE_SERVER</span><span class="p">,</span> <span class="n">ret</span><span class="p">))</span> | |
| 118 | <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="n">TYPE_SERVER</span><span class="p">,</span> <span class="n">ret</span><span class="p">)))</span> | |
| 144 | 119 | <span class="k">else</span><span class="p">:</span> |
| 145 | <span class="k">return</span> <span class="bp">None</span></div> | |
| 120 | <span class="k">return</span> <span class="kc">None</span></div> | |
| 146 | 121 | |
| 147 | 122 | <span class="c1">#</span> |
| 148 | 123 | <span class="c1"># Protected Methods</span> |
| 149 | 124 | <span class="c1">#</span> |
| 150 | 125 | |
| 151 | 126 | <span class="k">def</span> <span class="nf">_pollForNetBIOSPacket</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">wait_trn_id</span><span class="p">,</span> <span class="n">timeout</span><span class="p">):</span> |
| 152 | <span class="n">end_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">+</span> <span class="n">timeout</span> | |
| 153 | <span class="k">while</span> <span class="bp">True</span><span class="p">:</span> | |
| 127 | <span class="n">end_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">-</span> <span class="n">timeout</span> | |
| 128 | <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> | |
| 154 | 129 | <span class="k">try</span><span class="p">:</span> |
| 155 | <span class="n">_timeout</span> <span class="o">=</span> <span class="n">end_time</span> <span class="o">-</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> | |
| 130 | <span class="n">_timeout</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span><span class="o">-</span><span class="n">end_time</span> | |
| 156 | 131 | <span class="k">if</span> <span class="n">_timeout</span> <span class="o"><=</span> <span class="mi">0</span><span class="p">:</span> |
| 157 | <span class="k">return</span> <span class="bp">None</span> | |
| 132 | <span class="k">return</span> <span class="kc">None</span> | |
| 158 | 133 | |
| 159 | 134 | <span class="n">ready</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">select</span><span class="o">.</span><span class="n">select</span><span class="p">([</span> <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="o">.</span><span class="n">fileno</span><span class="p">()</span> <span class="p">],</span> <span class="p">[</span> <span class="p">],</span> <span class="p">[</span> <span class="p">],</span> <span class="n">_timeout</span><span class="p">)</span> |
| 160 | 135 | <span class="k">if</span> <span class="ow">not</span> <span class="n">ready</span><span class="p">:</span> |
| 161 | <span class="k">return</span> <span class="bp">None</span> | |
| 136 | <span class="k">return</span> <span class="kc">None</span> | |
| 162 | 137 | |
| 163 | 138 | <span class="n">data</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="o">.</span><span class="n">recvfrom</span><span class="p">(</span><span class="mh">0xFFFF</span><span class="p">)</span> |
| 164 | 139 | <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 168 | 143 | |
| 169 | 144 | <span class="k">if</span> <span class="n">trn_id</span> <span class="o">==</span> <span class="n">wait_trn_id</span><span class="p">:</span> |
| 170 | 145 | <span class="k">return</span> <span class="n">ret</span> |
| 171 | <span class="k">except</span> <span class="n">select</span><span class="o">.</span><span class="n">error</span><span class="p">,</span> <span class="n">ex</span><span class="p">:</span> | |
| 172 | <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">ex</span><span class="p">)</span> <span class="ow">is</span> <span class="n">types</span><span class="o">.</span><span class="n">TupleType</span><span class="p">:</span> | |
| 146 | <span class="k">except</span> <span class="n">select</span><span class="o">.</span><span class="n">error</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span> | |
| 147 | <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">ex</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">tuple</span><span class="p">:</span> | |
| 173 | 148 | <span class="k">if</span> <span class="n">ex</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">EINTR</span> <span class="ow">and</span> <span class="n">ex</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">EAGAIN</span><span class="p">:</span> |
| 174 | 149 | <span class="k">raise</span> <span class="n">ex</span> |
| 175 | 150 | <span class="k">else</span><span class="p">:</span> |
| 179 | 154 | <span class="c1"># Contributed by Jason Anderson</span> |
| 180 | 155 | <span class="c1">#</span> |
| 181 | 156 | <span class="k">def</span> <span class="nf">_pollForQueryPacket</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">wait_trn_id</span><span class="p">,</span> <span class="n">timeout</span><span class="p">):</span> |
| 182 | <span class="n">end_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">+</span> <span class="n">timeout</span> | |
| 183 | <span class="k">while</span> <span class="bp">True</span><span class="p">:</span> | |
| 157 | <span class="n">end_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">-</span> <span class="n">timeout</span> | |
| 158 | <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> | |
| 184 | 159 | <span class="k">try</span><span class="p">:</span> |
| 185 | <span class="n">_timeout</span> <span class="o">=</span> <span class="n">end_time</span> <span class="o">-</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> | |
| 160 | <span class="n">_timeout</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span><span class="o">-</span><span class="n">end_time</span> | |
| 186 | 161 | <span class="k">if</span> <span class="n">_timeout</span> <span class="o"><=</span> <span class="mi">0</span><span class="p">:</span> |
| 187 | <span class="k">return</span> <span class="bp">None</span> | |
| 162 | <span class="k">return</span> <span class="kc">None</span> | |
| 188 | 163 | |
| 189 | 164 | <span class="n">ready</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">select</span><span class="o">.</span><span class="n">select</span><span class="p">([</span> <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="o">.</span><span class="n">fileno</span><span class="p">()</span> <span class="p">],</span> <span class="p">[</span> <span class="p">],</span> <span class="p">[</span> <span class="p">],</span> <span class="n">_timeout</span><span class="p">)</span> |
| 190 | 165 | <span class="k">if</span> <span class="ow">not</span> <span class="n">ready</span><span class="p">:</span> |
| 191 | <span class="k">return</span> <span class="bp">None</span> | |
| 166 | <span class="k">return</span> <span class="kc">None</span> | |
| 192 | 167 | |
| 193 | 168 | <span class="n">data</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="o">.</span><span class="n">recvfrom</span><span class="p">(</span><span class="mh">0xFFFF</span><span class="p">)</span> |
| 194 | 169 | <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 198 | 173 | |
| 199 | 174 | <span class="k">if</span> <span class="n">trn_id</span> <span class="o">==</span> <span class="n">wait_trn_id</span><span class="p">:</span> |
| 200 | 175 | <span class="k">return</span> <span class="n">ret</span> |
| 201 | <span class="k">except</span> <span class="n">select</span><span class="o">.</span><span class="n">error</span><span class="p">,</span> <span class="n">ex</span><span class="p">:</span> | |
| 202 | <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">ex</span><span class="p">)</span> <span class="ow">is</span> <span class="n">types</span><span class="o">.</span><span class="n">TupleType</span><span class="p">:</span> | |
| 176 | <span class="k">except</span> <span class="n">select</span><span class="o">.</span><span class="n">error</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span> | |
| 177 | <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">ex</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">tuple</span><span class="p">:</span> | |
| 203 | 178 | <span class="k">if</span> <span class="n">ex</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">EINTR</span> <span class="ow">and</span> <span class="n">ex</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">EAGAIN</span><span class="p">:</span> |
| 204 | 179 | <span class="k">raise</span> <span class="n">ex</span> |
| 205 | 180 | <span class="k">else</span><span class="p">:</span> |
| 206 | 181 | <span class="k">raise</span> <span class="n">ex</span></div> |
| 207 | 182 | </pre></div> |
| 208 | 183 | |
| 184 | <div class="clearer"></div> | |
| 209 | 185 | </div> |
| 186 | </div> | |
| 187 | </div> | |
| 188 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 189 | <div class="sphinxsidebarwrapper"> | |
| 190 | <div id="searchbox" style="display: none" role="search"> | |
| 191 | <h3 id="searchlabel">Quick search</h3> | |
| 192 | <div class="searchformwrapper"> | |
| 193 | <form class="search" action="../../search.html" method="get"> | |
| 194 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 195 | <input type="submit" value="Go" /> | |
| 196 | </form> | |
| 197 | </div> | |
| 198 | </div> | |
| 199 | <script>$('#searchbox').show(0);</script> | |
| 210 | 200 | </div> |
| 211 | 201 | </div> |
| 212 | 202 | <div class="clearer"></div> |
| 217 | 207 | <li class="right" style="margin-right: 10px"> |
| 218 | 208 | <a href="../../genindex.html" title="General Index" |
| 219 | 209 | >index</a></li> |
| 220 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 221 | <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> | |
| 210 | <li class="right" > | |
| 211 | <a href="../../py-modindex.html" title="Python Module Index" | |
| 212 | >modules</a> |</li> | |
| 213 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 214 | <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> | |
| 215 | <li class="nav-item nav-item-this"><a href="">nmb.NetBIOS</a></li> | |
| 222 | 216 | </ul> |
| 223 | 217 | </div> |
| 224 | 218 | <div class="footer" role="contentinfo"> |
| 225 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 226 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 219 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 220 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 227 | 221 | </div> |
| 228 | 222 | </body> |
| 229 | 223 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | ||
| 3 | ||
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 0 | ||
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>nmb.NetBIOSProtocol — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>nmb.NetBIOSProtocol — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../../index.html" /> | |
| 26 | <link rel="up" title="Module code" href="../index.html" /> | |
| 27 | </head> | |
| 28 | <body role="document"> | |
| 10 | <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> | |
| 11 | <script src="../../_static/jquery.js"></script> | |
| 12 | <script src="../../_static/underscore.js"></script> | |
| 13 | <script src="../../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../../search.html" /> | |
| 16 | </head><body> | |
| 29 | 17 | <div class="related" role="navigation" aria-label="related navigation"> |
| 30 | 18 | <h3>Navigation</h3> |
| 31 | 19 | <ul> |
| 32 | 20 | <li class="right" style="margin-right: 10px"> |
| 33 | 21 | <a href="../../genindex.html" title="General Index" |
| 34 | 22 | accesskey="I">index</a></li> |
| 35 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 36 | <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> | |
| 23 | <li class="right" > | |
| 24 | <a href="../../py-modindex.html" title="Python Module Index" | |
| 25 | >modules</a> |</li> | |
| 26 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 27 | <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> | |
| 28 | <li class="nav-item nav-item-this"><a href="">nmb.NetBIOSProtocol</a></li> | |
| 37 | 29 | </ul> |
| 38 | </div> | |
| 39 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 40 | <div class="sphinxsidebarwrapper"> | |
| 41 | <div id="searchbox" style="display: none" role="search"> | |
| 42 | <h3>Quick search</h3> | |
| 43 | <form class="search" action="../../search.html" method="get"> | |
| 44 | <input type="text" name="q" /> | |
| 45 | <input type="submit" value="Go" /> | |
| 46 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 47 | <input type="hidden" name="area" value="default" /> | |
| 48 | </form> | |
| 49 | <p class="searchtip" style="font-size: 90%"> | |
| 50 | Enter search terms or a module, class or function name. | |
| 51 | </p> | |
| 52 | </div> | |
| 53 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 54 | </div> | |
| 55 | </div> | |
| 30 | </div> | |
| 56 | 31 | |
| 57 | 32 | <div class="document"> |
| 58 | 33 | <div class="documentwrapper"> |
| 60 | 35 | <div class="body" role="main"> |
| 61 | 36 | |
| 62 | 37 | <h1>Source code for nmb.NetBIOSProtocol</h1><div class="highlight"><pre> |
| 63 | ||
| 38 | <span></span> | |
| 64 | 39 | <span class="kn">import</span> <span class="nn">os</span><span class="o">,</span> <span class="nn">logging</span><span class="o">,</span> <span class="nn">random</span><span class="o">,</span> <span class="nn">socket</span><span class="o">,</span> <span class="nn">time</span> |
| 65 | 40 | <span class="kn">from</span> <span class="nn">twisted.internet</span> <span class="kn">import</span> <span class="n">reactor</span><span class="p">,</span> <span class="n">defer</span> |
| 66 | 41 | <span class="kn">from</span> <span class="nn">twisted.internet.protocol</span> <span class="kn">import</span> <span class="n">DatagramProtocol</span> |
| 67 | <span class="kn">from</span> <span class="nn">nmb_constants</span> <span class="kn">import</span> <span class="n">TYPE_SERVER</span> | |
| 68 | <span class="kn">from</span> <span class="nn">base</span> <span class="kn">import</span> <span class="n">NBNS</span> | |
| 69 | ||
| 70 | <span class="n">IP_QUERY</span><span class="p">,</span> <span class="n">NAME_QUERY</span> <span class="o">=</span> <span class="nb">range</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> | |
| 42 | <span class="kn">from</span> <span class="nn">.base</span> <span class="kn">import</span> <span class="n">NBNS</span> | |
| 71 | 43 | |
| 72 | 44 | <div class="viewcode-block" id="NetBIOSTimeout"><a class="viewcode-back" href="../../api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NetBIOSTimeout">[docs]</a><span class="k">class</span> <span class="nc">NetBIOSTimeout</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span> |
| 73 | 45 | <span class="sd">"""Raised in NBNSProtocol via Deferred.errback method when queryName method has timeout waiting for reply"""</span> |
| 77 | 49 | |
| 78 | 50 | <span class="n">log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s1">'NMB.NBNSProtocol'</span><span class="p">)</span> |
| 79 | 51 | |
| 80 | <div class="viewcode-block" id="NBNSProtocol.__init__"><a class="viewcode-back" href="../../api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NBNSProtocol.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">broadcast</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span> <span class="n">listen_port</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> | |
| 52 | <div class="viewcode-block" id="NBNSProtocol.__init__"><a class="viewcode-back" href="../../api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NBNSProtocol.__init__">[docs]</a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">broadcast</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">listen_port</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> | |
| 81 | 53 | <span class="sd">"""</span> |
| 82 | 54 | <span class="sd"> Instantiate a NBNSProtocol instance.</span> |
| 83 | 55 | |
| 93 | 65 | <span class="bp">self</span><span class="o">.</span><span class="n">transport</span><span class="o">.</span><span class="n">getHandle</span><span class="p">()</span><span class="o">.</span><span class="n">setsockopt</span><span class="p">(</span><span class="n">socket</span><span class="o">.</span><span class="n">SOL_SOCKET</span><span class="p">,</span> <span class="n">socket</span><span class="o">.</span><span class="n">SO_BROADCAST</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> |
| 94 | 66 | <span class="n">reactor</span><span class="o">.</span><span class="n">callLater</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cleanupPendingTrns</span><span class="p">)</span></div> |
| 95 | 67 | |
| 96 | <span class="k">def</span> <span class="nf">datagramReceived</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">from_info</span><span class="p">):</span> | |
| 68 | <div class="viewcode-block" id="NBNSProtocol.datagramReceived"><a class="viewcode-back" href="../../api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NBNSProtocol.datagramReceived">[docs]</a> <span class="k">def</span> <span class="nf">datagramReceived</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">from_info</span><span class="p">):</span> | |
| 97 | 69 | <span class="n">host</span><span class="p">,</span> <span class="n">port</span> <span class="o">=</span> <span class="n">from_info</span> |
| 98 | 70 | <span class="n">trn_id</span><span class="p">,</span> <span class="n">ret</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">decodePacket</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> |
| 99 | 71 | |
| 103 | 75 | <span class="k">if</span> <span class="n">ip</span> <span class="ow">is</span> <span class="n">NAME_QUERY</span><span class="p">:</span> |
| 104 | 76 | <span class="c1"># decode as query packet</span> |
| 105 | 77 | <span class="n">trn_id</span><span class="p">,</span> <span class="n">ret</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">decodeIPQueryPacket</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> |
| 106 | <span class="n">d</span><span class="o">.</span><span class="n">callback</span><span class="p">(</span><span class="n">ret</span><span class="p">)</span> | |
| 78 | <span class="n">d</span><span class="o">.</span><span class="n">callback</span><span class="p">(</span><span class="n">ret</span><span class="p">)</span></div> | |
| 107 | 79 | |
| 108 | 80 | <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">ip</span><span class="p">,</span> <span class="n">port</span><span class="p">):</span> |
| 109 | 81 | <span class="c1"># We don't use the transport.write method directly as it keeps raising DeprecationWarning for ip='<broadcast>'</span> |
| 121 | 93 | <span class="sd"> On timeout, the errback function will be called with a Failure instance wrapping around a NetBIOSTimeout exception</span> |
| 122 | 94 | <span class="sd"> """</span> |
| 123 | 95 | <span class="n">trn_id</span> <span class="o">=</span> <span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mh">0xFFFF</span><span class="p">)</span> |
| 124 | <span class="k">while</span> <span class="bp">True</span><span class="p">:</span> | |
| 125 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">pending_trns</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">trn_id</span><span class="p">):</span> | |
| 96 | <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> | |
| 97 | <span class="k">if</span> <span class="n">trn_id</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">pending_trns</span><span class="p">:</span> | |
| 126 | 98 | <span class="k">break</span> |
| 127 | 99 | <span class="k">else</span><span class="p">:</span> |
| 128 | 100 | <span class="n">trn_id</span> <span class="o">=</span> <span class="p">(</span><span class="n">trn_id</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="o">&</span> <span class="mh">0xFFFF</span> |
| 153 | 125 | <span class="sd"> On timeout, the errback function will be called with a Failure instance wrapping around a NetBIOSTimeout exception</span> |
| 154 | 126 | <span class="sd"> """</span> |
| 155 | 127 | <span class="n">trn_id</span> <span class="o">=</span> <span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mh">0xFFFF</span><span class="p">)</span> |
| 156 | <span class="k">while</span> <span class="bp">True</span><span class="p">:</span> | |
| 157 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">pending_trns</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">trn_id</span><span class="p">):</span> | |
| 128 | <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> | |
| 129 | <span class="k">if</span> <span class="n">trn_id</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">pending_trns</span><span class="p">:</span> | |
| 158 | 130 | <span class="k">break</span> |
| 159 | 131 | <span class="k">else</span><span class="p">:</span> |
| 160 | 132 | <span class="n">trn_id</span> <span class="o">=</span> <span class="p">(</span><span class="n">trn_id</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="o">&</span> <span class="mh">0xFFFF</span> |
| 167 | 139 | <span class="n">d2</span><span class="o">.</span><span class="n">addErrback</span><span class="p">(</span><span class="n">d</span><span class="o">.</span><span class="n">errback</span><span class="p">)</span> |
| 168 | 140 | |
| 169 | 141 | <span class="k">def</span> <span class="nf">stripCode</span><span class="p">(</span><span class="n">ret</span><span class="p">):</span> |
| 170 | <span class="k">if</span> <span class="n">ret</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span> <span class="c1"># got valid response. Somehow the callback is also called when there is an error.</span> | |
| 142 | <span class="k">if</span> <span class="n">ret</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># got valid response. Somehow the callback is also called when there is an error.</span> | |
| 171 | 143 | <span class="n">d</span><span class="o">.</span><span class="n">callback</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="n">TYPE_SERVER</span><span class="p">,</span> <span class="n">ret</span><span class="p">)))</span> |
| 172 | 144 | |
| 173 | 145 | <span class="n">d2</span><span class="o">.</span><span class="n">addCallback</span><span class="p">(</span><span class="n">stripCode</span><span class="p">)</span> |
| 174 | 146 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_trns</span><span class="p">[</span><span class="n">trn_id</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span><span class="o">+</span><span class="n">timeout</span><span class="p">,</span> <span class="n">NAME_QUERY</span><span class="p">,</span> <span class="n">d2</span> <span class="p">)</span> |
| 175 | 147 | <span class="k">return</span> <span class="n">d</span></div> |
| 176 | 148 | |
| 177 | <span class="k">def</span> <span class="nf">stopProtocol</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 178 | <span class="n">DatagramProtocol</span><span class="o">.</span><span class="n">stopProtocol</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> | |
| 149 | <div class="viewcode-block" id="NBNSProtocol.stopProtocol"><a class="viewcode-back" href="../../api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NBNSProtocol.stopProtocol">[docs]</a> <span class="k">def</span> <span class="nf">stopProtocol</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 150 | <span class="n">DatagramProtocol</span><span class="o">.</span><span class="n">stopProtocol</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div> | |
| 179 | 151 | |
| 180 | 152 | <span class="k">def</span> <span class="nf">cleanupPendingTrns</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| 181 | 153 | <span class="n">now</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> |
| 182 | 154 | |
| 183 | 155 | <span class="c1"># reply should have been received in the past</span> |
| 184 | <span class="n">expired</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="p">(</span><span class="n">trn_id</span><span class="p">,</span> <span class="p">(</span><span class="n">expiry_time</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">d</span><span class="p">)):</span> <span class="n">expiry_time</span> <span class="o"><</span> <span class="n">now</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">pending_trns</span><span class="o">.</span><span class="n">iteritems</span><span class="p">())</span> | |
| 156 | <span class="c1"># info is tuple of ( expiry_time, name, d )</span> | |
| 157 | <span class="n">expired</span> <span class="o">=</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">trn_id</span><span class="p">,</span> <span class="n">info</span><span class="p">:</span> <span class="n">info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o"><</span> <span class="n">now</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">pending_trns</span><span class="o">.</span><span class="n">iteritems</span><span class="p">())</span> | |
| 185 | 158 | |
| 186 | 159 | <span class="c1"># remove expired items from dict + call errback</span> |
| 187 | 160 | <span class="k">def</span> <span class="nf">expire_item</span><span class="p">(</span><span class="n">item</span><span class="p">):</span> |
| 198 | 171 | <span class="n">reactor</span><span class="o">.</span><span class="n">callLater</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cleanupPendingTrns</span><span class="p">)</span></div> |
| 199 | 172 | </pre></div> |
| 200 | 173 | |
| 174 | <div class="clearer"></div> | |
| 201 | 175 | </div> |
| 176 | </div> | |
| 177 | </div> | |
| 178 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 179 | <div class="sphinxsidebarwrapper"> | |
| 180 | <div id="searchbox" style="display: none" role="search"> | |
| 181 | <h3 id="searchlabel">Quick search</h3> | |
| 182 | <div class="searchformwrapper"> | |
| 183 | <form class="search" action="../../search.html" method="get"> | |
| 184 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 185 | <input type="submit" value="Go" /> | |
| 186 | </form> | |
| 187 | </div> | |
| 188 | </div> | |
| 189 | <script>$('#searchbox').show(0);</script> | |
| 202 | 190 | </div> |
| 203 | 191 | </div> |
| 204 | 192 | <div class="clearer"></div> |
| 209 | 197 | <li class="right" style="margin-right: 10px"> |
| 210 | 198 | <a href="../../genindex.html" title="General Index" |
| 211 | 199 | >index</a></li> |
| 212 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 213 | <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> | |
| 200 | <li class="right" > | |
| 201 | <a href="../../py-modindex.html" title="Python Module Index" | |
| 202 | >modules</a> |</li> | |
| 203 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 204 | <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> | |
| 205 | <li class="nav-item nav-item-this"><a href="">nmb.NetBIOSProtocol</a></li> | |
| 214 | 206 | </ul> |
| 215 | 207 | </div> |
| 216 | 208 | <div class="footer" role="contentinfo"> |
| 217 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 218 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 209 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 210 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 219 | 211 | </div> |
| 220 | 212 | </body> |
| 221 | 213 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | ||
| 3 | ||
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 0 | ||
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>smb.SMBConnection — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>smb.SMBConnection — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../../index.html" /> | |
| 26 | <link rel="up" title="Module code" href="../index.html" /> | |
| 27 | </head> | |
| 28 | <body role="document"> | |
| 10 | <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> | |
| 11 | <script src="../../_static/jquery.js"></script> | |
| 12 | <script src="../../_static/underscore.js"></script> | |
| 13 | <script src="../../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../../search.html" /> | |
| 16 | </head><body> | |
| 29 | 17 | <div class="related" role="navigation" aria-label="related navigation"> |
| 30 | 18 | <h3>Navigation</h3> |
| 31 | 19 | <ul> |
| 32 | 20 | <li class="right" style="margin-right: 10px"> |
| 33 | 21 | <a href="../../genindex.html" title="General Index" |
| 34 | 22 | accesskey="I">index</a></li> |
| 35 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 36 | <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> | |
| 23 | <li class="right" > | |
| 24 | <a href="../../py-modindex.html" title="Python Module Index" | |
| 25 | >modules</a> |</li> | |
| 26 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 27 | <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> | |
| 28 | <li class="nav-item nav-item-this"><a href="">smb.SMBConnection</a></li> | |
| 37 | 29 | </ul> |
| 38 | </div> | |
| 39 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 40 | <div class="sphinxsidebarwrapper"> | |
| 41 | <div id="searchbox" style="display: none" role="search"> | |
| 42 | <h3>Quick search</h3> | |
| 43 | <form class="search" action="../../search.html" method="get"> | |
| 44 | <input type="text" name="q" /> | |
| 45 | <input type="submit" value="Go" /> | |
| 46 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 47 | <input type="hidden" name="area" value="default" /> | |
| 48 | </form> | |
| 49 | <p class="searchtip" style="font-size: 90%"> | |
| 50 | Enter search terms or a module, class or function name. | |
| 51 | </p> | |
| 52 | </div> | |
| 53 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 54 | </div> | |
| 55 | </div> | |
| 30 | </div> | |
| 56 | 31 | |
| 57 | 32 | <div class="document"> |
| 58 | 33 | <div class="documentwrapper"> |
| 60 | 35 | <div class="body" role="main"> |
| 61 | 36 | |
| 62 | 37 | <h1>Source code for smb.SMBConnection</h1><div class="highlight"><pre> |
| 63 | ||
| 64 | <span class="kn">import</span> <span class="nn">os</span><span class="o">,</span> <span class="nn">logging</span><span class="o">,</span> <span class="nn">select</span><span class="o">,</span> <span class="nn">socket</span><span class="o">,</span> <span class="nn">struct</span><span class="o">,</span> <span class="nn">errno</span> | |
| 65 | <span class="kn">from</span> <span class="nn">smb_constants</span> <span class="kn">import</span> <span class="o">*</span> | |
| 66 | <span class="kn">from</span> <span class="nn">smb_structs</span> <span class="kn">import</span> <span class="o">*</span> | |
| 67 | <span class="kn">from</span> <span class="nn">base</span> <span class="kn">import</span> <span class="n">SMB</span><span class="p">,</span> <span class="n">NotConnectedError</span><span class="p">,</span> <span class="n">NotReadyError</span><span class="p">,</span> <span class="n">SMBTimeout</span> | |
| 38 | <span></span> | |
| 39 | <span class="kn">import</span> <span class="nn">os</span><span class="o">,</span> <span class="nn">logging</span><span class="o">,</span> <span class="nn">select</span><span class="o">,</span> <span class="nn">socket</span><span class="o">,</span> <span class="nn">types</span><span class="o">,</span> <span class="nn">struct</span><span class="o">,</span> <span class="nn">errno</span> | |
| 40 | <span class="kn">from</span> <span class="nn">.smb_constants</span> <span class="kn">import</span> <span class="o">*</span> | |
| 41 | <span class="kn">from</span> <span class="nn">.smb_structs</span> <span class="kn">import</span> <span class="o">*</span> | |
| 42 | <span class="kn">from</span> <span class="nn">.base</span> <span class="kn">import</span> <span class="n">SMB</span><span class="p">,</span> <span class="n">NotConnectedError</span><span class="p">,</span> <span class="n">NotReadyError</span><span class="p">,</span> <span class="n">SMBTimeout</span> | |
| 68 | 43 | |
| 69 | 44 | |
| 70 | 45 | <div class="viewcode-block" id="SMBConnection"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection">[docs]</a><span class="k">class</span> <span class="nc">SMBConnection</span><span class="p">(</span><span class="n">SMB</span><span class="p">):</span> |
| 78 | 53 | <span class="c1">#: SMB messages will only be signed when remote server requires signing.</span> |
| 79 | 54 | <span class="n">SIGN_WHEN_REQUIRED</span> <span class="o">=</span> <span class="mi">2</span> |
| 80 | 55 | |
| 81 | <div class="viewcode-block" id="SMBConnection.__init__"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">my_name</span><span class="p">,</span> <span class="n">remote_name</span><span class="p">,</span> <span class="n">domain</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> <span class="n">use_ntlm_v2</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span> <span class="n">sign_options</span> <span class="o">=</span> <span class="n">SIGN_WHEN_REQUIRED</span><span class="p">,</span> <span class="n">is_direct_tcp</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span> | |
| 56 | <div class="viewcode-block" id="SMBConnection.__init__"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.__init__">[docs]</a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">my_name</span><span class="p">,</span> <span class="n">remote_name</span><span class="p">,</span> <span class="n">domain</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> <span class="n">use_ntlm_v2</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">sign_options</span> <span class="o">=</span> <span class="n">SIGN_WHEN_REQUIRED</span><span class="p">,</span> <span class="n">is_direct_tcp</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span> | |
| 82 | 57 | <span class="sd">"""</span> |
| 83 | 58 | <span class="sd"> Create a new SMBConnection instance.</span> |
| 84 | 59 | |
| 85 | 60 | <span class="sd"> *username* and *password* are the user credentials required to authenticate the underlying SMB connection with the remote server.</span> |
| 61 | <span class="sd"> *password* can be a string or a callable returning a string.</span> | |
| 86 | 62 | <span class="sd"> File operations can only be proceeded after the connection has been authenticated successfully.</span> |
| 87 | 63 | |
| 88 | 64 | <span class="sd"> Note that you need to call *connect* method to actually establish the SMB connection to the remote server and perform authentication.</span> |
| 91 | 67 | <span class="sd"> Some newer server installations might also support Direct hosting of SMB over TCP/IP; for these servers, the default TCP port is 445.</span> |
| 92 | 68 | |
| 93 | 69 | <span class="sd"> :param string my_name: The local NetBIOS machine name that will identify where this connection is originating from.</span> |
| 94 | <span class="sd"> 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 ``\/:*?";|+``</span> | |
| 70 | <span class="sd"> 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 ``\\/:*?";|+``</span> | |
| 95 | 71 | <span class="sd"> :param string remote_name: The NetBIOS machine name of the remote server.</span> |
| 96 | 72 | <span class="sd"> On windows, you can find out the machine name by right-clicking on the "My Computer" and selecting "Properties".</span> |
| 97 | 73 | <span class="sd"> This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected.</span> |
| 107 | 83 | <span class="sd"> :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.</span> |
| 108 | 84 | <span class="sd"> The default parameter is False which will use NetBIOS over TCP/IP for wider compatibility (TCP port: 139).</span> |
| 109 | 85 | <span class="sd"> """</span> |
| 110 | <span class="n">SMB</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">my_name</span><span class="p">,</span> <span class="n">remote_name</span><span class="p">,</span> <span class="n">domain</span><span class="p">,</span> <span class="n">use_ntlm_v2</span><span class="p">,</span> <span class="n">sign_options</span><span class="p">,</span> <span class="n">is_direct_tcp</span><span class="p">)</span> | |
| 111 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span> <span class="o">=</span> <span class="bp">None</span> | |
| 112 | <span class="bp">self</span><span class="o">.</span><span class="n">auth_result</span> <span class="o">=</span> <span class="bp">None</span> | |
| 113 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 86 | <span class="n">SMB</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">my_name</span><span class="p">,</span> <span class="n">remote_name</span><span class="p">,</span> <span class="n">domain</span><span class="p">,</span> <span class="n">use_ntlm_v2</span><span class="p">,</span> <span class="n">sign_options</span><span class="p">,</span> <span class="n">is_direct_tcp</span><span class="p">)</span> | |
| 87 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span> <span class="o">=</span> <span class="kc">None</span> | |
| 88 | <span class="bp">self</span><span class="o">.</span><span class="n">auth_result</span> <span class="o">=</span> <span class="kc">None</span> | |
| 89 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 114 | 90 | <span class="bp">self</span><span class="o">.</span><span class="n">is_direct_tcp</span> <span class="o">=</span> <span class="n">is_direct_tcp</span></div> |
| 115 | 91 | |
| 116 | 92 | <span class="c1">#</span> |
| 118 | 94 | <span class="c1">#</span> |
| 119 | 95 | |
| 120 | 96 | <span class="k">def</span> <span class="nf">onAuthOK</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| 121 | <span class="bp">self</span><span class="o">.</span><span class="n">auth_result</span> <span class="o">=</span> <span class="bp">True</span> | |
| 97 | <span class="bp">self</span><span class="o">.</span><span class="n">auth_result</span> <span class="o">=</span> <span class="kc">True</span> | |
| 122 | 98 | |
| 123 | 99 | <span class="k">def</span> <span class="nf">onAuthFailed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| 124 | <span class="bp">self</span><span class="o">.</span><span class="n">auth_result</span> <span class="o">=</span> <span class="bp">False</span> | |
| 100 | <span class="bp">self</span><span class="o">.</span><span class="n">auth_result</span> <span class="o">=</span> <span class="kc">False</span> | |
| 125 | 101 | |
| 126 | 102 | <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span> |
| 127 | 103 | <span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">sock</span> |
| 134 | 110 | <span class="n">total_sent</span> <span class="o">=</span> <span class="n">total_sent</span> <span class="o">+</span> <span class="n">sent</span> |
| 135 | 111 | |
| 136 | 112 | <span class="c1">#</span> |
| 113 | <span class="c1"># Support for "with" context</span> | |
| 114 | <span class="c1">#</span> | |
| 115 | <span class="k">def</span> <span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 116 | <span class="k">return</span> <span class="bp">self</span> | |
| 117 | ||
| 118 | <span class="k">def</span> <span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span> | |
| 119 | <span class="bp">self</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> | |
| 120 | ||
| 121 | <span class="c1">#</span> | |
| 137 | 122 | <span class="c1"># Misc Properties</span> |
| 138 | 123 | <span class="c1">#</span> |
| 139 | 124 | |
| 147 | 132 | <span class="c1"># Public Methods</span> |
| 148 | 133 | <span class="c1">#</span> |
| 149 | 134 | |
| 150 | <div class="viewcode-block" id="SMBConnection.connect"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.connect">[docs]</a> <span class="k">def</span> <span class="nf">connect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ip</span><span class="p">,</span> <span class="n">port</span> <span class="o">=</span> <span class="mi">139</span><span class="p">,</span> <span class="n">sock_family</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">AF_INET</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">60</span><span class="p">):</span> | |
| 135 | <div class="viewcode-block" id="SMBConnection.connect"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.connect">[docs]</a> <span class="k">def</span> <span class="nf">connect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ip</span><span class="p">,</span> <span class="n">port</span> <span class="o">=</span> <span class="mi">139</span><span class="p">,</span> <span class="n">sock_family</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">60</span><span class="p">):</span> | |
| 151 | 136 | <span class="sd">"""</span> |
| 152 | 137 | <span class="sd"> Establish the SMB connection to the remote SMB/CIFS server.</span> |
| 153 | 138 | |
| 154 | 139 | <span class="sd"> You must call this method before attempting any of the file operations with the remote server.</span> |
| 155 | 140 | <span class="sd"> This method will block until the SMB connection has attempted at least one authentication.</span> |
| 156 | 141 | |
| 142 | <span class="sd"> :param port: Defaults to 139. If you are using direct TCP mode (is_direct_tcp=true when creating this SMBConnection instance), use 445.</span> | |
| 143 | <span class="sd"> :param sock_family: In Python 3.x, use *None* as we can infer the socket family from the provided *ip*. In Python 2.x, it must be either *socket.AF_INET* or *socket.AF_INET6*.</span> | |
| 157 | 144 | <span class="sd"> :return: A boolean value indicating the result of the authentication atttempt: True if authentication is successful; False, if otherwise.</span> |
| 158 | 145 | <span class="sd"> """</span> |
| 159 | 146 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="p">:</span> |
| 160 | 147 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| 161 | 148 | |
| 162 | <span class="bp">self</span><span class="o">.</span><span class="n">auth_result</span> <span class="o">=</span> <span class="bp">None</span> | |
| 163 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">socket</span><span class="p">(</span><span class="n">sock_family</span><span class="p">)</span> | |
| 164 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="o">.</span><span class="n">settimeout</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> | |
| 165 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="o">.</span><span class="n">connect</span><span class="p">((</span> <span class="n">ip</span><span class="p">,</span> <span class="n">port</span> <span class="p">))</span> | |
| 166 | ||
| 167 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">True</span> | |
| 149 | <span class="bp">self</span><span class="o">.</span><span class="n">auth_result</span> <span class="o">=</span> <span class="kc">None</span> | |
| 150 | <span class="k">if</span> <span class="n">sock_family</span><span class="p">:</span> | |
| 151 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">socket</span><span class="p">(</span><span class="n">sock_family</span><span class="p">)</span> | |
| 152 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="o">.</span><span class="n">settimeout</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> | |
| 153 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="o">.</span><span class="n">connect</span><span class="p">((</span> <span class="n">ip</span><span class="p">,</span> <span class="n">port</span> <span class="p">))</span> | |
| 154 | <span class="k">else</span><span class="p">:</span> | |
| 155 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">create_connection</span><span class="p">((</span> <span class="n">ip</span><span class="p">,</span> <span class="n">port</span> <span class="p">))</span> | |
| 156 | ||
| 157 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">True</span> | |
| 168 | 158 | <span class="k">try</span><span class="p">:</span> |
| 169 | 159 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_direct_tcp</span><span class="p">:</span> |
| 170 | 160 | <span class="bp">self</span><span class="o">.</span><span class="n">requestNMBSession</span><span class="p">()</span> |
| 171 | 161 | <span class="k">else</span><span class="p">:</span> |
| 172 | 162 | <span class="bp">self</span><span class="o">.</span><span class="n">onNMBSessionOK</span><span class="p">()</span> |
| 173 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">auth_result</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span> | |
| 174 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> | |
| 175 | <span class="k">finally</span><span class="p">:</span> | |
| 176 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 163 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">auth_result</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> | |
| 164 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> | |
| 165 | <span class="k">finally</span><span class="p">:</span> | |
| 166 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 177 | 167 | |
| 178 | 168 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">auth_result</span></div> |
| 179 | 169 | |
| 183 | 173 | <span class="sd"> """</span> |
| 184 | 174 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="p">:</span> |
| 185 | 175 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| 186 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span> <span class="o">=</span> <span class="bp">None</span></div> | |
| 176 | <span class="bp">self</span><span class="o">.</span><span class="n">sock</span> <span class="o">=</span> <span class="kc">None</span></div> | |
| 187 | 177 | |
| 188 | 178 | <div class="viewcode-block" id="SMBConnection.listShares"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.listShares">[docs]</a> <span class="k">def</span> <span class="nf">listShares</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> |
| 189 | 179 | <span class="sd">"""</span> |
| 197 | 187 | <span class="n">results</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 198 | 188 | |
| 199 | 189 | <span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">entries</span><span class="p">):</span> |
| 200 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 190 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 201 | 191 | <span class="n">results</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">entries</span><span class="p">)</span> |
| 202 | 192 | |
| 203 | 193 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> |
| 204 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 205 | <span class="k">raise</span> <span class="n">failure</span> | |
| 206 | ||
| 207 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">True</span> | |
| 194 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 195 | <span class="k">raise</span> <span class="n">failure</span> | |
| 196 | ||
| 197 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">True</span> | |
| 208 | 198 | <span class="k">try</span><span class="p">:</span> |
| 209 | 199 | <span class="bp">self</span><span class="o">.</span><span class="n">_listShares</span><span class="p">(</span><span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> |
| 210 | 200 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> |
| 211 | 201 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> |
| 212 | 202 | <span class="k">finally</span><span class="p">:</span> |
| 213 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 203 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 214 | 204 | |
| 215 | 205 | <span class="k">return</span> <span class="n">results</span></div> |
| 216 | 206 | |
| 217 | 207 | <div class="viewcode-block" id="SMBConnection.listPath"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.listPath">[docs]</a> <span class="k">def</span> <span class="nf">listPath</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> |
| 218 | <span class="n">search</span> <span class="o">=</span> <span class="n">SMB_FILE_ATTRIBUTE_READONLY</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_HIDDEN</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_SYSTEM</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_DIRECTORY</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_ARCHIVE</span><span class="p">,</span> | |
| 208 | <span class="n">search</span> <span class="o">=</span> <span class="n">SMB_FILE_ATTRIBUTE_READONLY</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_HIDDEN</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_SYSTEM</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_DIRECTORY</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_ARCHIVE</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_INCL_NORMAL</span><span class="p">,</span> | |
| 219 | 209 | <span class="n">pattern</span> <span class="o">=</span> <span class="s1">'*'</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> |
| 220 | 210 | <span class="sd">"""</span> |
| 221 | 211 | <span class="sd"> Retrieve a directory listing of files/folders at *path*</span> |
| 212 | ||
| 213 | <span class="sd"> For simplicity, pysmb defines a "normal" file as a file entry that is not read-only, not hidden, not system, not archive and not a directory.</span> | |
| 214 | <span class="sd"> It ignores other attributes like compression, indexed, sparse, temporary and encryption.</span> | |
| 215 | ||
| 216 | <span class="sd"> Note that the default search parameter will query for all read-only (SMB_FILE_ATTRIBUTE_READONLY), hidden (SMB_FILE_ATTRIBUTE_HIDDEN),</span> | |
| 217 | <span class="sd"> system (SMB_FILE_ATTRIBUTE_SYSTEM), archive (SMB_FILE_ATTRIBUTE_ARCHIVE), normal (SMB_FILE_ATTRIBUTE_INCL_NORMAL) files</span> | |
| 218 | <span class="sd"> and directories (SMB_FILE_ATTRIBUTE_DIRECTORY).</span> | |
| 219 | <span class="sd"> If you do not need to include "normal" files in the result, define your own search parameter without the SMB_FILE_ATTRIBUTE_INCL_NORMAL constant.</span> | |
| 220 | <span class="sd"> SMB_FILE_ATTRIBUTE_NORMAL should be used by itself and not be used with other bit constants.</span> | |
| 222 | 221 | |
| 223 | 222 | <span class="sd"> :param string/unicode service_name: the name of the shared folder for the *path*</span> |
| 224 | 223 | <span class="sd"> :param string/unicode path: path relative to the *service_name* where we are interested to learn about its files/sub-folders.</span> |
| 225 | 224 | <span class="sd"> :param integer search: integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py).</span> |
| 226 | <span class="sd"> The default *search* value will query for all read-only, hidden, system, archive files and directories.</span> | |
| 227 | 225 | <span class="sd"> :param string/unicode pattern: the filter to apply to the results before returning to the client.</span> |
| 228 | 226 | <span class="sd"> :return: A list of :doc:`smb.base.SharedFile<smb_SharedFile>` instances.</span> |
| 229 | 227 | <span class="sd"> """</span> |
| 233 | 231 | <span class="n">results</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 234 | 232 | |
| 235 | 233 | <span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">entries</span><span class="p">):</span> |
| 236 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 234 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 237 | 235 | <span class="n">results</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">entries</span><span class="p">)</span> |
| 238 | 236 | |
| 239 | 237 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> |
| 240 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 241 | <span class="k">raise</span> <span class="n">failure</span> | |
| 242 | ||
| 243 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">True</span> | |
| 238 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 239 | <span class="k">raise</span> <span class="n">failure</span> | |
| 240 | ||
| 241 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">True</span> | |
| 244 | 242 | <span class="k">try</span><span class="p">:</span> |
| 245 | 243 | <span class="bp">self</span><span class="o">.</span><span class="n">_listPath</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">,</span> <span class="n">search</span> <span class="o">=</span> <span class="n">search</span><span class="p">,</span> <span class="n">pattern</span> <span class="o">=</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span> |
| 246 | 244 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> |
| 247 | 245 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> |
| 248 | 246 | <span class="k">finally</span><span class="p">:</span> |
| 249 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 247 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 250 | 248 | |
| 251 | 249 | <span class="k">return</span> <span class="n">results</span></div> |
| 252 | 250 | |
| 266 | 264 | <span class="n">results</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 267 | 265 | |
| 268 | 266 | <span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">entries</span><span class="p">):</span> |
| 269 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 267 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 270 | 268 | <span class="n">results</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">entries</span><span class="p">)</span> |
| 271 | 269 | |
| 272 | 270 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> |
| 273 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 274 | <span class="k">raise</span> <span class="n">failure</span> | |
| 275 | ||
| 276 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">True</span> | |
| 271 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 272 | <span class="k">raise</span> <span class="n">failure</span> | |
| 273 | ||
| 274 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">True</span> | |
| 277 | 275 | <span class="k">try</span><span class="p">:</span> |
| 278 | 276 | <span class="bp">self</span><span class="o">.</span><span class="n">_listSnapshots</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span> |
| 279 | 277 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> |
| 280 | 278 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> |
| 281 | 279 | <span class="k">finally</span><span class="p">:</span> |
| 282 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 280 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 283 | 281 | |
| 284 | 282 | <span class="k">return</span> <span class="n">results</span></div> |
| 285 | 283 | |
| 297 | 295 | <span class="n">results</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 298 | 296 | |
| 299 | 297 | <span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">info</span><span class="p">):</span> |
| 300 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 298 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 301 | 299 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">info</span><span class="p">)</span> |
| 302 | 300 | |
| 303 | 301 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> |
| 304 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 305 | <span class="k">raise</span> <span class="n">failure</span> | |
| 306 | ||
| 307 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">True</span> | |
| 302 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 303 | <span class="k">raise</span> <span class="n">failure</span> | |
| 304 | ||
| 305 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">True</span> | |
| 308 | 306 | <span class="k">try</span><span class="p">:</span> |
| 309 | 307 | <span class="bp">self</span><span class="o">.</span><span class="n">_getAttributes</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> |
| 310 | 308 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> |
| 311 | 309 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> |
| 312 | 310 | <span class="k">finally</span><span class="p">:</span> |
| 313 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 311 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 314 | 312 | |
| 315 | 313 | <span class="k">return</span> <span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span></div> |
| 316 | 314 | |
| 317 | <div class="viewcode-block" id="SMBConnection.retrieveFile"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.retrieveFile">[docs]</a> <span class="k">def</span> <span class="nf">retrieveFile</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 318 | <span class="sd">"""</span> | |
| 319 | <span class="sd"> Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.</span> | |
| 320 | ||
| 321 | <span class="sd"> 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*.</span> | |
| 315 | <div class="viewcode-block" id="SMBConnection.getSecurity"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.getSecurity">[docs]</a> <span class="k">def</span> <span class="nf">getSecurity</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 316 | <span class="sd">"""</span> | |
| 317 | <span class="sd"> Retrieve the security descriptor of the file at *path* on the *service_name*.</span> | |
| 322 | 318 | |
| 323 | 319 | <span class="sd"> :param string/unicode service_name: the name of the shared folder for the *path*</span> |
| 324 | 320 | <span class="sd"> :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.</span> |
| 325 | <span class="sd"> :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.</span> | |
| 321 | <span class="sd"> :return: A :class:`smb.security_descriptors.SecurityDescriptor` instance containing the security information of the file.</span> | |
| 322 | <span class="sd"> """</span> | |
| 323 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="p">:</span> | |
| 324 | <span class="k">raise</span> <span class="n">NotConnectedError</span><span class="p">(</span><span class="s1">'Not connected to server'</span><span class="p">)</span> | |
| 325 | ||
| 326 | <span class="n">results</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> | |
| 327 | ||
| 328 | <span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">info</span><span class="p">):</span> | |
| 329 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 330 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">info</span><span class="p">)</span> | |
| 331 | ||
| 332 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> | |
| 333 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 334 | <span class="k">raise</span> <span class="n">failure</span> | |
| 335 | ||
| 336 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">True</span> | |
| 337 | <span class="k">try</span><span class="p">:</span> | |
| 338 | <span class="bp">self</span><span class="o">.</span><span class="n">_getSecurity</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 339 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> | |
| 340 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> | |
| 341 | <span class="k">finally</span><span class="p">:</span> | |
| 342 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 343 | ||
| 344 | <span class="k">return</span> <span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span></div> | |
| 345 | ||
| 346 | <div class="viewcode-block" id="SMBConnection.retrieveFile"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.retrieveFile">[docs]</a> <span class="k">def</span> <span class="nf">retrieveFile</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 347 | <span class="sd">"""</span> | |
| 348 | <span class="sd"> Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.</span> | |
| 349 | ||
| 350 | <span class="sd"> 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*.</span> | |
| 351 | ||
| 352 | <span class="sd"> :param string/unicode service_name: the name of the shared folder for the *path*</span> | |
| 353 | <span class="sd"> :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.</span> | |
| 354 | <span class="sd"> :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. In Python3, this file-like object must have a *write* method which accepts a bytes parameter.</span> | |
| 326 | 355 | <span class="sd"> :return: A 2-element tuple of ( file attributes of the file on server, number of bytes written to *file_obj* ).</span> |
| 327 | 356 | <span class="sd"> The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)</span> |
| 328 | 357 | <span class="sd"> """</span> |
| 329 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">retrieveFileFromOffset</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="il">0L</span><span class="p">,</span> <span class="o">-</span><span class="il">1L</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span></div> | |
| 330 | ||
| 331 | <div class="viewcode-block" id="SMBConnection.retrieveFileFromOffset"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.retrieveFileFromOffset">[docs]</a> <span class="k">def</span> <span class="nf">retrieveFileFromOffset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="il">0L</span><span class="p">,</span> <span class="n">max_length</span> <span class="o">=</span> <span class="o">-</span><span class="il">1L</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 358 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">retrieveFileFromOffset</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span></div> | |
| 359 | ||
| 360 | <div class="viewcode-block" id="SMBConnection.retrieveFileFromOffset"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.retrieveFileFromOffset">[docs]</a> <span class="k">def</span> <span class="nf">retrieveFileFromOffset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">max_length</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 332 | 361 | <span class="sd">"""</span> |
| 333 | 362 | <span class="sd"> Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.</span> |
| 334 | 363 | |
| 335 | 364 | <span class="sd"> :param string/unicode service_name: the name of the shared folder for the *path*</span> |
| 336 | 365 | <span class="sd"> :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.</span> |
| 337 | <span class="sd"> :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.</span> | |
| 366 | <span class="sd"> :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. In Python3, this file-like object must have a *write* method which accepts a bytes parameter.</span> | |
| 338 | 367 | <span class="sd"> :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.</span> |
| 339 | 368 | <span class="sd"> :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.</span> |
| 340 | 369 | <span class="sd"> If zero, the method returns immediately after the file is opened successfully for reading.</span> |
| 347 | 376 | <span class="n">results</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 348 | 377 | |
| 349 | 378 | <span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">r</span><span class="p">):</span> |
| 350 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 379 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 351 | 380 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">r</span><span class="p">[</span><span class="mi">1</span><span class="p">:])</span> |
| 352 | 381 | |
| 353 | 382 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> |
| 354 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 355 | <span class="k">raise</span> <span class="n">failure</span> | |
| 356 | ||
| 357 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">True</span> | |
| 383 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 384 | <span class="k">raise</span> <span class="n">failure</span> | |
| 385 | ||
| 386 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">True</span> | |
| 358 | 387 | <span class="k">try</span><span class="p">:</span> |
| 359 | 388 | <span class="bp">self</span><span class="o">.</span><span class="n">_retrieveFileFromOffset</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">max_length</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span> |
| 360 | 389 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> |
| 361 | 390 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> |
| 362 | 391 | <span class="k">finally</span><span class="p">:</span> |
| 363 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 392 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 364 | 393 | |
| 365 | 394 | <span class="k">return</span> <span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span></div> |
| 366 | 395 | |
| 372 | 401 | <span class="sd"> :param string/unicode service_name: the name of the shared folder for the *path*</span> |
| 373 | 402 | <span class="sd"> :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.</span> |
| 374 | 403 | <span class="sd"> If the *path* refers to a folder or the file cannot be opened for writing, an :doc:`OperationFailure<smb_exceptions>` will be raised.</span> |
| 375 | <span class="sd"> :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF.</span> | |
| 404 | <span class="sd"> :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF. In Python3, this file-like object must have a *read* method which returns a bytes parameter.</span> | |
| 376 | 405 | <span class="sd"> :return: Number of bytes uploaded</span> |
| 377 | 406 | <span class="sd"> """</span> |
| 378 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">storeFileFromOffset</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="il">0L</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span></div> | |
| 379 | ||
| 380 | <div class="viewcode-block" id="SMBConnection.storeFileFromOffset"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.storeFileFromOffset">[docs]</a> <span class="k">def</span> <span class="nf">storeFileFromOffset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="il">0L</span><span class="p">,</span> <span class="n">truncate</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 407 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">storeFileFromOffset</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span></div> | |
| 408 | ||
| 409 | <div class="viewcode-block" id="SMBConnection.storeFileFromOffset"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.storeFileFromOffset">[docs]</a> <span class="k">def</span> <span class="nf">storeFileFromOffset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">truncate</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 381 | 410 | <span class="sd">"""</span> |
| 382 | 411 | <span class="sd"> Store the contents of the *file_obj* at *path* on the *service_name*.</span> |
| 383 | 412 | |
| 395 | 424 | <span class="n">results</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 396 | 425 | |
| 397 | 426 | <span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">r</span><span class="p">):</span> |
| 398 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 427 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 399 | 428 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">r</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> |
| 400 | 429 | |
| 401 | 430 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> |
| 402 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 403 | <span class="k">raise</span> <span class="n">failure</span> | |
| 404 | ||
| 405 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">True</span> | |
| 431 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 432 | <span class="k">raise</span> <span class="n">failure</span> | |
| 433 | ||
| 434 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">True</span> | |
| 406 | 435 | <span class="k">try</span><span class="p">:</span> |
| 407 | 436 | <span class="bp">self</span><span class="o">.</span><span class="n">_storeFileFromOffset</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">truncate</span> <span class="o">=</span> <span class="n">truncate</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span> |
| 408 | 437 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> |
| 409 | 438 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> |
| 410 | 439 | <span class="k">finally</span><span class="p">:</span> |
| 411 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 440 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 412 | 441 | |
| 413 | 442 | <span class="k">return</span> <span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span></div> |
| 414 | 443 | |
| 415 | <div class="viewcode-block" id="SMBConnection.deleteFiles"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.deleteFiles">[docs]</a> <span class="k">def</span> <span class="nf">deleteFiles</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 444 | <div class="viewcode-block" id="SMBConnection.deleteFiles"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.deleteFiles">[docs]</a> <span class="k">def</span> <span class="nf">deleteFiles</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">delete_matching_folders</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 416 | 445 | <span class="sd">"""</span> |
| 417 | 446 | <span class="sd"> 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.</span> |
| 447 | ||
| 448 | <span class="sd"> If delete_matching_folders is True, immediate sub-folders that match the path_file_pattern will be deleted recursively.</span> | |
| 418 | 449 | |
| 419 | 450 | <span class="sd"> :param string/unicode service_name: Contains the name of the shared folder.</span> |
| 420 | 451 | <span class="sd"> :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.</span> |
| 426 | 457 | <span class="k">raise</span> <span class="n">NotConnectedError</span><span class="p">(</span><span class="s1">'Not connected to server'</span><span class="p">)</span> |
| 427 | 458 | |
| 428 | 459 | <span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">r</span><span class="p">):</span> |
| 429 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 430 | ||
| 431 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> | |
| 432 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 433 | <span class="k">raise</span> <span class="n">failure</span> | |
| 434 | ||
| 435 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">True</span> | |
| 436 | <span class="k">try</span><span class="p">:</span> | |
| 437 | <span class="bp">self</span><span class="o">.</span><span class="n">_deleteFiles</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span> | |
| 438 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> | |
| 439 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> | |
| 440 | <span class="k">finally</span><span class="p">:</span> | |
| 441 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span></div> | |
| 442 | ||
| 443 | <div class="viewcode-block" id="SMBConnection.resetFileAttributes"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.resetFileAttributes">[docs]</a> <span class="k">def</span> <span class="nf">resetFileAttributes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 460 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 461 | ||
| 462 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> | |
| 463 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 464 | <span class="k">raise</span> <span class="n">failure</span> | |
| 465 | ||
| 466 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">True</span> | |
| 467 | <span class="k">try</span><span class="p">:</span> | |
| 468 | <span class="bp">self</span><span class="o">.</span><span class="n">_deleteFiles</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">delete_matching_folders</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span> | |
| 469 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> | |
| 470 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> | |
| 471 | <span class="k">finally</span><span class="p">:</span> | |
| 472 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span></div> | |
| 473 | ||
| 474 | <div class="viewcode-block" id="SMBConnection.resetFileAttributes"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.resetFileAttributes">[docs]</a> <span class="k">def</span> <span class="nf">resetFileAttributes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">file_attributes</span> <span class="o">=</span> <span class="n">ATTR_NORMAL</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 444 | 475 | <span class="sd">"""</span> |
| 445 | 476 | <span class="sd"> Reset file attributes of one or more regular files or folders.</span> |
| 446 | 477 | <span class="sd"> It supports the use of wildcards in file names, allowing for unlocking of multiple files/folders in a single request.</span> |
| 447 | 478 | <span class="sd"> This function is very helpful when deleting files/folders that are read-only.</span> |
| 448 | <span class="sd"> 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)</span> | |
| 479 | <span class="sd"> By default, it sets the ATTR_NORMAL flag, therefore clearing all other flags.</span> | |
| 480 | <span class="sd"> (See https://msdn.microsoft.com/en-us/library/cc232110.aspx for further information)</span> | |
| 481 | ||
| 482 | <span class="sd"> Note: this function is currently only implemented for SMB2!</span> | |
| 449 | 483 | |
| 450 | 484 | <span class="sd"> :param string/unicode service_name: Contains the name of the shared folder.</span> |
| 451 | 485 | <span class="sd"> :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.</span> |
| 452 | 486 | <span class="sd"> Wildcards may be used in the filename component of the path.</span> |
| 453 | 487 | <span class="sd"> If your path/filename contains non-English characters, you must pass in an unicode string.</span> |
| 488 | <span class="sd"> :param int file_attributes: The desired file attributes to set. Defaults to `ATTR_NORMAL`.</span> | |
| 454 | 489 | <span class="sd"> :return: None</span> |
| 455 | 490 | <span class="sd"> """</span> |
| 456 | 491 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="p">:</span> |
| 457 | 492 | <span class="k">raise</span> <span class="n">NotConnectedError</span><span class="p">(</span><span class="s1">'Not connected to server'</span><span class="p">)</span> |
| 458 | 493 | |
| 459 | 494 | <span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">r</span><span class="p">):</span> |
| 460 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 461 | ||
| 462 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> | |
| 463 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 464 | <span class="k">raise</span> <span class="n">failure</span> | |
| 465 | ||
| 466 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">True</span> | |
| 467 | <span class="k">try</span><span class="p">:</span> | |
| 468 | <span class="bp">self</span><span class="o">.</span><span class="n">_resetFileAttributes</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span> | |
| 469 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> | |
| 470 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> | |
| 471 | <span class="k">finally</span><span class="p">:</span> | |
| 472 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span></div> | |
| 495 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 496 | ||
| 497 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> | |
| 498 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 499 | <span class="k">raise</span> <span class="n">failure</span> | |
| 500 | ||
| 501 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">True</span> | |
| 502 | <span class="k">try</span><span class="p">:</span> | |
| 503 | <span class="bp">self</span><span class="o">.</span><span class="n">_resetFileAttributes</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">,</span> <span class="n">file_attributes</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 504 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> | |
| 505 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> | |
| 506 | <span class="k">finally</span><span class="p">:</span> | |
| 507 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span></div> | |
| 473 | 508 | |
| 474 | 509 | <div class="viewcode-block" id="SMBConnection.createDirectory"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.createDirectory">[docs]</a> <span class="k">def</span> <span class="nf">createDirectory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> |
| 475 | 510 | <span class="sd">"""</span> |
| 484 | 519 | <span class="k">raise</span> <span class="n">NotConnectedError</span><span class="p">(</span><span class="s1">'Not connected to server'</span><span class="p">)</span> |
| 485 | 520 | |
| 486 | 521 | <span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">r</span><span class="p">):</span> |
| 487 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 488 | ||
| 489 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> | |
| 490 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 491 | <span class="k">raise</span> <span class="n">failure</span> | |
| 492 | ||
| 493 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">True</span> | |
| 522 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 523 | ||
| 524 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> | |
| 525 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 526 | <span class="k">raise</span> <span class="n">failure</span> | |
| 527 | ||
| 528 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">True</span> | |
| 494 | 529 | <span class="k">try</span><span class="p">:</span> |
| 495 | 530 | <span class="bp">self</span><span class="o">.</span><span class="n">_createDirectory</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span> |
| 496 | 531 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> |
| 497 | 532 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> |
| 498 | 533 | <span class="k">finally</span><span class="p">:</span> |
| 499 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span></div> | |
| 534 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span></div> | |
| 500 | 535 | |
| 501 | 536 | <div class="viewcode-block" id="SMBConnection.deleteDirectory"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.deleteDirectory">[docs]</a> <span class="k">def</span> <span class="nf">deleteDirectory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> |
| 502 | 537 | <span class="sd">"""</span> |
| 511 | 546 | <span class="k">raise</span> <span class="n">NotConnectedError</span><span class="p">(</span><span class="s1">'Not connected to server'</span><span class="p">)</span> |
| 512 | 547 | |
| 513 | 548 | <span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">r</span><span class="p">):</span> |
| 514 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 515 | ||
| 516 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> | |
| 517 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 518 | <span class="k">raise</span> <span class="n">failure</span> | |
| 519 | ||
| 520 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">True</span> | |
| 549 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 550 | ||
| 551 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> | |
| 552 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 553 | <span class="k">raise</span> <span class="n">failure</span> | |
| 554 | ||
| 555 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">True</span> | |
| 521 | 556 | <span class="k">try</span><span class="p">:</span> |
| 522 | 557 | <span class="bp">self</span><span class="o">.</span><span class="n">_deleteDirectory</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span> |
| 523 | 558 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> |
| 524 | 559 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> |
| 525 | 560 | <span class="k">finally</span><span class="p">:</span> |
| 526 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span></div> | |
| 561 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span></div> | |
| 527 | 562 | |
| 528 | 563 | <div class="viewcode-block" id="SMBConnection.rename"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.rename">[docs]</a> <span class="k">def</span> <span class="nf">rename</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">old_path</span><span class="p">,</span> <span class="n">new_path</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> |
| 529 | 564 | <span class="sd">"""</span> |
| 539 | 574 | <span class="k">raise</span> <span class="n">NotConnectedError</span><span class="p">(</span><span class="s1">'Not connected to server'</span><span class="p">)</span> |
| 540 | 575 | |
| 541 | 576 | <span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">r</span><span class="p">):</span> |
| 542 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 543 | ||
| 544 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> | |
| 545 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 546 | <span class="k">raise</span> <span class="n">failure</span> | |
| 547 | ||
| 548 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">True</span> | |
| 577 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 578 | ||
| 579 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> | |
| 580 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 581 | <span class="k">raise</span> <span class="n">failure</span> | |
| 582 | ||
| 583 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">True</span> | |
| 549 | 584 | <span class="k">try</span><span class="p">:</span> |
| 550 | 585 | <span class="bp">self</span><span class="o">.</span><span class="n">_rename</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">old_path</span><span class="p">,</span> <span class="n">new_path</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">)</span> |
| 551 | 586 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> |
| 552 | 587 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> |
| 553 | 588 | <span class="k">finally</span><span class="p">:</span> |
| 554 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span></div> | |
| 589 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span></div> | |
| 555 | 590 | |
| 556 | 591 | <div class="viewcode-block" id="SMBConnection.echo"><a class="viewcode-back" href="../../api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.echo">[docs]</a> <span class="k">def</span> <span class="nf">echo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">10</span><span class="p">):</span> |
| 557 | 592 | <span class="sd">"""</span> |
| 558 | 593 | <span class="sd"> Send an echo command containing *data* to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same *data*.</span> |
| 559 | 594 | |
| 560 | <span class="sd"> :param string data: Data to send to the remote server.</span> | |
| 595 | <span class="sd"> :param bytes data: Data to send to the remote server. Must be a bytes object.</span> | |
| 561 | 596 | <span class="sd"> :return: The *data* parameter</span> |
| 562 | 597 | <span class="sd"> """</span> |
| 563 | 598 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">sock</span><span class="p">:</span> |
| 566 | 601 | <span class="n">results</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 567 | 602 | |
| 568 | 603 | <span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">r</span><span class="p">):</span> |
| 569 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 604 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 570 | 605 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">r</span><span class="p">)</span> |
| 571 | 606 | |
| 572 | 607 | <span class="k">def</span> <span class="nf">eb</span><span class="p">(</span><span class="n">failure</span><span class="p">):</span> |
| 573 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 574 | <span class="k">raise</span> <span class="n">failure</span> | |
| 575 | ||
| 576 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">True</span> | |
| 608 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 609 | <span class="k">raise</span> <span class="n">failure</span> | |
| 610 | ||
| 611 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">True</span> | |
| 577 | 612 | <span class="k">try</span><span class="p">:</span> |
| 578 | 613 | <span class="bp">self</span><span class="o">.</span><span class="n">_echo</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">eb</span><span class="p">)</span> |
| 579 | 614 | <span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span><span class="p">:</span> |
| 580 | 615 | <span class="bp">self</span><span class="o">.</span><span class="n">_pollForNetBIOSPacket</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> |
| 581 | 616 | <span class="k">finally</span><span class="p">:</span> |
| 582 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="bp">False</span> | |
| 617 | <span class="bp">self</span><span class="o">.</span><span class="n">is_busy</span> <span class="o">=</span> <span class="kc">False</span> | |
| 583 | 618 | |
| 584 | 619 | <span class="k">return</span> <span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span></div> |
| 585 | 620 | |
| 590 | 625 | <span class="k">def</span> <span class="nf">_pollForNetBIOSPacket</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timeout</span><span class="p">):</span> |
| 591 | 626 | <span class="n">expiry_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">+</span> <span class="n">timeout</span> |
| 592 | 627 | <span class="n">read_len</span> <span class="o">=</span> <span class="mi">4</span> |
| 593 | <span class="n">data</span> <span class="o">=</span> <span class="s1">''</span> | |
| 628 | <span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 594 | 629 | |
| 595 | 630 | <span class="k">while</span> <span class="n">read_len</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| 596 | 631 | <span class="k">try</span><span class="p">:</span> |
| 607 | 642 | |
| 608 | 643 | <span class="n">data</span> <span class="o">=</span> <span class="n">data</span> <span class="o">+</span> <span class="n">d</span> |
| 609 | 644 | <span class="n">read_len</span> <span class="o">-=</span> <span class="nb">len</span><span class="p">(</span><span class="n">d</span><span class="p">)</span> |
| 610 | <span class="k">except</span> <span class="n">select</span><span class="o">.</span><span class="n">error</span><span class="p">,</span> <span class="n">ex</span><span class="p">:</span> | |
| 611 | <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">ex</span><span class="p">,</span> <span class="n">types</span><span class="o">.</span><span class="n">TupleType</span><span class="p">):</span> | |
| 645 | <span class="k">except</span> <span class="n">select</span><span class="o">.</span><span class="n">error</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span> | |
| 646 | <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">ex</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">):</span> | |
| 612 | 647 | <span class="k">if</span> <span class="n">ex</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">EINTR</span> <span class="ow">and</span> <span class="n">ex</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">EAGAIN</span><span class="p">:</span> |
| 613 | 648 | <span class="k">raise</span> <span class="n">ex</span> |
| 614 | 649 | <span class="k">else</span><span class="p">:</span> |
| 615 | 650 | <span class="k">raise</span> <span class="n">ex</span> |
| 616 | 651 | |
| 617 | <span class="n">type_</span><span class="p">,</span> <span class="n">flags</span><span class="p">,</span> <span class="n">length</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'>BBH'</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span> | |
| 652 | <span class="nb">type</span><span class="p">,</span> <span class="n">flags</span><span class="p">,</span> <span class="n">length</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'>BBH'</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span> | |
| 618 | 653 | <span class="k">if</span> <span class="n">flags</span> <span class="o">&</span> <span class="mh">0x01</span><span class="p">:</span> |
| 619 | 654 | <span class="n">length</span> <span class="o">=</span> <span class="n">length</span> <span class="o">|</span> <span class="mh">0x10000</span> |
| 620 | 655 | |
| 634 | 669 | |
| 635 | 670 | <span class="n">data</span> <span class="o">=</span> <span class="n">data</span> <span class="o">+</span> <span class="n">d</span> |
| 636 | 671 | <span class="n">read_len</span> <span class="o">-=</span> <span class="nb">len</span><span class="p">(</span><span class="n">d</span><span class="p">)</span> |
| 637 | <span class="k">except</span> <span class="n">select</span><span class="o">.</span><span class="n">error</span><span class="p">,</span> <span class="n">ex</span><span class="p">:</span> | |
| 638 | <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">ex</span><span class="p">,</span> <span class="n">types</span><span class="o">.</span><span class="n">TupleType</span><span class="p">):</span> | |
| 672 | <span class="k">except</span> <span class="n">select</span><span class="o">.</span><span class="n">error</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span> | |
| 673 | <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">ex</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">):</span> | |
| 639 | 674 | <span class="k">if</span> <span class="n">ex</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">EINTR</span> <span class="ow">and</span> <span class="n">ex</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">EAGAIN</span><span class="p">:</span> |
| 640 | 675 | <span class="k">raise</span> <span class="n">ex</span> |
| 641 | 676 | <span class="k">else</span><span class="p">:</span> |
| 644 | 679 | <span class="bp">self</span><span class="o">.</span><span class="n">feedData</span><span class="p">(</span><span class="n">data</span><span class="p">)</span></div> |
| 645 | 680 | </pre></div> |
| 646 | 681 | |
| 682 | <div class="clearer"></div> | |
| 647 | 683 | </div> |
| 684 | </div> | |
| 685 | </div> | |
| 686 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 687 | <div class="sphinxsidebarwrapper"> | |
| 688 | <div id="searchbox" style="display: none" role="search"> | |
| 689 | <h3 id="searchlabel">Quick search</h3> | |
| 690 | <div class="searchformwrapper"> | |
| 691 | <form class="search" action="../../search.html" method="get"> | |
| 692 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 693 | <input type="submit" value="Go" /> | |
| 694 | </form> | |
| 695 | </div> | |
| 696 | </div> | |
| 697 | <script>$('#searchbox').show(0);</script> | |
| 648 | 698 | </div> |
| 649 | 699 | </div> |
| 650 | 700 | <div class="clearer"></div> |
| 655 | 705 | <li class="right" style="margin-right: 10px"> |
| 656 | 706 | <a href="../../genindex.html" title="General Index" |
| 657 | 707 | >index</a></li> |
| 658 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 659 | <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> | |
| 708 | <li class="right" > | |
| 709 | <a href="../../py-modindex.html" title="Python Module Index" | |
| 710 | >modules</a> |</li> | |
| 711 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 712 | <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> | |
| 713 | <li class="nav-item nav-item-this"><a href="">smb.SMBConnection</a></li> | |
| 660 | 714 | </ul> |
| 661 | 715 | </div> |
| 662 | 716 | <div class="footer" role="contentinfo"> |
| 663 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 664 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 717 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 718 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 665 | 719 | </div> |
| 666 | 720 | </body> |
| 667 | 721 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | ||
| 3 | ||
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 0 | ||
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>smb.SMBProtocol — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>smb.SMBProtocol — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../../index.html" /> | |
| 26 | <link rel="up" title="Module code" href="../index.html" /> | |
| 27 | </head> | |
| 28 | <body role="document"> | |
| 10 | <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> | |
| 11 | <script src="../../_static/jquery.js"></script> | |
| 12 | <script src="../../_static/underscore.js"></script> | |
| 13 | <script src="../../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../../search.html" /> | |
| 16 | </head><body> | |
| 29 | 17 | <div class="related" role="navigation" aria-label="related navigation"> |
| 30 | 18 | <h3>Navigation</h3> |
| 31 | 19 | <ul> |
| 32 | 20 | <li class="right" style="margin-right: 10px"> |
| 33 | 21 | <a href="../../genindex.html" title="General Index" |
| 34 | 22 | accesskey="I">index</a></li> |
| 35 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 36 | <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> | |
| 23 | <li class="right" > | |
| 24 | <a href="../../py-modindex.html" title="Python Module Index" | |
| 25 | >modules</a> |</li> | |
| 26 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 27 | <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> | |
| 28 | <li class="nav-item nav-item-this"><a href="">smb.SMBProtocol</a></li> | |
| 37 | 29 | </ul> |
| 38 | </div> | |
| 39 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 40 | <div class="sphinxsidebarwrapper"> | |
| 41 | <div id="searchbox" style="display: none" role="search"> | |
| 42 | <h3>Quick search</h3> | |
| 43 | <form class="search" action="../../search.html" method="get"> | |
| 44 | <input type="text" name="q" /> | |
| 45 | <input type="submit" value="Go" /> | |
| 46 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 47 | <input type="hidden" name="area" value="default" /> | |
| 48 | </form> | |
| 49 | <p class="searchtip" style="font-size: 90%"> | |
| 50 | Enter search terms or a module, class or function name. | |
| 51 | </p> | |
| 52 | </div> | |
| 53 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 54 | </div> | |
| 55 | </div> | |
| 30 | </div> | |
| 56 | 31 | |
| 57 | 32 | <div class="document"> |
| 58 | 33 | <div class="documentwrapper"> |
| 60 | 35 | <div class="body" role="main"> |
| 61 | 36 | |
| 62 | 37 | <h1>Source code for smb.SMBProtocol</h1><div class="highlight"><pre> |
| 63 | ||
| 38 | <span></span> | |
| 64 | 39 | <span class="kn">import</span> <span class="nn">os</span><span class="o">,</span> <span class="nn">logging</span><span class="o">,</span> <span class="nn">time</span> |
| 65 | 40 | <span class="kn">from</span> <span class="nn">twisted.internet</span> <span class="kn">import</span> <span class="n">reactor</span><span class="p">,</span> <span class="n">defer</span> |
| 66 | 41 | <span class="kn">from</span> <span class="nn">twisted.internet.protocol</span> <span class="kn">import</span> <span class="n">ClientFactory</span><span class="p">,</span> <span class="n">Protocol</span> |
| 67 | <span class="kn">from</span> <span class="nn">smb_constants</span> <span class="kn">import</span> <span class="o">*</span> | |
| 68 | <span class="kn">from</span> <span class="nn">smb_structs</span> <span class="kn">import</span> <span class="o">*</span> | |
| 69 | <span class="kn">from</span> <span class="nn">base</span> <span class="kn">import</span> <span class="n">SMB</span><span class="p">,</span> <span class="n">NotConnectedError</span><span class="p">,</span> <span class="n">NotReadyError</span><span class="p">,</span> <span class="n">SMBTimeout</span> | |
| 42 | <span class="kn">from</span> <span class="nn">.smb_constants</span> <span class="kn">import</span> <span class="o">*</span> | |
| 43 | <span class="kn">from</span> <span class="nn">.smb_structs</span> <span class="kn">import</span> <span class="o">*</span> | |
| 44 | <span class="kn">from</span> <span class="nn">.base</span> <span class="kn">import</span> <span class="n">SMB</span><span class="p">,</span> <span class="n">NotConnectedError</span><span class="p">,</span> <span class="n">NotReadyError</span><span class="p">,</span> <span class="n">SMBTimeout</span> | |
| 70 | 45 | |
| 71 | 46 | |
| 72 | 47 | <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span> <span class="s1">'SMBProtocolFactory'</span><span class="p">,</span> <span class="s1">'NotConnectedError'</span><span class="p">,</span> <span class="s1">'NotReadyError'</span> <span class="p">]</span> |
| 87 | 62 | <span class="k">else</span><span class="p">:</span> |
| 88 | 63 | <span class="bp">self</span><span class="o">.</span><span class="n">onNMBSessionOK</span><span class="p">()</span> |
| 89 | 64 | |
| 65 | ||
| 90 | 66 | <span class="k">def</span> <span class="nf">connectionLost</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reason</span><span class="p">):</span> |
| 91 | 67 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">factory</span><span class="o">.</span><span class="n">instance</span> <span class="o">==</span> <span class="bp">self</span><span class="p">:</span> |
| 92 | <span class="bp">self</span><span class="o">.</span><span class="n">instance</span> <span class="o">=</span> <span class="bp">None</span> | |
| 68 | <span class="bp">self</span><span class="o">.</span><span class="n">instance</span> <span class="o">=</span> <span class="kc">None</span> | |
| 93 | 69 | |
| 94 | 70 | <span class="k">def</span> <span class="nf">dataReceived</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span> |
| 95 | 71 | <span class="bp">self</span><span class="o">.</span><span class="n">feedData</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> |
| 121 | 97 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">factory</span><span class="o">.</span><span class="n">instance</span> <span class="o">==</span> <span class="bp">self</span><span class="p">:</span> |
| 122 | 98 | <span class="n">now</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> |
| 123 | 99 | <span class="n">to_remove</span> <span class="o">=</span> <span class="p">[]</span> |
| 124 | <span class="k">for</span> <span class="n">mid</span><span class="p">,</span> <span class="n">r</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span> | |
| 100 | <span class="k">for</span> <span class="n">mid</span><span class="p">,</span> <span class="n">r</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> | |
| 125 | 101 | <span class="k">if</span> <span class="n">r</span><span class="o">.</span><span class="n">expiry_time</span> <span class="o"><</span> <span class="n">now</span><span class="p">:</span> |
| 126 | 102 | <span class="k">try</span><span class="p">:</span> |
| 127 | 103 | <span class="n">r</span><span class="o">.</span><span class="n">errback</span><span class="p">(</span><span class="n">SMBTimeout</span><span class="p">())</span> |
| 146 | 122 | <span class="c1">#: SMB messages will only be signed when remote server requires signing.</span> |
| 147 | 123 | <span class="n">SIGN_WHEN_REQUIRED</span> <span class="o">=</span> <span class="mi">2</span> |
| 148 | 124 | |
| 149 | <div class="viewcode-block" id="SMBProtocolFactory.__init__"><a class="viewcode-back" href="../../api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">my_name</span><span class="p">,</span> <span class="n">remote_name</span><span class="p">,</span> <span class="n">domain</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> <span class="n">use_ntlm_v2</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span> <span class="n">sign_options</span> <span class="o">=</span> <span class="n">SIGN_WHEN_REQUIRED</span><span class="p">,</span> <span class="n">is_direct_tcp</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span> | |
| 125 | <div class="viewcode-block" id="SMBProtocolFactory.__init__"><a class="viewcode-back" href="../../api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.__init__">[docs]</a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">my_name</span><span class="p">,</span> <span class="n">remote_name</span><span class="p">,</span> <span class="n">domain</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> <span class="n">use_ntlm_v2</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">sign_options</span> <span class="o">=</span> <span class="n">SIGN_WHEN_REQUIRED</span><span class="p">,</span> <span class="n">is_direct_tcp</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span> | |
| 150 | 126 | <span class="sd">"""</span> |
| 151 | 127 | <span class="sd"> 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.</span> |
| 152 | 128 | <span class="sd"> Note that the default TCP port for most SMB/CIFS servers using NetBIOS over TCP/IP is 139.</span> |
| 156 | 132 | <span class="sd"> File operations can only be proceeded after the connection has been authenticated successfully.</span> |
| 157 | 133 | |
| 158 | 134 | <span class="sd"> :param string my_name: The local NetBIOS machine name that will identify where this connection is originating from.</span> |
| 159 | <span class="sd"> 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 ``\/:*?";|+``.</span> | |
| 135 | <span class="sd"> 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 ``\/:*?";|+``</span> | |
| 160 | 136 | <span class="sd"> :param string remote_name: The NetBIOS machine name of the remote server.</span> |
| 161 | 137 | <span class="sd"> On windows, you can find out the machine name by right-clicking on the "My Computer" and selecting "Properties".</span> |
| 162 | 138 | <span class="sd"> This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected.</span> |
| 180 | 156 | <span class="bp">self</span><span class="o">.</span><span class="n">use_ntlm_v2</span> <span class="o">=</span> <span class="n">use_ntlm_v2</span> |
| 181 | 157 | <span class="bp">self</span><span class="o">.</span><span class="n">sign_options</span> <span class="o">=</span> <span class="n">sign_options</span> |
| 182 | 158 | <span class="bp">self</span><span class="o">.</span><span class="n">is_direct_tcp</span> <span class="o">=</span> <span class="n">is_direct_tcp</span> |
| 183 | <span class="bp">self</span><span class="o">.</span><span class="n">instance</span> <span class="o">=</span> <span class="bp">None</span> <span class="c1">#: The single SMBProtocol instance for each SMBProtocolFactory instance. Usually, you should not need to touch this attribute directly.</span></div> | |
| 159 | <span class="bp">self</span><span class="o">.</span><span class="n">instance</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1">#: The single SMBProtocol instance for each SMBProtocolFactory instance. Usually, you should not need to touch this attribute directly.</span></div> | |
| 184 | 160 | |
| 185 | 161 | <span class="c1">#</span> |
| 186 | 162 | <span class="c1"># Public Property</span> |
| 239 | 215 | <span class="k">return</span> <span class="n">d</span></div> |
| 240 | 216 | |
| 241 | 217 | <div class="viewcode-block" id="SMBProtocolFactory.listPath"><a class="viewcode-back" href="../../api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.listPath">[docs]</a> <span class="k">def</span> <span class="nf">listPath</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> |
| 242 | <span class="n">search</span> <span class="o">=</span> <span class="n">SMB_FILE_ATTRIBUTE_READONLY</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_HIDDEN</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_SYSTEM</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_DIRECTORY</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_ARCHIVE</span><span class="p">,</span> | |
| 218 | <span class="n">search</span> <span class="o">=</span> <span class="n">SMB_FILE_ATTRIBUTE_READONLY</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_HIDDEN</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_SYSTEM</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_DIRECTORY</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_ARCHIVE</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_INCL_NORMAL</span><span class="p">,</span> | |
| 243 | 219 | <span class="n">pattern</span> <span class="o">=</span> <span class="s1">'*'</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> |
| 244 | 220 | <span class="sd">"""</span> |
| 245 | 221 | <span class="sd"> Retrieve a directory listing of files/folders at *path*</span> |
| 222 | ||
| 223 | <span class="sd"> For simplicity, pysmb defines a "normal" file as a file entry that is not read-only, not hidden, not system, not archive and not a directory.</span> | |
| 224 | <span class="sd"> It ignores other attributes like compression, indexed, sparse, temporary and encryption.</span> | |
| 225 | ||
| 226 | <span class="sd"> Note that the default search parameter will query for all read-only (SMB_FILE_ATTRIBUTE_READONLY), hidden (SMB_FILE_ATTRIBUTE_HIDDEN),</span> | |
| 227 | <span class="sd"> system (SMB_FILE_ATTRIBUTE_SYSTEM), archive (SMB_FILE_ATTRIBUTE_ARCHIVE), normal (SMB_FILE_ATTRIBUTE_INCL_NORMAL) files</span> | |
| 228 | <span class="sd"> and directories (SMB_FILE_ATTRIBUTE_DIRECTORY).</span> | |
| 229 | <span class="sd"> If you do not need to include "normal" files in the result, define your own search parameter without the SMB_FILE_ATTRIBUTE_INCL_NORMAL constant.</span> | |
| 230 | <span class="sd"> SMB_FILE_ATTRIBUTE_NORMAL should be used by itself and not be used with other bit constants.</span> | |
| 246 | 231 | |
| 247 | 232 | <span class="sd"> :param string/unicode service_name: the name of the shared folder for the *path*</span> |
| 248 | 233 | <span class="sd"> :param string/unicode path: path relative to the *service_name* where we are interested to learn about its files/sub-folders.</span> |
| 249 | 234 | <span class="sd"> :param integer search: integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py).</span> |
| 250 | <span class="sd"> The default *search* value will query for all read-only, hidden, system, archive files and directories.</span> | |
| 251 | 235 | <span class="sd"> :param string/unicode pattern: the filter to apply to the results before returning to the client.</span> |
| 252 | 236 | <span class="sd"> :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.</span> |
| 253 | 237 | <span class="sd"> :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of :doc:`smb.base.SharedFile<smb_SharedFile>` instances.</span> |
| 304 | 288 | |
| 305 | 289 | <span class="sd"> :param string/unicode service_name: the name of the shared folder for the *path*</span> |
| 306 | 290 | <span class="sd"> :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.</span> |
| 307 | <span class="sd"> :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.</span> | |
| 291 | <span class="sd"> :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. In Python3, this file-like object must have a *write* method which accepts a bytes parameter.</span> | |
| 308 | 292 | <span class="sd"> :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* ).</span> |
| 309 | 293 | <span class="sd"> The file attributes is an integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py)</span> |
| 310 | 294 | <span class="sd"> """</span> |
| 311 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">retrieveFileFromOffset</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="il">0L</span><span class="p">,</span> <span class="o">-</span><span class="il">1L</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span></div> | |
| 312 | ||
| 313 | <div class="viewcode-block" id="SMBProtocolFactory.retrieveFileFromOffset"><a class="viewcode-back" href="../../api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.retrieveFileFromOffset">[docs]</a> <span class="k">def</span> <span class="nf">retrieveFileFromOffset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="il">0L</span><span class="p">,</span> <span class="n">max_length</span> <span class="o">=</span> <span class="o">-</span><span class="il">1L</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 295 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">retrieveFileFromOffset</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span></div> | |
| 296 | ||
| 297 | <div class="viewcode-block" id="SMBProtocolFactory.retrieveFileFromOffset"><a class="viewcode-back" href="../../api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.retrieveFileFromOffset">[docs]</a> <span class="k">def</span> <span class="nf">retrieveFileFromOffset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">max_length</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 314 | 298 | <span class="sd">"""</span> |
| 315 | 299 | <span class="sd"> Retrieve the contents of the file at *path* on the *service_name* and write these contents to the provided *file_obj*.</span> |
| 316 | 300 | |
| 320 | 304 | |
| 321 | 305 | <span class="sd"> :param string/unicode service_name: the name of the shared folder for the *path*</span> |
| 322 | 306 | <span class="sd"> :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.</span> |
| 323 | <span class="sd"> :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.</span> | |
| 307 | <span class="sd"> :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. In Python3, this file-like object must have a *write* method which accepts a bytes parameter.</span> | |
| 324 | 308 | <span class="sd"> :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.</span> |
| 325 | 309 | <span class="sd"> :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.</span> |
| 326 | 310 | <span class="sd"> If zero, the *Deferred* callback is invoked immediately after the file is opened successfully for reading.</span> |
| 346 | 330 | <span class="sd"> :param string/unicode service_name: the name of the shared folder for the *path*</span> |
| 347 | 331 | <span class="sd"> :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.</span> |
| 348 | 332 | <span class="sd"> 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.</span> |
| 349 | <span class="sd"> :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF.</span> | |
| 333 | <span class="sd"> :param file_obj: A file-like object that has a *read* method. Data will read continuously from *file_obj* until EOF. In Python3, this file-like object must have a *read* method which returns a bytes parameter.</span> | |
| 350 | 334 | <span class="sd"> :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 ).</span> |
| 351 | 335 | <span class="sd"> """</span> |
| 352 | 336 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">:</span> |
| 356 | 340 | <span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="o">.</span><span class="n">_storeFile</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">d</span><span class="o">.</span><span class="n">callback</span><span class="p">,</span> <span class="n">d</span><span class="o">.</span><span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span> |
| 357 | 341 | <span class="k">return</span> <span class="n">d</span></div> |
| 358 | 342 | |
| 359 | <div class="viewcode-block" id="SMBProtocolFactory.deleteFiles"><a class="viewcode-back" href="../../api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.deleteFiles">[docs]</a> <span class="k">def</span> <span class="nf">deleteFiles</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 343 | <div class="viewcode-block" id="SMBProtocolFactory.deleteFiles"><a class="viewcode-back" href="../../api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.deleteFiles">[docs]</a> <span class="k">def</span> <span class="nf">deleteFiles</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">delete_matching_folders</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 360 | 344 | <span class="sd">"""</span> |
| 361 | 345 | <span class="sd"> 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.</span> |
| 362 | 346 | |
| 347 | <span class="sd"> If delete_matching_folders is True, immediate sub-folders that match the path_file_pattern will be deleted recursively.</span> | |
| 348 | <span class="sd"> </span> | |
| 363 | 349 | <span class="sd"> :param string/unicode service_name: Contains the name of the shared folder.</span> |
| 364 | 350 | <span class="sd"> :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name.</span> |
| 365 | 351 | <span class="sd"> Wildcards may be used in th filename component of the path.</span> |
| 371 | 357 | <span class="k">raise</span> <span class="n">NotConnectedError</span><span class="p">(</span><span class="s1">'Not connected to server'</span><span class="p">)</span> |
| 372 | 358 | |
| 373 | 359 | <span class="n">d</span> <span class="o">=</span> <span class="n">defer</span><span class="o">.</span><span class="n">Deferred</span><span class="p">()</span> |
| 374 | <span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="o">.</span><span class="n">_deleteFiles</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">d</span><span class="o">.</span><span class="n">callback</span><span class="p">,</span> <span class="n">d</span><span class="o">.</span><span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span> | |
| 360 | <span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="o">.</span><span class="n">_deleteFiles</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">delete_matching_folders</span><span class="p">,</span> <span class="n">d</span><span class="o">.</span><span class="n">callback</span><span class="p">,</span> <span class="n">d</span><span class="o">.</span><span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span> | |
| 375 | 361 | <span class="k">return</span> <span class="n">d</span></div> |
| 376 | 362 | |
| 377 | 363 | <div class="viewcode-block" id="SMBProtocolFactory.createDirectory"><a class="viewcode-back" href="../../api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.createDirectory">[docs]</a> <span class="k">def</span> <span class="nf">createDirectory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span> |
| 430 | 416 | <span class="sd">"""</span> |
| 431 | 417 | <span class="sd"> Send an echo command containing *data* to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same *data*.</span> |
| 432 | 418 | |
| 433 | <span class="sd"> :param string data: Data to send to the remote server.</span> | |
| 419 | <span class="sd"> :param bytes data: Data to send to the remote server. Must be a bytes object.</span> | |
| 434 | 420 | <span class="sd"> :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method.</span> |
| 435 | 421 | <span class="sd"> :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *data* parameter.</span> |
| 436 | 422 | <span class="sd"> """</span> |
| 457 | 443 | <span class="c1"># (Do not touch these unless you know what you are doing)</span> |
| 458 | 444 | <span class="c1">#</span> |
| 459 | 445 | |
| 460 | <span class="k">def</span> <span class="nf">buildProtocol</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">addr</span><span class="p">):</span> | |
| 446 | <div class="viewcode-block" id="SMBProtocolFactory.buildProtocol"><a class="viewcode-back" href="../../api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.buildProtocol">[docs]</a> <span class="k">def</span> <span class="nf">buildProtocol</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">addr</span><span class="p">):</span> | |
| 461 | 447 | <span class="n">p</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">protocol</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">my_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_ntlm_v2</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">sign_options</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_direct_tcp</span><span class="p">)</span> |
| 462 | 448 | <span class="n">p</span><span class="o">.</span><span class="n">factory</span> <span class="o">=</span> <span class="bp">self</span> |
| 463 | <span class="k">return</span> <span class="n">p</span></div> | |
| 449 | <span class="k">return</span> <span class="n">p</span></div></div> | |
| 464 | 450 | </pre></div> |
| 465 | 451 | |
| 452 | <div class="clearer"></div> | |
| 466 | 453 | </div> |
| 454 | </div> | |
| 455 | </div> | |
| 456 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 457 | <div class="sphinxsidebarwrapper"> | |
| 458 | <div id="searchbox" style="display: none" role="search"> | |
| 459 | <h3 id="searchlabel">Quick search</h3> | |
| 460 | <div class="searchformwrapper"> | |
| 461 | <form class="search" action="../../search.html" method="get"> | |
| 462 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 463 | <input type="submit" value="Go" /> | |
| 464 | </form> | |
| 465 | </div> | |
| 466 | </div> | |
| 467 | <script>$('#searchbox').show(0);</script> | |
| 467 | 468 | </div> |
| 468 | 469 | </div> |
| 469 | 470 | <div class="clearer"></div> |
| 474 | 475 | <li class="right" style="margin-right: 10px"> |
| 475 | 476 | <a href="../../genindex.html" title="General Index" |
| 476 | 477 | >index</a></li> |
| 477 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 478 | <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> | |
| 478 | <li class="right" > | |
| 479 | <a href="../../py-modindex.html" title="Python Module Index" | |
| 480 | >modules</a> |</li> | |
| 481 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 482 | <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> | |
| 483 | <li class="nav-item nav-item-this"><a href="">smb.SMBProtocol</a></li> | |
| 479 | 484 | </ul> |
| 480 | 485 | </div> |
| 481 | 486 | <div class="footer" role="contentinfo"> |
| 482 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 483 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 487 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 488 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 484 | 489 | </div> |
| 485 | 490 | </body> |
| 486 | 491 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | ||
| 3 | ||
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 0 | ||
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>smb.base — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>smb.base — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../../index.html" /> | |
| 26 | <link rel="up" title="Module code" href="../index.html" /> | |
| 27 | </head> | |
| 28 | <body role="document"> | |
| 10 | <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> | |
| 11 | <script src="../../_static/jquery.js"></script> | |
| 12 | <script src="../../_static/underscore.js"></script> | |
| 13 | <script src="../../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../../search.html" /> | |
| 16 | </head><body> | |
| 29 | 17 | <div class="related" role="navigation" aria-label="related navigation"> |
| 30 | 18 | <h3>Navigation</h3> |
| 31 | 19 | <ul> |
| 32 | 20 | <li class="right" style="margin-right: 10px"> |
| 33 | 21 | <a href="../../genindex.html" title="General Index" |
| 34 | 22 | accesskey="I">index</a></li> |
| 35 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 36 | <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> | |
| 23 | <li class="right" > | |
| 24 | <a href="../../py-modindex.html" title="Python Module Index" | |
| 25 | >modules</a> |</li> | |
| 26 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 27 | <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> | |
| 28 | <li class="nav-item nav-item-this"><a href="">smb.base</a></li> | |
| 37 | 29 | </ul> |
| 38 | </div> | |
| 39 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 40 | <div class="sphinxsidebarwrapper"> | |
| 41 | <div id="searchbox" style="display: none" role="search"> | |
| 42 | <h3>Quick search</h3> | |
| 43 | <form class="search" action="../../search.html" method="get"> | |
| 44 | <input type="text" name="q" /> | |
| 45 | <input type="submit" value="Go" /> | |
| 46 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 47 | <input type="hidden" name="area" value="default" /> | |
| 48 | </form> | |
| 49 | <p class="searchtip" style="font-size: 90%"> | |
| 50 | Enter search terms or a module, class or function name. | |
| 51 | </p> | |
| 52 | </div> | |
| 53 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 54 | </div> | |
| 55 | </div> | |
| 30 | </div> | |
| 56 | 31 | |
| 57 | 32 | <div class="document"> |
| 58 | 33 | <div class="documentwrapper"> |
| 60 | 35 | <div class="body" role="main"> |
| 61 | 36 | |
| 62 | 37 | <h1>Source code for smb.base</h1><div class="highlight"><pre> |
| 63 | ||
| 38 | <span></span> | |
| 64 | 39 | <span class="kn">import</span> <span class="nn">logging</span><span class="o">,</span> <span class="nn">binascii</span><span class="o">,</span> <span class="nn">time</span><span class="o">,</span> <span class="nn">hmac</span> |
| 65 | 40 | <span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span> |
| 66 | <span class="kn">from</span> <span class="nn">smb_constants</span> <span class="kn">import</span> <span class="o">*</span> | |
| 67 | <span class="kn">from</span> <span class="nn">smb2_constants</span> <span class="kn">import</span> <span class="o">*</span> | |
| 68 | <span class="kn">from</span> <span class="nn">smb_structs</span> <span class="kn">import</span> <span class="o">*</span> | |
| 69 | <span class="kn">from</span> <span class="nn">smb2_structs</span> <span class="kn">import</span> <span class="o">*</span> | |
| 41 | <span class="kn">from</span> <span class="nn">.smb_constants</span> <span class="kn">import</span> <span class="o">*</span> | |
| 42 | <span class="kn">from</span> <span class="nn">.smb2_constants</span> <span class="kn">import</span> <span class="o">*</span> | |
| 43 | <span class="kn">from</span> <span class="nn">.smb_structs</span> <span class="kn">import</span> <span class="o">*</span> | |
| 44 | <span class="kn">from</span> <span class="nn">.smb2_structs</span> <span class="kn">import</span> <span class="o">*</span> | |
| 45 | <span class="kn">from</span> <span class="nn">.security_descriptors</span> <span class="kn">import</span> <span class="n">SecurityDescriptor</span> | |
| 70 | 46 | <span class="kn">from</span> <span class="nn">nmb.base</span> <span class="kn">import</span> <span class="n">NMBSession</span> |
| 71 | <span class="kn">from</span> <span class="nn">utils</span> <span class="kn">import</span> <span class="n">convertFILETIMEtoEpoch</span> | |
| 72 | <span class="kn">import</span> <span class="nn">ntlm</span><span class="o">,</span> <span class="nn">securityblob</span> | |
| 47 | <span class="kn">from</span> <span class="nn">.utils</span> <span class="kn">import</span> <span class="n">convertFILETIMEtoEpoch</span> | |
| 48 | <span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">ntlm</span><span class="p">,</span> <span class="n">securityblob</span> | |
| 73 | 49 | |
| 74 | 50 | <span class="k">try</span><span class="p">:</span> |
| 75 | 51 | <span class="kn">import</span> <span class="nn">hashlib</span> |
| 76 | 52 | <span class="n">sha256</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">sha256</span> |
| 77 | 53 | <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> |
| 78 | <span class="kn">from</span> <span class="nn">utils</span> <span class="kn">import</span> <span class="n">sha256</span> | |
| 54 | <span class="kn">from</span> <span class="nn">.utils</span> <span class="kn">import</span> <span class="n">sha256</span> | |
| 79 | 55 | |
| 80 | 56 | |
| 81 | 57 | <div class="viewcode-block" id="NotReadyError"><a class="viewcode-back" href="../../api/smb_exceptions.html#smb.base.NotReadyError">[docs]</a><span class="k">class</span> <span class="nc">NotReadyError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span> |
| 89 | 65 | <div class="viewcode-block" id="SMBTimeout"><a class="viewcode-back" href="../../api/smb_exceptions.html#smb.base.SMBTimeout">[docs]</a><span class="k">class</span> <span class="nc">SMBTimeout</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span> |
| 90 | 66 | <span class="sd">"""Raised when a timeout has occurred while waiting for a response or for a SMB/CIFS operation to complete."""</span> |
| 91 | 67 | <span class="k">pass</span></div> |
| 92 | ||
| 93 | ||
| 94 | <span class="k">def</span> <span class="nf">_convert_to_unicode</span><span class="p">(</span><span class="n">string</span><span class="p">):</span> | |
| 95 | <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">string</span><span class="p">,</span> <span class="nb">unicode</span><span class="p">):</span> | |
| 96 | <span class="n">string</span> <span class="o">=</span> <span class="nb">unicode</span><span class="p">(</span><span class="n">string</span><span class="p">,</span> <span class="s2">"utf-8"</span><span class="p">)</span> | |
| 97 | <span class="k">return</span> <span class="n">string</span> | |
| 98 | 68 | |
| 99 | 69 | |
| 100 | 70 | <span class="k">class</span> <span class="nc">SMB</span><span class="p">(</span><span class="n">NMBSession</span><span class="p">):</span> |
| 118 | 88 | <span class="n">SIGN_WHEN_SUPPORTED</span> <span class="o">=</span> <span class="mi">1</span> |
| 119 | 89 | <span class="n">SIGN_WHEN_REQUIRED</span> <span class="o">=</span> <span class="mi">2</span> |
| 120 | 90 | |
| 121 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">my_name</span><span class="p">,</span> <span class="n">remote_name</span><span class="p">,</span> <span class="n">domain</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> <span class="n">use_ntlm_v2</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span> <span class="n">sign_options</span> <span class="o">=</span> <span class="n">SIGN_WHEN_REQUIRED</span><span class="p">,</span> <span class="n">is_direct_tcp</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span> | |
| 122 | <span class="n">NMBSession</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">my_name</span><span class="p">,</span> <span class="n">remote_name</span><span class="p">,</span> <span class="n">is_direct_tcp</span> <span class="o">=</span> <span class="n">is_direct_tcp</span><span class="p">)</span> | |
| 123 | <span class="bp">self</span><span class="o">.</span><span class="n">username</span> <span class="o">=</span> <span class="n">_convert_to_unicode</span><span class="p">(</span><span class="n">username</span><span class="p">)</span> | |
| 124 | <span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="n">_convert_to_unicode</span><span class="p">(</span><span class="n">password</span><span class="p">)</span> | |
| 125 | <span class="bp">self</span><span class="o">.</span><span class="n">domain</span> <span class="o">=</span> <span class="n">_convert_to_unicode</span><span class="p">(</span><span class="n">domain</span><span class="p">)</span> | |
| 91 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">my_name</span><span class="p">,</span> <span class="n">remote_name</span><span class="p">,</span> <span class="n">domain</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> <span class="n">use_ntlm_v2</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">sign_options</span> <span class="o">=</span> <span class="n">SIGN_WHEN_REQUIRED</span><span class="p">,</span> <span class="n">is_direct_tcp</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span> | |
| 92 | <span class="n">NMBSession</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">my_name</span><span class="p">,</span> <span class="n">remote_name</span><span class="p">,</span> <span class="n">is_direct_tcp</span> <span class="o">=</span> <span class="n">is_direct_tcp</span><span class="p">)</span> | |
| 93 | <span class="bp">self</span><span class="o">.</span><span class="n">username</span> <span class="o">=</span> <span class="n">username</span> | |
| 94 | <span class="bp">self</span><span class="o">.</span><span class="n">_password</span> <span class="o">=</span> <span class="n">password</span> | |
| 95 | <span class="bp">self</span><span class="o">.</span><span class="n">domain</span> <span class="o">=</span> <span class="n">domain</span> | |
| 126 | 96 | <span class="bp">self</span><span class="o">.</span><span class="n">sign_options</span> <span class="o">=</span> <span class="n">sign_options</span> |
| 127 | 97 | <span class="bp">self</span><span class="o">.</span><span class="n">is_direct_tcp</span> <span class="o">=</span> <span class="n">is_direct_tcp</span> |
| 128 | 98 | <span class="bp">self</span><span class="o">.</span><span class="n">use_ntlm_v2</span> <span class="o">=</span> <span class="n">use_ntlm_v2</span> <span class="c1">#: Similar to LMAuthenticationPolicy and NTAuthenticationPolicy as described in [MS-CIFS] 3.2.1.1</span> |
| 129 | 99 | <span class="bp">self</span><span class="o">.</span><span class="n">smb_message</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">()</span> |
| 130 | <span class="bp">self</span><span class="o">.</span><span class="n">is_using_smb2</span> <span class="o">=</span> <span class="bp">False</span> <span class="c1">#: Are we communicating using SMB2 protocol? self.smb_message will be a SMB2Message instance if this flag is True</span> | |
| 100 | <span class="bp">self</span><span class="o">.</span><span class="n">is_using_smb2</span> <span class="o">=</span> <span class="kc">False</span> <span class="c1">#: Are we communicating using SMB2 protocol? self.smb_message will be a SMB2Message instance if this flag is True</span> | |
| 101 | <span class="bp">self</span><span class="o">.</span><span class="n">async_requests</span> <span class="o">=</span> <span class="p">{</span> <span class="p">}</span> <span class="c1">#: AsyncID mapped to _PendingRequest instance</span> | |
| 131 | 102 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span> <span class="o">=</span> <span class="p">{</span> <span class="p">}</span> <span class="c1">#: MID mapped to _PendingRequest instance</span> |
| 132 | 103 | <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span> <span class="o">=</span> <span class="p">{</span> <span class="p">}</span> <span class="c1">#: Share name mapped to TID</span> |
| 133 | 104 | <span class="bp">self</span><span class="o">.</span><span class="n">next_rpc_call_id</span> <span class="o">=</span> <span class="mi">1</span> <span class="c1">#: Next RPC callID value. Not used directly in SMB message. Usually encapsulated in sub-commands under SMB_COM_TRANSACTION or SMB_COM_TRANSACTION2 messages</span> |
| 134 | 105 | |
| 135 | <span class="bp">self</span><span class="o">.</span><span class="n">has_negotiated</span> <span class="o">=</span> <span class="bp">False</span> | |
| 136 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="bp">False</span> | |
| 137 | <span class="bp">self</span><span class="o">.</span><span class="n">is_signing_active</span> <span class="o">=</span> <span class="bp">False</span> <span class="c1">#: 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</span> | |
| 138 | <span class="bp">self</span><span class="o">.</span><span class="n">signing_session_key</span> <span class="o">=</span> <span class="bp">None</span> <span class="c1">#: Session key for signing packets, if signing is active. Similar to SigningSessionKey as described in [MS-CIFS] 3.2.1.2</span> | |
| 139 | <span class="bp">self</span><span class="o">.</span><span class="n">signing_challenge_response</span> <span class="o">=</span> <span class="bp">None</span> <span class="c1">#: Contains the challenge response for signing, if signing is active. Similar to SigningChallengeResponse as described in [MS-CIFS] 3.2.1.2</span> | |
| 106 | <span class="bp">self</span><span class="o">.</span><span class="n">has_negotiated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 107 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 108 | <span class="bp">self</span><span class="o">.</span><span class="n">is_signing_active</span> <span class="o">=</span> <span class="kc">False</span> <span class="c1">#: 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</span> | |
| 109 | <span class="bp">self</span><span class="o">.</span><span class="n">signing_session_key</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1">#: Session key for signing packets, if signing is active. Similar to SigningSessionKey as described in [MS-CIFS] 3.2.1.2</span> | |
| 110 | <span class="bp">self</span><span class="o">.</span><span class="n">signing_challenge_response</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1">#: Contains the challenge response for signing, if signing is active. Similar to SigningChallengeResponse as described in [MS-CIFS] 3.2.1.2</span> | |
| 140 | 111 | <span class="bp">self</span><span class="o">.</span><span class="n">mid</span> <span class="o">=</span> <span class="mi">0</span> |
| 141 | 112 | <span class="bp">self</span><span class="o">.</span><span class="n">uid</span> <span class="o">=</span> <span class="mi">0</span> |
| 142 | 113 | <span class="bp">self</span><span class="o">.</span><span class="n">next_signing_id</span> <span class="o">=</span> <span class="mi">2</span> <span class="c1">#: Similar to ClientNextSendSequenceNumber as described in [MS-CIFS] 3.2.1.2</span> |
| 148 | 119 | |
| 149 | 120 | <span class="c1"># SMB1 attributes</span> |
| 150 | 121 | <span class="c1"># Most of the following attributes will be initialized upon receipt of SMB_COM_NEGOTIATE message from server (via self._updateServerInfo_SMB1 method)</span> |
| 151 | <span class="bp">self</span><span class="o">.</span><span class="n">use_plaintext_authentication</span> <span class="o">=</span> <span class="bp">False</span> <span class="c1">#: Similar to PlaintextAuthenticationPolicy in in [MS-CIFS] 3.2.1.1</span> | |
| 122 | <span class="bp">self</span><span class="o">.</span><span class="n">use_plaintext_authentication</span> <span class="o">=</span> <span class="kc">False</span> <span class="c1">#: Similar to PlaintextAuthenticationPolicy in in [MS-CIFS] 3.2.1.1</span> | |
| 152 | 123 | <span class="bp">self</span><span class="o">.</span><span class="n">max_raw_size</span> <span class="o">=</span> <span class="mi">0</span> |
| 153 | 124 | <span class="bp">self</span><span class="o">.</span><span class="n">max_buffer_size</span> <span class="o">=</span> <span class="mi">0</span> <span class="c1">#: Similar to MaxBufferSize as described in [MS-CIFS] 3.2.1.1</span> |
| 154 | 125 | <span class="bp">self</span><span class="o">.</span><span class="n">max_mpx_count</span> <span class="o">=</span> <span class="mi">0</span> <span class="c1">#: Similar to MaxMpxCount as described in [MS-CIFS] 3.2.1.1</span> |
| 166 | 137 | <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">use_ntlm_v2</span> <span class="ow">and</span> <span class="s1">'v2'</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">'v1'</span><span class="p">,</span> |
| 167 | 138 | <span class="p">(</span><span class="n">SUPPORT_EXTENDED_SECURITY</span> <span class="ow">and</span> <span class="s1">'with'</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">'without'</span><span class="p">)</span> |
| 168 | 139 | |
| 140 | <span class="nd">@property</span> | |
| 141 | <span class="k">def</span> <span class="nf">password</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 142 | <span class="k">if</span> <span class="n">callable</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_password</span><span class="p">):</span> | |
| 143 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_password</span><span class="p">()</span> | |
| 144 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_password</span> | |
| 169 | 145 | |
| 170 | 146 | <span class="c1">#</span> |
| 171 | 147 | <span class="c1"># NMBSession Methods</span> |
| 178 | 154 | <span class="k">pass</span> |
| 179 | 155 | |
| 180 | 156 | <span class="k">def</span> <span class="nf">onNMBSessionMessage</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">flags</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span> |
| 181 | <span class="k">while</span> <span class="bp">True</span><span class="p">:</span> | |
| 157 | <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> | |
| 182 | 158 | <span class="k">try</span><span class="p">:</span> |
| 183 | 159 | <span class="n">i</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">smb_message</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> |
| 184 | 160 | <span class="k">except</span> <span class="n">SMB2ProtocolHeaderError</span><span class="p">:</span> |
| 185 | 161 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Now switching over to SMB2 protocol communication'</span><span class="p">)</span> |
| 186 | <span class="bp">self</span><span class="o">.</span><span class="n">is_using_smb2</span> <span class="o">=</span> <span class="bp">True</span> | |
| 162 | <span class="bp">self</span><span class="o">.</span><span class="n">is_using_smb2</span> <span class="o">=</span> <span class="kc">True</span> | |
| 187 | 163 | <span class="bp">self</span><span class="o">.</span><span class="n">mid</span> <span class="o">=</span> <span class="mi">0</span> <span class="c1"># Must reset messageID counter, or else remote SMB2 server will disconnect</span> |
| 188 | 164 | <span class="bp">self</span><span class="o">.</span><span class="n">_setupSMB2Methods</span><span class="p">()</span> |
| 189 | 165 | <span class="bp">self</span><span class="o">.</span><span class="n">smb_message</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_klassSMBMessage</span><span class="p">()</span> |
| 235 | 211 | <span class="bp">self</span><span class="o">.</span><span class="n">_listShares</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_listShares_SMB1</span> |
| 236 | 212 | <span class="bp">self</span><span class="o">.</span><span class="n">_listPath</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_listPath_SMB1</span> |
| 237 | 213 | <span class="bp">self</span><span class="o">.</span><span class="n">_listSnapshots</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_listSnapshots_SMB1</span> |
| 214 | <span class="bp">self</span><span class="o">.</span><span class="n">_getSecurity</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_getSecurity_SMB1</span> | |
| 238 | 215 | <span class="bp">self</span><span class="o">.</span><span class="n">_getAttributes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_getAttributes_SMB1</span> |
| 239 | 216 | <span class="bp">self</span><span class="o">.</span><span class="n">_retrieveFile</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_retrieveFile_SMB1</span> |
| 240 | 217 | <span class="bp">self</span><span class="o">.</span><span class="n">_retrieveFileFromOffset</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_retrieveFileFromOffset_SMB1</span> |
| 257 | 234 | <span class="bp">self</span><span class="o">.</span><span class="n">_listShares</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_listShares_SMB2</span> |
| 258 | 235 | <span class="bp">self</span><span class="o">.</span><span class="n">_listPath</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_listPath_SMB2</span> |
| 259 | 236 | <span class="bp">self</span><span class="o">.</span><span class="n">_listSnapshots</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_listSnapshots_SMB2</span> |
| 237 | <span class="bp">self</span><span class="o">.</span><span class="n">_getSecurity</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_getSecurity_SMB2</span> | |
| 260 | 238 | <span class="bp">self</span><span class="o">.</span><span class="n">_getAttributes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_getAttributes_SMB2</span> |
| 261 | 239 | <span class="bp">self</span><span class="o">.</span><span class="n">_retrieveFile</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_retrieveFile_SMB2</span> |
| 262 | 240 | <span class="bp">self</span><span class="o">.</span><span class="n">_retrieveFileFromOffset</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_retrieveFileFromOffset_SMB2</span> |
| 281 | 259 | <span class="k">if</span> <span class="n">smb_message</span><span class="o">.</span><span class="n">mid</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 282 | 260 | <span class="n">smb_message</span><span class="o">.</span><span class="n">mid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_getNextMID_SMB2</span><span class="p">()</span> |
| 283 | 261 | |
| 284 | <span class="k">if</span> <span class="n">smb_message</span><span class="o">.</span><span class="n">command</span> <span class="o">!=</span> <span class="n">SMB2_COM_NEGOTIATE</span> <span class="ow">and</span> <span class="n">smb_message</span><span class="o">.</span><span class="n">command</span> <span class="o">!=</span> <span class="n">SMB2_COM_ECHO</span><span class="p">:</span> | |
| 262 | <span class="k">if</span> <span class="n">smb_message</span><span class="o">.</span><span class="n">command</span> <span class="o">!=</span> <span class="n">SMB2_COM_NEGOTIATE</span><span class="p">:</span> | |
| 285 | 263 | <span class="n">smb_message</span><span class="o">.</span><span class="n">session_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">session_id</span> |
| 286 | 264 | |
| 287 | 265 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_signing_active</span><span class="p">:</span> |
| 303 | 281 | <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">isReply</span><span class="p">:</span> |
| 304 | 282 | <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">command</span> <span class="o">==</span> <span class="n">SMB2_COM_NEGOTIATE</span><span class="p">:</span> |
| 305 | 283 | <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 306 | <span class="bp">self</span><span class="o">.</span><span class="n">has_negotiated</span> <span class="o">=</span> <span class="bp">True</span> | |
| 284 | <span class="bp">self</span><span class="o">.</span><span class="n">has_negotiated</span> <span class="o">=</span> <span class="kc">True</span> | |
| 307 | 285 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'SMB2 dialect negotiation successful'</span><span class="p">)</span> |
| 308 | 286 | <span class="bp">self</span><span class="o">.</span><span class="n">_updateServerInfo</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">payload</span><span class="p">)</span> |
| 309 | 287 | <span class="bp">self</span><span class="o">.</span><span class="n">_handleNegotiateResponse</span><span class="p">(</span><span class="n">message</span><span class="p">)</span> |
| 316 | 294 | <span class="k">try</span><span class="p">:</span> |
| 317 | 295 | <span class="n">result</span> <span class="o">=</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">decodeAuthResponseSecurityBlob</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">security_blob</span><span class="p">)</span> |
| 318 | 296 | <span class="k">if</span> <span class="n">result</span> <span class="o">==</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">RESULT_ACCEPT_COMPLETED</span><span class="p">:</span> |
| 319 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="bp">True</span> | |
| 297 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">True</span> | |
| 320 | 298 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (on SMB2) successful!'</span><span class="p">)</span> |
| 299 | ||
| 300 | <span class="c1"># [MS-SMB2]: 3.2.5.3.1</span> | |
| 301 | <span class="c1"># If the security subsystem indicates that the session was established by an anonymous user,</span> | |
| 302 | <span class="c1"># Session.SigningRequired MUST be set to FALSE.</span> | |
| 303 | <span class="c1"># If the SMB2_SESSION_FLAG_IS_GUEST bit is set in the SessionFlags field of the</span> | |
| 304 | <span class="c1"># SMB2 SESSION_SETUP Response and if Session.SigningRequired is TRUE, this indicates a SESSION_SETUP</span> | |
| 305 | <span class="c1"># failure and the connection MUST be terminated. If the SMB2_SESSION_FLAG_IS_GUEST bit is set in the SessionFlags</span> | |
| 306 | <span class="c1"># field of the SMB2 SESSION_SETUP Response and if RequireMessageSigning is FALSE, Session.SigningRequired</span> | |
| 307 | <span class="c1"># MUST be set to FALSE.</span> | |
| 308 | <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">isGuestSession</span> <span class="ow">or</span> <span class="n">message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">isAnonymousSession</span><span class="p">:</span> | |
| 309 | <span class="bp">self</span><span class="o">.</span><span class="n">is_signing_active</span> <span class="o">=</span> <span class="kc">False</span> | |
| 310 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Signing disabled because session is guest/anonymous'</span><span class="p">)</span> | |
| 311 | ||
| 321 | 312 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthOK</span><span class="p">()</span> |
| 322 | 313 | <span class="k">else</span><span class="p">:</span> |
| 323 | 314 | <span class="k">raise</span> <span class="n">ProtocolError</span><span class="p">(</span><span class="s1">'SMB2_COM_SESSION_SETUP status is 0 but security blob negResult value is </span><span class="si">%d</span><span class="s1">'</span> <span class="o">%</span> <span class="n">result</span><span class="p">,</span> <span class="n">message</span><span class="o">.</span><span class="n">raw_data</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span> |
| 324 | <span class="k">except</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">BadSecurityBlobError</span><span class="p">,</span> <span class="n">ex</span><span class="p">:</span> | |
| 315 | <span class="k">except</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">BadSecurityBlobError</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span> | |
| 325 | 316 | <span class="k">raise</span> <span class="n">ProtocolError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">),</span> <span class="n">message</span><span class="o">.</span><span class="n">raw_data</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span> |
| 326 | 317 | <span class="k">elif</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xc0000016</span><span class="p">:</span> <span class="c1"># STATUS_MORE_PROCESSING_REQUIRED</span> |
| 327 | 318 | <span class="bp">self</span><span class="o">.</span><span class="n">session_id</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">session_id</span> |
| 329 | 320 | <span class="n">result</span><span class="p">,</span> <span class="n">ntlm_token</span> <span class="o">=</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">decodeChallengeSecurityBlob</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">security_blob</span><span class="p">)</span> |
| 330 | 321 | <span class="k">if</span> <span class="n">result</span> <span class="o">==</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">RESULT_ACCEPT_INCOMPLETE</span><span class="p">:</span> |
| 331 | 322 | <span class="bp">self</span><span class="o">.</span><span class="n">_handleSessionChallenge</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">ntlm_token</span><span class="p">)</span> |
| 332 | <span class="k">except</span> <span class="p">(</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">BadSecurityBlobError</span><span class="p">,</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">UnsupportedSecurityProvider</span> <span class="p">),</span> <span class="n">ex</span><span class="p">:</span> | |
| 323 | <span class="k">except</span> <span class="p">(</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">BadSecurityBlobError</span><span class="p">,</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">UnsupportedSecurityProvider</span> <span class="p">)</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span> | |
| 333 | 324 | <span class="k">raise</span> <span class="n">ProtocolError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">),</span> <span class="n">message</span><span class="o">.</span><span class="n">raw_data</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span> |
| 334 | <span class="k">elif</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xc000006d</span><span class="p">:</span> <span class="c1"># STATUS_LOGON_FAILURE</span> | |
| 335 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="bp">False</span> | |
| 325 | <span class="k">elif</span> <span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xc000006d</span> <span class="c1"># STATUS_LOGON_FAILURE</span> | |
| 326 | <span class="ow">or</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xc0000064</span> <span class="c1"># STATUS_NO_SUCH_USER</span> | |
| 327 | <span class="ow">or</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xc000006a</span><span class="p">):</span><span class="c1"># STATUS_WRONG_PASSWORD</span> | |
| 328 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 336 | 329 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (on SMB2) failed. Please check username and password.'</span><span class="p">)</span> |
| 337 | 330 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> |
| 331 | <span class="k">elif</span> <span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xc0000193</span> <span class="c1"># STATUS_ACCOUNT_EXPIRED</span> | |
| 332 | <span class="ow">or</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xC0000071</span><span class="p">):</span> <span class="c1"># STATUS_PASSWORD_EXPIRED</span> | |
| 333 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 334 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (on SMB2) failed. Account or password has expired.'</span><span class="p">)</span> | |
| 335 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> | |
| 336 | <span class="k">elif</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xc0000234</span><span class="p">:</span> <span class="c1"># STATUS_ACCOUNT_LOCKED_OUT</span> | |
| 337 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 338 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (on SMB2) failed. Account has been locked due to too many invalid logon attempts.'</span><span class="p">)</span> | |
| 339 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> | |
| 340 | <span class="k">elif</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xc0000072</span><span class="p">:</span> <span class="c1"># STATUS_ACCOUNT_DISABLED</span> | |
| 341 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 342 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (on SMB2) failed. Account has been disabled.'</span><span class="p">)</span> | |
| 343 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> | |
| 344 | <span class="k">elif</span> <span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xc000006f</span> <span class="c1"># STATUS_INVALID_LOGON_HOURS</span> | |
| 345 | <span class="ow">or</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xc000015b</span> <span class="c1"># STATUS_LOGON_TYPE_NOT_GRANTED</span> | |
| 346 | <span class="ow">or</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xc0000070</span><span class="p">):</span> <span class="c1"># STATUS_INVALID_WORKSTATION</span> | |
| 347 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 348 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (on SMB2) failed. Not allowed.'</span><span class="p">)</span> | |
| 349 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> | |
| 350 | <span class="k">elif</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xc000018c</span><span class="p">:</span> <span class="c1"># STATUS_TRUSTED_DOMAIN_FAILURE</span> | |
| 351 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 352 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (on SMB2) failed. Domain not trusted.'</span><span class="p">)</span> | |
| 353 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> | |
| 354 | <span class="k">elif</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xc000018d</span><span class="p">:</span> <span class="c1"># STATUS_TRUSTED_RELATIONSHIP_FAILURE</span> | |
| 355 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 356 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (on SMB2) failed. Workstation not trusted.'</span><span class="p">)</span> | |
| 357 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> | |
| 338 | 358 | <span class="k">else</span><span class="p">:</span> |
| 339 | 359 | <span class="k">raise</span> <span class="n">ProtocolError</span><span class="p">(</span><span class="s1">'Unknown status value (0x</span><span class="si">%08X</span><span class="s1">) in SMB_COM_SESSION_SETUP_ANDX (with extended security)'</span> <span class="o">%</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="p">,</span> |
| 340 | 360 | <span class="n">message</span><span class="o">.</span><span class="n">raw_data</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span> |
| 341 | 361 | |
| 342 | <span class="n">req</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span> | |
| 343 | <span class="k">if</span> <span class="n">req</span><span class="p">:</span> | |
| 344 | <span class="n">req</span><span class="o">.</span><span class="n">callback</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="o">**</span><span class="n">req</span><span class="o">.</span><span class="n">kwargs</span><span class="p">)</span> | |
| 345 | <span class="k">return</span> <span class="bp">True</span> | |
| 362 | <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">isAsync</span><span class="p">:</span> | |
| 363 | <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0x00000103</span><span class="p">:</span> <span class="c1"># STATUS_PENDING</span> | |
| 364 | <span class="n">req</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> | |
| 365 | <span class="k">if</span> <span class="n">req</span><span class="p">:</span> | |
| 366 | <span class="bp">self</span><span class="o">.</span><span class="n">async_requests</span><span class="p">[</span><span class="n">message</span><span class="o">.</span><span class="n">async_id</span><span class="p">]</span> <span class="o">=</span> <span class="n">req</span> | |
| 367 | <span class="k">else</span><span class="p">:</span> <span class="c1"># All other status including SUCCESS</span> | |
| 368 | <span class="n">req</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">async_requests</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">async_id</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> | |
| 369 | <span class="k">if</span> <span class="n">req</span><span class="p">:</span> | |
| 370 | <span class="n">req</span><span class="o">.</span><span class="n">callback</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="o">**</span><span class="n">req</span><span class="o">.</span><span class="n">kwargs</span><span class="p">)</span> | |
| 371 | <span class="k">return</span> <span class="kc">True</span> | |
| 372 | <span class="k">else</span><span class="p">:</span> | |
| 373 | <span class="n">req</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> | |
| 374 | <span class="k">if</span> <span class="n">req</span><span class="p">:</span> | |
| 375 | <span class="n">req</span><span class="o">.</span><span class="n">callback</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="o">**</span><span class="n">req</span><span class="o">.</span><span class="n">kwargs</span><span class="p">)</span> | |
| 376 | <span class="k">return</span> <span class="kc">True</span> | |
| 346 | 377 | |
| 347 | 378 | |
| 348 | 379 | <span class="k">def</span> <span class="nf">_updateServerInfo_SMB2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">payload</span><span class="p">):</span> |
| 351 | 382 | <span class="bp">self</span><span class="o">.</span><span class="n">max_transact_size</span> <span class="o">=</span> <span class="n">payload</span><span class="o">.</span><span class="n">max_transact_size</span> |
| 352 | 383 | <span class="bp">self</span><span class="o">.</span><span class="n">max_read_size</span> <span class="o">=</span> <span class="n">payload</span><span class="o">.</span><span class="n">max_read_size</span> |
| 353 | 384 | <span class="bp">self</span><span class="o">.</span><span class="n">max_write_size</span> <span class="o">=</span> <span class="n">payload</span><span class="o">.</span><span class="n">max_write_size</span> |
| 354 | <span class="bp">self</span><span class="o">.</span><span class="n">use_plaintext_authentication</span> <span class="o">=</span> <span class="bp">False</span> <span class="c1"># SMB2 never allows plaintext authentication</span> | |
| 385 | <span class="bp">self</span><span class="o">.</span><span class="n">use_plaintext_authentication</span> <span class="o">=</span> <span class="kc">False</span> <span class="c1"># SMB2 never allows plaintext authentication</span> | |
| 355 | 386 | |
| 356 | 387 | |
| 357 | 388 | <span class="k">def</span> <span class="nf">_handleNegotiateResponse_SMB2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> |
| 375 | 406 | |
| 376 | 407 | <span class="k">else</span><span class="p">:</span> |
| 377 | 408 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Performing NTLMv1 authentication (on SMB2) with server challenge "</span><span class="si">%s</span><span class="s1">"'</span><span class="p">,</span> <span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="n">server_challenge</span><span class="p">))</span> |
| 378 | <span class="n">nt_challenge_response</span><span class="p">,</span> <span class="n">lm_challenge_response</span><span class="p">,</span> <span class="n">session_key</span> <span class="o">=</span> <span class="n">ntlm</span><span class="o">.</span><span class="n">generateChallengeResponseV1</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">,</span> <span class="n">server_challenge</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span> | |
| 379 | ||
| 380 | <span class="n">ntlm_data</span> <span class="o">=</span> <span class="n">ntlm</span><span class="o">.</span><span class="n">generateAuthenticateMessage</span><span class="p">(</span><span class="n">server_flags</span><span class="p">,</span> | |
| 381 | <span class="n">nt_challenge_response</span><span class="p">,</span> | |
| 382 | <span class="n">lm_challenge_response</span><span class="p">,</span> | |
| 383 | <span class="n">session_key</span><span class="p">,</span> | |
| 384 | <span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="p">,</span> | |
| 385 | <span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="p">)</span> | |
| 409 | <span class="n">nt_challenge_response</span><span class="p">,</span> <span class="n">lm_challenge_response</span><span class="p">,</span> <span class="n">session_key</span> <span class="o">=</span> <span class="n">ntlm</span><span class="o">.</span><span class="n">generateChallengeResponseV1</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">,</span> <span class="n">server_challenge</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span> | |
| 410 | ||
| 411 | <span class="n">ntlm_data</span><span class="p">,</span> <span class="n">session_signing_key</span> <span class="o">=</span> <span class="n">ntlm</span><span class="o">.</span><span class="n">generateAuthenticateMessage</span><span class="p">(</span><span class="n">server_flags</span><span class="p">,</span> | |
| 412 | <span class="n">nt_challenge_response</span><span class="p">,</span> | |
| 413 | <span class="n">lm_challenge_response</span><span class="p">,</span> | |
| 414 | <span class="n">session_key</span><span class="p">,</span> | |
| 415 | <span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="p">,</span> | |
| 416 | <span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="p">,</span> | |
| 417 | <span class="bp">self</span><span class="o">.</span><span class="n">my_name</span><span class="p">)</span> | |
| 386 | 418 | |
| 387 | 419 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">isEnabledFor</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">):</span> |
| 388 | 420 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'NT challenge response is "</span><span class="si">%s</span><span class="s1">" (</span><span class="si">%d</span><span class="s1"> bytes)'</span><span class="p">,</span> <span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="n">nt_challenge_response</span><span class="p">),</span> <span class="nb">len</span><span class="p">(</span><span class="n">nt_challenge_response</span><span class="p">))</span> |
| 398 | 430 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Server supports SMB signing'</span><span class="p">)</span> |
| 399 | 431 | <span class="bp">self</span><span class="o">.</span><span class="n">is_signing_active</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sign_options</span> <span class="o">==</span> <span class="n">SMB</span><span class="o">.</span><span class="n">SIGN_WHEN_SUPPORTED</span><span class="p">)</span> |
| 400 | 432 | <span class="k">else</span><span class="p">:</span> |
| 401 | <span class="bp">self</span><span class="o">.</span><span class="n">is_signing_active</span> <span class="o">=</span> <span class="bp">False</span> | |
| 433 | <span class="bp">self</span><span class="o">.</span><span class="n">is_signing_active</span> <span class="o">=</span> <span class="kc">False</span> | |
| 402 | 434 | |
| 403 | 435 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_signing_active</span><span class="p">:</span> |
| 404 | 436 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"SMB signing activated. All SMB messages will be signed."</span><span class="p">)</span> |
| 405 | <span class="bp">self</span><span class="o">.</span><span class="n">signing_session_key</span> <span class="o">=</span> <span class="p">(</span><span class="n">session_key</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="o">*</span><span class="mi">16</span><span class="p">)[:</span><span class="mi">16</span><span class="p">]</span> | |
| 437 | <span class="bp">self</span><span class="o">.</span><span class="n">signing_session_key</span> <span class="o">=</span> <span class="n">session_signing_key</span> | |
| 438 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">isEnabledFor</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">):</span> | |
| 439 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"SMB signing key is </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">signing_session_key</span><span class="p">))</span> | |
| 440 | ||
| 406 | 441 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">capabilities</span> <span class="o">&</span> <span class="n">CAP_EXTENDED_SECURITY</span><span class="p">:</span> |
| 407 | <span class="bp">self</span><span class="o">.</span><span class="n">signing_challenge_response</span> <span class="o">=</span> <span class="bp">None</span> | |
| 442 | <span class="bp">self</span><span class="o">.</span><span class="n">signing_challenge_response</span> <span class="o">=</span> <span class="kc">None</span> | |
| 408 | 443 | <span class="k">else</span><span class="p">:</span> |
| 409 | 444 | <span class="bp">self</span><span class="o">.</span><span class="n">signing_challenge_response</span> <span class="o">=</span> <span class="n">blob</span> |
| 410 | 445 | <span class="k">else</span><span class="p">:</span> |
| 431 | 466 | |
| 432 | 467 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 433 | 468 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 434 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectSrvSvcCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">)</span> | |
| 469 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectSrvSvcCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span><span class="p">)</span> | |
| 435 | 470 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 436 | 471 | |
| 437 | 472 | <span class="k">def</span> <span class="nf">connectSrvSvcCB</span><span class="p">(</span><span class="n">create_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 441 | 476 | <span class="c1"># The data_bytes are binding call to Server Service RPC using DCE v1.1 RPC over SMB. See [MS-SRVS] and [C706]</span> |
| 442 | 477 | <span class="c1"># 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</span> |
| 443 | 478 | <span class="n">data_bytes</span> <span class="o">=</span> \ |
| 444 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""05 00 0b 03 10 00 00 00 74 00 00 00"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> <span class="o">+</span> \ | |
| 479 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""05 00 0b 03 10 00 00 00 74 00 00 00"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> <span class="o">+</span> \ | |
| 445 | 480 | <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<I'</span><span class="p">,</span> <span class="n">call_id</span><span class="p">)</span> <span class="o">+</span> \ |
| 446 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""</span> | |
| 481 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""</span> | |
| 447 | 482 | <span class="s2">b8 10 b8 10 00 00 00 00 02 00 00 00 00 00 01 00</span> |
| 448 | 483 | <span class="s2">c8 4f 32 4b 70 16 d3 01 12 78 5a 47 bf 6e e1 88</span> |
| 449 | 484 | <span class="s2">03 00 00 00 04 5d 88 8a eb 1c c9 11 9f e8 08 00</span> |
| 451 | 486 | <span class="s2">70 16 d3 01 12 78 5a 47 bf 6e e1 88 03 00 00 00</span> |
| 452 | 487 | <span class="s2">2c 1c b7 6c 12 98 40 45 03 00 00 00 00 00 00 00</span> |
| 453 | 488 | <span class="s2">01 00 00 00</span> |
| 454 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 489 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> | |
| 455 | 490 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2WriteRequest</span><span class="p">(</span><span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">,</span> <span class="n">data_bytes</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span> |
| 456 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">create_message</span><span class="o">.</span><span class="n">tid</span> | |
| 491 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">]</span> | |
| 457 | 492 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 458 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">rpcBindCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> | |
| 493 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">rpcBindCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> | |
| 459 | 494 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 460 | 495 | <span class="k">else</span><span class="p">:</span> |
| 461 | 496 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list shares: Unable to locate Server Service RPC endpoint'</span><span class="p">,</span> <span class="n">messages_history</span><span class="p">))</span> |
| 464 | 499 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">trans_message</span><span class="p">)</span> |
| 465 | 500 | <span class="k">if</span> <span class="n">trans_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 466 | 501 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2ReadRequest</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">read_len</span> <span class="o">=</span> <span class="mi">1024</span><span class="p">,</span> <span class="n">read_offset</span> <span class="o">=</span> <span class="mi">0</span><span class="p">))</span> |
| 467 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">trans_message</span><span class="o">.</span><span class="n">tid</span> | |
| 502 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">]</span> | |
| 468 | 503 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 469 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">rpcReadCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">])</span> | |
| 504 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">rpcReadCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">])</span> | |
| 470 | 505 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 471 | 506 | <span class="k">else</span><span class="p">:</span> |
| 472 | <span class="n">closeFid</span><span class="p">(</span><span class="n">trans_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">error</span> <span class="o">=</span> <span class="s1">'Failed to list shares: Unable to read from Server Service RPC endpoint'</span><span class="p">)</span> | |
| 507 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">error</span> <span class="o">=</span> <span class="s1">'Failed to list shares: Unable to read from Server Service RPC endpoint'</span><span class="p">)</span> | |
| 473 | 508 | |
| 474 | 509 | <span class="k">def</span> <span class="nf">rpcReadCB</span><span class="p">(</span><span class="n">read_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 475 | 510 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">read_message</span><span class="p">)</span> |
| 476 | 511 | <span class="k">if</span> <span class="n">read_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 477 | 512 | <span class="n">call_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_getNextRPCCallID</span><span class="p">()</span> |
| 478 | 513 | |
| 479 | <span class="n">padding</span> <span class="o">=</span> <span class="s1">''</span> | |
| 514 | <span class="n">padding</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 480 | 515 | <span class="n">remote_name</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\\\\</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span> |
| 481 | 516 | <span class="n">server_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">remote_name</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> |
| 482 | 517 | <span class="n">server_bytes_len</span> <span class="o">=</span> <span class="n">server_len</span> <span class="o">*</span> <span class="mi">2</span> |
| 483 | 518 | <span class="k">if</span> <span class="n">server_len</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 484 | <span class="n">padding</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 519 | <span class="n">padding</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 485 | 520 | <span class="n">server_bytes_len</span> <span class="o">+=</span> <span class="mi">2</span> |
| 486 | 521 | |
| 487 | 522 | <span class="c1"># The data bytes are the RPC call to NetrShareEnum (Opnum 15) at Server Service RPC.</span> |
| 488 | 523 | <span class="c1"># 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</span> |
| 489 | 524 | <span class="n">data_bytes</span> <span class="o">=</span> \ |
| 490 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""05 00 00 03 10 00 00 00"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> <span class="o">+</span> \ | |
| 525 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""05 00 00 03 10 00 00 00"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> <span class="o">+</span> \ | |
| 491 | 526 | <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<HHI'</span><span class="p">,</span> <span class="mi">72</span><span class="o">+</span><span class="n">server_bytes_len</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">call_id</span><span class="p">)</span> <span class="o">+</span> \ |
| 492 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""4c 00 00 00 00 00 0f 00 00 00 02 00"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> <span class="o">+</span> \ | |
| 527 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""4c 00 00 00 00 00 0f 00 00 00 02 00"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> <span class="o">+</span> \ | |
| 493 | 528 | <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<III'</span><span class="p">,</span> <span class="n">server_len</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">server_len</span><span class="p">)</span> <span class="o">+</span> \ |
| 494 | 529 | <span class="p">(</span><span class="n">remote_name</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="n">padding</span> <span class="o">+</span> \ |
| 495 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""</span> | |
| 530 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""</span> | |
| 496 | 531 | <span class="s2">01 00 00 00 01 00 00 00 04 00 02 00 00 00 00 00</span> |
| 497 | 532 | <span class="s2">00 00 00 00 ff ff ff ff 08 00 02 00 00 00 00 00</span> |
| 498 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 533 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> | |
| 499 | 534 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2IoctlRequest</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="mh">0x0011C017</span><span class="p">,</span> <span class="n">flags</span> <span class="o">=</span> <span class="mh">0x01</span><span class="p">,</span> <span class="n">max_out_size</span> <span class="o">=</span> <span class="mi">8196</span><span class="p">,</span> <span class="n">in_data</span> <span class="o">=</span> <span class="n">data_bytes</span><span class="p">))</span> |
| 500 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">read_message</span><span class="o">.</span><span class="n">tid</span> | |
| 535 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">]</span> | |
| 501 | 536 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 502 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">listShareResultsCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">])</span> | |
| 537 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">listShareResultsCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">])</span> | |
| 503 | 538 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 504 | 539 | <span class="k">else</span><span class="p">:</span> |
| 505 | <span class="n">closeFid</span><span class="p">(</span><span class="n">read_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">error</span> <span class="o">=</span> <span class="s1">'Failed to list shares: Unable to bind to Server Service RPC endpoint'</span><span class="p">)</span> | |
| 540 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">error</span> <span class="o">=</span> <span class="s1">'Failed to list shares: Unable to bind to Server Service RPC endpoint'</span><span class="p">)</span> | |
| 506 | 541 | |
| 507 | 542 | <span class="k">def</span> <span class="nf">listShareResultsCB</span><span class="p">(</span><span class="n">result_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 508 | 543 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">result_message</span><span class="p">)</span> |
| 510 | 545 | <span class="c1"># The payload.data_bytes will contain the results of the RPC call to NetrShareEnum (Opnum 15) at Server Service RPC.</span> |
| 511 | 546 | <span class="n">data_bytes</span> <span class="o">=</span> <span class="n">result_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">out_data</span> |
| 512 | 547 | |
| 513 | <span class="k">if</span> <span class="nb">ord</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">[</span><span class="mi">3</span><span class="p">])</span> <span class="o">&</span> <span class="mh">0x02</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> | |
| 514 | <span class="n">sendReadRequest</span><span class="p">(</span><span class="n">result_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">data_bytes</span><span class="p">)</span> | |
| 515 | <span class="k">else</span><span class="p">:</span> | |
| 516 | <span class="n">decodeResults</span><span class="p">(</span><span class="n">result_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">data_bytes</span><span class="p">)</span> | |
| 517 | <span class="k">elif</span> <span class="n">result_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0x0103</span><span class="p">:</span> <span class="c1"># STATUS_PENDING</span> | |
| 518 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">result_message</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">result_message</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">listShareResultsCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">])</span> | |
| 519 | <span class="k">else</span><span class="p">:</span> | |
| 520 | <span class="n">closeFid</span><span class="p">(</span><span class="n">result_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">])</span> | |
| 548 | <span class="k">if</span> <span class="n">data_bytes</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">&</span> <span class="mh">0x02</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> | |
| 549 | <span class="n">sendReadRequest</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">data_bytes</span><span class="p">)</span> | |
| 550 | <span class="k">else</span><span class="p">:</span> | |
| 551 | <span class="n">decodeResults</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">data_bytes</span><span class="p">)</span> | |
| 552 | <span class="k">else</span><span class="p">:</span> | |
| 553 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">])</span> | |
| 521 | 554 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list shares: Unable to retrieve shared device list'</span><span class="p">,</span> <span class="n">messages_history</span><span class="p">))</span> |
| 522 | 555 | |
| 523 | 556 | <span class="k">def</span> <span class="nf">decodeResults</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">data_bytes</span><span class="p">):</span> |
| 525 | 558 | <span class="n">results</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> <span class="c1"># A list of SharedDevice instances</span> |
| 526 | 559 | <span class="n">offset</span> <span class="o">=</span> <span class="mi">36</span> <span class="o">+</span> <span class="mi">12</span> <span class="c1"># You need to study the byte stream to understand the meaning of these constants</span> |
| 527 | 560 | <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">shares_count</span><span class="p">):</span> |
| 528 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">SharedDevice</span><span class="p">(</span><span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<I'</span><span class="p">,</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="mi">8</span><span class="p">])[</span><span class="mi">0</span><span class="p">],</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">))</span> | |
| 561 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">SharedDevice</span><span class="p">(</span><span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<I'</span><span class="p">,</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="mi">8</span><span class="p">])[</span><span class="mi">0</span><span class="p">],</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span> | |
| 529 | 562 | <span class="n">offset</span> <span class="o">+=</span> <span class="mi">12</span> |
| 530 | 563 | |
| 531 | 564 | <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">shares_count</span><span class="p">):</span> |
| 532 | 565 | <span class="n">max_length</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">length</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<III'</span><span class="p">,</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="mi">12</span><span class="p">])</span> |
| 533 | 566 | <span class="n">offset</span> <span class="o">+=</span> <span class="mi">12</span> |
| 534 | <span class="n">results</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="nb">unicode</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="n">length</span><span class="o">*</span><span class="mi">2</span><span class="o">-</span><span class="mi">2</span><span class="p">],</span> <span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 567 | <span class="n">results</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="n">length</span><span class="o">*</span><span class="mi">2</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 535 | 568 | |
| 536 | 569 | <span class="k">if</span> <span class="n">length</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 537 | 570 | <span class="n">offset</span> <span class="o">+=</span> <span class="p">(</span><span class="n">length</span> <span class="o">*</span> <span class="mi">2</span> <span class="o">+</span> <span class="mi">2</span><span class="p">)</span> |
| 540 | 573 | |
| 541 | 574 | <span class="n">max_length</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">length</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<III'</span><span class="p">,</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="mi">12</span><span class="p">])</span> |
| 542 | 575 | <span class="n">offset</span> <span class="o">+=</span> <span class="mi">12</span> |
| 543 | <span class="n">results</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">comments</span> <span class="o">=</span> <span class="nb">unicode</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="n">length</span><span class="o">*</span><span class="mi">2</span><span class="o">-</span><span class="mi">2</span><span class="p">],</span> <span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 576 | <span class="n">results</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">comments</span> <span class="o">=</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="n">length</span><span class="o">*</span><span class="mi">2</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 544 | 577 | |
| 545 | 578 | <span class="k">if</span> <span class="n">length</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 546 | 579 | <span class="n">offset</span> <span class="o">+=</span> <span class="p">(</span><span class="n">length</span> <span class="o">*</span> <span class="mi">2</span> <span class="o">+</span> <span class="mi">2</span><span class="p">)</span> |
| 556 | 589 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 557 | 590 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 558 | 591 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">readCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> |
| 559 | <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">,</span> <span class="n">data_bytes</span> <span class="o">=</span> <span class="n">data_bytes</span><span class="p">)</span> | |
| 592 | <span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">,</span> <span class="n">data_bytes</span> <span class="o">=</span> <span class="n">data_bytes</span><span class="p">)</span> | |
| 560 | 593 | |
| 561 | 594 | <span class="k">def</span> <span class="nf">readCB</span><span class="p">(</span><span class="n">read_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 562 | 595 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">read_message</span><span class="p">)</span> |
| 563 | 596 | <span class="k">if</span> <span class="n">read_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 564 | <span class="n">data_len</span> <span class="o">=</span> <span class="n">read_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_length</span> | |
| 565 | 597 | <span class="n">data_bytes</span> <span class="o">=</span> <span class="n">read_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data</span> |
| 566 | 598 | |
| 567 | <span class="k">if</span> <span class="nb">ord</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">[</span><span class="mi">3</span><span class="p">])</span> <span class="o">&</span> <span class="mh">0x02</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> | |
| 568 | <span class="n">sendReadRequest</span><span class="p">(</span><span class="n">read_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_bytes'</span><span class="p">]</span> <span class="o">+</span> <span class="n">data_bytes</span><span class="p">[</span><span class="mi">24</span><span class="p">:</span><span class="n">data_len</span><span class="o">-</span><span class="mi">24</span><span class="p">])</span> | |
| 569 | <span class="k">else</span><span class="p">:</span> | |
| 570 | <span class="n">decodeResults</span><span class="p">(</span><span class="n">read_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_bytes'</span><span class="p">]</span> <span class="o">+</span> <span class="n">data_bytes</span><span class="p">[</span><span class="mi">24</span><span class="p">:</span><span class="n">data_len</span><span class="o">-</span><span class="mi">24</span><span class="p">])</span> | |
| 571 | <span class="k">else</span><span class="p">:</span> | |
| 572 | <span class="n">closeFid</span><span class="p">(</span><span class="n">read_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">])</span> | |
| 599 | <span class="k">if</span> <span class="n">data_bytes</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">&</span> <span class="mh">0x02</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> | |
| 600 | <span class="n">sendReadRequest</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_bytes'</span><span class="p">]</span> <span class="o">+</span> <span class="n">data_bytes</span><span class="p">[</span><span class="mi">24</span><span class="p">:])</span> | |
| 601 | <span class="k">else</span><span class="p">:</span> | |
| 602 | <span class="n">decodeResults</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_bytes'</span><span class="p">]</span> <span class="o">+</span> <span class="n">data_bytes</span><span class="p">[</span><span class="mi">24</span><span class="p">:])</span> | |
| 603 | <span class="k">else</span><span class="p">:</span> | |
| 604 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">])</span> | |
| 573 | 605 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list shares: Unable to retrieve shared device list'</span><span class="p">,</span> <span class="n">messages_history</span><span class="p">))</span> |
| 574 | 606 | |
| 575 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">results</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">error</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span> | |
| 607 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">results</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">error</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span> | |
| 576 | 608 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CloseRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">))</span> |
| 577 | 609 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 578 | 610 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 580 | 612 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 581 | 613 | |
| 582 | 614 | <span class="k">def</span> <span class="nf">closeCB</span><span class="p">(</span><span class="n">close_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 583 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'results'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span> | |
| 615 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'results'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> | |
| 584 | 616 | <span class="n">callback</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'results'</span><span class="p">])</span> |
| 585 | <span class="k">elif</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span> | |
| 617 | <span class="k">elif</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> | |
| 586 | 618 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">],</span> <span class="n">messages_history</span><span class="p">))</span> |
| 587 | 619 | |
| 588 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">path</span><span class="p">):</span> | |
| 620 | <span class="k">if</span> <span class="n">path</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 589 | 621 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 590 | 622 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 591 | 623 | <span class="k">if</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 594 | 626 | <span class="k">else</span><span class="p">:</span> |
| 595 | 627 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list shares: Unable to connect to IPC$'</span><span class="p">,</span> <span class="n">messages_history</span><span class="p">))</span> |
| 596 | 628 | |
| 597 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">path</span> <span class="p">)))</span> | |
| 629 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">path</span> <span class="p">)))</span> | |
| 598 | 630 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 599 | 631 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="p">)</span> |
| 600 | 632 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 615 | 647 | <span class="n">results</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 616 | 648 | |
| 617 | 649 | <span class="k">def</span> <span class="nf">sendCreate</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> |
| 618 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""</span> | |
| 650 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""</span> | |
| 619 | 651 | <span class="s2">28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00</span> |
| 620 | 652 | <span class="s2">44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00</span> |
| 621 | 653 | <span class="s2">00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00</span> |
| 622 | 654 | <span class="s2">00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00</span> |
| 623 | 655 | <span class="s2">00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00</span> |
| 624 | 656 | <span class="s2">51 46 69 64 00 00 00 00</span> |
| 625 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 657 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> | |
| 626 | 658 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CreateRequest</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> |
| 627 | 659 | <span class="n">file_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 628 | 660 | <span class="n">access_mask</span> <span class="o">=</span> <span class="n">FILE_READ_DATA</span> <span class="o">|</span> <span class="n">FILE_READ_EA</span> <span class="o">|</span> <span class="n">FILE_READ_ATTRIBUTES</span> <span class="o">|</span> <span class="n">SYNCHRONIZE</span><span class="p">,</span> |
| 634 | 666 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">create_context_data</span><span class="p">))</span> |
| 635 | 667 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 636 | 668 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 637 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">createCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">)</span> | |
| 669 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">createCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span><span class="p">)</span> | |
| 638 | 670 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 639 | 671 | |
| 640 | 672 | <span class="k">def</span> <span class="nf">createCB</span><span class="p">(</span><span class="n">create_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 641 | 673 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">create_message</span><span class="p">)</span> |
| 642 | 674 | <span class="k">if</span> <span class="n">create_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 643 | <span class="n">sendQuery</span><span class="p">(</span><span class="n">create_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> | |
| 675 | <span class="n">sendQuery</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span> | |
| 676 | <span class="k">elif</span> <span class="n">create_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xC0000034</span><span class="p">:</span> <span class="c1"># [MS-ERREF]: STATUS_OBJECT_NAME_INVALID</span> | |
| 677 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Path not found'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 644 | 678 | <span class="k">else</span><span class="p">:</span> |
| 645 | 679 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to open directory'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 646 | 680 | |
| 647 | 681 | <span class="k">def</span> <span class="nf">sendQuery</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">data_buf</span><span class="p">):</span> |
| 648 | 682 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2QueryDirectoryRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">,</span> <span class="n">pattern</span><span class="p">,</span> |
| 649 | <span class="n">info_class</span> <span class="o">=</span> <span class="mh">0x03</span><span class="p">,</span> <span class="c1"># FileBothDirectoryInformation</span> | |
| 683 | <span class="n">info_class</span> <span class="o">=</span> <span class="mh">0x25</span><span class="p">,</span> <span class="c1"># FileIdBothDirectoryInformation</span> | |
| 650 | 684 | <span class="n">flags</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 651 | 685 | <span class="n">output_buf_len</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_transact_size</span><span class="p">))</span> |
| 652 | 686 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 653 | 687 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 654 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">queryCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">,</span> <span class="n">data_buf</span> <span class="o">=</span> <span class="n">data_buf</span><span class="p">)</span> | |
| 688 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">queryCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">,</span> <span class="n">data_buf</span> <span class="o">=</span> <span class="n">data_buf</span><span class="p">)</span> | |
| 655 | 689 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 656 | 690 | |
| 657 | 691 | <span class="k">def</span> <span class="nf">queryCB</span><span class="p">(</span><span class="n">query_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 658 | 692 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">query_message</span><span class="p">)</span> |
| 659 | 693 | <span class="k">if</span> <span class="n">query_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 660 | 694 | <span class="n">data_buf</span> <span class="o">=</span> <span class="n">decodeQueryStruct</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_buf'</span><span class="p">]</span> <span class="o">+</span> <span class="n">query_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data</span><span class="p">)</span> |
| 661 | <span class="n">sendQuery</span><span class="p">(</span><span class="n">query_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">data_buf</span><span class="p">)</span> | |
| 662 | <span class="k">elif</span> <span class="n">query_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0x80000006</span><span class="n">L</span><span class="p">:</span> <span class="c1"># STATUS_NO_MORE_FILES</span> | |
| 663 | <span class="n">closeFid</span><span class="p">(</span><span class="n">query_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">results</span> <span class="o">=</span> <span class="n">results</span><span class="p">)</span> | |
| 664 | <span class="k">else</span><span class="p">:</span> | |
| 665 | <span class="n">closeFid</span><span class="p">(</span><span class="n">query_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">error</span> <span class="o">=</span> <span class="n">query_message</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> | |
| 695 | <span class="n">sendQuery</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">data_buf</span><span class="p">)</span> | |
| 696 | <span class="k">elif</span> <span class="n">query_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xC000000F</span><span class="p">:</span> <span class="c1"># [MS-ERREF]: STATUS_NO_SUCH_FILE</span> | |
| 697 | <span class="c1"># If there are no matching files, we just treat as success instead of failing</span> | |
| 698 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">results</span> <span class="o">=</span> <span class="n">results</span><span class="p">)</span> | |
| 699 | <span class="k">elif</span> <span class="n">query_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0x80000006</span><span class="p">:</span> <span class="c1"># STATUS_NO_MORE_FILES</span> | |
| 700 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">results</span> <span class="o">=</span> <span class="n">results</span><span class="p">)</span> | |
| 701 | <span class="k">else</span><span class="p">:</span> | |
| 702 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">error</span> <span class="o">=</span> <span class="n">query_message</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> | |
| 666 | 703 | |
| 667 | 704 | <span class="k">def</span> <span class="nf">decodeQueryStruct</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">):</span> |
| 668 | <span class="c1"># SMB_FIND_FILE_BOTH_DIRECTORY_INFO structure. See [MS-CIFS]: 2.2.8.1.7 and [MS-SMB]: 2.2.8.1.1</span> | |
| 669 | <span class="n">info_format</span> <span class="o">=</span> <span class="s1">'<IIQQQQQQIIIBB24s'</span> | |
| 705 | <span class="c1"># FileIdBothDirectoryInformation structure. See [MS-SMB]: 2.2.8.1.3 and [MS-FSCC]: 2.4.17</span> | |
| 706 | <span class="n">info_format</span> <span class="o">=</span> <span class="s1">'<IIQQQQQQIIIBB24sHQ'</span> | |
| 670 | 707 | <span class="n">info_size</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">calcsize</span><span class="p">(</span><span class="n">info_format</span><span class="p">)</span> |
| 671 | 708 | |
| 672 | 709 | <span class="n">data_length</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">)</span> |
| 678 | 715 | <span class="n">next_offset</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> \ |
| 679 | 716 | <span class="n">create_time</span><span class="p">,</span> <span class="n">last_access_time</span><span class="p">,</span> <span class="n">last_write_time</span><span class="p">,</span> <span class="n">last_attr_change_time</span><span class="p">,</span> \ |
| 680 | 717 | <span class="n">file_size</span><span class="p">,</span> <span class="n">alloc_size</span><span class="p">,</span> <span class="n">file_attributes</span><span class="p">,</span> <span class="n">filename_length</span><span class="p">,</span> <span class="n">ea_size</span><span class="p">,</span> \ |
| 681 | <span class="n">short_name_length</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">short_name</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="n">info_format</span><span class="p">,</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="n">info_size</span><span class="p">])</span> | |
| 718 | <span class="n">short_name_length</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">short_name</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">file_id</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="n">info_format</span><span class="p">,</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="n">info_size</span><span class="p">])</span> | |
| 682 | 719 | |
| 683 | 720 | <span class="n">offset2</span> <span class="o">=</span> <span class="n">offset</span> <span class="o">+</span> <span class="n">info_size</span> |
| 684 | 721 | <span class="k">if</span> <span class="n">offset2</span> <span class="o">+</span> <span class="n">filename_length</span> <span class="o">></span> <span class="n">data_length</span><span class="p">:</span> |
| 685 | 722 | <span class="k">return</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:]</span> |
| 686 | 723 | |
| 687 | 724 | <span class="n">filename</span> <span class="o">=</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset2</span><span class="p">:</span><span class="n">offset2</span><span class="o">+</span><span class="n">filename_length</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> |
| 688 | <span class="n">short_name</span> <span class="o">=</span> <span class="n">short_name</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 689 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">SharedFile</span><span class="p">(</span><span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">create_time</span><span class="p">),</span> <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_access_time</span><span class="p">),</span> | |
| 690 | <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_write_time</span><span class="p">),</span> <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_attr_change_time</span><span class="p">),</span> | |
| 691 | <span class="n">file_size</span><span class="p">,</span> <span class="n">alloc_size</span><span class="p">,</span> <span class="n">file_attributes</span><span class="p">,</span> <span class="n">short_name</span><span class="p">,</span> <span class="n">filename</span><span class="p">))</span> | |
| 725 | <span class="n">short_name</span> <span class="o">=</span> <span class="n">short_name</span><span class="p">[:</span><span class="n">short_name_length</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 726 | ||
| 727 | <span class="n">accept_result</span> <span class="o">=</span> <span class="kc">False</span> | |
| 728 | <span class="k">if</span> <span class="p">(</span><span class="n">file_attributes</span> <span class="o">&</span> <span class="mh">0xff</span><span class="p">)</span> <span class="ow">in</span> <span class="p">(</span> <span class="mh">0x00</span><span class="p">,</span> <span class="n">ATTR_NORMAL</span> <span class="p">):</span> <span class="c1"># Only the first 8-bits are compared. We ignore other bits like temp, compressed, encryption, sparse, indexed, etc</span> | |
| 729 | <span class="n">accept_result</span> <span class="o">=</span> <span class="p">(</span><span class="n">search</span> <span class="o">==</span> <span class="n">SMB_FILE_ATTRIBUTE_NORMAL</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="n">search</span> <span class="o">&</span> <span class="n">SMB_FILE_ATTRIBUTE_INCL_NORMAL</span><span class="p">)</span> | |
| 730 | <span class="k">else</span><span class="p">:</span> | |
| 731 | <span class="n">accept_result</span> <span class="o">=</span> <span class="p">(</span><span class="n">file_attributes</span> <span class="o">&</span> <span class="n">search</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span> | |
| 732 | <span class="k">if</span> <span class="n">accept_result</span><span class="p">:</span> | |
| 733 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">SharedFile</span><span class="p">(</span><span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">create_time</span><span class="p">),</span> <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_access_time</span><span class="p">),</span> | |
| 734 | <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_write_time</span><span class="p">),</span> <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_attr_change_time</span><span class="p">),</span> | |
| 735 | <span class="n">file_size</span><span class="p">,</span> <span class="n">alloc_size</span><span class="p">,</span> <span class="n">file_attributes</span><span class="p">,</span> <span class="n">short_name</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">file_id</span><span class="p">))</span> | |
| 692 | 736 | |
| 693 | 737 | <span class="k">if</span> <span class="n">next_offset</span><span class="p">:</span> |
| 694 | 738 | <span class="n">offset</span> <span class="o">+=</span> <span class="n">next_offset</span> |
| 695 | 739 | <span class="k">else</span><span class="p">:</span> |
| 696 | 740 | <span class="k">break</span> |
| 697 | <span class="k">return</span> <span class="s1">''</span> | |
| 698 | ||
| 699 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">results</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">error</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span> | |
| 741 | <span class="k">return</span> <span class="sa">b</span><span class="s1">''</span> | |
| 742 | ||
| 743 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">results</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">error</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span> | |
| 700 | 744 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CloseRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">))</span> |
| 701 | 745 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 702 | 746 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 704 | 748 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 705 | 749 | |
| 706 | 750 | <span class="k">def</span> <span class="nf">closeCB</span><span class="p">(</span><span class="n">close_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 707 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'results'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span> | |
| 751 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'results'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> | |
| 708 | 752 | <span class="n">callback</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'results'</span><span class="p">])</span> |
| 709 | <span class="k">elif</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span> | |
| 710 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Query failed with errorcode 0x</span><span class="si">%08x</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 711 | ||
| 712 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 753 | <span class="k">elif</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> | |
| 754 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="o">==</span> <span class="mh">0xC000000F</span><span class="p">:</span> <span class="c1"># [MS-ERREF]: STATUS_NO_SUCH_FILE</span> | |
| 755 | <span class="c1"># Remote server returns STATUS_NO_SUCH_FILE error so we assume that the search returns no matching files</span> | |
| 756 | <span class="n">callback</span><span class="p">([</span> <span class="p">])</span> | |
| 757 | <span class="k">else</span><span class="p">:</span> | |
| 758 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Query failed with errorcode 0x</span><span class="si">%08x</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 759 | ||
| 760 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 713 | 761 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 714 | 762 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 715 | 763 | <span class="k">if</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 718 | 766 | <span class="k">else</span><span class="p">:</span> |
| 719 | 767 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 720 | 768 | |
| 721 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 769 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 722 | 770 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 723 | 771 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 724 | 772 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 757 | 805 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">create_context_data</span><span class="p">))</span> |
| 758 | 806 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 759 | 807 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 760 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">createCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">)</span> | |
| 808 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">createCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span><span class="p">)</span> | |
| 761 | 809 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 762 | 810 | |
| 763 | 811 | <span class="k">def</span> <span class="nf">createCB</span><span class="p">(</span><span class="n">create_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 764 | 812 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">create_message</span><span class="p">)</span> |
| 765 | 813 | <span class="k">if</span> <span class="n">create_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 766 | 814 | <span class="n">p</span> <span class="o">=</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span> |
| 815 | <span class="n">filename</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_extractLastPathComponent</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> | |
| 767 | 816 | <span class="n">info</span> <span class="o">=</span> <span class="n">SharedFile</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">create_time</span><span class="p">,</span> <span class="n">p</span><span class="o">.</span><span class="n">lastaccess_time</span><span class="p">,</span> <span class="n">p</span><span class="o">.</span><span class="n">lastwrite_time</span><span class="p">,</span> <span class="n">p</span><span class="o">.</span><span class="n">change_time</span><span class="p">,</span> |
| 768 | 817 | <span class="n">p</span><span class="o">.</span><span class="n">file_size</span><span class="p">,</span> <span class="n">p</span><span class="o">.</span><span class="n">allocation_size</span><span class="p">,</span> <span class="n">p</span><span class="o">.</span><span class="n">file_attributes</span><span class="p">,</span> |
| 769 | <span class="nb">unicode</span><span class="p">(</span><span class="n">path</span><span class="p">),</span> <span class="nb">unicode</span><span class="p">(</span><span class="n">path</span><span class="p">))</span> | |
| 770 | <span class="n">closeFid</span><span class="p">(</span><span class="n">create_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">p</span><span class="o">.</span><span class="n">fid</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="n">info</span><span class="p">)</span> | |
| 818 | <span class="n">filename</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span> | |
| 819 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">p</span><span class="o">.</span><span class="n">fid</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="n">info</span><span class="p">)</span> | |
| 771 | 820 | <span class="k">else</span><span class="p">:</span> |
| 772 | 821 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to get attributes for </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to open remote file object'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 773 | 822 | |
| 774 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">error</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span> | |
| 823 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">error</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span> | |
| 775 | 824 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CloseRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">))</span> |
| 776 | 825 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 777 | 826 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 779 | 828 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 780 | 829 | |
| 781 | 830 | <span class="k">def</span> <span class="nf">closeCB</span><span class="p">(</span><span class="n">close_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 782 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'info'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span> | |
| 831 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'info'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> | |
| 783 | 832 | <span class="n">callback</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'info'</span><span class="p">])</span> |
| 784 | <span class="k">elif</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span> | |
| 833 | <span class="k">elif</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> | |
| 785 | 834 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to get attributes for </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Query failed with errorcode 0x</span><span class="si">%08x</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 786 | 835 | |
| 787 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 836 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 788 | 837 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 789 | 838 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 790 | 839 | <span class="k">if</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 793 | 842 | <span class="k">else</span><span class="p">:</span> |
| 794 | 843 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to get attributes for </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 795 | 844 | |
| 796 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 845 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 797 | 846 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 798 | 847 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 799 | 848 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 800 | 849 | <span class="k">else</span><span class="p">:</span> |
| 801 | 850 | <span class="n">sendCreate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">])</span> |
| 802 | 851 | |
| 803 | <span class="k">def</span> <span class="nf">_retrieveFile_SMB2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 804 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_retrieveFileFromOffset</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="il">0L</span><span class="p">,</span> <span class="o">-</span><span class="il">1L</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 805 | ||
| 806 | <span class="k">def</span> <span class="nf">_retrieveFileFromOffset_SMB2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">starting_offset</span><span class="p">,</span> <span class="n">max_length</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 852 | <span class="k">def</span> <span class="nf">_getSecurity_SMB2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 807 | 853 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span><span class="p">:</span> |
| 808 | 854 | <span class="k">raise</span> <span class="n">NotReadyError</span><span class="p">(</span><span class="s1">'SMB connection not authenticated'</span><span class="p">)</span> |
| 809 | 855 | |
| 817 | 863 | <span class="n">results</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 818 | 864 | |
| 819 | 865 | <span class="k">def</span> <span class="nf">sendCreate</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> |
| 820 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""</span> | |
| 866 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CreateRequest</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> | |
| 867 | <span class="n">file_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> | |
| 868 | <span class="n">access_mask</span> <span class="o">=</span> <span class="n">FILE_READ_DATA</span> <span class="o">|</span> <span class="n">FILE_READ_EA</span> <span class="o">|</span> <span class="n">FILE_READ_ATTRIBUTES</span> <span class="o">|</span> <span class="n">READ_CONTROL</span> <span class="o">|</span> <span class="n">SYNCHRONIZE</span><span class="p">,</span> | |
| 869 | <span class="n">share_access</span> <span class="o">=</span> <span class="n">FILE_SHARE_READ</span> <span class="o">|</span> <span class="n">FILE_SHARE_WRITE</span> <span class="o">|</span> <span class="n">FILE_SHARE_DELETE</span><span class="p">,</span> | |
| 870 | <span class="n">oplock</span> <span class="o">=</span> <span class="n">SMB2_OPLOCK_LEVEL_NONE</span><span class="p">,</span> | |
| 871 | <span class="n">impersonation</span> <span class="o">=</span> <span class="n">SEC_IMPERSONATE</span><span class="p">,</span> | |
| 872 | <span class="n">create_options</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> | |
| 873 | <span class="n">create_disp</span> <span class="o">=</span> <span class="n">FILE_OPEN</span><span class="p">))</span> | |
| 874 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> | |
| 875 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 876 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">createCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span><span class="p">)</span> | |
| 877 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 878 | ||
| 879 | <span class="k">def</span> <span class="nf">createCB</span><span class="p">(</span><span class="n">create_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 880 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">create_message</span><span class="p">)</span> | |
| 881 | <span class="k">if</span> <span class="n">create_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> | |
| 882 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2QueryInfoRequest</span><span class="p">(</span><span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">,</span> | |
| 883 | <span class="n">flags</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> | |
| 884 | <span class="n">additional_info</span> <span class="o">=</span> <span class="n">OWNER_SECURITY_INFORMATION</span> <span class="o">|</span> <span class="n">GROUP_SECURITY_INFORMATION</span> <span class="o">|</span> <span class="n">DACL_SECURITY_INFORMATION</span><span class="p">,</span> | |
| 885 | <span class="n">info_type</span> <span class="o">=</span> <span class="n">SMB2_INFO_SECURITY</span><span class="p">,</span> | |
| 886 | <span class="n">file_info_class</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="c1"># [MS-SMB2] 2.2.37, 3.2.4.12</span> | |
| 887 | <span class="n">input_buf</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> | |
| 888 | <span class="n">output_buf_len</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_transact_size</span><span class="p">))</span> | |
| 889 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">]</span> | |
| 890 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 891 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">queryCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> | |
| 892 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 893 | <span class="k">else</span><span class="p">:</span> | |
| 894 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to get the security descriptor of </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to open file or directory'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 895 | ||
| 896 | <span class="k">def</span> <span class="nf">queryCB</span><span class="p">(</span><span class="n">query_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 897 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">query_message</span><span class="p">)</span> | |
| 898 | <span class="k">if</span> <span class="n">query_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> | |
| 899 | <span class="n">security</span> <span class="o">=</span> <span class="n">SecurityDescriptor</span><span class="o">.</span><span class="n">from_bytes</span><span class="p">(</span><span class="n">query_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data</span><span class="p">)</span> | |
| 900 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">result</span> <span class="o">=</span> <span class="n">security</span><span class="p">)</span> | |
| 901 | <span class="k">else</span><span class="p">:</span> | |
| 902 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">error</span> <span class="o">=</span> <span class="n">query_message</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> | |
| 903 | ||
| 904 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">result</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">error</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span> | |
| 905 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CloseRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">))</span> | |
| 906 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> | |
| 907 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 908 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">closeCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">result</span> <span class="o">=</span> <span class="n">result</span><span class="p">,</span> <span class="n">error</span> <span class="o">=</span> <span class="n">error</span><span class="p">)</span> | |
| 909 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 910 | ||
| 911 | <span class="k">def</span> <span class="nf">closeCB</span><span class="p">(</span><span class="n">close_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 912 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'result'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> | |
| 913 | <span class="n">callback</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'result'</span><span class="p">])</span> | |
| 914 | <span class="k">elif</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> | |
| 915 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to get the security descriptor of </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Query failed with errorcode 0x</span><span class="si">%08x</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 916 | ||
| 917 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 918 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 919 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> | |
| 920 | <span class="k">if</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> | |
| 921 | <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span> | |
| 922 | <span class="n">sendCreate</span><span class="p">(</span><span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span><span class="p">)</span> | |
| 923 | <span class="k">else</span><span class="p">:</span> | |
| 924 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to get the security descriptor of </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 925 | ||
| 926 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 927 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 928 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> | |
| 929 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 930 | <span class="k">else</span><span class="p">:</span> | |
| 931 | <span class="n">sendCreate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">])</span> | |
| 932 | ||
| 933 | <span class="k">def</span> <span class="nf">_retrieveFile_SMB2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 934 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_retrieveFileFromOffset</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 935 | ||
| 936 | <span class="k">def</span> <span class="nf">_retrieveFileFromOffset_SMB2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">starting_offset</span><span class="p">,</span> <span class="n">max_length</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 937 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span><span class="p">:</span> | |
| 938 | <span class="k">raise</span> <span class="n">NotReadyError</span><span class="p">(</span><span class="s1">'SMB connection not authenticated'</span><span class="p">)</span> | |
| 939 | ||
| 940 | <span class="n">expiry_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">+</span> <span class="n">timeout</span> | |
| 941 | <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'/'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">)</span> | |
| 942 | <span class="k">if</span> <span class="n">path</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">):</span> | |
| 943 | <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> | |
| 944 | <span class="k">if</span> <span class="n">path</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">):</span> | |
| 945 | <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> | |
| 946 | <span class="n">messages_history</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> | |
| 947 | <span class="n">results</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> | |
| 948 | ||
| 949 | <span class="k">def</span> <span class="nf">sendCreate</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> | |
| 950 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""</span> | |
| 821 | 951 | <span class="s2">28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00</span> |
| 822 | 952 | <span class="s2">44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00</span> |
| 823 | 953 | <span class="s2">00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00</span> |
| 824 | 954 | <span class="s2">00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00</span> |
| 825 | 955 | <span class="s2">00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00</span> |
| 826 | 956 | <span class="s2">51 46 69 64 00 00 00 00</span> |
| 827 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 957 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> | |
| 828 | 958 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CreateRequest</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> |
| 829 | 959 | <span class="n">file_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 830 | 960 | <span class="n">access_mask</span> <span class="o">=</span> <span class="n">FILE_READ_DATA</span> <span class="o">|</span> <span class="n">FILE_READ_EA</span> <span class="o">|</span> <span class="n">FILE_READ_ATTRIBUTES</span> <span class="o">|</span> <span class="n">READ_CONTROL</span> <span class="o">|</span> <span class="n">SYNCHRONIZE</span><span class="p">,</span> |
| 831 | <span class="n">share_access</span> <span class="o">=</span> <span class="n">FILE_SHARE_READ</span><span class="p">,</span> | |
| 961 | <span class="n">share_access</span> <span class="o">=</span> <span class="n">FILE_SHARE_READ</span> <span class="o">|</span> <span class="n">FILE_SHARE_WRITE</span><span class="p">,</span> | |
| 832 | 962 | <span class="n">oplock</span> <span class="o">=</span> <span class="n">SMB2_OPLOCK_LEVEL_NONE</span><span class="p">,</span> |
| 833 | 963 | <span class="n">impersonation</span> <span class="o">=</span> <span class="n">SEC_IMPERSONATE</span><span class="p">,</span> |
| 834 | 964 | <span class="n">create_options</span> <span class="o">=</span> <span class="n">FILE_SEQUENTIAL_ONLY</span> <span class="o">|</span> <span class="n">FILE_NON_DIRECTORY_FILE</span><span class="p">,</span> |
| 846 | 976 | <span class="n">flags</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 847 | 977 | <span class="n">additional_info</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 848 | 978 | <span class="n">info_type</span> <span class="o">=</span> <span class="n">SMB2_INFO_FILE</span><span class="p">,</span> |
| 849 | <span class="n">file_info_class</span> <span class="o">=</span> <span class="mh">0x16</span><span class="p">,</span> <span class="c1"># FileStreamInformation [MS-FSCC] 2.4</span> | |
| 850 | <span class="n">input_buf</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> | |
| 979 | <span class="n">file_info_class</span> <span class="o">=</span> <span class="mh">0x05</span><span class="p">,</span> <span class="c1"># FileStandardInformation [MS-FSCC] 2.4</span> | |
| 980 | <span class="n">input_buf</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="p">,</span> | |
| 851 | 981 | <span class="n">output_buf_len</span> <span class="o">=</span> <span class="mi">4096</span><span class="p">))</span> |
| 852 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">create_message</span><span class="o">.</span><span class="n">tid</span> | |
| 982 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">]</span> | |
| 853 | 983 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 854 | 984 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">infoCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> |
| 855 | <span class="n">fid</span> <span class="o">=</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">,</span> <span class="n">file_attributes</span> <span class="o">=</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">file_attributes</span><span class="p">)</span> | |
| 985 | <span class="n">tid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> | |
| 986 | <span class="n">fid</span> <span class="o">=</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">,</span> | |
| 987 | <span class="n">file_attributes</span> <span class="o">=</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">file_attributes</span><span class="p">)</span> | |
| 856 | 988 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 857 | 989 | <span class="k">else</span><span class="p">:</span> |
| 858 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to open file'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 990 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to retrieve </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to open file'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 859 | 991 | |
| 860 | 992 | <span class="k">def</span> <span class="nf">infoCB</span><span class="p">(</span><span class="n">info_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 861 | 993 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">info_message</span><span class="p">)</span> |
| 870 | 1002 | <span class="n">remaining_len</span> <span class="o">=</span> <span class="n">file_len</span> |
| 871 | 1003 | <span class="k">if</span> <span class="n">starting_offset</span> <span class="o">+</span> <span class="n">remaining_len</span> <span class="o">></span> <span class="n">file_len</span><span class="p">:</span> |
| 872 | 1004 | <span class="n">remaining_len</span> <span class="o">=</span> <span class="n">file_len</span> <span class="o">-</span> <span class="n">starting_offset</span> |
| 873 | <span class="n">sendRead</span><span class="p">(</span><span class="n">info_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">starting_offset</span><span class="p">,</span> <span class="n">remaining_len</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'file_attributes'</span><span class="p">])</span> | |
| 874 | <span class="k">else</span><span class="p">:</span> | |
| 875 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to retrieve information on file'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 1005 | <span class="n">sendRead</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">starting_offset</span><span class="p">,</span> <span class="n">remaining_len</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'file_attributes'</span><span class="p">])</span> | |
| 1006 | <span class="k">else</span><span class="p">:</span> | |
| 1007 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to retrieve </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to retrieve information on file'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 876 | 1008 | |
| 877 | 1009 | <span class="k">def</span> <span class="nf">sendRead</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">remaining_len</span><span class="p">,</span> <span class="n">read_len</span><span class="p">,</span> <span class="n">file_attributes</span><span class="p">):</span> |
| 878 | 1010 | <span class="n">read_count</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">max_read_size</span><span class="p">,</span> <span class="n">remaining_len</span><span class="p">)</span> |
| 880 | 1012 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 881 | 1013 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 882 | 1014 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">readCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> |
| 883 | <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="n">offset</span><span class="p">,</span> | |
| 1015 | <span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="n">offset</span><span class="p">,</span> | |
| 884 | 1016 | <span class="n">remaining_len</span> <span class="o">=</span> <span class="n">remaining_len</span><span class="p">,</span> |
| 885 | 1017 | <span class="n">read_len</span> <span class="o">=</span> <span class="n">read_len</span><span class="p">,</span> |
| 886 | 1018 | <span class="n">file_attributes</span> <span class="o">=</span> <span class="n">file_attributes</span><span class="p">)</span> |
| 894 | 1026 | <span class="n">remaining_len</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'remaining_len'</span><span class="p">]</span> <span class="o">-</span> <span class="n">data_len</span> |
| 895 | 1027 | |
| 896 | 1028 | <span class="k">if</span> <span class="n">remaining_len</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| 897 | <span class="n">sendRead</span><span class="p">(</span><span class="n">read_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'offset'</span><span class="p">]</span> <span class="o">+</span> <span class="n">data_len</span><span class="p">,</span> <span class="n">remaining_len</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'read_len'</span><span class="p">]</span> <span class="o">+</span> <span class="n">data_len</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'file_attributes'</span><span class="p">])</span> | |
| 898 | <span class="k">else</span><span class="p">:</span> | |
| 899 | <span class="n">closeFid</span><span class="p">(</span><span class="n">read_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">ret</span> <span class="o">=</span> <span class="p">(</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'file_attributes'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'read_len'</span><span class="p">]</span> <span class="o">+</span> <span class="n">data_len</span> <span class="p">))</span> | |
| 1029 | <span class="n">sendRead</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'offset'</span><span class="p">]</span> <span class="o">+</span> <span class="n">data_len</span><span class="p">,</span> <span class="n">remaining_len</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'read_len'</span><span class="p">]</span> <span class="o">+</span> <span class="n">data_len</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'file_attributes'</span><span class="p">])</span> | |
| 1030 | <span class="k">else</span><span class="p">:</span> | |
| 1031 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">ret</span> <span class="o">=</span> <span class="p">(</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'file_attributes'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'read_len'</span><span class="p">]</span> <span class="o">+</span> <span class="n">data_len</span> <span class="p">))</span> | |
| 900 | 1032 | <span class="k">else</span><span class="p">:</span> |
| 901 | 1033 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">read_message</span><span class="p">)</span> |
| 902 | <span class="n">closeFid</span><span class="p">(</span><span class="n">read_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">error</span> <span class="o">=</span> <span class="n">read_message</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> | |
| 903 | ||
| 904 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">ret</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">error</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span> | |
| 1034 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">error</span> <span class="o">=</span> <span class="n">read_message</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> | |
| 1035 | ||
| 1036 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">ret</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">error</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span> | |
| 905 | 1037 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CloseRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">))</span> |
| 906 | 1038 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 907 | 1039 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 909 | 1041 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 910 | 1042 | |
| 911 | 1043 | <span class="k">def</span> <span class="nf">closeCB</span><span class="p">(</span><span class="n">close_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 912 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'ret'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span> | |
| 1044 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'ret'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> | |
| 913 | 1045 | <span class="n">callback</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'ret'</span><span class="p">])</span> |
| 914 | <span class="k">elif</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span> | |
| 1046 | <span class="k">elif</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> | |
| 915 | 1047 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to retrieve </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Read failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 916 | 1048 | |
| 917 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 1049 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 918 | 1050 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 919 | 1051 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 920 | 1052 | <span class="k">if</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 923 | 1055 | <span class="k">else</span><span class="p">:</span> |
| 924 | 1056 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to retrieve </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 925 | 1057 | |
| 926 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1058 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 927 | 1059 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 928 | 1060 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 929 | 1061 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 931 | 1063 | <span class="n">sendCreate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">])</span> |
| 932 | 1064 | |
| 933 | 1065 | <span class="k">def</span> <span class="nf">_storeFile_SMB2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> |
| 934 | <span class="bp">self</span><span class="o">.</span><span class="n">_storeFileFromOffset_SMB2</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="il">0L</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 935 | ||
| 936 | <span class="k">def</span> <span class="nf">_storeFileFromOffset_SMB2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">starting_offset</span><span class="p">,</span> <span class="n">truncate</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 1066 | <span class="bp">self</span><span class="o">.</span><span class="n">_storeFileFromOffset_SMB2</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 1067 | ||
| 1068 | <span class="k">def</span> <span class="nf">_storeFileFromOffset_SMB2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">starting_offset</span><span class="p">,</span> <span class="n">truncate</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 937 | 1069 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span><span class="p">:</span> |
| 938 | 1070 | <span class="k">raise</span> <span class="n">NotReadyError</span><span class="p">(</span><span class="s1">'SMB connection not authenticated'</span><span class="p">)</span> |
| 939 | 1071 | |
| 1072 | <span class="n">expiry_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">+</span> <span class="n">timeout</span> | |
| 940 | 1073 | <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'/'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">)</span> |
| 941 | 1074 | <span class="k">if</span> <span class="n">path</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">):</span> |
| 942 | 1075 | <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> |
| 945 | 1078 | <span class="n">messages_history</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 946 | 1079 | |
| 947 | 1080 | <span class="k">def</span> <span class="nf">sendCreate</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> |
| 948 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""</span> | |
| 1081 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""</span> | |
| 949 | 1082 | <span class="s2">28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00</span> |
| 950 | 1083 | <span class="s2">44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00</span> |
| 951 | 1084 | <span class="s2">00 00 00 00 00 00 00 00 20 00 00 00 10 00 04 00</span> |
| 954 | 1087 | <span class="s2">00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00</span> |
| 955 | 1088 | <span class="s2">00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00</span> |
| 956 | 1089 | <span class="s2">51 46 69 64 00 00 00 00</span> |
| 957 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 1090 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> | |
| 958 | 1091 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CreateRequest</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> |
| 959 | 1092 | <span class="n">file_attributes</span> <span class="o">=</span> <span class="n">ATTR_ARCHIVE</span><span class="p">,</span> |
| 960 | 1093 | <span class="n">access_mask</span> <span class="o">=</span> <span class="n">FILE_READ_DATA</span> <span class="o">|</span> <span class="n">FILE_WRITE_DATA</span> <span class="o">|</span> <span class="n">FILE_APPEND_DATA</span> <span class="o">|</span> <span class="n">FILE_READ_ATTRIBUTES</span> <span class="o">|</span> <span class="n">FILE_WRITE_ATTRIBUTES</span> <span class="o">|</span> <span class="n">FILE_READ_EA</span> <span class="o">|</span> <span class="n">FILE_WRITE_EA</span> <span class="o">|</span> <span class="n">READ_CONTROL</span> <span class="o">|</span> <span class="n">SYNCHRONIZE</span><span class="p">,</span> |
| 970 | 1103 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 971 | 1104 | |
| 972 | 1105 | <span class="k">def</span> <span class="nf">createCB</span><span class="p">(</span><span class="n">create_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1106 | <span class="n">create_message</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">]</span> | |
| 973 | 1107 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">create_message</span><span class="p">)</span> |
| 974 | 1108 | <span class="k">if</span> <span class="n">create_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 975 | 1109 | <span class="n">sendWrite</span><span class="p">(</span><span class="n">create_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">,</span> <span class="n">starting_offset</span><span class="p">)</span> |
| 984 | 1118 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2WriteRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">offset</span><span class="p">))</span> |
| 985 | 1119 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 986 | 1120 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 987 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">writeCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="n">offset</span><span class="o">+</span><span class="n">data_len</span><span class="p">)</span> | |
| 1121 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">writeCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="n">offset</span><span class="o">+</span><span class="n">data_len</span><span class="p">)</span> | |
| 988 | 1122 | <span class="k">else</span><span class="p">:</span> |
| 989 | 1123 | <span class="n">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="n">offset</span><span class="p">)</span> |
| 990 | 1124 | |
| 991 | 1125 | <span class="k">def</span> <span class="nf">writeCB</span><span class="p">(</span><span class="n">write_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 992 | 1126 | <span class="c1"># To avoid crazy memory usage when saving large files, we do not save every write_message in messages_history.</span> |
| 993 | 1127 | <span class="k">if</span> <span class="n">write_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 994 | <span class="n">sendWrite</span><span class="p">(</span><span class="n">write_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'offset'</span><span class="p">])</span> | |
| 1128 | <span class="n">sendWrite</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'offset'</span><span class="p">])</span> | |
| 995 | 1129 | <span class="k">else</span><span class="p">:</span> |
| 996 | 1130 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">write_message</span><span class="p">)</span> |
| 997 | <span class="n">closeFid</span><span class="p">(</span><span class="n">write_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">])</span> | |
| 1131 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">])</span> | |
| 998 | 1132 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to store </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Write failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 999 | 1133 | |
| 1000 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">error</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span> | |
| 1134 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">error</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span> | |
| 1001 | 1135 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CloseRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">))</span> |
| 1002 | 1136 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 1003 | 1137 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1005 | 1139 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1006 | 1140 | |
| 1007 | 1141 | <span class="k">def</span> <span class="nf">closeCB</span><span class="p">(</span><span class="n">close_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1008 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'offset'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span> | |
| 1142 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'offset'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> | |
| 1009 | 1143 | <span class="n">callback</span><span class="p">((</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'offset'</span><span class="p">]</span> <span class="p">))</span> <span class="c1"># Note that this is a tuple of 2-elements</span> |
| 1010 | <span class="k">elif</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span> | |
| 1144 | <span class="k">elif</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'error'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> | |
| 1011 | 1145 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to store </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Write failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1012 | 1146 | |
| 1013 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 1147 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 1014 | 1148 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1015 | 1149 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 1016 | 1150 | <span class="k">if</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1019 | 1153 | <span class="k">else</span><span class="p">:</span> |
| 1020 | 1154 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to store </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1021 | 1155 | |
| 1022 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1156 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1023 | 1157 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1024 | 1158 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 1025 | 1159 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1027 | 1161 | <span class="n">sendCreate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">])</span> |
| 1028 | 1162 | |
| 1029 | 1163 | |
| 1030 | <span class="k">def</span> <span class="nf">_deleteFiles_SMB2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 1164 | <span class="k">def</span> <span class="nf">_deleteFiles_SMB2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">delete_matching_folders</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 1031 | 1165 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span><span class="p">:</span> |
| 1032 | 1166 | <span class="k">raise</span> <span class="n">NotReadyError</span><span class="p">(</span><span class="s1">'SMB connection not authenticated'</span><span class="p">)</span> |
| 1033 | 1167 | |
| 1034 | 1168 | <span class="n">expiry_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">+</span> <span class="n">timeout</span> |
| 1169 | <span class="n">pattern</span> <span class="o">=</span> <span class="kc">None</span> | |
| 1035 | 1170 | <span class="n">path</span> <span class="o">=</span> <span class="n">path_file_pattern</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'/'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">)</span> |
| 1036 | 1171 | <span class="k">if</span> <span class="n">path</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">):</span> |
| 1037 | 1172 | <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> |
| 1038 | 1173 | <span class="k">if</span> <span class="n">path</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">):</span> |
| 1039 | 1174 | <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> |
| 1175 | <span class="k">else</span><span class="p">:</span> | |
| 1176 | <span class="n">path_components</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">)</span> | |
| 1177 | <span class="k">if</span> <span class="n">path_components</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">'*'</span><span class="p">)</span> <span class="o">></span> <span class="o">-</span><span class="mi">1</span> <span class="ow">or</span> <span class="n">path_components</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">'?'</span><span class="p">)</span> <span class="o">></span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span> | |
| 1178 | <span class="n">path</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path_components</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span> | |
| 1179 | <span class="n">pattern</span> <span class="o">=</span> <span class="n">path_components</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> | |
| 1180 | <span class="n">messages_history</span><span class="p">,</span> <span class="n">files_queue</span> <span class="o">=</span> <span class="p">[</span> <span class="p">],</span> <span class="p">[</span> <span class="p">]</span> | |
| 1181 | ||
| 1182 | <span class="k">if</span> <span class="n">pattern</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> | |
| 1183 | <span class="n">path_components</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">)</span> | |
| 1184 | <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">path_components</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span> | |
| 1185 | <span class="n">files_queue</span><span class="o">.</span><span class="n">append</span><span class="p">((</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path_components</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]),</span> <span class="n">path_components</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="p">))</span> | |
| 1186 | <span class="k">else</span><span class="p">:</span> | |
| 1187 | <span class="n">files_queue</span><span class="o">.</span><span class="n">append</span><span class="p">((</span> <span class="s1">''</span><span class="p">,</span> <span class="n">path</span> <span class="p">))</span> | |
| 1188 | ||
| 1189 | <span class="k">def</span> <span class="nf">deleteCB</span><span class="p">(</span><span class="n">path</span><span class="p">):</span> | |
| 1190 | <span class="k">if</span> <span class="n">files_queue</span><span class="p">:</span> | |
| 1191 | <span class="n">p</span><span class="p">,</span> <span class="n">filename</span> <span class="o">=</span> <span class="n">files_queue</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> | |
| 1192 | <span class="k">if</span> <span class="n">filename</span><span class="p">:</span> | |
| 1193 | <span class="k">if</span> <span class="n">p</span><span class="p">:</span> | |
| 1194 | <span class="n">filename</span> <span class="o">=</span> <span class="n">p</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span> <span class="o">+</span> <span class="n">filename</span> | |
| 1195 | <span class="bp">self</span><span class="o">.</span><span class="n">_deleteFiles_SMB2__del</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">],</span> <span class="n">filename</span><span class="p">,</span> <span class="n">deleteCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 1196 | <span class="k">else</span><span class="p">:</span> | |
| 1197 | <span class="bp">self</span><span class="o">.</span><span class="n">_deleteDirectory_SMB2</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">deleteCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 1198 | <span class="k">else</span><span class="p">:</span> | |
| 1199 | <span class="n">callback</span><span class="p">(</span><span class="n">path_file_pattern</span><span class="p">)</span> | |
| 1200 | ||
| 1201 | <span class="k">def</span> <span class="nf">listCB</span><span class="p">(</span><span class="n">files_list</span><span class="p">):</span> | |
| 1202 | <span class="n">files_queue</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">files_list</span><span class="p">)</span> | |
| 1203 | <span class="n">deleteCB</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span> | |
| 1204 | ||
| 1205 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 1206 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 1207 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> | |
| 1208 | <span class="k">if</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> | |
| 1209 | <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span> | |
| 1210 | <span class="k">if</span> <span class="n">files_queue</span><span class="p">:</span> | |
| 1211 | <span class="n">deleteCB</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span> | |
| 1212 | <span class="k">else</span><span class="p">:</span> | |
| 1213 | <span class="bp">self</span><span class="o">.</span><span class="n">_deleteFiles_SMB2__list</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">delete_matching_folders</span><span class="p">,</span> <span class="n">listCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 1214 | <span class="k">else</span><span class="p">:</span> | |
| 1215 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 1216 | ||
| 1217 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1218 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 1219 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> | |
| 1220 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 1221 | <span class="k">else</span><span class="p">:</span> | |
| 1222 | <span class="k">if</span> <span class="n">files_queue</span><span class="p">:</span> | |
| 1223 | <span class="n">deleteCB</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span> | |
| 1224 | <span class="k">else</span><span class="p">:</span> | |
| 1225 | <span class="bp">self</span><span class="o">.</span><span class="n">_deleteFiles_SMB2__list</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">delete_matching_folders</span><span class="p">,</span> <span class="n">listCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 1226 | ||
| 1227 | <span class="k">def</span> <span class="nf">_deleteFiles_SMB2__list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">delete_matching_folders</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 1228 | <span class="n">folder_queue</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> | |
| 1229 | <span class="n">files_list</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> | |
| 1230 | <span class="n">current_path</span> <span class="o">=</span> <span class="p">[</span> <span class="n">path</span> <span class="p">]</span> | |
| 1231 | <span class="n">search</span> <span class="o">=</span> <span class="n">SMB_FILE_ATTRIBUTE_READONLY</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_HIDDEN</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_SYSTEM</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_DIRECTORY</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_ARCHIVE</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_INCL_NORMAL</span> | |
| 1232 | ||
| 1233 | <span class="k">def</span> <span class="nf">listCB</span><span class="p">(</span><span class="n">results</span><span class="p">):</span> | |
| 1234 | <span class="n">files</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> | |
| 1235 | <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="o">.</span><span class="n">filename</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span> <span class="s1">'.'</span><span class="p">,</span> <span class="s1">'..'</span> <span class="p">],</span> <span class="n">results</span><span class="p">):</span> | |
| 1236 | <span class="k">if</span> <span class="n">f</span><span class="o">.</span><span class="n">isDirectory</span><span class="p">:</span> | |
| 1237 | <span class="k">if</span> <span class="n">delete_matching_folders</span><span class="p">:</span> | |
| 1238 | <span class="n">folder_queue</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">current_path</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">+</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="o">+</span><span class="n">f</span><span class="o">.</span><span class="n">filename</span><span class="p">)</span> | |
| 1239 | <span class="k">else</span><span class="p">:</span> | |
| 1240 | <span class="n">files</span><span class="o">.</span><span class="n">append</span><span class="p">((</span> <span class="n">current_path</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">f</span><span class="o">.</span><span class="n">filename</span> <span class="p">))</span> | |
| 1241 | <span class="k">if</span> <span class="n">current_path</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">!=</span><span class="n">path</span> <span class="ow">and</span> <span class="n">delete_matching_folders</span><span class="p">:</span> | |
| 1242 | <span class="n">files</span><span class="o">.</span><span class="n">append</span><span class="p">((</span> <span class="n">current_path</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="kc">None</span> <span class="p">))</span> | |
| 1243 | ||
| 1244 | <span class="k">if</span> <span class="n">files</span><span class="p">:</span> | |
| 1245 | <span class="n">files_list</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">files</span> | |
| 1246 | ||
| 1247 | <span class="k">if</span> <span class="n">folder_queue</span><span class="p">:</span> | |
| 1248 | <span class="n">p</span> <span class="o">=</span> <span class="n">folder_queue</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span> | |
| 1249 | <span class="n">current_path</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">p</span> | |
| 1250 | <span class="bp">self</span><span class="o">.</span><span class="n">_listPath_SMB2</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">current_path</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">listCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">search</span> <span class="o">=</span> <span class="n">search</span><span class="p">,</span> <span class="n">pattern</span> <span class="o">=</span> <span class="s1">'*'</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">)</span> | |
| 1251 | <span class="k">else</span><span class="p">:</span> | |
| 1252 | <span class="n">callback</span><span class="p">(</span><span class="n">files_list</span><span class="p">)</span> | |
| 1253 | ||
| 1254 | <span class="bp">self</span><span class="o">.</span><span class="n">_listPath_SMB2</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">listCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">search</span> <span class="o">=</span> <span class="n">search</span><span class="p">,</span> <span class="n">pattern</span> <span class="o">=</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span> | |
| 1255 | ||
| 1256 | <span class="k">def</span> <span class="nf">_deleteFiles_SMB2__del</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">tid</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 1040 | 1257 | <span class="n">messages_history</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 1041 | 1258 | |
| 1042 | 1259 | <span class="k">def</span> <span class="nf">sendCreate</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> |
| 1043 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""</span> | |
| 1044 | <span class="s2">28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00</span> | |
| 1045 | <span class="s2">44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00</span> | |
| 1046 | <span class="s2">00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00</span> | |
| 1047 | <span class="s2">00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00</span> | |
| 1048 | <span class="s2">00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00</span> | |
| 1049 | <span class="s2">51 46 69 64 00 00 00 00</span> | |
| 1050 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 1260 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""</span> | |
| 1261 | <span class="s2"> 28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00</span> | |
| 1262 | <span class="s2"> 44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00</span> | |
| 1263 | <span class="s2"> 00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00</span> | |
| 1264 | <span class="s2"> 00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00</span> | |
| 1265 | <span class="s2"> 00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00</span> | |
| 1266 | <span class="s2"> 51 46 69 64 00 00 00 00</span> | |
| 1267 | <span class="s2"> """</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> | |
| 1051 | 1268 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CreateRequest</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> |
| 1052 | 1269 | <span class="n">file_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1053 | 1270 | <span class="n">access_mask</span> <span class="o">=</span> <span class="n">DELETE</span> <span class="o">|</span> <span class="n">FILE_READ_ATTRIBUTES</span><span class="p">,</span> |
| 1063 | 1280 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1064 | 1281 | |
| 1065 | 1282 | <span class="k">def</span> <span class="nf">createCB</span><span class="p">(</span><span class="n">open_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1283 | <span class="n">open_message</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">]</span> | |
| 1066 | 1284 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">open_message</span><span class="p">)</span> |
| 1067 | 1285 | <span class="k">if</span> <span class="n">open_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1068 | 1286 | <span class="n">sendDelete</span><span class="p">(</span><span class="n">open_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">open_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> |
| 1287 | <span class="k">elif</span> <span class="n">open_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xc0000034</span><span class="p">:</span> <span class="c1"># STATUS_OBJECT_NAME_NOT_FOUND</span> | |
| 1288 | <span class="n">callback</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> | |
| 1289 | <span class="k">elif</span> <span class="n">open_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mh">0xC00000BA</span><span class="p">:</span> <span class="c1"># [MS-ERREF]: STATUS_FILE_IS_A_DIRECTORY</span> | |
| 1290 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Cannot delete a folder. Please use deleteDirectory() method or append "/*" to your path if you wish to delete all files in the folder.'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 1069 | 1291 | <span class="k">else</span><span class="p">:</span> |
| 1070 | 1292 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to open file'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1071 | 1293 | |
| 1074 | 1296 | <span class="n">additional_info</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1075 | 1297 | <span class="n">info_type</span> <span class="o">=</span> <span class="n">SMB2_INFO_FILE</span><span class="p">,</span> |
| 1076 | 1298 | <span class="n">file_info_class</span> <span class="o">=</span> <span class="mh">0x0d</span><span class="p">,</span> <span class="c1"># SMB2_FILE_DISPOSITION_INFO</span> |
| 1077 | <span class="n">data</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\x01</span><span class="s1">'</span><span class="p">))</span> | |
| 1078 | <span class="sd">'''</span> | |
| 1079 | <span class="sd"> Resources:</span> | |
| 1080 | <span class="sd"> https://msdn.microsoft.com/en-us/library/cc246560.aspx</span> | |
| 1081 | <span class="sd"> https://msdn.microsoft.com/en-us/library/cc232098.aspx</span> | |
| 1082 | <span class="sd"> '''</span> | |
| 1083 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> | |
| 1084 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 1085 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">deleteCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">)</span> | |
| 1299 | <span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\x01</span><span class="s1">'</span><span class="p">))</span> | |
| 1300 | <span class="c1"># [MS-SMB2]: 2.2.39, [MS-FSCC]: 2.4.11</span> | |
| 1301 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> | |
| 1302 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 1303 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">deleteCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">)</span> | |
| 1086 | 1304 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1087 | 1305 | |
| 1088 | 1306 | <span class="k">def</span> <span class="nf">deleteCB</span><span class="p">(</span><span class="n">delete_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1089 | 1307 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">delete_message</span><span class="p">)</span> |
| 1090 | 1308 | <span class="k">if</span> <span class="n">delete_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1091 | <span class="n">closeFid</span><span class="p">(</span><span class="n">delete_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> | |
| 1092 | <span class="k">else</span><span class="p">:</span> | |
| 1093 | <span class="n">closeFid</span><span class="p">(</span><span class="n">delete_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="n">delete_message</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> | |
| 1094 | ||
| 1095 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">status</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span> | |
| 1309 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> | |
| 1310 | <span class="k">else</span><span class="p">:</span> | |
| 1311 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="n">delete_message</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> | |
| 1312 | ||
| 1313 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">status</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span> | |
| 1096 | 1314 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CloseRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">))</span> |
| 1097 | 1315 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 1098 | 1316 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1101 | 1319 | |
| 1102 | 1320 | <span class="k">def</span> <span class="nf">closeCB</span><span class="p">(</span><span class="n">close_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1103 | 1321 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'status'</span><span class="p">]</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1104 | <span class="n">callback</span><span class="p">(</span><span class="n">path_file_pattern</span><span class="p">)</span> | |
| 1322 | <span class="n">callback</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> | |
| 1105 | 1323 | <span class="k">else</span><span class="p">:</span> |
| 1106 | 1324 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Delete failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1107 | 1325 | |
| 1108 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 1109 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 1110 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> | |
| 1111 | <span class="k">if</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> | |
| 1112 | <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span> | |
| 1113 | <span class="n">sendCreate</span><span class="p">(</span><span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span><span class="p">)</span> | |
| 1114 | <span class="k">else</span><span class="p">:</span> | |
| 1115 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 1116 | ||
| 1117 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1118 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 1119 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> | |
| 1120 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 1121 | <span class="k">else</span><span class="p">:</span> | |
| 1122 | <span class="n">sendCreate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">])</span> | |
| 1123 | ||
| 1124 | <span class="k">def</span> <span class="nf">_resetFileAttributes_SMB2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 1326 | <span class="n">sendCreate</span><span class="p">(</span><span class="n">tid</span><span class="p">)</span> | |
| 1327 | ||
| 1328 | <span class="k">def</span> <span class="nf">_resetFileAttributes_SMB2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">file_attributes</span> <span class="o">=</span> <span class="n">ATTR_NORMAL</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 1125 | 1329 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span><span class="p">:</span> |
| 1126 | 1330 | <span class="k">raise</span> <span class="n">NotReadyError</span><span class="p">(</span><span class="s1">'SMB connection not authenticated'</span><span class="p">)</span> |
| 1127 | 1331 | |
| 1134 | 1338 | <span class="n">messages_history</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 1135 | 1339 | |
| 1136 | 1340 | <span class="k">def</span> <span class="nf">sendCreate</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> |
| 1137 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""</span> | |
| 1341 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""</span> | |
| 1138 | 1342 | <span class="s2">28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00</span> |
| 1139 | 1343 | <span class="s2">44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00</span> |
| 1140 | 1344 | <span class="s2">00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00</span> |
| 1141 | 1345 | <span class="s2">00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00</span> |
| 1142 | 1346 | <span class="s2">00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00</span> |
| 1143 | 1347 | <span class="s2">51 46 69 64 00 00 00 00</span> |
| 1144 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 1348 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> | |
| 1145 | 1349 | |
| 1146 | 1350 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CreateRequest</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> |
| 1147 | 1351 | <span class="n">file_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1160 | 1364 | <span class="k">def</span> <span class="nf">createCB</span><span class="p">(</span><span class="n">open_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1161 | 1365 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">open_message</span><span class="p">)</span> |
| 1162 | 1366 | <span class="k">if</span> <span class="n">open_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1163 | <span class="n">sendReset</span><span class="p">(</span><span class="n">open_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">open_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> | |
| 1367 | <span class="n">sendReset</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">open_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> | |
| 1164 | 1368 | <span class="k">else</span><span class="p">:</span> |
| 1165 | 1369 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to reset attributes of </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to open file'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1166 | 1370 | |
| 1169 | 1373 | <span class="n">additional_info</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1170 | 1374 | <span class="n">info_type</span> <span class="o">=</span> <span class="n">SMB2_INFO_FILE</span><span class="p">,</span> |
| 1171 | 1375 | <span class="n">file_info_class</span> <span class="o">=</span> <span class="mi">4</span><span class="p">,</span> <span class="c1"># FileBasicInformation</span> |
| 1172 | <span class="n">data</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'qqqqii'</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mh">0x80</span><span class="p">,</span><span class="mi">0</span><span class="p">)))</span> <span class="c1"># FILE_ATTRIBUTE_NORMAL</span> | |
| 1173 | <span class="sd">'''</span> | |
| 1174 | <span class="sd"> Resources:</span> | |
| 1175 | <span class="sd"> https://msdn.microsoft.com/en-us/library/cc246560.aspx</span> | |
| 1176 | <span class="sd"> https://msdn.microsoft.com/en-us/library/cc232064.aspx</span> | |
| 1177 | <span class="sd"> https://msdn.microsoft.com/en-us/library/cc232094.aspx</span> | |
| 1178 | <span class="sd"> https://msdn.microsoft.com/en-us/library/cc232110.aspx</span> | |
| 1179 | <span class="sd"> '''</span> | |
| 1180 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> | |
| 1181 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 1182 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">resetCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">)</span> | |
| 1376 | <span class="n">data</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'qqqqii'</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">file_attributes</span><span class="p">,</span> <span class="mi">0</span><span class="p">)))</span> | |
| 1377 | <span class="c1"># [MS-SMB2]: 2.2.39, [MS-FSCC]: 2.4, [MS-FSCC]: 2.4.7, [MS-FSCC]: 2.6</span> | |
| 1378 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> | |
| 1379 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 1380 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">resetCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">)</span> | |
| 1183 | 1381 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1184 | 1382 | |
| 1185 | 1383 | <span class="k">def</span> <span class="nf">resetCB</span><span class="p">(</span><span class="n">reset_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1186 | 1384 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">reset_message</span><span class="p">)</span> |
| 1187 | 1385 | <span class="k">if</span> <span class="n">reset_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1188 | <span class="n">closeFid</span><span class="p">(</span><span class="n">reset_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> | |
| 1189 | <span class="k">else</span><span class="p">:</span> | |
| 1190 | <span class="n">closeFid</span><span class="p">(</span><span class="n">reset_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="n">reset_message</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> | |
| 1191 | ||
| 1192 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">status</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span> | |
| 1386 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> | |
| 1387 | <span class="k">else</span><span class="p">:</span> | |
| 1388 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="n">reset_message</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> | |
| 1389 | ||
| 1390 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">status</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span> | |
| 1193 | 1391 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CloseRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">))</span> |
| 1194 | 1392 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 1195 | 1393 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1202 | 1400 | <span class="k">else</span><span class="p">:</span> |
| 1203 | 1401 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to reset attributes of </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Reset failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1204 | 1402 | |
| 1205 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 1403 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 1206 | 1404 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1207 | 1405 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 1208 | 1406 | <span class="k">if</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1211 | 1409 | <span class="k">else</span><span class="p">:</span> |
| 1212 | 1410 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to reset attributes of </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1213 | 1411 | |
| 1214 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1412 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1215 | 1413 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1216 | 1414 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 1217 | 1415 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1231 | 1429 | <span class="n">messages_history</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 1232 | 1430 | |
| 1233 | 1431 | <span class="k">def</span> <span class="nf">sendCreate</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> |
| 1234 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""</span> | |
| 1432 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""</span> | |
| 1235 | 1433 | <span class="s2">28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00</span> |
| 1236 | 1434 | <span class="s2">44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00</span> |
| 1237 | 1435 | <span class="s2">00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00</span> |
| 1238 | 1436 | <span class="s2">00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00</span> |
| 1239 | 1437 | <span class="s2">00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00</span> |
| 1240 | 1438 | <span class="s2">51 46 69 64 00 00 00 00</span> |
| 1241 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 1439 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> | |
| 1242 | 1440 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CreateRequest</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> |
| 1243 | 1441 | <span class="n">file_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1244 | 1442 | <span class="n">access_mask</span> <span class="o">=</span> <span class="n">FILE_READ_DATA</span> <span class="o">|</span> <span class="n">FILE_WRITE_DATA</span> <span class="o">|</span> <span class="n">FILE_READ_EA</span> <span class="o">|</span> <span class="n">FILE_WRITE_EA</span> <span class="o">|</span> <span class="n">FILE_READ_ATTRIBUTES</span> <span class="o">|</span> <span class="n">FILE_WRITE_ATTRIBUTES</span> <span class="o">|</span> <span class="n">READ_CONTROL</span> <span class="o">|</span> <span class="n">DELETE</span> <span class="o">|</span> <span class="n">SYNCHRONIZE</span><span class="p">,</span> |
| 1250 | 1448 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">create_context_data</span><span class="p">))</span> |
| 1251 | 1449 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 1252 | 1450 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1253 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">createCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">)</span> | |
| 1451 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">createCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span><span class="p">)</span> | |
| 1254 | 1452 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1255 | 1453 | |
| 1256 | 1454 | <span class="k">def</span> <span class="nf">createCB</span><span class="p">(</span><span class="n">create_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1257 | 1455 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">create_message</span><span class="p">)</span> |
| 1258 | 1456 | <span class="k">if</span> <span class="n">create_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1259 | <span class="n">closeFid</span><span class="p">(</span><span class="n">create_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> | |
| 1457 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> | |
| 1260 | 1458 | <span class="k">else</span><span class="p">:</span> |
| 1261 | 1459 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to create directory </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Create failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1262 | 1460 | |
| 1270 | 1468 | <span class="k">def</span> <span class="nf">closeCB</span><span class="p">(</span><span class="n">close_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1271 | 1469 | <span class="n">callback</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> |
| 1272 | 1470 | |
| 1273 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 1471 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 1274 | 1472 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1275 | 1473 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 1276 | 1474 | <span class="k">if</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1279 | 1477 | <span class="k">else</span><span class="p">:</span> |
| 1280 | 1478 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to create directory </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1281 | 1479 | |
| 1282 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1480 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1283 | 1481 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1284 | 1482 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 1285 | 1483 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1299 | 1497 | <span class="n">messages_history</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 1300 | 1498 | |
| 1301 | 1499 | <span class="k">def</span> <span class="nf">sendCreate</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> |
| 1302 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""</span> | |
| 1500 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""</span> | |
| 1303 | 1501 | <span class="s2">28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00</span> |
| 1304 | 1502 | <span class="s2">44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00</span> |
| 1305 | 1503 | <span class="s2">00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00</span> |
| 1306 | 1504 | <span class="s2">00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00</span> |
| 1307 | 1505 | <span class="s2">00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00</span> |
| 1308 | 1506 | <span class="s2">51 46 69 64 00 00 00 00</span> |
| 1309 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 1507 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> | |
| 1310 | 1508 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CreateRequest</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> |
| 1311 | 1509 | <span class="n">file_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1312 | 1510 | <span class="n">access_mask</span> <span class="o">=</span> <span class="n">DELETE</span> <span class="o">|</span> <span class="n">FILE_READ_ATTRIBUTES</span><span class="p">,</span> |
| 1324 | 1522 | <span class="k">def</span> <span class="nf">createCB</span><span class="p">(</span><span class="n">open_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1325 | 1523 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">open_message</span><span class="p">)</span> |
| 1326 | 1524 | <span class="k">if</span> <span class="n">open_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1327 | <span class="n">sendDelete</span><span class="p">(</span><span class="n">open_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">open_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> | |
| 1525 | <span class="n">sendDelete</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">open_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> | |
| 1328 | 1526 | <span class="k">else</span><span class="p">:</span> |
| 1329 | 1527 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to open directory'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1330 | 1528 | |
| 1333 | 1531 | <span class="n">additional_info</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1334 | 1532 | <span class="n">info_type</span> <span class="o">=</span> <span class="n">SMB2_INFO_FILE</span><span class="p">,</span> |
| 1335 | 1533 | <span class="n">file_info_class</span> <span class="o">=</span> <span class="mh">0x0d</span><span class="p">,</span> <span class="c1"># SMB2_FILE_DISPOSITION_INFO</span> |
| 1336 | <span class="n">data</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\x01</span><span class="s1">'</span><span class="p">))</span> | |
| 1337 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> | |
| 1338 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 1339 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">deleteCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">)</span> | |
| 1534 | <span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\x01</span><span class="s1">'</span><span class="p">))</span> | |
| 1535 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> | |
| 1536 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 1537 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">deleteCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">)</span> | |
| 1340 | 1538 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1341 | 1539 | |
| 1342 | 1540 | <span class="k">def</span> <span class="nf">deleteCB</span><span class="p">(</span><span class="n">delete_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1343 | 1541 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">delete_message</span><span class="p">)</span> |
| 1344 | 1542 | <span class="k">if</span> <span class="n">delete_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1345 | <span class="n">closeFid</span><span class="p">(</span><span class="n">delete_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> | |
| 1346 | <span class="k">else</span><span class="p">:</span> | |
| 1347 | <span class="n">closeFid</span><span class="p">(</span><span class="n">delete_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="n">delete_message</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> | |
| 1348 | ||
| 1349 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">status</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span> | |
| 1543 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> | |
| 1544 | <span class="k">else</span><span class="p">:</span> | |
| 1545 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="n">delete_message</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> | |
| 1546 | ||
| 1547 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">status</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span> | |
| 1350 | 1548 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CloseRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">))</span> |
| 1351 | 1549 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 1352 | 1550 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1359 | 1557 | <span class="k">else</span><span class="p">:</span> |
| 1360 | 1558 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Delete failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1361 | 1559 | |
| 1362 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 1560 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 1363 | 1561 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1364 | 1562 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 1365 | 1563 | <span class="k">if</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1368 | 1566 | <span class="k">else</span><span class="p">:</span> |
| 1369 | 1567 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1370 | 1568 | |
| 1371 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1569 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1372 | 1570 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1373 | 1571 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 1374 | 1572 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1395 | 1593 | <span class="n">old_path</span> <span class="o">=</span> <span class="n">old_path</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> |
| 1396 | 1594 | |
| 1397 | 1595 | <span class="k">def</span> <span class="nf">sendCreate</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> |
| 1398 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""</span> | |
| 1596 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""</span> | |
| 1399 | 1597 | <span class="s2">28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00</span> |
| 1400 | 1598 | <span class="s2">44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00</span> |
| 1401 | 1599 | <span class="s2">00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00</span> |
| 1402 | 1600 | <span class="s2">00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00</span> |
| 1403 | 1601 | <span class="s2">00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00</span> |
| 1404 | 1602 | <span class="s2">51 46 69 64 00 00 00 00</span> |
| 1405 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 1603 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> | |
| 1406 | 1604 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CreateRequest</span><span class="p">(</span><span class="n">old_path</span><span class="p">,</span> |
| 1407 | 1605 | <span class="n">file_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1408 | 1606 | <span class="n">access_mask</span> <span class="o">=</span> <span class="n">DELETE</span> <span class="o">|</span> <span class="n">FILE_READ_ATTRIBUTES</span> <span class="o">|</span> <span class="n">SYNCHRONIZE</span><span class="p">,</span> |
| 1420 | 1618 | <span class="k">def</span> <span class="nf">createCB</span><span class="p">(</span><span class="n">create_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1421 | 1619 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">create_message</span><span class="p">)</span> |
| 1422 | 1620 | <span class="k">if</span> <span class="n">create_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1423 | <span class="n">sendRename</span><span class="p">(</span><span class="n">create_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> | |
| 1621 | <span class="n">sendRename</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> | |
| 1424 | 1622 | <span class="k">else</span><span class="p">:</span> |
| 1425 | 1623 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to rename </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to open file/directory'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">old_path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1426 | 1624 | |
| 1427 | 1625 | <span class="k">def</span> <span class="nf">sendRename</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">):</span> |
| 1428 | <span class="n">data</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\x00</span><span class="s1">'</span><span class="o">*</span><span class="mi">16</span> <span class="o">+</span> <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<I'</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">new_path</span><span class="p">)</span><span class="o">*</span><span class="mi">2</span><span class="p">)</span> <span class="o">+</span> <span class="n">new_path</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 1626 | <span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\x00</span><span class="s1">'</span><span class="o">*</span><span class="mi">16</span> <span class="o">+</span> <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<I'</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">new_path</span><span class="p">)</span><span class="o">*</span><span class="mi">2</span><span class="p">)</span> <span class="o">+</span> <span class="n">new_path</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 1429 | 1627 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2SetInfoRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">,</span> |
| 1430 | 1628 | <span class="n">additional_info</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1431 | 1629 | <span class="n">info_type</span> <span class="o">=</span> <span class="n">SMB2_INFO_FILE</span><span class="p">,</span> |
| 1433 | 1631 | <span class="n">data</span> <span class="o">=</span> <span class="n">data</span><span class="p">))</span> |
| 1434 | 1632 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 1435 | 1633 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1436 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">renameCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">)</span> | |
| 1634 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">renameCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">)</span> | |
| 1437 | 1635 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1438 | 1636 | |
| 1439 | 1637 | <span class="k">def</span> <span class="nf">renameCB</span><span class="p">(</span><span class="n">rename_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1440 | 1638 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">rename_message</span><span class="p">)</span> |
| 1441 | 1639 | <span class="k">if</span> <span class="n">rename_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1442 | <span class="n">closeFid</span><span class="p">(</span><span class="n">rename_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> | |
| 1443 | <span class="k">else</span><span class="p">:</span> | |
| 1444 | <span class="n">closeFid</span><span class="p">(</span><span class="n">rename_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="n">rename_message</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> | |
| 1445 | ||
| 1446 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">status</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span> | |
| 1640 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> | |
| 1641 | <span class="k">else</span><span class="p">:</span> | |
| 1642 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="n">rename_message</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> | |
| 1643 | ||
| 1644 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">status</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span> | |
| 1447 | 1645 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CloseRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">))</span> |
| 1448 | 1646 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 1449 | 1647 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1456 | 1654 | <span class="k">else</span><span class="p">:</span> |
| 1457 | 1655 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to rename </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Rename failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">old_path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1458 | 1656 | |
| 1459 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 1657 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 1460 | 1658 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1461 | 1659 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 1462 | 1660 | <span class="k">if</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1465 | 1663 | <span class="k">else</span><span class="p">:</span> |
| 1466 | 1664 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to rename </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">old_path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1467 | 1665 | |
| 1468 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1666 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1469 | 1667 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1470 | 1668 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 1471 | 1669 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1485 | 1683 | <span class="n">messages_history</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 1486 | 1684 | |
| 1487 | 1685 | <span class="k">def</span> <span class="nf">sendCreate</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> |
| 1488 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""</span> | |
| 1686 | <span class="n">create_context_data</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""</span> | |
| 1489 | 1687 | <span class="s2">28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00</span> |
| 1490 | 1688 | <span class="s2">44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00</span> |
| 1491 | 1689 | <span class="s2">00 00 00 00 00 00 00 00 00 00 00 00 10 00 04 00</span> |
| 1492 | 1690 | <span class="s2">00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00</span> |
| 1493 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 1691 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> | |
| 1494 | 1692 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CreateRequest</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> |
| 1495 | 1693 | <span class="n">file_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1496 | 1694 | <span class="n">access_mask</span> <span class="o">=</span> <span class="n">FILE_READ_DATA</span> <span class="o">|</span> <span class="n">FILE_READ_ATTRIBUTES</span> <span class="o">|</span> <span class="n">SYNCHRONIZE</span><span class="p">,</span> |
| 1508 | 1706 | <span class="k">def</span> <span class="nf">createCB</span><span class="p">(</span><span class="n">create_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1509 | 1707 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">create_message</span><span class="p">)</span> |
| 1510 | 1708 | <span class="k">if</span> <span class="n">create_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1511 | <span class="n">sendEnumSnapshots</span><span class="p">(</span><span class="n">create_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> | |
| 1709 | <span class="n">sendEnumSnapshots</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">create_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> | |
| 1512 | 1710 | <span class="k">else</span><span class="p">:</span> |
| 1513 | 1711 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list snapshots </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to open file/directory'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">old_path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1514 | 1712 | |
| 1516 | 1714 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2IoctlRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">,</span> |
| 1517 | 1715 | <span class="n">ctlcode</span> <span class="o">=</span> <span class="mh">0x00144064</span><span class="p">,</span> <span class="c1"># FSCTL_SRV_ENUMERATE_SNAPSHOTS</span> |
| 1518 | 1716 | <span class="n">flags</span> <span class="o">=</span> <span class="mh">0x0001</span><span class="p">,</span> |
| 1519 | <span class="n">in_data</span> <span class="o">=</span> <span class="s1">''</span><span class="p">))</span> | |
| 1717 | <span class="n">in_data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> | |
| 1520 | 1718 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 1521 | 1719 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1522 | 1720 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">enumSnapshotsCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span><span class="p">,</span> <span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span><span class="p">)</span> |
| 1529 | 1727 | <span class="n">snapshots_count</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<I'</span><span class="p">,</span> <span class="n">enum_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">out_data</span><span class="p">[</span><span class="mi">4</span><span class="p">:</span><span class="mi">8</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span> |
| 1530 | 1728 | <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">snapshots_count</span><span class="p">):</span> |
| 1531 | 1729 | <span class="n">s</span> <span class="o">=</span> <span class="n">enum_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">out_data</span><span class="p">[</span><span class="mi">12</span><span class="o">+</span><span class="n">i</span><span class="o">*</span><span class="mi">50</span><span class="p">:</span><span class="mi">12</span><span class="o">+</span><span class="mi">48</span><span class="o">+</span><span class="n">i</span><span class="o">*</span><span class="mi">50</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> |
| 1532 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">datetime</span><span class="p">(</span><span class="o">*</span><span class="nb">map</span><span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="p">(</span> <span class="n">s</span><span class="p">[</span><span class="mi">5</span><span class="p">:</span><span class="mi">9</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">10</span><span class="p">:</span><span class="mi">12</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">13</span><span class="p">:</span><span class="mi">15</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">16</span><span class="p">:</span><span class="mi">18</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">19</span><span class="p">:</span><span class="mi">21</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">22</span><span class="p">:</span><span class="mi">24</span><span class="p">]</span> <span class="p">))))</span> | |
| 1730 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">datetime</span><span class="p">(</span><span class="o">*</span><span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="p">(</span> <span class="n">s</span><span class="p">[</span><span class="mi">5</span><span class="p">:</span><span class="mi">9</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">10</span><span class="p">:</span><span class="mi">12</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">13</span><span class="p">:</span><span class="mi">15</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">16</span><span class="p">:</span><span class="mi">18</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">19</span><span class="p">:</span><span class="mi">21</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">22</span><span class="p">:</span><span class="mi">24</span><span class="p">]</span> <span class="p">)))))</span> | |
| 1533 | 1731 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">results</span> <span class="o">=</span> <span class="n">results</span><span class="p">)</span> |
| 1534 | 1732 | <span class="k">else</span><span class="p">:</span> |
| 1535 | 1733 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">status</span> <span class="o">=</span> <span class="n">enum_message</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> |
| 1536 | 1734 | |
| 1537 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">status</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">results</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span> | |
| 1735 | <span class="k">def</span> <span class="nf">closeFid</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">status</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">results</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span> | |
| 1538 | 1736 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2CloseRequest</span><span class="p">(</span><span class="n">fid</span><span class="p">))</span> |
| 1539 | 1737 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> |
| 1540 | 1738 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1542 | 1740 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1543 | 1741 | |
| 1544 | 1742 | <span class="k">def</span> <span class="nf">closeCB</span><span class="p">(</span><span class="n">close_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1545 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'results'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span> | |
| 1743 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'results'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> | |
| 1546 | 1744 | <span class="n">callback</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'results'</span><span class="p">])</span> |
| 1547 | 1745 | <span class="k">else</span><span class="p">:</span> |
| 1548 | 1746 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list snapshots </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: List failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1549 | 1747 | |
| 1550 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 1748 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 1551 | 1749 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1552 | 1750 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 1553 | 1751 | <span class="k">if</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1556 | 1754 | <span class="k">else</span><span class="p">:</span> |
| 1557 | 1755 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list snapshots </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1558 | 1756 | |
| 1559 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1757 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMB2Message</span><span class="p">(</span><span class="n">SMB2TreeConnectRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">)))</span> | |
| 1560 | 1758 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1561 | 1759 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 1562 | 1760 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1620 | 1818 | <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">isReply</span><span class="p">:</span> |
| 1621 | 1819 | <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">command</span> <span class="o">==</span> <span class="n">SMB_COM_NEGOTIATE</span><span class="p">:</span> |
| 1622 | 1820 | <span class="k">if</span> <span class="ow">not</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 1623 | <span class="bp">self</span><span class="o">.</span><span class="n">has_negotiated</span> <span class="o">=</span> <span class="bp">True</span> | |
| 1821 | <span class="bp">self</span><span class="o">.</span><span class="n">has_negotiated</span> <span class="o">=</span> <span class="kc">True</span> | |
| 1624 | 1822 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'SMB dialect negotiation successful (ExtendedSecurity:</span><span class="si">%s</span><span class="s1">)'</span><span class="p">,</span> <span class="n">message</span><span class="o">.</span><span class="n">hasExtendedSecurity</span><span class="p">)</span> |
| 1625 | 1823 | <span class="bp">self</span><span class="o">.</span><span class="n">_updateServerInfo</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">payload</span><span class="p">)</span> |
| 1626 | 1824 | <span class="bp">self</span><span class="o">.</span><span class="n">_handleNegotiateResponse</span><span class="p">(</span><span class="n">message</span><span class="p">)</span> |
| 1635 | 1833 | <span class="k">if</span> <span class="n">result</span> <span class="o">==</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">RESULT_ACCEPT_COMPLETED</span><span class="p">:</span> |
| 1636 | 1834 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'SMB uid is now </span><span class="si">%d</span><span class="s1">'</span><span class="p">,</span> <span class="n">message</span><span class="o">.</span><span class="n">uid</span><span class="p">)</span> |
| 1637 | 1835 | <span class="bp">self</span><span class="o">.</span><span class="n">uid</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">uid</span> |
| 1638 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="bp">True</span> | |
| 1836 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">True</span> | |
| 1639 | 1837 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (with extended security) successful!'</span><span class="p">)</span> |
| 1640 | 1838 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthOK</span><span class="p">()</span> |
| 1641 | 1839 | <span class="k">else</span><span class="p">:</span> |
| 1642 | 1840 | <span class="k">raise</span> <span class="n">ProtocolError</span><span class="p">(</span><span class="s1">'SMB_COM_SESSION_SETUP_ANDX status is 0 but security blob negResult value is </span><span class="si">%d</span><span class="s1">'</span> <span class="o">%</span> <span class="n">result</span><span class="p">,</span> <span class="n">message</span><span class="o">.</span><span class="n">raw_data</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span> |
| 1643 | <span class="k">except</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">BadSecurityBlobError</span><span class="p">,</span> <span class="n">ex</span><span class="p">:</span> | |
| 1841 | <span class="k">except</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">BadSecurityBlobError</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span> | |
| 1644 | 1842 | <span class="k">raise</span> <span class="n">ProtocolError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">),</span> <span class="n">message</span><span class="o">.</span><span class="n">raw_data</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span> |
| 1645 | 1843 | <span class="k">elif</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xc0000016</span><span class="p">:</span> <span class="c1"># STATUS_MORE_PROCESSING_REQUIRED</span> |
| 1646 | 1844 | <span class="k">try</span><span class="p">:</span> |
| 1647 | 1845 | <span class="n">result</span><span class="p">,</span> <span class="n">ntlm_token</span> <span class="o">=</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">decodeChallengeSecurityBlob</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">security_blob</span><span class="p">)</span> |
| 1648 | 1846 | <span class="k">if</span> <span class="n">result</span> <span class="o">==</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">RESULT_ACCEPT_INCOMPLETE</span><span class="p">:</span> |
| 1649 | 1847 | <span class="bp">self</span><span class="o">.</span><span class="n">_handleSessionChallenge</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">ntlm_token</span><span class="p">)</span> |
| 1650 | <span class="k">except</span> <span class="p">(</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">BadSecurityBlobError</span><span class="p">,</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">UnsupportedSecurityProvider</span> <span class="p">),</span> <span class="n">ex</span><span class="p">:</span> | |
| 1848 | <span class="k">except</span> <span class="p">(</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">BadSecurityBlobError</span><span class="p">,</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">UnsupportedSecurityProvider</span> <span class="p">)</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span> | |
| 1651 | 1849 | <span class="k">raise</span> <span class="n">ProtocolError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">),</span> <span class="n">message</span><span class="o">.</span><span class="n">raw_data</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span> |
| 1652 | <span class="k">elif</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xc000006d</span><span class="p">:</span> <span class="c1"># STATUS_LOGON_FAILURE</span> | |
| 1653 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="bp">False</span> | |
| 1654 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (with extended security) failed. Please check username and password. You may need to enable/disable NTLMv2 authentication.'</span><span class="p">)</span> | |
| 1850 | <span class="k">elif</span> <span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xc000006d</span> <span class="c1"># STATUS_LOGON_FAILURE</span> | |
| 1851 | <span class="ow">or</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xc0000064</span> <span class="c1"># STATUS_NO_SUCH_USER</span> | |
| 1852 | <span class="ow">or</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xc000006a</span><span class="p">):</span> <span class="c1"># STATUS_WRONG_PASSWORD</span> | |
| 1853 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 1854 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (with extended security) failed. Please check username and password.'</span><span class="p">)</span> | |
| 1855 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> | |
| 1856 | <span class="k">elif</span> <span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xc0000193</span> <span class="c1"># STATUS_ACCOUNT_EXPIRED</span> | |
| 1857 | <span class="ow">or</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xC0000071</span><span class="p">):</span> <span class="c1"># STATUS_PASSWORD_EXPIRED</span> | |
| 1858 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 1859 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (with extended security) failed. Account or password has expired.'</span><span class="p">)</span> | |
| 1860 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> | |
| 1861 | <span class="k">elif</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xc0000234</span><span class="p">:</span> <span class="c1"># STATUS_ACCOUNT_LOCKED_OUT</span> | |
| 1862 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 1863 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (with extended security) failed. Account has been locked due to too many invalid logon attempts.'</span><span class="p">)</span> | |
| 1864 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> | |
| 1865 | <span class="k">elif</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xc0000072</span><span class="p">:</span> <span class="c1"># STATUS_ACCOUNT_DISABLED</span> | |
| 1866 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 1867 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (with extended security) failed. Account has been disabled.'</span><span class="p">)</span> | |
| 1868 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> | |
| 1869 | <span class="k">elif</span> <span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xc000006f</span> <span class="c1"># STATUS_INVALID_LOGON_HOURS</span> | |
| 1870 | <span class="ow">or</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xc000015b</span> <span class="c1"># STATUS_LOGON_TYPE_NOT_GRANTED</span> | |
| 1871 | <span class="ow">or</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xc0000070</span><span class="p">):</span> <span class="c1"># STATUS_INVALID_WORKSTATION</span> | |
| 1872 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 1873 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (with extended security) failed. Not allowed.'</span><span class="p">)</span> | |
| 1874 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> | |
| 1875 | <span class="k">elif</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xc000018c</span><span class="p">:</span> <span class="c1"># STATUS_TRUSTED_DOMAIN_FAILURE</span> | |
| 1876 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 1877 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (with extended security) failed. Domain not trusted.'</span><span class="p">)</span> | |
| 1878 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> | |
| 1879 | <span class="k">elif</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xc000018d</span><span class="p">:</span> <span class="c1"># STATUS_TRUSTED_RELATIONSHIP_FAILURE</span> | |
| 1880 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 1881 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (with extended security) failed. Workstation not trusted.'</span><span class="p">)</span> | |
| 1655 | 1882 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> |
| 1656 | 1883 | <span class="k">else</span><span class="p">:</span> |
| 1657 | 1884 | <span class="k">raise</span> <span class="n">ProtocolError</span><span class="p">(</span><span class="s1">'Unknown status value (0x</span><span class="si">%08X</span><span class="s1">) in SMB_COM_SESSION_SETUP_ANDX (with extended security)'</span> <span class="o">%</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span><span class="p">,</span> |
| 1660 | 1887 | <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 1661 | 1888 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'SMB uid is now </span><span class="si">%d</span><span class="s1">'</span><span class="p">,</span> <span class="n">message</span><span class="o">.</span><span class="n">uid</span><span class="p">)</span> |
| 1662 | 1889 | <span class="bp">self</span><span class="o">.</span><span class="n">uid</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">uid</span> |
| 1663 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="bp">True</span> | |
| 1890 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">True</span> | |
| 1664 | 1891 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (without extended security) successful!'</span><span class="p">)</span> |
| 1665 | 1892 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthOK</span><span class="p">()</span> |
| 1666 | 1893 | <span class="k">else</span><span class="p">:</span> |
| 1667 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="bp">False</span> | |
| 1894 | <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span> <span class="o">=</span> <span class="kc">False</span> | |
| 1668 | 1895 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Authentication (without extended security) failed. Please check username and password'</span><span class="p">)</span> |
| 1669 | 1896 | <span class="bp">self</span><span class="o">.</span><span class="n">onAuthFailed</span><span class="p">()</span> |
| 1670 | 1897 | <span class="k">elif</span> <span class="n">message</span><span class="o">.</span><span class="n">command</span> <span class="o">==</span> <span class="n">SMB_COM_TREE_CONNECT_ANDX</span><span class="p">:</span> |
| 1676 | 1903 | <span class="k">if</span> <span class="ow">not</span> <span class="n">message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 1677 | 1904 | <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">req</span><span class="o">.</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'path'</span><span class="p">]]</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">tid</span> |
| 1678 | 1905 | |
| 1679 | <span class="n">req</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span> | |
| 1906 | <span class="n">req</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> | |
| 1680 | 1907 | <span class="k">if</span> <span class="n">req</span><span class="p">:</span> |
| 1681 | 1908 | <span class="n">req</span><span class="o">.</span><span class="n">callback</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="o">**</span><span class="n">req</span><span class="o">.</span><span class="n">kwargs</span><span class="p">)</span> |
| 1682 | <span class="k">return</span> <span class="bp">True</span> | |
| 1909 | <span class="k">return</span> <span class="kc">True</span> | |
| 1683 | 1910 | |
| 1684 | 1911 | |
| 1685 | 1912 | <span class="k">def</span> <span class="nf">_updateServerInfo_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">payload</span><span class="p">):</span> |
| 1711 | 1938 | |
| 1712 | 1939 | <span class="k">else</span><span class="p">:</span> |
| 1713 | 1940 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Performing NTLMv1 authentication (with extended security) with server challenge "</span><span class="si">%s</span><span class="s1">"'</span><span class="p">,</span> <span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="n">server_challenge</span><span class="p">))</span> |
| 1714 | <span class="n">nt_challenge_response</span><span class="p">,</span> <span class="n">lm_challenge_response</span><span class="p">,</span> <span class="n">session_key</span> <span class="o">=</span> <span class="n">ntlm</span><span class="o">.</span><span class="n">generateChallengeResponseV1</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">,</span> <span class="n">server_challenge</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span> | |
| 1715 | ||
| 1716 | <span class="n">ntlm_data</span> <span class="o">=</span> <span class="n">ntlm</span><span class="o">.</span><span class="n">generateAuthenticateMessage</span><span class="p">(</span><span class="n">server_flags</span><span class="p">,</span> | |
| 1717 | <span class="n">nt_challenge_response</span><span class="p">,</span> | |
| 1718 | <span class="n">lm_challenge_response</span><span class="p">,</span> | |
| 1719 | <span class="n">session_key</span><span class="p">,</span> | |
| 1720 | <span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="p">,</span> | |
| 1721 | <span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="p">)</span> | |
| 1941 | <span class="n">nt_challenge_response</span><span class="p">,</span> <span class="n">lm_challenge_response</span><span class="p">,</span> <span class="n">session_key</span> <span class="o">=</span> <span class="n">ntlm</span><span class="o">.</span><span class="n">generateChallengeResponseV1</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">,</span> <span class="n">server_challenge</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span> | |
| 1942 | ||
| 1943 | <span class="n">ntlm_data</span><span class="p">,</span> <span class="n">signing_session_key</span> <span class="o">=</span> <span class="n">ntlm</span><span class="o">.</span><span class="n">generateAuthenticateMessage</span><span class="p">(</span><span class="n">server_flags</span><span class="p">,</span> | |
| 1944 | <span class="n">nt_challenge_response</span><span class="p">,</span> | |
| 1945 | <span class="n">lm_challenge_response</span><span class="p">,</span> | |
| 1946 | <span class="n">session_key</span><span class="p">,</span> | |
| 1947 | <span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="p">,</span> | |
| 1948 | <span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="p">,</span> | |
| 1949 | <span class="bp">self</span><span class="o">.</span><span class="n">my_name</span><span class="p">)</span> | |
| 1722 | 1950 | |
| 1723 | 1951 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">isEnabledFor</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">):</span> |
| 1724 | 1952 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'NT challenge response is "</span><span class="si">%s</span><span class="s1">" (</span><span class="si">%d</span><span class="s1"> bytes)'</span><span class="p">,</span> <span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="n">nt_challenge_response</span><span class="p">),</span> <span class="nb">len</span><span class="p">(</span><span class="n">nt_challenge_response</span><span class="p">))</span> |
| 1734 | 1962 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Server supports SMB signing'</span><span class="p">)</span> |
| 1735 | 1963 | <span class="bp">self</span><span class="o">.</span><span class="n">is_signing_active</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sign_options</span> <span class="o">==</span> <span class="n">SMB</span><span class="o">.</span><span class="n">SIGN_WHEN_SUPPORTED</span><span class="p">)</span> |
| 1736 | 1964 | <span class="k">else</span><span class="p">:</span> |
| 1737 | <span class="bp">self</span><span class="o">.</span><span class="n">is_signing_active</span> <span class="o">=</span> <span class="bp">False</span> | |
| 1965 | <span class="bp">self</span><span class="o">.</span><span class="n">is_signing_active</span> <span class="o">=</span> <span class="kc">False</span> | |
| 1738 | 1966 | |
| 1739 | 1967 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_signing_active</span><span class="p">:</span> |
| 1740 | 1968 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"SMB signing activated. All SMB messages will be signed."</span><span class="p">)</span> |
| 1741 | <span class="bp">self</span><span class="o">.</span><span class="n">signing_session_key</span> <span class="o">=</span> <span class="n">session_key</span> | |
| 1969 | <span class="bp">self</span><span class="o">.</span><span class="n">signing_session_key</span> <span class="o">=</span> <span class="n">signing_session_key</span> | |
| 1742 | 1970 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">capabilities</span> <span class="o">&</span> <span class="n">CAP_EXTENDED_SECURITY</span><span class="p">:</span> |
| 1743 | <span class="bp">self</span><span class="o">.</span><span class="n">signing_challenge_response</span> <span class="o">=</span> <span class="bp">None</span> | |
| 1971 | <span class="bp">self</span><span class="o">.</span><span class="n">signing_challenge_response</span> <span class="o">=</span> <span class="kc">None</span> | |
| 1744 | 1972 | <span class="k">else</span><span class="p">:</span> |
| 1745 | 1973 | <span class="bp">self</span><span class="o">.</span><span class="n">signing_challenge_response</span> <span class="o">=</span> <span class="n">blob</span> |
| 1746 | 1974 | <span class="k">else</span><span class="p">:</span> |
| 1756 | 1984 | <span class="n">blob</span> <span class="o">=</span> <span class="n">securityblob</span><span class="o">.</span><span class="n">generateNegotiateSecurityBlob</span><span class="p">(</span><span class="n">ntlm_data</span><span class="p">)</span> |
| 1757 | 1985 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComSessionSetupAndxRequest__WithSecurityExtension</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">session_key</span><span class="p">,</span> <span class="n">blob</span><span class="p">)))</span> |
| 1758 | 1986 | <span class="k">else</span><span class="p">:</span> |
| 1759 | <span class="n">nt_password</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">ntlm</span><span class="o">.</span><span class="n">generateChallengeResponseV1</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">,</span> <span class="n">message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">challenge</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span> | |
| 1987 | <span class="n">nt_password</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">ntlm</span><span class="o">.</span><span class="n">generateChallengeResponseV1</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">,</span> <span class="n">message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">challenge</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> | |
| 1760 | 1988 | <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Performing NTLMv1 authentication (without extended security) with challenge "</span><span class="si">%s</span><span class="s1">" and hashed password of "</span><span class="si">%s</span><span class="s1">"'</span><span class="p">,</span> |
| 1761 | 1989 | <span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">challenge</span><span class="p">),</span> |
| 1762 | 1990 | <span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="n">nt_password</span><span class="p">))</span> |
| 1763 | 1991 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComSessionSetupAndxRequest__NoSecurityExtension</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">session_key</span><span class="p">,</span> |
| 1764 | 1992 | <span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="p">,</span> |
| 1765 | 1993 | <span class="n">nt_password</span><span class="p">,</span> |
| 1766 | <span class="bp">True</span><span class="p">,</span> | |
| 1994 | <span class="kc">True</span><span class="p">,</span> | |
| 1767 | 1995 | <span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="p">)))</span> |
| 1768 | 1996 | |
| 1769 | 1997 | <span class="k">def</span> <span class="nf">_listShares_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> |
| 1797 | 2025 | <span class="c1"># The data_bytes are binding call to Server Service RPC using DCE v1.1 RPC over SMB. See [MS-SRVS] and [C706]</span> |
| 1798 | 2026 | <span class="c1"># 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</span> |
| 1799 | 2027 | <span class="n">data_bytes</span> <span class="o">=</span> \ |
| 1800 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""05 00 0b 03 10 00 00 00 48 00 00 00"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> <span class="o">+</span> \ | |
| 2028 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""05 00 0b 03 10 00 00 00 48 00 00 00"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> <span class="o">+</span> \ | |
| 1801 | 2029 | <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<I'</span><span class="p">,</span> <span class="n">call_id</span><span class="p">)</span> <span class="o">+</span> \ |
| 1802 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""</span> | |
| 2030 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""</span> | |
| 1803 | 2031 | <span class="s2">b8 10 b8 10 00 00 00 00 01 00 00 00 00 00 01 00</span> |
| 1804 | 2032 | <span class="s2">c8 4f 32 4b 70 16 d3 01 12 78 5a 47 bf 6e e1 88</span> |
| 1805 | 2033 | <span class="s2">03 00 00 00 04 5d 88 8a eb 1c c9 11 9f e8 08 00</span> |
| 1806 | <span class="s2">2b 10 48 60 02 00 00 00"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2034 | <span class="s2">2b 10 48 60 02 00 00 00"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> | |
| 1807 | 2035 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTransactionRequest</span><span class="p">(</span><span class="n">max_params_count</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1808 | 2036 | <span class="n">max_data_count</span> <span class="o">=</span> <span class="mi">4280</span><span class="p">,</span> |
| 1809 | 2037 | <span class="n">max_setup_count</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1821 | 2049 | <span class="k">if</span> <span class="ow">not</span> <span class="n">trans_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 1822 | 2050 | <span class="n">call_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_getNextRPCCallID</span><span class="p">()</span> |
| 1823 | 2051 | |
| 1824 | <span class="n">padding</span> <span class="o">=</span> <span class="s1">''</span> | |
| 2052 | <span class="n">padding</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 1825 | 2053 | <span class="n">server_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> |
| 1826 | 2054 | <span class="n">server_bytes_len</span> <span class="o">=</span> <span class="n">server_len</span> <span class="o">*</span> <span class="mi">2</span> |
| 1827 | 2055 | <span class="k">if</span> <span class="n">server_len</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 1828 | <span class="n">padding</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 2056 | <span class="n">padding</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 1829 | 2057 | <span class="n">server_bytes_len</span> <span class="o">+=</span> <span class="mi">2</span> |
| 1830 | 2058 | |
| 1831 | 2059 | <span class="c1"># See [MS-CIFS]: 2.2.5.6.1 for more information on TRANS_TRANSACT_NMPIPE (0x0026) parameters</span> |
| 1833 | 2061 | <span class="c1"># The data bytes are the RPC call to NetrShareEnum (Opnum 15) at Server Service RPC.</span> |
| 1834 | 2062 | <span class="c1"># 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</span> |
| 1835 | 2063 | <span class="n">data_bytes</span> <span class="o">=</span> \ |
| 1836 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""05 00 00 03 10 00 00 00"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> <span class="o">+</span> \ | |
| 2064 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""05 00 00 03 10 00 00 00"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> <span class="o">+</span> \ | |
| 1837 | 2065 | <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<HHI'</span><span class="p">,</span> <span class="mi">72</span><span class="o">+</span><span class="n">server_bytes_len</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">call_id</span><span class="p">)</span> <span class="o">+</span> \ |
| 1838 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""4c 00 00 00 00 00 0f 00 00 00 02 00"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> <span class="o">+</span> \ | |
| 2066 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""4c 00 00 00 00 00 0f 00 00 00 02 00"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> <span class="o">+</span> \ | |
| 1839 | 2067 | <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<III'</span><span class="p">,</span> <span class="n">server_len</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">server_len</span><span class="p">)</span> <span class="o">+</span> \ |
| 1840 | 2068 | <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="n">padding</span> <span class="o">+</span> \ |
| 1841 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="s2">"""</span> | |
| 2069 | <span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""</span> | |
| 1842 | 2070 | <span class="s2">01 00 00 00 01 00 00 00 04 00 02 00 00 00 00 00</span> |
| 1843 | 2071 | <span class="s2">00 00 00 00 ff ff ff ff 08 00 02 00 00 00 00 00</span> |
| 1844 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2072 | <span class="s2">"""</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">' '</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">''</span><span class="p">))</span> | |
| 1845 | 2073 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTransactionRequest</span><span class="p">(</span><span class="n">max_params_count</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1846 | 2074 | <span class="n">max_data_count</span> <span class="o">=</span> <span class="mi">4280</span><span class="p">,</span> |
| 1847 | 2075 | <span class="n">max_setup_count</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1861 | 2089 | <span class="c1"># The payload.data_bytes will contain the results of the RPC call to NetrShareEnum (Opnum 15) at Server Service RPC.</span> |
| 1862 | 2090 | <span class="n">data_bytes</span> <span class="o">=</span> <span class="n">result_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_bytes</span> |
| 1863 | 2091 | |
| 1864 | <span class="k">if</span> <span class="nb">ord</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">[</span><span class="mi">3</span><span class="p">])</span> <span class="o">&</span> <span class="mh">0x02</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> | |
| 2092 | <span class="k">if</span> <span class="n">data_bytes</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">&</span> <span class="mh">0x02</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> | |
| 1865 | 2093 | <span class="n">sendReadRequest</span><span class="p">(</span><span class="n">result_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">data_bytes</span><span class="p">)</span> |
| 1866 | 2094 | <span class="k">else</span><span class="p">:</span> |
| 1867 | 2095 | <span class="n">decodeResults</span><span class="p">(</span><span class="n">result_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">data_bytes</span><span class="p">)</span> |
| 1874 | 2102 | <span class="n">results</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> <span class="c1"># A list of SharedDevice instances</span> |
| 1875 | 2103 | <span class="n">offset</span> <span class="o">=</span> <span class="mi">36</span> <span class="o">+</span> <span class="mi">12</span> <span class="c1"># You need to study the byte stream to understand the meaning of these constants</span> |
| 1876 | 2104 | <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">shares_count</span><span class="p">):</span> |
| 1877 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">SharedDevice</span><span class="p">(</span><span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<I'</span><span class="p">,</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="mi">8</span><span class="p">])[</span><span class="mi">0</span><span class="p">],</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">))</span> | |
| 2105 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">SharedDevice</span><span class="p">(</span><span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<I'</span><span class="p">,</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="mi">8</span><span class="p">])[</span><span class="mi">0</span><span class="p">],</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span> | |
| 1878 | 2106 | <span class="n">offset</span> <span class="o">+=</span> <span class="mi">12</span> |
| 1879 | 2107 | |
| 1880 | 2108 | <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">shares_count</span><span class="p">):</span> |
| 1881 | 2109 | <span class="n">max_length</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">length</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<III'</span><span class="p">,</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="mi">12</span><span class="p">])</span> |
| 1882 | 2110 | <span class="n">offset</span> <span class="o">+=</span> <span class="mi">12</span> |
| 1883 | <span class="n">results</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="nb">unicode</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="n">length</span><span class="o">*</span><span class="mi">2</span><span class="o">-</span><span class="mi">2</span><span class="p">],</span> <span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 2111 | <span class="n">results</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="n">length</span><span class="o">*</span><span class="mi">2</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 1884 | 2112 | |
| 1885 | 2113 | <span class="k">if</span> <span class="n">length</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 1886 | 2114 | <span class="n">offset</span> <span class="o">+=</span> <span class="p">(</span><span class="n">length</span> <span class="o">*</span> <span class="mi">2</span> <span class="o">+</span> <span class="mi">2</span><span class="p">)</span> |
| 1889 | 2117 | |
| 1890 | 2118 | <span class="n">max_length</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">length</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<III'</span><span class="p">,</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="mi">12</span><span class="p">])</span> |
| 1891 | 2119 | <span class="n">offset</span> <span class="o">+=</span> <span class="mi">12</span> |
| 1892 | <span class="n">results</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">comments</span> <span class="o">=</span> <span class="nb">unicode</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="n">length</span><span class="o">*</span><span class="mi">2</span><span class="o">-</span><span class="mi">2</span><span class="p">],</span> <span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 2120 | <span class="n">results</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">comments</span> <span class="o">=</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="n">length</span><span class="o">*</span><span class="mi">2</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 1893 | 2121 | |
| 1894 | 2122 | <span class="k">if</span> <span class="n">length</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 1895 | 2123 | <span class="n">offset</span> <span class="o">+=</span> <span class="p">(</span><span class="n">length</span> <span class="o">*</span> <span class="mi">2</span> <span class="o">+</span> <span class="mi">2</span><span class="p">)</span> |
| 1912 | 2140 | <span class="k">def</span> <span class="nf">readCB</span><span class="p">(</span><span class="n">read_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 1913 | 2141 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">read_message</span><span class="p">)</span> |
| 1914 | 2142 | <span class="k">if</span> <span class="ow">not</span> <span class="n">read_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 1915 | <span class="n">data_len</span> <span class="o">=</span> <span class="n">read_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_length</span> | |
| 1916 | 2143 | <span class="n">data_bytes</span> <span class="o">=</span> <span class="n">read_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data</span> |
| 1917 | 2144 | |
| 1918 | <span class="k">if</span> <span class="nb">ord</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">[</span><span class="mi">3</span><span class="p">])</span> <span class="o">&</span> <span class="mh">0x02</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> | |
| 1919 | <span class="n">sendReadRequest</span><span class="p">(</span><span class="n">read_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_bytes'</span><span class="p">]</span> <span class="o">+</span> <span class="n">data_bytes</span><span class="p">[</span><span class="mi">24</span><span class="p">:</span><span class="n">data_len</span><span class="o">-</span><span class="mi">24</span><span class="p">])</span> | |
| 1920 | <span class="k">else</span><span class="p">:</span> | |
| 1921 | <span class="n">decodeResults</span><span class="p">(</span><span class="n">read_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_bytes'</span><span class="p">]</span> <span class="o">+</span> <span class="n">data_bytes</span><span class="p">[</span><span class="mi">24</span><span class="p">:</span><span class="n">data_len</span><span class="o">-</span><span class="mi">24</span><span class="p">])</span> | |
| 2145 | <span class="k">if</span> <span class="n">data_bytes</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">&</span> <span class="mh">0x02</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> | |
| 2146 | <span class="n">sendReadRequest</span><span class="p">(</span><span class="n">read_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_bytes'</span><span class="p">]</span> <span class="o">+</span> <span class="n">data_bytes</span><span class="p">[</span><span class="mi">24</span><span class="p">:])</span> | |
| 2147 | <span class="k">else</span><span class="p">:</span> | |
| 2148 | <span class="n">decodeResults</span><span class="p">(</span><span class="n">read_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_bytes'</span><span class="p">]</span> <span class="o">+</span> <span class="n">data_bytes</span><span class="p">[</span><span class="mi">24</span><span class="p">:])</span> | |
| 1922 | 2149 | <span class="k">else</span><span class="p">:</span> |
| 1923 | 2150 | <span class="n">closeFid</span><span class="p">(</span><span class="n">read_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">])</span> |
| 1924 | 2151 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list shares: Unable to retrieve shared device list'</span><span class="p">,</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1937 | 2164 | <span class="k">else</span><span class="p">:</span> |
| 1938 | 2165 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list shares: Unable to connect to IPC$'</span><span class="p">,</span> <span class="n">messages_history</span><span class="p">))</span> |
| 1939 | 2166 | |
| 1940 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">path</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2167 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">path</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 1941 | 2168 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1942 | 2169 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="p">)</span> |
| 1943 | 2170 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1953 | 2180 | <span class="n">messages_history</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 1954 | 2181 | <span class="n">results</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 1955 | 2182 | |
| 1956 | <span class="k">def</span> <span class="nf">sendFindFirst</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">support_dfs</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span> | |
| 2183 | <span class="k">def</span> <span class="nf">sendFindFirst</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">support_dfs</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> | |
| 1957 | 2184 | <span class="n">setup_bytes</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<H'</span><span class="p">,</span> <span class="mh">0x0001</span><span class="p">)</span> <span class="c1"># TRANS2_FIND_FIRST2 sub-command. See [MS-CIFS]: 2.2.6.2.1</span> |
| 1958 | 2185 | <span class="n">params_bytes</span> <span class="o">=</span> \ |
| 1959 | 2186 | <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<HHHHI'</span><span class="p">,</span> |
| 1960 | <span class="n">search</span><span class="p">,</span> <span class="c1"># SearchAttributes</span> | |
| 2187 | <span class="n">search</span> <span class="o">&</span> <span class="mh">0xFFFF</span><span class="p">,</span> <span class="c1"># SearchAttributes (need to restrict the values due to introduction of SMB_FILE_ATTRIBUTE_INCL_NORMAL)</span> | |
| 1961 | 2188 | <span class="mi">100</span><span class="p">,</span> <span class="c1"># SearchCount</span> |
| 1962 | 2189 | <span class="mh">0x0006</span><span class="p">,</span> <span class="c1"># Flags: SMB_FIND_CLOSE_AT_EOS | SMB_FIND_RETURN_RESUME_KEYS</span> |
| 1963 | 2190 | <span class="mh">0x0104</span><span class="p">,</span> <span class="c1"># InfoLevel: SMB_FIND_FILE_BOTH_DIRECTORY_INFO</span> |
| 1964 | <span class="mh">0x0000</span><span class="p">)</span> <span class="c1"># SearchStorageType</span> | |
| 2191 | <span class="mh">0x0000</span><span class="p">)</span> <span class="c1"># SearchStorageType (seems to be ignored by Windows)</span> | |
| 1965 | 2192 | <span class="k">if</span> <span class="n">support_dfs</span><span class="p">:</span> |
| 1966 | 2193 | <span class="n">params_bytes</span> <span class="o">+=</span> <span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">"</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">"</span> <span class="o">+</span> <span class="n">service_name</span> <span class="o">+</span> <span class="n">path</span> <span class="o">+</span> <span class="n">pattern</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> |
| 1967 | 2194 | <span class="k">else</span><span class="p">:</span> |
| 1968 | <span class="n">params_bytes</span> <span class="o">+=</span> <span class="p">(</span><span class="n">path</span> <span class="o">+</span> <span class="n">pattern</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 2195 | <span class="n">params_bytes</span> <span class="o">+=</span> <span class="p">(</span><span class="n">path</span> <span class="o">+</span> <span class="n">pattern</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 1969 | 2196 | |
| 1970 | 2197 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTransaction2Request</span><span class="p">(</span><span class="n">max_params_count</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span> |
| 1971 | 2198 | <span class="n">max_data_count</span> <span class="o">=</span> <span class="mi">16644</span><span class="p">,</span> |
| 1976 | 2203 | <span class="k">if</span> <span class="n">support_dfs</span><span class="p">:</span> |
| 1977 | 2204 | <span class="n">m</span><span class="o">.</span><span class="n">flags2</span> <span class="o">|=</span> <span class="n">SMB_FLAGS2_DFS</span> |
| 1978 | 2205 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1979 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">findFirstCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">support_dfs</span><span class="o">=</span><span class="n">support_dfs</span><span class="p">)</span> | |
| 2206 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">findFirstCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">)</span> | |
| 1980 | 2207 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 1981 | 2208 | |
| 1982 | 2209 | <span class="k">def</span> <span class="nf">decodeFindStruct</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">):</span> |
| 2001 | 2228 | |
| 2002 | 2229 | <span class="n">filename</span> <span class="o">=</span> <span class="n">data_bytes</span><span class="p">[</span><span class="n">offset2</span><span class="p">:</span><span class="n">offset2</span><span class="o">+</span><span class="n">filename_length</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> |
| 2003 | 2230 | <span class="n">short_name</span> <span class="o">=</span> <span class="n">short_name</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> |
| 2004 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">SharedFile</span><span class="p">(</span><span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">create_time</span><span class="p">),</span> <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_access_time</span><span class="p">),</span> | |
| 2005 | <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_write_time</span><span class="p">),</span> <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_attr_change_time</span><span class="p">),</span> | |
| 2006 | <span class="n">file_size</span><span class="p">,</span> <span class="n">alloc_size</span><span class="p">,</span> <span class="n">file_attributes</span><span class="p">,</span> <span class="n">short_name</span><span class="p">,</span> <span class="n">filename</span><span class="p">))</span> | |
| 2231 | ||
| 2232 | <span class="n">accept_result</span> <span class="o">=</span> <span class="kc">False</span> | |
| 2233 | <span class="k">if</span> <span class="p">(</span><span class="n">file_attributes</span> <span class="o">&</span> <span class="mh">0xff</span><span class="p">)</span> <span class="ow">in</span> <span class="p">(</span> <span class="mh">0x00</span><span class="p">,</span> <span class="n">ATTR_NORMAL</span> <span class="p">):</span> <span class="c1"># Only the first 8-bits are compared. We ignore other bits like temp, compressed, encryption, sparse, indexed, etc</span> | |
| 2234 | <span class="n">accept_result</span> <span class="o">=</span> <span class="p">(</span><span class="n">search</span> <span class="o">==</span> <span class="n">SMB_FILE_ATTRIBUTE_NORMAL</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="n">search</span> <span class="o">&</span> <span class="n">SMB_FILE_ATTRIBUTE_INCL_NORMAL</span><span class="p">)</span> | |
| 2235 | <span class="k">else</span><span class="p">:</span> | |
| 2236 | <span class="n">accept_result</span> <span class="o">=</span> <span class="p">(</span><span class="n">file_attributes</span> <span class="o">&</span> <span class="n">search</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span> | |
| 2237 | <span class="k">if</span> <span class="n">accept_result</span><span class="p">:</span> | |
| 2238 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">SharedFile</span><span class="p">(</span><span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">create_time</span><span class="p">),</span> <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_access_time</span><span class="p">),</span> | |
| 2239 | <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_write_time</span><span class="p">),</span> <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_attr_change_time</span><span class="p">),</span> | |
| 2240 | <span class="n">file_size</span><span class="p">,</span> <span class="n">alloc_size</span><span class="p">,</span> <span class="n">file_attributes</span><span class="p">,</span> <span class="n">short_name</span><span class="p">,</span> <span class="n">filename</span><span class="p">))</span> | |
| 2007 | 2241 | |
| 2008 | 2242 | <span class="k">if</span> <span class="n">next_offset</span><span class="p">:</span> |
| 2009 | 2243 | <span class="n">offset</span> <span class="o">+=</span> <span class="n">next_offset</span> |
| 2010 | 2244 | <span class="k">else</span><span class="p">:</span> |
| 2011 | 2245 | <span class="k">break</span> |
| 2012 | <span class="k">return</span> <span class="s1">''</span> | |
| 2246 | <span class="k">return</span> <span class="sa">b</span><span class="s1">''</span> | |
| 2013 | 2247 | |
| 2014 | 2248 | <span class="k">def</span> <span class="nf">findFirstCB</span><span class="p">(</span><span class="n">find_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 2015 | 2249 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">find_message</span><span class="p">)</span> |
| 2016 | 2250 | <span class="k">if</span> <span class="ow">not</span> <span class="n">find_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 2017 | <span class="k">if</span> <span class="ow">not</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="s1">'total_count'</span><span class="p">):</span> | |
| 2251 | <span class="k">if</span> <span class="s1">'total_count'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span> | |
| 2018 | 2252 | <span class="c1"># TRANS2_FIND_FIRST2 response. [MS-CIFS]: 2.2.6.2.2</span> |
| 2019 | 2253 | <span class="n">sid</span><span class="p">,</span> <span class="n">search_count</span><span class="p">,</span> <span class="n">end_of_search</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">last_name_offset</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<HHHHH'</span><span class="p">,</span> <span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">params_bytes</span><span class="p">[:</span><span class="mi">10</span><span class="p">])</span> |
| 2020 | <span class="n">kwargs</span><span class="o">.</span><span class="n">update</span><span class="p">({</span> <span class="s1">'sid'</span><span class="p">:</span> <span class="n">sid</span><span class="p">,</span> <span class="s1">'end_of_search'</span><span class="p">:</span> <span class="n">end_of_search</span><span class="p">,</span> <span class="s1">'last_name_offset'</span><span class="p">:</span> <span class="n">last_name_offset</span><span class="p">,</span> <span class="s1">'data_buf'</span><span class="p">:</span> <span class="s1">''</span> <span class="p">})</span> | |
| 2254 | <span class="n">kwargs</span><span class="o">.</span><span class="n">update</span><span class="p">({</span> <span class="s1">'sid'</span><span class="p">:</span> <span class="n">sid</span><span class="p">,</span> <span class="s1">'end_of_search'</span><span class="p">:</span> <span class="n">end_of_search</span><span class="p">,</span> <span class="s1">'last_name_offset'</span><span class="p">:</span> <span class="n">last_name_offset</span><span class="p">,</span> <span class="s1">'data_buf'</span><span class="p">:</span> <span class="sa">b</span><span class="s1">''</span> <span class="p">})</span> | |
| 2021 | 2255 | <span class="k">else</span><span class="p">:</span> |
| 2022 | 2256 | <span class="n">sid</span><span class="p">,</span> <span class="n">end_of_search</span><span class="p">,</span> <span class="n">last_name_offset</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'sid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'end_of_search'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'last_name_offset'</span><span class="p">]</span> |
| 2023 | 2257 | |
| 2024 | <span class="n">send_next</span> <span class="o">=</span> <span class="bp">True</span> | |
| 2258 | <span class="n">send_next</span> <span class="o">=</span> <span class="kc">True</span> | |
| 2025 | 2259 | <span class="k">if</span> <span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">:</span> |
| 2026 | 2260 | <span class="n">d</span> <span class="o">=</span> <span class="n">decodeFindStruct</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_buf'</span><span class="p">]</span> <span class="o">+</span> <span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">)</span> |
| 2027 | <span class="k">if</span> <span class="ow">not</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="s1">'data_count'</span><span class="p">):</span> | |
| 2261 | <span class="k">if</span> <span class="s1">'data_count'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span> | |
| 2028 | 2262 | <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">)</span> <span class="o">!=</span> <span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">total_data_count</span><span class="p">:</span> |
| 2029 | 2263 | <span class="n">kwargs</span><span class="o">.</span><span class="n">update</span><span class="p">({</span> <span class="s1">'data_count'</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">),</span> |
| 2030 | 2264 | <span class="s1">'total_count'</span><span class="p">:</span> <span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">total_data_count</span><span class="p">,</span> |
| 2031 | 2265 | <span class="s1">'data_buf'</span><span class="p">:</span> <span class="n">d</span><span class="p">,</span> |
| 2032 | 2266 | <span class="p">})</span> |
| 2033 | <span class="n">send_next</span> <span class="o">=</span> <span class="bp">False</span> | |
| 2267 | <span class="n">send_next</span> <span class="o">=</span> <span class="kc">False</span> | |
| 2034 | 2268 | <span class="k">else</span><span class="p">:</span> |
| 2035 | 2269 | <span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_count'</span><span class="p">]</span> <span class="o">+=</span> <span class="nb">len</span><span class="p">(</span><span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">)</span> |
| 2036 | 2270 | <span class="n">kwargs</span><span class="p">[</span><span class="s1">'total_count'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">total_data_count</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'total_count'</span><span class="p">])</span> |
| 2037 | 2271 | <span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_buf'</span><span class="p">]</span> <span class="o">=</span> <span class="n">d</span> |
| 2038 | 2272 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_count'</span><span class="p">]</span> <span class="o">!=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'total_count'</span><span class="p">]:</span> |
| 2039 | <span class="n">send_next</span> <span class="o">=</span> <span class="bp">False</span> | |
| 2273 | <span class="n">send_next</span> <span class="o">=</span> <span class="kc">False</span> | |
| 2040 | 2274 | |
| 2041 | 2275 | <span class="k">if</span> <span class="ow">not</span> <span class="n">send_next</span><span class="p">:</span> |
| 2042 | 2276 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">find_message</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">find_message</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">findFirstCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| 2043 | 2277 | <span class="k">elif</span> <span class="n">end_of_search</span><span class="p">:</span> |
| 2044 | 2278 | <span class="n">callback</span><span class="p">(</span><span class="n">results</span><span class="p">)</span> |
| 2045 | 2279 | <span class="k">else</span><span class="p">:</span> |
| 2046 | <span class="n">sendFindNext</span><span class="p">(</span><span class="n">find_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">sid</span><span class="p">,</span> <span class="n">last_name_offset</span><span class="p">,</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'support_dfs'</span><span class="p">,</span> <span class="bp">False</span><span class="p">))</span> | |
| 2047 | <span class="k">else</span><span class="p">:</span> | |
| 2048 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to retrieve file list'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2049 | ||
| 2050 | <span class="k">def</span> <span class="nf">sendFindNext</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">sid</span><span class="p">,</span> <span class="n">resume_key</span><span class="p">,</span> <span class="n">support_dfs</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span> | |
| 2280 | <span class="n">sendFindNext</span><span class="p">(</span><span class="n">find_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">sid</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">results</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">filename</span><span class="p">,</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'support_dfs'</span><span class="p">,</span> <span class="kc">False</span><span class="p">))</span> | |
| 2281 | <span class="k">else</span><span class="p">:</span> | |
| 2282 | <span class="k">if</span> <span class="n">find_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xC000000F</span><span class="p">:</span> <span class="c1"># [MS-ERREF]: STATUS_NO_SUCH_FILE</span> | |
| 2283 | <span class="c1"># Remote server returns STATUS_NO_SUCH_FILE error so we assume that the search returns no matching files</span> | |
| 2284 | <span class="n">callback</span><span class="p">([</span> <span class="p">])</span> | |
| 2285 | <span class="k">else</span><span class="p">:</span> | |
| 2286 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to retrieve file list'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2287 | ||
| 2288 | <span class="k">def</span> <span class="nf">sendFindNext</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">sid</span><span class="p">,</span> <span class="n">resume_key</span><span class="p">,</span> <span class="n">resume_file</span><span class="p">,</span> <span class="n">support_dfs</span><span class="p">):</span> | |
| 2051 | 2289 | <span class="n">setup_bytes</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<H'</span><span class="p">,</span> <span class="mh">0x0002</span><span class="p">)</span> <span class="c1"># TRANS2_FIND_NEXT2 sub-command. See [MS-CIFS]: 2.2.6.3.1</span> |
| 2052 | 2290 | <span class="n">params_bytes</span> <span class="o">=</span> \ |
| 2053 | 2291 | <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<HHHIH'</span><span class="p">,</span> |
| 2055 | 2293 | <span class="mi">100</span><span class="p">,</span> <span class="c1"># SearchCount</span> |
| 2056 | 2294 | <span class="mh">0x0104</span><span class="p">,</span> <span class="c1"># InfoLevel: SMB_FIND_FILE_BOTH_DIRECTORY_INFO</span> |
| 2057 | 2295 | <span class="n">resume_key</span><span class="p">,</span> <span class="c1"># ResumeKey</span> |
| 2058 | <span class="mh">0x000a</span><span class="p">)</span> <span class="c1"># Flags: SMB_FIND_RETURN_RESUME_KEYS | SMB_FIND_CLOSE_AT_EOS | SMB_FIND_RETURN_RESUME_KEYS</span> | |
| 2059 | <span class="k">if</span> <span class="n">support_dfs</span><span class="p">:</span> | |
| 2060 | <span class="n">params_bytes</span> <span class="o">+=</span> <span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">"</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">"</span> <span class="o">+</span> <span class="n">service_name</span> <span class="o">+</span> <span class="n">path</span> <span class="o">+</span> <span class="n">pattern</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 2061 | <span class="k">else</span><span class="p">:</span> | |
| 2062 | <span class="n">params_bytes</span> <span class="o">+=</span> <span class="p">(</span><span class="n">path</span> <span class="o">+</span> <span class="n">pattern</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 2296 | <span class="mh">0x0006</span><span class="p">)</span> <span class="c1"># Flags: SMB_FIND_RETURN_RESUME_KEYS | SMB_FIND_CLOSE_AT_EOS</span> | |
| 2297 | <span class="n">params_bytes</span> <span class="o">+=</span> <span class="p">(</span><span class="n">resume_file</span><span class="o">+</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> | |
| 2063 | 2298 | |
| 2064 | 2299 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTransaction2Request</span><span class="p">(</span><span class="n">max_params_count</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span> |
| 2065 | 2300 | <span class="n">max_data_count</span> <span class="o">=</span> <span class="mi">16644</span><span class="p">,</span> |
| 2076 | 2311 | <span class="k">def</span> <span class="nf">findNextCB</span><span class="p">(</span><span class="n">find_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 2077 | 2312 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">find_message</span><span class="p">)</span> |
| 2078 | 2313 | <span class="k">if</span> <span class="ow">not</span> <span class="n">find_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 2079 | <span class="k">if</span> <span class="ow">not</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="s1">'total_count'</span><span class="p">):</span> | |
| 2314 | <span class="k">if</span> <span class="s1">'total_count'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span> | |
| 2080 | 2315 | <span class="c1"># TRANS2_FIND_NEXT2 response. [MS-CIFS]: 2.2.6.3.2</span> |
| 2081 | 2316 | <span class="n">search_count</span><span class="p">,</span> <span class="n">end_of_search</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">last_name_offset</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<HHHH'</span><span class="p">,</span> <span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">params_bytes</span><span class="p">[:</span><span class="mi">8</span><span class="p">])</span> |
| 2082 | <span class="n">kwargs</span><span class="o">.</span><span class="n">update</span><span class="p">({</span> <span class="s1">'end_of_search'</span><span class="p">:</span> <span class="n">end_of_search</span><span class="p">,</span> <span class="s1">'last_name_offset'</span><span class="p">:</span> <span class="n">last_name_offset</span><span class="p">,</span> <span class="s1">'data_buf'</span><span class="p">:</span> <span class="s1">''</span> <span class="p">})</span> | |
| 2317 | <span class="n">kwargs</span><span class="o">.</span><span class="n">update</span><span class="p">({</span> <span class="s1">'end_of_search'</span><span class="p">:</span> <span class="n">end_of_search</span><span class="p">,</span> <span class="s1">'last_name_offset'</span><span class="p">:</span> <span class="n">last_name_offset</span><span class="p">,</span> <span class="s1">'data_buf'</span><span class="p">:</span> <span class="sa">b</span><span class="s1">''</span> <span class="p">})</span> | |
| 2083 | 2318 | <span class="k">else</span><span class="p">:</span> |
| 2084 | 2319 | <span class="n">end_of_search</span><span class="p">,</span> <span class="n">last_name_offset</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'end_of_search'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'last_name_offset'</span><span class="p">]</span> |
| 2085 | 2320 | |
| 2086 | <span class="n">send_next</span> <span class="o">=</span> <span class="bp">True</span> | |
| 2321 | <span class="n">send_next</span> <span class="o">=</span> <span class="kc">True</span> | |
| 2087 | 2322 | <span class="k">if</span> <span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">:</span> |
| 2088 | 2323 | <span class="n">d</span> <span class="o">=</span> <span class="n">decodeFindStruct</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_buf'</span><span class="p">]</span> <span class="o">+</span> <span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">)</span> |
| 2089 | <span class="k">if</span> <span class="ow">not</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="s1">'data_count'</span><span class="p">):</span> | |
| 2324 | <span class="k">if</span> <span class="s1">'data_count'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span> | |
| 2090 | 2325 | <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">)</span> <span class="o">!=</span> <span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">total_data_count</span><span class="p">:</span> |
| 2091 | 2326 | <span class="n">kwargs</span><span class="o">.</span><span class="n">update</span><span class="p">({</span> <span class="s1">'data_count'</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">),</span> |
| 2092 | 2327 | <span class="s1">'total_count'</span><span class="p">:</span> <span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">total_data_count</span><span class="p">,</span> |
| 2093 | 2328 | <span class="s1">'data_buf'</span><span class="p">:</span> <span class="n">d</span><span class="p">,</span> |
| 2094 | 2329 | <span class="p">})</span> |
| 2095 | <span class="n">send_next</span> <span class="o">=</span> <span class="bp">False</span> | |
| 2330 | <span class="n">send_next</span> <span class="o">=</span> <span class="kc">False</span> | |
| 2096 | 2331 | <span class="k">else</span><span class="p">:</span> |
| 2097 | 2332 | <span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_count'</span><span class="p">]</span> <span class="o">+=</span> <span class="nb">len</span><span class="p">(</span><span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">)</span> |
| 2098 | 2333 | <span class="n">kwargs</span><span class="p">[</span><span class="s1">'total_count'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">find_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">total_data_count</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'total_count'</span><span class="p">])</span> |
| 2099 | 2334 | <span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_buf'</span><span class="p">]</span> <span class="o">=</span> <span class="n">d</span> |
| 2100 | 2335 | <span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'data_count'</span><span class="p">]</span> <span class="o">!=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'total_count'</span><span class="p">]:</span> |
| 2101 | <span class="n">send_next</span> <span class="o">=</span> <span class="bp">False</span> | |
| 2336 | <span class="n">send_next</span> <span class="o">=</span> <span class="kc">False</span> | |
| 2102 | 2337 | |
| 2103 | 2338 | <span class="k">if</span> <span class="ow">not</span> <span class="n">send_next</span><span class="p">:</span> |
| 2104 | 2339 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">find_message</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">find_message</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">findNextCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| 2105 | 2340 | <span class="k">elif</span> <span class="n">end_of_search</span><span class="p">:</span> |
| 2106 | 2341 | <span class="n">callback</span><span class="p">(</span><span class="n">results</span><span class="p">)</span> |
| 2107 | 2342 | <span class="k">else</span><span class="p">:</span> |
| 2108 | <span class="n">sendFindNext</span><span class="p">(</span><span class="n">find_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'sid'</span><span class="p">],</span> <span class="n">last_name_offset</span><span class="p">,</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'support_dfs'</span><span class="p">,</span> <span class="bp">False</span><span class="p">))</span> | |
| 2343 | <span class="n">sendFindNext</span><span class="p">(</span><span class="n">find_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'sid'</span><span class="p">],</span> <span class="mi">0</span><span class="p">,</span> <span class="n">results</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">filename</span><span class="p">,</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'support_dfs'</span><span class="p">,</span> <span class="kc">False</span><span class="p">))</span> | |
| 2109 | 2344 | <span class="k">else</span><span class="p">:</span> |
| 2110 | 2345 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to retrieve file list'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 2111 | 2346 | |
| 2125 | 2360 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2126 | 2361 | |
| 2127 | 2362 | <span class="k">def</span> <span class="nf">dfsReferralCB</span><span class="p">(</span><span class="n">dfs_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 2128 | <span class="n">sendFindFirst</span><span class="p">(</span><span class="n">dfs_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span> | |
| 2129 | ||
| 2130 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 2363 | <span class="n">sendFindFirst</span><span class="p">(</span><span class="n">dfs_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span> | |
| 2364 | ||
| 2365 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 2131 | 2366 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 2132 | 2367 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 2133 | 2368 | <span class="k">if</span> <span class="ow">not</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 2135 | 2370 | <span class="k">if</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">optional_support</span> <span class="o">&</span> <span class="n">SMB_TREE_CONNECTX_SUPPORT_DFS</span><span class="p">:</span> |
| 2136 | 2371 | <span class="n">sendDFSReferral</span><span class="p">(</span><span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span><span class="p">)</span> |
| 2137 | 2372 | <span class="k">else</span><span class="p">:</span> |
| 2138 | <span class="n">sendFindFirst</span><span class="p">(</span><span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span> | |
| 2373 | <span class="n">sendFindFirst</span><span class="p">(</span><span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> | |
| 2139 | 2374 | <span class="k">else</span><span class="p">:</span> |
| 2140 | 2375 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 2141 | 2376 | |
| 2142 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2377 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2143 | 2378 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2144 | 2379 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 2145 | 2380 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2183 | 2418 | <span class="n">info_size</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">calcsize</span><span class="p">(</span><span class="n">info_format</span><span class="p">)</span> |
| 2184 | 2419 | <span class="n">create_time</span><span class="p">,</span> <span class="n">last_access_time</span><span class="p">,</span> <span class="n">last_write_time</span><span class="p">,</span> <span class="n">last_attr_change_time</span><span class="p">,</span> \ |
| 2185 | 2420 | <span class="n">file_attributes</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">alloc_size</span><span class="p">,</span> <span class="n">file_size</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="n">info_format</span><span class="p">,</span> <span class="n">query_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">[:</span><span class="n">info_size</span><span class="p">])</span> |
| 2186 | ||
| 2187 | <span class="n">info</span> <span class="o">=</span> <span class="n">SharedFile</span><span class="p">(</span><span class="n">create_time</span><span class="p">,</span> <span class="n">last_access_time</span><span class="p">,</span> <span class="n">last_write_time</span><span class="p">,</span> <span class="n">last_attr_change_time</span><span class="p">,</span> | |
| 2188 | <span class="n">file_size</span><span class="p">,</span> <span class="n">alloc_size</span><span class="p">,</span> <span class="n">file_attributes</span><span class="p">,</span> <span class="nb">unicode</span><span class="p">(</span><span class="n">path</span><span class="p">),</span> <span class="nb">unicode</span><span class="p">(</span><span class="n">path</span><span class="p">))</span> | |
| 2421 | <span class="n">filename</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_extractLastPathComponent</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> | |
| 2422 | ||
| 2423 | <span class="n">info</span> <span class="o">=</span> <span class="n">SharedFile</span><span class="p">(</span><span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">create_time</span><span class="p">),</span> <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_access_time</span><span class="p">),</span> <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_write_time</span><span class="p">),</span> <span class="n">convertFILETIMEtoEpoch</span><span class="p">(</span><span class="n">last_attr_change_time</span><span class="p">),</span> | |
| 2424 | <span class="n">file_size</span><span class="p">,</span> <span class="n">alloc_size</span><span class="p">,</span> <span class="n">file_attributes</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span> | |
| 2189 | 2425 | <span class="n">callback</span><span class="p">(</span><span class="n">info</span><span class="p">)</span> |
| 2190 | 2426 | <span class="k">else</span><span class="p">:</span> |
| 2191 | 2427 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to get attributes for </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Read failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 2192 | 2428 | |
| 2193 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 2429 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 2194 | 2430 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 2195 | 2431 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 2196 | 2432 | <span class="k">if</span> <span class="ow">not</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 2199 | 2435 | <span class="k">else</span><span class="p">:</span> |
| 2200 | 2436 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to get attributes for </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 2201 | 2437 | |
| 2202 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2438 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2203 | 2439 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2204 | 2440 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 2205 | 2441 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2206 | 2442 | <span class="k">else</span><span class="p">:</span> |
| 2207 | 2443 | <span class="n">sendQuery</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">])</span> |
| 2208 | 2444 | |
| 2445 | <span class="k">def</span> <span class="nf">_getSecurity_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 2446 | <span class="k">raise</span> <span class="n">NotReadyError</span><span class="p">(</span><span class="s1">'getSecurity is not yet implemented for SMB1'</span><span class="p">)</span> | |
| 2447 | ||
| 2209 | 2448 | <span class="k">def</span> <span class="nf">_retrieveFile_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> |
| 2210 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_retrieveFileFromOffset</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="il">0L</span><span class="p">,</span> <span class="o">-</span><span class="il">1L</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 2449 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_retrieveFileFromOffset</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 2211 | 2450 | |
| 2212 | 2451 | <span class="k">def</span> <span class="nf">_retrieveFileFromOffset_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">starting_offset</span><span class="p">,</span> <span class="n">max_length</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> |
| 2213 | 2452 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span><span class="p">:</span> |
| 2232 | 2471 | <span class="k">if</span> <span class="ow">not</span> <span class="n">open_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 2233 | 2472 | <span class="k">if</span> <span class="n">max_length</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 2234 | 2473 | <span class="n">closeFid</span><span class="p">(</span><span class="n">open_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">open_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">)</span> |
| 2235 | <span class="n">callback</span><span class="p">((</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">open_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">file_attributes</span><span class="p">,</span> <span class="il">0L</span> <span class="p">))</span> | |
| 2236 | <span class="k">else</span><span class="p">:</span> | |
| 2237 | <span class="n">sendRead</span><span class="p">(</span><span class="n">open_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">open_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">,</span> <span class="n">starting_offset</span><span class="p">,</span> <span class="n">open_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">file_attributes</span><span class="p">,</span> <span class="il">0L</span><span class="p">,</span> <span class="n">max_length</span><span class="p">)</span> | |
| 2474 | <span class="n">callback</span><span class="p">((</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">open_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">file_attributes</span><span class="p">,</span> <span class="mi">0</span> <span class="p">))</span> | |
| 2475 | <span class="k">else</span><span class="p">:</span> | |
| 2476 | <span class="n">sendRead</span><span class="p">(</span><span class="n">open_message</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">open_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">fid</span><span class="p">,</span> <span class="n">starting_offset</span><span class="p">,</span> <span class="n">open_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">file_attributes</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">max_length</span><span class="p">)</span> | |
| 2238 | 2477 | <span class="k">else</span><span class="p">:</span> |
| 2239 | 2478 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to retrieve </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to open file'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 2240 | 2479 | |
| 2284 | 2523 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2285 | 2524 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2286 | 2525 | |
| 2287 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 2526 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 2288 | 2527 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 2289 | 2528 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 2290 | 2529 | <span class="k">if</span> <span class="ow">not</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 2293 | 2532 | <span class="k">else</span><span class="p">:</span> |
| 2294 | 2533 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to retrieve </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 2295 | 2534 | |
| 2296 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2535 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2297 | 2536 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2298 | 2537 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 2299 | 2538 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2301 | 2540 | <span class="n">sendOpen</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">])</span> |
| 2302 | 2541 | |
| 2303 | 2542 | <span class="k">def</span> <span class="nf">_storeFile_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> |
| 2304 | <span class="bp">self</span><span class="o">.</span><span class="n">_storeFileFromOffset_SMB1</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="il">0L</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 2305 | ||
| 2306 | <span class="k">def</span> <span class="nf">_storeFileFromOffset_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">starting_offset</span><span class="p">,</span> <span class="n">truncate</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 2543 | <span class="bp">self</span><span class="o">.</span><span class="n">_storeFileFromOffset_SMB1</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 2544 | ||
| 2545 | <span class="k">def</span> <span class="nf">_storeFileFromOffset_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">starting_offset</span><span class="p">,</span> <span class="n">truncate</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 2307 | 2546 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span><span class="p">:</span> |
| 2308 | 2547 | <span class="k">raise</span> <span class="n">NotReadyError</span><span class="p">(</span><span class="s1">'SMB connection not authenticated'</span><span class="p">)</span> |
| 2309 | 2548 | |
| 2329 | 2568 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to store </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to open file'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 2330 | 2569 | |
| 2331 | 2570 | <span class="k">def</span> <span class="nf">sendWrite</span><span class="p">(</span><span class="n">tid</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">offset</span><span class="p">):</span> |
| 2332 | <span class="c1"># For message signing, the total SMB message size must be not exceed the max_buffer_size. Non-message signing does not have this limitation</span> | |
| 2333 | <span class="n">write_count</span> <span class="o">=</span> <span class="nb">min</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">is_signing_active</span> <span class="ow">and</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">max_buffer_size</span><span class="o">-</span><span class="mi">64</span><span class="p">))</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_raw_size</span><span class="p">,</span> <span class="mh">0xFFFF</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span> <span class="c1"># Need to minus 1 byte from 0xFFFF because of the first NULL byte in the ComWriteAndxRequest message data</span> | |
| 2571 | <span class="c1"># [MS-SMB] 2.2.4.5.2.2: The total SMB message size (inclusive of SMB header) must be not exceed the max_buffer_size.</span> | |
| 2572 | <span class="n">write_count</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">max_buffer_size</span><span class="o">-</span><span class="mi">64</span><span class="p">,</span> <span class="mh">0xFFFF</span><span class="o">-</span><span class="mi">64</span><span class="p">)</span> <span class="c1"># SMB header is 32-bytes. We factor in another 32-bytes for the message parameter block</span> | |
| 2334 | 2573 | <span class="n">data_bytes</span> <span class="o">=</span> <span class="n">file_obj</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">write_count</span><span class="p">)</span> |
| 2335 | 2574 | <span class="n">data_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">)</span> |
| 2336 | 2575 | <span class="k">if</span> <span class="n">data_len</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| 2357 | 2596 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2358 | 2597 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2359 | 2598 | |
| 2360 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 2599 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 2361 | 2600 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 2362 | 2601 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 2363 | 2602 | <span class="k">if</span> <span class="ow">not</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 2366 | 2605 | <span class="k">else</span><span class="p">:</span> |
| 2367 | 2606 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to store </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 2368 | 2607 | |
| 2369 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2608 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2370 | 2609 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2371 | 2610 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 2372 | 2611 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2373 | 2612 | <span class="k">else</span><span class="p">:</span> |
| 2374 | 2613 | <span class="n">sendOpen</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">])</span> |
| 2375 | 2614 | |
| 2376 | <span class="k">def</span> <span class="nf">_deleteFiles_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 2615 | <span class="k">def</span> <span class="nf">_deleteFiles_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">delete_matching_folders</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 2377 | 2616 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span><span class="p">:</span> |
| 2378 | 2617 | <span class="k">raise</span> <span class="n">NotReadyError</span><span class="p">(</span><span class="s1">'SMB connection not authenticated'</span><span class="p">)</span> |
| 2379 | 2618 | |
| 2619 | <span class="n">expiry_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">+</span> <span class="n">timeout</span> | |
| 2620 | <span class="n">pattern</span> <span class="o">=</span> <span class="kc">None</span> | |
| 2380 | 2621 | <span class="n">path</span> <span class="o">=</span> <span class="n">path_file_pattern</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'/'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">)</span> |
| 2622 | <span class="k">if</span> <span class="n">path</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">):</span> | |
| 2623 | <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> | |
| 2624 | <span class="k">if</span> <span class="n">path</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">):</span> | |
| 2625 | <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> | |
| 2626 | <span class="k">else</span><span class="p">:</span> | |
| 2627 | <span class="n">path_components</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">)</span> | |
| 2628 | <span class="k">if</span> <span class="n">path_components</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">'*'</span><span class="p">)</span> <span class="o">></span> <span class="o">-</span><span class="mi">1</span> <span class="ow">or</span> <span class="n">path_components</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">'?'</span><span class="p">)</span> <span class="o">></span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span> | |
| 2629 | <span class="n">path</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path_components</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span> | |
| 2630 | <span class="n">pattern</span> <span class="o">=</span> <span class="n">path_components</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> | |
| 2631 | <span class="n">messages_history</span><span class="p">,</span> <span class="n">files_queue</span> <span class="o">=</span> <span class="p">[</span> <span class="p">],</span> <span class="p">[</span> <span class="p">]</span> | |
| 2632 | ||
| 2633 | <span class="k">if</span> <span class="n">pattern</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> | |
| 2634 | <span class="n">path_components</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">)</span> | |
| 2635 | <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">path_components</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span> | |
| 2636 | <span class="n">files_queue</span><span class="o">.</span><span class="n">append</span><span class="p">((</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path_components</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]),</span> <span class="n">path_components</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="p">))</span> | |
| 2637 | <span class="k">else</span><span class="p">:</span> | |
| 2638 | <span class="n">files_queue</span><span class="o">.</span><span class="n">append</span><span class="p">((</span> <span class="s1">''</span><span class="p">,</span> <span class="n">path</span> <span class="p">))</span> | |
| 2639 | ||
| 2640 | <span class="k">def</span> <span class="nf">deleteCB</span><span class="p">(</span><span class="n">path</span><span class="p">):</span> | |
| 2641 | <span class="k">if</span> <span class="n">files_queue</span><span class="p">:</span> | |
| 2642 | <span class="n">p</span><span class="p">,</span> <span class="n">filename</span> <span class="o">=</span> <span class="n">files_queue</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> | |
| 2643 | <span class="k">if</span> <span class="n">filename</span><span class="p">:</span> | |
| 2644 | <span class="k">if</span> <span class="n">p</span><span class="p">:</span> | |
| 2645 | <span class="n">filename</span> <span class="o">=</span> <span class="n">p</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span> <span class="o">+</span> <span class="n">filename</span> | |
| 2646 | <span class="bp">self</span><span class="o">.</span><span class="n">_deleteFiles_SMB1__del</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">],</span> <span class="n">filename</span><span class="p">,</span> <span class="n">deleteCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 2647 | <span class="k">else</span><span class="p">:</span> | |
| 2648 | <span class="bp">self</span><span class="o">.</span><span class="n">_deleteDirectory_SMB1</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">deleteCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">)</span> | |
| 2649 | <span class="k">else</span><span class="p">:</span> | |
| 2650 | <span class="n">callback</span><span class="p">(</span><span class="n">path_file_pattern</span><span class="p">)</span> | |
| 2651 | ||
| 2652 | <span class="k">def</span> <span class="nf">listCB</span><span class="p">(</span><span class="n">files_list</span><span class="p">):</span> | |
| 2653 | <span class="n">files_queue</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">files_list</span><span class="p">)</span> | |
| 2654 | <span class="n">deleteCB</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span> | |
| 2655 | ||
| 2656 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 2657 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 2658 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> | |
| 2659 | <span class="k">if</span> <span class="ow">not</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> | |
| 2660 | <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span> | |
| 2661 | <span class="k">if</span> <span class="n">files_queue</span><span class="p">:</span> | |
| 2662 | <span class="n">deleteCB</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span> | |
| 2663 | <span class="k">else</span><span class="p">:</span> | |
| 2664 | <span class="bp">self</span><span class="o">.</span><span class="n">_deleteFiles_SMB1__list</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">delete_matching_folders</span><span class="p">,</span> <span class="n">listCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 2665 | <span class="k">else</span><span class="p">:</span> | |
| 2666 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2667 | ||
| 2668 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2669 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2670 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> | |
| 2671 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2672 | <span class="k">else</span><span class="p">:</span> | |
| 2673 | <span class="k">if</span> <span class="n">files_queue</span><span class="p">:</span> | |
| 2674 | <span class="n">deleteCB</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span> | |
| 2675 | <span class="k">else</span><span class="p">:</span> | |
| 2676 | <span class="bp">self</span><span class="o">.</span><span class="n">_deleteFiles_SMB1__list</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">delete_matching_folders</span><span class="p">,</span> <span class="n">listCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span> | |
| 2677 | ||
| 2678 | <span class="k">def</span> <span class="nf">_deleteFiles_SMB1__list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">delete_matching_folders</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 2679 | <span class="n">folder_queue</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> | |
| 2680 | <span class="n">files_list</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> | |
| 2681 | <span class="n">current_path</span> <span class="o">=</span> <span class="p">[</span> <span class="n">path</span> <span class="p">]</span> | |
| 2682 | <span class="n">search</span> <span class="o">=</span> <span class="n">SMB_FILE_ATTRIBUTE_READONLY</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_HIDDEN</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_SYSTEM</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_DIRECTORY</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_ARCHIVE</span> <span class="o">|</span> <span class="n">SMB_FILE_ATTRIBUTE_INCL_NORMAL</span> | |
| 2683 | ||
| 2684 | <span class="k">def</span> <span class="nf">listCB</span><span class="p">(</span><span class="n">results</span><span class="p">):</span> | |
| 2685 | <span class="n">files</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> | |
| 2686 | <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="o">.</span><span class="n">filename</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span> <span class="s1">'.'</span><span class="p">,</span> <span class="s1">'..'</span> <span class="p">],</span> <span class="n">results</span><span class="p">):</span> | |
| 2687 | <span class="k">if</span> <span class="n">f</span><span class="o">.</span><span class="n">isDirectory</span><span class="p">:</span> | |
| 2688 | <span class="k">if</span> <span class="n">delete_matching_folders</span><span class="p">:</span> | |
| 2689 | <span class="n">folder_queue</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">current_path</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">+</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="o">+</span><span class="n">f</span><span class="o">.</span><span class="n">filename</span><span class="p">)</span> | |
| 2690 | <span class="k">else</span><span class="p">:</span> | |
| 2691 | <span class="n">files</span><span class="o">.</span><span class="n">append</span><span class="p">((</span> <span class="n">current_path</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">f</span><span class="o">.</span><span class="n">filename</span> <span class="p">))</span> | |
| 2692 | <span class="k">if</span> <span class="n">current_path</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">!=</span><span class="n">path</span> <span class="ow">and</span> <span class="n">delete_matching_folders</span><span class="p">:</span> | |
| 2693 | <span class="n">files</span><span class="o">.</span><span class="n">append</span><span class="p">((</span> <span class="n">current_path</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="kc">None</span> <span class="p">))</span> | |
| 2694 | ||
| 2695 | <span class="k">if</span> <span class="n">files</span><span class="p">:</span> | |
| 2696 | <span class="n">files_list</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">files</span> | |
| 2697 | ||
| 2698 | <span class="k">if</span> <span class="n">folder_queue</span><span class="p">:</span> | |
| 2699 | <span class="n">p</span> <span class="o">=</span> <span class="n">folder_queue</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span> | |
| 2700 | <span class="n">current_path</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">p</span> | |
| 2701 | <span class="bp">self</span><span class="o">.</span><span class="n">_listPath_SMB1</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">current_path</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">listCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">search</span> <span class="o">=</span> <span class="n">search</span><span class="p">,</span> <span class="n">pattern</span> <span class="o">=</span> <span class="s1">'*'</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">)</span> | |
| 2702 | <span class="k">else</span><span class="p">:</span> | |
| 2703 | <span class="n">callback</span><span class="p">(</span><span class="n">files_list</span><span class="p">)</span> | |
| 2704 | ||
| 2705 | <span class="bp">self</span><span class="o">.</span><span class="n">_listPath_SMB1</span><span class="p">(</span><span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">listCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">search</span> <span class="o">=</span> <span class="n">search</span><span class="p">,</span> <span class="n">pattern</span> <span class="o">=</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span> | |
| 2706 | ||
| 2707 | <span class="k">def</span> <span class="nf">_deleteFiles_SMB1__del</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">tid</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 2381 | 2708 | <span class="n">messages_history</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 2382 | 2709 | |
| 2383 | 2710 | <span class="k">def</span> <span class="nf">sendDelete</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> |
| 2391 | 2718 | <span class="k">def</span> <span class="nf">deleteCB</span><span class="p">(</span><span class="n">delete_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 2392 | 2719 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">delete_message</span><span class="p">)</span> |
| 2393 | 2720 | <span class="k">if</span> <span class="ow">not</span> <span class="n">delete_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 2721 | <span class="n">callback</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> | |
| 2722 | <span class="k">elif</span> <span class="n">delete_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xC000000F</span><span class="p">:</span> <span class="c1"># [MS-ERREF]: STATUS_NO_SUCH_FILE</span> | |
| 2723 | <span class="c1"># If there are no matching files, we just treat as success instead of failing</span> | |
| 2394 | 2724 | <span class="n">callback</span><span class="p">(</span><span class="n">path_file_pattern</span><span class="p">)</span> |
| 2395 | <span class="k">else</span><span class="p">:</span> | |
| 2396 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to store </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Delete failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2397 | ||
| 2398 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 2725 | <span class="k">elif</span> <span class="n">delete_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xC00000BA</span><span class="p">:</span> <span class="c1"># [MS-ERREF]: STATUS_FILE_IS_A_DIRECTORY</span> | |
| 2726 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Cannot delete a folder. Please use deleteDirectory() method or append "/*" to your path if you wish to delete all files in the folder.'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2727 | <span class="k">elif</span> <span class="n">delete_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">==</span> <span class="mh">0xC0000034</span><span class="p">:</span> <span class="c1"># [MS-ERREF]: STATUS_OBJECT_NAME_INVALID</span> | |
| 2728 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Path not found'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2729 | <span class="k">else</span><span class="p">:</span> | |
| 2730 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Delete failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2731 | ||
| 2732 | <span class="n">sendDelete</span><span class="p">(</span><span class="n">tid</span><span class="p">)</span> | |
| 2733 | ||
| 2734 | <span class="k">def</span> <span class="nf">_resetFileAttributes_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">file_attributes</span><span class="o">=</span><span class="n">ATTR_NORMAL</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 2735 | <span class="k">raise</span> <span class="n">NotReadyError</span><span class="p">(</span><span class="s1">'resetFileAttributes is not yet implemented for SMB1'</span><span class="p">)</span> | |
| 2736 | ||
| 2737 | <span class="k">def</span> <span class="nf">_createDirectory_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 2738 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span><span class="p">:</span> | |
| 2739 | <span class="k">raise</span> <span class="n">NotReadyError</span><span class="p">(</span><span class="s1">'SMB connection not authenticated'</span><span class="p">)</span> | |
| 2740 | ||
| 2741 | <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'/'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">)</span> | |
| 2742 | <span class="n">messages_history</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> | |
| 2743 | ||
| 2744 | <span class="k">def</span> <span class="nf">sendCreate</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> | |
| 2745 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComCreateDirectoryRequest</span><span class="p">(</span><span class="n">path</span><span class="p">))</span> | |
| 2746 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> | |
| 2747 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2748 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">createCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">)</span> | |
| 2749 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2750 | ||
| 2751 | <span class="k">def</span> <span class="nf">createCB</span><span class="p">(</span><span class="n">create_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 2752 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">create_message</span><span class="p">)</span> | |
| 2753 | <span class="k">if</span> <span class="ow">not</span> <span class="n">create_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> | |
| 2754 | <span class="n">callback</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> | |
| 2755 | <span class="k">else</span><span class="p">:</span> | |
| 2756 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to create directory </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Create failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2757 | ||
| 2758 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 2759 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 2760 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> | |
| 2761 | <span class="k">if</span> <span class="ow">not</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> | |
| 2762 | <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span> | |
| 2763 | <span class="n">sendCreate</span><span class="p">(</span><span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span><span class="p">)</span> | |
| 2764 | <span class="k">else</span><span class="p">:</span> | |
| 2765 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to create directory </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2766 | ||
| 2767 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2768 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2769 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> | |
| 2770 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2771 | <span class="k">else</span><span class="p">:</span> | |
| 2772 | <span class="n">sendCreate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">])</span> | |
| 2773 | ||
| 2774 | <span class="k">def</span> <span class="nf">_deleteDirectory_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 2775 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span><span class="p">:</span> | |
| 2776 | <span class="k">raise</span> <span class="n">NotReadyError</span><span class="p">(</span><span class="s1">'SMB connection not authenticated'</span><span class="p">)</span> | |
| 2777 | ||
| 2778 | <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'/'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">)</span> | |
| 2779 | <span class="n">messages_history</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> | |
| 2780 | ||
| 2781 | <span class="k">def</span> <span class="nf">sendDelete</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> | |
| 2782 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComDeleteDirectoryRequest</span><span class="p">(</span><span class="n">path</span><span class="p">))</span> | |
| 2783 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> | |
| 2784 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2785 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">deleteCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">)</span> | |
| 2786 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2787 | ||
| 2788 | <span class="k">def</span> <span class="nf">deleteCB</span><span class="p">(</span><span class="n">delete_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 2789 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">delete_message</span><span class="p">)</span> | |
| 2790 | <span class="k">if</span> <span class="ow">not</span> <span class="n">delete_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> | |
| 2791 | <span class="n">callback</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> | |
| 2792 | <span class="k">else</span><span class="p">:</span> | |
| 2793 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete directory </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Delete failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2794 | ||
| 2795 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 2399 | 2796 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 2400 | 2797 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 2401 | 2798 | <span class="k">if</span> <span class="ow">not</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 2402 | 2799 | <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span> |
| 2403 | 2800 | <span class="n">sendDelete</span><span class="p">(</span><span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span><span class="p">)</span> |
| 2404 | 2801 | <span class="k">else</span><span class="p">:</span> |
| 2405 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2406 | ||
| 2407 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2408 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2409 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> | |
| 2410 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2411 | <span class="k">else</span><span class="p">:</span> | |
| 2412 | <span class="n">sendDelete</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">])</span> | |
| 2413 | ||
| 2414 | <span class="k">def</span> <span class="nf">_resetFileAttributes_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path_file_pattern</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 2415 | <span class="k">raise</span> <span class="n">NotReadyError</span><span class="p">(</span><span class="s1">'resetFileAttributes is not yet implemented for SMB1'</span><span class="p">)</span> | |
| 2416 | ||
| 2417 | <span class="k">def</span> <span class="nf">_createDirectory_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 2418 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span><span class="p">:</span> | |
| 2419 | <span class="k">raise</span> <span class="n">NotReadyError</span><span class="p">(</span><span class="s1">'SMB connection not authenticated'</span><span class="p">)</span> | |
| 2420 | ||
| 2421 | <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'/'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">)</span> | |
| 2422 | <span class="n">messages_history</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> | |
| 2423 | ||
| 2424 | <span class="k">def</span> <span class="nf">sendCreate</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> | |
| 2425 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComCreateDirectoryRequest</span><span class="p">(</span><span class="n">path</span><span class="p">))</span> | |
| 2426 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> | |
| 2427 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2428 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">createCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">)</span> | |
| 2429 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2430 | ||
| 2431 | <span class="k">def</span> <span class="nf">createCB</span><span class="p">(</span><span class="n">create_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 2432 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">create_message</span><span class="p">)</span> | |
| 2433 | <span class="k">if</span> <span class="ow">not</span> <span class="n">create_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> | |
| 2434 | <span class="n">callback</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> | |
| 2435 | <span class="k">else</span><span class="p">:</span> | |
| 2436 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to create directory </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Create failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2437 | ||
| 2438 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 2439 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 2440 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> | |
| 2441 | <span class="k">if</span> <span class="ow">not</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> | |
| 2442 | <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span> | |
| 2443 | <span class="n">sendCreate</span><span class="p">(</span><span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span><span class="p">)</span> | |
| 2444 | <span class="k">else</span><span class="p">:</span> | |
| 2445 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to create directory </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2446 | ||
| 2447 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2448 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2449 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> | |
| 2450 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2451 | <span class="k">else</span><span class="p">:</span> | |
| 2452 | <span class="n">sendCreate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">])</span> | |
| 2453 | ||
| 2454 | <span class="k">def</span> <span class="nf">_deleteDirectory_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> | |
| 2455 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_authenticated</span><span class="p">:</span> | |
| 2456 | <span class="k">raise</span> <span class="n">NotReadyError</span><span class="p">(</span><span class="s1">'SMB connection not authenticated'</span><span class="p">)</span> | |
| 2457 | ||
| 2458 | <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'/'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">)</span> | |
| 2459 | <span class="n">messages_history</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> | |
| 2460 | ||
| 2461 | <span class="k">def</span> <span class="nf">sendDelete</span><span class="p">(</span><span class="n">tid</span><span class="p">):</span> | |
| 2462 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComDeleteDirectoryRequest</span><span class="p">(</span><span class="n">path</span><span class="p">))</span> | |
| 2463 | <span class="n">m</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="n">tid</span> | |
| 2464 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2465 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">deleteCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">)</span> | |
| 2466 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> | |
| 2467 | ||
| 2468 | <span class="k">def</span> <span class="nf">deleteCB</span><span class="p">(</span><span class="n">delete_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 2469 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">delete_message</span><span class="p">)</span> | |
| 2470 | <span class="k">if</span> <span class="ow">not</span> <span class="n">delete_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> | |
| 2471 | <span class="n">callback</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> | |
| 2472 | <span class="k">else</span><span class="p">:</span> | |
| 2473 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete directory </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Delete failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2474 | ||
| 2475 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 2476 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 2477 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> | |
| 2478 | <span class="k">if</span> <span class="ow">not</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> | |
| 2479 | <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">[</span><span class="n">service_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span> | |
| 2480 | <span class="n">sendDelete</span><span class="p">(</span><span class="n">connect_message</span><span class="o">.</span><span class="n">tid</span><span class="p">)</span> | |
| 2481 | <span class="k">else</span><span class="p">:</span> | |
| 2482 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2483 | ||
| 2484 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2802 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to delete directory </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> | |
| 2803 | ||
| 2804 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2485 | 2805 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2486 | 2806 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 2487 | 2807 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2512 | 2832 | <span class="k">else</span><span class="p">:</span> |
| 2513 | 2833 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to rename </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Rename failed'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">old_path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 2514 | 2834 | |
| 2515 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 2835 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 2516 | 2836 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 2517 | 2837 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 2518 | 2838 | <span class="k">if</span> <span class="ow">not</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 2521 | 2841 | <span class="k">else</span><span class="p">:</span> |
| 2522 | 2842 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to rename </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">old_path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 2523 | 2843 | |
| 2524 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2844 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2525 | 2845 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2526 | 2846 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 2527 | 2847 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2582 | 2902 | <span class="n">snapshots_count</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<I'</span><span class="p">,</span> <span class="n">enum_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">[</span><span class="mi">4</span><span class="p">:</span><span class="mi">8</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span> |
| 2583 | 2903 | <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">snapshots_count</span><span class="p">):</span> |
| 2584 | 2904 | <span class="n">s</span> <span class="o">=</span> <span class="n">enum_message</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">[</span><span class="mi">12</span><span class="o">+</span><span class="n">i</span><span class="o">*</span><span class="mi">50</span><span class="p">:</span><span class="mi">12</span><span class="o">+</span><span class="mi">48</span><span class="o">+</span><span class="n">i</span><span class="o">*</span><span class="mi">50</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> |
| 2585 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">datetime</span><span class="p">(</span><span class="o">*</span><span class="nb">map</span><span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="p">(</span> <span class="n">s</span><span class="p">[</span><span class="mi">5</span><span class="p">:</span><span class="mi">9</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">10</span><span class="p">:</span><span class="mi">12</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">13</span><span class="p">:</span><span class="mi">15</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">16</span><span class="p">:</span><span class="mi">18</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">19</span><span class="p">:</span><span class="mi">21</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">22</span><span class="p">:</span><span class="mi">24</span><span class="p">]</span> <span class="p">))))</span> | |
| 2905 | <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">datetime</span><span class="p">(</span><span class="o">*</span><span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="p">(</span> <span class="n">s</span><span class="p">[</span><span class="mi">5</span><span class="p">:</span><span class="mi">9</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">10</span><span class="p">:</span><span class="mi">12</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">13</span><span class="p">:</span><span class="mi">15</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">16</span><span class="p">:</span><span class="mi">18</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">19</span><span class="p">:</span><span class="mi">21</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="mi">22</span><span class="p">:</span><span class="mi">24</span><span class="p">]</span> <span class="p">)))))</span> | |
| 2586 | 2906 | <span class="n">closeFid</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'tid'</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'fid'</span><span class="p">])</span> |
| 2587 | 2907 | <span class="n">callback</span><span class="p">(</span><span class="n">results</span><span class="p">)</span> |
| 2588 | 2908 | <span class="k">else</span><span class="p">:</span> |
| 2595 | 2915 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2596 | 2916 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2597 | 2917 | |
| 2598 | <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">service_name</span><span class="p">):</span> | |
| 2918 | <span class="k">if</span> <span class="n">service_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected_trees</span><span class="p">:</span> | |
| 2599 | 2919 | <span class="k">def</span> <span class="nf">connectCB</span><span class="p">(</span><span class="n">connect_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 2600 | 2920 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">connect_message</span><span class="p">)</span> |
| 2601 | 2921 | <span class="k">if</span> <span class="ow">not</span> <span class="n">connect_message</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">hasError</span><span class="p">:</span> |
| 2604 | 2924 | <span class="k">else</span><span class="p">:</span> |
| 2605 | 2925 | <span class="n">errback</span><span class="p">(</span><span class="n">OperationFailure</span><span class="p">(</span><span class="s1">'Failed to list snapshots </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="s1">: Unable to connect to shared device'</span> <span class="o">%</span> <span class="p">(</span> <span class="n">path</span><span class="p">,</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">messages_history</span><span class="p">))</span> |
| 2606 | 2926 | |
| 2607 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="s1">r'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2927 | <span class="n">m</span> <span class="o">=</span> <span class="n">SMBMessage</span><span class="p">(</span><span class="n">ComTreeConnectAndxRequest</span><span class="p">(</span><span class="sa">r</span><span class="s1">'</span><span class="se">\\</span><span class="si">%s</span><span class="s1">\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_name</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">service_name</span> <span class="p">),</span> <span class="n">SERVICE_ANY</span><span class="p">,</span> <span class="s1">''</span><span class="p">))</span> | |
| 2608 | 2928 | <span class="bp">self</span><span class="o">.</span><span class="n">_sendSMBMessage</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2609 | 2929 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">connectCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">service_name</span><span class="p">)</span> |
| 2610 | 2930 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2613 | 2933 | |
| 2614 | 2934 | <span class="k">def</span> <span class="nf">_echo_SMB1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span> |
| 2615 | 2935 | <span class="n">messages_history</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 2936 | ||
| 2937 | <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="sa">b</span><span class="s1">''</span><span class="p">)):</span> | |
| 2938 | <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'Echo data must be </span><span class="si">%s</span><span class="s1"> not </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="sa">b</span><span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">data</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span><span class="p">))</span> | |
| 2616 | 2939 | |
| 2617 | 2940 | <span class="k">def</span> <span class="nf">echoCB</span><span class="p">(</span><span class="n">echo_message</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| 2618 | 2941 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">echo_message</span><span class="p">)</span> |
| 2626 | 2949 | <span class="bp">self</span><span class="o">.</span><span class="n">pending_requests</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">]</span> <span class="o">=</span> <span class="n">_PendingRequest</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">+</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">echoCB</span><span class="p">,</span> <span class="n">errback</span><span class="p">)</span> |
| 2627 | 2950 | <span class="n">messages_history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> |
| 2628 | 2951 | |
| 2952 | <span class="k">def</span> <span class="nf">_extractLastPathComponent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span> | |
| 2953 | <span class="k">return</span> <span class="n">path</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'/'</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'/'</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> | |
| 2954 | ||
| 2629 | 2955 | |
| 2630 | 2956 | <div class="viewcode-block" id="SharedDevice"><a class="viewcode-back" href="../../api/smb_SharedDevice.html#smb.base.SharedDevice">[docs]</a><span class="k">class</span> <span class="nc">SharedDevice</span><span class="p">:</span> |
| 2631 | 2957 | <span class="sd">"""</span> |
| 2632 | 2958 | <span class="sd"> Contains information about a single shared device on the remote server.</span> |
| 2959 | ||
| 2960 | <span class="sd"> The following attributes are available:</span> | |
| 2961 | ||
| 2962 | <span class="sd"> * name : An unicode string containing the name of the shared device</span> | |
| 2963 | <span class="sd"> * comments : An unicode string containing the user description of the shared device</span> | |
| 2633 | 2964 | <span class="sd"> """</span> |
| 2634 | 2965 | |
| 2635 | 2966 | <span class="c1"># The following constants are taken from [MS-SRVS]: 2.2.2.4</span> |
| 2639 | 2970 | <span class="n">COMM_DEVICE</span> <span class="o">=</span> <span class="mh">0x02</span> |
| 2640 | 2971 | <span class="n">IPC</span> <span class="o">=</span> <span class="mh">0x03</span> |
| 2641 | 2972 | |
| 2642 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">type</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">comments</span><span class="p">):</span> | |
| 2973 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">type</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">comments</span><span class="p">):</span> | |
| 2643 | 2974 | <span class="bp">self</span><span class="o">.</span><span class="n">_type</span> <span class="o">=</span> <span class="nb">type</span> |
| 2644 | 2975 | <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span> <span class="c1">#: An unicode string containing the name of the shared device</span> |
| 2645 | 2976 | <span class="bp">self</span><span class="o">.</span><span class="n">comments</span> <span class="o">=</span> <span class="n">comments</span> <span class="c1">#: An unicode string containing the user description of the shared device</span> |
| 2672 | 3003 | <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_type</span> <span class="o">&</span> <span class="mh">0x40000000</span><span class="p">)</span> |
| 2673 | 3004 | |
| 2674 | 3005 | <span class="k">def</span> <span class="nf">__unicode__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| 2675 | <span class="k">return</span> <span class="s1">u'Shared device: </span><span class="si">%s</span><span class="s1"> (type:0x</span><span class="si">%02x</span><span class="s1"> comments:</span><span class="si">%s</span><span class="s1">)'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">comments</span> <span class="p">)</span></div> | |
| 3006 | <span class="k">return</span> <span class="s1">'Shared device: </span><span class="si">%s</span><span class="s1"> (type:0x</span><span class="si">%02x</span><span class="s1"> comments:</span><span class="si">%s</span><span class="s1">)'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">comments</span> <span class="p">)</span></div> | |
| 2676 | 3007 | |
| 2677 | 3008 | |
| 2678 | 3009 | <div class="viewcode-block" id="SharedFile"><a class="viewcode-back" href="../../api/smb_SharedFile.html#smb.base.SharedFile">[docs]</a><span class="k">class</span> <span class="nc">SharedFile</span><span class="p">:</span> |
| 2684 | 3015 | |
| 2685 | 3016 | <span class="sd"> If you encounter *SharedFile* instance where its short_name attribute is empty but the filename attribute contains a short name which does not correspond</span> |
| 2686 | 3017 | <span class="sd"> 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</span> |
| 2687 | <span class="sd"> one of these prohibited characters: "\/[]:+|<>=;?,* (see [MS-CIFS]: 2.2.1.1.1 for more details).</span> | |
| 3018 | <span class="sd"> one of these prohibited characters: "\\/[]:+|<>=;?,* (see [MS-CIFS]: 2.2.1.1.1 for more details).</span> | |
| 3019 | ||
| 3020 | <span class="sd"> The following attributes are available:</span> | |
| 3021 | ||
| 3022 | <span class="sd"> * 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</span> | |
| 3023 | <span class="sd"> * 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</span> | |
| 3024 | <span class="sd"> * 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</span> | |
| 3025 | <span class="sd"> * 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</span> | |
| 3026 | <span class="sd"> * file_size : File size in number of bytes</span> | |
| 3027 | <span class="sd"> * alloc_size : Total number of bytes allocated to store this file</span> | |
| 3028 | <span class="sd"> * file_attributes : A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3. You can perform bit-wise tests to determine the status of the file using the ATTR_xxx constants in smb_constants.py.</span> | |
| 3029 | <span class="sd"> * short_name : Unicode string containing the short name of this file (usually in 8.3 notation)</span> | |
| 3030 | <span class="sd"> * 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.</span> | |
| 3031 | <span class="sd"> * file_id : Long value representing the file reference number for the file. If the remote system does not support this field, this field will be None or 0. See [MS-FSCC]: 2.4.17</span> | |
| 2688 | 3032 | <span class="sd"> """</span> |
| 2689 | 3033 | |
| 2690 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">create_time</span><span class="p">,</span> <span class="n">last_access_time</span><span class="p">,</span> <span class="n">last_write_time</span><span class="p">,</span> <span class="n">last_attr_change_time</span><span class="p">,</span> <span class="n">file_size</span><span class="p">,</span> <span class="n">alloc_size</span><span class="p">,</span> <span class="n">file_attributes</span><span class="p">,</span> <span class="n">short_name</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span> | |
| 3034 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">create_time</span><span class="p">,</span> <span class="n">last_access_time</span><span class="p">,</span> <span class="n">last_write_time</span><span class="p">,</span> <span class="n">last_attr_change_time</span><span class="p">,</span> <span class="n">file_size</span><span class="p">,</span> <span class="n">alloc_size</span><span class="p">,</span> <span class="n">file_attributes</span><span class="p">,</span> <span class="n">short_name</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">file_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> | |
| 2691 | 3035 | <span class="bp">self</span><span class="o">.</span><span class="n">create_time</span> <span class="o">=</span> <span class="n">create_time</span> <span class="c1">#: 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</span> |
| 2692 | 3036 | <span class="bp">self</span><span class="o">.</span><span class="n">last_access_time</span> <span class="o">=</span> <span class="n">last_access_time</span> <span class="c1">#: 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</span> |
| 2693 | 3037 | <span class="bp">self</span><span class="o">.</span><span class="n">last_write_time</span> <span class="o">=</span> <span class="n">last_write_time</span> <span class="c1">#: 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</span> |
| 2694 | 3038 | <span class="bp">self</span><span class="o">.</span><span class="n">last_attr_change_time</span> <span class="o">=</span> <span class="n">last_attr_change_time</span> <span class="c1">#: 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</span> |
| 2695 | 3039 | <span class="bp">self</span><span class="o">.</span><span class="n">file_size</span> <span class="o">=</span> <span class="n">file_size</span> <span class="c1">#: File size in number of bytes</span> |
| 2696 | 3040 | <span class="bp">self</span><span class="o">.</span><span class="n">alloc_size</span> <span class="o">=</span> <span class="n">alloc_size</span> <span class="c1">#: Total number of bytes allocated to store this file</span> |
| 2697 | <span class="bp">self</span><span class="o">.</span><span class="n">file_attributes</span> <span class="o">=</span> <span class="n">file_attributes</span> <span class="c1">#: A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3</span> | |
| 3041 | <span class="bp">self</span><span class="o">.</span><span class="n">file_attributes</span> <span class="o">=</span> <span class="n">file_attributes</span> <span class="c1">#: A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3. You can perform bit-wise tests to determine the status of the file using the ATTR_xxx constants in smb_constants.py.</span> | |
| 2698 | 3042 | <span class="bp">self</span><span class="o">.</span><span class="n">short_name</span> <span class="o">=</span> <span class="n">short_name</span> <span class="c1">#: Unicode string containing the short name of this file (usually in 8.3 notation)</span> |
| 2699 | 3043 | <span class="bp">self</span><span class="o">.</span><span class="n">filename</span> <span class="o">=</span> <span class="n">filename</span> <span class="c1">#: 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.</span> |
| 3044 | <span class="bp">self</span><span class="o">.</span><span class="n">file_id</span> <span class="o">=</span> <span class="n">file_id</span> <span class="c1">#: Long value representing the file reference number for the file. If the remote system does not support this field, this field will be None or 0. See [MS-FSCC]: 2.4.17</span> | |
| 2700 | 3045 | |
| 2701 | 3046 | <span class="nd">@property</span> |
| 2702 | 3047 | <span class="k">def</span> <span class="nf">isDirectory</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| 2703 | <span class="sd">"""A convenient property to return True if this file resource is a directory on the remote server"""</span> | |
| 3048 | <span class="sd">"""A convenience property to return True if this file resource is a directory on the remote server"""</span> | |
| 2704 | 3049 | <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file_attributes</span> <span class="o">&</span> <span class="n">ATTR_DIRECTORY</span><span class="p">)</span> |
| 2705 | 3050 | |
| 2706 | 3051 | <span class="nd">@property</span> |
| 2708 | 3053 | <span class="sd">"""A convenient property to return True if this file resource is read-only on the remote server"""</span> |
| 2709 | 3054 | <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file_attributes</span> <span class="o">&</span> <span class="n">ATTR_READONLY</span><span class="p">)</span> |
| 2710 | 3055 | |
| 3056 | <span class="nd">@property</span> | |
| 3057 | <span class="k">def</span> <span class="nf">isNormal</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 3058 | <span class="sd">"""</span> | |
| 3059 | <span class="sd"> A convenient property to return True if this is a normal file.</span> | |
| 3060 | ||
| 3061 | <span class="sd"> Note that pysmb defines a normal file as a file entry that is not read-only, not hidden, not system, not archive and not a directory.</span> | |
| 3062 | <span class="sd"> It ignores other attributes like compression, indexed, sparse, temporary and encryption.</span> | |
| 3063 | <span class="sd"> """</span> | |
| 3064 | <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file_attributes</span><span class="o">==</span><span class="n">ATTR_NORMAL</span><span class="p">)</span> <span class="ow">or</span> <span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">file_attributes</span> <span class="o">&</span> <span class="mh">0xff</span><span class="p">)</span><span class="o">==</span><span class="mi">0</span><span class="p">)</span> | |
| 3065 | ||
| 2711 | 3066 | <span class="k">def</span> <span class="nf">__unicode__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| 2712 | <span class="k">return</span> <span class="s1">u'Shared file: </span><span class="si">%s</span><span class="s1"> (FileSize:</span><span class="si">%d</span><span class="s1"> bytes, isDirectory:</span><span class="si">%s</span><span class="s1">)'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">filename</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">file_size</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">isDirectory</span> <span class="p">)</span></div> | |
| 3067 | <span class="k">return</span> <span class="s1">'Shared file: </span><span class="si">%s</span><span class="s1"> (FileSize:</span><span class="si">%d</span><span class="s1"> bytes, isDirectory:</span><span class="si">%s</span><span class="s1">)'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">filename</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">file_size</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">isDirectory</span> <span class="p">)</span></div> | |
| 2713 | 3068 | |
| 2714 | 3069 | |
| 2715 | 3070 | <span class="k">class</span> <span class="nc">_PendingRequest</span><span class="p">:</span> |
| 2716 | 3071 | |
| 2717 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 3072 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mid</span><span class="p">,</span> <span class="n">expiry_time</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">errback</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 2718 | 3073 | <span class="bp">self</span><span class="o">.</span><span class="n">mid</span> <span class="o">=</span> <span class="n">mid</span> |
| 2719 | 3074 | <span class="bp">self</span><span class="o">.</span><span class="n">expiry_time</span> <span class="o">=</span> <span class="n">expiry_time</span> |
| 2720 | 3075 | <span class="bp">self</span><span class="o">.</span><span class="n">callback</span> <span class="o">=</span> <span class="n">callback</span> |
| 2722 | 3077 | <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span> <span class="o">=</span> <span class="n">kwargs</span> |
| 2723 | 3078 | </pre></div> |
| 2724 | 3079 | |
| 3080 | <div class="clearer"></div> | |
| 2725 | 3081 | </div> |
| 3082 | </div> | |
| 3083 | </div> | |
| 3084 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 3085 | <div class="sphinxsidebarwrapper"> | |
| 3086 | <div id="searchbox" style="display: none" role="search"> | |
| 3087 | <h3 id="searchlabel">Quick search</h3> | |
| 3088 | <div class="searchformwrapper"> | |
| 3089 | <form class="search" action="../../search.html" method="get"> | |
| 3090 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 3091 | <input type="submit" value="Go" /> | |
| 3092 | </form> | |
| 3093 | </div> | |
| 3094 | </div> | |
| 3095 | <script>$('#searchbox').show(0);</script> | |
| 2726 | 3096 | </div> |
| 2727 | 3097 | </div> |
| 2728 | 3098 | <div class="clearer"></div> |
| 2733 | 3103 | <li class="right" style="margin-right: 10px"> |
| 2734 | 3104 | <a href="../../genindex.html" title="General Index" |
| 2735 | 3105 | >index</a></li> |
| 2736 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 2737 | <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> | |
| 3106 | <li class="right" > | |
| 3107 | <a href="../../py-modindex.html" title="Python Module Index" | |
| 3108 | >modules</a> |</li> | |
| 3109 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 3110 | <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> | |
| 3111 | <li class="nav-item nav-item-this"><a href="">smb.base</a></li> | |
| 2738 | 3112 | </ul> |
| 2739 | 3113 | </div> |
| 2740 | 3114 | <div class="footer" role="contentinfo"> |
| 2741 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 2742 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 3115 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 3116 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 2743 | 3117 | </div> |
| 2744 | 3118 | </body> |
| 2745 | 3119 | </html>⏎ |
| 0 | ||
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 4 | <head> | |
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>smb.security_descriptors — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> | |
| 9 | <link rel="stylesheet" href="../../_static/sphinxdoc.css" type="text/css" /> | |
| 10 | <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> | |
| 11 | <script src="../../_static/jquery.js"></script> | |
| 12 | <script src="../../_static/underscore.js"></script> | |
| 13 | <script src="../../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../../search.html" /> | |
| 16 | </head><body> | |
| 17 | <div class="related" role="navigation" aria-label="related navigation"> | |
| 18 | <h3>Navigation</h3> | |
| 19 | <ul> | |
| 20 | <li class="right" style="margin-right: 10px"> | |
| 21 | <a href="../../genindex.html" title="General Index" | |
| 22 | accesskey="I">index</a></li> | |
| 23 | <li class="right" > | |
| 24 | <a href="../../py-modindex.html" title="Python Module Index" | |
| 25 | >modules</a> |</li> | |
| 26 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 27 | <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> | |
| 28 | <li class="nav-item nav-item-this"><a href="">smb.security_descriptors</a></li> | |
| 29 | </ul> | |
| 30 | </div> | |
| 31 | ||
| 32 | <div class="document"> | |
| 33 | <div class="documentwrapper"> | |
| 34 | <div class="bodywrapper"> | |
| 35 | <div class="body" role="main"> | |
| 36 | ||
| 37 | <h1>Source code for smb.security_descriptors</h1><div class="highlight"><pre> | |
| 38 | <span></span><span class="sd">"""</span> | |
| 39 | <span class="sd">This module implements security descriptors, and the partial structures</span> | |
| 40 | <span class="sd">used in them, as specified in [MS-DTYP].</span> | |
| 41 | <span class="sd">"""</span> | |
| 42 | ||
| 43 | <span class="kn">import</span> <span class="nn">struct</span> | |
| 44 | ||
| 45 | ||
| 46 | <span class="c1"># Security descriptor control flags</span> | |
| 47 | <span class="c1"># [MS-DTYP]: 2.4.6</span> | |
| 48 | <span class="n">SECURITY_DESCRIPTOR_OWNER_DEFAULTED</span> <span class="o">=</span> <span class="mh">0x0001</span> | |
| 49 | <span class="n">SECURITY_DESCRIPTOR_GROUP_DEFAULTED</span> <span class="o">=</span> <span class="mh">0x0002</span> | |
| 50 | <span class="n">SECURITY_DESCRIPTOR_DACL_PRESENT</span> <span class="o">=</span> <span class="mh">0x0004</span> | |
| 51 | <span class="n">SECURITY_DESCRIPTOR_DACL_DEFAULTED</span> <span class="o">=</span> <span class="mh">0x0008</span> | |
| 52 | <span class="n">SECURITY_DESCRIPTOR_SACL_PRESENT</span> <span class="o">=</span> <span class="mh">0x0010</span> | |
| 53 | <span class="n">SECURITY_DESCRIPTOR_SACL_DEFAULTED</span> <span class="o">=</span> <span class="mh">0x0020</span> | |
| 54 | <span class="n">SECURITY_DESCRIPTOR_SERVER_SECURITY</span> <span class="o">=</span> <span class="mh">0x0040</span> | |
| 55 | <span class="n">SECURITY_DESCRIPTOR_DACL_TRUSTED</span> <span class="o">=</span> <span class="mh">0x0080</span> | |
| 56 | <span class="n">SECURITY_DESCRIPTOR_DACL_COMPUTED_INHERITANCE_REQUIRED</span> <span class="o">=</span> <span class="mh">0x0100</span> | |
| 57 | <span class="n">SECURITY_DESCRIPTOR_SACL_COMPUTED_INHERITANCE_REQUIRED</span> <span class="o">=</span> <span class="mh">0x0200</span> | |
| 58 | <span class="n">SECURITY_DESCRIPTOR_DACL_AUTO_INHERITED</span> <span class="o">=</span> <span class="mh">0x0400</span> | |
| 59 | <span class="n">SECURITY_DESCRIPTOR_SACL_AUTO_INHERITED</span> <span class="o">=</span> <span class="mh">0x0800</span> | |
| 60 | <span class="n">SECURITY_DESCRIPTOR_DACL_PROTECTED</span> <span class="o">=</span> <span class="mh">0x1000</span> | |
| 61 | <span class="n">SECURITY_DESCRIPTOR_SACL_PROTECTED</span> <span class="o">=</span> <span class="mh">0x2000</span> | |
| 62 | <span class="n">SECURITY_DESCRIPTOR_RM_CONTROL_VALID</span> <span class="o">=</span> <span class="mh">0x4000</span> | |
| 63 | <span class="n">SECURITY_DESCRIPTOR_SELF_RELATIVE</span> <span class="o">=</span> <span class="mh">0x8000</span> | |
| 64 | ||
| 65 | <span class="c1"># ACE types</span> | |
| 66 | <span class="c1"># [MS-DTYP]: 2.4.4.1</span> | |
| 67 | <span class="n">ACE_TYPE_ACCESS_ALLOWED</span> <span class="o">=</span> <span class="mh">0x00</span> | |
| 68 | <span class="n">ACE_TYPE_ACCESS_DENIED</span> <span class="o">=</span> <span class="mh">0x01</span> | |
| 69 | <span class="n">ACE_TYPE_SYSTEM_AUDIT</span> <span class="o">=</span> <span class="mh">0x02</span> | |
| 70 | <span class="n">ACE_TYPE_SYSTEM_ALARM</span> <span class="o">=</span> <span class="mh">0x03</span> | |
| 71 | <span class="n">ACE_TYPE_ACCESS_ALLOWED_COMPOUND</span> <span class="o">=</span> <span class="mh">0x04</span> | |
| 72 | <span class="n">ACE_TYPE_ACCESS_ALLOWED_OBJECT</span> <span class="o">=</span> <span class="mh">0x05</span> | |
| 73 | <span class="n">ACE_TYPE_ACCESS_DENIED_OBJECT</span> <span class="o">=</span> <span class="mh">0x06</span> | |
| 74 | <span class="n">ACE_TYPE_SYSTEM_AUDIT_OBJECT</span> <span class="o">=</span> <span class="mh">0x07</span> | |
| 75 | <span class="n">ACE_TYPE_SYSTEM_ALARM_OBJECT</span> <span class="o">=</span> <span class="mh">0x08</span> | |
| 76 | <span class="n">ACE_TYPE_ACCESS_ALLOWED_CALLBACK</span> <span class="o">=</span> <span class="mh">0x09</span> | |
| 77 | <span class="n">ACE_TYPE_ACCESS_DENIED_CALLBACK</span> <span class="o">=</span> <span class="mh">0x0A</span> | |
| 78 | <span class="n">ACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT</span> <span class="o">=</span> <span class="mh">0x0B</span> | |
| 79 | <span class="n">ACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT</span> <span class="o">=</span> <span class="mh">0x0C</span> | |
| 80 | <span class="n">ACE_TYPE_SYSTEM_AUDIT_CALLBACK</span> <span class="o">=</span> <span class="mh">0x0D</span> | |
| 81 | <span class="n">ACE_TYPE_SYSTEM_ALARM_CALLBACK</span> <span class="o">=</span> <span class="mh">0x0E</span> | |
| 82 | <span class="n">ACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT</span> <span class="o">=</span> <span class="mh">0x0F</span> | |
| 83 | <span class="n">ACE_TYPE_SYSTEM_ALARM_CALLBACK_OBJECT</span> <span class="o">=</span> <span class="mh">0x10</span> | |
| 84 | <span class="n">ACE_TYPE_SYSTEM_MANDATORY_LABEL</span> <span class="o">=</span> <span class="mh">0x11</span> | |
| 85 | <span class="n">ACE_TYPE_SYSTEM_RESOURCE_ATTRIBUTE</span> <span class="o">=</span> <span class="mh">0x12</span> | |
| 86 | <span class="n">ACE_TYPE_SYSTEM_SCOPED_POLICY_ID</span> <span class="o">=</span> <span class="mh">0x13</span> | |
| 87 | ||
| 88 | <span class="c1"># ACE flags</span> | |
| 89 | <span class="c1"># [MS-DTYP]: 2.4.4.1</span> | |
| 90 | <span class="n">ACE_FLAG_OBJECT_INHERIT</span> <span class="o">=</span> <span class="mh">0x01</span> | |
| 91 | <span class="n">ACE_FLAG_CONTAINER_INHERIT</span> <span class="o">=</span> <span class="mh">0x02</span> | |
| 92 | <span class="n">ACE_FLAG_NO_PROPAGATE_INHERIT</span> <span class="o">=</span> <span class="mh">0x04</span> | |
| 93 | <span class="n">ACE_FLAG_INHERIT_ONLY</span> <span class="o">=</span> <span class="mh">0x08</span> | |
| 94 | <span class="n">ACE_FLAG_INHERITED</span> <span class="o">=</span> <span class="mh">0x10</span> | |
| 95 | <span class="n">ACE_FLAG_SUCCESSFUL_ACCESS</span> <span class="o">=</span> <span class="mh">0x40</span> | |
| 96 | <span class="n">ACE_FLAG_FAILED_ACCESS</span> <span class="o">=</span> <span class="mh">0x80</span> | |
| 97 | ||
| 98 | <span class="c1"># Pre-defined well-known SIDs</span> | |
| 99 | <span class="c1"># [MS-DTYP]: 2.4.2.4</span> | |
| 100 | <span class="n">SID_NULL</span> <span class="o">=</span> <span class="s2">"S-1-0-0"</span> | |
| 101 | <span class="n">SID_EVERYONE</span> <span class="o">=</span> <span class="s2">"S-1-1-0"</span> | |
| 102 | <span class="n">SID_LOCAL</span> <span class="o">=</span> <span class="s2">"S-1-2-0"</span> | |
| 103 | <span class="n">SID_CONSOLE_LOGON</span> <span class="o">=</span> <span class="s2">"S-1-2-1"</span> | |
| 104 | <span class="n">SID_CREATOR_OWNER</span> <span class="o">=</span> <span class="s2">"S-1-3-0"</span> | |
| 105 | <span class="n">SID_CREATOR_GROUP</span> <span class="o">=</span> <span class="s2">"S-1-3-1"</span> | |
| 106 | <span class="n">SID_OWNER_SERVER</span> <span class="o">=</span> <span class="s2">"S-1-3-2"</span> | |
| 107 | <span class="n">SID_GROUP_SERVER</span> <span class="o">=</span> <span class="s2">"S-1-3-3"</span> | |
| 108 | <span class="n">SID_OWNER_RIGHTS</span> <span class="o">=</span> <span class="s2">"S-1-3-4"</span> | |
| 109 | <span class="n">SID_NT_AUTHORITY</span> <span class="o">=</span> <span class="s2">"S-1-5"</span> | |
| 110 | <span class="n">SID_DIALUP</span> <span class="o">=</span> <span class="s2">"S-1-5-1"</span> | |
| 111 | <span class="n">SID_NETWORK</span> <span class="o">=</span> <span class="s2">"S-1-5-2"</span> | |
| 112 | <span class="n">SID_BATCH</span> <span class="o">=</span> <span class="s2">"S-1-5-3"</span> | |
| 113 | <span class="n">SID_INTERACTIVE</span> <span class="o">=</span> <span class="s2">"S-1-5-4"</span> | |
| 114 | <span class="n">SID_SERVICE</span> <span class="o">=</span> <span class="s2">"S-1-5-6"</span> | |
| 115 | <span class="n">SID_ANONYMOUS</span> <span class="o">=</span> <span class="s2">"S-1-5-7"</span> | |
| 116 | <span class="n">SID_PROXY</span> <span class="o">=</span> <span class="s2">"S-1-5-8"</span> | |
| 117 | <span class="n">SID_ENTERPRISE_DOMAIN_CONTROLLERS</span> <span class="o">=</span> <span class="s2">"S-1-5-9"</span> | |
| 118 | <span class="n">SID_PRINCIPAL_SELF</span> <span class="o">=</span> <span class="s2">"S-1-5-10"</span> | |
| 119 | <span class="n">SID_AUTHENTICATED_USERS</span> <span class="o">=</span> <span class="s2">"S-1-5-11"</span> | |
| 120 | <span class="n">SID_RESTRICTED_CODE</span> <span class="o">=</span> <span class="s2">"S-1-5-12"</span> | |
| 121 | <span class="n">SID_TERMINAL_SERVER_USER</span> <span class="o">=</span> <span class="s2">"S-1-5-13"</span> | |
| 122 | <span class="n">SID_REMOTE_INTERACTIVE_LOGON</span> <span class="o">=</span> <span class="s2">"S-1-5-14"</span> | |
| 123 | <span class="n">SID_THIS_ORGANIZATION</span> <span class="o">=</span> <span class="s2">"S-1-5-15"</span> | |
| 124 | <span class="n">SID_IUSR</span> <span class="o">=</span> <span class="s2">"S-1-5-17"</span> | |
| 125 | <span class="n">SID_LOCAL_SYSTEM</span> <span class="o">=</span> <span class="s2">"S-1-5-18"</span> | |
| 126 | <span class="n">SID_LOCAL_SERVICE</span> <span class="o">=</span> <span class="s2">"S-1-5-19"</span> | |
| 127 | <span class="n">SID_NETWORK_SERVICE</span> <span class="o">=</span> <span class="s2">"S-1-5-20"</span> | |
| 128 | <span class="n">SID_COMPOUNDED_AUTHENTICATION</span> <span class="o">=</span> <span class="s2">"S-1-5-21-0-0-0-496"</span> | |
| 129 | <span class="n">SID_CLAIMS_VALID</span> <span class="o">=</span> <span class="s2">"S-1-5-21-0-0-0-497"</span> | |
| 130 | <span class="n">SID_BUILTIN_ADMINISTRATORS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-544"</span> | |
| 131 | <span class="n">SID_BUILTIN_USERS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-545"</span> | |
| 132 | <span class="n">SID_BUILTIN_GUESTS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-546"</span> | |
| 133 | <span class="n">SID_POWER_USERS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-547"</span> | |
| 134 | <span class="n">SID_ACCOUNT_OPERATORS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-548"</span> | |
| 135 | <span class="n">SID_SERVER_OPERATORS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-549"</span> | |
| 136 | <span class="n">SID_PRINTER_OPERATORS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-550"</span> | |
| 137 | <span class="n">SID_BACKUP_OPERATORS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-551"</span> | |
| 138 | <span class="n">SID_REPLICATOR</span> <span class="o">=</span> <span class="s2">"S-1-5-32-552"</span> | |
| 139 | <span class="n">SID_ALIAS_PREW2KCOMPACC</span> <span class="o">=</span> <span class="s2">"S-1-5-32-554"</span> | |
| 140 | <span class="n">SID_REMOTE_DESKTOP</span> <span class="o">=</span> <span class="s2">"S-1-5-32-555"</span> | |
| 141 | <span class="n">SID_NETWORK_CONFIGURATION_OPS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-556"</span> | |
| 142 | <span class="n">SID_INCOMING_FOREST_TRUST_BUILDERS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-557"</span> | |
| 143 | <span class="n">SID_PERFMON_USERS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-558"</span> | |
| 144 | <span class="n">SID_PERFLOG_USERS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-559"</span> | |
| 145 | <span class="n">SID_WINDOWS_AUTHORIZATION_ACCESS_GROUP</span> <span class="o">=</span> <span class="s2">"S-1-5-32-560"</span> | |
| 146 | <span class="n">SID_TERMINAL_SERVER_LICENSE_SERVERS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-561"</span> | |
| 147 | <span class="n">SID_DISTRIBUTED_COM_USERS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-562"</span> | |
| 148 | <span class="n">SID_IIS_IUSRS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-568"</span> | |
| 149 | <span class="n">SID_CRYPTOGRAPHIC_OPERATORS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-569"</span> | |
| 150 | <span class="n">SID_EVENT_LOG_READERS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-573"</span> | |
| 151 | <span class="n">SID_CERTIFICATE_SERVICE_DCOM_ACCESS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-574"</span> | |
| 152 | <span class="n">SID_RDS_REMOTE_ACCESS_SERVERS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-575"</span> | |
| 153 | <span class="n">SID_RDS_ENDPOINT_SERVERS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-576"</span> | |
| 154 | <span class="n">SID_RDS_MANAGEMENT_SERVERS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-577"</span> | |
| 155 | <span class="n">SID_HYPER_V_ADMINS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-578"</span> | |
| 156 | <span class="n">SID_ACCESS_CONTROL_ASSISTANCE_OPS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-579"</span> | |
| 157 | <span class="n">SID_REMOTE_MANAGEMENT_USERS</span> <span class="o">=</span> <span class="s2">"S-1-5-32-580"</span> | |
| 158 | <span class="n">SID_WRITE_RESTRICTED_CODE</span> <span class="o">=</span> <span class="s2">"S-1-5-33"</span> | |
| 159 | <span class="n">SID_NTLM_AUTHENTICATION</span> <span class="o">=</span> <span class="s2">"S-1-5-64-10"</span> | |
| 160 | <span class="n">SID_SCHANNEL_AUTHENTICATION</span> <span class="o">=</span> <span class="s2">"S-1-5-64-14"</span> | |
| 161 | <span class="n">SID_DIGEST_AUTHENTICATION</span> <span class="o">=</span> <span class="s2">"S-1-5-64-21"</span> | |
| 162 | <span class="n">SID_THIS_ORGANIZATION_CERTIFICATE</span> <span class="o">=</span> <span class="s2">"S-1-5-65-1"</span> | |
| 163 | <span class="n">SID_NT_SERVICE</span> <span class="o">=</span> <span class="s2">"S-1-5-80"</span> | |
| 164 | <span class="n">SID_USER_MODE_DRIVERS</span> <span class="o">=</span> <span class="s2">"S-1-5-84-0-0-0-0-0"</span> | |
| 165 | <span class="n">SID_LOCAL_ACCOUNT</span> <span class="o">=</span> <span class="s2">"S-1-5-113"</span> | |
| 166 | <span class="n">SID_LOCAL_ACCOUNT_AND_MEMBER_OF_ADMINISTRATORS_GROUP</span> <span class="o">=</span> <span class="s2">"S-1-5-114"</span> | |
| 167 | <span class="n">SID_OTHER_ORGANIZATION</span> <span class="o">=</span> <span class="s2">"S-1-5-1000"</span> | |
| 168 | <span class="n">SID_ALL_APP_PACKAGES</span> <span class="o">=</span> <span class="s2">"S-1-15-2-1"</span> | |
| 169 | <span class="n">SID_ML_UNTRUSTED</span> <span class="o">=</span> <span class="s2">"S-1-16-0"</span> | |
| 170 | <span class="n">SID_ML_LOW</span> <span class="o">=</span> <span class="s2">"S-1-16-4096"</span> | |
| 171 | <span class="n">SID_ML_MEDIUM</span> <span class="o">=</span> <span class="s2">"S-1-16-8192"</span> | |
| 172 | <span class="n">SID_ML_MEDIUM_PLUS</span> <span class="o">=</span> <span class="s2">"S-1-16-8448"</span> | |
| 173 | <span class="n">SID_ML_HIGH</span> <span class="o">=</span> <span class="s2">"S-1-16-12288"</span> | |
| 174 | <span class="n">SID_ML_SYSTEM</span> <span class="o">=</span> <span class="s2">"S-1-16-16384"</span> | |
| 175 | <span class="n">SID_ML_PROTECTED_PROCESS</span> <span class="o">=</span> <span class="s2">"S-1-16-20480"</span> | |
| 176 | <span class="n">SID_AUTHENTICATION_AUTHORITY_ASSERTED_IDENTITY</span> <span class="o">=</span> <span class="s2">"S-1-18-1"</span> | |
| 177 | <span class="n">SID_SERVICE_ASSERTED_IDENTITY</span> <span class="o">=</span> <span class="s2">"S-1-18-2"</span> | |
| 178 | <span class="n">SID_FRESH_PUBLIC_KEY_IDENTITY</span> <span class="o">=</span> <span class="s2">"S-1-18-3"</span> | |
| 179 | <span class="n">SID_KEY_TRUST_IDENTITY</span> <span class="o">=</span> <span class="s2">"S-1-18-4"</span> | |
| 180 | <span class="n">SID_KEY_PROPERTY_MFA</span> <span class="o">=</span> <span class="s2">"S-1-18-5"</span> | |
| 181 | <span class="n">SID_KEY_PROPERTY_ATTESTATION</span> <span class="o">=</span> <span class="s2">"S-1-18-6"</span> | |
| 182 | ||
| 183 | ||
| 184 | <div class="viewcode-block" id="SID"><a class="viewcode-back" href="../../api/smb_security_descriptors.html#smb.security_descriptors.SID">[docs]</a><span class="k">class</span> <span class="nc">SID</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> | |
| 185 | <span class="sd">"""</span> | |
| 186 | <span class="sd"> A Windows security identifier. Represents a single principal, such a</span> | |
| 187 | <span class="sd"> user or a group, as a sequence of numbers consisting of the revision,</span> | |
| 188 | <span class="sd"> identifier authority, and a variable-length list of subauthorities.</span> | |
| 189 | ||
| 190 | <span class="sd"> See [MS-DTYP]: 2.4.2</span> | |
| 191 | <span class="sd"> """</span> | |
| 192 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">revision</span><span class="p">,</span> <span class="n">identifier_authority</span><span class="p">,</span> <span class="n">subauthorities</span><span class="p">):</span> | |
| 193 | <span class="c1">#: Revision, should always be 1.</span> | |
| 194 | <span class="bp">self</span><span class="o">.</span><span class="n">revision</span> <span class="o">=</span> <span class="n">revision</span> | |
| 195 | <span class="c1">#: An integer representing the identifier authority.</span> | |
| 196 | <span class="bp">self</span><span class="o">.</span><span class="n">identifier_authority</span> <span class="o">=</span> <span class="n">identifier_authority</span> | |
| 197 | <span class="c1">#: A list of integers representing all subauthorities.</span> | |
| 198 | <span class="bp">self</span><span class="o">.</span><span class="n">subauthorities</span> <span class="o">=</span> <span class="n">subauthorities</span> | |
| 199 | ||
| 200 | <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 201 | <span class="sd">"""</span> | |
| 202 | <span class="sd"> String representation, as specified in [MS-DTYP]: 2.4.2.1</span> | |
| 203 | <span class="sd"> """</span> | |
| 204 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">identifier_authority</span> <span class="o">>=</span> <span class="mi">2</span><span class="o">**</span><span class="mi">32</span><span class="p">:</span> | |
| 205 | <span class="n">id_auth</span> <span class="o">=</span> <span class="s1">'</span><span class="si">%#x</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">identifier_authority</span><span class="p">,)</span> | |
| 206 | <span class="k">else</span><span class="p">:</span> | |
| 207 | <span class="n">id_auth</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">identifier_authority</span> | |
| 208 | <span class="n">auths</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">revision</span><span class="p">,</span> <span class="n">id_auth</span><span class="p">]</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">subauthorities</span> | |
| 209 | <span class="k">return</span> <span class="s1">'S-'</span> <span class="o">+</span> <span class="s1">'-'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">subauth</span><span class="p">)</span> <span class="k">for</span> <span class="n">subauth</span> <span class="ow">in</span> <span class="n">auths</span><span class="p">)</span> | |
| 210 | ||
| 211 | <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 212 | <span class="k">return</span> <span class="s1">'SID(</span><span class="si">%r</span><span class="s1">)'</span> <span class="o">%</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">),)</span> | |
| 213 | ||
| 214 | <span class="nd">@classmethod</span> | |
| 215 | <span class="k">def</span> <span class="nf">from_bytes</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">return_tail</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> | |
| 216 | <span class="n">revision</span><span class="p">,</span> <span class="n">subauth_count</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<BB'</span><span class="p">,</span> <span class="n">data</span><span class="p">[:</span><span class="mi">2</span><span class="p">])</span> | |
| 217 | <span class="n">identifier_authority</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'>Q'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\x00\x00</span><span class="s1">'</span> <span class="o">+</span> <span class="n">data</span><span class="p">[</span><span class="mi">2</span><span class="p">:</span><span class="mi">8</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span> | |
| 218 | <span class="n">subauth_data</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">8</span><span class="p">:]</span> | |
| 219 | <span class="n">subauthorities</span> <span class="o">=</span> <span class="p">[</span><span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<L'</span><span class="p">,</span> <span class="n">subauth_data</span><span class="p">[</span><span class="mi">4</span> <span class="o">*</span> <span class="n">i</span> <span class="p">:</span> <span class="mi">4</span> <span class="o">*</span> <span class="p">(</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">)])[</span><span class="mi">0</span><span class="p">]</span> | |
| 220 | <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">subauth_count</span><span class="p">)]</span> | |
| 221 | <span class="n">sid</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="n">revision</span><span class="p">,</span> <span class="n">identifier_authority</span><span class="p">,</span> <span class="n">subauthorities</span><span class="p">)</span> | |
| 222 | <span class="k">if</span> <span class="n">return_tail</span><span class="p">:</span> | |
| 223 | <span class="k">return</span> <span class="n">sid</span><span class="p">,</span> <span class="n">subauth_data</span><span class="p">[</span><span class="mi">4</span> <span class="o">*</span> <span class="n">subauth_count</span> <span class="p">:]</span> | |
| 224 | <span class="k">return</span> <span class="n">sid</span></div> | |
| 225 | ||
| 226 | ||
| 227 | <div class="viewcode-block" id="ACE"><a class="viewcode-back" href="../../api/smb_security_descriptors.html#smb.security_descriptors.ACE">[docs]</a><span class="k">class</span> <span class="nc">ACE</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> | |
| 228 | <span class="sd">"""</span> | |
| 229 | <span class="sd"> Represents a single access control entry.</span> | |
| 230 | ||
| 231 | <span class="sd"> See [MS-DTYP]: 2.4.4</span> | |
| 232 | <span class="sd"> """</span> | |
| 233 | <span class="n">HEADER_FORMAT</span> <span class="o">=</span> <span class="s1">'<BBH'</span> | |
| 234 | ||
| 235 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">type_</span><span class="p">,</span> <span class="n">flags</span><span class="p">,</span> <span class="n">mask</span><span class="p">,</span> <span class="n">sid</span><span class="p">,</span> <span class="n">additional_data</span><span class="p">):</span> | |
| 236 | <span class="c1">#: An integer representing the type of the ACE. One of the</span> | |
| 237 | <span class="c1">#: ``ACE_TYPE_*`` constants. Corresponds to the ``AceType`` field</span> | |
| 238 | <span class="c1">#: from [MS-DTYP] 2.4.4.1.</span> | |
| 239 | <span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="o">=</span> <span class="n">type_</span> | |
| 240 | <span class="c1">#: An integer bitmask with ACE flags, corresponds to the</span> | |
| 241 | <span class="c1">#: ``AceFlags`` field.</span> | |
| 242 | <span class="bp">self</span><span class="o">.</span><span class="n">flags</span> <span class="o">=</span> <span class="n">flags</span> | |
| 243 | <span class="c1">#: An integer representing the ``ACCESS_MASK`` as specified in</span> | |
| 244 | <span class="c1">#: [MS-DTYP] 2.4.3.</span> | |
| 245 | <span class="bp">self</span><span class="o">.</span><span class="n">mask</span> <span class="o">=</span> <span class="n">mask</span> | |
| 246 | <span class="c1">#: The :class:`SID` of a trustee.</span> | |
| 247 | <span class="bp">self</span><span class="o">.</span><span class="n">sid</span> <span class="o">=</span> <span class="n">sid</span> | |
| 248 | <span class="c1">#: A dictionary of additional fields present in the ACE, depending</span> | |
| 249 | <span class="c1">#: on the type. The following fields can be present:</span> | |
| 250 | <span class="c1">#:</span> | |
| 251 | <span class="c1">#: * ``flags``</span> | |
| 252 | <span class="c1">#: * ``object_type``</span> | |
| 253 | <span class="c1">#: * ``inherited_object_type``</span> | |
| 254 | <span class="c1">#: * ``application_data``</span> | |
| 255 | <span class="c1">#: * ``attribute_data``</span> | |
| 256 | <span class="bp">self</span><span class="o">.</span><span class="n">additional_data</span> <span class="o">=</span> <span class="n">additional_data</span> | |
| 257 | ||
| 258 | <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 259 | <span class="k">return</span> <span class="s2">"ACE(type=</span><span class="si">%#04x</span><span class="s2">, flags=</span><span class="si">%#04x</span><span class="s2">, mask=</span><span class="si">%#010x</span><span class="s2">, sid=</span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span> | |
| 260 | <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">flags</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">mask</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">sid</span><span class="p">,</span> | |
| 261 | <span class="p">)</span> | |
| 262 | ||
| 263 | <span class="nd">@property</span> | |
| 264 | <span class="k">def</span> <span class="nf">isInheritOnly</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 265 | <span class="sd">"""Convenience property which indicates if this ACE is inherit</span> | |
| 266 | <span class="sd"> only, meaning that it doesn't apply to the object itself."""</span> | |
| 267 | <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">flags</span> <span class="o">&</span> <span class="n">ACE_FLAG_INHERIT_ONLY</span><span class="p">)</span> | |
| 268 | ||
| 269 | <span class="nd">@classmethod</span> | |
| 270 | <span class="k">def</span> <span class="nf">from_bytes</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span> | |
| 271 | <span class="n">header_size</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">calcsize</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">HEADER_FORMAT</span><span class="p">)</span> | |
| 272 | <span class="n">header</span> <span class="o">=</span> <span class="n">data</span><span class="p">[:</span><span class="n">header_size</span><span class="p">]</span> | |
| 273 | <span class="n">type_</span><span class="p">,</span> <span class="n">flags</span><span class="p">,</span> <span class="n">size</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">HEADER_FORMAT</span><span class="p">,</span> <span class="n">header</span><span class="p">)</span> | |
| 274 | ||
| 275 | <span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="o">>=</span> <span class="n">size</span> | |
| 276 | ||
| 277 | <span class="n">body</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="n">header_size</span><span class="p">:</span><span class="n">size</span><span class="p">]</span> | |
| 278 | <span class="n">additional_data</span> <span class="o">=</span> <span class="p">{}</span> | |
| 279 | ||
| 280 | <span class="c1"># In all ACE types, the mask immediately follows the header.</span> | |
| 281 | <span class="n">mask</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<I'</span><span class="p">,</span> <span class="n">body</span><span class="p">[:</span><span class="mi">4</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span> | |
| 282 | <span class="n">body</span> <span class="o">=</span> <span class="n">body</span><span class="p">[</span><span class="mi">4</span><span class="p">:]</span> | |
| 283 | ||
| 284 | <span class="c1"># All OBJECT-type ACEs contain additional flags, and two GUIDs as</span> | |
| 285 | <span class="c1"># the following fields.</span> | |
| 286 | <span class="k">if</span> <span class="n">type_</span> <span class="ow">in</span> <span class="p">(</span><span class="n">ACE_TYPE_ACCESS_ALLOWED_OBJECT</span><span class="p">,</span> | |
| 287 | <span class="n">ACE_TYPE_ACCESS_DENIED_OBJECT</span><span class="p">,</span> | |
| 288 | <span class="n">ACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT</span><span class="p">,</span> | |
| 289 | <span class="n">ACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT</span><span class="p">,</span> | |
| 290 | <span class="n">ACE_TYPE_SYSTEM_AUDIT_OBJECT</span><span class="p">,</span> | |
| 291 | <span class="n">ACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT</span><span class="p">):</span> | |
| 292 | <span class="n">additional_data</span><span class="p">[</span><span class="s1">'flags'</span><span class="p">]</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<I'</span><span class="p">,</span> <span class="n">body</span><span class="p">[:</span><span class="mi">4</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span> | |
| 293 | <span class="n">additional_data</span><span class="p">[</span><span class="s1">'object_type'</span><span class="p">]</span> <span class="o">=</span> <span class="n">body</span><span class="p">[</span><span class="mi">4</span><span class="p">:</span><span class="mi">20</span><span class="p">]</span> | |
| 294 | <span class="n">additional_data</span><span class="p">[</span><span class="s1">'inherited_object_type'</span><span class="p">]</span> <span class="o">=</span> <span class="n">body</span><span class="p">[</span><span class="mi">20</span><span class="p">:</span><span class="mi">36</span><span class="p">]</span> | |
| 295 | <span class="n">body</span> <span class="o">=</span> <span class="n">body</span><span class="p">[</span><span class="mi">36</span><span class="p">:]</span> | |
| 296 | ||
| 297 | <span class="c1"># Then the SID in all types.</span> | |
| 298 | <span class="n">sid</span><span class="p">,</span> <span class="n">body</span> <span class="o">=</span> <span class="n">SID</span><span class="o">.</span><span class="n">from_bytes</span><span class="p">(</span><span class="n">body</span><span class="p">,</span> <span class="n">return_tail</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> | |
| 299 | ||
| 300 | <span class="c1"># CALLBACK-type ACEs (and for some obscure reason,</span> | |
| 301 | <span class="c1"># SYSTEM_AUDIT_OBJECT) have a final tail of application data.</span> | |
| 302 | <span class="k">if</span> <span class="n">type_</span> <span class="ow">in</span> <span class="p">(</span><span class="n">ACE_TYPE_ACCESS_ALLOWED_CALLBACK</span><span class="p">,</span> | |
| 303 | <span class="n">ACE_TYPE_ACCESS_DENIED_CALLBACK</span><span class="p">,</span> | |
| 304 | <span class="n">ACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT</span><span class="p">,</span> | |
| 305 | <span class="n">ACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT</span><span class="p">,</span> | |
| 306 | <span class="n">ACE_TYPE_SYSTEM_AUDIT_OBJECT</span><span class="p">,</span> | |
| 307 | <span class="n">ACE_TYPE_SYSTEM_AUDIT_CALLBACK</span><span class="p">,</span> | |
| 308 | <span class="n">ACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT</span><span class="p">):</span> | |
| 309 | <span class="n">additional_data</span><span class="p">[</span><span class="s1">'application_data'</span><span class="p">]</span> <span class="o">=</span> <span class="n">body</span> | |
| 310 | ||
| 311 | <span class="c1"># SYSTEM_RESOURCE_ATTRIBUTE ACEs have a tail of attribute data.</span> | |
| 312 | <span class="k">if</span> <span class="n">type_</span> <span class="o">==</span> <span class="n">ACE_TYPE_SYSTEM_RESOURCE_ATTRIBUTE</span><span class="p">:</span> | |
| 313 | <span class="n">additional_data</span><span class="p">[</span><span class="s1">'attribute_data'</span><span class="p">]</span> <span class="o">=</span> <span class="n">body</span> | |
| 314 | ||
| 315 | <span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="n">type_</span><span class="p">,</span> <span class="n">flags</span><span class="p">,</span> <span class="n">mask</span><span class="p">,</span> <span class="n">sid</span><span class="p">,</span> <span class="n">additional_data</span><span class="p">)</span></div> | |
| 316 | ||
| 317 | ||
| 318 | <div class="viewcode-block" id="ACL"><a class="viewcode-back" href="../../api/smb_security_descriptors.html#smb.security_descriptors.ACL">[docs]</a><span class="k">class</span> <span class="nc">ACL</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> | |
| 319 | <span class="sd">"""</span> | |
| 320 | <span class="sd"> Access control list, encapsulating a sequence of access control</span> | |
| 321 | <span class="sd"> entries.</span> | |
| 322 | ||
| 323 | <span class="sd"> See [MS-DTYP]: 2.4.5</span> | |
| 324 | <span class="sd"> """</span> | |
| 325 | <span class="n">HEADER_FORMAT</span> <span class="o">=</span> <span class="s1">'<BBHHH'</span> | |
| 326 | ||
| 327 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">revision</span><span class="p">,</span> <span class="n">aces</span><span class="p">):</span> | |
| 328 | <span class="c1">#: Integer value of the revision.</span> | |
| 329 | <span class="bp">self</span><span class="o">.</span><span class="n">revision</span> <span class="o">=</span> <span class="n">revision</span> | |
| 330 | <span class="c1">#: List of :class:`ACE` instances.</span> | |
| 331 | <span class="bp">self</span><span class="o">.</span><span class="n">aces</span> <span class="o">=</span> <span class="n">aces</span> | |
| 332 | ||
| 333 | <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 334 | <span class="k">return</span> <span class="s2">"ACL(</span><span class="si">%r</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">aces</span><span class="p">,)</span> | |
| 335 | ||
| 336 | <span class="nd">@classmethod</span> | |
| 337 | <span class="k">def</span> <span class="nf">from_bytes</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span> | |
| 338 | <span class="n">revision</span> <span class="o">=</span> <span class="kc">None</span> | |
| 339 | <span class="n">aces</span> <span class="o">=</span> <span class="p">[]</span> | |
| 340 | ||
| 341 | <span class="n">header_size</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">calcsize</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">HEADER_FORMAT</span><span class="p">)</span> | |
| 342 | <span class="n">header</span><span class="p">,</span> <span class="n">remaining</span> <span class="o">=</span> <span class="n">data</span><span class="p">[:</span><span class="n">header_size</span><span class="p">],</span> <span class="n">data</span><span class="p">[</span><span class="n">header_size</span><span class="p">:]</span> | |
| 343 | <span class="n">revision</span><span class="p">,</span> <span class="n">sbz1</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">count</span><span class="p">,</span> <span class="n">sbz2</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">HEADER_FORMAT</span><span class="p">,</span> <span class="n">header</span><span class="p">)</span> | |
| 344 | ||
| 345 | <span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="o">>=</span> <span class="n">size</span> | |
| 346 | ||
| 347 | <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">count</span><span class="p">):</span> | |
| 348 | <span class="n">ace_size</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s1">'<H'</span><span class="p">,</span> <span class="n">remaining</span><span class="p">[</span><span class="mi">2</span><span class="p">:</span><span class="mi">4</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span> | |
| 349 | <span class="n">ace_data</span><span class="p">,</span> <span class="n">remaining</span> <span class="o">=</span> <span class="n">remaining</span><span class="p">[:</span><span class="n">ace_size</span><span class="p">],</span> <span class="n">remaining</span><span class="p">[</span><span class="n">ace_size</span><span class="p">:]</span> | |
| 350 | <span class="n">aces</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ACE</span><span class="o">.</span><span class="n">from_bytes</span><span class="p">(</span><span class="n">ace_data</span><span class="p">))</span> | |
| 351 | ||
| 352 | <span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="n">revision</span><span class="p">,</span> <span class="n">aces</span><span class="p">)</span></div> | |
| 353 | ||
| 354 | ||
| 355 | <div class="viewcode-block" id="SecurityDescriptor"><a class="viewcode-back" href="../../api/smb_security_descriptors.html#smb.security_descriptors.SecurityDescriptor">[docs]</a><span class="k">class</span> <span class="nc">SecurityDescriptor</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> | |
| 356 | <span class="sd">"""</span> | |
| 357 | <span class="sd"> Represents a security descriptor.</span> | |
| 358 | ||
| 359 | <span class="sd"> See [MS-DTYP]: 2.4.6</span> | |
| 360 | <span class="sd"> """</span> | |
| 361 | ||
| 362 | <span class="n">HEADER_FORMAT</span> <span class="o">=</span> <span class="s1">'<BBHIIII'</span> | |
| 363 | ||
| 364 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">flags</span><span class="p">,</span> <span class="n">owner</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">dacl</span><span class="p">,</span> <span class="n">sacl</span><span class="p">):</span> | |
| 365 | <span class="c1">#: Integer bitmask of control flags. Corresponds to the</span> | |
| 366 | <span class="c1">#: ``Control`` field in [MS-DTYP] 2.4.6.</span> | |
| 367 | <span class="bp">self</span><span class="o">.</span><span class="n">flags</span> <span class="o">=</span> <span class="n">flags</span> | |
| 368 | <span class="c1">#: Instance of :class:`SID` representing the owner user.</span> | |
| 369 | <span class="bp">self</span><span class="o">.</span><span class="n">owner</span> <span class="o">=</span> <span class="n">owner</span> | |
| 370 | <span class="c1">#: Instance of :class:`SID` representing the owner group.</span> | |
| 371 | <span class="bp">self</span><span class="o">.</span><span class="n">group</span> <span class="o">=</span> <span class="n">group</span> | |
| 372 | <span class="c1">#: Instance of :class:`ACL` representing the discretionary access</span> | |
| 373 | <span class="c1">#: control list, which specifies access restrictions of an object.</span> | |
| 374 | <span class="bp">self</span><span class="o">.</span><span class="n">dacl</span> <span class="o">=</span> <span class="n">dacl</span> | |
| 375 | <span class="c1">#: Instance of :class:`ACL` representing the system access control</span> | |
| 376 | <span class="c1">#: list, which specifies audit logging of an object.</span> | |
| 377 | <span class="bp">self</span><span class="o">.</span><span class="n">sacl</span> <span class="o">=</span> <span class="n">sacl</span> | |
| 378 | ||
| 379 | <span class="nd">@classmethod</span> | |
| 380 | <span class="k">def</span> <span class="nf">from_bytes</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span> | |
| 381 | <span class="n">owner</span> <span class="o">=</span> <span class="kc">None</span> | |
| 382 | <span class="n">group</span> <span class="o">=</span> <span class="kc">None</span> | |
| 383 | <span class="n">dacl</span> <span class="o">=</span> <span class="kc">None</span> | |
| 384 | <span class="n">sacl</span> <span class="o">=</span> <span class="kc">None</span> | |
| 385 | ||
| 386 | <span class="n">header</span> <span class="o">=</span> <span class="n">data</span><span class="p">[:</span><span class="n">struct</span><span class="o">.</span><span class="n">calcsize</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">HEADER_FORMAT</span><span class="p">)]</span> | |
| 387 | <span class="p">(</span><span class="n">revision</span><span class="p">,</span> <span class="n">sbz1</span><span class="p">,</span> <span class="n">flags</span><span class="p">,</span> <span class="n">owner_offset</span><span class="p">,</span> <span class="n">group_offset</span><span class="p">,</span> <span class="n">sacl_offset</span><span class="p">,</span> | |
| 388 | <span class="n">dacl_offset</span><span class="p">)</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">HEADER_FORMAT</span><span class="p">,</span> <span class="n">header</span><span class="p">)</span> | |
| 389 | ||
| 390 | <span class="k">assert</span> <span class="n">revision</span> <span class="o">==</span> <span class="mi">1</span> | |
| 391 | <span class="k">assert</span> <span class="n">flags</span> <span class="o">&</span> <span class="n">SECURITY_DESCRIPTOR_SELF_RELATIVE</span> | |
| 392 | <span class="k">for</span> <span class="n">offset</span> <span class="ow">in</span> <span class="p">(</span><span class="n">owner_offset</span><span class="p">,</span> <span class="n">group_offset</span><span class="p">,</span> <span class="n">sacl_offset</span><span class="p">,</span> <span class="n">dacl_offset</span><span class="p">):</span> | |
| 393 | <span class="k">assert</span> <span class="mi">0</span> <span class="o"><=</span> <span class="n">offset</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> | |
| 394 | ||
| 395 | <span class="k">if</span> <span class="n">owner_offset</span><span class="p">:</span> | |
| 396 | <span class="n">owner</span> <span class="o">=</span> <span class="n">SID</span><span class="o">.</span><span class="n">from_bytes</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="n">owner_offset</span><span class="p">:])</span> | |
| 397 | <span class="k">if</span> <span class="n">group_offset</span><span class="p">:</span> | |
| 398 | <span class="n">group</span> <span class="o">=</span> <span class="n">SID</span><span class="o">.</span><span class="n">from_bytes</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="n">group_offset</span><span class="p">:])</span> | |
| 399 | <span class="k">if</span> <span class="n">dacl_offset</span><span class="p">:</span> | |
| 400 | <span class="n">dacl</span> <span class="o">=</span> <span class="n">ACL</span><span class="o">.</span><span class="n">from_bytes</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="n">dacl_offset</span><span class="p">:])</span> | |
| 401 | <span class="k">if</span> <span class="n">sacl_offset</span><span class="p">:</span> | |
| 402 | <span class="n">sacl</span> <span class="o">=</span> <span class="n">ACL</span><span class="o">.</span><span class="n">from_bytes</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="n">sacl_offset</span><span class="p">:])</span> | |
| 403 | ||
| 404 | <span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="n">flags</span><span class="p">,</span> <span class="n">owner</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">dacl</span><span class="p">,</span> <span class="n">sacl</span><span class="p">)</span></div> | |
| 405 | </pre></div> | |
| 406 | ||
| 407 | <div class="clearer"></div> | |
| 408 | </div> | |
| 409 | </div> | |
| 410 | </div> | |
| 411 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 412 | <div class="sphinxsidebarwrapper"> | |
| 413 | <div id="searchbox" style="display: none" role="search"> | |
| 414 | <h3 id="searchlabel">Quick search</h3> | |
| 415 | <div class="searchformwrapper"> | |
| 416 | <form class="search" action="../../search.html" method="get"> | |
| 417 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 418 | <input type="submit" value="Go" /> | |
| 419 | </form> | |
| 420 | </div> | |
| 421 | </div> | |
| 422 | <script>$('#searchbox').show(0);</script> | |
| 423 | </div> | |
| 424 | </div> | |
| 425 | <div class="clearer"></div> | |
| 426 | </div> | |
| 427 | <div class="related" role="navigation" aria-label="related navigation"> | |
| 428 | <h3>Navigation</h3> | |
| 429 | <ul> | |
| 430 | <li class="right" style="margin-right: 10px"> | |
| 431 | <a href="../../genindex.html" title="General Index" | |
| 432 | >index</a></li> | |
| 433 | <li class="right" > | |
| 434 | <a href="../../py-modindex.html" title="Python Module Index" | |
| 435 | >modules</a> |</li> | |
| 436 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 437 | <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> | |
| 438 | <li class="nav-item nav-item-this"><a href="">smb.security_descriptors</a></li> | |
| 439 | </ul> | |
| 440 | </div> | |
| 441 | <div class="footer" role="contentinfo"> | |
| 442 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 443 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 444 | </div> | |
| 445 | </body> | |
| 446 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | ||
| 3 | ||
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 0 | ||
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>smb.smb_structs — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>smb.smb_structs — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../../index.html" /> | |
| 26 | <link rel="up" title="Module code" href="../index.html" /> | |
| 27 | </head> | |
| 28 | <body role="document"> | |
| 10 | <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> | |
| 11 | <script src="../../_static/jquery.js"></script> | |
| 12 | <script src="../../_static/underscore.js"></script> | |
| 13 | <script src="../../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../../search.html" /> | |
| 16 | </head><body> | |
| 29 | 17 | <div class="related" role="navigation" aria-label="related navigation"> |
| 30 | 18 | <h3>Navigation</h3> |
| 31 | 19 | <ul> |
| 32 | 20 | <li class="right" style="margin-right: 10px"> |
| 33 | 21 | <a href="../../genindex.html" title="General Index" |
| 34 | 22 | accesskey="I">index</a></li> |
| 35 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 36 | <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> | |
| 23 | <li class="right" > | |
| 24 | <a href="../../py-modindex.html" title="Python Module Index" | |
| 25 | >modules</a> |</li> | |
| 26 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 27 | <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> | |
| 28 | <li class="nav-item nav-item-this"><a href="">smb.smb_structs</a></li> | |
| 37 | 29 | </ul> |
| 38 | </div> | |
| 39 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 40 | <div class="sphinxsidebarwrapper"> | |
| 41 | <div id="searchbox" style="display: none" role="search"> | |
| 42 | <h3>Quick search</h3> | |
| 43 | <form class="search" action="../../search.html" method="get"> | |
| 44 | <input type="text" name="q" /> | |
| 45 | <input type="submit" value="Go" /> | |
| 46 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 47 | <input type="hidden" name="area" value="default" /> | |
| 48 | </form> | |
| 49 | <p class="searchtip" style="font-size: 90%"> | |
| 50 | Enter search terms or a module, class or function name. | |
| 51 | </p> | |
| 52 | </div> | |
| 53 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 54 | </div> | |
| 55 | </div> | |
| 30 | </div> | |
| 56 | 31 | |
| 57 | 32 | <div class="document"> |
| 58 | 33 | <div class="documentwrapper"> |
| 60 | 35 | <div class="body" role="main"> |
| 61 | 36 | |
| 62 | 37 | <h1>Source code for smb.smb_structs</h1><div class="highlight"><pre> |
| 63 | ||
| 38 | <span></span> | |
| 64 | 39 | <span class="kn">import</span> <span class="nn">os</span><span class="o">,</span> <span class="nn">sys</span><span class="o">,</span> <span class="nn">struct</span><span class="o">,</span> <span class="nn">types</span><span class="o">,</span> <span class="nn">logging</span><span class="o">,</span> <span class="nn">binascii</span><span class="o">,</span> <span class="nn">time</span> |
| 65 | <span class="kn">from</span> <span class="nn">StringIO</span> <span class="kn">import</span> <span class="n">StringIO</span> | |
| 66 | <span class="kn">from</span> <span class="nn">smb_constants</span> <span class="kn">import</span> <span class="o">*</span> | |
| 40 | <span class="kn">from</span> <span class="nn">io</span> <span class="kn">import</span> <span class="n">StringIO</span> | |
| 41 | <span class="kn">from</span> <span class="nn">.smb_constants</span> <span class="kn">import</span> <span class="o">*</span> | |
| 67 | 42 | |
| 68 | 43 | |
| 69 | 44 | <span class="c1"># Set to True if you want to enable support for extended security. Required for Windows Vista and later</span> |
| 70 | <span class="n">SUPPORT_EXTENDED_SECURITY</span> <span class="o">=</span> <span class="bp">True</span> | |
| 45 | <span class="n">SUPPORT_EXTENDED_SECURITY</span> <span class="o">=</span> <span class="kc">True</span> | |
| 71 | 46 | |
| 72 | 47 | <span class="c1"># Set to True if you want to enable SMB2 protocol.</span> |
| 73 | <span class="n">SUPPORT_SMB2</span> <span class="o">=</span> <span class="bp">True</span> | |
| 48 | <span class="n">SUPPORT_SMB2</span> <span class="o">=</span> <span class="kc">True</span> | |
| 74 | 49 | |
| 75 | 50 | <span class="c1"># Supported dialects</span> |
| 76 | 51 | <span class="n">DIALECTS</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 77 | <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="p">(</span> <span class="n">name</span><span class="p">,</span> <span class="n">dialect</span> <span class="p">)</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">([</span> <span class="p">(</span> <span class="s1">'NT_LAN_MANAGER_DIALECT'</span><span class="p">,</span> <span class="s1">'NT LM 0.12'</span> <span class="p">),</span> <span class="p">]):</span> | |
| 52 | <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="p">(</span> <span class="n">name</span><span class="p">,</span> <span class="n">dialect</span> <span class="p">)</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">([</span> <span class="p">(</span> <span class="s1">'NT_LAN_MANAGER_DIALECT'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">'NT LM 0.12'</span> <span class="p">),</span> <span class="p">]):</span> | |
| 78 | 53 | <span class="n">DIALECTS</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dialect</span><span class="p">)</span> |
| 79 | 54 | <span class="nb">globals</span><span class="p">()[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">i</span> |
| 80 | 55 | |
| 81 | 56 | <span class="n">DIALECTS2</span> <span class="o">=</span> <span class="p">[</span> <span class="p">]</span> |
| 82 | <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="p">(</span> <span class="n">name</span><span class="p">,</span> <span class="n">dialect</span> <span class="p">)</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">([</span> <span class="p">(</span> <span class="s1">'SMB2_DIALECT'</span><span class="p">,</span> <span class="s1">'SMB 2.002'</span> <span class="p">)</span> <span class="p">]):</span> | |
| 57 | <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="p">(</span> <span class="n">name</span><span class="p">,</span> <span class="n">dialect</span> <span class="p">)</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">([</span> <span class="p">(</span> <span class="s1">'SMB2_DIALECT'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">'SMB 2.002'</span> <span class="p">)</span> <span class="p">]):</span> | |
| 83 | 58 | <span class="n">DIALECTS2</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dialect</span><span class="p">)</span> |
| 84 | 59 | <span class="nb">globals</span><span class="p">()[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">i</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">DIALECTS</span><span class="p">)</span> |
| 85 | 60 | |
| 94 | 69 | |
| 95 | 70 | <div class="viewcode-block" id="ProtocolError"><a class="viewcode-back" href="../../api/smb_exceptions.html#smb.smb_structs.ProtocolError">[docs]</a><span class="k">class</span> <span class="nc">ProtocolError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span> |
| 96 | 71 | |
| 97 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">data_buf</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">smb_message</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span> | |
| 72 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">data_buf</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">smb_message</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span> | |
| 98 | 73 | <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span> |
| 99 | 74 | <span class="bp">self</span><span class="o">.</span><span class="n">data_buf</span> <span class="o">=</span> <span class="n">data_buf</span> |
| 100 | 75 | <span class="bp">self</span><span class="o">.</span><span class="n">smb_message</span> <span class="o">=</span> <span class="n">smb_message</span> |
| 101 | 76 | |
| 102 | <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 77 | <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 103 | 78 | <span class="n">b</span> <span class="o">=</span> <span class="n">StringIO</span><span class="p">()</span> |
| 104 | 79 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span><span class="p">)</span> |
| 105 | 80 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">smb_message</span><span class="p">:</span> |
| 108 | 83 | |
| 109 | 84 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_buf</span><span class="p">:</span> |
| 110 | 85 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'='</span> <span class="o">*</span> <span class="mi">20</span> <span class="o">+</span> <span class="s1">' SMB Data Packet (hex) '</span> <span class="o">+</span> <span class="s1">'='</span> <span class="o">*</span> <span class="mi">20</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span><span class="p">)</span> |
| 111 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data_buf</span><span class="p">))</span> | |
| 86 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data_buf</span><span class="p">)))</span> | |
| 112 | 87 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">linesep</span><span class="p">)</span> |
| 113 | 88 | |
| 114 | 89 | <span class="k">return</span> <span class="n">b</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span></div> |
| 115 | 90 | |
| 116 | 91 | <span class="k">class</span> <span class="nc">SMB2ProtocolHeaderError</span><span class="p">(</span><span class="n">ProtocolError</span><span class="p">):</span> |
| 117 | 92 | |
| 118 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 119 | <span class="n">ProtocolError</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"Packet header belongs to SMB2"</span><span class="p">)</span> | |
| 93 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 94 | <span class="n">ProtocolError</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"Packet header belongs to SMB2"</span><span class="p">)</span> | |
| 120 | 95 | |
| 121 | 96 | <div class="viewcode-block" id="OperationFailure"><a class="viewcode-back" href="../../api/smb_exceptions.html#smb.smb_structs.OperationFailure">[docs]</a><span class="k">class</span> <span class="nc">OperationFailure</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span> |
| 122 | 97 | |
| 123 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">smb_messages</span><span class="p">):</span> | |
| 124 | <span class="bp">self</span><span class="o">.</span><span class="n">args</span> <span class="o">=</span> <span class="p">[</span> <span class="n">message</span> <span class="p">]</span> | |
| 98 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">smb_messages</span><span class="p">):</span> | |
| 125 | 99 | <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span> |
| 126 | 100 | <span class="bp">self</span><span class="o">.</span><span class="n">smb_messages</span> <span class="o">=</span> <span class="n">smb_messages</span> |
| 127 | 101 | |
| 128 | <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 102 | <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 129 | 103 | <span class="n">b</span> <span class="o">=</span> <span class="n">StringIO</span><span class="p">()</span> |
| 130 | 104 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span><span class="p">)</span> |
| 131 | 105 | |
| 136 | 110 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">m</span><span class="p">))</span> |
| 137 | 111 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'SMB Data Packet (hex):'</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span><span class="p">)</span> |
| 138 | 112 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'----------------------'</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span><span class="p">)</span> |
| 139 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">raw_data</span><span class="p">))</span> | |
| 113 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">raw_data</span><span class="p">)))</span> | |
| 140 | 114 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">linesep</span><span class="p">)</span> |
| 141 | 115 | |
| 142 | 116 | <span class="k">return</span> <span class="n">b</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span></div> |
| 144 | 118 | |
| 145 | 119 | <span class="k">class</span> <span class="nc">SMBError</span><span class="p">:</span> |
| 146 | 120 | |
| 147 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 121 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 148 | 122 | <span class="bp">self</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span> |
| 149 | 123 | |
| 150 | 124 | <span class="k">def</span> <span class="nf">reset</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| 151 | <span class="bp">self</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">=</span> <span class="il">0L</span> | |
| 152 | <span class="bp">self</span><span class="o">.</span><span class="n">is_ntstatus</span> <span class="o">=</span> <span class="bp">True</span> | |
| 153 | ||
| 154 | <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 125 | <span class="bp">self</span><span class="o">.</span><span class="n">internal_value</span> <span class="o">=</span> <span class="mi">0</span> | |
| 126 | <span class="bp">self</span><span class="o">.</span><span class="n">is_ntstatus</span> <span class="o">=</span> <span class="kc">True</span> | |
| 127 | ||
| 128 | <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 155 | 129 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_ntstatus</span><span class="p">:</span> |
| 156 | 130 | <span class="k">return</span> <span class="s1">'NTSTATUS=0x</span><span class="si">%08X</span><span class="s1">'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">internal_value</span> |
| 157 | 131 | <span class="k">else</span><span class="p">:</span> |
| 170 | 144 | <span class="n">log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s1">'SMB.SMBMessage'</span><span class="p">)</span> |
| 171 | 145 | <span class="n">protocol</span> <span class="o">=</span> <span class="mi">1</span> |
| 172 | 146 | |
| 173 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">payload</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span> | |
| 147 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">payload</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span> | |
| 174 | 148 | <span class="bp">self</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span> |
| 175 | 149 | <span class="k">if</span> <span class="n">payload</span><span class="p">:</span> |
| 176 | 150 | <span class="bp">self</span><span class="o">.</span><span class="n">payload</span> <span class="o">=</span> <span class="n">payload</span> |
| 177 | 151 | <span class="bp">self</span><span class="o">.</span><span class="n">payload</span><span class="o">.</span><span class="n">initMessage</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> |
| 178 | 152 | |
| 179 | <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 153 | <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 180 | 154 | <span class="n">b</span> <span class="o">=</span> <span class="n">StringIO</span><span class="p">()</span> |
| 181 | 155 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'Command: 0x</span><span class="si">%02X</span><span class="s1"> (</span><span class="si">%s</span><span class="s1">) </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">,</span> <span class="n">SMB_COMMAND_NAMES</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">,</span> <span class="s1">'<unknown>'</span><span class="p">),</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span> <span class="p">))</span> |
| 182 | 156 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'Status: </span><span class="si">%s</span><span class="s1"> </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">status</span><span class="p">),</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span> <span class="p">))</span> |
| 187 | 161 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'MID: </span><span class="si">%d</span><span class="s1"> </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span> <span class="p">))</span> |
| 188 | 162 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'TID: </span><span class="si">%d</span><span class="s1"> </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span> <span class="p">))</span> |
| 189 | 163 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'Security: 0x</span><span class="si">%016X</span><span class="s1"> </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">security</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span> <span class="p">))</span> |
| 190 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'Parameters: </span><span class="si">%d</span><span class="s1"> bytes </span><span class="si">%s%s</span><span class="s1"> </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parameters_data</span><span class="p">),</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span><span class="p">,</span> <span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parameters_data</span><span class="p">),</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span> <span class="p">))</span> | |
| 191 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'Data: </span><span class="si">%d</span><span class="s1"> bytes </span><span class="si">%s%s</span><span class="s1"> </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">),</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span><span class="p">,</span> <span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">),</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span> <span class="p">))</span> | |
| 164 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'Parameters: </span><span class="si">%d</span><span class="s1"> bytes </span><span class="si">%s%s</span><span class="s1"> </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parameters_data</span><span class="p">),</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parameters_data</span><span class="p">)),</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span> <span class="p">))</span> | |
| 165 | <span class="n">b</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'Data: </span><span class="si">%d</span><span class="s1"> bytes </span><span class="si">%s%s</span><span class="s1"> </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">),</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">)),</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span> <span class="p">))</span> | |
| 192 | 166 | <span class="k">return</span> <span class="n">b</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span> |
| 193 | 167 | |
| 194 | 168 | <span class="k">def</span> <span class="nf">reset</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| 195 | <span class="bp">self</span><span class="o">.</span><span class="n">raw_data</span> <span class="o">=</span> <span class="s1">''</span> | |
| 169 | <span class="bp">self</span><span class="o">.</span><span class="n">raw_data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 196 | 170 | <span class="bp">self</span><span class="o">.</span><span class="n">command</span> <span class="o">=</span> <span class="mi">0</span> |
| 197 | 171 | <span class="bp">self</span><span class="o">.</span><span class="n">status</span> <span class="o">=</span> <span class="n">SMBError</span><span class="p">()</span> |
| 198 | 172 | <span class="bp">self</span><span class="o">.</span><span class="n">flags</span> <span class="o">=</span> <span class="mi">0</span> |
| 201 | 175 | <span class="bp">self</span><span class="o">.</span><span class="n">tid</span> <span class="o">=</span> <span class="mi">0</span> |
| 202 | 176 | <span class="bp">self</span><span class="o">.</span><span class="n">uid</span> <span class="o">=</span> <span class="mi">0</span> |
| 203 | 177 | <span class="bp">self</span><span class="o">.</span><span class="n">mid</span> <span class="o">=</span> <span class="mi">0</span> |
| 204 | <span class="bp">self</span><span class="o">.</span><span class="n">security</span> <span class="o">=</span> <span class="il">0L</span> | |
| 205 | <span class="bp">self</span><span class="o">.</span><span class="n">parameters_data</span> <span class="o">=</span> <span class="s1">''</span> | |
| 206 | <span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="s1">''</span> | |
| 207 | <span class="bp">self</span><span class="o">.</span><span class="n">payload</span> <span class="o">=</span> <span class="bp">None</span> | |
| 178 | <span class="bp">self</span><span class="o">.</span><span class="n">security</span> <span class="o">=</span> <span class="mi">0</span> | |
| 179 | <span class="bp">self</span><span class="o">.</span><span class="n">parameters_data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 180 | <span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 181 | <span class="bp">self</span><span class="o">.</span><span class="n">payload</span> <span class="o">=</span> <span class="kc">None</span> | |
| 182 | ||
| 183 | <span class="nd">@property</span> | |
| 184 | <span class="k">def</span> <span class="nf">isAsync</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 185 | <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">flags</span> <span class="o">&</span> <span class="n">SMB2_FLAGS_ASYNC_COMMAND</span><span class="p">)</span> | |
| 208 | 186 | |
| 209 | 187 | <span class="nd">@property</span> |
| 210 | 188 | <span class="k">def</span> <span class="nf">isReply</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| 230 | 208 | <span class="k">assert</span> <span class="n">parameters_len</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">==</span> <span class="mi">0</span> |
| 231 | 209 | |
| 232 | 210 | <span class="n">headers_data</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">HEADER_STRUCT_FORMAT</span><span class="p">,</span> |
| 233 | <span class="s1">'</span><span class="se">\xFF</span><span class="s1">SMB'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">flags</span><span class="p">,</span> | |
| 211 | <span class="sa">b</span><span class="s1">'</span><span class="se">\xFF</span><span class="s1">SMB'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">internal_value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">flags</span><span class="p">,</span> | |
| 234 | 212 | <span class="bp">self</span><span class="o">.</span><span class="n">flags2</span><span class="p">,</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pid</span> <span class="o">>></span> <span class="mi">16</span><span class="p">)</span> <span class="o">&</span> <span class="mh">0xFFFF</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">security</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> |
| 235 | 213 | <span class="bp">self</span><span class="o">.</span><span class="n">pid</span> <span class="o">&</span> <span class="mh">0xFFFF</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">uid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">parameters_len</span> <span class="o">/</span> <span class="mi">2</span><span class="p">))</span> |
| 236 | 214 | <span class="k">return</span> <span class="n">headers_data</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">parameters_data</span> <span class="o">+</span> <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<H'</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">))</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span> |
| 258 | 236 | <span class="bp">self</span><span class="o">.</span><span class="n">flags2</span><span class="p">,</span> <span class="n">pid_high</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">security</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">tid</span><span class="p">,</span> \ |
| 259 | 237 | <span class="n">pid_low</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">uid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">mid</span><span class="p">,</span> <span class="n">params_count</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">HEADER_STRUCT_FORMAT</span><span class="p">,</span> <span class="n">buf</span><span class="p">[:</span><span class="bp">self</span><span class="o">.</span><span class="n">HEADER_STRUCT_SIZE</span><span class="p">])</span> |
| 260 | 238 | |
| 261 | <span class="k">if</span> <span class="n">protocol</span> <span class="o">==</span> <span class="s1">'</span><span class="se">\xFE</span><span class="s1">SMB'</span><span class="p">:</span> | |
| 239 | <span class="k">if</span> <span class="n">protocol</span> <span class="o">==</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\xFE</span><span class="s1">SMB'</span><span class="p">:</span> | |
| 262 | 240 | <span class="k">raise</span> <span class="n">SMB2ProtocolHeaderError</span><span class="p">()</span> |
| 263 | <span class="k">if</span> <span class="n">protocol</span> <span class="o">!=</span> <span class="s1">'</span><span class="se">\xFF</span><span class="s1">SMB'</span><span class="p">:</span> | |
| 241 | <span class="k">if</span> <span class="n">protocol</span> <span class="o">!=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\xFF</span><span class="s1">SMB'</span><span class="p">:</span> | |
| 264 | 242 | <span class="k">raise</span> <span class="n">ProtocolError</span><span class="p">(</span><span class="s1">'Invalid 4-byte protocol field'</span><span class="p">,</span> <span class="n">buf</span><span class="p">)</span> |
| 265 | 243 | |
| 266 | 244 | <span class="bp">self</span><span class="o">.</span><span class="n">pid</span> <span class="o">=</span> <span class="p">(</span><span class="n">pid_high</span> <span class="o"><<</span> <span class="mi">16</span><span class="p">)</span> <span class="o">|</span> <span class="n">pid_low</span> |
| 316 | 294 | |
| 317 | 295 | <span class="k">class</span> <span class="nc">Payload</span><span class="p">:</span> |
| 318 | 296 | |
| 319 | <span class="n">DEFAULT_ANDX_PARAM_HEADER</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\xFF\x00\x00\x00</span><span class="s1">'</span> | |
| 297 | <span class="n">DEFAULT_ANDX_PARAM_HEADER</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\xFF\x00\x00\x00</span><span class="s1">'</span> | |
| 320 | 298 | <span class="n">DEFAULT_ANDX_PARAM_SIZE</span> <span class="o">=</span> <span class="mi">4</span> |
| 321 | 299 | |
| 322 | 300 | <span class="k">def</span> <span class="nf">initMessage</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> |
| 325 | 303 | <span class="c1"># support SMB_FLAGS2_UNICODE by default.</span> |
| 326 | 304 | <span class="k">assert</span> <span class="n">message</span><span class="o">.</span><span class="n">payload</span> <span class="o">==</span> <span class="bp">self</span> |
| 327 | 305 | <span class="n">message</span><span class="o">.</span><span class="n">flags</span> <span class="o">=</span> <span class="n">SMB_FLAGS_CASE_INSENSITIVE</span> <span class="o">|</span> <span class="n">SMB_FLAGS_CANONICALIZED_PATHS</span> |
| 328 | <span class="n">message</span><span class="o">.</span><span class="n">flags2</span> <span class="o">=</span> <span class="n">SMB_FLAGS2_UNICODE</span> <span class="o">|</span> <span class="n">SMB_FLAGS2_NT_STATUS</span> <span class="o">|</span> <span class="n">SMB_FLAGS2_LONG_NAMES</span> <span class="o">|</span> <span class="n">SMB_FLAGS2_EAS</span> | |
| 306 | <span class="n">message</span><span class="o">.</span><span class="n">flags2</span> <span class="o">=</span> <span class="n">SMB_FLAGS2_UNICODE</span> <span class="o">|</span> <span class="n">SMB_FLAGS2_NT_STATUS</span> <span class="o">|</span> <span class="n">SMB_FLAGS2_IS_LONG_NAME</span> <span class="o">|</span> <span class="n">SMB_FLAGS2_LONG_NAMES</span> | |
| 329 | 307 | |
| 330 | 308 | <span class="k">if</span> <span class="n">SUPPORT_EXTENDED_SECURITY</span><span class="p">:</span> |
| 331 | <span class="n">message</span><span class="o">.</span><span class="n">flags2</span> <span class="o">|=</span> <span class="n">SMB_FLAGS2_EXTENDED_SECURITY</span> <span class="o">|</span> <span class="n">SMB_FLAGS2_SMB_SECURITY_SIGNATURE</span> | |
| 309 | <span class="n">message</span><span class="o">.</span><span class="n">flags2</span> <span class="o">|=</span> <span class="n">SMB_FLAGS2_EXTENDED_SECURITY</span> | |
| 332 | 310 | |
| 333 | 311 | <span class="k">def</span> <span class="nf">prepare</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> |
| 334 | 312 | <span class="k">raise</span> <span class="ne">NotImplementedError</span> |
| 351 | 329 | |
| 352 | 330 | <span class="k">def</span> <span class="nf">prepare</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> |
| 353 | 331 | <span class="k">assert</span> <span class="n">message</span><span class="o">.</span><span class="n">payload</span> <span class="o">==</span> <span class="bp">self</span> |
| 354 | <span class="n">message</span><span class="o">.</span><span class="n">parameters_data</span> <span class="o">=</span> <span class="s1">''</span> | |
| 332 | <span class="n">message</span><span class="o">.</span><span class="n">parameters_data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 355 | 333 | <span class="k">if</span> <span class="n">SUPPORT_SMB2</span><span class="p">:</span> |
| 356 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="s1">'</span><span class="se">\x02</span><span class="s1">'</span><span class="o">+</span><span class="n">s</span><span class="o">+</span><span class="s1">'</span><span class="se">\x00</span><span class="s1">'</span><span class="p">,</span> <span class="n">DIALECTS</span> <span class="o">+</span> <span class="n">DIALECTS2</span><span class="p">))</span> | |
| 334 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="sa">b</span><span class="s1">'</span><span class="se">\x02</span><span class="s1">'</span><span class="o">+</span><span class="n">s</span><span class="o">+</span><span class="sa">b</span><span class="s1">'</span><span class="se">\x00</span><span class="s1">'</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">DIALECTS</span> <span class="o">+</span> <span class="n">DIALECTS2</span><span class="p">])</span> | |
| 357 | 335 | <span class="k">else</span><span class="p">:</span> |
| 358 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="s1">'</span><span class="se">\x02</span><span class="s1">'</span><span class="o">+</span><span class="n">s</span><span class="o">+</span><span class="s1">'</span><span class="se">\x00</span><span class="s1">'</span><span class="p">,</span> <span class="n">DIALECTS</span><span class="p">))</span> | |
| 336 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="sa">b</span><span class="s1">'</span><span class="se">\x02</span><span class="s1">'</span><span class="o">+</span><span class="n">s</span><span class="o">+</span><span class="sa">b</span><span class="s1">'</span><span class="se">\x00</span><span class="s1">'</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">DIALECTS</span><span class="p">])</span> | |
| 359 | 337 | |
| 360 | 338 | |
| 361 | 339 | <span class="k">class</span> <span class="nc">ComNegotiateResponse</span><span class="p">(</span><span class="n">Payload</span><span class="p">):</span> |
| 429 | 407 | <span class="k">if</span> <span class="n">data_len</span> <span class="o">>=</span> <span class="bp">self</span><span class="o">.</span><span class="n">challenge_length</span><span class="p">:</span> |
| 430 | 408 | <span class="bp">self</span><span class="o">.</span><span class="n">challenge</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span><span class="p">[:</span><span class="bp">self</span><span class="o">.</span><span class="n">challenge_length</span><span class="p">]</span> |
| 431 | 409 | |
| 432 | <span class="n">s</span> <span class="o">=</span> <span class="s1">''</span> | |
| 410 | <span class="n">s</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 433 | 411 | <span class="n">offset</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">challenge_length</span> |
| 434 | 412 | <span class="k">while</span> <span class="n">offset</span> <span class="o"><</span> <span class="n">data_len</span><span class="p">:</span> |
| 435 | 413 | <span class="n">_s</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="n">offset</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="mi">2</span><span class="p">]</span> |
| 436 | <span class="k">if</span> <span class="n">_s</span> <span class="o">==</span> <span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span><span class="p">:</span> | |
| 414 | <span class="k">if</span> <span class="n">_s</span> <span class="o">==</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span><span class="p">:</span> | |
| 437 | 415 | <span class="bp">self</span><span class="o">.</span><span class="n">domain</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> |
| 438 | 416 | <span class="k">break</span> |
| 439 | 417 | <span class="k">else</span><span class="p">:</span> |
| 462 | 440 | |
| 463 | 441 | <span class="n">PAYLOAD_STRUCT_FORMAT</span> <span class="o">=</span> <span class="s1">'<HHHIHII'</span> |
| 464 | 442 | |
| 465 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">session_key</span><span class="p">,</span> <span class="n">security_blob</span><span class="p">):</span> | |
| 443 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">session_key</span><span class="p">,</span> <span class="n">security_blob</span><span class="p">):</span> | |
| 466 | 444 | <span class="bp">self</span><span class="o">.</span><span class="n">session_key</span> <span class="o">=</span> <span class="n">session_key</span> |
| 467 | 445 | <span class="bp">self</span><span class="o">.</span><span class="n">security_blob</span> <span class="o">=</span> <span class="n">security_blob</span> |
| 468 | 446 | |
| 484 | 462 | |
| 485 | 463 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">security_blob</span> |
| 486 | 464 | <span class="k">if</span> <span class="p">(</span><span class="n">SMBMessage</span><span class="o">.</span><span class="n">HEADER_STRUCT_SIZE</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">parameters_data</span><span class="p">)</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">data</span><span class="p">))</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 487 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 488 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> <span class="o">*</span> <span class="mi">4</span> | |
| 465 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 466 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> <span class="o">*</span> <span class="mi">4</span> | |
| 489 | 467 | |
| 490 | 468 | |
| 491 | 469 | <span class="k">class</span> <span class="nc">ComSessionSetupAndxRequest__NoSecurityExtension</span><span class="p">(</span><span class="n">Payload</span><span class="p">):</span> |
| 497 | 475 | |
| 498 | 476 | <span class="n">PAYLOAD_STRUCT_FORMAT</span> <span class="o">=</span> <span class="s1">'<HHHIHHII'</span> |
| 499 | 477 | |
| 500 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">session_key</span><span class="p">,</span> <span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">is_unicode</span><span class="p">,</span> <span class="n">domain</span><span class="p">):</span> | |
| 478 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">session_key</span><span class="p">,</span> <span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">is_unicode</span><span class="p">,</span> <span class="n">domain</span><span class="p">):</span> | |
| 501 | 479 | <span class="bp">self</span><span class="o">.</span><span class="n">username</span> <span class="o">=</span> <span class="n">username</span> |
| 502 | 480 | <span class="bp">self</span><span class="o">.</span><span class="n">session_key</span> <span class="o">=</span> <span class="n">session_key</span> |
| 503 | 481 | <span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="n">password</span> |
| 528 | 506 | |
| 529 | 507 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">password</span> |
| 530 | 508 | <span class="k">if</span> <span class="p">(</span><span class="n">est_offset</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">data</span><span class="p">))</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">!=</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">message</span><span class="o">.</span><span class="n">flags2</span> <span class="o">&</span> <span class="n">SMB_FLAGS2_UNICODE</span><span class="p">:</span> |
| 531 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 509 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 532 | 510 | |
| 533 | 511 | <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">flags2</span> <span class="o">&</span> <span class="n">SMB_FLAGS2_UNICODE</span><span class="p">:</span> |
| 534 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 512 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 535 | 513 | <span class="k">else</span><span class="p">:</span> |
| 536 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 514 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-8'</span><span class="p">)</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 537 | 515 | |
| 538 | 516 | <span class="k">if</span> <span class="p">(</span><span class="n">est_offset</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">data</span><span class="p">))</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">!=</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">message</span><span class="o">.</span><span class="n">flags2</span> <span class="o">&</span> <span class="n">SMB_FLAGS2_UNICODE</span><span class="p">:</span> |
| 539 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 517 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 540 | 518 | |
| 541 | 519 | <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">flags2</span> <span class="o">&</span> <span class="n">SMB_FLAGS2_UNICODE</span><span class="p">:</span> |
| 542 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> <span class="o">+</span> <span class="s1">'pysmb'</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 520 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> <span class="o">+</span> <span class="s1">'pysmb'</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 543 | 521 | <span class="k">else</span><span class="p">:</span> |
| 544 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">domain</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">pysmb</span><span class="se">\0</span><span class="s1">'</span> | |
| 522 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-8'</span><span class="p">)</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">pysmb</span><span class="se">\0</span><span class="s1">'</span> | |
| 545 | 523 | |
| 546 | 524 | |
| 547 | 525 | <span class="k">class</span> <span class="nc">ComSessionSetupAndxResponse</span><span class="p">(</span><span class="n">Payload</span><span class="p">):</span> |
| 604 | 582 | <span class="n">PAYLOAD_STRUCT_FORMAT</span> <span class="o">=</span> <span class="s1">'<HH'</span> |
| 605 | 583 | <span class="n">PAYLOAD_STRUCT_SIZE</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">calcsize</span><span class="p">(</span><span class="n">PAYLOAD_STRUCT_FORMAT</span><span class="p">)</span> |
| 606 | 584 | |
| 607 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">service</span><span class="p">,</span> <span class="n">password</span> <span class="o">=</span> <span class="s1">''</span><span class="p">):</span> | |
| 585 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">service</span><span class="p">,</span> <span class="n">password</span> <span class="o">=</span> <span class="s1">''</span><span class="p">):</span> | |
| 608 | 586 | <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="n">path</span> |
| 609 | 587 | <span class="bp">self</span><span class="o">.</span><span class="n">service</span> <span class="o">=</span> <span class="n">service</span> |
| 610 | 588 | <span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="n">password</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> |
| 620 | 598 | <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">PAYLOAD_STRUCT_FORMAT</span><span class="p">,</span> |
| 621 | 599 | <span class="mh">0x08</span> <span class="o">|</span> \ |
| 622 | 600 | <span class="p">((</span><span class="n">message</span><span class="o">.</span><span class="n">hasExtendedSecurity</span> <span class="ow">and</span> <span class="mh">0x0004</span><span class="p">)</span> <span class="ow">or</span> <span class="mh">0x00</span><span class="p">)</span> <span class="o">|</span> \ |
| 623 | <span class="p">((</span><span class="n">message</span><span class="o">.</span><span class="n">tid</span> <span class="ow">and</span> <span class="n">message</span><span class="o">.</span><span class="n">tid</span> <span class="o">!=</span> <span class="mh">0xFFFF</span> <span class="ow">and</span> <span class="mh">0x0001</span><span class="p">)</span> <span class="ow">or</span> <span class="mh">0x00</span><span class="p">),</span> <span class="c1"># Disconnect tid, if message.tid must be non-zero</span> | |
| 601 | <span class="p">((</span><span class="n">message</span><span class="o">.</span><span class="n">tid</span> <span class="ow">and</span> <span class="n">message</span><span class="o">.</span><span class="n">tid</span> <span class="o">!=</span> <span class="mh">0xffff</span> <span class="ow">and</span> <span class="mh">0x0001</span><span class="p">)</span> <span class="ow">or</span> <span class="mh">0x00</span><span class="p">),</span> <span class="c1"># Disconnect tid, if message.tid must be non-zero</span> | |
| 624 | 602 | <span class="n">password_len</span><span class="p">)</span> |
| 625 | 603 | |
| 626 | <span class="n">padding</span> <span class="o">=</span> <span class="s1">''</span> | |
| 604 | <span class="n">padding</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 627 | 605 | <span class="k">if</span> <span class="n">password_len</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| 628 | <span class="n">padding</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 606 | <span class="n">padding</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 629 | 607 | |
| 630 | 608 | <span class="c1"># Note that service field is never encoded in UTF-16LE. [MS-CIFS]: 2.2.1.1</span> |
| 631 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="o">+</span> <span class="n">padding</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">service</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 609 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-8'</span><span class="p">)</span> <span class="o">+</span> <span class="n">padding</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-8'</span><span class="p">)</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 632 | 610 | |
| 633 | 611 | |
| 634 | 612 | <span class="k">class</span> <span class="nc">ComTreeConnectAndxResponse</span><span class="p">(</span><span class="n">Payload</span><span class="p">):</span> |
| 667 | 645 | <span class="n">PAYLOAD_STRUCT_FORMAT</span> <span class="o">=</span> <span class="s1">'<BHIIIQIIIIIB'</span> |
| 668 | 646 | <span class="n">PAYLOAD_STRUCT_SIZE</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">calcsize</span><span class="p">(</span><span class="n">PAYLOAD_STRUCT_FORMAT</span><span class="p">)</span> |
| 669 | 647 | |
| 670 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">flags</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">root_fid</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">access_mask</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">allocation_size</span> <span class="o">=</span> <span class="il">0L</span><span class="p">,</span> <span class="n">ext_attr</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> | |
| 648 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">flags</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">root_fid</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">access_mask</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">allocation_size</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">ext_attr</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> | |
| 671 | 649 | <span class="n">share_access</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">create_disp</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">create_options</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">impersonation</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">security_flags</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> |
| 672 | 650 | <span class="bp">self</span><span class="o">.</span><span class="n">filename</span> <span class="o">=</span> <span class="p">(</span><span class="n">filename</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> |
| 673 | 651 | <span class="bp">self</span><span class="o">.</span><span class="n">flags</span> <span class="o">=</span> <span class="n">flags</span> |
| 704 | 682 | <span class="bp">self</span><span class="o">.</span><span class="n">impersonation</span><span class="p">,</span> <span class="c1"># ImpersonationLevel</span> |
| 705 | 683 | <span class="bp">self</span><span class="o">.</span><span class="n">security_flags</span><span class="p">)</span> <span class="c1"># SecurityFlags</span> |
| 706 | 684 | |
| 707 | <span class="n">padding</span> <span class="o">=</span> <span class="s1">''</span> | |
| 685 | <span class="n">padding</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 708 | 686 | <span class="k">if</span> <span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">HEADER_STRUCT_SIZE</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">parameters_data</span><span class="p">))</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 709 | <span class="n">padding</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 687 | <span class="n">padding</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 710 | 688 | |
| 711 | 689 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">padding</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">filename</span> |
| 712 | 690 | |
| 746 | 724 | <span class="n">PAYLOAD_STRUCT_FORMAT</span> <span class="o">=</span> <span class="s1">'<HHHHBBHIHHHHHH'</span> |
| 747 | 725 | <span class="n">PAYLOAD_STRUCT_SIZE</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">calcsize</span><span class="p">(</span><span class="n">PAYLOAD_STRUCT_FORMAT</span><span class="p">)</span> |
| 748 | 726 | |
| 749 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">max_params_count</span><span class="p">,</span> <span class="n">max_data_count</span><span class="p">,</span> <span class="n">max_setup_count</span><span class="p">,</span> | |
| 727 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">max_params_count</span><span class="p">,</span> <span class="n">max_data_count</span><span class="p">,</span> <span class="n">max_setup_count</span><span class="p">,</span> | |
| 750 | 728 | <span class="n">total_params_count</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">total_data_count</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 751 | <span class="n">params_bytes</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> <span class="n">data_bytes</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> <span class="n">setup_bytes</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> | |
| 729 | <span class="n">params_bytes</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="p">,</span> <span class="n">data_bytes</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="p">,</span> <span class="n">setup_bytes</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="p">,</span> | |
| 752 | 730 | <span class="n">flags</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">name</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">PIPE</span><span class="se">\\</span><span class="s2">"</span><span class="p">):</span> |
| 753 | 731 | <span class="bp">self</span><span class="o">.</span><span class="n">total_params_count</span> <span class="o">=</span> <span class="n">total_params_count</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">params_bytes</span><span class="p">)</span> |
| 754 | 732 | <span class="bp">self</span><span class="o">.</span><span class="n">total_data_count</span> <span class="o">=</span> <span class="n">total_data_count</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">)</span> |
| 773 | 751 | <span class="n">params_bytes_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">params_bytes</span><span class="p">)</span> |
| 774 | 752 | <span class="n">data_bytes_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">)</span> |
| 775 | 753 | |
| 776 | <span class="n">padding0</span> <span class="o">=</span> <span class="s1">''</span> | |
| 754 | <span class="n">padding0</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 777 | 755 | <span class="n">offset</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">HEADER_STRUCT_SIZE</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">PAYLOAD_STRUCT_SIZE</span> <span class="o">+</span> <span class="n">setup_bytes_len</span> <span class="o">+</span> <span class="mi">2</span> <span class="c1"># constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)</span> |
| 778 | 756 | <span class="k">if</span> <span class="n">offset</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 779 | <span class="n">padding0</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 757 | <span class="n">padding0</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 780 | 758 | <span class="n">offset</span> <span class="o">+=</span> <span class="mi">1</span> |
| 781 | 759 | |
| 782 | 760 | <span class="n">offset</span> <span class="o">+=</span> <span class="n">name_len</span> <span class="c1"># For the name field</span> |
| 783 | <span class="n">padding1</span> <span class="o">=</span> <span class="s1">''</span> | |
| 761 | <span class="n">padding1</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 784 | 762 | <span class="k">if</span> <span class="n">offset</span> <span class="o">%</span> <span class="mi">4</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 785 | <span class="n">padding1</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="o">*</span><span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> | |
| 763 | <span class="n">padding1</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="o">*</span><span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> | |
| 786 | 764 | <span class="n">offset</span> <span class="o">+=</span> <span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> |
| 787 | 765 | |
| 788 | 766 | <span class="k">if</span> <span class="n">params_bytes_len</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| 791 | 769 | <span class="k">else</span><span class="p">:</span> |
| 792 | 770 | <span class="n">params_bytes_offset</span> <span class="o">=</span> <span class="mi">0</span> |
| 793 | 771 | |
| 794 | <span class="n">padding2</span> <span class="o">=</span> <span class="s1">''</span> | |
| 772 | <span class="n">padding2</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 795 | 773 | <span class="k">if</span> <span class="n">offset</span> <span class="o">%</span> <span class="mi">4</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 796 | <span class="n">padding2</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="o">*</span><span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> | |
| 774 | <span class="n">padding2</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="o">*</span><span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> | |
| 797 | 775 | <span class="n">offset</span> <span class="o">+=</span> <span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> |
| 798 | 776 | |
| 799 | 777 | <span class="k">if</span> <span class="n">data_bytes_len</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| 886 | 864 | <span class="n">PAYLOAD_STRUCT_FORMAT</span> <span class="o">=</span> <span class="s1">'HHHHBBHIHHHHHH'</span> |
| 887 | 865 | <span class="n">PAYLOAD_STRUCT_SIZE</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">calcsize</span><span class="p">(</span><span class="n">PAYLOAD_STRUCT_FORMAT</span><span class="p">)</span> |
| 888 | 866 | |
| 889 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">max_params_count</span><span class="p">,</span> <span class="n">max_data_count</span><span class="p">,</span> <span class="n">max_setup_count</span><span class="p">,</span> | |
| 867 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">max_params_count</span><span class="p">,</span> <span class="n">max_data_count</span><span class="p">,</span> <span class="n">max_setup_count</span><span class="p">,</span> | |
| 890 | 868 | <span class="n">total_params_count</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">total_data_count</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 891 | <span class="n">params_bytes</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> <span class="n">data_bytes</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> <span class="n">setup_bytes</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> | |
| 869 | <span class="n">params_bytes</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="p">,</span> <span class="n">data_bytes</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="p">,</span> <span class="n">setup_bytes</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="p">,</span> | |
| 892 | 870 | <span class="n">flags</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> |
| 893 | 871 | <span class="bp">self</span><span class="o">.</span><span class="n">total_params_count</span> <span class="o">=</span> <span class="n">total_params_count</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">params_bytes</span><span class="p">)</span> |
| 894 | 872 | <span class="bp">self</span><span class="o">.</span><span class="n">total_data_count</span> <span class="o">=</span> <span class="n">total_data_count</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">)</span> |
| 909 | 887 | <span class="n">setup_bytes_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">setup_bytes</span><span class="p">)</span> |
| 910 | 888 | <span class="n">params_bytes_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">params_bytes</span><span class="p">)</span> |
| 911 | 889 | <span class="n">data_bytes_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">)</span> |
| 912 | <span class="n">name</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 913 | ||
| 914 | <span class="n">padding0</span> <span class="o">=</span> <span class="s1">''</span> | |
| 890 | <span class="n">name</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 891 | ||
| 892 | <span class="n">padding0</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 915 | 893 | <span class="n">offset</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">HEADER_STRUCT_SIZE</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">PAYLOAD_STRUCT_SIZE</span> <span class="o">+</span> <span class="n">setup_bytes_len</span> <span class="o">+</span> <span class="mi">2</span> <span class="c1"># constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)</span> |
| 916 | 894 | <span class="k">if</span> <span class="n">offset</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 917 | <span class="n">padding0</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 895 | <span class="n">padding0</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> | |
| 918 | 896 | <span class="n">offset</span> <span class="o">+=</span> <span class="mi">1</span> |
| 919 | 897 | |
| 920 | 898 | <span class="n">offset</span> <span class="o">+=</span> <span class="mi">2</span> <span class="c1"># For the name field</span> |
| 921 | <span class="n">padding1</span> <span class="o">=</span> <span class="s1">''</span> | |
| 899 | <span class="n">padding1</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 922 | 900 | <span class="k">if</span> <span class="n">offset</span> <span class="o">%</span> <span class="mi">4</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 923 | <span class="n">padding1</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="o">*</span><span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> | |
| 901 | <span class="n">padding1</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="o">*</span><span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> | |
| 924 | 902 | |
| 925 | 903 | <span class="k">if</span> <span class="n">params_bytes_len</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| 926 | 904 | <span class="n">params_bytes_offset</span> <span class="o">=</span> <span class="n">offset</span> |
| 928 | 906 | <span class="k">else</span><span class="p">:</span> |
| 929 | 907 | <span class="n">params_bytes_offset</span> <span class="o">=</span> <span class="mi">0</span> |
| 930 | 908 | |
| 931 | <span class="n">padding2</span> <span class="o">=</span> <span class="s1">''</span> | |
| 909 | <span class="n">padding2</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 932 | 910 | <span class="k">if</span> <span class="n">offset</span> <span class="o">%</span> <span class="mi">4</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 933 | <span class="n">padding2</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="o">*</span><span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> | |
| 911 | <span class="n">padding2</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="o">*</span><span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> | |
| 934 | 912 | |
| 935 | 913 | <span class="k">if</span> <span class="n">data_bytes_len</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| 936 | 914 | <span class="n">data_bytes_offset</span> <span class="o">=</span> <span class="n">offset</span> |
| 1022 | 1000 | <span class="n">PAYLOAD_STRUCT_FORMAT</span> <span class="o">=</span> <span class="s1">'<HI'</span> |
| 1023 | 1001 | <span class="n">PAYLOAD_STRUCT_SIZE</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">calcsize</span><span class="p">(</span><span class="n">PAYLOAD_STRUCT_FORMAT</span><span class="p">)</span> |
| 1024 | 1002 | |
| 1025 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">last_modified_time</span> <span class="o">=</span> <span class="mh">0xFFFFFFFF</span><span class="p">):</span> | |
| 1003 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">last_modified_time</span> <span class="o">=</span> <span class="mh">0xFFFFFFFF</span><span class="p">):</span> | |
| 1026 | 1004 | <span class="bp">self</span><span class="o">.</span><span class="n">fid</span> <span class="o">=</span> <span class="n">fid</span> |
| 1027 | 1005 | <span class="bp">self</span><span class="o">.</span><span class="n">last_modified_time</span> <span class="o">=</span> <span class="n">last_modified_time</span> |
| 1028 | 1006 | |
| 1032 | 1010 | |
| 1033 | 1011 | <span class="k">def</span> <span class="nf">prepare</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> |
| 1034 | 1012 | <span class="n">message</span><span class="o">.</span><span class="n">parameters_data</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">PAYLOAD_STRUCT_FORMAT</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">fid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_modified_time</span><span class="p">)</span> |
| 1035 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="s1">''</span> | |
| 1013 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 1036 | 1014 | |
| 1037 | 1015 | |
| 1038 | 1016 | <span class="k">class</span> <span class="nc">ComOpenAndxRequest</span><span class="p">(</span><span class="n">Payload</span><span class="p">):</span> |
| 1045 | 1023 | <span class="n">PAYLOAD_STRUCT_FORMAT</span> <span class="o">=</span> <span class="s1">'<HHHHIHIII'</span> |
| 1046 | 1024 | <span class="n">PAYLOAD_STRUCT_SIZE</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">calcsize</span><span class="p">(</span><span class="n">PAYLOAD_STRUCT_FORMAT</span><span class="p">)</span> |
| 1047 | 1025 | |
| 1048 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">access_mode</span><span class="p">,</span> <span class="n">open_mode</span><span class="p">,</span> <span class="n">flags</span> <span class="o">=</span> <span class="mh">0x0000</span><span class="p">,</span> <span class="n">search_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">file_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">create_time</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> | |
| 1026 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">access_mode</span><span class="p">,</span> <span class="n">open_mode</span><span class="p">,</span> <span class="n">flags</span> <span class="o">=</span> <span class="mh">0x0000</span><span class="p">,</span> <span class="n">search_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">file_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">create_time</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> | |
| 1049 | 1027 | <span class="sd">"""</span> |
| 1050 | 1028 | <span class="sd"> @param create_time: Epoch time value to indicate the time of creation for this file. If zero, we will automatically assign the current time</span> |
| 1051 | 1029 | <span class="sd"> @type create_time: int</span> |
| 1079 | 1057 | <span class="mi">0</span><span class="p">,</span> <span class="c1"># Timeout (in milli-secs)</span> |
| 1080 | 1058 | <span class="mi">0</span><span class="p">)</span> <span class="c1"># Reserved</span> |
| 1081 | 1059 | |
| 1082 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">filename</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 1060 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">filename</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 1083 | 1061 | |
| 1084 | 1062 | |
| 1085 | 1063 | <span class="k">class</span> <span class="nc">ComOpenAndxResponse</span><span class="p">(</span><span class="n">Payload</span><span class="p">):</span> |
| 1126 | 1104 | <span class="n">PAYLOAD_STRUCT_FORMAT</span> <span class="o">=</span> <span class="s1">'<HIIHHHHHI'</span> |
| 1127 | 1105 | <span class="n">PAYLOAD_STRUCT_SIZE</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">calcsize</span><span class="p">(</span><span class="n">PAYLOAD_STRUCT_FORMAT</span><span class="p">)</span> |
| 1128 | 1106 | |
| 1129 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">data_bytes</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">write_mode</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> | |
| 1107 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">data_bytes</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">write_mode</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> | |
| 1130 | 1108 | <span class="sd">"""</span> |
| 1131 | 1109 | <span class="sd"> @param timeout: Number of milliseconds to wait for blocked write request before failing. Must be zero for writing to regular file</span> |
| 1132 | 1110 | <span class="sd"> @type timeout: int</span> |
| 1160 | 1138 | <span class="n">data_offset</span><span class="p">,</span> <span class="c1"># DataOffset</span> |
| 1161 | 1139 | <span class="bp">self</span><span class="o">.</span><span class="n">offset</span> <span class="o">>></span> <span class="mi">32</span><span class="p">)</span> <span class="c1"># OffsetHigh field defined in [MS-SMB]: 2.2.4.3.1</span> |
| 1162 | 1140 | |
| 1163 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_bytes</span> | |
| 1141 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_bytes</span> | |
| 1164 | 1142 | |
| 1165 | 1143 | |
| 1166 | 1144 | <span class="k">class</span> <span class="nc">ComWriteAndxResponse</span><span class="p">(</span><span class="n">Payload</span><span class="p">):</span> |
| 1196 | 1174 | <span class="n">PAYLOAD_STRUCT_FORMAT</span> <span class="o">=</span> <span class="s1">'<HIHHIHI'</span> |
| 1197 | 1175 | <span class="n">PAYLOAD_STRUCT_SIZE</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">calcsize</span><span class="p">(</span><span class="n">PAYLOAD_STRUCT_FORMAT</span><span class="p">)</span> |
| 1198 | 1176 | |
| 1199 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">max_return_bytes_count</span><span class="p">,</span> <span class="n">min_return_bytes_count</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">remaining</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> | |
| 1177 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fid</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">max_return_bytes_count</span><span class="p">,</span> <span class="n">min_return_bytes_count</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">remaining</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> | |
| 1200 | 1178 | <span class="sd">"""</span> |
| 1201 | 1179 | <span class="sd"> @param timeout: If reading from a regular file, this parameter must be 0.</span> |
| 1202 | 1180 | <span class="sd"> @type timeout: int</span> |
| 1224 | 1202 | <span class="bp">self</span><span class="o">.</span><span class="n">remaining</span><span class="p">,</span> <span class="c1"># In [MS-CIFS]: 2.2.4.42.1, this field must be set to 0x0000</span> |
| 1225 | 1203 | <span class="bp">self</span><span class="o">.</span><span class="n">offset</span> <span class="o">>></span> <span class="mi">32</span><span class="p">)</span> |
| 1226 | 1204 | |
| 1227 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="s1">''</span> | |
| 1205 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 1228 | 1206 | |
| 1229 | 1207 | |
| 1230 | 1208 | <span class="k">class</span> <span class="nc">ComReadAndxResponse</span><span class="p">(</span><span class="n">Payload</span><span class="p">):</span> |
| 1260 | 1238 | <span class="sd"> - [MS-CIFS]: 2.2.4.7.1</span> |
| 1261 | 1239 | <span class="sd"> """</span> |
| 1262 | 1240 | |
| 1263 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename_pattern</span><span class="p">,</span> <span class="n">search_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> | |
| 1241 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename_pattern</span><span class="p">,</span> <span class="n">search_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> | |
| 1264 | 1242 | <span class="bp">self</span><span class="o">.</span><span class="n">filename_pattern</span> <span class="o">=</span> <span class="n">filename_pattern</span> |
| 1265 | 1243 | <span class="bp">self</span><span class="o">.</span><span class="n">search_attributes</span> <span class="o">=</span> <span class="n">search_attributes</span> |
| 1266 | 1244 | |
| 1270 | 1248 | |
| 1271 | 1249 | <span class="k">def</span> <span class="nf">prepare</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> |
| 1272 | 1250 | <span class="n">message</span><span class="o">.</span><span class="n">parameters_data</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<H'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_attributes</span><span class="p">)</span> |
| 1273 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\x04</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">filename_pattern</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 1251 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\x04</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">filename_pattern</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 1274 | 1252 | |
| 1275 | 1253 | |
| 1276 | 1254 | <span class="k">class</span> <span class="nc">ComCreateDirectoryRequest</span><span class="p">(</span><span class="n">Payload</span><span class="p">):</span> |
| 1283 | 1261 | <span class="sd"> - [MS-CIFS]: 2.2.4.1.1</span> |
| 1284 | 1262 | <span class="sd"> """</span> |
| 1285 | 1263 | |
| 1286 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span> | |
| 1264 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span> | |
| 1287 | 1265 | <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="n">path</span> |
| 1288 | 1266 | |
| 1289 | 1267 | <span class="k">def</span> <span class="nf">initMessage</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> |
| 1291 | 1269 | <span class="n">message</span><span class="o">.</span><span class="n">command</span> <span class="o">=</span> <span class="n">SMB_COM_CREATE_DIRECTORY</span> |
| 1292 | 1270 | |
| 1293 | 1271 | <span class="k">def</span> <span class="nf">prepare</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> |
| 1294 | <span class="n">message</span><span class="o">.</span><span class="n">parameters_data</span> <span class="o">=</span> <span class="s1">''</span> | |
| 1295 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\x04</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 1272 | <span class="n">message</span><span class="o">.</span><span class="n">parameters_data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 1273 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\x04</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 1296 | 1274 | |
| 1297 | 1275 | |
| 1298 | 1276 | <span class="k">class</span> <span class="nc">ComDeleteDirectoryRequest</span><span class="p">(</span><span class="n">Payload</span><span class="p">):</span> |
| 1302 | 1280 | <span class="sd"> - [MS-CIFS]: 2.2.4.2.1</span> |
| 1303 | 1281 | <span class="sd"> """</span> |
| 1304 | 1282 | |
| 1305 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span> | |
| 1283 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span> | |
| 1306 | 1284 | <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="n">path</span> |
| 1307 | 1285 | |
| 1308 | 1286 | <span class="k">def</span> <span class="nf">initMessage</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> |
| 1310 | 1288 | <span class="n">message</span><span class="o">.</span><span class="n">command</span> <span class="o">=</span> <span class="n">SMB_COM_DELETE_DIRECTORY</span> |
| 1311 | 1289 | |
| 1312 | 1290 | <span class="k">def</span> <span class="nf">prepare</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> |
| 1313 | <span class="n">message</span><span class="o">.</span><span class="n">parameters_data</span> <span class="o">=</span> <span class="s1">''</span> | |
| 1314 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\x04</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 1291 | <span class="n">message</span><span class="o">.</span><span class="n">parameters_data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 1292 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\x04</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0\0</span><span class="s1">'</span> | |
| 1315 | 1293 | |
| 1316 | 1294 | |
| 1317 | 1295 | <span class="k">class</span> <span class="nc">ComRenameRequest</span><span class="p">(</span><span class="n">Payload</span><span class="p">):</span> |
| 1321 | 1299 | <span class="sd"> - [MS-CIFS]: 2.2.4.8.1</span> |
| 1322 | 1300 | <span class="sd"> """</span> |
| 1323 | 1301 | |
| 1324 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">old_path</span><span class="p">,</span> <span class="n">new_path</span><span class="p">,</span> <span class="n">search_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> | |
| 1302 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">old_path</span><span class="p">,</span> <span class="n">new_path</span><span class="p">,</span> <span class="n">search_attributes</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span> | |
| 1325 | 1303 | <span class="bp">self</span><span class="o">.</span><span class="n">old_path</span> <span class="o">=</span> <span class="n">old_path</span> |
| 1326 | 1304 | <span class="bp">self</span><span class="o">.</span><span class="n">new_path</span> <span class="o">=</span> <span class="n">new_path</span> |
| 1327 | 1305 | <span class="bp">self</span><span class="o">.</span><span class="n">search_attributes</span> <span class="o">=</span> <span class="n">search_attributes</span> |
| 1332 | 1310 | |
| 1333 | 1311 | <span class="k">def</span> <span class="nf">prepare</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> |
| 1334 | 1312 | <span class="n">message</span><span class="o">.</span><span class="n">parameters_data</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="s1">'<H'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_attributes</span><span class="p">)</span> |
| 1335 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\x04</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">old_path</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\x00\x00\x04\x00</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">new_path</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\x00\x00</span><span class="s1">'</span> | |
| 1313 | <span class="n">message</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\x04</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">old_path</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\x00\x00\x04\x00</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">new_path</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'UTF-16LE'</span><span class="p">)</span> <span class="o">+</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\x00\x00</span><span class="s1">'</span> | |
| 1336 | 1314 | |
| 1337 | 1315 | |
| 1338 | 1316 | <span class="k">class</span> <span class="nc">ComEchoRequest</span><span class="p">(</span><span class="n">Payload</span><span class="p">):</span> |
| 1342 | 1320 | <span class="sd"> - [MS-CIFS]: 2.2.4.39.1</span> |
| 1343 | 1321 | <span class="sd"> """</span> |
| 1344 | 1322 | |
| 1345 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">echo_data</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> <span class="n">echo_count</span> <span class="o">=</span> <span class="mi">1</span><span class="p">):</span> | |
| 1323 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">echo_data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="p">,</span> <span class="n">echo_count</span> <span class="o">=</span> <span class="mi">1</span><span class="p">):</span> | |
| 1346 | 1324 | <span class="bp">self</span><span class="o">.</span><span class="n">echo_count</span> <span class="o">=</span> <span class="n">echo_count</span> |
| 1347 | 1325 | <span class="bp">self</span><span class="o">.</span><span class="n">echo_data</span> <span class="o">=</span> <span class="n">echo_data</span> |
| 1348 | 1326 | |
| 1377 | 1355 | <span class="n">PAYLOAD_STRUCT_FORMAT</span> <span class="o">=</span> <span class="s1">'<BHIIIIIIIIBH'</span> |
| 1378 | 1356 | <span class="n">PAYLOAD_STRUCT_SIZE</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">calcsize</span><span class="p">(</span><span class="n">PAYLOAD_STRUCT_FORMAT</span><span class="p">)</span> |
| 1379 | 1357 | |
| 1380 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">function</span><span class="p">,</span> <span class="n">max_params_count</span><span class="p">,</span> <span class="n">max_data_count</span><span class="p">,</span> <span class="n">max_setup_count</span><span class="p">,</span> | |
| 1358 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">function</span><span class="p">,</span> <span class="n">max_params_count</span><span class="p">,</span> <span class="n">max_data_count</span><span class="p">,</span> <span class="n">max_setup_count</span><span class="p">,</span> | |
| 1381 | 1359 | <span class="n">total_params_count</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">total_data_count</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> |
| 1382 | <span class="n">params_bytes</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> <span class="n">setup_bytes</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> <span class="n">data_bytes</span> <span class="o">=</span> <span class="s1">''</span><span class="p">):</span> | |
| 1360 | <span class="n">params_bytes</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="p">,</span> <span class="n">setup_bytes</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="p">,</span> <span class="n">data_bytes</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span><span class="p">):</span> | |
| 1383 | 1361 | <span class="bp">self</span><span class="o">.</span><span class="n">function</span> <span class="o">=</span> <span class="n">function</span> |
| 1384 | 1362 | <span class="bp">self</span><span class="o">.</span><span class="n">total_params_count</span> <span class="o">=</span> <span class="n">total_params_count</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">params_bytes</span><span class="p">)</span> |
| 1385 | 1363 | <span class="bp">self</span><span class="o">.</span><span class="n">total_data_count</span> <span class="o">=</span> <span class="n">total_data_count</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">data_bytes</span><span class="p">)</span> |
| 1399 | 1377 | <span class="n">params_bytes_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">params_bytes</span><span class="p">)</span> |
| 1400 | 1378 | <span class="n">data_bytes_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data_bytes</span><span class="p">)</span> |
| 1401 | 1379 | |
| 1402 | <span class="n">padding0</span> <span class="o">=</span> <span class="s1">''</span> | |
| 1380 | <span class="n">padding0</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 1403 | 1381 | <span class="n">offset</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">HEADER_STRUCT_SIZE</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">PAYLOAD_STRUCT_SIZE</span> <span class="o">+</span> <span class="n">setup_bytes_len</span> <span class="o">+</span> <span class="mi">2</span> <span class="c1"># constant 2 is for the ByteCount field in the SMB header (i.e. field which indicates number of data bytes after the SMB parameters)</span> |
| 1404 | 1382 | <span class="k">if</span> <span class="n">offset</span> <span class="o">%</span> <span class="mi">4</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 1405 | <span class="n">padding0</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="o">*</span><span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> | |
| 1383 | <span class="n">padding0</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="o">*</span><span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> | |
| 1406 | 1384 | <span class="n">offset</span> <span class="o">+=</span> <span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> |
| 1407 | 1385 | |
| 1408 | 1386 | <span class="k">if</span> <span class="n">params_bytes_len</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| 1411 | 1389 | <span class="n">params_bytes_offset</span> <span class="o">=</span> <span class="mi">0</span> |
| 1412 | 1390 | |
| 1413 | 1391 | <span class="n">offset</span> <span class="o">+=</span> <span class="n">params_bytes_len</span> |
| 1414 | <span class="n">padding1</span> <span class="o">=</span> <span class="s1">''</span> | |
| 1392 | <span class="n">padding1</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 1415 | 1393 | <span class="k">if</span> <span class="n">offset</span> <span class="o">%</span> <span class="mi">4</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| 1416 | <span class="n">padding1</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="o">*</span><span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> | |
| 1394 | <span class="n">padding1</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\0</span><span class="s1">'</span><span class="o">*</span><span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> | |
| 1417 | 1395 | <span class="n">offset</span> <span class="o">+=</span> <span class="p">(</span><span class="mi">4</span><span class="o">-</span><span class="n">offset</span><span class="o">%</span><span class="mi">4</span><span class="p">)</span> |
| 1418 | 1396 | |
| 1419 | 1397 | <span class="k">if</span> <span class="n">data_bytes_len</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| 1473 | 1451 | <span class="n">params_offset</span> <span class="o">-=</span> <span class="n">message</span><span class="o">.</span><span class="n">HEADER_STRUCT_SIZE</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">PAYLOAD_STRUCT_SIZE</span> <span class="o">+</span> <span class="n">setup_count</span><span class="o">*</span><span class="mi">2</span> <span class="o">+</span> <span class="mi">2</span> |
| 1474 | 1452 | <span class="bp">self</span><span class="o">.</span><span class="n">params_bytes</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="n">params_offset</span><span class="p">:</span><span class="n">params_offset</span><span class="o">+</span><span class="n">params_count</span><span class="p">]</span> |
| 1475 | 1453 | <span class="k">else</span><span class="p">:</span> |
| 1476 | <span class="bp">self</span><span class="o">.</span><span class="n">params_bytes</span> <span class="o">=</span> <span class="s1">''</span> | |
| 1454 | <span class="bp">self</span><span class="o">.</span><span class="n">params_bytes</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 1477 | 1455 | |
| 1478 | 1456 | <span class="k">if</span> <span class="n">data_count</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| 1479 | 1457 | <span class="n">data_offset</span> <span class="o">-=</span> <span class="n">message</span><span class="o">.</span><span class="n">HEADER_STRUCT_SIZE</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">PAYLOAD_STRUCT_SIZE</span> <span class="o">+</span> <span class="n">setup_count</span><span class="o">*</span><span class="mi">2</span> <span class="o">+</span> <span class="mi">2</span> |
| 1480 | 1458 | <span class="bp">self</span><span class="o">.</span><span class="n">data_bytes</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="n">data_offset</span><span class="p">:</span><span class="n">data_offset</span><span class="o">+</span><span class="n">data_count</span><span class="p">]</span> |
| 1481 | 1459 | <span class="k">else</span><span class="p">:</span> |
| 1482 | <span class="bp">self</span><span class="o">.</span><span class="n">data_bytes</span> <span class="o">=</span> <span class="s1">''</span> | |
| 1460 | <span class="bp">self</span><span class="o">.</span><span class="n">data_bytes</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span> | |
| 1483 | 1461 | </pre></div> |
| 1484 | 1462 | |
| 1463 | <div class="clearer"></div> | |
| 1485 | 1464 | </div> |
| 1465 | </div> | |
| 1466 | </div> | |
| 1467 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 1468 | <div class="sphinxsidebarwrapper"> | |
| 1469 | <div id="searchbox" style="display: none" role="search"> | |
| 1470 | <h3 id="searchlabel">Quick search</h3> | |
| 1471 | <div class="searchformwrapper"> | |
| 1472 | <form class="search" action="../../search.html" method="get"> | |
| 1473 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 1474 | <input type="submit" value="Go" /> | |
| 1475 | </form> | |
| 1476 | </div> | |
| 1477 | </div> | |
| 1478 | <script>$('#searchbox').show(0);</script> | |
| 1486 | 1479 | </div> |
| 1487 | 1480 | </div> |
| 1488 | 1481 | <div class="clearer"></div> |
| 1493 | 1486 | <li class="right" style="margin-right: 10px"> |
| 1494 | 1487 | <a href="../../genindex.html" title="General Index" |
| 1495 | 1488 | >index</a></li> |
| 1496 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 1497 | <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> | |
| 1489 | <li class="right" > | |
| 1490 | <a href="../../py-modindex.html" title="Python Module Index" | |
| 1491 | >modules</a> |</li> | |
| 1492 | <li class="nav-item nav-item-0"><a href="../../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 1493 | <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> | |
| 1494 | <li class="nav-item nav-item-this"><a href="">smb.smb_structs</a></li> | |
| 1498 | 1495 | </ul> |
| 1499 | 1496 | </div> |
| 1500 | 1497 | <div class="footer" role="contentinfo"> |
| 1501 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 1502 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 1498 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 1499 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 1503 | 1500 | </div> |
| 1504 | 1501 | </body> |
| 1505 | 1502 | </html>⏎ |
| 0 | ||
| 1 | NBNSProtocol Class | |
| 2 | ================== | |
| 3 | ||
| 4 | pysmb has a *NBNSProtocol* implementation for Twisted framework. | |
| 5 | This allows you to perform name query asynchronously without having your application to block and wait for the results. | |
| 6 | ||
| 7 | In your project, | |
| 8 | 1. Create a NBNSProtocol instance. | |
| 9 | 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. | |
| 10 | 3. When you are done with the NBNSProtocol instance, call its <NBNSProtocol instance>.transport.stopListening method to remove this instance from the reactor. | |
| 11 | ||
| 12 | .. autoclass:: nmb.NetBIOSProtocol.NBNSProtocol | |
| 13 | :members: | |
| 14 | :special-members: | |
| 15 | ||
| 16 | .. autoclass:: nmb.NetBIOSProtocol.NetBIOSTimeout | |
| 17 | :members: |
| 0 | ||
| 1 | NetBIOS class | |
| 2 | ============= | |
| 3 | ||
| 4 | To use the NetBIOS class in your application, | |
| 5 | 1. Create a new NetBIOS instance | |
| 6 | 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. | |
| 7 | 3. When you are done, call *close* method to release the underlying resources. | |
| 8 | ||
| 9 | .. autoclass:: nmb.NetBIOS.NetBIOS | |
| 10 | :members: | |
| 11 | :special-members: |
| 0 | ||
| 1 | SMBConnection Class | |
| 2 | =================== | |
| 3 | ||
| 4 | The SMBConnection is suitable for developers who wish to use pysmb to perform file operations with a remote SMB/CIFS server sequentially. | |
| 5 | ||
| 6 | Each file operation method, when invoked, will block and return after it has completed or has encountered an error. | |
| 7 | ||
| 8 | Example | |
| 9 | ------- | |
| 10 | ||
| 11 | The following illustrates a simple file retrieving implementation.:: | |
| 12 | ||
| 13 | import tempfile | |
| 14 | from smb.SMBConnection import SMBConnection | |
| 15 | ||
| 16 | # There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip | |
| 17 | # client_machine_name can be an arbitary ASCII string | |
| 18 | # server_name should match the remote machine name, or else the connection will be rejected | |
| 19 | conn = SMBConnection(userID, password, client_machine_name, server_name, use_ntlm_v2 = True) | |
| 20 | assert conn.connect(server_ip, 139) | |
| 21 | ||
| 22 | file_obj = tempfile.NamedTemporaryFile() | |
| 23 | file_attributes, filesize = conn.retrieveFile('smbtest', '/rfc1001.txt', file_obj) | |
| 24 | ||
| 25 | # Retrieved file contents are inside file_obj | |
| 26 | # Do what you need with the file_obj and then close it | |
| 27 | # Note that the file obj is positioned at the end-of-file, | |
| 28 | # so you might need to perform a file_obj.seek() if you need | |
| 29 | # to read from the beginning | |
| 30 | file_obj.close() | |
| 31 | ||
| 32 | SMB2 Support | |
| 33 | ------------- | |
| 34 | ||
| 35 | Starting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2. | |
| 36 | Otherwise, it will fallback automatically back to using SMB1 protocol. | |
| 37 | ||
| 38 | To disable SMB2 protocol in pysmb, set the *SUPPORT_SMB2* flag in the *smb_structs* module to *False* before creating the *SMBConnection* instance.:: | |
| 39 | ||
| 40 | from smb import smb_structs | |
| 41 | smb_structs.SUPPORT_SMB2 = False | |
| 42 | ||
| 43 | Caveats | |
| 44 | ------- | |
| 45 | ||
| 46 | * It is not meant to be used asynchronously. | |
| 47 | * A single *SMBConnection* instance should not be used to perform more than one operation concurrently at the same time. | |
| 48 | * Do not keep a *SMBConnection* instance "idle" for too long, i.e. keeping a *SMBConnection* instance but not using it. | |
| 49 | Most SMB/CIFS servers have some sort of keepalive mechanism and impose a timeout limit. | |
| 50 | If the clients fail to respond within the timeout limit, the SMB/CIFS server may disconnect the client. | |
| 51 | ||
| 52 | .. autoclass:: smb.SMBConnection.SMBConnection | |
| 53 | :members: | |
| 54 | :special-members: |
| 0 | ||
| 1 | SMbHandler Class | |
| 2 | ================ | |
| 3 | ||
| 4 | The SMBHandler class provides support for "smb://" URLs in the `urllib2 <http://docs.python.org/library/urllib2.html>`_ python package. | |
| 5 | ||
| 6 | Notes | |
| 7 | ----- | |
| 8 | * The host component of the URL must be one of the following: | |
| 9 | ||
| 10 | * A fully-qualified hostname that can be resolved by your local DNS service. Example: myserver.test.com | |
| 11 | * An IP address. Example: 192.168.1.1 | |
| 12 | * A comma-separated string "<NBName>,<IP>" where *<NBName>* is the Windows/NetBIOS machine name for remote SMB service, and *<IP>* is the service's IP address. Example: MYSERVER,192.168.1.1 | |
| 13 | ||
| 14 | * The first component of the path in the URL points to the name of the shared folder. | |
| 15 | Subsequent path components will point to the directory/folder of the file. | |
| 16 | * You can retrieve and upload files, but you cannot delete files/folders or create folders. | |
| 17 | In uploads, if the parent folders do not exist, an *urllib2.URLError* will be raised. | |
| 18 | ||
| 19 | Example | |
| 20 | ------- | |
| 21 | ||
| 22 | The following code snippet illustrates file retrieval with Python 2.:: | |
| 23 | ||
| 24 | # -*- coding: utf-8 -*- | |
| 25 | import urllib2 | |
| 26 | from smb.SMBHandler import SMBHandler | |
| 27 | ||
| 28 | director = urllib2.build_opener(SMBHandler) | |
| 29 | fh = director.open('smb://myuserID:[email protected]/sharedfolder/rfc1001.txt') | |
| 30 | ||
| 31 | # Process fh like a file-like object and then close it. | |
| 32 | fh.close() | |
| 33 | ||
| 34 | # For paths/files with unicode characters, simply pass in the URL as an unicode string | |
| 35 | fh2 = director.open(u'smb://myuserID:[email protected]/sharedfolder/测试文件夹/垃圾文件.dat') | |
| 36 | ||
| 37 | # Process fh2 like a file-like object and then close it. | |
| 38 | fh2.close() | |
| 39 | ||
| 40 | The following code snippet illustrates file upload with Python 2. You need to provide a file-like object for the *data* parameter in the *open()* method:: | |
| 41 | ||
| 42 | import urllib2 | |
| 43 | from smb.SMBHandler import SMBHandler | |
| 44 | ||
| 45 | file_fh = open('local_file.dat', 'rb') | |
| 46 | ||
| 47 | director = urllib2.build_opener(SMBHandler) | |
| 48 | fh = director.open('smb://myuserID:[email protected]/sharedfolder/upload_file.dat', data = file_fh) | |
| 49 | ||
| 50 | # Reading from fh will only return an empty string | |
| 51 | fh.close() | |
| 52 | ||
| 53 | ||
| 54 | The following code snippet illustrates file retrieval with Python 3.:: | |
| 55 | ||
| 56 | import urllib | |
| 57 | from smb.SMBHandler import SMBHandler | |
| 58 | ||
| 59 | director = urllib.request.build_opener(SMBHandler) | |
| 60 | fh = director.open('smb://myuserID:[email protected]/sharedfolder/rfc1001.txt') | |
| 61 | ||
| 62 | # Process fh like a file-like object and then close it. | |
| 63 | fh.close() | |
| 64 | ||
| 65 | # For paths/files with unicode characters, simply pass in the URL as an unicode string | |
| 66 | fh2 = director.open(u'smb://myuserID:[email protected]/sharedfolder/测试文件夹/垃圾文件.dat') | |
| 67 | ||
| 68 | # Process fh2 like a file-like object and then close it. | |
| 69 | fh2.close() | |
| 70 | ||
| 71 | The following code snippet illustrates file upload with Python 3. You need to provide a file-like object for the *data* parameter in the *open()* method:: | |
| 72 | ||
| 73 | import urllib | |
| 74 | from smb.SMBHandler import SMBHandler | |
| 75 | ||
| 76 | file_fh = open('local_file.dat', 'rb') | |
| 77 | ||
| 78 | director = urllib.request.build_opener(SMBHandler) | |
| 79 | fh = director.open('smb://myuserID:[email protected]/sharedfolder/upload_file.dat', data = file_fh) | |
| 80 | ||
| 81 | # Reading from fh will only return an empty string | |
| 82 | fh.close() |
| 5 | 5 | |
| 6 | 6 | Notes |
| 7 | 7 | ----- |
| 8 | * Note that you need to pass in a valid hostname or IP address for the host component of the URL. | |
| 9 | Do not use the Windows/NetBIOS machine name for the host component. | |
| 8 | * The host component of the URL must be one of the following: | |
| 9 | ||
| 10 | * A fully-qualified hostname that can be resolved by your local DNS service. Example: myserver.test.com | |
| 11 | * An IP address. Example: 192.168.1.1 | |
| 12 | * A comma-separated string "<NBName>,<IP>" where *<NBName>* is the Windows/NetBIOS machine name for remote SMB service, and *<IP>* is the service's IP address. Example: MYSERVER,192.168.1.1 | |
| 13 | ||
| 10 | 14 | * The first component of the path in the URL points to the name of the shared folder. |
| 11 | 15 | Subsequent path components will point to the directory/folder of the file. |
| 12 | 16 | * You can retrieve and upload files, but you cannot delete files/folders or create folders. |
| 15 | 19 | Example |
| 16 | 20 | ------- |
| 17 | 21 | |
| 18 | The following code snippet illustrates file retrieval.:: | |
| 22 | The following code snippet illustrates file retrieval with Python 2.:: | |
| 19 | 23 | |
| 20 | 24 | # -*- coding: utf-8 -*- |
| 21 | 25 | import urllib2 |
| 33 | 37 | # Process fh2 like a file-like object and then close it. |
| 34 | 38 | fh2.close() |
| 35 | 39 | |
| 36 | The following code snippet illustrates file upload. You need to provide a file-like object for the *data* parameter in the *open()* method:: | |
| 40 | The following code snippet illustrates file upload with Python 2. You need to provide a file-like object for the *data* parameter in the *open()* method:: | |
| 37 | 41 | |
| 38 | 42 | import urllib2 |
| 39 | 43 | from smb.SMBHandler import SMBHandler |
| 45 | 49 | |
| 46 | 50 | # Reading from fh will only return an empty string |
| 47 | 51 | fh.close() |
| 52 | ||
| 53 | ||
| 54 | The following code snippet illustrates file retrieval with Python 3.:: | |
| 55 | ||
| 56 | import urllib | |
| 57 | from smb.SMBHandler import SMBHandler | |
| 58 | ||
| 59 | director = urllib.request.build_opener(SMBHandler) | |
| 60 | fh = director.open('smb://myuserID:[email protected]/sharedfolder/rfc1001.txt') | |
| 61 | ||
| 62 | # Process fh like a file-like object and then close it. | |
| 63 | fh.close() | |
| 64 | ||
| 65 | # For paths/files with unicode characters, simply pass in the URL as an unicode string | |
| 66 | fh2 = director.open(u'smb://myuserID:[email protected]/sharedfolder/测试文件夹/垃圾文件.dat') | |
| 67 | ||
| 68 | # Process fh2 like a file-like object and then close it. | |
| 69 | fh2.close() | |
| 70 | ||
| 71 | The following code snippet illustrates file upload with Python 3. You need to provide a file-like object for the *data* parameter in the *open()* method:: | |
| 72 | ||
| 73 | import urllib | |
| 74 | from smb.SMBHandler import SMBHandler | |
| 75 | ||
| 76 | file_fh = open('local_file.dat', 'rb') | |
| 77 | ||
| 78 | director = urllib.request.build_opener(SMBHandler) | |
| 79 | fh = director.open('smb://myuserID:[email protected]/sharedfolder/upload_file.dat', data = file_fh) | |
| 80 | ||
| 81 | # Reading from fh will only return an empty string | |
| 82 | fh.close() | |
| 0 | ||
| 1 | SMBProtocolFactory Class | |
| 2 | ======================== | |
| 3 | ||
| 4 | For those who want to utilize pysmb in Twisted framework, pysmb has a *smb.SMBProtocol.SMBProtocol* implementation. | |
| 5 | In most cases, you do not need to touch or import the *SMBProtocol* directly. All the SMB functionalities are exposed in the *SMBProtocolFactory*. | |
| 6 | ||
| 7 | In your project, | |
| 8 | 1. Create a new class and subclass *SMBProtocolFactory*. | |
| 9 | 2. Override the *SMBProtocolFactory.onAuthOK* and *SMBProtocolFactory.onAuthFailed* instance methods to provide your own post-authenthentication handling. | |
| 10 | Once *SMBProtocolFactory.onAuthOK* has been called by pymsb internals, your application is ready to communicate with the remote SMB/CIFS service through | |
| 11 | the *SMBProtocolFactory* public methods such as *SMBProtocolFactory.storeFile*, *SMBProtocolFactory.retrieveFile*, etc. | |
| 12 | 3. When you want to disconnect from the remote SMB/CIFS server, just call *SMBProtocolFactory.closeConnection* method. | |
| 13 | ||
| 14 | All the *SMBProtocolFactory* public methods that provide file functionlities will return a *twisted.internet.defer.Deferred* instance. | |
| 15 | A :doc:`NotReadyError<smb_exceptions>` exception is raised when the underlying SMB is not authenticated. | |
| 16 | If the underlying SMB connection has been terminated, a :doc:`NotConnectedError<smb_exceptions>` exception is raised. | |
| 17 | ||
| 18 | All the file operation methods in *SMBProtocolFactory* class accept a *timeout* parameter. This parameter specifies the time limit where pysmb will wait for the | |
| 19 | entire file operation (except *storeFile* and *retrieveFile* methods) to complete. If the file operation fails to complete within the timeout period, the returned | |
| 20 | *Deferred* instance's *errback* method will be called with a *SMBTimeout* exception. | |
| 21 | ||
| 22 | If you are interested in learning the results of the operation or to know when the operation has completed, you should | |
| 23 | add a handling method to the returned *Deferred* instance via *Deferred.addCallback*. If the file operation fails, the *Deferred.errback* function will be called | |
| 24 | with an :doc:`OperationFailure<smb_exceptions>`; on timeout, it will be called with a :doc:`SMBTimeout<smb_exceptions>`. | |
| 25 | ||
| 26 | Example | |
| 27 | ------- | |
| 28 | ||
| 29 | The following illustrates a simple file retrieving implementation.:: | |
| 30 | ||
| 31 | import tempfile | |
| 32 | from twisted.internet import reactor | |
| 33 | from smb.SMBProtocol import SMBProtocolFactory | |
| 34 | ||
| 35 | class RetrieveFileFactory(SMBProtocolFactory): | |
| 36 | ||
| 37 | def __init__(self, *args, **kwargs): | |
| 38 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 39 | ||
| 40 | def fileRetrieved(self, write_result): | |
| 41 | file_obj, file_attributes, file_size = write_result | |
| 42 | ||
| 43 | # Retrieved file contents are inside file_obj | |
| 44 | # Do what you need with the file_obj and then close it | |
| 45 | # Note that the file obj is positioned at the end-of-file, | |
| 46 | # so you might need to perform a file_obj.seek() to if you | |
| 47 | # need to read from the beginning | |
| 48 | file_obj.close() | |
| 49 | ||
| 50 | self.transport.loseConnection() | |
| 51 | ||
| 52 | def onAuthOK(self): | |
| 53 | d = self.retrieveFile(self.service, self.path, tempfile.NamedTemporaryFile()) | |
| 54 | d.addCallback(self.fileRetrieved) | |
| 55 | d.addErrback(self.d.errback) | |
| 56 | ||
| 57 | def onAuthFailed(self): | |
| 58 | print 'Auth failed' | |
| 59 | ||
| 60 | # There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip | |
| 61 | # client_machine_name can be an arbitary ASCII string | |
| 62 | # server_name should match the remote machine name, or else the connection will be rejected | |
| 63 | factory = RetrieveFileFactory(userID, password, client_machine_name, server_name, use_ntlm_v2 = True) | |
| 64 | factory.service = 'smbtest' | |
| 65 | factory.path = '/rfc1001.txt' | |
| 66 | reactor.connectTCP(server_ip, 139, factory) | |
| 67 | ||
| 68 | ||
| 69 | ||
| 70 | ||
| 71 | SMB2 Support | |
| 72 | ------------- | |
| 73 | ||
| 74 | Starting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2. | |
| 75 | Otherwise, it will fallback automatically back to using SMB1 protocol. | |
| 76 | ||
| 77 | To disable SMB2 protocol in pysmb, set the *SUPPORT_SMB2* flag in the *smb_structs* module to *False* before creating the *SMBProtocolFactory* instance.:: | |
| 78 | ||
| 79 | from smb import smb_structs | |
| 80 | smb_structs.SUPPORT_SMB2 = False | |
| 81 | ||
| 82 | Caveats | |
| 83 | ------- | |
| 84 | ||
| 85 | * 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. | |
| 86 | * 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. | |
| 87 | * 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 | |
| 88 | *SMBTimeout* exception after 1.5 sec. | |
| 89 | ||
| 90 | .. autoclass:: smb.SMBProtocol.SMBProtocolFactory | |
| 91 | :members: | |
| 92 | :special-members: |
| 0 | ||
| 1 | SMB Exceptions | |
| 2 | ============== | |
| 3 | ||
| 4 | .. autoclass:: smb.base.SMBTimeout | |
| 5 | :members: | |
| 6 | ||
| 7 | .. autoclass:: smb.base.NotReadyError | |
| 8 | :members: | |
| 9 | ||
| 10 | .. autoclass:: smb.base.NotConnectedError | |
| 11 | :members: | |
| 12 | ||
| 13 | .. autoclass:: smb.smb_structs.UnsupportedFeature | |
| 14 | :members: | |
| 15 | ||
| 16 | .. autoclass:: smb.smb_structs.ProtocolError | |
| 17 | :members: | |
| 18 | ||
| 19 | .. autoclass:: smb.smb_structs.OperationFailure | |
| 20 | :members: |
| 0 | ||
| 1 | Security Descriptors | |
| 2 | ==================== | |
| 3 | ||
| 4 | .. module:: smb.security_descriptors | |
| 5 | :synopsis: Data structures used in Windows security descriptors. | |
| 6 | ||
| 7 | This module implements security descriptors, and associated data | |
| 8 | structures, as specified in `[MS-DTYP]`_. | |
| 9 | ||
| 10 | .. autoclass:: SID | |
| 11 | :members: | |
| 12 | ||
| 13 | .. autoclass:: ACE | |
| 14 | :members: | |
| 15 | ||
| 16 | .. autoclass:: ACL | |
| 17 | :members: | |
| 18 | ||
| 19 | .. autoclass:: SecurityDescriptor | |
| 20 | :members: | |
| 21 | ||
| 22 | .. _[MS-DTYP]: https://msdn.microsoft.com/en-us/library/cc230273.aspx |
| 0 | ||
| 1 | Security Descriptors | |
| 2 | ==================== | |
| 3 | ||
| 4 | .. module:: smb.security_descriptors | |
| 5 | :synopsis: Data structures used in Windows security descriptors. | |
| 6 | ||
| 7 | This module implements security descriptors, and associated data | |
| 8 | structures, as specified in `[MS-DTYP]`_. | |
| 9 | ||
| 10 | .. autoclass:: SID | |
| 11 | :members: | |
| 12 | ||
| 13 | .. autoclass:: ACE | |
| 14 | :members: | |
| 15 | ||
| 16 | .. autoclass:: ACL | |
| 17 | :members: | |
| 18 | ||
| 19 | .. autoclass:: SecurityDescriptor | |
| 20 | :members: | |
| 21 | ||
| 22 | .. _[MS-DTYP]: https://msdn.microsoft.com/en-us/library/cc230273.aspx |
| 0 | ||
| 1 | Extending pysmb For Other Frameworks | |
| 2 | ==================================== | |
| 3 | ||
| 4 | This page briefly describes the steps involved in extending pysmb for other frameworks. | |
| 5 | ||
| 6 | 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. | |
| 7 | 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, | |
| 8 | initiate file operations with the remote SMB/CIFS server. | |
| 9 | ||
| 10 | Now the above steps in more technical details: | |
| 11 | 1. Create a new class which subclasses the *smb.base.SMB* class. Most often, the connection setup will be part of the *__init__* method. | |
| 12 | 2. Override the *write(self, data)* method to provide an implementation which will write *data* to the socket. | |
| 13 | 3. Write your own loop handling method to read data from the socket. Once data have been read, call *feedData* method with the parameter. | |
| 14 | The *feedData* method has its own internal buffer, so it can accept incomplete NetBIOS session packet data. | |
| 15 | 4. Override | |
| 16 | ||
| 17 | * *onAuthOK* method to include your own operations to perform when authentication is successful. You can initiate file operations in this method. | |
| 18 | * *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). | |
| 19 | * *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. |
| 0 | Welcome to pysmb's documentation! | |
| 1 | ================================= | |
| 2 | ||
| 3 | pysmb is a pure Python implementation of the client-side SMB/CIFS protocol (SMB1 and SMB2) which is the underlying protocol | |
| 4 | that facilitates file sharing and printing between Windows machines, as well as with Linux machines via the Samba server application. | |
| 5 | pysmb is developed in Python 2.7.x and Python 3.8.x and has been tested against shared folders on Windows 7, Windows 10 and Samba 4.x. | |
| 6 | ||
| 7 | The latest version of pysmb is always available at the pysmb project page at `miketeo.net <http://miketeo.net/projects/pysmb>`_. | |
| 8 | ||
| 9 | License | |
| 10 | ------- | |
| 11 | pysmb itself is licensed under an opensource license. | |
| 12 | You are free to use pysmb in any applications, including for commercial purposes. | |
| 13 | For more details on the terms of use, please read the LICENSE file that comes with your pysmb source. | |
| 14 | ||
| 15 | pysmb depends on other 3rd-party modules whose terms of use are not covered by pysmb. | |
| 16 | Use of these modules could possibly conflict with your licensing needs. Please exercise your own discretion to determine their suitabilities. | |
| 17 | I have listed these modules in the following section. | |
| 18 | ||
| 19 | Credits | |
| 20 | ------- | |
| 21 | pysmb is not alone. It is made possible with support from other modules. | |
| 22 | ||
| 23 | * **pyasn1** : Pure Python implementation of ASN.1 parsing and encoding (not included together with pysmb; needs to be installed separately) | |
| 24 | * **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. | |
| 25 | * **pyDes** : Pure Python implementation of the DES encryption algorithm by Todd Whiteman. Free domain and included together with pysmb. | |
| 26 | * **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 | |
| 27 | the Python standard library (usually Python 2.4) does not provide the SHA-256 hash algorithm. | |
| 28 | ||
| 29 | In various places, there are references to different specifications. Most of these referenced specifications | |
| 30 | can be downloaded from Microsoft web site under Microsoft's "Open Specification Promise". If you need to download | |
| 31 | a copy of these specifications, please google for it. For example, google for "MS-CIFS" to download the CIFS specification for NT LM dialect. | |
| 32 | ||
| 33 | Package Contents and Description | |
| 34 | ================================ | |
| 35 | ||
| 36 | pysmb is organized into 2 main packages: smb and nmb. | |
| 37 | The smb package contains all the functionalities related to Server Message Block (SMB) implementation. | |
| 38 | As an application developer, you will be importing this module into your application. | |
| 39 | Hence, please take some time to familiarize yourself with the smb package contents. | |
| 40 | ||
| 41 | * **nmb/base.py** : | |
| 42 | Contains the NetBIOSSession and NBNS abstract class which implements NetBIOS session and NetBIOS Name Service communication | |
| 43 | without any network transport specifics. | |
| 44 | * **nmb/NetBIOS.py**: | |
| 45 | Provides a NBNS implementation to query IP addresses for machine names. All operations are blocking I/O. | |
| 46 | * **nmb/NetBIOSProtocol.py** : | |
| 47 | Provides the NBNS protocol implementation for use in Twisted framework. | |
| 48 | ||
| 49 | * **smb/base.py** : | |
| 50 | Contains the SMB abstract class which implements the SMB communication without any network transport specifics. | |
| 51 | * **smb/ntlm.py** : | |
| 52 | Contains the NTLMv1 and NTLMv2 authentication routines and the decoding/encoding of NTLM authentication messages within SMB messages. | |
| 53 | * **smb/securityblob.py** : | |
| 54 | Provides routines to encode/decode the NTLMSSP security blob in the SMB messages. | |
| 55 | * **smb/smb_constants.py** : | |
| 56 | All the constants used in the smb package for SMB1 protocol | |
| 57 | * **smb/smb_structs.py** : | |
| 58 | 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. | |
| 59 | * **smb/smb2_constants.py** : | |
| 60 | All the constants used in the smb package for SMB2 protocol | |
| 61 | * **smb/smb2_structs.py** : | |
| 62 | 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. | |
| 63 | * **smb/SMBConnection.py** : | |
| 64 | Contains a SMB protocol implementation. All operations are blocking I/O. | |
| 65 | * **smb/SMBProtocol.py** : | |
| 66 | Contains the SMB protocol implementation for use in the Twisted framework. | |
| 67 | * **smb/SMBHandler.py** : | |
| 68 | Provides support for "smb://" URL in the urllib2 python package. | |
| 69 | ||
| 70 | Using pysmb | |
| 71 | =========== | |
| 72 | ||
| 73 | As an application developer who is looking to use pysmb to translate NetBIOS names to IP addresses, | |
| 74 | * To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read | |
| 75 | :doc:`nmb.NetBIOS.NetBIOS<api/nmb_NetBIOS>` documentation. | |
| 76 | * To use pysmb in Twisted, please read :doc:`nmb.NetBIOSProtocol.NBNSProtocol<api/nmb_NBNSProtocol>` documentation. | |
| 77 | ||
| 78 | As an application developer who is looking to use pysmb to implement file transfer or authentication over SMB: | |
| 79 | * To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read | |
| 80 | :doc:`smb.SMBConnection.SMBConnection<api/smb_SMBConnection>` documentation. | |
| 81 | * To use pysmb in Twisted, please read :doc:`smb.SMBProtocol.SMBProtocolFactory<api/smb_SMBProtocolFactory>` documentation. | |
| 82 | * To support "smb://" URL in urllib2 python package, read :doc:`smb.SMBHandler.SMBHandler<api/smb_SMBHandler>` documentation. | |
| 83 | ||
| 84 | As a software developer who is looking to modify pysmb so that you can integrate it to other network frameworks: | |
| 85 | * Read :doc:`extending` | |
| 86 | ||
| 87 | If you are upgrading from older pysmb versions: | |
| 88 | * Read :doc:`upgrading` | |
| 89 | ||
| 90 | ||
| 91 | Indices and tables | |
| 92 | ================== | |
| 93 | ||
| 94 | .. toctree:: | |
| 95 | :glob: | |
| 96 | :maxdepth: 1 | |
| 97 | ||
| 98 | api/* | |
| 99 | extending | |
| 100 | upgrading | |
| 101 | ||
| 102 | * :ref:`genindex` | |
| 103 | * :ref:`search` |
| 7 | 7 | |
| 8 | 8 | pysmb is a pure Python implementation of the client-side SMB/CIFS protocol (SMB1 and SMB2) which is the underlying protocol |
| 9 | 9 | that facilitates file sharing and printing between Windows machines, as well as with Linux machines via the Samba server application. |
| 10 | 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. | |
| 10 | pysmb is developed in Python 2.7.x and Python 3.5.x and has been tested against shared folders on Windows XP SP3, Windows Vista, Windows 7 and Samba 3.x. | |
| 11 | 11 | |
| 12 | The latest version of pysmb is always available at the pysmb project page at `miketeo.net <http://miketeo.net/wp/index.php/projects/pysmb>`_. | |
| 12 | The latest version of pysmb is always available at the pysmb project page at `miketeo.net <http://miketeo.net/projects/pysmb>`_. | |
| 13 | 13 | |
| 14 | 14 | License |
| 15 | 15 | ------- |
| 89 | 89 | As a software developer who is looking to modify pysmb so that you can integrate it to other network frameworks: |
| 90 | 90 | * Read :doc:`extending` |
| 91 | 91 | |
| 92 | If you are upgrading from older pysmb versions: | |
| 93 | * Read :doc:`upgrading` | |
| 92 | 94 | |
| 93 | 95 | |
| 94 | 96 | Indices and tables |
| 100 | 102 | |
| 101 | 103 | api/* |
| 102 | 104 | extending |
| 105 | upgrading | |
| 103 | 106 | |
| 104 | 107 | * :ref:`genindex` |
| 105 | 108 | * :ref:`search` |
| 0 | Upgrading from older pysmb versions | |
| 1 | ==================================== | |
| 2 | ||
| 3 | This page documents the improvements and changes to the API that could be incompatible with previous releases. | |
| 4 | ||
| 5 | pysmb 1.2.0 | |
| 6 | ----------- | |
| 7 | - Add new `delete_matching_folders` parameter to `deleteFiles()` method in SMBProtocolFactory and SMBConnection | |
| 8 | class to support deletion of sub-folders. If you are passing timeout parameter to the `deleteFiles()` method | |
| 9 | in your application, please switch to using named parameter for timeout. | |
| 10 | ||
| 11 | pysmb 1.1.28 | |
| 12 | ------------ | |
| 13 | - SharedFile instances returned from the `listPath()` method now has a new property | |
| 14 | `file_id` attribute which represents the file reference number given by the remote SMB server. | |
| 15 | ||
| 16 | pysmb 1.1.26 | |
| 17 | ------------ | |
| 18 | - SMBConnection class can now be used as a context manager | |
| 19 | ||
| 20 | pysmb 1.1.25 | |
| 21 | ------------ | |
| 22 | - SharedFile class has a new property `isNormal` which will be True if the file is a | |
| 23 | 'normal' file. pysmb defines a 'normal' file as a file entry that is not | |
| 24 | read-only, not hidden, not system, not archive and not a directory; | |
| 25 | it ignores other attributes like compression, indexed, sparse, temporary and encryption. | |
| 26 | - `listPath()` method in SMBProtocolFactory and SMBConnection class will now include | |
| 27 | 'normal' files by default if you do not specify the `search` parameter. | |
| 28 | ||
| 29 | pysmb 1.1.20 | |
| 30 | ------------ | |
| 31 | - A new method `getSecurity()` was added to SMBConnection and SMBProtocolFactory class. | |
| 32 | ||
| 33 | pysmb 1.1.15 | |
| 34 | ------------ | |
| 35 | - Add new `truncate` parameter to `storeFileFromOffset()` in SMBProtocolFactory and SMBConnection | |
| 36 | class to support truncation of the file before writing. If you are passing timeout parameter | |
| 37 | to the `storeFileFromOffset()` method in your application, please switch to using named parameter for timeout. | |
| 38 | ||
| 39 | pysmb 1.1.11 | |
| 40 | ------------ | |
| 41 | - A new method `storeFileFromOffset()` was added to SMBConnection and SMBProtocolFactory class. | |
| 42 | ||
| 43 | pysmb 1.1.10 | |
| 44 | ------------ | |
| 45 | - A new method `getAttributes()` was added to SMBConnection and SMBProtocolFactory class | |
| 46 | - SharedFile class has a new property `isReadOnly` to indicate the file is read-only on the remote filesystem. | |
| 47 | ||
| 48 | pysmb 1.1.2 | |
| 49 | ----------- | |
| 50 | - `queryIPForName()` method in nmb.NetBIOS and nmb.NBNSProtocol class will now return only the server machine name and ignore workgroup names. | |
| 51 | ||
| 52 | pysmb 1.0.3 | |
| 53 | ----------- | |
| 54 | - Two new methods were added to NBNSProtocol class: `queryIPForName()` and `NetBIOS.queryIPForName()` | |
| 55 | to support querying for a machine's NetBIOS name at the given IP address. | |
| 56 | - A new method `retrieveFileFromOffset()` was added to SMBProtocolFactory and SMBConnection | |
| 57 | to support finer control of file retrieval operation. | |
| 58 | ||
| 59 | pysmb 1.0.0 | |
| 60 | ----------- | |
| 61 | pysmb was completely rewritten in version 1.0.0. | |
| 62 | If you are upgrading from pysmb 0.x, you most likely have to rewrite your application for the new 1.x API. |
| 0 | Upgrading from older pysmb versions | |
| 1 | ==================================== | |
| 2 | ||
| 3 | This page documents the improvements and changes to the API that could be incompatible with previous releases. | |
| 4 | ||
| 5 | pysmb 1.2.0 | |
| 6 | ----------- | |
| 7 | - Add new `delete_matching_folders` parameter to `deleteFiles()` method in SMBProtocolFactory and SMBConnection | |
| 8 | class to support deletion of sub-folders. If you are passing timeout parameter to the `deleteFiles()` method | |
| 9 | in your application, please switch to using named parameter for timeout. | |
| 10 | ||
| 11 | pysmb 1.1.28 | |
| 12 | ------------ | |
| 13 | - SharedFile instances returned from the `listPath()` method now has a new property | |
| 14 | `file_id` attribute which represents the file reference number given by the remote SMB server. | |
| 15 | ||
| 16 | pysmb 1.1.26 | |
| 17 | ------------ | |
| 18 | - SMBConnection class can now be used as a context manager | |
| 19 | ||
| 20 | pysmb 1.1.25 | |
| 21 | ------------ | |
| 22 | - SharedFile class has a new property `isNormal` which will be True if the file is a | |
| 23 | 'normal' file. pysmb defines a 'normal' file as a file entry that is not | |
| 24 | read-only, not hidden, not system, not archive and not a directory; | |
| 25 | it ignores other attributes like compression, indexed, sparse, temporary and encryption. | |
| 26 | - `listPath()` method in SMBProtocolFactory and SMBConnection class will now include | |
| 27 | 'normal' files by default if you do not specify the `search` parameter. | |
| 28 | ||
| 29 | pysmb 1.1.20 | |
| 30 | ------------ | |
| 31 | - A new method `getSecurity()` was added to SMBConnection and SMBProtocolFactory class. | |
| 32 | ||
| 33 | pysmb 1.1.15 | |
| 34 | ------------ | |
| 35 | - Add new `truncate` parameter to `storeFileFromOffset()` in SMBProtocolFactory and SMBConnection | |
| 36 | class to support truncation of the file before writing. If you are passing timeout parameter | |
| 37 | to the `storeFileFromOffset()` method in your application, please switch to using named parameter for timeout. | |
| 38 | ||
| 39 | pysmb 1.1.11 | |
| 40 | ------------ | |
| 41 | - A new method `storeFileFromOffset()` was added to SMBConnection and SMBProtocolFactory class. | |
| 42 | ||
| 43 | pysmb 1.1.10 | |
| 44 | ------------ | |
| 45 | - A new method `getAttributes()` was added to SMBConnection and SMBProtocolFactory class | |
| 46 | - SharedFile class has a new property `isReadOnly` to indicate the file is read-only on the remote filesystem. | |
| 47 | ||
| 48 | pysmb 1.1.2 | |
| 49 | ----------- | |
| 50 | - `queryIPForName()` method in nmb.NetBIOS and nmb.NBNSProtocol class will now return only the server machine name and ignore workgroup names. | |
| 51 | ||
| 52 | pysmb 1.0.3 | |
| 53 | ----------- | |
| 54 | - Two new methods were added to NBNSProtocol class: `queryIPForName()` and `NetBIOS.queryIPForName()` | |
| 55 | to support querying for a machine's NetBIOS name at the given IP address. | |
| 56 | - A new method `retrieveFileFromOffset()` was added to SMBProtocolFactory and SMBConnection | |
| 57 | to support finer control of file retrieval operation. | |
| 58 | ||
| 59 | pysmb 1.0.0 | |
| 60 | ----------- | |
| 61 | pysmb was completely rewritten in version 1.0.0. | |
| 62 | If you are upgrading from pysmb 0.x, you most likely have to rewrite your application for the new 1.x API. |
| 3 | 3 | * |
| 4 | 4 | * Sphinx stylesheet -- basic theme. |
| 5 | 5 | * |
| 6 | * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. | |
| 6 | * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. | |
| 7 | 7 | * :license: BSD, see LICENSE for details. |
| 8 | 8 | * |
| 9 | 9 | */ |
| 12 | 12 | |
| 13 | 13 | div.clearer { |
| 14 | 14 | clear: both; |
| 15 | } | |
| 16 | ||
| 17 | div.section::after { | |
| 18 | display: block; | |
| 19 | content: ''; | |
| 20 | clear: left; | |
| 15 | 21 | } |
| 16 | 22 | |
| 17 | 23 | /* -- relbar ---------------------------------------------------------------- */ |
| 51 | 57 | width: 230px; |
| 52 | 58 | margin-left: -100%; |
| 53 | 59 | font-size: 90%; |
| 60 | word-wrap: break-word; | |
| 61 | overflow-wrap : break-word; | |
| 54 | 62 | } |
| 55 | 63 | |
| 56 | 64 | div.sphinxsidebar ul { |
| 78 | 86 | font-size: 1em; |
| 79 | 87 | } |
| 80 | 88 | |
| 89 | div.sphinxsidebar #searchbox form.search { | |
| 90 | overflow: hidden; | |
| 91 | } | |
| 92 | ||
| 81 | 93 | div.sphinxsidebar #searchbox input[type="text"] { |
| 82 | width: 170px; | |
| 94 | float: left; | |
| 95 | width: 80%; | |
| 96 | padding: 0.25em; | |
| 97 | box-sizing: border-box; | |
| 83 | 98 | } |
| 84 | 99 | |
| 85 | 100 | div.sphinxsidebar #searchbox input[type="submit"] { |
| 86 | width: 30px; | |
| 87 | } | |
| 101 | float: left; | |
| 102 | width: 20%; | |
| 103 | border-left: none; | |
| 104 | padding: 0.25em; | |
| 105 | box-sizing: border-box; | |
| 106 | } | |
| 107 | ||
| 88 | 108 | |
| 89 | 109 | img { |
| 90 | 110 | border: 0; |
| 123 | 143 | |
| 124 | 144 | table.contentstable { |
| 125 | 145 | width: 90%; |
| 146 | margin-left: auto; | |
| 147 | margin-right: auto; | |
| 126 | 148 | } |
| 127 | 149 | |
| 128 | 150 | table.contentstable p.biglink { |
| 150 | 172 | vertical-align: top; |
| 151 | 173 | } |
| 152 | 174 | |
| 153 | table.indextable dl, table.indextable dd { | |
| 175 | table.indextable ul { | |
| 154 | 176 | margin-top: 0; |
| 155 | 177 | margin-bottom: 0; |
| 178 | list-style-type: none; | |
| 179 | } | |
| 180 | ||
| 181 | table.indextable > tbody > tr > td > ul { | |
| 182 | padding-left: 0em; | |
| 156 | 183 | } |
| 157 | 184 | |
| 158 | 185 | table.indextable tr.pcap { |
| 184 | 211 | padding: 0.4em; |
| 185 | 212 | } |
| 186 | 213 | |
| 214 | /* -- domain module index --------------------------------------------------- */ | |
| 215 | ||
| 216 | table.modindextable td { | |
| 217 | padding: 2px; | |
| 218 | border-collapse: collapse; | |
| 219 | } | |
| 220 | ||
| 187 | 221 | /* -- general body styles --------------------------------------------------- */ |
| 222 | ||
| 223 | div.body { | |
| 224 | min-width: 450px; | |
| 225 | max-width: 800px; | |
| 226 | } | |
| 227 | ||
| 228 | div.body p, div.body dd, div.body li, div.body blockquote { | |
| 229 | -moz-hyphens: auto; | |
| 230 | -ms-hyphens: auto; | |
| 231 | -webkit-hyphens: auto; | |
| 232 | hyphens: auto; | |
| 233 | } | |
| 188 | 234 | |
| 189 | 235 | a.headerlink { |
| 190 | 236 | visibility: hidden; |
| 237 | } | |
| 238 | ||
| 239 | a.brackets:before, | |
| 240 | span.brackets > a:before{ | |
| 241 | content: "["; | |
| 242 | } | |
| 243 | ||
| 244 | a.brackets:after, | |
| 245 | span.brackets > a:after { | |
| 246 | content: "]"; | |
| 191 | 247 | } |
| 192 | 248 | |
| 193 | 249 | h1:hover > a.headerlink, |
| 211 | 267 | text-align: left; |
| 212 | 268 | } |
| 213 | 269 | |
| 214 | .field-list ul { | |
| 215 | padding-left: 1em; | |
| 216 | } | |
| 217 | ||
| 218 | 270 | .first { |
| 219 | 271 | margin-top: 0 !important; |
| 220 | 272 | } |
| 242 | 294 | margin-right: auto; |
| 243 | 295 | } |
| 244 | 296 | |
| 297 | img.align-default, .figure.align-default { | |
| 298 | display: block; | |
| 299 | margin-left: auto; | |
| 300 | margin-right: auto; | |
| 301 | } | |
| 302 | ||
| 245 | 303 | .align-left { |
| 246 | 304 | text-align: left; |
| 247 | 305 | } |
| 248 | 306 | |
| 249 | 307 | .align-center { |
| 308 | text-align: center; | |
| 309 | } | |
| 310 | ||
| 311 | .align-default { | |
| 250 | 312 | text-align: center; |
| 251 | 313 | } |
| 252 | 314 | |
| 259 | 321 | div.sidebar { |
| 260 | 322 | margin: 0 0 0.5em 1em; |
| 261 | 323 | border: 1px solid #ddb; |
| 262 | padding: 7px 7px 0 7px; | |
| 324 | padding: 7px; | |
| 263 | 325 | background-color: #ffe; |
| 264 | 326 | width: 40%; |
| 265 | 327 | float: right; |
| 328 | clear: right; | |
| 329 | overflow-x: auto; | |
| 266 | 330 | } |
| 267 | 331 | |
| 268 | 332 | p.sidebar-title { |
| 269 | 333 | font-weight: bold; |
| 334 | } | |
| 335 | ||
| 336 | div.admonition, div.topic, blockquote { | |
| 337 | clear: left; | |
| 270 | 338 | } |
| 271 | 339 | |
| 272 | 340 | /* -- topics ---------------------------------------------------------------- */ |
| 273 | 341 | |
| 274 | 342 | div.topic { |
| 275 | 343 | border: 1px solid #ccc; |
| 276 | padding: 7px 7px 0 7px; | |
| 344 | padding: 7px; | |
| 277 | 345 | margin: 10px 0 10px 0; |
| 278 | 346 | } |
| 279 | 347 | |
| 295 | 363 | font-weight: bold; |
| 296 | 364 | } |
| 297 | 365 | |
| 298 | div.admonition dl { | |
| 299 | margin-bottom: 0; | |
| 300 | } | |
| 301 | ||
| 302 | 366 | p.admonition-title { |
| 303 | 367 | margin: 0px 10px 5px 0px; |
| 304 | 368 | font-weight: bold; |
| 309 | 373 | margin-top: 25px; |
| 310 | 374 | } |
| 311 | 375 | |
| 376 | /* -- content of sidebars/topics/admonitions -------------------------------- */ | |
| 377 | ||
| 378 | div.sidebar > :last-child, | |
| 379 | div.topic > :last-child, | |
| 380 | div.admonition > :last-child { | |
| 381 | margin-bottom: 0; | |
| 382 | } | |
| 383 | ||
| 384 | div.sidebar::after, | |
| 385 | div.topic::after, | |
| 386 | div.admonition::after, | |
| 387 | blockquote::after { | |
| 388 | display: block; | |
| 389 | content: ''; | |
| 390 | clear: both; | |
| 391 | } | |
| 392 | ||
| 312 | 393 | /* -- tables ---------------------------------------------------------------- */ |
| 313 | 394 | |
| 314 | 395 | table.docutils { |
| 396 | margin-top: 10px; | |
| 397 | margin-bottom: 10px; | |
| 315 | 398 | border: 0; |
| 316 | 399 | border-collapse: collapse; |
| 400 | } | |
| 401 | ||
| 402 | table.align-center { | |
| 403 | margin-left: auto; | |
| 404 | margin-right: auto; | |
| 405 | } | |
| 406 | ||
| 407 | table.align-default { | |
| 408 | margin-left: auto; | |
| 409 | margin-right: auto; | |
| 317 | 410 | } |
| 318 | 411 | |
| 319 | 412 | table caption span.caption-number { |
| 331 | 424 | border-bottom: 1px solid #aaa; |
| 332 | 425 | } |
| 333 | 426 | |
| 334 | table.field-list td, table.field-list th { | |
| 335 | border: 0 !important; | |
| 336 | } | |
| 337 | ||
| 338 | 427 | table.footnote td, table.footnote th { |
| 339 | 428 | border: 0 !important; |
| 340 | 429 | } |
| 353 | 442 | border-bottom: none; |
| 354 | 443 | } |
| 355 | 444 | |
| 445 | th > :first-child, | |
| 446 | td > :first-child { | |
| 447 | margin-top: 0px; | |
| 448 | } | |
| 449 | ||
| 450 | th > :last-child, | |
| 451 | td > :last-child { | |
| 452 | margin-bottom: 0px; | |
| 453 | } | |
| 454 | ||
| 356 | 455 | /* -- figures --------------------------------------------------------------- */ |
| 357 | 456 | |
| 358 | 457 | div.figure { |
| 371 | 470 | div.figure p.caption span.caption-text { |
| 372 | 471 | } |
| 373 | 472 | |
| 473 | /* -- field list styles ----------------------------------------------------- */ | |
| 474 | ||
| 475 | table.field-list td, table.field-list th { | |
| 476 | border: 0 !important; | |
| 477 | } | |
| 478 | ||
| 479 | .field-list ul { | |
| 480 | margin: 0; | |
| 481 | padding-left: 1em; | |
| 482 | } | |
| 483 | ||
| 484 | .field-list p { | |
| 485 | margin: 0; | |
| 486 | } | |
| 487 | ||
| 488 | .field-name { | |
| 489 | -moz-hyphens: manual; | |
| 490 | -ms-hyphens: manual; | |
| 491 | -webkit-hyphens: manual; | |
| 492 | hyphens: manual; | |
| 493 | } | |
| 494 | ||
| 495 | /* -- hlist styles ---------------------------------------------------------- */ | |
| 496 | ||
| 497 | table.hlist { | |
| 498 | margin: 1em 0; | |
| 499 | } | |
| 500 | ||
| 501 | table.hlist td { | |
| 502 | vertical-align: top; | |
| 503 | } | |
| 504 | ||
| 374 | 505 | |
| 375 | 506 | /* -- other body styles ----------------------------------------------------- */ |
| 376 | 507 | |
| 394 | 525 | list-style: upper-roman; |
| 395 | 526 | } |
| 396 | 527 | |
| 528 | :not(li) > ol > li:first-child > :first-child, | |
| 529 | :not(li) > ul > li:first-child > :first-child { | |
| 530 | margin-top: 0px; | |
| 531 | } | |
| 532 | ||
| 533 | :not(li) > ol > li:last-child > :last-child, | |
| 534 | :not(li) > ul > li:last-child > :last-child { | |
| 535 | margin-bottom: 0px; | |
| 536 | } | |
| 537 | ||
| 538 | ol.simple ol p, | |
| 539 | ol.simple ul p, | |
| 540 | ul.simple ol p, | |
| 541 | ul.simple ul p { | |
| 542 | margin-top: 0; | |
| 543 | } | |
| 544 | ||
| 545 | ol.simple > li:not(:first-child) > p, | |
| 546 | ul.simple > li:not(:first-child) > p { | |
| 547 | margin-top: 0; | |
| 548 | } | |
| 549 | ||
| 550 | ol.simple p, | |
| 551 | ul.simple p { | |
| 552 | margin-bottom: 0; | |
| 553 | } | |
| 554 | ||
| 555 | dl.footnote > dt, | |
| 556 | dl.citation > dt { | |
| 557 | float: left; | |
| 558 | margin-right: 0.5em; | |
| 559 | } | |
| 560 | ||
| 561 | dl.footnote > dd, | |
| 562 | dl.citation > dd { | |
| 563 | margin-bottom: 0em; | |
| 564 | } | |
| 565 | ||
| 566 | dl.footnote > dd:after, | |
| 567 | dl.citation > dd:after { | |
| 568 | content: ""; | |
| 569 | clear: both; | |
| 570 | } | |
| 571 | ||
| 572 | dl.field-list { | |
| 573 | display: grid; | |
| 574 | grid-template-columns: fit-content(30%) auto; | |
| 575 | } | |
| 576 | ||
| 577 | dl.field-list > dt { | |
| 578 | font-weight: bold; | |
| 579 | word-break: break-word; | |
| 580 | padding-left: 0.5em; | |
| 581 | padding-right: 5px; | |
| 582 | } | |
| 583 | ||
| 584 | dl.field-list > dt:after { | |
| 585 | content: ":"; | |
| 586 | } | |
| 587 | ||
| 588 | dl.field-list > dd { | |
| 589 | padding-left: 0.5em; | |
| 590 | margin-top: 0em; | |
| 591 | margin-left: 0em; | |
| 592 | margin-bottom: 0em; | |
| 593 | } | |
| 594 | ||
| 397 | 595 | dl { |
| 398 | 596 | margin-bottom: 15px; |
| 399 | 597 | } |
| 400 | 598 | |
| 401 | dd p { | |
| 599 | dd > :first-child { | |
| 402 | 600 | margin-top: 0px; |
| 403 | 601 | } |
| 404 | 602 | |
| 412 | 610 | margin-left: 30px; |
| 413 | 611 | } |
| 414 | 612 | |
| 415 | dt:target, .highlighted { | |
| 613 | dl > dd:last-child, | |
| 614 | dl > dd:last-child > :last-child { | |
| 615 | margin-bottom: 0; | |
| 616 | } | |
| 617 | ||
| 618 | dt:target, span.highlighted { | |
| 416 | 619 | background-color: #fbe54e; |
| 417 | 620 | } |
| 418 | 621 | |
| 622 | rect.highlighted { | |
| 623 | fill: #fbe54e; | |
| 624 | } | |
| 625 | ||
| 419 | 626 | dl.glossary dt { |
| 420 | 627 | font-weight: bold; |
| 421 | 628 | font-size: 1.1em; |
| 422 | } | |
| 423 | ||
| 424 | .field-list ul { | |
| 425 | margin: 0; | |
| 426 | padding-left: 1em; | |
| 427 | } | |
| 428 | ||
| 429 | .field-list p { | |
| 430 | margin: 0; | |
| 431 | 629 | } |
| 432 | 630 | |
| 433 | 631 | .optional { |
| 476 | 674 | font-style: oblique; |
| 477 | 675 | } |
| 478 | 676 | |
| 677 | .classifier:before { | |
| 678 | font-style: normal; | |
| 679 | margin: 0.5em; | |
| 680 | content: ":"; | |
| 681 | } | |
| 682 | ||
| 479 | 683 | abbr, acronym { |
| 480 | 684 | border-bottom: dotted 1px; |
| 481 | 685 | cursor: help; |
| 488 | 692 | overflow-y: hidden; /* fixes display issues on Chrome browsers */ |
| 489 | 693 | } |
| 490 | 694 | |
| 695 | pre, div[class*="highlight-"] { | |
| 696 | clear: both; | |
| 697 | } | |
| 698 | ||
| 699 | span.pre { | |
| 700 | -moz-hyphens: none; | |
| 701 | -ms-hyphens: none; | |
| 702 | -webkit-hyphens: none; | |
| 703 | hyphens: none; | |
| 704 | } | |
| 705 | ||
| 706 | div[class*="highlight-"] { | |
| 707 | margin: 1em 0; | |
| 708 | } | |
| 709 | ||
| 491 | 710 | td.linenos pre { |
| 492 | padding: 5px 0px; | |
| 493 | 711 | border: 0; |
| 494 | 712 | background-color: transparent; |
| 495 | 713 | color: #aaa; |
| 496 | 714 | } |
| 497 | 715 | |
| 498 | 716 | table.highlighttable { |
| 499 | margin-left: 0.5em; | |
| 717 | display: block; | |
| 718 | } | |
| 719 | ||
| 720 | table.highlighttable tbody { | |
| 721 | display: block; | |
| 722 | } | |
| 723 | ||
| 724 | table.highlighttable tr { | |
| 725 | display: flex; | |
| 500 | 726 | } |
| 501 | 727 | |
| 502 | 728 | table.highlighttable td { |
| 503 | padding: 0 0.5em 0 0.5em; | |
| 729 | margin: 0; | |
| 730 | padding: 0; | |
| 731 | } | |
| 732 | ||
| 733 | table.highlighttable td.linenos { | |
| 734 | padding-right: 0.5em; | |
| 735 | } | |
| 736 | ||
| 737 | table.highlighttable td.code { | |
| 738 | flex: 1; | |
| 739 | overflow: hidden; | |
| 740 | } | |
| 741 | ||
| 742 | .highlight .hll { | |
| 743 | display: block; | |
| 744 | } | |
| 745 | ||
| 746 | div.highlight pre, | |
| 747 | table.highlighttable pre { | |
| 748 | margin: 0; | |
| 749 | } | |
| 750 | ||
| 751 | div.code-block-caption + div { | |
| 752 | margin-top: 0; | |
| 504 | 753 | } |
| 505 | 754 | |
| 506 | 755 | div.code-block-caption { |
| 756 | margin-top: 1em; | |
| 507 | 757 | padding: 2px 5px; |
| 508 | 758 | font-size: small; |
| 509 | 759 | } |
| 512 | 762 | background-color: transparent; |
| 513 | 763 | } |
| 514 | 764 | |
| 515 | div.code-block-caption + div > div.highlight > pre { | |
| 516 | margin-top: 0; | |
| 765 | table.highlighttable td.linenos, | |
| 766 | span.linenos, | |
| 767 | div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ | |
| 768 | user-select: none; | |
| 517 | 769 | } |
| 518 | 770 | |
| 519 | 771 | div.code-block-caption span.caption-number { |
| 525 | 777 | } |
| 526 | 778 | |
| 527 | 779 | div.literal-block-wrapper { |
| 528 | padding: 1em 1em 0; | |
| 529 | } | |
| 530 | ||
| 531 | div.literal-block-wrapper div.highlight { | |
| 532 | margin: 0; | |
| 780 | margin: 1em 0; | |
| 533 | 781 | } |
| 534 | 782 | |
| 535 | 783 | code.descname { |
| 577 | 825 | |
| 578 | 826 | span.eqno { |
| 579 | 827 | float: right; |
| 828 | } | |
| 829 | ||
| 830 | span.eqno a.headerlink { | |
| 831 | position: absolute; | |
| 832 | z-index: 1; | |
| 833 | } | |
| 834 | ||
| 835 | div.math:hover a.headerlink { | |
| 836 | visibility: visible; | |
| 580 | 837 | } |
| 581 | 838 | |
| 582 | 839 | /* -- printout stylesheet --------------------------------------------------- */ |
Binary diff not shown
| 3 | 3 | * |
| 4 | 4 | * Sphinx JavaScript utilities for all documentation. |
| 5 | 5 | * |
| 6 | * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. | |
| 6 | * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. | |
| 7 | 7 | * :license: BSD, see LICENSE for details. |
| 8 | 8 | * |
| 9 | 9 | */ |
| 44 | 44 | * it will always return arrays of strings for the value parts. |
| 45 | 45 | */ |
| 46 | 46 | jQuery.getQueryParameters = function(s) { |
| 47 | if (typeof s == 'undefined') | |
| 47 | if (typeof s === 'undefined') | |
| 48 | 48 | s = document.location.search; |
| 49 | 49 | var parts = s.substr(s.indexOf('?') + 1).split('&'); |
| 50 | 50 | var result = {}; |
| 65 | 65 | * span elements with the given class name. |
| 66 | 66 | */ |
| 67 | 67 | jQuery.fn.highlightText = function(text, className) { |
| 68 | function highlight(node) { | |
| 69 | if (node.nodeType == 3) { | |
| 68 | function highlight(node, addItems) { | |
| 69 | if (node.nodeType === 3) { | |
| 70 | 70 | var val = node.nodeValue; |
| 71 | 71 | var pos = val.toLowerCase().indexOf(text); |
| 72 | if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { | |
| 73 | var span = document.createElement("span"); | |
| 74 | span.className = className; | |
| 72 | if (pos >= 0 && | |
| 73 | !jQuery(node.parentNode).hasClass(className) && | |
| 74 | !jQuery(node.parentNode).hasClass("nohighlight")) { | |
| 75 | var span; | |
| 76 | var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); | |
| 77 | if (isInSVG) { | |
| 78 | span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); | |
| 79 | } else { | |
| 80 | span = document.createElement("span"); | |
| 81 | span.className = className; | |
| 82 | } | |
| 75 | 83 | span.appendChild(document.createTextNode(val.substr(pos, text.length))); |
| 76 | 84 | node.parentNode.insertBefore(span, node.parentNode.insertBefore( |
| 77 | 85 | document.createTextNode(val.substr(pos + text.length)), |
| 78 | 86 | node.nextSibling)); |
| 79 | 87 | node.nodeValue = val.substr(0, pos); |
| 88 | if (isInSVG) { | |
| 89 | var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); | |
| 90 | var bbox = node.parentElement.getBBox(); | |
| 91 | rect.x.baseVal.value = bbox.x; | |
| 92 | rect.y.baseVal.value = bbox.y; | |
| 93 | rect.width.baseVal.value = bbox.width; | |
| 94 | rect.height.baseVal.value = bbox.height; | |
| 95 | rect.setAttribute('class', className); | |
| 96 | addItems.push({ | |
| 97 | "parent": node.parentNode, | |
| 98 | "target": rect}); | |
| 99 | } | |
| 80 | 100 | } |
| 81 | 101 | } |
| 82 | 102 | else if (!jQuery(node).is("button, select, textarea")) { |
| 83 | 103 | jQuery.each(node.childNodes, function() { |
| 84 | highlight(this); | |
| 104 | highlight(this, addItems); | |
| 85 | 105 | }); |
| 86 | 106 | } |
| 87 | 107 | } |
| 88 | return this.each(function() { | |
| 89 | highlight(this); | |
| 108 | var addItems = []; | |
| 109 | var result = this.each(function() { | |
| 110 | highlight(this, addItems); | |
| 90 | 111 | }); |
| 112 | for (var i = 0; i < addItems.length; ++i) { | |
| 113 | jQuery(addItems[i].parent).before(addItems[i].target); | |
| 114 | } | |
| 115 | return result; | |
| 91 | 116 | }; |
| 92 | 117 | |
| 93 | 118 | /* |
| 123 | 148 | this.fixFirefoxAnchorBug(); |
| 124 | 149 | this.highlightSearchWords(); |
| 125 | 150 | this.initIndexTable(); |
| 151 | if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { | |
| 152 | this.initOnKeyListeners(); | |
| 153 | } | |
| 126 | 154 | }, |
| 127 | 155 | |
| 128 | 156 | /** |
| 129 | 157 | * i18n support |
| 130 | 158 | */ |
| 131 | 159 | TRANSLATIONS : {}, |
| 132 | PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, | |
| 160 | PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, | |
| 133 | 161 | LOCALE : 'unknown', |
| 134 | 162 | |
| 135 | 163 | // gettext and ngettext don't access this so that the functions |
| 136 | 164 | // can safely bound to a different name (_ = Documentation.gettext) |
| 137 | 165 | gettext : function(string) { |
| 138 | 166 | var translated = Documentation.TRANSLATIONS[string]; |
| 139 | if (typeof translated == 'undefined') | |
| 167 | if (typeof translated === 'undefined') | |
| 140 | 168 | return string; |
| 141 | return (typeof translated == 'string') ? translated : translated[0]; | |
| 169 | return (typeof translated === 'string') ? translated : translated[0]; | |
| 142 | 170 | }, |
| 143 | 171 | |
| 144 | 172 | ngettext : function(singular, plural, n) { |
| 145 | 173 | var translated = Documentation.TRANSLATIONS[singular]; |
| 146 | if (typeof translated == 'undefined') | |
| 174 | if (typeof translated === 'undefined') | |
| 147 | 175 | return (n == 1) ? singular : plural; |
| 148 | 176 | return translated[Documentation.PLURALEXPR(n)]; |
| 149 | 177 | }, |
| 178 | 206 | * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 |
| 179 | 207 | */ |
| 180 | 208 | fixFirefoxAnchorBug : function() { |
| 181 | if (document.location.hash) | |
| 209 | if (document.location.hash && $.browser.mozilla) | |
| 182 | 210 | window.setTimeout(function() { |
| 183 | 211 | document.location.href += ''; |
| 184 | 212 | }, 10); |
| 214 | 242 | var src = $(this).attr('src'); |
| 215 | 243 | var idnum = $(this).attr('id').substr(7); |
| 216 | 244 | $('tr.cg-' + idnum).toggle(); |
| 217 | if (src.substr(-9) == 'minus.png') | |
| 245 | if (src.substr(-9) === 'minus.png') | |
| 218 | 246 | $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); |
| 219 | 247 | else |
| 220 | 248 | $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); |
| 246 | 274 | var path = document.location.pathname; |
| 247 | 275 | var parts = path.split(/\//); |
| 248 | 276 | $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { |
| 249 | if (this == '..') | |
| 277 | if (this === '..') | |
| 250 | 278 | parts.pop(); |
| 251 | 279 | }); |
| 252 | 280 | var url = parts.join('/'); |
| 253 | 281 | return path.substring(url.lastIndexOf('/') + 1, path.length - 1); |
| 282 | }, | |
| 283 | ||
| 284 | initOnKeyListeners: function() { | |
| 285 | $(document).keydown(function(event) { | |
| 286 | var activeElementType = document.activeElement.tagName; | |
| 287 | // don't navigate when in search box, textarea, dropdown or button | |
| 288 | if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' | |
| 289 | && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey | |
| 290 | && !event.shiftKey) { | |
| 291 | switch (event.keyCode) { | |
| 292 | case 37: // left | |
| 293 | var prevHref = $('link[rel="prev"]').prop('href'); | |
| 294 | if (prevHref) { | |
| 295 | window.location.href = prevHref; | |
| 296 | return false; | |
| 297 | } | |
| 298 | case 39: // right | |
| 299 | var nextHref = $('link[rel="next"]').prop('href'); | |
| 300 | if (nextHref) { | |
| 301 | window.location.href = nextHref; | |
| 302 | return false; | |
| 303 | } | |
| 304 | } | |
| 305 | } | |
| 306 | }); | |
| 254 | 307 | } |
| 255 | 308 | }; |
| 256 | 309 | |
| 0 | var DOCUMENTATION_OPTIONS = { | |
| 1 | URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), | |
| 2 | VERSION: '1.2.7', | |
| 3 | LANGUAGE: 'None', | |
| 4 | COLLAPSE_INDEX: false, | |
| 5 | BUILDER: 'html', | |
| 6 | FILE_SUFFIX: '.html', | |
| 7 | LINK_SUFFIX: '.html', | |
| 8 | HAS_SOURCE: true, | |
| 9 | SOURCELINK_SUFFIX: '.txt', | |
| 10 | NAVIGATION_WITH_KEYS: false | |
| 11 | };⏎ |
Binary diff not shown
| 0 | /*! | |
| 1 | * jQuery JavaScript Library v3.5.1 | |
| 2 | * https://jquery.com/ | |
| 3 | * | |
| 4 | * Includes Sizzle.js | |
| 5 | * https://sizzlejs.com/ | |
| 6 | * | |
| 7 | * Copyright JS Foundation and other contributors | |
| 8 | * Released under the MIT license | |
| 9 | * https://jquery.org/license | |
| 10 | * | |
| 11 | * Date: 2020-05-04T22:49Z | |
| 12 | */ | |
| 13 | ( function( global, factory ) { | |
| 14 | ||
| 15 | "use strict"; | |
| 16 | ||
| 17 | if ( typeof module === "object" && typeof module.exports === "object" ) { | |
| 18 | ||
| 19 | // For CommonJS and CommonJS-like environments where a proper `window` | |
| 20 | // is present, execute the factory and get jQuery. | |
| 21 | // For environments that do not have a `window` with a `document` | |
| 22 | // (such as Node.js), expose a factory as module.exports. | |
| 23 | // This accentuates the need for the creation of a real `window`. | |
| 24 | // e.g. var jQuery = require("jquery")(window); | |
| 25 | // See ticket #14549 for more info. | |
| 26 | module.exports = global.document ? | |
| 27 | factory( global, true ) : | |
| 28 | function( w ) { | |
| 29 | if ( !w.document ) { | |
| 30 | throw new Error( "jQuery requires a window with a document" ); | |
| 31 | } | |
| 32 | return factory( w ); | |
| 33 | }; | |
| 34 | } else { | |
| 35 | factory( global ); | |
| 36 | } | |
| 37 | ||
| 38 | // Pass this if window is not defined yet | |
| 39 | } )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { | |
| 40 | ||
| 41 | // Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 | |
| 42 | // throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode | |
| 43 | // arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common | |
| 44 | // enough that all such attempts are guarded in a try block. | |
| 45 | "use strict"; | |
| 46 | ||
| 47 | var arr = []; | |
| 48 | ||
| 49 | var getProto = Object.getPrototypeOf; | |
| 50 | ||
| 51 | var slice = arr.slice; | |
| 52 | ||
| 53 | var flat = arr.flat ? function( array ) { | |
| 54 | return arr.flat.call( array ); | |
| 55 | } : function( array ) { | |
| 56 | return arr.concat.apply( [], array ); | |
| 57 | }; | |
| 58 | ||
| 59 | ||
| 60 | var push = arr.push; | |
| 61 | ||
| 62 | var indexOf = arr.indexOf; | |
| 63 | ||
| 64 | var class2type = {}; | |
| 65 | ||
| 66 | var toString = class2type.toString; | |
| 67 | ||
| 68 | var hasOwn = class2type.hasOwnProperty; | |
| 69 | ||
| 70 | var fnToString = hasOwn.toString; | |
| 71 | ||
| 72 | var ObjectFunctionString = fnToString.call( Object ); | |
| 73 | ||
| 74 | var support = {}; | |
| 75 | ||
| 76 | var isFunction = function isFunction( obj ) { | |
| 77 | ||
| 78 | // Support: Chrome <=57, Firefox <=52 | |
| 79 | // In some browsers, typeof returns "function" for HTML <object> elements | |
| 80 | // (i.e., `typeof document.createElement( "object" ) === "function"`). | |
| 81 | // We don't want to classify *any* DOM node as a function. | |
| 82 | return typeof obj === "function" && typeof obj.nodeType !== "number"; | |
| 83 | }; | |
| 84 | ||
| 85 | ||
| 86 | var isWindow = function isWindow( obj ) { | |
| 87 | return obj != null && obj === obj.window; | |
| 88 | }; | |
| 89 | ||
| 90 | ||
| 91 | var document = window.document; | |
| 92 | ||
| 93 | ||
| 94 | ||
| 95 | var preservedScriptAttributes = { | |
| 96 | type: true, | |
| 97 | src: true, | |
| 98 | nonce: true, | |
| 99 | noModule: true | |
| 100 | }; | |
| 101 | ||
| 102 | function DOMEval( code, node, doc ) { | |
| 103 | doc = doc || document; | |
| 104 | ||
| 105 | var i, val, | |
| 106 | script = doc.createElement( "script" ); | |
| 107 | ||
| 108 | script.text = code; | |
| 109 | if ( node ) { | |
| 110 | for ( i in preservedScriptAttributes ) { | |
| 111 | ||
| 112 | // Support: Firefox 64+, Edge 18+ | |
| 113 | // Some browsers don't support the "nonce" property on scripts. | |
| 114 | // On the other hand, just using `getAttribute` is not enough as | |
| 115 | // the `nonce` attribute is reset to an empty string whenever it | |
| 116 | // becomes browsing-context connected. | |
| 117 | // See https://github.com/whatwg/html/issues/2369 | |
| 118 | // See https://html.spec.whatwg.org/#nonce-attributes | |
| 119 | // The `node.getAttribute` check was added for the sake of | |
| 120 | // `jQuery.globalEval` so that it can fake a nonce-containing node | |
| 121 | // via an object. | |
| 122 | val = node[ i ] || node.getAttribute && node.getAttribute( i ); | |
| 123 | if ( val ) { | |
| 124 | script.setAttribute( i, val ); | |
| 125 | } | |
| 126 | } | |
| 127 | } | |
| 128 | doc.head.appendChild( script ).parentNode.removeChild( script ); | |
| 129 | } | |
| 130 | ||
| 131 | ||
| 132 | function toType( obj ) { | |
| 133 | if ( obj == null ) { | |
| 134 | return obj + ""; | |
| 135 | } | |
| 136 | ||
| 137 | // Support: Android <=2.3 only (functionish RegExp) | |
| 138 | return typeof obj === "object" || typeof obj === "function" ? | |
| 139 | class2type[ toString.call( obj ) ] || "object" : | |
| 140 | typeof obj; | |
| 141 | } | |
| 142 | /* global Symbol */ | |
| 143 | // Defining this global in .eslintrc.json would create a danger of using the global | |
| 144 | // unguarded in another place, it seems safer to define global only for this module | |
| 145 | ||
| 146 | ||
| 147 | ||
| 148 | var | |
| 149 | version = "3.5.1", | |
| 150 | ||
| 151 | // Define a local copy of jQuery | |
| 152 | jQuery = function( selector, context ) { | |
| 153 | ||
| 154 | // The jQuery object is actually just the init constructor 'enhanced' | |
| 155 | // Need init if jQuery is called (just allow error to be thrown if not included) | |
| 156 | return new jQuery.fn.init( selector, context ); | |
| 157 | }; | |
| 158 | ||
| 159 | jQuery.fn = jQuery.prototype = { | |
| 160 | ||
| 161 | // The current version of jQuery being used | |
| 162 | jquery: version, | |
| 163 | ||
| 164 | constructor: jQuery, | |
| 165 | ||
| 166 | // The default length of a jQuery object is 0 | |
| 167 | length: 0, | |
| 168 | ||
| 169 | toArray: function() { | |
| 170 | return slice.call( this ); | |
| 171 | }, | |
| 172 | ||
| 173 | // Get the Nth element in the matched element set OR | |
| 174 | // Get the whole matched element set as a clean array | |
| 175 | get: function( num ) { | |
| 176 | ||
| 177 | // Return all the elements in a clean array | |
| 178 | if ( num == null ) { | |
| 179 | return slice.call( this ); | |
| 180 | } | |
| 181 | ||
| 182 | // Return just the one element from the set | |
| 183 | return num < 0 ? this[ num + this.length ] : this[ num ]; | |
| 184 | }, | |
| 185 | ||
| 186 | // Take an array of elements and push it onto the stack | |
| 187 | // (returning the new matched element set) | |
| 188 | pushStack: function( elems ) { | |
| 189 | ||
| 190 | // Build a new jQuery matched element set | |
| 191 | var ret = jQuery.merge( this.constructor(), elems ); | |
| 192 | ||
| 193 | // Add the old object onto the stack (as a reference) | |
| 194 | ret.prevObject = this; | |
| 195 | ||
| 196 | // Return the newly-formed element set | |
| 197 | return ret; | |
| 198 | }, | |
| 199 | ||
| 200 | // Execute a callback for every element in the matched set. | |
| 201 | each: function( callback ) { | |
| 202 | return jQuery.each( this, callback ); | |
| 203 | }, | |
| 204 | ||
| 205 | map: function( callback ) { | |
| 206 | return this.pushStack( jQuery.map( this, function( elem, i ) { | |
| 207 | return callback.call( elem, i, elem ); | |
| 208 | } ) ); | |
| 209 | }, | |
| 210 | ||
| 211 | slice: function() { | |
| 212 | return this.pushStack( slice.apply( this, arguments ) ); | |
| 213 | }, | |
| 214 | ||
| 215 | first: function() { | |
| 216 | return this.eq( 0 ); | |
| 217 | }, | |
| 218 | ||
| 219 | last: function() { | |
| 220 | return this.eq( -1 ); | |
| 221 | }, | |
| 222 | ||
| 223 | even: function() { | |
| 224 | return this.pushStack( jQuery.grep( this, function( _elem, i ) { | |
| 225 | return ( i + 1 ) % 2; | |
| 226 | } ) ); | |
| 227 | }, | |
| 228 | ||
| 229 | odd: function() { | |
| 230 | return this.pushStack( jQuery.grep( this, function( _elem, i ) { | |
| 231 | return i % 2; | |
| 232 | } ) ); | |
| 233 | }, | |
| 234 | ||
| 235 | eq: function( i ) { | |
| 236 | var len = this.length, | |
| 237 | j = +i + ( i < 0 ? len : 0 ); | |
| 238 | return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); | |
| 239 | }, | |
| 240 | ||
| 241 | end: function() { | |
| 242 | return this.prevObject || this.constructor(); | |
| 243 | }, | |
| 244 | ||
| 245 | // For internal use only. | |
| 246 | // Behaves like an Array's method, not like a jQuery method. | |
| 247 | push: push, | |
| 248 | sort: arr.sort, | |
| 249 | splice: arr.splice | |
| 250 | }; | |
| 251 | ||
| 252 | jQuery.extend = jQuery.fn.extend = function() { | |
| 253 | var options, name, src, copy, copyIsArray, clone, | |
| 254 | target = arguments[ 0 ] || {}, | |
| 255 | i = 1, | |
| 256 | length = arguments.length, | |
| 257 | deep = false; | |
| 258 | ||
| 259 | // Handle a deep copy situation | |
| 260 | if ( typeof target === "boolean" ) { | |
| 261 | deep = target; | |
| 262 | ||
| 263 | // Skip the boolean and the target | |
| 264 | target = arguments[ i ] || {}; | |
| 265 | i++; | |
| 266 | } | |
| 267 | ||
| 268 | // Handle case when target is a string or something (possible in deep copy) | |
| 269 | if ( typeof target !== "object" && !isFunction( target ) ) { | |
| 270 | target = {}; | |
| 271 | } | |
| 272 | ||
| 273 | // Extend jQuery itself if only one argument is passed | |
| 274 | if ( i === length ) { | |
| 275 | target = this; | |
| 276 | i--; | |
| 277 | } | |
| 278 | ||
| 279 | for ( ; i < length; i++ ) { | |
| 280 | ||
| 281 | // Only deal with non-null/undefined values | |
| 282 | if ( ( options = arguments[ i ] ) != null ) { | |
| 283 | ||
| 284 | // Extend the base object | |
| 285 | for ( name in options ) { | |
| 286 | copy = options[ name ]; | |
| 287 | ||
| 288 | // Prevent Object.prototype pollution | |
| 289 | // Prevent never-ending loop | |
| 290 | if ( name === "__proto__" || target === copy ) { | |
| 291 | continue; | |
| 292 | } | |
| 293 | ||
| 294 | // Recurse if we're merging plain objects or arrays | |
| 295 | if ( deep && copy && ( jQuery.isPlainObject( copy ) || | |
| 296 | ( copyIsArray = Array.isArray( copy ) ) ) ) { | |
| 297 | src = target[ name ]; | |
| 298 | ||
| 299 | // Ensure proper type for the source value | |
| 300 | if ( copyIsArray && !Array.isArray( src ) ) { | |
| 301 | clone = []; | |
| 302 | } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { | |
| 303 | clone = {}; | |
| 304 | } else { | |
| 305 | clone = src; | |
| 306 | } | |
| 307 | copyIsArray = false; | |
| 308 | ||
| 309 | // Never move original objects, clone them | |
| 310 | target[ name ] = jQuery.extend( deep, clone, copy ); | |
| 311 | ||
| 312 | // Don't bring in undefined values | |
| 313 | } else if ( copy !== undefined ) { | |
| 314 | target[ name ] = copy; | |
| 315 | } | |
| 316 | } | |
| 317 | } | |
| 318 | } | |
| 319 | ||
| 320 | // Return the modified object | |
| 321 | return target; | |
| 322 | }; | |
| 323 | ||
| 324 | jQuery.extend( { | |
| 325 | ||
| 326 | // Unique for each copy of jQuery on the page | |
| 327 | expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), | |
| 328 | ||
| 329 | // Assume jQuery is ready without the ready module | |
| 330 | isReady: true, | |
| 331 | ||
| 332 | error: function( msg ) { | |
| 333 | throw new Error( msg ); | |
| 334 | }, | |
| 335 | ||
| 336 | noop: function() {}, | |
| 337 | ||
| 338 | isPlainObject: function( obj ) { | |
| 339 | var proto, Ctor; | |
| 340 | ||
| 341 | // Detect obvious negatives | |
| 342 | // Use toString instead of jQuery.type to catch host objects | |
| 343 | if ( !obj || toString.call( obj ) !== "[object Object]" ) { | |
| 344 | return false; | |
| 345 | } | |
| 346 | ||
| 347 | proto = getProto( obj ); | |
| 348 | ||
| 349 | // Objects with no prototype (e.g., `Object.create( null )`) are plain | |
| 350 | if ( !proto ) { | |
| 351 | return true; | |
| 352 | } | |
| 353 | ||
| 354 | // Objects with prototype are plain iff they were constructed by a global Object function | |
| 355 | Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; | |
| 356 | return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; | |
| 357 | }, | |
| 358 | ||
| 359 | isEmptyObject: function( obj ) { | |
| 360 | var name; | |
| 361 | ||
| 362 | for ( name in obj ) { | |
| 363 | return false; | |
| 364 | } | |
| 365 | return true; | |
| 366 | }, | |
| 367 | ||
| 368 | // Evaluates a script in a provided context; falls back to the global one | |
| 369 | // if not specified. | |
| 370 | globalEval: function( code, options, doc ) { | |
| 371 | DOMEval( code, { nonce: options && options.nonce }, doc ); | |
| 372 | }, | |
| 373 | ||
| 374 | each: function( obj, callback ) { | |
| 375 | var length, i = 0; | |
| 376 | ||
| 377 | if ( isArrayLike( obj ) ) { | |
| 378 | length = obj.length; | |
| 379 | for ( ; i < length; i++ ) { | |
| 380 | if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { | |
| 381 | break; | |
| 382 | } | |
| 383 | } | |
| 384 | } else { | |
| 385 | for ( i in obj ) { | |
| 386 | if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { | |
| 387 | break; | |
| 388 | } | |
| 389 | } | |
| 390 | } | |
| 391 | ||
| 392 | return obj; | |
| 393 | }, | |
| 394 | ||
| 395 | // results is for internal usage only | |
| 396 | makeArray: function( arr, results ) { | |
| 397 | var ret = results || []; | |
| 398 | ||
| 399 | if ( arr != null ) { | |
| 400 | if ( isArrayLike( Object( arr ) ) ) { | |
| 401 | jQuery.merge( ret, | |
| 402 | typeof arr === "string" ? | |
| 403 | [ arr ] : arr | |
| 404 | ); | |
| 405 | } else { | |
| 406 | push.call( ret, arr ); | |
| 407 | } | |
| 408 | } | |
| 409 | ||
| 410 | return ret; | |
| 411 | }, | |
| 412 | ||
| 413 | inArray: function( elem, arr, i ) { | |
| 414 | return arr == null ? -1 : indexOf.call( arr, elem, i ); | |
| 415 | }, | |
| 416 | ||
| 417 | // Support: Android <=4.0 only, PhantomJS 1 only | |
| 418 | // push.apply(_, arraylike) throws on ancient WebKit | |
| 419 | merge: function( first, second ) { | |
| 420 | var len = +second.length, | |
| 421 | j = 0, | |
| 422 | i = first.length; | |
| 423 | ||
| 424 | for ( ; j < len; j++ ) { | |
| 425 | first[ i++ ] = second[ j ]; | |
| 426 | } | |
| 427 | ||
| 428 | first.length = i; | |
| 429 | ||
| 430 | return first; | |
| 431 | }, | |
| 432 | ||
| 433 | grep: function( elems, callback, invert ) { | |
| 434 | var callbackInverse, | |
| 435 | matches = [], | |
| 436 | i = 0, | |
| 437 | length = elems.length, | |
| 438 | callbackExpect = !invert; | |
| 439 | ||
| 440 | // Go through the array, only saving the items | |
| 441 | // that pass the validator function | |
| 442 | for ( ; i < length; i++ ) { | |
| 443 | callbackInverse = !callback( elems[ i ], i ); | |
| 444 | if ( callbackInverse !== callbackExpect ) { | |
| 445 | matches.push( elems[ i ] ); | |
| 446 | } | |
| 447 | } | |
| 448 | ||
| 449 | return matches; | |
| 450 | }, | |
| 451 | ||
| 452 | // arg is for internal usage only | |
| 453 | map: function( elems, callback, arg ) { | |
| 454 | var length, value, | |
| 455 | i = 0, | |
| 456 | ret = []; | |
| 457 | ||
| 458 | // Go through the array, translating each of the items to their new values | |
| 459 | if ( isArrayLike( elems ) ) { | |
| 460 | length = elems.length; | |
| 461 | for ( ; i < length; i++ ) { | |
| 462 | value = callback( elems[ i ], i, arg ); | |
| 463 | ||
| 464 | if ( value != null ) { | |
| 465 | ret.push( value ); | |
| 466 | } | |
| 467 | } | |
| 468 | ||
| 469 | // Go through every key on the object, | |
| 470 | } else { | |
| 471 | for ( i in elems ) { | |
| 472 | value = callback( elems[ i ], i, arg ); | |
| 473 | ||
| 474 | if ( value != null ) { | |
| 475 | ret.push( value ); | |
| 476 | } | |
| 477 | } | |
| 478 | } | |
| 479 | ||
| 480 | // Flatten any nested arrays | |
| 481 | return flat( ret ); | |
| 482 | }, | |
| 483 | ||
| 484 | // A global GUID counter for objects | |
| 485 | guid: 1, | |
| 486 | ||
| 487 | // jQuery.support is not used in Core but other projects attach their | |
| 488 | // properties to it so it needs to exist. | |
| 489 | support: support | |
| 490 | } ); | |
| 491 | ||
| 492 | if ( typeof Symbol === "function" ) { | |
| 493 | jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; | |
| 494 | } | |
| 495 | ||
| 496 | // Populate the class2type map | |
| 497 | jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), | |
| 498 | function( _i, name ) { | |
| 499 | class2type[ "[object " + name + "]" ] = name.toLowerCase(); | |
| 500 | } ); | |
| 501 | ||
| 502 | function isArrayLike( obj ) { | |
| 503 | ||
| 504 | // Support: real iOS 8.2 only (not reproducible in simulator) | |
| 505 | // `in` check used to prevent JIT error (gh-2145) | |
| 506 | // hasOwn isn't used here due to false negatives | |
| 507 | // regarding Nodelist length in IE | |
| 508 | var length = !!obj && "length" in obj && obj.length, | |
| 509 | type = toType( obj ); | |
| 510 | ||
| 511 | if ( isFunction( obj ) || isWindow( obj ) ) { | |
| 512 | return false; | |
| 513 | } | |
| 514 | ||
| 515 | return type === "array" || length === 0 || | |
| 516 | typeof length === "number" && length > 0 && ( length - 1 ) in obj; | |
| 517 | } | |
| 518 | var Sizzle = | |
| 519 | /*! | |
| 520 | * Sizzle CSS Selector Engine v2.3.5 | |
| 521 | * https://sizzlejs.com/ | |
| 522 | * | |
| 523 | * Copyright JS Foundation and other contributors | |
| 524 | * Released under the MIT license | |
| 525 | * https://js.foundation/ | |
| 526 | * | |
| 527 | * Date: 2020-03-14 | |
| 528 | */ | |
| 529 | ( function( window ) { | |
| 530 | var i, | |
| 531 | support, | |
| 532 | Expr, | |
| 533 | getText, | |
| 534 | isXML, | |
| 535 | tokenize, | |
| 536 | compile, | |
| 537 | select, | |
| 538 | outermostContext, | |
| 539 | sortInput, | |
| 540 | hasDuplicate, | |
| 541 | ||
| 542 | // Local document vars | |
| 543 | setDocument, | |
| 544 | document, | |
| 545 | docElem, | |
| 546 | documentIsHTML, | |
| 547 | rbuggyQSA, | |
| 548 | rbuggyMatches, | |
| 549 | matches, | |
| 550 | contains, | |
| 551 | ||
| 552 | // Instance-specific data | |
| 553 | expando = "sizzle" + 1 * new Date(), | |
| 554 | preferredDoc = window.document, | |
| 555 | dirruns = 0, | |
| 556 | done = 0, | |
| 557 | classCache = createCache(), | |
| 558 | tokenCache = createCache(), | |
| 559 | compilerCache = createCache(), | |
| 560 | nonnativeSelectorCache = createCache(), | |
| 561 | sortOrder = function( a, b ) { | |
| 562 | if ( a === b ) { | |
| 563 | hasDuplicate = true; | |
| 564 | } | |
| 565 | return 0; | |
| 566 | }, | |
| 567 | ||
| 568 | // Instance methods | |
| 569 | hasOwn = ( {} ).hasOwnProperty, | |
| 570 | arr = [], | |
| 571 | pop = arr.pop, | |
| 572 | pushNative = arr.push, | |
| 573 | push = arr.push, | |
| 574 | slice = arr.slice, | |
| 575 | ||
| 576 | // Use a stripped-down indexOf as it's faster than native | |
| 577 | // https://jsperf.com/thor-indexof-vs-for/5 | |
| 578 | indexOf = function( list, elem ) { | |
| 579 | var i = 0, | |
| 580 | len = list.length; | |
| 581 | for ( ; i < len; i++ ) { | |
| 582 | if ( list[ i ] === elem ) { | |
| 583 | return i; | |
| 584 | } | |
| 585 | } | |
| 586 | return -1; | |
| 587 | }, | |
| 588 | ||
| 589 | booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + | |
| 590 | "ismap|loop|multiple|open|readonly|required|scoped", | |
| 591 | ||
| 592 | // Regular expressions | |
| 593 | ||
| 594 | // http://www.w3.org/TR/css3-selectors/#whitespace | |
| 595 | whitespace = "[\\x20\\t\\r\\n\\f]", | |
| 596 | ||
| 597 | // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram | |
| 598 | identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + | |
| 599 | "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", | |
| 600 | ||
| 601 | // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors | |
| 602 | attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + | |
| 603 | ||
| 604 | // Operator (capture 2) | |
| 605 | "*([*^$|!~]?=)" + whitespace + | |
| 606 | ||
| 607 | // "Attribute values must be CSS identifiers [capture 5] | |
| 608 | // or strings [capture 3 or capture 4]" | |
| 609 | "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + | |
| 610 | whitespace + "*\\]", | |
| 611 | ||
| 612 | pseudos = ":(" + identifier + ")(?:\\((" + | |
| 613 | ||
| 614 | // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: | |
| 615 | // 1. quoted (capture 3; capture 4 or capture 5) | |
| 616 | "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + | |
| 617 | ||
| 618 | // 2. simple (capture 6) | |
| 619 | "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + | |
| 620 | ||
| 621 | // 3. anything else (capture 2) | |
| 622 | ".*" + | |
| 623 | ")\\)|)", | |
| 624 | ||
| 625 | // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter | |
| 626 | rwhitespace = new RegExp( whitespace + "+", "g" ), | |
| 627 | rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + | |
| 628 | whitespace + "+$", "g" ), | |
| 629 | ||
| 630 | rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), | |
| 631 | rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + | |
| 632 | "*" ), | |
| 633 | rdescend = new RegExp( whitespace + "|>" ), | |
| 634 | ||
| 635 | rpseudo = new RegExp( pseudos ), | |
| 636 | ridentifier = new RegExp( "^" + identifier + "$" ), | |
| 637 | ||
| 638 | matchExpr = { | |
| 639 | "ID": new RegExp( "^#(" + identifier + ")" ), | |
| 640 | "CLASS": new RegExp( "^\\.(" + identifier + ")" ), | |
| 641 | "TAG": new RegExp( "^(" + identifier + "|[*])" ), | |
| 642 | "ATTR": new RegExp( "^" + attributes ), | |
| 643 | "PSEUDO": new RegExp( "^" + pseudos ), | |
| 644 | "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + | |
| 645 | whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + | |
| 646 | whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), | |
| 647 | "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), | |
| 648 | ||
| 649 | // For use in libraries implementing .is() | |
| 650 | // We use this for POS matching in `select` | |
| 651 | "needsContext": new RegExp( "^" + whitespace + | |
| 652 | "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + | |
| 653 | "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) | |
| 654 | }, | |
| 655 | ||
| 656 | rhtml = /HTML$/i, | |
| 657 | rinputs = /^(?:input|select|textarea|button)$/i, | |
| 658 | rheader = /^h\d$/i, | |
| 659 | ||
| 660 | rnative = /^[^{]+\{\s*\[native \w/, | |
| 661 | ||
| 662 | // Easily-parseable/retrievable ID or TAG or CLASS selectors | |
| 663 | rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, | |
| 664 | ||
| 665 | rsibling = /[+~]/, | |
| 666 | ||
| 667 | // CSS escapes | |
| 668 | // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters | |
| 669 | runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), | |
| 670 | funescape = function( escape, nonHex ) { | |
| 671 | var high = "0x" + escape.slice( 1 ) - 0x10000; | |
| 672 | ||
| 673 | return nonHex ? | |
| 674 | ||
| 675 | // Strip the backslash prefix from a non-hex escape sequence | |
| 676 | nonHex : | |
| 677 | ||
| 678 | // Replace a hexadecimal escape sequence with the encoded Unicode code point | |
| 679 | // Support: IE <=11+ | |
| 680 | // For values outside the Basic Multilingual Plane (BMP), manually construct a | |
| 681 | // surrogate pair | |
| 682 | high < 0 ? | |
| 683 | String.fromCharCode( high + 0x10000 ) : | |
| 684 | String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); | |
| 685 | }, | |
| 686 | ||
| 687 | // CSS string/identifier serialization | |
| 688 | // https://drafts.csswg.org/cssom/#common-serializing-idioms | |
| 689 | rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, | |
| 690 | fcssescape = function( ch, asCodePoint ) { | |
| 691 | if ( asCodePoint ) { | |
| 692 | ||
| 693 | // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER | |
| 694 | if ( ch === "\0" ) { | |
| 695 | return "\uFFFD"; | |
| 696 | } | |
| 697 | ||
| 698 | // Control characters and (dependent upon position) numbers get escaped as code points | |
| 699 | return ch.slice( 0, -1 ) + "\\" + | |
| 700 | ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; | |
| 701 | } | |
| 702 | ||
| 703 | // Other potentially-special ASCII characters get backslash-escaped | |
| 704 | return "\\" + ch; | |
| 705 | }, | |
| 706 | ||
| 707 | // Used for iframes | |
| 708 | // See setDocument() | |
| 709 | // Removing the function wrapper causes a "Permission Denied" | |
| 710 | // error in IE | |
| 711 | unloadHandler = function() { | |
| 712 | setDocument(); | |
| 713 | }, | |
| 714 | ||
| 715 | inDisabledFieldset = addCombinator( | |
| 716 | function( elem ) { | |
| 717 | return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; | |
| 718 | }, | |
| 719 | { dir: "parentNode", next: "legend" } | |
| 720 | ); | |
| 721 | ||
| 722 | // Optimize for push.apply( _, NodeList ) | |
| 723 | try { | |
| 724 | push.apply( | |
| 725 | ( arr = slice.call( preferredDoc.childNodes ) ), | |
| 726 | preferredDoc.childNodes | |
| 727 | ); | |
| 728 | ||
| 729 | // Support: Android<4.0 | |
| 730 | // Detect silently failing push.apply | |
| 731 | // eslint-disable-next-line no-unused-expressions | |
| 732 | arr[ preferredDoc.childNodes.length ].nodeType; | |
| 733 | } catch ( e ) { | |
| 734 | push = { apply: arr.length ? | |
| 735 | ||
| 736 | // Leverage slice if possible | |
| 737 | function( target, els ) { | |
| 738 | pushNative.apply( target, slice.call( els ) ); | |
| 739 | } : | |
| 740 | ||
| 741 | // Support: IE<9 | |
| 742 | // Otherwise append directly | |
| 743 | function( target, els ) { | |
| 744 | var j = target.length, | |
| 745 | i = 0; | |
| 746 | ||
| 747 | // Can't trust NodeList.length | |
| 748 | while ( ( target[ j++ ] = els[ i++ ] ) ) {} | |
| 749 | target.length = j - 1; | |
| 750 | } | |
| 751 | }; | |
| 752 | } | |
| 753 | ||
| 754 | function Sizzle( selector, context, results, seed ) { | |
| 755 | var m, i, elem, nid, match, groups, newSelector, | |
| 756 | newContext = context && context.ownerDocument, | |
| 757 | ||
| 758 | // nodeType defaults to 9, since context defaults to document | |
| 759 | nodeType = context ? context.nodeType : 9; | |
| 760 | ||
| 761 | results = results || []; | |
| 762 | ||
| 763 | // Return early from calls with invalid selector or context | |
| 764 | if ( typeof selector !== "string" || !selector || | |
| 765 | nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { | |
| 766 | ||
| 767 | return results; | |
| 768 | } | |
| 769 | ||
| 770 | // Try to shortcut find operations (as opposed to filters) in HTML documents | |
| 771 | if ( !seed ) { | |
| 772 | setDocument( context ); | |
| 773 | context = context || document; | |
| 774 | ||
| 775 | if ( documentIsHTML ) { | |
| 776 | ||
| 777 | // If the selector is sufficiently simple, try using a "get*By*" DOM method | |
| 778 | // (excepting DocumentFragment context, where the methods don't exist) | |
| 779 | if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { | |
| 780 | ||
| 781 | // ID selector | |
| 782 | if ( ( m = match[ 1 ] ) ) { | |
| 783 | ||
| 784 | // Document context | |
| 785 | if ( nodeType === 9 ) { | |
| 786 | if ( ( elem = context.getElementById( m ) ) ) { | |
| 787 | ||
| 788 | // Support: IE, Opera, Webkit | |
| 789 | // TODO: identify versions | |
| 790 | // getElementById can match elements by name instead of ID | |
| 791 | if ( elem.id === m ) { | |
| 792 | results.push( elem ); | |
| 793 | return results; | |
| 794 | } | |
| 795 | } else { | |
| 796 | return results; | |
| 797 | } | |
| 798 | ||
| 799 | // Element context | |
| 800 | } else { | |
| 801 | ||
| 802 | // Support: IE, Opera, Webkit | |
| 803 | // TODO: identify versions | |
| 804 | // getElementById can match elements by name instead of ID | |
| 805 | if ( newContext && ( elem = newContext.getElementById( m ) ) && | |
| 806 | contains( context, elem ) && | |
| 807 | elem.id === m ) { | |
| 808 | ||
| 809 | results.push( elem ); | |
| 810 | return results; | |
| 811 | } | |
| 812 | } | |
| 813 | ||
| 814 | // Type selector | |
| 815 | } else if ( match[ 2 ] ) { | |
| 816 | push.apply( results, context.getElementsByTagName( selector ) ); | |
| 817 | return results; | |
| 818 | ||
| 819 | // Class selector | |
| 820 | } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && | |
| 821 | context.getElementsByClassName ) { | |
| 822 | ||
| 823 | push.apply( results, context.getElementsByClassName( m ) ); | |
| 824 | return results; | |
| 825 | } | |
| 826 | } | |
| 827 | ||
| 828 | // Take advantage of querySelectorAll | |
| 829 | if ( support.qsa && | |
| 830 | !nonnativeSelectorCache[ selector + " " ] && | |
| 831 | ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && | |
| 832 | ||
| 833 | // Support: IE 8 only | |
| 834 | // Exclude object elements | |
| 835 | ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { | |
| 836 | ||
| 837 | newSelector = selector; | |
| 838 | newContext = context; | |
| 839 | ||
| 840 | // qSA considers elements outside a scoping root when evaluating child or | |
| 841 | // descendant combinators, which is not what we want. | |
| 842 | // In such cases, we work around the behavior by prefixing every selector in the | |
| 843 | // list with an ID selector referencing the scope context. | |
| 844 | // The technique has to be used as well when a leading combinator is used | |
| 845 | // as such selectors are not recognized by querySelectorAll. | |
| 846 | // Thanks to Andrew Dupont for this technique. | |
| 847 | if ( nodeType === 1 && | |
| 848 | ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { | |
| 849 | ||
| 850 | // Expand context for sibling selectors | |
| 851 | newContext = rsibling.test( selector ) && testContext( context.parentNode ) || | |
| 852 | context; | |
| 853 | ||
| 854 | // We can use :scope instead of the ID hack if the browser | |
| 855 | // supports it & if we're not changing the context. | |
| 856 | if ( newContext !== context || !support.scope ) { | |
| 857 | ||
| 858 | // Capture the context ID, setting it first if necessary | |
| 859 | if ( ( nid = context.getAttribute( "id" ) ) ) { | |
| 860 | nid = nid.replace( rcssescape, fcssescape ); | |
| 861 | } else { | |
| 862 | context.setAttribute( "id", ( nid = expando ) ); | |
| 863 | } | |
| 864 | } | |
| 865 | ||
| 866 | // Prefix every selector in the list | |
| 867 | groups = tokenize( selector ); | |
| 868 | i = groups.length; | |
| 869 | while ( i-- ) { | |
| 870 | groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + | |
| 871 | toSelector( groups[ i ] ); | |
| 872 | } | |
| 873 | newSelector = groups.join( "," ); | |
| 874 | } | |
| 875 | ||
| 876 | try { | |
| 877 | push.apply( results, | |
| 878 | newContext.querySelectorAll( newSelector ) | |
| 879 | ); | |
| 880 | return results; | |
| 881 | } catch ( qsaError ) { | |
| 882 | nonnativeSelectorCache( selector, true ); | |
| 883 | } finally { | |
| 884 | if ( nid === expando ) { | |
| 885 | context.removeAttribute( "id" ); | |
| 886 | } | |
| 887 | } | |
| 888 | } | |
| 889 | } | |
| 890 | } | |
| 891 | ||
| 892 | // All others | |
| 893 | return select( selector.replace( rtrim, "$1" ), context, results, seed ); | |
| 894 | } | |
| 895 | ||
| 896 | /** | |
| 897 | * Create key-value caches of limited size | |
| 898 | * @returns {function(string, object)} Returns the Object data after storing it on itself with | |
| 899 | * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) | |
| 900 | * deleting the oldest entry | |
| 901 | */ | |
| 902 | function createCache() { | |
| 903 | var keys = []; | |
| 904 | ||
| 905 | function cache( key, value ) { | |
| 906 | ||
| 907 | // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) | |
| 908 | if ( keys.push( key + " " ) > Expr.cacheLength ) { | |
| 909 | ||
| 910 | // Only keep the most recent entries | |
| 911 | delete cache[ keys.shift() ]; | |
| 912 | } | |
| 913 | return ( cache[ key + " " ] = value ); | |
| 914 | } | |
| 915 | return cache; | |
| 916 | } | |
| 917 | ||
| 918 | /** | |
| 919 | * Mark a function for special use by Sizzle | |
| 920 | * @param {Function} fn The function to mark | |
| 921 | */ | |
| 922 | function markFunction( fn ) { | |
| 923 | fn[ expando ] = true; | |
| 924 | return fn; | |
| 925 | } | |
| 926 | ||
| 927 | /** | |
| 928 | * Support testing using an element | |
| 929 | * @param {Function} fn Passed the created element and returns a boolean result | |
| 930 | */ | |
| 931 | function assert( fn ) { | |
| 932 | var el = document.createElement( "fieldset" ); | |
| 933 | ||
| 934 | try { | |
| 935 | return !!fn( el ); | |
| 936 | } catch ( e ) { | |
| 937 | return false; | |
| 938 | } finally { | |
| 939 | ||
| 940 | // Remove from its parent by default | |
| 941 | if ( el.parentNode ) { | |
| 942 | el.parentNode.removeChild( el ); | |
| 943 | } | |
| 944 | ||
| 945 | // release memory in IE | |
| 946 | el = null; | |
| 947 | } | |
| 948 | } | |
| 949 | ||
| 950 | /** | |
| 951 | * Adds the same handler for all of the specified attrs | |
| 952 | * @param {String} attrs Pipe-separated list of attributes | |
| 953 | * @param {Function} handler The method that will be applied | |
| 954 | */ | |
| 955 | function addHandle( attrs, handler ) { | |
| 956 | var arr = attrs.split( "|" ), | |
| 957 | i = arr.length; | |
| 958 | ||
| 959 | while ( i-- ) { | |
| 960 | Expr.attrHandle[ arr[ i ] ] = handler; | |
| 961 | } | |
| 962 | } | |
| 963 | ||
| 964 | /** | |
| 965 | * Checks document order of two siblings | |
| 966 | * @param {Element} a | |
| 967 | * @param {Element} b | |
| 968 | * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b | |
| 969 | */ | |
| 970 | function siblingCheck( a, b ) { | |
| 971 | var cur = b && a, | |
| 972 | diff = cur && a.nodeType === 1 && b.nodeType === 1 && | |
| 973 | a.sourceIndex - b.sourceIndex; | |
| 974 | ||
| 975 | // Use IE sourceIndex if available on both nodes | |
| 976 | if ( diff ) { | |
| 977 | return diff; | |
| 978 | } | |
| 979 | ||
| 980 | // Check if b follows a | |
| 981 | if ( cur ) { | |
| 982 | while ( ( cur = cur.nextSibling ) ) { | |
| 983 | if ( cur === b ) { | |
| 984 | return -1; | |
| 985 | } | |
| 986 | } | |
| 987 | } | |
| 988 | ||
| 989 | return a ? 1 : -1; | |
| 990 | } | |
| 991 | ||
| 992 | /** | |
| 993 | * Returns a function to use in pseudos for input types | |
| 994 | * @param {String} type | |
| 995 | */ | |
| 996 | function createInputPseudo( type ) { | |
| 997 | return function( elem ) { | |
| 998 | var name = elem.nodeName.toLowerCase(); | |
| 999 | return name === "input" && elem.type === type; | |
| 1000 | }; | |
| 1001 | } | |
| 1002 | ||
| 1003 | /** | |
| 1004 | * Returns a function to use in pseudos for buttons | |
| 1005 | * @param {String} type | |
| 1006 | */ | |
| 1007 | function createButtonPseudo( type ) { | |
| 1008 | return function( elem ) { | |
| 1009 | var name = elem.nodeName.toLowerCase(); | |
| 1010 | return ( name === "input" || name === "button" ) && elem.type === type; | |
| 1011 | }; | |
| 1012 | } | |
| 1013 | ||
| 1014 | /** | |
| 1015 | * Returns a function to use in pseudos for :enabled/:disabled | |
| 1016 | * @param {Boolean} disabled true for :disabled; false for :enabled | |
| 1017 | */ | |
| 1018 | function createDisabledPseudo( disabled ) { | |
| 1019 | ||
| 1020 | // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable | |
| 1021 | return function( elem ) { | |
| 1022 | ||
| 1023 | // Only certain elements can match :enabled or :disabled | |
| 1024 | // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled | |
| 1025 | // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled | |
| 1026 | if ( "form" in elem ) { | |
| 1027 | ||
| 1028 | // Check for inherited disabledness on relevant non-disabled elements: | |
| 1029 | // * listed form-associated elements in a disabled fieldset | |
| 1030 | // https://html.spec.whatwg.org/multipage/forms.html#category-listed | |
| 1031 | // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled | |
| 1032 | // * option elements in a disabled optgroup | |
| 1033 | // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled | |
| 1034 | // All such elements have a "form" property. | |
| 1035 | if ( elem.parentNode && elem.disabled === false ) { | |
| 1036 | ||
| 1037 | // Option elements defer to a parent optgroup if present | |
| 1038 | if ( "label" in elem ) { | |
| 1039 | if ( "label" in elem.parentNode ) { | |
| 1040 | return elem.parentNode.disabled === disabled; | |
| 1041 | } else { | |
| 1042 | return elem.disabled === disabled; | |
| 1043 | } | |
| 1044 | } | |
| 1045 | ||
| 1046 | // Support: IE 6 - 11 | |
| 1047 | // Use the isDisabled shortcut property to check for disabled fieldset ancestors | |
| 1048 | return elem.isDisabled === disabled || | |
| 1049 | ||
| 1050 | // Where there is no isDisabled, check manually | |
| 1051 | /* jshint -W018 */ | |
| 1052 | elem.isDisabled !== !disabled && | |
| 1053 | inDisabledFieldset( elem ) === disabled; | |
| 1054 | } | |
| 1055 | ||
| 1056 | return elem.disabled === disabled; | |
| 1057 | ||
| 1058 | // Try to winnow out elements that can't be disabled before trusting the disabled property. | |
| 1059 | // Some victims get caught in our net (label, legend, menu, track), but it shouldn't | |
| 1060 | // even exist on them, let alone have a boolean value. | |
| 1061 | } else if ( "label" in elem ) { | |
| 1062 | return elem.disabled === disabled; | |
| 1063 | } | |
| 1064 | ||
| 1065 | // Remaining elements are neither :enabled nor :disabled | |
| 1066 | return false; | |
| 1067 | }; | |
| 1068 | } | |
| 1069 | ||
| 1070 | /** | |
| 1071 | * Returns a function to use in pseudos for positionals | |
| 1072 | * @param {Function} fn | |
| 1073 | */ | |
| 1074 | function createPositionalPseudo( fn ) { | |
| 1075 | return markFunction( function( argument ) { | |
| 1076 | argument = +argument; | |
| 1077 | return markFunction( function( seed, matches ) { | |
| 1078 | var j, | |
| 1079 | matchIndexes = fn( [], seed.length, argument ), | |
| 1080 | i = matchIndexes.length; | |
| 1081 | ||
| 1082 | // Match elements found at the specified indexes | |
| 1083 | while ( i-- ) { | |
| 1084 | if ( seed[ ( j = matchIndexes[ i ] ) ] ) { | |
| 1085 | seed[ j ] = !( matches[ j ] = seed[ j ] ); | |
| 1086 | } | |
| 1087 | } | |
| 1088 | } ); | |
| 1089 | } ); | |
| 1090 | } | |
| 1091 | ||
| 1092 | /** | |
| 1093 | * Checks a node for validity as a Sizzle context | |
| 1094 | * @param {Element|Object=} context | |
| 1095 | * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value | |
| 1096 | */ | |
| 1097 | function testContext( context ) { | |
| 1098 | return context && typeof context.getElementsByTagName !== "undefined" && context; | |
| 1099 | } | |
| 1100 | ||
| 1101 | // Expose support vars for convenience | |
| 1102 | support = Sizzle.support = {}; | |
| 1103 | ||
| 1104 | /** | |
| 1105 | * Detects XML nodes | |
| 1106 | * @param {Element|Object} elem An element or a document | |
| 1107 | * @returns {Boolean} True iff elem is a non-HTML XML node | |
| 1108 | */ | |
| 1109 | isXML = Sizzle.isXML = function( elem ) { | |
| 1110 | var namespace = elem.namespaceURI, | |
| 1111 | docElem = ( elem.ownerDocument || elem ).documentElement; | |
| 1112 | ||
| 1113 | // Support: IE <=8 | |
| 1114 | // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes | |
| 1115 | // https://bugs.jquery.com/ticket/4833 | |
| 1116 | return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); | |
| 1117 | }; | |
| 1118 | ||
| 1119 | /** | |
| 1120 | * Sets document-related variables once based on the current document | |
| 1121 | * @param {Element|Object} [doc] An element or document object to use to set the document | |
| 1122 | * @returns {Object} Returns the current document | |
| 1123 | */ | |
| 1124 | setDocument = Sizzle.setDocument = function( node ) { | |
| 1125 | var hasCompare, subWindow, | |
| 1126 | doc = node ? node.ownerDocument || node : preferredDoc; | |
| 1127 | ||
| 1128 | // Return early if doc is invalid or already selected | |
| 1129 | // Support: IE 11+, Edge 17 - 18+ | |
| 1130 | // IE/Edge sometimes throw a "Permission denied" error when strict-comparing | |
| 1131 | // two documents; shallow comparisons work. | |
| 1132 | // eslint-disable-next-line eqeqeq | |
| 1133 | if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { | |
| 1134 | return document; | |
| 1135 | } | |
| 1136 | ||
| 1137 | // Update global variables | |
| 1138 | document = doc; | |
| 1139 | docElem = document.documentElement; | |
| 1140 | documentIsHTML = !isXML( document ); | |
| 1141 | ||
| 1142 | // Support: IE 9 - 11+, Edge 12 - 18+ | |
| 1143 | // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) | |
| 1144 | // Support: IE 11+, Edge 17 - 18+ | |
| 1145 | // IE/Edge sometimes throw a "Permission denied" error when strict-comparing | |
| 1146 | // two documents; shallow comparisons work. | |
| 1147 | // eslint-disable-next-line eqeqeq | |
| 1148 | if ( preferredDoc != document && | |
| 1149 | ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { | |
| 1150 | ||
| 1151 | // Support: IE 11, Edge | |
| 1152 | if ( subWindow.addEventListener ) { | |
| 1153 | subWindow.addEventListener( "unload", unloadHandler, false ); | |
| 1154 | ||
| 1155 | // Support: IE 9 - 10 only | |
| 1156 | } else if ( subWindow.attachEvent ) { | |
| 1157 | subWindow.attachEvent( "onunload", unloadHandler ); | |
| 1158 | } | |
| 1159 | } | |
| 1160 | ||
| 1161 | // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, | |
| 1162 | // Safari 4 - 5 only, Opera <=11.6 - 12.x only | |
| 1163 | // IE/Edge & older browsers don't support the :scope pseudo-class. | |
| 1164 | // Support: Safari 6.0 only | |
| 1165 | // Safari 6.0 supports :scope but it's an alias of :root there. | |
| 1166 | support.scope = assert( function( el ) { | |
| 1167 | docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); | |
| 1168 | return typeof el.querySelectorAll !== "undefined" && | |
| 1169 | !el.querySelectorAll( ":scope fieldset div" ).length; | |
| 1170 | } ); | |
| 1171 | ||
| 1172 | /* Attributes | |
| 1173 | ---------------------------------------------------------------------- */ | |
| 1174 | ||
| 1175 | // Support: IE<8 | |
| 1176 | // Verify that getAttribute really returns attributes and not properties | |
| 1177 | // (excepting IE8 booleans) | |
| 1178 | support.attributes = assert( function( el ) { | |
| 1179 | el.className = "i"; | |
| 1180 | return !el.getAttribute( "className" ); | |
| 1181 | } ); | |
| 1182 | ||
| 1183 | /* getElement(s)By* | |
| 1184 | ---------------------------------------------------------------------- */ | |
| 1185 | ||
| 1186 | // Check if getElementsByTagName("*") returns only elements | |
| 1187 | support.getElementsByTagName = assert( function( el ) { | |
| 1188 | el.appendChild( document.createComment( "" ) ); | |
| 1189 | return !el.getElementsByTagName( "*" ).length; | |
| 1190 | } ); | |
| 1191 | ||
| 1192 | // Support: IE<9 | |
| 1193 | support.getElementsByClassName = rnative.test( document.getElementsByClassName ); | |
| 1194 | ||
| 1195 | // Support: IE<10 | |
| 1196 | // Check if getElementById returns elements by name | |
| 1197 | // The broken getElementById methods don't pick up programmatically-set names, | |
| 1198 | // so use a roundabout getElementsByName test | |
| 1199 | support.getById = assert( function( el ) { | |
| 1200 | docElem.appendChild( el ).id = expando; | |
| 1201 | return !document.getElementsByName || !document.getElementsByName( expando ).length; | |
| 1202 | } ); | |
| 1203 | ||
| 1204 | // ID filter and find | |
| 1205 | if ( support.getById ) { | |
| 1206 | Expr.filter[ "ID" ] = function( id ) { | |
| 1207 | var attrId = id.replace( runescape, funescape ); | |
| 1208 | return function( elem ) { | |
| 1209 | return elem.getAttribute( "id" ) === attrId; | |
| 1210 | }; | |
| 1211 | }; | |
| 1212 | Expr.find[ "ID" ] = function( id, context ) { | |
| 1213 | if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { | |
| 1214 | var elem = context.getElementById( id ); | |
| 1215 | return elem ? [ elem ] : []; | |
| 1216 | } | |
| 1217 | }; | |
| 1218 | } else { | |
| 1219 | Expr.filter[ "ID" ] = function( id ) { | |
| 1220 | var attrId = id.replace( runescape, funescape ); | |
| 1221 | return function( elem ) { | |
| 1222 | var node = typeof elem.getAttributeNode !== "undefined" && | |
| 1223 | elem.getAttributeNode( "id" ); | |
| 1224 | return node && node.value === attrId; | |
| 1225 | }; | |
| 1226 | }; | |
| 1227 | ||
| 1228 | // Support: IE 6 - 7 only | |
| 1229 | // getElementById is not reliable as a find shortcut | |
| 1230 | Expr.find[ "ID" ] = function( id, context ) { | |
| 1231 | if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { | |
| 1232 | var node, i, elems, | |
| 1233 | elem = context.getElementById( id ); | |
| 1234 | ||
| 1235 | if ( elem ) { | |
| 1236 | ||
| 1237 | // Verify the id attribute | |
| 1238 | node = elem.getAttributeNode( "id" ); | |
| 1239 | if ( node && node.value === id ) { | |
| 1240 | return [ elem ]; | |
| 1241 | } | |
| 1242 | ||
| 1243 | // Fall back on getElementsByName | |
| 1244 | elems = context.getElementsByName( id ); | |
| 1245 | i = 0; | |
| 1246 | while ( ( elem = elems[ i++ ] ) ) { | |
| 1247 | node = elem.getAttributeNode( "id" ); | |
| 1248 | if ( node && node.value === id ) { | |
| 1249 | return [ elem ]; | |
| 1250 | } | |
| 1251 | } | |
| 1252 | } | |
| 1253 | ||
| 1254 | return []; | |
| 1255 | } | |
| 1256 | }; | |
| 1257 | } | |
| 1258 | ||
| 1259 | // Tag | |
| 1260 | Expr.find[ "TAG" ] = support.getElementsByTagName ? | |
| 1261 | function( tag, context ) { | |
| 1262 | if ( typeof context.getElementsByTagName !== "undefined" ) { | |
| 1263 | return context.getElementsByTagName( tag ); | |
| 1264 | ||
| 1265 | // DocumentFragment nodes don't have gEBTN | |
| 1266 | } else if ( support.qsa ) { | |
| 1267 | return context.querySelectorAll( tag ); | |
| 1268 | } | |
| 1269 | } : | |
| 1270 | ||
| 1271 | function( tag, context ) { | |
| 1272 | var elem, | |
| 1273 | tmp = [], | |
| 1274 | i = 0, | |
| 1275 | ||
| 1276 | // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too | |
| 1277 | results = context.getElementsByTagName( tag ); | |
| 1278 | ||
| 1279 | // Filter out possible comments | |
| 1280 | if ( tag === "*" ) { | |
| 1281 | while ( ( elem = results[ i++ ] ) ) { | |
| 1282 | if ( elem.nodeType === 1 ) { | |
| 1283 | tmp.push( elem ); | |
| 1284 | } | |
| 1285 | } | |
| 1286 | ||
| 1287 | return tmp; | |
| 1288 | } | |
| 1289 | return results; | |
| 1290 | }; | |
| 1291 | ||
| 1292 | // Class | |
| 1293 | Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { | |
| 1294 | if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { | |
| 1295 | return context.getElementsByClassName( className ); | |
| 1296 | } | |
| 1297 | }; | |
| 1298 | ||
| 1299 | /* QSA/matchesSelector | |
| 1300 | ---------------------------------------------------------------------- */ | |
| 1301 | ||
| 1302 | // QSA and matchesSelector support | |
| 1303 | ||
| 1304 | // matchesSelector(:active) reports false when true (IE9/Opera 11.5) | |
| 1305 | rbuggyMatches = []; | |
| 1306 | ||
| 1307 | // qSa(:focus) reports false when true (Chrome 21) | |
| 1308 | // We allow this because of a bug in IE8/9 that throws an error | |
| 1309 | // whenever `document.activeElement` is accessed on an iframe | |
| 1310 | // So, we allow :focus to pass through QSA all the time to avoid the IE error | |
| 1311 | // See https://bugs.jquery.com/ticket/13378 | |
| 1312 | rbuggyQSA = []; | |
| 1313 | ||
| 1314 | if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { | |
| 1315 | ||
| 1316 | // Build QSA regex | |
| 1317 | // Regex strategy adopted from Diego Perini | |
| 1318 | assert( function( el ) { | |
| 1319 | ||
| 1320 | var input; | |
| 1321 | ||
| 1322 | // Select is set to empty string on purpose | |
| 1323 | // This is to test IE's treatment of not explicitly | |
| 1324 | // setting a boolean content attribute, | |
| 1325 | // since its presence should be enough | |
| 1326 | // https://bugs.jquery.com/ticket/12359 | |
| 1327 | docElem.appendChild( el ).innerHTML = "<a id='" + expando + "'></a>" + | |
| 1328 | "<select id='" + expando + "-\r\\' msallowcapture=''>" + | |
| 1329 | "<option selected=''></option></select>"; | |
| 1330 | ||
| 1331 | // Support: IE8, Opera 11-12.16 | |
| 1332 | // Nothing should be selected when empty strings follow ^= or $= or *= | |
| 1333 | // The test attribute must be unknown in Opera but "safe" for WinRT | |
| 1334 | // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section | |
| 1335 | if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { | |
| 1336 | rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); | |
| 1337 | } | |
| 1338 | ||
| 1339 | // Support: IE8 | |
| 1340 | // Boolean attributes and "value" are not treated correctly | |
| 1341 | if ( !el.querySelectorAll( "[selected]" ).length ) { | |
| 1342 | rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); | |
| 1343 | } | |
| 1344 | ||
| 1345 | // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ | |
| 1346 | if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { | |
| 1347 | rbuggyQSA.push( "~=" ); | |
| 1348 | } | |
| 1349 | ||
| 1350 | // Support: IE 11+, Edge 15 - 18+ | |
| 1351 | // IE 11/Edge don't find elements on a `[name='']` query in some cases. | |
| 1352 | // Adding a temporary attribute to the document before the selection works | |
| 1353 | // around the issue. | |
| 1354 | // Interestingly, IE 10 & older don't seem to have the issue. | |
| 1355 | input = document.createElement( "input" ); | |
| 1356 | input.setAttribute( "name", "" ); | |
| 1357 | el.appendChild( input ); | |
| 1358 | if ( !el.querySelectorAll( "[name='']" ).length ) { | |
| 1359 | rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + | |
| 1360 | whitespace + "*(?:''|\"\")" ); | |
| 1361 | } | |
| 1362 | ||
| 1363 | // Webkit/Opera - :checked should return selected option elements | |
| 1364 | // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked | |
| 1365 | // IE8 throws error here and will not see later tests | |
| 1366 | if ( !el.querySelectorAll( ":checked" ).length ) { | |
| 1367 | rbuggyQSA.push( ":checked" ); | |
| 1368 | } | |
| 1369 | ||
| 1370 | // Support: Safari 8+, iOS 8+ | |
| 1371 | // https://bugs.webkit.org/show_bug.cgi?id=136851 | |
| 1372 | // In-page `selector#id sibling-combinator selector` fails | |
| 1373 | if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { | |
| 1374 | rbuggyQSA.push( ".#.+[+~]" ); | |
| 1375 | } | |
| 1376 | ||
| 1377 | // Support: Firefox <=3.6 - 5 only | |
| 1378 | // Old Firefox doesn't throw on a badly-escaped identifier. | |
| 1379 | el.querySelectorAll( "\\\f" ); | |
| 1380 | rbuggyQSA.push( "[\\r\\n\\f]" ); | |
| 1381 | } ); | |
| 1382 | ||
| 1383 | assert( function( el ) { | |
| 1384 | el.innerHTML = "<a href='' disabled='disabled'></a>" + | |
| 1385 | "<select disabled='disabled'><option/></select>"; | |
| 1386 | ||
| 1387 | // Support: Windows 8 Native Apps | |
| 1388 | // The type and name attributes are restricted during .innerHTML assignment | |
| 1389 | var input = document.createElement( "input" ); | |
| 1390 | input.setAttribute( "type", "hidden" ); | |
| 1391 | el.appendChild( input ).setAttribute( "name", "D" ); | |
| 1392 | ||
| 1393 | // Support: IE8 | |
| 1394 | // Enforce case-sensitivity of name attribute | |
| 1395 | if ( el.querySelectorAll( "[name=d]" ).length ) { | |
| 1396 | rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); | |
| 1397 | } | |
| 1398 | ||
| 1399 | // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) | |
| 1400 | // IE8 throws error here and will not see later tests | |
| 1401 | if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { | |
| 1402 | rbuggyQSA.push( ":enabled", ":disabled" ); | |
| 1403 | } | |
| 1404 | ||
| 1405 | // Support: IE9-11+ | |
| 1406 | // IE's :disabled selector does not pick up the children of disabled fieldsets | |
| 1407 | docElem.appendChild( el ).disabled = true; | |
| 1408 | if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { | |
| 1409 | rbuggyQSA.push( ":enabled", ":disabled" ); | |
| 1410 | } | |
| 1411 | ||
| 1412 | // Support: Opera 10 - 11 only | |
| 1413 | // Opera 10-11 does not throw on post-comma invalid pseudos | |
| 1414 | el.querySelectorAll( "*,:x" ); | |
| 1415 | rbuggyQSA.push( ",.*:" ); | |
| 1416 | } ); | |
| 1417 | } | |
| 1418 | ||
| 1419 | if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || | |
| 1420 | docElem.webkitMatchesSelector || | |
| 1421 | docElem.mozMatchesSelector || | |
| 1422 | docElem.oMatchesSelector || | |
| 1423 | docElem.msMatchesSelector ) ) ) ) { | |
| 1424 | ||
| 1425 | assert( function( el ) { | |
| 1426 | ||
| 1427 | // Check to see if it's possible to do matchesSelector | |
| 1428 | // on a disconnected node (IE 9) | |
| 1429 | support.disconnectedMatch = matches.call( el, "*" ); | |
| 1430 | ||
| 1431 | // This should fail with an exception | |
| 1432 | // Gecko does not error, returns false instead | |
| 1433 | matches.call( el, "[s!='']:x" ); | |
| 1434 | rbuggyMatches.push( "!=", pseudos ); | |
| 1435 | } ); | |
| 1436 | } | |
| 1437 | ||
| 1438 | rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); | |
| 1439 | rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); | |
| 1440 | ||
| 1441 | /* Contains | |
| 1442 | ---------------------------------------------------------------------- */ | |
| 1443 | hasCompare = rnative.test( docElem.compareDocumentPosition ); | |
| 1444 | ||
| 1445 | // Element contains another | |
| 1446 | // Purposefully self-exclusive | |
| 1447 | // As in, an element does not contain itself | |
| 1448 | contains = hasCompare || rnative.test( docElem.contains ) ? | |
| 1449 | function( a, b ) { | |
| 1450 | var adown = a.nodeType === 9 ? a.documentElement : a, | |
| 1451 | bup = b && b.parentNode; | |
| 1452 | return a === bup || !!( bup && bup.nodeType === 1 && ( | |
| 1453 | adown.contains ? | |
| 1454 | adown.contains( bup ) : | |
| 1455 | a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 | |
| 1456 | ) ); | |
| 1457 | } : | |
| 1458 | function( a, b ) { | |
| 1459 | if ( b ) { | |
| 1460 | while ( ( b = b.parentNode ) ) { | |
| 1461 | if ( b === a ) { | |
| 1462 | return true; | |
| 1463 | } | |
| 1464 | } | |
| 1465 | } | |
| 1466 | return false; | |
| 1467 | }; | |
| 1468 | ||
| 1469 | /* Sorting | |
| 1470 | ---------------------------------------------------------------------- */ | |
| 1471 | ||
| 1472 | // Document order sorting | |
| 1473 | sortOrder = hasCompare ? | |
| 1474 | function( a, b ) { | |
| 1475 | ||
| 1476 | // Flag for duplicate removal | |
| 1477 | if ( a === b ) { | |
| 1478 | hasDuplicate = true; | |
| 1479 | return 0; | |
| 1480 | } | |
| 1481 | ||
| 1482 | // Sort on method existence if only one input has compareDocumentPosition | |
| 1483 | var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; | |
| 1484 | if ( compare ) { | |
| 1485 | return compare; | |
| 1486 | } | |
| 1487 | ||
| 1488 | // Calculate position if both inputs belong to the same document | |
| 1489 | // Support: IE 11+, Edge 17 - 18+ | |
| 1490 | // IE/Edge sometimes throw a "Permission denied" error when strict-comparing | |
| 1491 | // two documents; shallow comparisons work. | |
| 1492 | // eslint-disable-next-line eqeqeq | |
| 1493 | compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? | |
| 1494 | a.compareDocumentPosition( b ) : | |
| 1495 | ||
| 1496 | // Otherwise we know they are disconnected | |
| 1497 | 1; | |
| 1498 | ||
| 1499 | // Disconnected nodes | |
| 1500 | if ( compare & 1 || | |
| 1501 | ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { | |
| 1502 | ||
| 1503 | // Choose the first element that is related to our preferred document | |
| 1504 | // Support: IE 11+, Edge 17 - 18+ | |
| 1505 | // IE/Edge sometimes throw a "Permission denied" error when strict-comparing | |
| 1506 | // two documents; shallow comparisons work. | |
| 1507 | // eslint-disable-next-line eqeqeq | |
| 1508 | if ( a == document || a.ownerDocument == preferredDoc && | |
| 1509 | contains( preferredDoc, a ) ) { | |
| 1510 | return -1; | |
| 1511 | } | |
| 1512 | ||
| 1513 | // Support: IE 11+, Edge 17 - 18+ | |
| 1514 | // IE/Edge sometimes throw a "Permission denied" error when strict-comparing | |
| 1515 | // two documents; shallow comparisons work. | |
| 1516 | // eslint-disable-next-line eqeqeq | |
| 1517 | if ( b == document || b.ownerDocument == preferredDoc && | |
| 1518 | contains( preferredDoc, b ) ) { | |
| 1519 | return 1; | |
| 1520 | } | |
| 1521 | ||
| 1522 | // Maintain original order | |
| 1523 | return sortInput ? | |
| 1524 | ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : | |
| 1525 | 0; | |
| 1526 | } | |
| 1527 | ||
| 1528 | return compare & 4 ? -1 : 1; | |
| 1529 | } : | |
| 1530 | function( a, b ) { | |
| 1531 | ||
| 1532 | // Exit early if the nodes are identical | |
| 1533 | if ( a === b ) { | |
| 1534 | hasDuplicate = true; | |
| 1535 | return 0; | |
| 1536 | } | |
| 1537 | ||
| 1538 | var cur, | |
| 1539 | i = 0, | |
| 1540 | aup = a.parentNode, | |
| 1541 | bup = b.parentNode, | |
| 1542 | ap = [ a ], | |
| 1543 | bp = [ b ]; | |
| 1544 | ||
| 1545 | // Parentless nodes are either documents or disconnected | |
| 1546 | if ( !aup || !bup ) { | |
| 1547 | ||
| 1548 | // Support: IE 11+, Edge 17 - 18+ | |
| 1549 | // IE/Edge sometimes throw a "Permission denied" error when strict-comparing | |
| 1550 | // two documents; shallow comparisons work. | |
| 1551 | /* eslint-disable eqeqeq */ | |
| 1552 | return a == document ? -1 : | |
| 1553 | b == document ? 1 : | |
| 1554 | /* eslint-enable eqeqeq */ | |
| 1555 | aup ? -1 : | |
| 1556 | bup ? 1 : | |
| 1557 | sortInput ? | |
| 1558 | ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : | |
| 1559 | 0; | |
| 1560 | ||
| 1561 | // If the nodes are siblings, we can do a quick check | |
| 1562 | } else if ( aup === bup ) { | |
| 1563 | return siblingCheck( a, b ); | |
| 1564 | } | |
| 1565 | ||
| 1566 | // Otherwise we need full lists of their ancestors for comparison | |
| 1567 | cur = a; | |
| 1568 | while ( ( cur = cur.parentNode ) ) { | |
| 1569 | ap.unshift( cur ); | |
| 1570 | } | |
| 1571 | cur = b; | |
| 1572 | while ( ( cur = cur.parentNode ) ) { | |
| 1573 | bp.unshift( cur ); | |
| 1574 | } | |
| 1575 | ||
| 1576 | // Walk down the tree looking for a discrepancy | |
| 1577 | while ( ap[ i ] === bp[ i ] ) { | |
| 1578 | i++; | |
| 1579 | } | |
| 1580 | ||
| 1581 | return i ? | |
| 1582 | ||
| 1583 | // Do a sibling check if the nodes have a common ancestor | |
| 1584 | siblingCheck( ap[ i ], bp[ i ] ) : | |
| 1585 | ||
| 1586 | // Otherwise nodes in our document sort first | |
| 1587 | // Support: IE 11+, Edge 17 - 18+ | |
| 1588 | // IE/Edge sometimes throw a "Permission denied" error when strict-comparing | |
| 1589 | // two documents; shallow comparisons work. | |
| 1590 | /* eslint-disable eqeqeq */ | |
| 1591 | ap[ i ] == preferredDoc ? -1 : | |
| 1592 | bp[ i ] == preferredDoc ? 1 : | |
| 1593 | /* eslint-enable eqeqeq */ | |
| 1594 | 0; | |
| 1595 | }; | |
| 1596 | ||
| 1597 | return document; | |
| 1598 | }; | |
| 1599 | ||
| 1600 | Sizzle.matches = function( expr, elements ) { | |
| 1601 | return Sizzle( expr, null, null, elements ); | |
| 1602 | }; | |
| 1603 | ||
| 1604 | Sizzle.matchesSelector = function( elem, expr ) { | |
| 1605 | setDocument( elem ); | |
| 1606 | ||
| 1607 | if ( support.matchesSelector && documentIsHTML && | |
| 1608 | !nonnativeSelectorCache[ expr + " " ] && | |
| 1609 | ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && | |
| 1610 | ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { | |
| 1611 | ||
| 1612 | try { | |
| 1613 | var ret = matches.call( elem, expr ); | |
| 1614 | ||
| 1615 | // IE 9's matchesSelector returns false on disconnected nodes | |
| 1616 | if ( ret || support.disconnectedMatch || | |
| 1617 | ||
| 1618 | // As well, disconnected nodes are said to be in a document | |
| 1619 | // fragment in IE 9 | |
| 1620 | elem.document && elem.document.nodeType !== 11 ) { | |
| 1621 | return ret; | |
| 1622 | } | |
| 1623 | } catch ( e ) { | |
| 1624 | nonnativeSelectorCache( expr, true ); | |
| 1625 | } | |
| 1626 | } | |
| 1627 | ||
| 1628 | return Sizzle( expr, document, null, [ elem ] ).length > 0; | |
| 1629 | }; | |
| 1630 | ||
| 1631 | Sizzle.contains = function( context, elem ) { | |
| 1632 | ||
| 1633 | // Set document vars if needed | |
| 1634 | // Support: IE 11+, Edge 17 - 18+ | |
| 1635 | // IE/Edge sometimes throw a "Permission denied" error when strict-comparing | |
| 1636 | // two documents; shallow comparisons work. | |
| 1637 | // eslint-disable-next-line eqeqeq | |
| 1638 | if ( ( context.ownerDocument || context ) != document ) { | |
| 1639 | setDocument( context ); | |
| 1640 | } | |
| 1641 | return contains( context, elem ); | |
| 1642 | }; | |
| 1643 | ||
| 1644 | Sizzle.attr = function( elem, name ) { | |
| 1645 | ||
| 1646 | // Set document vars if needed | |
| 1647 | // Support: IE 11+, Edge 17 - 18+ | |
| 1648 | // IE/Edge sometimes throw a "Permission denied" error when strict-comparing | |
| 1649 | // two documents; shallow comparisons work. | |
| 1650 | // eslint-disable-next-line eqeqeq | |
| 1651 | if ( ( elem.ownerDocument || elem ) != document ) { | |
| 1652 | setDocument( elem ); | |
| 1653 | } | |
| 1654 | ||
| 1655 | var fn = Expr.attrHandle[ name.toLowerCase() ], | |
| 1656 | ||
| 1657 | // Don't get fooled by Object.prototype properties (jQuery #13807) | |
| 1658 | val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? | |
| 1659 | fn( elem, name, !documentIsHTML ) : | |
| 1660 | undefined; | |
| 1661 | ||
| 1662 | return val !== undefined ? | |
| 1663 | val : | |
| 1664 | support.attributes || !documentIsHTML ? | |
| 1665 | elem.getAttribute( name ) : | |
| 1666 | ( val = elem.getAttributeNode( name ) ) && val.specified ? | |
| 1667 | val.value : | |
| 1668 | null; | |
| 1669 | }; | |
| 1670 | ||
| 1671 | Sizzle.escape = function( sel ) { | |
| 1672 | return ( sel + "" ).replace( rcssescape, fcssescape ); | |
| 1673 | }; | |
| 1674 | ||
| 1675 | Sizzle.error = function( msg ) { | |
| 1676 | throw new Error( "Syntax error, unrecognized expression: " + msg ); | |
| 1677 | }; | |
| 1678 | ||
| 1679 | /** | |
| 1680 | * Document sorting and removing duplicates | |
| 1681 | * @param {ArrayLike} results | |
| 1682 | */ | |
| 1683 | Sizzle.uniqueSort = function( results ) { | |
| 1684 | var elem, | |
| 1685 | duplicates = [], | |
| 1686 | j = 0, | |
| 1687 | i = 0; | |
| 1688 | ||
| 1689 | // Unless we *know* we can detect duplicates, assume their presence | |
| 1690 | hasDuplicate = !support.detectDuplicates; | |
| 1691 | sortInput = !support.sortStable && results.slice( 0 ); | |
| 1692 | results.sort( sortOrder ); | |
| 1693 | ||
| 1694 | if ( hasDuplicate ) { | |
| 1695 | while ( ( elem = results[ i++ ] ) ) { | |
| 1696 | if ( elem === results[ i ] ) { | |
| 1697 | j = duplicates.push( i ); | |
| 1698 | } | |
| 1699 | } | |
| 1700 | while ( j-- ) { | |
| 1701 | results.splice( duplicates[ j ], 1 ); | |
| 1702 | } | |
| 1703 | } | |
| 1704 | ||
| 1705 | // Clear input after sorting to release objects | |
| 1706 | // See https://github.com/jquery/sizzle/pull/225 | |
| 1707 | sortInput = null; | |
| 1708 | ||
| 1709 | return results; | |
| 1710 | }; | |
| 1711 | ||
| 1712 | /** | |
| 1713 | * Utility function for retrieving the text value of an array of DOM nodes | |
| 1714 | * @param {Array|Element} elem | |
| 1715 | */ | |
| 1716 | getText = Sizzle.getText = function( elem ) { | |
| 1717 | var node, | |
| 1718 | ret = "", | |
| 1719 | i = 0, | |
| 1720 | nodeType = elem.nodeType; | |
| 1721 | ||
| 1722 | if ( !nodeType ) { | |
| 1723 | ||
| 1724 | // If no nodeType, this is expected to be an array | |
| 1725 | while ( ( node = elem[ i++ ] ) ) { | |
| 1726 | ||
| 1727 | // Do not traverse comment nodes | |
| 1728 | ret += getText( node ); | |
| 1729 | } | |
| 1730 | } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { | |
| 1731 | ||
| 1732 | // Use textContent for elements | |
| 1733 | // innerText usage removed for consistency of new lines (jQuery #11153) | |
| 1734 | if ( typeof elem.textContent === "string" ) { | |
| 1735 | return elem.textContent; | |
| 1736 | } else { | |
| 1737 | ||
| 1738 | // Traverse its children | |
| 1739 | for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { | |
| 1740 | ret += getText( elem ); | |
| 1741 | } | |
| 1742 | } | |
| 1743 | } else if ( nodeType === 3 || nodeType === 4 ) { | |
| 1744 | return elem.nodeValue; | |
| 1745 | } | |
| 1746 | ||
| 1747 | // Do not include comment or processing instruction nodes | |
| 1748 | ||
| 1749 | return ret; | |
| 1750 | }; | |
| 1751 | ||
| 1752 | Expr = Sizzle.selectors = { | |
| 1753 | ||
| 1754 | // Can be adjusted by the user | |
| 1755 | cacheLength: 50, | |
| 1756 | ||
| 1757 | createPseudo: markFunction, | |
| 1758 | ||
| 1759 | match: matchExpr, | |
| 1760 | ||
| 1761 | attrHandle: {}, | |
| 1762 | ||
| 1763 | find: {}, | |
| 1764 | ||
| 1765 | relative: { | |
| 1766 | ">": { dir: "parentNode", first: true }, | |
| 1767 | " ": { dir: "parentNode" }, | |
| 1768 | "+": { dir: "previousSibling", first: true }, | |
| 1769 | "~": { dir: "previousSibling" } | |
| 1770 | }, | |
| 1771 | ||
| 1772 | preFilter: { | |
| 1773 | "ATTR": function( match ) { | |
| 1774 | match[ 1 ] = match[ 1 ].replace( runescape, funescape ); | |
| 1775 | ||
| 1776 | // Move the given value to match[3] whether quoted or unquoted | |
| 1777 | match[ 3 ] = ( match[ 3 ] || match[ 4 ] || | |
| 1778 | match[ 5 ] || "" ).replace( runescape, funescape ); | |
| 1779 | ||
| 1780 | if ( match[ 2 ] === "~=" ) { | |
| 1781 | match[ 3 ] = " " + match[ 3 ] + " "; | |
| 1782 | } | |
| 1783 | ||
| 1784 | return match.slice( 0, 4 ); | |
| 1785 | }, | |
| 1786 | ||
| 1787 | "CHILD": function( match ) { | |
| 1788 | ||
| 1789 | /* matches from matchExpr["CHILD"] | |
| 1790 | 1 type (only|nth|...) | |
| 1791 | 2 what (child|of-type) | |
| 1792 | 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) | |
| 1793 | 4 xn-component of xn+y argument ([+-]?\d*n|) | |
| 1794 | 5 sign of xn-component | |
| 1795 | 6 x of xn-component | |
| 1796 | 7 sign of y-component | |
| 1797 | 8 y of y-component | |
| 1798 | */ | |
| 1799 | match[ 1 ] = match[ 1 ].toLowerCase(); | |
| 1800 | ||
| 1801 | if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { | |
| 1802 | ||
| 1803 | // nth-* requires argument | |
| 1804 | if ( !match[ 3 ] ) { | |
| 1805 | Sizzle.error( match[ 0 ] ); | |
| 1806 | } | |
| 1807 | ||
| 1808 | // numeric x and y parameters for Expr.filter.CHILD | |
| 1809 | // remember that false/true cast respectively to 0/1 | |
| 1810 | match[ 4 ] = +( match[ 4 ] ? | |
| 1811 | match[ 5 ] + ( match[ 6 ] || 1 ) : | |
| 1812 | 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); | |
| 1813 | match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); | |
| 1814 | ||
| 1815 | // other types prohibit arguments | |
| 1816 | } else if ( match[ 3 ] ) { | |
| 1817 | Sizzle.error( match[ 0 ] ); | |
| 1818 | } | |
| 1819 | ||
| 1820 | return match; | |
| 1821 | }, | |
| 1822 | ||
| 1823 | "PSEUDO": function( match ) { | |
| 1824 | var excess, | |
| 1825 | unquoted = !match[ 6 ] && match[ 2 ]; | |
| 1826 | ||
| 1827 | if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { | |
| 1828 | return null; | |
| 1829 | } | |
| 1830 | ||
| 1831 | // Accept quoted arguments as-is | |
| 1832 | if ( match[ 3 ] ) { | |
| 1833 | match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; | |
| 1834 | ||
| 1835 | // Strip excess characters from unquoted arguments | |
| 1836 | } else if ( unquoted && rpseudo.test( unquoted ) && | |
| 1837 | ||
| 1838 | // Get excess from tokenize (recursively) | |
| 1839 | ( excess = tokenize( unquoted, true ) ) && | |
| 1840 | ||
| 1841 | // advance to the next closing parenthesis | |
| 1842 | ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { | |
| 1843 | ||
| 1844 | // excess is a negative index | |
| 1845 | match[ 0 ] = match[ 0 ].slice( 0, excess ); | |
| 1846 | match[ 2 ] = unquoted.slice( 0, excess ); | |
| 1847 | } | |
| 1848 | ||
| 1849 | // Return only captures needed by the pseudo filter method (type and argument) | |
| 1850 | return match.slice( 0, 3 ); | |
| 1851 | } | |
| 1852 | }, | |
| 1853 | ||
| 1854 | filter: { | |
| 1855 | ||
| 1856 | "TAG": function( nodeNameSelector ) { | |
| 1857 | var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); | |
| 1858 | return nodeNameSelector === "*" ? | |
| 1859 | function() { | |
| 1860 | return true; | |
| 1861 | } : | |
| 1862 | function( elem ) { | |
| 1863 | return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; | |
| 1864 | }; | |
| 1865 | }, | |
| 1866 | ||
| 1867 | "CLASS": function( className ) { | |
| 1868 | var pattern = classCache[ className + " " ]; | |
| 1869 | ||
| 1870 | return pattern || | |
| 1871 | ( pattern = new RegExp( "(^|" + whitespace + | |
| 1872 | ")" + className + "(" + whitespace + "|$)" ) ) && classCache( | |
| 1873 | className, function( elem ) { | |
| 1874 | return pattern.test( | |
| 1875 | typeof elem.className === "string" && elem.className || | |
| 1876 | typeof elem.getAttribute !== "undefined" && | |
| 1877 | elem.getAttribute( "class" ) || | |
| 1878 | "" | |
| 1879 | ); | |
| 1880 | } ); | |
| 1881 | }, | |
| 1882 | ||
| 1883 | "ATTR": function( name, operator, check ) { | |
| 1884 | return function( elem ) { | |
| 1885 | var result = Sizzle.attr( elem, name ); | |
| 1886 | ||
| 1887 | if ( result == null ) { | |
| 1888 | return operator === "!="; | |
| 1889 | } | |
| 1890 | if ( !operator ) { | |
| 1891 | return true; | |
| 1892 | } | |
| 1893 | ||
| 1894 | result += ""; | |
| 1895 | ||
| 1896 | /* eslint-disable max-len */ | |
| 1897 | ||
| 1898 | return operator === "=" ? result === check : | |
| 1899 | operator === "!=" ? result !== check : | |
| 1900 | operator === "^=" ? check && result.indexOf( check ) === 0 : | |
| 1901 | operator === "*=" ? check && result.indexOf( check ) > -1 : | |
| 1902 | operator === "$=" ? check && result.slice( -check.length ) === check : | |
| 1903 | operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : | |
| 1904 | operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : | |
| 1905 | false; | |
| 1906 | /* eslint-enable max-len */ | |
| 1907 | ||
| 1908 | }; | |
| 1909 | }, | |
| 1910 | ||
| 1911 | "CHILD": function( type, what, _argument, first, last ) { | |
| 1912 | var simple = type.slice( 0, 3 ) !== "nth", | |
| 1913 | forward = type.slice( -4 ) !== "last", | |
| 1914 | ofType = what === "of-type"; | |
| 1915 | ||
| 1916 | return first === 1 && last === 0 ? | |
| 1917 | ||
| 1918 | // Shortcut for :nth-*(n) | |
| 1919 | function( elem ) { | |
| 1920 | return !!elem.parentNode; | |
| 1921 | } : | |
| 1922 | ||
| 1923 | function( elem, _context, xml ) { | |
| 1924 | var cache, uniqueCache, outerCache, node, nodeIndex, start, | |
| 1925 | dir = simple !== forward ? "nextSibling" : "previousSibling", | |
| 1926 | parent = elem.parentNode, | |
| 1927 | name = ofType && elem.nodeName.toLowerCase(), | |
| 1928 | useCache = !xml && !ofType, | |
| 1929 | diff = false; | |
| 1930 | ||
| 1931 | if ( parent ) { | |
| 1932 | ||
| 1933 | // :(first|last|only)-(child|of-type) | |
| 1934 | if ( simple ) { | |
| 1935 | while ( dir ) { | |
| 1936 | node = elem; | |
| 1937 | while ( ( node = node[ dir ] ) ) { | |
| 1938 | if ( ofType ? | |
| 1939 | node.nodeName.toLowerCase() === name : | |
| 1940 | node.nodeType === 1 ) { | |
| 1941 | ||
| 1942 | return false; | |
| 1943 | } | |
| 1944 | } | |
| 1945 | ||
| 1946 | // Reverse direction for :only-* (if we haven't yet done so) | |
| 1947 | start = dir = type === "only" && !start && "nextSibling"; | |
| 1948 | } | |
| 1949 | return true; | |
| 1950 | } | |
| 1951 | ||
| 1952 | start = [ forward ? parent.firstChild : parent.lastChild ]; | |
| 1953 | ||
| 1954 | // non-xml :nth-child(...) stores cache data on `parent` | |
| 1955 | if ( forward && useCache ) { | |
| 1956 | ||
| 1957 | // Seek `elem` from a previously-cached index | |
| 1958 | ||
| 1959 | // ...in a gzip-friendly way | |
| 1960 | node = parent; | |
| 1961 | outerCache = node[ expando ] || ( node[ expando ] = {} ); | |
| 1962 | ||
| 1963 | // Support: IE <9 only | |
| 1964 | // Defend against cloned attroperties (jQuery gh-1709) | |
| 1965 | uniqueCache = outerCache[ node.uniqueID ] || | |
| 1966 | ( outerCache[ node.uniqueID ] = {} ); | |
| 1967 | ||
| 1968 | cache = uniqueCache[ type ] || []; | |
| 1969 | nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; | |
| 1970 | diff = nodeIndex && cache[ 2 ]; | |
| 1971 | node = nodeIndex && parent.childNodes[ nodeIndex ]; | |
| 1972 | ||
| 1973 | while ( ( node = ++nodeIndex && node && node[ dir ] || | |
| 1974 | ||
| 1975 | // Fallback to seeking `elem` from the start | |
| 1976 | ( diff = nodeIndex = 0 ) || start.pop() ) ) { | |
| 1977 | ||
| 1978 | // When found, cache indexes on `parent` and break | |
| 1979 | if ( node.nodeType === 1 && ++diff && node === elem ) { | |
| 1980 | uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; | |
| 1981 | break; | |
| 1982 | } | |
| 1983 | } | |
| 1984 | ||
| 1985 | } else { | |
| 1986 | ||
| 1987 | // Use previously-cached element index if available | |
| 1988 | if ( useCache ) { | |
| 1989 | ||
| 1990 | // ...in a gzip-friendly way | |
| 1991 | node = elem; | |
| 1992 | outerCache = node[ expando ] || ( node[ expando ] = {} ); | |
| 1993 | ||
| 1994 | // Support: IE <9 only | |
| 1995 | // Defend against cloned attroperties (jQuery gh-1709) | |
| 1996 | uniqueCache = outerCache[ node.uniqueID ] || | |
| 1997 | ( outerCache[ node.uniqueID ] = {} ); | |
| 1998 | ||
| 1999 | cache = uniqueCache[ type ] || []; | |
| 2000 | nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; | |
| 2001 | diff = nodeIndex; | |
| 2002 | } | |
| 2003 | ||
| 2004 | // xml :nth-child(...) | |
| 2005 | // or :nth-last-child(...) or :nth(-last)?-of-type(...) | |
| 2006 | if ( diff === false ) { | |
| 2007 | ||
| 2008 | // Use the same loop as above to seek `elem` from the start | |
| 2009 | while ( ( node = ++nodeIndex && node && node[ dir ] || | |
| 2010 | ( diff = nodeIndex = 0 ) || start.pop() ) ) { | |
| 2011 | ||
| 2012 | if ( ( ofType ? | |
| 2013 | node.nodeName.toLowerCase() === name : | |
| 2014 | node.nodeType === 1 ) && | |
| 2015 | ++diff ) { | |
| 2016 | ||
| 2017 | // Cache the index of each encountered element | |
| 2018 | if ( useCache ) { | |
| 2019 | outerCache = node[ expando ] || | |
| 2020 | ( node[ expando ] = {} ); | |
| 2021 | ||
| 2022 | // Support: IE <9 only | |
| 2023 | // Defend against cloned attroperties (jQuery gh-1709) | |
| 2024 | uniqueCache = outerCache[ node.uniqueID ] || | |
| 2025 | ( outerCache[ node.uniqueID ] = {} ); | |
| 2026 | ||
| 2027 | uniqueCache[ type ] = [ dirruns, diff ]; | |
| 2028 | } | |
| 2029 | ||
| 2030 | if ( node === elem ) { | |
| 2031 | break; | |
| 2032 | } | |
| 2033 | } | |
| 2034 | } | |
| 2035 | } | |
| 2036 | } | |
| 2037 | ||
| 2038 | // Incorporate the offset, then check against cycle size | |
| 2039 | diff -= last; | |
| 2040 | return diff === first || ( diff % first === 0 && diff / first >= 0 ); | |
| 2041 | } | |
| 2042 | }; | |
| 2043 | }, | |
| 2044 | ||
| 2045 | "PSEUDO": function( pseudo, argument ) { | |
| 2046 | ||
| 2047 | // pseudo-class names are case-insensitive | |
| 2048 | // http://www.w3.org/TR/selectors/#pseudo-classes | |
| 2049 | // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters | |
| 2050 | // Remember that setFilters inherits from pseudos | |
| 2051 | var args, | |
| 2052 | fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || | |
| 2053 | Sizzle.error( "unsupported pseudo: " + pseudo ); | |
| 2054 | ||
| 2055 | // The user may use createPseudo to indicate that | |
| 2056 | // arguments are needed to create the filter function | |
| 2057 | // just as Sizzle does | |
| 2058 | if ( fn[ expando ] ) { | |
| 2059 | return fn( argument ); | |
| 2060 | } | |
| 2061 | ||
| 2062 | // But maintain support for old signatures | |
| 2063 | if ( fn.length > 1 ) { | |
| 2064 | args = [ pseudo, pseudo, "", argument ]; | |
| 2065 | return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? | |
| 2066 | markFunction( function( seed, matches ) { | |
| 2067 | var idx, | |
| 2068 | matched = fn( seed, argument ), | |
| 2069 | i = matched.length; | |
| 2070 | while ( i-- ) { | |
| 2071 | idx = indexOf( seed, matched[ i ] ); | |
| 2072 | seed[ idx ] = !( matches[ idx ] = matched[ i ] ); | |
| 2073 | } | |
| 2074 | } ) : | |
| 2075 | function( elem ) { | |
| 2076 | return fn( elem, 0, args ); | |
| 2077 | }; | |
| 2078 | } | |
| 2079 | ||
| 2080 | return fn; | |
| 2081 | } | |
| 2082 | }, | |
| 2083 | ||
| 2084 | pseudos: { | |
| 2085 | ||
| 2086 | // Potentially complex pseudos | |
| 2087 | "not": markFunction( function( selector ) { | |
| 2088 | ||
| 2089 | // Trim the selector passed to compile | |
| 2090 | // to avoid treating leading and trailing | |
| 2091 | // spaces as combinators | |
| 2092 | var input = [], | |
| 2093 | results = [], | |
| 2094 | matcher = compile( selector.replace( rtrim, "$1" ) ); | |
| 2095 | ||
| 2096 | return matcher[ expando ] ? | |
| 2097 | markFunction( function( seed, matches, _context, xml ) { | |
| 2098 | var elem, | |
| 2099 | unmatched = matcher( seed, null, xml, [] ), | |
| 2100 | i = seed.length; | |
| 2101 | ||
| 2102 | // Match elements unmatched by `matcher` | |
| 2103 | while ( i-- ) { | |
| 2104 | if ( ( elem = unmatched[ i ] ) ) { | |
| 2105 | seed[ i ] = !( matches[ i ] = elem ); | |
| 2106 | } | |
| 2107 | } | |
| 2108 | } ) : | |
| 2109 | function( elem, _context, xml ) { | |
| 2110 | input[ 0 ] = elem; | |
| 2111 | matcher( input, null, xml, results ); | |
| 2112 | ||
| 2113 | // Don't keep the element (issue #299) | |
| 2114 | input[ 0 ] = null; | |
| 2115 | return !results.pop(); | |
| 2116 | }; | |
| 2117 | } ), | |
| 2118 | ||
| 2119 | "has": markFunction( function( selector ) { | |
| 2120 | return function( elem ) { | |
| 2121 | return Sizzle( selector, elem ).length > 0; | |
| 2122 | }; | |
| 2123 | } ), | |
| 2124 | ||
| 2125 | "contains": markFunction( function( text ) { | |
| 2126 | text = text.replace( runescape, funescape ); | |
| 2127 | return function( elem ) { | |
| 2128 | return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; | |
| 2129 | }; | |
| 2130 | } ), | |
| 2131 | ||
| 2132 | // "Whether an element is represented by a :lang() selector | |
| 2133 | // is based solely on the element's language value | |
| 2134 | // being equal to the identifier C, | |
| 2135 | // or beginning with the identifier C immediately followed by "-". | |
| 2136 | // The matching of C against the element's language value is performed case-insensitively. | |
| 2137 | // The identifier C does not have to be a valid language name." | |
| 2138 | // http://www.w3.org/TR/selectors/#lang-pseudo | |
| 2139 | "lang": markFunction( function( lang ) { | |
| 2140 | ||
| 2141 | // lang value must be a valid identifier | |
| 2142 | if ( !ridentifier.test( lang || "" ) ) { | |
| 2143 | Sizzle.error( "unsupported lang: " + lang ); | |
| 2144 | } | |
| 2145 | lang = lang.replace( runescape, funescape ).toLowerCase(); | |
| 2146 | return function( elem ) { | |
| 2147 | var elemLang; | |
| 2148 | do { | |
| 2149 | if ( ( elemLang = documentIsHTML ? | |
| 2150 | elem.lang : | |
| 2151 | elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { | |
| 2152 | ||
| 2153 | elemLang = elemLang.toLowerCase(); | |
| 2154 | return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; | |
| 2155 | } | |
| 2156 | } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); | |
| 2157 | return false; | |
| 2158 | }; | |
| 2159 | } ), | |
| 2160 | ||
| 2161 | // Miscellaneous | |
| 2162 | "target": function( elem ) { | |
| 2163 | var hash = window.location && window.location.hash; | |
| 2164 | return hash && hash.slice( 1 ) === elem.id; | |
| 2165 | }, | |
| 2166 | ||
| 2167 | "root": function( elem ) { | |
| 2168 | return elem === docElem; | |
| 2169 | }, | |
| 2170 | ||
| 2171 | "focus": function( elem ) { | |
| 2172 | return elem === document.activeElement && | |
| 2173 | ( !document.hasFocus || document.hasFocus() ) && | |
| 2174 | !!( elem.type || elem.href || ~elem.tabIndex ); | |
| 2175 | }, | |
| 2176 | ||
| 2177 | // Boolean properties | |
| 2178 | "enabled": createDisabledPseudo( false ), | |
| 2179 | "disabled": createDisabledPseudo( true ), | |
| 2180 | ||
| 2181 | "checked": function( elem ) { | |
| 2182 | ||
| 2183 | // In CSS3, :checked should return both checked and selected elements | |
| 2184 | // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked | |
| 2185 | var nodeName = elem.nodeName.toLowerCase(); | |
| 2186 | return ( nodeName === "input" && !!elem.checked ) || | |
| 2187 | ( nodeName === "option" && !!elem.selected ); | |
| 2188 | }, | |
| 2189 | ||
| 2190 | "selected": function( elem ) { | |
| 2191 | ||
| 2192 | // Accessing this property makes selected-by-default | |
| 2193 | // options in Safari work properly | |
| 2194 | if ( elem.parentNode ) { | |
| 2195 | // eslint-disable-next-line no-unused-expressions | |
| 2196 | elem.parentNode.selectedIndex; | |
| 2197 | } | |
| 2198 | ||
| 2199 | return elem.selected === true; | |
| 2200 | }, | |
| 2201 | ||
| 2202 | // Contents | |
| 2203 | "empty": function( elem ) { | |
| 2204 | ||
| 2205 | // http://www.w3.org/TR/selectors/#empty-pseudo | |
| 2206 | // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), | |
| 2207 | // but not by others (comment: 8; processing instruction: 7; etc.) | |
| 2208 | // nodeType < 6 works because attributes (2) do not appear as children | |
| 2209 | for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { | |
| 2210 | if ( elem.nodeType < 6 ) { | |
| 2211 | return false; | |
| 2212 | } | |
| 2213 | } | |
| 2214 | return true; | |
| 2215 | }, | |
| 2216 | ||
| 2217 | "parent": function( elem ) { | |
| 2218 | return !Expr.pseudos[ "empty" ]( elem ); | |
| 2219 | }, | |
| 2220 | ||
| 2221 | // Element/input types | |
| 2222 | "header": function( elem ) { | |
| 2223 | return rheader.test( elem.nodeName ); | |
| 2224 | }, | |
| 2225 | ||
| 2226 | "input": function( elem ) { | |
| 2227 | return rinputs.test( elem.nodeName ); | |
| 2228 | }, | |
| 2229 | ||
| 2230 | "button": function( elem ) { | |
| 2231 | var name = elem.nodeName.toLowerCase(); | |
| 2232 | return name === "input" && elem.type === "button" || name === "button"; | |
| 2233 | }, | |
| 2234 | ||
| 2235 | "text": function( elem ) { | |
| 2236 | var attr; | |
| 2237 | return elem.nodeName.toLowerCase() === "input" && | |
| 2238 | elem.type === "text" && | |
| 2239 | ||
| 2240 | // Support: IE<8 | |
| 2241 | // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" | |
| 2242 | ( ( attr = elem.getAttribute( "type" ) ) == null || | |
| 2243 | attr.toLowerCase() === "text" ); | |
| 2244 | }, | |
| 2245 | ||
| 2246 | // Position-in-collection | |
| 2247 | "first": createPositionalPseudo( function() { | |
| 2248 | return [ 0 ]; | |
| 2249 | } ), | |
| 2250 | ||
| 2251 | "last": createPositionalPseudo( function( _matchIndexes, length ) { | |
| 2252 | return [ length - 1 ]; | |
| 2253 | } ), | |
| 2254 | ||
| 2255 | "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { | |
| 2256 | return [ argument < 0 ? argument + length : argument ]; | |
| 2257 | } ), | |
| 2258 | ||
| 2259 | "even": createPositionalPseudo( function( matchIndexes, length ) { | |
| 2260 | var i = 0; | |
| 2261 | for ( ; i < length; i += 2 ) { | |
| 2262 | matchIndexes.push( i ); | |
| 2263 | } | |
| 2264 | return matchIndexes; | |
| 2265 | } ), | |
| 2266 | ||
| 2267 | "odd": createPositionalPseudo( function( matchIndexes, length ) { | |
| 2268 | var i = 1; | |
| 2269 | for ( ; i < length; i += 2 ) { | |
| 2270 | matchIndexes.push( i ); | |
| 2271 | } | |
| 2272 | return matchIndexes; | |
| 2273 | } ), | |
| 2274 | ||
| 2275 | "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { | |
| 2276 | var i = argument < 0 ? | |
| 2277 | argument + length : | |
| 2278 | argument > length ? | |
| 2279 | length : | |
| 2280 | argument; | |
| 2281 | for ( ; --i >= 0; ) { | |
| 2282 | matchIndexes.push( i ); | |
| 2283 | } | |
| 2284 | return matchIndexes; | |
| 2285 | } ), | |
| 2286 | ||
| 2287 | "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { | |
| 2288 | var i = argument < 0 ? argument + length : argument; | |
| 2289 | for ( ; ++i < length; ) { | |
| 2290 | matchIndexes.push( i ); | |
| 2291 | } | |
| 2292 | return matchIndexes; | |
| 2293 | } ) | |
| 2294 | } | |
| 2295 | }; | |
| 2296 | ||
| 2297 | Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; | |
| 2298 | ||
| 2299 | // Add button/input type pseudos | |
| 2300 | for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { | |
| 2301 | Expr.pseudos[ i ] = createInputPseudo( i ); | |
| 2302 | } | |
| 2303 | for ( i in { submit: true, reset: true } ) { | |
| 2304 | Expr.pseudos[ i ] = createButtonPseudo( i ); | |
| 2305 | } | |
| 2306 | ||
| 2307 | // Easy API for creating new setFilters | |
| 2308 | function setFilters() {} | |
| 2309 | setFilters.prototype = Expr.filters = Expr.pseudos; | |
| 2310 | Expr.setFilters = new setFilters(); | |
| 2311 | ||
| 2312 | tokenize = Sizzle.tokenize = function( selector, parseOnly ) { | |
| 2313 | var matched, match, tokens, type, | |
| 2314 | soFar, groups, preFilters, | |
| 2315 | cached = tokenCache[ selector + " " ]; | |
| 2316 | ||
| 2317 | if ( cached ) { | |
| 2318 | return parseOnly ? 0 : cached.slice( 0 ); | |
| 2319 | } | |
| 2320 | ||
| 2321 | soFar = selector; | |
| 2322 | groups = []; | |
| 2323 | preFilters = Expr.preFilter; | |
| 2324 | ||
| 2325 | while ( soFar ) { | |
| 2326 | ||
| 2327 | // Comma and first run | |
| 2328 | if ( !matched || ( match = rcomma.exec( soFar ) ) ) { | |
| 2329 | if ( match ) { | |
| 2330 | ||
| 2331 | // Don't consume trailing commas as valid | |
| 2332 | soFar = soFar.slice( match[ 0 ].length ) || soFar; | |
| 2333 | } | |
| 2334 | groups.push( ( tokens = [] ) ); | |
| 2335 | } | |
| 2336 | ||
| 2337 | matched = false; | |
| 2338 | ||
| 2339 | // Combinators | |
| 2340 | if ( ( match = rcombinators.exec( soFar ) ) ) { | |
| 2341 | matched = match.shift(); | |
| 2342 | tokens.push( { | |
| 2343 | value: matched, | |
| 2344 | ||
| 2345 | // Cast descendant combinators to space | |
| 2346 | type: match[ 0 ].replace( rtrim, " " ) | |
| 2347 | } ); | |
| 2348 | soFar = soFar.slice( matched.length ); | |
| 2349 | } | |
| 2350 | ||
| 2351 | // Filters | |
| 2352 | for ( type in Expr.filter ) { | |
| 2353 | if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || | |
| 2354 | ( match = preFilters[ type ]( match ) ) ) ) { | |
| 2355 | matched = match.shift(); | |
| 2356 | tokens.push( { | |
| 2357 | value: matched, | |
| 2358 | type: type, | |
| 2359 | matches: match | |
| 2360 | } ); | |
| 2361 | soFar = soFar.slice( matched.length ); | |
| 2362 | } | |
| 2363 | } | |
| 2364 | ||
| 2365 | if ( !matched ) { | |
| 2366 | break; | |
| 2367 | } | |
| 2368 | } | |
| 2369 | ||
| 2370 | // Return the length of the invalid excess | |
| 2371 | // if we're just parsing | |
| 2372 | // Otherwise, throw an error or return tokens | |
| 2373 | return parseOnly ? | |
| 2374 | soFar.length : | |
| 2375 | soFar ? | |
| 2376 | Sizzle.error( selector ) : | |
| 2377 | ||
| 2378 | // Cache the tokens | |
| 2379 | tokenCache( selector, groups ).slice( 0 ); | |
| 2380 | }; | |
| 2381 | ||
| 2382 | function toSelector( tokens ) { | |
| 2383 | var i = 0, | |
| 2384 | len = tokens.length, | |
| 2385 | selector = ""; | |
| 2386 | for ( ; i < len; i++ ) { | |
| 2387 | selector += tokens[ i ].value; | |
| 2388 | } | |
| 2389 | return selector; | |
| 2390 | } | |
| 2391 | ||
| 2392 | function addCombinator( matcher, combinator, base ) { | |
| 2393 | var dir = combinator.dir, | |
| 2394 | skip = combinator.next, | |
| 2395 | key = skip || dir, | |
| 2396 | checkNonElements = base && key === "parentNode", | |
| 2397 | doneName = done++; | |
| 2398 | ||
| 2399 | return combinator.first ? | |
| 2400 | ||
| 2401 | // Check against closest ancestor/preceding element | |
| 2402 | function( elem, context, xml ) { | |
| 2403 | while ( ( elem = elem[ dir ] ) ) { | |
| 2404 | if ( elem.nodeType === 1 || checkNonElements ) { | |
| 2405 | return matcher( elem, context, xml ); | |
| 2406 | } | |
| 2407 | } | |
| 2408 | return false; | |
| 2409 | } : | |
| 2410 | ||
| 2411 | // Check against all ancestor/preceding elements | |
| 2412 | function( elem, context, xml ) { | |
| 2413 | var oldCache, uniqueCache, outerCache, | |
| 2414 | newCache = [ dirruns, doneName ]; | |
| 2415 | ||
| 2416 | // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching | |
| 2417 | if ( xml ) { | |
| 2418 | while ( ( elem = elem[ dir ] ) ) { | |
| 2419 | if ( elem.nodeType === 1 || checkNonElements ) { | |
| 2420 | if ( matcher( elem, context, xml ) ) { | |
| 2421 | return true; | |
| 2422 | } | |
| 2423 | } | |
| 2424 | } | |
| 2425 | } else { | |
| 2426 | while ( ( elem = elem[ dir ] ) ) { | |
| 2427 | if ( elem.nodeType === 1 || checkNonElements ) { | |
| 2428 | outerCache = elem[ expando ] || ( elem[ expando ] = {} ); | |
| 2429 | ||
| 2430 | // Support: IE <9 only | |
| 2431 | // Defend against cloned attroperties (jQuery gh-1709) | |
| 2432 | uniqueCache = outerCache[ elem.uniqueID ] || | |
| 2433 | ( outerCache[ elem.uniqueID ] = {} ); | |
| 2434 | ||
| 2435 | if ( skip && skip === elem.nodeName.toLowerCase() ) { | |
| 2436 | elem = elem[ dir ] || elem; | |
| 2437 | } else if ( ( oldCache = uniqueCache[ key ] ) && | |
| 2438 | oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { | |
| 2439 | ||
| 2440 | // Assign to newCache so results back-propagate to previous elements | |
| 2441 | return ( newCache[ 2 ] = oldCache[ 2 ] ); | |
| 2442 | } else { | |
| 2443 | ||
| 2444 | // Reuse newcache so results back-propagate to previous elements | |
| 2445 | uniqueCache[ key ] = newCache; | |
| 2446 | ||
| 2447 | // A match means we're done; a fail means we have to keep checking | |
| 2448 | if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { | |
| 2449 | return true; | |
| 2450 | } | |
| 2451 | } | |
| 2452 | } | |
| 2453 | } | |
| 2454 | } | |
| 2455 | return false; | |
| 2456 | }; | |
| 2457 | } | |
| 2458 | ||
| 2459 | function elementMatcher( matchers ) { | |
| 2460 | return matchers.length > 1 ? | |
| 2461 | function( elem, context, xml ) { | |
| 2462 | var i = matchers.length; | |
| 2463 | while ( i-- ) { | |
| 2464 | if ( !matchers[ i ]( elem, context, xml ) ) { | |
| 2465 | return false; | |
| 2466 | } | |
| 2467 | } | |
| 2468 | return true; | |
| 2469 | } : | |
| 2470 | matchers[ 0 ]; | |
| 2471 | } | |
| 2472 | ||
| 2473 | function multipleContexts( selector, contexts, results ) { | |
| 2474 | var i = 0, | |
| 2475 | len = contexts.length; | |
| 2476 | for ( ; i < len; i++ ) { | |
| 2477 | Sizzle( selector, contexts[ i ], results ); | |
| 2478 | } | |
| 2479 | return results; | |
| 2480 | } | |
| 2481 | ||
| 2482 | function condense( unmatched, map, filter, context, xml ) { | |
| 2483 | var elem, | |
| 2484 | newUnmatched = [], | |
| 2485 | i = 0, | |
| 2486 | len = unmatched.length, | |
| 2487 | mapped = map != null; | |
| 2488 | ||
| 2489 | for ( ; i < len; i++ ) { | |
| 2490 | if ( ( elem = unmatched[ i ] ) ) { | |
| 2491 | if ( !filter || filter( elem, context, xml ) ) { | |
| 2492 | newUnmatched.push( elem ); | |
| 2493 | if ( mapped ) { | |
| 2494 | map.push( i ); | |
| 2495 | } | |
| 2496 | } | |
| 2497 | } | |
| 2498 | } | |
| 2499 | ||
| 2500 | return newUnmatched; | |
| 2501 | } | |
| 2502 | ||
| 2503 | function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { | |
| 2504 | if ( postFilter && !postFilter[ expando ] ) { | |
| 2505 | postFilter = setMatcher( postFilter ); | |
| 2506 | } | |
| 2507 | if ( postFinder && !postFinder[ expando ] ) { | |
| 2508 | postFinder = setMatcher( postFinder, postSelector ); | |
| 2509 | } | |
| 2510 | return markFunction( function( seed, results, context, xml ) { | |
| 2511 | var temp, i, elem, | |
| 2512 | preMap = [], | |
| 2513 | postMap = [], | |
| 2514 | preexisting = results.length, | |
| 2515 | ||
| 2516 | // Get initial elements from seed or context | |
| 2517 | elems = seed || multipleContexts( | |
| 2518 | selector || "*", | |
| 2519 | context.nodeType ? [ context ] : context, | |
| 2520 | [] | |
| 2521 | ), | |
| 2522 | ||
| 2523 | // Prefilter to get matcher input, preserving a map for seed-results synchronization | |
| 2524 | matcherIn = preFilter && ( seed || !selector ) ? | |
| 2525 | condense( elems, preMap, preFilter, context, xml ) : | |
| 2526 | elems, | |
| 2527 | ||
| 2528 | matcherOut = matcher ? | |
| 2529 | ||
| 2530 | // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, | |
| 2531 | postFinder || ( seed ? preFilter : preexisting || postFilter ) ? | |
| 2532 | ||
| 2533 | // ...intermediate processing is necessary | |
| 2534 | [] : | |
| 2535 | ||
| 2536 | // ...otherwise use results directly | |
| 2537 | results : | |
| 2538 | matcherIn; | |
| 2539 | ||
| 2540 | // Find primary matches | |
| 2541 | if ( matcher ) { | |
| 2542 | matcher( matcherIn, matcherOut, context, xml ); | |
| 2543 | } | |
| 2544 | ||
| 2545 | // Apply postFilter | |
| 2546 | if ( postFilter ) { | |
| 2547 | temp = condense( matcherOut, postMap ); | |
| 2548 | postFilter( temp, [], context, xml ); | |
| 2549 | ||
| 2550 | // Un-match failing elements by moving them back to matcherIn | |
| 2551 | i = temp.length; | |
| 2552 | while ( i-- ) { | |
| 2553 | if ( ( elem = temp[ i ] ) ) { | |
| 2554 | matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); | |
| 2555 | } | |
| 2556 | } | |
| 2557 | } | |
| 2558 | ||
| 2559 | if ( seed ) { | |
| 2560 | if ( postFinder || preFilter ) { | |
| 2561 | if ( postFinder ) { | |
| 2562 | ||
| 2563 | // Get the final matcherOut by condensing this intermediate into postFinder contexts | |
| 2564 | temp = []; | |
| 2565 | i = matcherOut.length; | |
| 2566 | while ( i-- ) { | |
| 2567 | if ( ( elem = matcherOut[ i ] ) ) { | |
| 2568 | ||
| 2569 | // Restore matcherIn since elem is not yet a final match | |
| 2570 | temp.push( ( matcherIn[ i ] = elem ) ); | |
| 2571 | } | |
| 2572 | } | |
| 2573 | postFinder( null, ( matcherOut = [] ), temp, xml ); | |
| 2574 | } | |
| 2575 | ||
| 2576 | // Move matched elements from seed to results to keep them synchronized | |
| 2577 | i = matcherOut.length; | |
| 2578 | while ( i-- ) { | |
| 2579 | if ( ( elem = matcherOut[ i ] ) && | |
| 2580 | ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { | |
| 2581 | ||
| 2582 | seed[ temp ] = !( results[ temp ] = elem ); | |
| 2583 | } | |
| 2584 | } | |
| 2585 | } | |
| 2586 | ||
| 2587 | // Add elements to results, through postFinder if defined | |
| 2588 | } else { | |
| 2589 | matcherOut = condense( | |
| 2590 | matcherOut === results ? | |
| 2591 | matcherOut.splice( preexisting, matcherOut.length ) : | |
| 2592 | matcherOut | |
| 2593 | ); | |
| 2594 | if ( postFinder ) { | |
| 2595 | postFinder( null, results, matcherOut, xml ); | |
| 2596 | } else { | |
| 2597 | push.apply( results, matcherOut ); | |
| 2598 | } | |
| 2599 | } | |
| 2600 | } ); | |
| 2601 | } | |
| 2602 | ||
| 2603 | function matcherFromTokens( tokens ) { | |
| 2604 | var checkContext, matcher, j, | |
| 2605 | len = tokens.length, | |
| 2606 | leadingRelative = Expr.relative[ tokens[ 0 ].type ], | |
| 2607 | implicitRelative = leadingRelative || Expr.relative[ " " ], | |
| 2608 | i = leadingRelative ? 1 : 0, | |
| 2609 | ||
| 2610 | // The foundational matcher ensures that elements are reachable from top-level context(s) | |
| 2611 | matchContext = addCombinator( function( elem ) { | |
| 2612 | return elem === checkContext; | |
| 2613 | }, implicitRelative, true ), | |
| 2614 | matchAnyContext = addCombinator( function( elem ) { | |
| 2615 | return indexOf( checkContext, elem ) > -1; | |
| 2616 | }, implicitRelative, true ), | |
| 2617 | matchers = [ function( elem, context, xml ) { | |
| 2618 | var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( | |
| 2619 | ( checkContext = context ).nodeType ? | |
| 2620 | matchContext( elem, context, xml ) : | |
| 2621 | matchAnyContext( elem, context, xml ) ); | |
| 2622 | ||
| 2623 | // Avoid hanging onto element (issue #299) | |
| 2624 | checkContext = null; | |
| 2625 | return ret; | |
| 2626 | } ]; | |
| 2627 | ||
| 2628 | for ( ; i < len; i++ ) { | |
| 2629 | if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { | |
| 2630 | matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; | |
| 2631 | } else { | |
| 2632 | matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); | |
| 2633 | ||
| 2634 | // Return special upon seeing a positional matcher | |
| 2635 | if ( matcher[ expando ] ) { | |
| 2636 | ||
| 2637 | // Find the next relative operator (if any) for proper handling | |
| 2638 | j = ++i; | |
| 2639 | for ( ; j < len; j++ ) { | |
| 2640 | if ( Expr.relative[ tokens[ j ].type ] ) { | |
| 2641 | break; | |
| 2642 | } | |
| 2643 | } | |
| 2644 | return setMatcher( | |
| 2645 | i > 1 && elementMatcher( matchers ), | |
| 2646 | i > 1 && toSelector( | |
| 2647 | ||
| 2648 | // If the preceding token was a descendant combinator, insert an implicit any-element `*` | |
| 2649 | tokens | |
| 2650 | .slice( 0, i - 1 ) | |
| 2651 | .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) | |
| 2652 | ).replace( rtrim, "$1" ), | |
| 2653 | matcher, | |
| 2654 | i < j && matcherFromTokens( tokens.slice( i, j ) ), | |
| 2655 | j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), | |
| 2656 | j < len && toSelector( tokens ) | |
| 2657 | ); | |
| 2658 | } | |
| 2659 | matchers.push( matcher ); | |
| 2660 | } | |
| 2661 | } | |
| 2662 | ||
| 2663 | return elementMatcher( matchers ); | |
| 2664 | } | |
| 2665 | ||
| 2666 | function matcherFromGroupMatchers( elementMatchers, setMatchers ) { | |
| 2667 | var bySet = setMatchers.length > 0, | |
| 2668 | byElement = elementMatchers.length > 0, | |
| 2669 | superMatcher = function( seed, context, xml, results, outermost ) { | |
| 2670 | var elem, j, matcher, | |
| 2671 | matchedCount = 0, | |
| 2672 | i = "0", | |
| 2673 | unmatched = seed && [], | |
| 2674 | setMatched = [], | |
| 2675 | contextBackup = outermostContext, | |
| 2676 | ||
| 2677 | // We must always have either seed elements or outermost context | |
| 2678 | elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), | |
| 2679 | ||
| 2680 | // Use integer dirruns iff this is the outermost matcher | |
| 2681 | dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), | |
| 2682 | len = elems.length; | |
| 2683 | ||
| 2684 | if ( outermost ) { | |
| 2685 | ||
| 2686 | // Support: IE 11+, Edge 17 - 18+ | |
| 2687 | // IE/Edge sometimes throw a "Permission denied" error when strict-comparing | |
| 2688 | // two documents; shallow comparisons work. | |
| 2689 | // eslint-disable-next-line eqeqeq | |
| 2690 | outermostContext = context == document || context || outermost; | |
| 2691 | } | |
| 2692 | ||
| 2693 | // Add elements passing elementMatchers directly to results | |
| 2694 | // Support: IE<9, Safari | |
| 2695 | // Tolerate NodeList properties (IE: "length"; Safari: <number>) matching elements by id | |
| 2696 | for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { | |
| 2697 | if ( byElement && elem ) { | |
| 2698 | j = 0; | |
| 2699 | ||
| 2700 | // Support: IE 11+, Edge 17 - 18+ | |
| 2701 | // IE/Edge sometimes throw a "Permission denied" error when strict-comparing | |
| 2702 | // two documents; shallow comparisons work. | |
| 2703 | // eslint-disable-next-line eqeqeq | |
| 2704 | if ( !context && elem.ownerDocument != document ) { | |
| 2705 | setDocument( elem ); | |
| 2706 | xml = !documentIsHTML; | |
| 2707 | } | |
| 2708 | while ( ( matcher = elementMatchers[ j++ ] ) ) { | |
| 2709 | if ( matcher( elem, context || document, xml ) ) { | |
| 2710 | results.push( elem ); | |
| 2711 | break; | |
| 2712 | } | |
| 2713 | } | |
| 2714 | if ( outermost ) { | |
| 2715 | dirruns = dirrunsUnique; | |
| 2716 | } | |
| 2717 | } | |
| 2718 | ||
| 2719 | // Track unmatched elements for set filters | |
| 2720 | if ( bySet ) { | |
| 2721 | ||
| 2722 | // They will have gone through all possible matchers | |
| 2723 | if ( ( elem = !matcher && elem ) ) { | |
| 2724 | matchedCount--; | |
| 2725 | } | |
| 2726 | ||
| 2727 | // Lengthen the array for every element, matched or not | |
| 2728 | if ( seed ) { | |
| 2729 | unmatched.push( elem ); | |
| 2730 | } | |
| 2731 | } | |
| 2732 | } | |
| 2733 | ||
| 2734 | // `i` is now the count of elements visited above, and adding it to `matchedCount` | |
| 2735 | // makes the latter nonnegative. | |
| 2736 | matchedCount += i; | |
| 2737 | ||
| 2738 | // Apply set filters to unmatched elements | |
| 2739 | // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` | |
| 2740 | // equals `i`), unless we didn't visit _any_ elements in the above loop because we have | |
| 2741 | // no element matchers and no seed. | |
| 2742 | // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that | |
| 2743 | // case, which will result in a "00" `matchedCount` that differs from `i` but is also | |
| 2744 | // numerically zero. | |
| 2745 | if ( bySet && i !== matchedCount ) { | |
| 2746 | j = 0; | |
| 2747 | while ( ( matcher = setMatchers[ j++ ] ) ) { | |
| 2748 | matcher( unmatched, setMatched, context, xml ); | |
| 2749 | } | |
| 2750 | ||
| 2751 | if ( seed ) { | |
| 2752 | ||
| 2753 | // Reintegrate element matches to eliminate the need for sorting | |
| 2754 | if ( matchedCount > 0 ) { | |
| 2755 | while ( i-- ) { | |
| 2756 | if ( !( unmatched[ i ] || setMatched[ i ] ) ) { | |
| 2757 | setMatched[ i ] = pop.call( results ); | |
| 2758 | } | |
| 2759 | } | |
| 2760 | } | |
| 2761 | ||
| 2762 | // Discard index placeholder values to get only actual matches | |
| 2763 | setMatched = condense( setMatched ); | |
| 2764 | } | |
| 2765 | ||
| 2766 | // Add matches to results | |
| 2767 | push.apply( results, setMatched ); | |
| 2768 | ||
| 2769 | // Seedless set matches succeeding multiple successful matchers stipulate sorting | |
| 2770 | if ( outermost && !seed && setMatched.length > 0 && | |
| 2771 | ( matchedCount + setMatchers.length ) > 1 ) { | |
| 2772 | ||
| 2773 | Sizzle.uniqueSort( results ); | |
| 2774 | } | |
| 2775 | } | |
| 2776 | ||
| 2777 | // Override manipulation of globals by nested matchers | |
| 2778 | if ( outermost ) { | |
| 2779 | dirruns = dirrunsUnique; | |
| 2780 | outermostContext = contextBackup; | |
| 2781 | } | |
| 2782 | ||
| 2783 | return unmatched; | |
| 2784 | }; | |
| 2785 | ||
| 2786 | return bySet ? | |
| 2787 | markFunction( superMatcher ) : | |
| 2788 | superMatcher; | |
| 2789 | } | |
| 2790 | ||
| 2791 | compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { | |
| 2792 | var i, | |
| 2793 | setMatchers = [], | |
| 2794 | elementMatchers = [], | |
| 2795 | cached = compilerCache[ selector + " " ]; | |
| 2796 | ||
| 2797 | if ( !cached ) { | |
| 2798 | ||
| 2799 | // Generate a function of recursive functions that can be used to check each element | |
| 2800 | if ( !match ) { | |
| 2801 | match = tokenize( selector ); | |
| 2802 | } | |
| 2803 | i = match.length; | |
| 2804 | while ( i-- ) { | |
| 2805 | cached = matcherFromTokens( match[ i ] ); | |
| 2806 | if ( cached[ expando ] ) { | |
| 2807 | setMatchers.push( cached ); | |
| 2808 | } else { | |
| 2809 | elementMatchers.push( cached ); | |
| 2810 | } | |
| 2811 | } | |
| 2812 | ||
| 2813 | // Cache the compiled function | |
| 2814 | cached = compilerCache( | |
| 2815 | selector, | |
| 2816 | matcherFromGroupMatchers( elementMatchers, setMatchers ) | |
| 2817 | ); | |
| 2818 | ||
| 2819 | // Save selector and tokenization | |
| 2820 | cached.selector = selector; | |
| 2821 | } | |
| 2822 | return cached; | |
| 2823 | }; | |
| 2824 | ||
| 2825 | /** | |
| 2826 | * A low-level selection function that works with Sizzle's compiled | |
| 2827 | * selector functions | |
| 2828 | * @param {String|Function} selector A selector or a pre-compiled | |
| 2829 | * selector function built with Sizzle.compile | |
| 2830 | * @param {Element} context | |
| 2831 | * @param {Array} [results] | |
| 2832 | * @param {Array} [seed] A set of elements to match against | |
| 2833 | */ | |
| 2834 | select = Sizzle.select = function( selector, context, results, seed ) { | |
| 2835 | var i, tokens, token, type, find, | |
| 2836 | compiled = typeof selector === "function" && selector, | |
| 2837 | match = !seed && tokenize( ( selector = compiled.selector || selector ) ); | |
| 2838 | ||
| 2839 | results = results || []; | |
| 2840 | ||
| 2841 | // Try to minimize operations if there is only one selector in the list and no seed | |
| 2842 | // (the latter of which guarantees us context) | |
| 2843 | if ( match.length === 1 ) { | |
| 2844 | ||
| 2845 | // Reduce context if the leading compound selector is an ID | |
| 2846 | tokens = match[ 0 ] = match[ 0 ].slice( 0 ); | |
| 2847 | if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && | |
| 2848 | context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { | |
| 2849 | ||
| 2850 | context = ( Expr.find[ "ID" ]( token.matches[ 0 ] | |
| 2851 | .replace( runescape, funescape ), context ) || [] )[ 0 ]; | |
| 2852 | if ( !context ) { | |
| 2853 | return results; | |
| 2854 | ||
| 2855 | // Precompiled matchers will still verify ancestry, so step up a level | |
| 2856 | } else if ( compiled ) { | |
| 2857 | context = context.parentNode; | |
| 2858 | } | |
| 2859 | ||
| 2860 | selector = selector.slice( tokens.shift().value.length ); | |
| 2861 | } | |
| 2862 | ||
| 2863 | // Fetch a seed set for right-to-left matching | |
| 2864 | i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; | |
| 2865 | while ( i-- ) { | |
| 2866 | token = tokens[ i ]; | |
| 2867 | ||
| 2868 | // Abort if we hit a combinator | |
| 2869 | if ( Expr.relative[ ( type = token.type ) ] ) { | |
| 2870 | break; | |
| 2871 | } | |
| 2872 | if ( ( find = Expr.find[ type ] ) ) { | |
| 2873 | ||
| 2874 | // Search, expanding context for leading sibling combinators | |
| 2875 | if ( ( seed = find( | |
| 2876 | token.matches[ 0 ].replace( runescape, funescape ), | |
| 2877 | rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || | |
| 2878 | context | |
| 2879 | ) ) ) { | |
| 2880 | ||
| 2881 | // If seed is empty or no tokens remain, we can return early | |
| 2882 | tokens.splice( i, 1 ); | |
| 2883 | selector = seed.length && toSelector( tokens ); | |
| 2884 | if ( !selector ) { | |
| 2885 | push.apply( results, seed ); | |
| 2886 | return results; | |
| 2887 | } | |
| 2888 | ||
| 2889 | break; | |
| 2890 | } | |
| 2891 | } | |
| 2892 | } | |
| 2893 | } | |
| 2894 | ||
| 2895 | // Compile and execute a filtering function if one is not provided | |
| 2896 | // Provide `match` to avoid retokenization if we modified the selector above | |
| 2897 | ( compiled || compile( selector, match ) )( | |
| 2898 | seed, | |
| 2899 | context, | |
| 2900 | !documentIsHTML, | |
| 2901 | results, | |
| 2902 | !context || rsibling.test( selector ) && testContext( context.parentNode ) || context | |
| 2903 | ); | |
| 2904 | return results; | |
| 2905 | }; | |
| 2906 | ||
| 2907 | // One-time assignments | |
| 2908 | ||
| 2909 | // Sort stability | |
| 2910 | support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; | |
| 2911 | ||
| 2912 | // Support: Chrome 14-35+ | |
| 2913 | // Always assume duplicates if they aren't passed to the comparison function | |
| 2914 | support.detectDuplicates = !!hasDuplicate; | |
| 2915 | ||
| 2916 | // Initialize against the default document | |
| 2917 | setDocument(); | |
| 2918 | ||
| 2919 | // Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) | |
| 2920 | // Detached nodes confoundingly follow *each other* | |
| 2921 | support.sortDetached = assert( function( el ) { | |
| 2922 | ||
| 2923 | // Should return 1, but returns 4 (following) | |
| 2924 | return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; | |
| 2925 | } ); | |
| 2926 | ||
| 2927 | // Support: IE<8 | |
| 2928 | // Prevent attribute/property "interpolation" | |
| 2929 | // https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx | |
| 2930 | if ( !assert( function( el ) { | |
| 2931 | el.innerHTML = "<a href='#'></a>"; | |
| 2932 | return el.firstChild.getAttribute( "href" ) === "#"; | |
| 2933 | } ) ) { | |
| 2934 | addHandle( "type|href|height|width", function( elem, name, isXML ) { | |
| 2935 | if ( !isXML ) { | |
| 2936 | return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); | |
| 2937 | } | |
| 2938 | } ); | |
| 2939 | } | |
| 2940 | ||
| 2941 | // Support: IE<9 | |
| 2942 | // Use defaultValue in place of getAttribute("value") | |
| 2943 | if ( !support.attributes || !assert( function( el ) { | |
| 2944 | el.innerHTML = "<input/>"; | |
| 2945 | el.firstChild.setAttribute( "value", "" ); | |
| 2946 | return el.firstChild.getAttribute( "value" ) === ""; | |
| 2947 | } ) ) { | |
| 2948 | addHandle( "value", function( elem, _name, isXML ) { | |
| 2949 | if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { | |
| 2950 | return elem.defaultValue; | |
| 2951 | } | |
| 2952 | } ); | |
| 2953 | } | |
| 2954 | ||
| 2955 | // Support: IE<9 | |
| 2956 | // Use getAttributeNode to fetch booleans when getAttribute lies | |
| 2957 | if ( !assert( function( el ) { | |
| 2958 | return el.getAttribute( "disabled" ) == null; | |
| 2959 | } ) ) { | |
| 2960 | addHandle( booleans, function( elem, name, isXML ) { | |
| 2961 | var val; | |
| 2962 | if ( !isXML ) { | |
| 2963 | return elem[ name ] === true ? name.toLowerCase() : | |
| 2964 | ( val = elem.getAttributeNode( name ) ) && val.specified ? | |
| 2965 | val.value : | |
| 2966 | null; | |
| 2967 | } | |
| 2968 | } ); | |
| 2969 | } | |
| 2970 | ||
| 2971 | return Sizzle; | |
| 2972 | ||
| 2973 | } )( window ); | |
| 2974 | ||
| 2975 | ||
| 2976 | ||
| 2977 | jQuery.find = Sizzle; | |
| 2978 | jQuery.expr = Sizzle.selectors; | |
| 2979 | ||
| 2980 | // Deprecated | |
| 2981 | jQuery.expr[ ":" ] = jQuery.expr.pseudos; | |
| 2982 | jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; | |
| 2983 | jQuery.text = Sizzle.getText; | |
| 2984 | jQuery.isXMLDoc = Sizzle.isXML; | |
| 2985 | jQuery.contains = Sizzle.contains; | |
| 2986 | jQuery.escapeSelector = Sizzle.escape; | |
| 2987 | ||
| 2988 | ||
| 2989 | ||
| 2990 | ||
| 2991 | var dir = function( elem, dir, until ) { | |
| 2992 | var matched = [], | |
| 2993 | truncate = until !== undefined; | |
| 2994 | ||
| 2995 | while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { | |
| 2996 | if ( elem.nodeType === 1 ) { | |
| 2997 | if ( truncate && jQuery( elem ).is( until ) ) { | |
| 2998 | break; | |
| 2999 | } | |
| 3000 | matched.push( elem ); | |
| 3001 | } | |
| 3002 | } | |
| 3003 | return matched; | |
| 3004 | }; | |
| 3005 | ||
| 3006 | ||
| 3007 | var siblings = function( n, elem ) { | |
| 3008 | var matched = []; | |
| 3009 | ||
| 3010 | for ( ; n; n = n.nextSibling ) { | |
| 3011 | if ( n.nodeType === 1 && n !== elem ) { | |
| 3012 | matched.push( n ); | |
| 3013 | } | |
| 3014 | } | |
| 3015 | ||
| 3016 | return matched; | |
| 3017 | }; | |
| 3018 | ||
| 3019 | ||
| 3020 | var rneedsContext = jQuery.expr.match.needsContext; | |
| 3021 | ||
| 3022 | ||
| 3023 | ||
| 3024 | function nodeName( elem, name ) { | |
| 3025 | ||
| 3026 | return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); | |
| 3027 | ||
| 3028 | }; | |
| 3029 | var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); | |
| 3030 | ||
| 3031 | ||
| 3032 | ||
| 3033 | // Implement the identical functionality for filter and not | |
| 3034 | function winnow( elements, qualifier, not ) { | |
| 3035 | if ( isFunction( qualifier ) ) { | |
| 3036 | return jQuery.grep( elements, function( elem, i ) { | |
| 3037 | return !!qualifier.call( elem, i, elem ) !== not; | |
| 3038 | } ); | |
| 3039 | } | |
| 3040 | ||
| 3041 | // Single element | |
| 3042 | if ( qualifier.nodeType ) { | |
| 3043 | return jQuery.grep( elements, function( elem ) { | |
| 3044 | return ( elem === qualifier ) !== not; | |
| 3045 | } ); | |
| 3046 | } | |
| 3047 | ||
| 3048 | // Arraylike of elements (jQuery, arguments, Array) | |
| 3049 | if ( typeof qualifier !== "string" ) { | |
| 3050 | return jQuery.grep( elements, function( elem ) { | |
| 3051 | return ( indexOf.call( qualifier, elem ) > -1 ) !== not; | |
| 3052 | } ); | |
| 3053 | } | |
| 3054 | ||
| 3055 | // Filtered directly for both simple and complex selectors | |
| 3056 | return jQuery.filter( qualifier, elements, not ); | |
| 3057 | } | |
| 3058 | ||
| 3059 | jQuery.filter = function( expr, elems, not ) { | |
| 3060 | var elem = elems[ 0 ]; | |
| 3061 | ||
| 3062 | if ( not ) { | |
| 3063 | expr = ":not(" + expr + ")"; | |
| 3064 | } | |
| 3065 | ||
| 3066 | if ( elems.length === 1 && elem.nodeType === 1 ) { | |
| 3067 | return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; | |
| 3068 | } | |
| 3069 | ||
| 3070 | return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { | |
| 3071 | return elem.nodeType === 1; | |
| 3072 | } ) ); | |
| 3073 | }; | |
| 3074 | ||
| 3075 | jQuery.fn.extend( { | |
| 3076 | find: function( selector ) { | |
| 3077 | var i, ret, | |
| 3078 | len = this.length, | |
| 3079 | self = this; | |
| 3080 | ||
| 3081 | if ( typeof selector !== "string" ) { | |
| 3082 | return this.pushStack( jQuery( selector ).filter( function() { | |
| 3083 | for ( i = 0; i < len; i++ ) { | |
| 3084 | if ( jQuery.contains( self[ i ], this ) ) { | |
| 3085 | return true; | |
| 3086 | } | |
| 3087 | } | |
| 3088 | } ) ); | |
| 3089 | } | |
| 3090 | ||
| 3091 | ret = this.pushStack( [] ); | |
| 3092 | ||
| 3093 | for ( i = 0; i < len; i++ ) { | |
| 3094 | jQuery.find( selector, self[ i ], ret ); | |
| 3095 | } | |
| 3096 | ||
| 3097 | return len > 1 ? jQuery.uniqueSort( ret ) : ret; | |
| 3098 | }, | |
| 3099 | filter: function( selector ) { | |
| 3100 | return this.pushStack( winnow( this, selector || [], false ) ); | |
| 3101 | }, | |
| 3102 | not: function( selector ) { | |
| 3103 | return this.pushStack( winnow( this, selector || [], true ) ); | |
| 3104 | }, | |
| 3105 | is: function( selector ) { | |
| 3106 | return !!winnow( | |
| 3107 | this, | |
| 3108 | ||
| 3109 | // If this is a positional/relative selector, check membership in the returned set | |
| 3110 | // so $("p:first").is("p:last") won't return true for a doc with two "p". | |
| 3111 | typeof selector === "string" && rneedsContext.test( selector ) ? | |
| 3112 | jQuery( selector ) : | |
| 3113 | selector || [], | |
| 3114 | false | |
| 3115 | ).length; | |
| 3116 | } | |
| 3117 | } ); | |
| 3118 | ||
| 3119 | ||
| 3120 | // Initialize a jQuery object | |
| 3121 | ||
| 3122 | ||
| 3123 | // A central reference to the root jQuery(document) | |
| 3124 | var rootjQuery, | |
| 3125 | ||
| 3126 | // A simple way to check for HTML strings | |
| 3127 | // Prioritize #id over <tag> to avoid XSS via location.hash (#9521) | |
| 3128 | // Strict HTML recognition (#11290: must start with <) | |
| 3129 | // Shortcut simple #id case for speed | |
| 3130 | rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, | |
| 3131 | ||
| 3132 | init = jQuery.fn.init = function( selector, context, root ) { | |
| 3133 | var match, elem; | |
| 3134 | ||
| 3135 | // HANDLE: $(""), $(null), $(undefined), $(false) | |
| 3136 | if ( !selector ) { | |
| 3137 | return this; | |
| 3138 | } | |
| 3139 | ||
| 3140 | // Method init() accepts an alternate rootjQuery | |
| 3141 | // so migrate can support jQuery.sub (gh-2101) | |
| 3142 | root = root || rootjQuery; | |
| 3143 | ||
| 3144 | // Handle HTML strings | |
| 3145 | if ( typeof selector === "string" ) { | |
| 3146 | if ( selector[ 0 ] === "<" && | |
| 3147 | selector[ selector.length - 1 ] === ">" && | |
| 3148 | selector.length >= 3 ) { | |
| 3149 | ||
| 3150 | // Assume that strings that start and end with <> are HTML and skip the regex check | |
| 3151 | match = [ null, selector, null ]; | |
| 3152 | ||
| 3153 | } else { | |
| 3154 | match = rquickExpr.exec( selector ); | |
| 3155 | } | |
| 3156 | ||
| 3157 | // Match html or make sure no context is specified for #id | |
| 3158 | if ( match && ( match[ 1 ] || !context ) ) { | |
| 3159 | ||
| 3160 | // HANDLE: $(html) -> $(array) | |
| 3161 | if ( match[ 1 ] ) { | |
| 3162 | context = context instanceof jQuery ? context[ 0 ] : context; | |
| 3163 | ||
| 3164 | // Option to run scripts is true for back-compat | |
| 3165 | // Intentionally let the error be thrown if parseHTML is not present | |
| 3166 | jQuery.merge( this, jQuery.parseHTML( | |
| 3167 | match[ 1 ], | |
| 3168 | context && context.nodeType ? context.ownerDocument || context : document, | |
| 3169 | true | |
| 3170 | ) ); | |
| 3171 | ||
| 3172 | // HANDLE: $(html, props) | |
| 3173 | if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { | |
| 3174 | for ( match in context ) { | |
| 3175 | ||
| 3176 | // Properties of context are called as methods if possible | |
| 3177 | if ( isFunction( this[ match ] ) ) { | |
| 3178 | this[ match ]( context[ match ] ); | |
| 3179 | ||
| 3180 | // ...and otherwise set as attributes | |
| 3181 | } else { | |
| 3182 | this.attr( match, context[ match ] ); | |
| 3183 | } | |
| 3184 | } | |
| 3185 | } | |
| 3186 | ||
| 3187 | return this; | |
| 3188 | ||
| 3189 | // HANDLE: $(#id) | |
| 3190 | } else { | |
| 3191 | elem = document.getElementById( match[ 2 ] ); | |
| 3192 | ||
| 3193 | if ( elem ) { | |
| 3194 | ||
| 3195 | // Inject the element directly into the jQuery object | |
| 3196 | this[ 0 ] = elem; | |
| 3197 | this.length = 1; | |
| 3198 | } | |
| 3199 | return this; | |
| 3200 | } | |
| 3201 | ||
| 3202 | // HANDLE: $(expr, $(...)) | |
| 3203 | } else if ( !context || context.jquery ) { | |
| 3204 | return ( context || root ).find( selector ); | |
| 3205 | ||
| 3206 | // HANDLE: $(expr, context) | |
| 3207 | // (which is just equivalent to: $(context).find(expr) | |
| 3208 | } else { | |
| 3209 | return this.constructor( context ).find( selector ); | |
| 3210 | } | |
| 3211 | ||
| 3212 | // HANDLE: $(DOMElement) | |
| 3213 | } else if ( selector.nodeType ) { | |
| 3214 | this[ 0 ] = selector; | |
| 3215 | this.length = 1; | |
| 3216 | return this; | |
| 3217 | ||
| 3218 | // HANDLE: $(function) | |
| 3219 | // Shortcut for document ready | |
| 3220 | } else if ( isFunction( selector ) ) { | |
| 3221 | return root.ready !== undefined ? | |
| 3222 | root.ready( selector ) : | |
| 3223 | ||
| 3224 | // Execute immediately if ready is not present | |
| 3225 | selector( jQuery ); | |
| 3226 | } | |
| 3227 | ||
| 3228 | return jQuery.makeArray( selector, this ); | |
| 3229 | }; | |
| 3230 | ||
| 3231 | // Give the init function the jQuery prototype for later instantiation | |
| 3232 | init.prototype = jQuery.fn; | |
| 3233 | ||
| 3234 | // Initialize central reference | |
| 3235 | rootjQuery = jQuery( document ); | |
| 3236 | ||
| 3237 | ||
| 3238 | var rparentsprev = /^(?:parents|prev(?:Until|All))/, | |
| 3239 | ||
| 3240 | // Methods guaranteed to produce a unique set when starting from a unique set | |
| 3241 | guaranteedUnique = { | |
| 3242 | children: true, | |
| 3243 | contents: true, | |
| 3244 | next: true, | |
| 3245 | prev: true | |
| 3246 | }; | |
| 3247 | ||
| 3248 | jQuery.fn.extend( { | |
| 3249 | has: function( target ) { | |
| 3250 | var targets = jQuery( target, this ), | |
| 3251 | l = targets.length; | |
| 3252 | ||
| 3253 | return this.filter( function() { | |
| 3254 | var i = 0; | |
| 3255 | for ( ; i < l; i++ ) { | |
| 3256 | if ( jQuery.contains( this, targets[ i ] ) ) { | |
| 3257 | return true; | |
| 3258 | } | |
| 3259 | } | |
| 3260 | } ); | |
| 3261 | }, | |
| 3262 | ||
| 3263 | closest: function( selectors, context ) { | |
| 3264 | var cur, | |
| 3265 | i = 0, | |
| 3266 | l = this.length, | |
| 3267 | matched = [], | |
| 3268 | targets = typeof selectors !== "string" && jQuery( selectors ); | |
| 3269 | ||
| 3270 | // Positional selectors never match, since there's no _selection_ context | |
| 3271 | if ( !rneedsContext.test( selectors ) ) { | |
| 3272 | for ( ; i < l; i++ ) { | |
| 3273 | for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { | |
| 3274 | ||
| 3275 | // Always skip document fragments | |
| 3276 | if ( cur.nodeType < 11 && ( targets ? | |
| 3277 | targets.index( cur ) > -1 : | |
| 3278 | ||
| 3279 | // Don't pass non-elements to Sizzle | |
| 3280 | cur.nodeType === 1 && | |
| 3281 | jQuery.find.matchesSelector( cur, selectors ) ) ) { | |
| 3282 | ||
| 3283 | matched.push( cur ); | |
| 3284 | break; | |
| 3285 | } | |
| 3286 | } | |
| 3287 | } | |
| 3288 | } | |
| 3289 | ||
| 3290 | return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); | |
| 3291 | }, | |
| 3292 | ||
| 3293 | // Determine the position of an element within the set | |
| 3294 | index: function( elem ) { | |
| 3295 | ||
| 3296 | // No argument, return index in parent | |
| 3297 | if ( !elem ) { | |
| 3298 | return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; | |
| 3299 | } | |
| 3300 | ||
| 3301 | // Index in selector | |
| 3302 | if ( typeof elem === "string" ) { | |
| 3303 | return indexOf.call( jQuery( elem ), this[ 0 ] ); | |
| 3304 | } | |
| 3305 | ||
| 3306 | // Locate the position of the desired element | |
| 3307 | return indexOf.call( this, | |
| 3308 | ||
| 3309 | // If it receives a jQuery object, the first element is used | |
| 3310 | elem.jquery ? elem[ 0 ] : elem | |
| 3311 | ); | |
| 3312 | }, | |
| 3313 | ||
| 3314 | add: function( selector, context ) { | |
| 3315 | return this.pushStack( | |
| 3316 | jQuery.uniqueSort( | |
| 3317 | jQuery.merge( this.get(), jQuery( selector, context ) ) | |
| 3318 | ) | |
| 3319 | ); | |
| 3320 | }, | |
| 3321 | ||
| 3322 | addBack: function( selector ) { | |
| 3323 | return this.add( selector == null ? | |
| 3324 | this.prevObject : this.prevObject.filter( selector ) | |
| 3325 | ); | |
| 3326 | } | |
| 3327 | } ); | |
| 3328 | ||
| 3329 | function sibling( cur, dir ) { | |
| 3330 | while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} | |
| 3331 | return cur; | |
| 3332 | } | |
| 3333 | ||
| 3334 | jQuery.each( { | |
| 3335 | parent: function( elem ) { | |
| 3336 | var parent = elem.parentNode; | |
| 3337 | return parent && parent.nodeType !== 11 ? parent : null; | |
| 3338 | }, | |
| 3339 | parents: function( elem ) { | |
| 3340 | return dir( elem, "parentNode" ); | |
| 3341 | }, | |
| 3342 | parentsUntil: function( elem, _i, until ) { | |
| 3343 | return dir( elem, "parentNode", until ); | |
| 3344 | }, | |
| 3345 | next: function( elem ) { | |
| 3346 | return sibling( elem, "nextSibling" ); | |
| 3347 | }, | |
| 3348 | prev: function( elem ) { | |
| 3349 | return sibling( elem, "previousSibling" ); | |
| 3350 | }, | |
| 3351 | nextAll: function( elem ) { | |
| 3352 | return dir( elem, "nextSibling" ); | |
| 3353 | }, | |
| 3354 | prevAll: function( elem ) { | |
| 3355 | return dir( elem, "previousSibling" ); | |
| 3356 | }, | |
| 3357 | nextUntil: function( elem, _i, until ) { | |
| 3358 | return dir( elem, "nextSibling", until ); | |
| 3359 | }, | |
| 3360 | prevUntil: function( elem, _i, until ) { | |
| 3361 | return dir( elem, "previousSibling", until ); | |
| 3362 | }, | |
| 3363 | siblings: function( elem ) { | |
| 3364 | return siblings( ( elem.parentNode || {} ).firstChild, elem ); | |
| 3365 | }, | |
| 3366 | children: function( elem ) { | |
| 3367 | return siblings( elem.firstChild ); | |
| 3368 | }, | |
| 3369 | contents: function( elem ) { | |
| 3370 | if ( elem.contentDocument != null && | |
| 3371 | ||
| 3372 | // Support: IE 11+ | |
| 3373 | // <object> elements with no `data` attribute has an object | |
| 3374 | // `contentDocument` with a `null` prototype. | |
| 3375 | getProto( elem.contentDocument ) ) { | |
| 3376 | ||
| 3377 | return elem.contentDocument; | |
| 3378 | } | |
| 3379 | ||
| 3380 | // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only | |
| 3381 | // Treat the template element as a regular one in browsers that | |
| 3382 | // don't support it. | |
| 3383 | if ( nodeName( elem, "template" ) ) { | |
| 3384 | elem = elem.content || elem; | |
| 3385 | } | |
| 3386 | ||
| 3387 | return jQuery.merge( [], elem.childNodes ); | |
| 3388 | } | |
| 3389 | }, function( name, fn ) { | |
| 3390 | jQuery.fn[ name ] = function( until, selector ) { | |
| 3391 | var matched = jQuery.map( this, fn, until ); | |
| 3392 | ||
| 3393 | if ( name.slice( -5 ) !== "Until" ) { | |
| 3394 | selector = until; | |
| 3395 | } | |
| 3396 | ||
| 3397 | if ( selector && typeof selector === "string" ) { | |
| 3398 | matched = jQuery.filter( selector, matched ); | |
| 3399 | } | |
| 3400 | ||
| 3401 | if ( this.length > 1 ) { | |
| 3402 | ||
| 3403 | // Remove duplicates | |
| 3404 | if ( !guaranteedUnique[ name ] ) { | |
| 3405 | jQuery.uniqueSort( matched ); | |
| 3406 | } | |
| 3407 | ||
| 3408 | // Reverse order for parents* and prev-derivatives | |
| 3409 | if ( rparentsprev.test( name ) ) { | |
| 3410 | matched.reverse(); | |
| 3411 | } | |
| 3412 | } | |
| 3413 | ||
| 3414 | return this.pushStack( matched ); | |
| 3415 | }; | |
| 3416 | } ); | |
| 3417 | var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); | |
| 3418 | ||
| 3419 | ||
| 3420 | ||
| 3421 | // Convert String-formatted options into Object-formatted ones | |
| 3422 | function createOptions( options ) { | |
| 3423 | var object = {}; | |
| 3424 | jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { | |
| 3425 | object[ flag ] = true; | |
| 3426 | } ); | |
| 3427 | return object; | |
| 3428 | } | |
| 3429 | ||
| 3430 | /* | |
| 3431 | * Create a callback list using the following parameters: | |
| 3432 | * | |
| 3433 | * options: an optional list of space-separated options that will change how | |
| 3434 | * the callback list behaves or a more traditional option object | |
| 3435 | * | |
| 3436 | * By default a callback list will act like an event callback list and can be | |
| 3437 | * "fired" multiple times. | |
| 3438 | * | |
| 3439 | * Possible options: | |
| 3440 | * | |
| 3441 | * once: will ensure the callback list can only be fired once (like a Deferred) | |
| 3442 | * | |
| 3443 | * memory: will keep track of previous values and will call any callback added | |
| 3444 | * after the list has been fired right away with the latest "memorized" | |
| 3445 | * values (like a Deferred) | |
| 3446 | * | |
| 3447 | * unique: will ensure a callback can only be added once (no duplicate in the list) | |
| 3448 | * | |
| 3449 | * stopOnFalse: interrupt callings when a callback returns false | |
| 3450 | * | |
| 3451 | */ | |
| 3452 | jQuery.Callbacks = function( options ) { | |
| 3453 | ||
| 3454 | // Convert options from String-formatted to Object-formatted if needed | |
| 3455 | // (we check in cache first) | |
| 3456 | options = typeof options === "string" ? | |
| 3457 | createOptions( options ) : | |
| 3458 | jQuery.extend( {}, options ); | |
| 3459 | ||
| 3460 | var // Flag to know if list is currently firing | |
| 3461 | firing, | |
| 3462 | ||
| 3463 | // Last fire value for non-forgettable lists | |
| 3464 | memory, | |
| 3465 | ||
| 3466 | // Flag to know if list was already fired | |
| 3467 | fired, | |
| 3468 | ||
| 3469 | // Flag to prevent firing | |
| 3470 | locked, | |
| 3471 | ||
| 3472 | // Actual callback list | |
| 3473 | list = [], | |
| 3474 | ||
| 3475 | // Queue of execution data for repeatable lists | |
| 3476 | queue = [], | |
| 3477 | ||
| 3478 | // Index of currently firing callback (modified by add/remove as needed) | |
| 3479 | firingIndex = -1, | |
| 3480 | ||
| 3481 | // Fire callbacks | |
| 3482 | fire = function() { | |
| 3483 | ||
| 3484 | // Enforce single-firing | |
| 3485 | locked = locked || options.once; | |
| 3486 | ||
| 3487 | // Execute callbacks for all pending executions, | |
| 3488 | // respecting firingIndex overrides and runtime changes | |
| 3489 | fired = firing = true; | |
| 3490 | for ( ; queue.length; firingIndex = -1 ) { | |
| 3491 | memory = queue.shift(); | |
| 3492 | while ( ++firingIndex < list.length ) { | |
| 3493 | ||
| 3494 | // Run callback and check for early termination | |
| 3495 | if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && | |
| 3496 | options.stopOnFalse ) { | |
| 3497 | ||
| 3498 | // Jump to end and forget the data so .add doesn't re-fire | |
| 3499 | firingIndex = list.length; | |
| 3500 | memory = false; | |
| 3501 | } | |
| 3502 | } | |
| 3503 | } | |
| 3504 | ||
| 3505 | // Forget the data if we're done with it | |
| 3506 | if ( !options.memory ) { | |
| 3507 | memory = false; | |
| 3508 | } | |
| 3509 | ||
| 3510 | firing = false; | |
| 3511 | ||
| 3512 | // Clean up if we're done firing for good | |
| 3513 | if ( locked ) { | |
| 3514 | ||
| 3515 | // Keep an empty list if we have data for future add calls | |
| 3516 | if ( memory ) { | |
| 3517 | list = []; | |
| 3518 | ||
| 3519 | // Otherwise, this object is spent | |
| 3520 | } else { | |
| 3521 | list = ""; | |
| 3522 | } | |
| 3523 | } | |
| 3524 | }, | |
| 3525 | ||
| 3526 | // Actual Callbacks object | |
| 3527 | self = { | |
| 3528 | ||
| 3529 | // Add a callback or a collection of callbacks to the list | |
| 3530 | add: function() { | |
| 3531 | if ( list ) { | |
| 3532 | ||
| 3533 | // If we have memory from a past run, we should fire after adding | |
| 3534 | if ( memory && !firing ) { | |
| 3535 | firingIndex = list.length - 1; | |
| 3536 | queue.push( memory ); | |
| 3537 | } | |
| 3538 | ||
| 3539 | ( function add( args ) { | |
| 3540 | jQuery.each( args, function( _, arg ) { | |
| 3541 | if ( isFunction( arg ) ) { | |
| 3542 | if ( !options.unique || !self.has( arg ) ) { | |
| 3543 | list.push( arg ); | |
| 3544 | } | |
| 3545 | } else if ( arg && arg.length && toType( arg ) !== "string" ) { | |
| 3546 | ||
| 3547 | // Inspect recursively | |
| 3548 | add( arg ); | |
| 3549 | } | |
| 3550 | } ); | |
| 3551 | } )( arguments ); | |
| 3552 | ||
| 3553 | if ( memory && !firing ) { | |
| 3554 | fire(); | |
| 3555 | } | |
| 3556 | } | |
| 3557 | return this; | |
| 3558 | }, | |
| 3559 | ||
| 3560 | // Remove a callback from the list | |
| 3561 | remove: function() { | |
| 3562 | jQuery.each( arguments, function( _, arg ) { | |
| 3563 | var index; | |
| 3564 | while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { | |
| 3565 | list.splice( index, 1 ); | |
| 3566 | ||
| 3567 | // Handle firing indexes | |
| 3568 | if ( index <= firingIndex ) { | |
| 3569 | firingIndex--; | |
| 3570 | } | |
| 3571 | } | |
| 3572 | } ); | |
| 3573 | return this; | |
| 3574 | }, | |
| 3575 | ||
| 3576 | // Check if a given callback is in the list. | |
| 3577 | // If no argument is given, return whether or not list has callbacks attached. | |
| 3578 | has: function( fn ) { | |
| 3579 | return fn ? | |
| 3580 | jQuery.inArray( fn, list ) > -1 : | |
| 3581 | list.length > 0; | |
| 3582 | }, | |
| 3583 | ||
| 3584 | // Remove all callbacks from the list | |
| 3585 | empty: function() { | |
| 3586 | if ( list ) { | |
| 3587 | list = []; | |
| 3588 | } | |
| 3589 | return this; | |
| 3590 | }, | |
| 3591 | ||
| 3592 | // Disable .fire and .add | |
| 3593 | // Abort any current/pending executions | |
| 3594 | // Clear all callbacks and values | |
| 3595 | disable: function() { | |
| 3596 | locked = queue = []; | |
| 3597 | list = memory = ""; | |
| 3598 | return this; | |
| 3599 | }, | |
| 3600 | disabled: function() { | |
| 3601 | return !list; | |
| 3602 | }, | |
| 3603 | ||
| 3604 | // Disable .fire | |
| 3605 | // Also disable .add unless we have memory (since it would have no effect) | |
| 3606 | // Abort any pending executions | |
| 3607 | lock: function() { | |
| 3608 | locked = queue = []; | |
| 3609 | if ( !memory && !firing ) { | |
| 3610 | list = memory = ""; | |
| 3611 | } | |
| 3612 | return this; | |
| 3613 | }, | |
| 3614 | locked: function() { | |
| 3615 | return !!locked; | |
| 3616 | }, | |
| 3617 | ||
| 3618 | // Call all callbacks with the given context and arguments | |
| 3619 | fireWith: function( context, args ) { | |
| 3620 | if ( !locked ) { | |
| 3621 | args = args || []; | |
| 3622 | args = [ context, args.slice ? args.slice() : args ]; | |
| 3623 | queue.push( args ); | |
| 3624 | if ( !firing ) { | |
| 3625 | fire(); | |
| 3626 | } | |
| 3627 | } | |
| 3628 | return this; | |
| 3629 | }, | |
| 3630 | ||
| 3631 | // Call all the callbacks with the given arguments | |
| 3632 | fire: function() { | |
| 3633 | self.fireWith( this, arguments ); | |
| 3634 | return this; | |
| 3635 | }, | |
| 3636 | ||
| 3637 | // To know if the callbacks have already been called at least once | |
| 3638 | fired: function() { | |
| 3639 | return !!fired; | |
| 3640 | } | |
| 3641 | }; | |
| 3642 | ||
| 3643 | return self; | |
| 3644 | }; | |
| 3645 | ||
| 3646 | ||
| 3647 | function Identity( v ) { | |
| 3648 | return v; | |
| 3649 | } | |
| 3650 | function Thrower( ex ) { | |
| 3651 | throw ex; | |
| 3652 | } | |
| 3653 | ||
| 3654 | function adoptValue( value, resolve, reject, noValue ) { | |
| 3655 | var method; | |
| 3656 | ||
| 3657 | try { | |
| 3658 | ||
| 3659 | // Check for promise aspect first to privilege synchronous behavior | |
| 3660 | if ( value && isFunction( ( method = value.promise ) ) ) { | |
| 3661 | method.call( value ).done( resolve ).fail( reject ); | |
| 3662 | ||
| 3663 | // Other thenables | |
| 3664 | } else if ( value && isFunction( ( method = value.then ) ) ) { | |
| 3665 | method.call( value, resolve, reject ); | |
| 3666 | ||
| 3667 | // Other non-thenables | |
| 3668 | } else { | |
| 3669 | ||
| 3670 | // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: | |
| 3671 | // * false: [ value ].slice( 0 ) => resolve( value ) | |
| 3672 | // * true: [ value ].slice( 1 ) => resolve() | |
| 3673 | resolve.apply( undefined, [ value ].slice( noValue ) ); | |
| 3674 | } | |
| 3675 | ||
| 3676 | // For Promises/A+, convert exceptions into rejections | |
| 3677 | // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in | |
| 3678 | // Deferred#then to conditionally suppress rejection. | |
| 3679 | } catch ( value ) { | |
| 3680 | ||
| 3681 | // Support: Android 4.0 only | |
| 3682 | // Strict mode functions invoked without .call/.apply get global-object context | |
| 3683 | reject.apply( undefined, [ value ] ); | |
| 3684 | } | |
| 3685 | } | |
| 3686 | ||
| 3687 | jQuery.extend( { | |
| 3688 | ||
| 3689 | Deferred: function( func ) { | |
| 3690 | var tuples = [ | |
| 3691 | ||
| 3692 | // action, add listener, callbacks, | |
| 3693 | // ... .then handlers, argument index, [final state] | |
| 3694 | [ "notify", "progress", jQuery.Callbacks( "memory" ), | |
| 3695 | jQuery.Callbacks( "memory" ), 2 ], | |
| 3696 | [ "resolve", "done", jQuery.Callbacks( "once memory" ), | |
| 3697 | jQuery.Callbacks( "once memory" ), 0, "resolved" ], | |
| 3698 | [ "reject", "fail", jQuery.Callbacks( "once memory" ), | |
| 3699 | jQuery.Callbacks( "once memory" ), 1, "rejected" ] | |
| 3700 | ], | |
| 3701 | state = "pending", | |
| 3702 | promise = { | |
| 3703 | state: function() { | |
| 3704 | return state; | |
| 3705 | }, | |
| 3706 | always: function() { | |
| 3707 | deferred.done( arguments ).fail( arguments ); | |
| 3708 | return this; | |
| 3709 | }, | |
| 3710 | "catch": function( fn ) { | |
| 3711 | return promise.then( null, fn ); | |
| 3712 | }, | |
| 3713 | ||
| 3714 | // Keep pipe for back-compat | |
| 3715 | pipe: function( /* fnDone, fnFail, fnProgress */ ) { | |
| 3716 | var fns = arguments; | |
| 3717 | ||
| 3718 | return jQuery.Deferred( function( newDefer ) { | |
| 3719 | jQuery.each( tuples, function( _i, tuple ) { | |
| 3720 | ||
| 3721 | // Map tuples (progress, done, fail) to arguments (done, fail, progress) | |
| 3722 | var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; | |
| 3723 | ||
| 3724 | // deferred.progress(function() { bind to newDefer or newDefer.notify }) | |
| 3725 | // deferred.done(function() { bind to newDefer or newDefer.resolve }) | |
| 3726 | // deferred.fail(function() { bind to newDefer or newDefer.reject }) | |
| 3727 | deferred[ tuple[ 1 ] ]( function() { | |
| 3728 | var returned = fn && fn.apply( this, arguments ); | |
| 3729 | if ( returned && isFunction( returned.promise ) ) { | |
| 3730 | returned.promise() | |
| 3731 | .progress( newDefer.notify ) | |
| 3732 | .done( newDefer.resolve ) | |
| 3733 | .fail( newDefer.reject ); | |
| 3734 | } else { | |
| 3735 | newDefer[ tuple[ 0 ] + "With" ]( | |
| 3736 | this, | |
| 3737 | fn ? [ returned ] : arguments | |
| 3738 | ); | |
| 3739 | } | |
| 3740 | } ); | |
| 3741 | } ); | |
| 3742 | fns = null; | |
| 3743 | } ).promise(); | |
| 3744 | }, | |
| 3745 | then: function( onFulfilled, onRejected, onProgress ) { | |
| 3746 | var maxDepth = 0; | |
| 3747 | function resolve( depth, deferred, handler, special ) { | |
| 3748 | return function() { | |
| 3749 | var that = this, | |
| 3750 | args = arguments, | |
| 3751 | mightThrow = function() { | |
| 3752 | var returned, then; | |
| 3753 | ||
| 3754 | // Support: Promises/A+ section 2.3.3.3.3 | |
| 3755 | // https://promisesaplus.com/#point-59 | |
| 3756 | // Ignore double-resolution attempts | |
| 3757 | if ( depth < maxDepth ) { | |
| 3758 | return; | |
| 3759 | } | |
| 3760 | ||
| 3761 | returned = handler.apply( that, args ); | |
| 3762 | ||
| 3763 | // Support: Promises/A+ section 2.3.1 | |
| 3764 | // https://promisesaplus.com/#point-48 | |
| 3765 | if ( returned === deferred.promise() ) { | |
| 3766 | throw new TypeError( "Thenable self-resolution" ); | |
| 3767 | } | |
| 3768 | ||
| 3769 | // Support: Promises/A+ sections 2.3.3.1, 3.5 | |
| 3770 | // https://promisesaplus.com/#point-54 | |
| 3771 | // https://promisesaplus.com/#point-75 | |
| 3772 | // Retrieve `then` only once | |
| 3773 | then = returned && | |
| 3774 | ||
| 3775 | // Support: Promises/A+ section 2.3.4 | |
| 3776 | // https://promisesaplus.com/#point-64 | |
| 3777 | // Only check objects and functions for thenability | |
| 3778 | ( typeof returned === "object" || | |
| 3779 | typeof returned === "function" ) && | |
| 3780 | returned.then; | |
| 3781 | ||
| 3782 | // Handle a returned thenable | |
| 3783 | if ( isFunction( then ) ) { | |
| 3784 | ||
| 3785 | // Special processors (notify) just wait for resolution | |
| 3786 | if ( special ) { | |
| 3787 | then.call( | |
| 3788 | returned, | |
| 3789 | resolve( maxDepth, deferred, Identity, special ), | |
| 3790 | resolve( maxDepth, deferred, Thrower, special ) | |
| 3791 | ); | |
| 3792 | ||
| 3793 | // Normal processors (resolve) also hook into progress | |
| 3794 | } else { | |
| 3795 | ||
| 3796 | // ...and disregard older resolution values | |
| 3797 | maxDepth++; | |
| 3798 | ||
| 3799 | then.call( | |
| 3800 | returned, | |
| 3801 | resolve( maxDepth, deferred, Identity, special ), | |
| 3802 | resolve( maxDepth, deferred, Thrower, special ), | |
| 3803 | resolve( maxDepth, deferred, Identity, | |
| 3804 | deferred.notifyWith ) | |
| 3805 | ); | |
| 3806 | } | |
| 3807 | ||
| 3808 | // Handle all other returned values | |
| 3809 | } else { | |
| 3810 | ||
| 3811 | // Only substitute handlers pass on context | |
| 3812 | // and multiple values (non-spec behavior) | |
| 3813 | if ( handler !== Identity ) { | |
| 3814 | that = undefined; | |
| 3815 | args = [ returned ]; | |
| 3816 | } | |
| 3817 | ||
| 3818 | // Process the value(s) | |
| 3819 | // Default process is resolve | |
| 3820 | ( special || deferred.resolveWith )( that, args ); | |
| 3821 | } | |
| 3822 | }, | |
| 3823 | ||
| 3824 | // Only normal processors (resolve) catch and reject exceptions | |
| 3825 | process = special ? | |
| 3826 | mightThrow : | |
| 3827 | function() { | |
| 3828 | try { | |
| 3829 | mightThrow(); | |
| 3830 | } catch ( e ) { | |
| 3831 | ||
| 3832 | if ( jQuery.Deferred.exceptionHook ) { | |
| 3833 | jQuery.Deferred.exceptionHook( e, | |
| 3834 | process.stackTrace ); | |
| 3835 | } | |
| 3836 | ||
| 3837 | // Support: Promises/A+ section 2.3.3.3.4.1 | |
| 3838 | // https://promisesaplus.com/#point-61 | |
| 3839 | // Ignore post-resolution exceptions | |
| 3840 | if ( depth + 1 >= maxDepth ) { | |
| 3841 | ||
| 3842 | // Only substitute handlers pass on context | |
| 3843 | // and multiple values (non-spec behavior) | |
| 3844 | if ( handler !== Thrower ) { | |
| 3845 | that = undefined; | |
| 3846 | args = [ e ]; | |
| 3847 | } | |
| 3848 | ||
| 3849 | deferred.rejectWith( that, args ); | |
| 3850 | } | |
| 3851 | } | |
| 3852 | }; | |
| 3853 | ||
| 3854 | // Support: Promises/A+ section 2.3.3.3.1 | |
| 3855 | // https://promisesaplus.com/#point-57 | |
| 3856 | // Re-resolve promises immediately to dodge false rejection from | |
| 3857 | // subsequent errors | |
| 3858 | if ( depth ) { | |
| 3859 | process(); | |
| 3860 | } else { | |
| 3861 | ||
| 3862 | // Call an optional hook to record the stack, in case of exception | |
| 3863 | // since it's otherwise lost when execution goes async | |
| 3864 | if ( jQuery.Deferred.getStackHook ) { | |
| 3865 | process.stackTrace = jQuery.Deferred.getStackHook(); | |
| 3866 | } | |
| 3867 | window.setTimeout( process ); | |
| 3868 | } | |
| 3869 | }; | |
| 3870 | } | |
| 3871 | ||
| 3872 | return jQuery.Deferred( function( newDefer ) { | |
| 3873 | ||
| 3874 | // progress_handlers.add( ... ) | |
| 3875 | tuples[ 0 ][ 3 ].add( | |
| 3876 | resolve( | |
| 3877 | 0, | |
| 3878 | newDefer, | |
| 3879 | isFunction( onProgress ) ? | |
| 3880 | onProgress : | |
| 3881 | Identity, | |
| 3882 | newDefer.notifyWith | |
| 3883 | ) | |
| 3884 | ); | |
| 3885 | ||
| 3886 | // fulfilled_handlers.add( ... ) | |
| 3887 | tuples[ 1 ][ 3 ].add( | |
| 3888 | resolve( | |
| 3889 | 0, | |
| 3890 | newDefer, | |
| 3891 | isFunction( onFulfilled ) ? | |
| 3892 | onFulfilled : | |
| 3893 | Identity | |
| 3894 | ) | |
| 3895 | ); | |
| 3896 | ||
| 3897 | // rejected_handlers.add( ... ) | |
| 3898 | tuples[ 2 ][ 3 ].add( | |
| 3899 | resolve( | |
| 3900 | 0, | |
| 3901 | newDefer, | |
| 3902 | isFunction( onRejected ) ? | |
| 3903 | onRejected : | |
| 3904 | Thrower | |
| 3905 | ) | |
| 3906 | ); | |
| 3907 | } ).promise(); | |
| 3908 | }, | |
| 3909 | ||
| 3910 | // Get a promise for this deferred | |
| 3911 | // If obj is provided, the promise aspect is added to the object | |
| 3912 | promise: function( obj ) { | |
| 3913 | return obj != null ? jQuery.extend( obj, promise ) : promise; | |
| 3914 | } | |
| 3915 | }, | |
| 3916 | deferred = {}; | |
| 3917 | ||
| 3918 | // Add list-specific methods | |
| 3919 | jQuery.each( tuples, function( i, tuple ) { | |
| 3920 | var list = tuple[ 2 ], | |
| 3921 | stateString = tuple[ 5 ]; | |
| 3922 | ||
| 3923 | // promise.progress = list.add | |
| 3924 | // promise.done = list.add | |
| 3925 | // promise.fail = list.add | |
| 3926 | promise[ tuple[ 1 ] ] = list.add; | |
| 3927 | ||
| 3928 | // Handle state | |
| 3929 | if ( stateString ) { | |
| 3930 | list.add( | |
| 3931 | function() { | |
| 3932 | ||
| 3933 | // state = "resolved" (i.e., fulfilled) | |
| 3934 | // state = "rejected" | |
| 3935 | state = stateString; | |
| 3936 | }, | |
| 3937 | ||
| 3938 | // rejected_callbacks.disable | |
| 3939 | // fulfilled_callbacks.disable | |
| 3940 | tuples[ 3 - i ][ 2 ].disable, | |
| 3941 | ||
| 3942 | // rejected_handlers.disable | |
| 3943 | // fulfilled_handlers.disable | |
| 3944 | tuples[ 3 - i ][ 3 ].disable, | |
| 3945 | ||
| 3946 | // progress_callbacks.lock | |
| 3947 | tuples[ 0 ][ 2 ].lock, | |
| 3948 | ||
| 3949 | // progress_handlers.lock | |
| 3950 | tuples[ 0 ][ 3 ].lock | |
| 3951 | ); | |
| 3952 | } | |
| 3953 | ||
| 3954 | // progress_handlers.fire | |
| 3955 | // fulfilled_handlers.fire | |
| 3956 | // rejected_handlers.fire | |
| 3957 | list.add( tuple[ 3 ].fire ); | |
| 3958 | ||
| 3959 | // deferred.notify = function() { deferred.notifyWith(...) } | |
| 3960 | // deferred.resolve = function() { deferred.resolveWith(...) } | |
| 3961 | // deferred.reject = function() { deferred.rejectWith(...) } | |
| 3962 | deferred[ tuple[ 0 ] ] = function() { | |
| 3963 | deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); | |
| 3964 | return this; | |
| 3965 | }; | |
| 3966 | ||
| 3967 | // deferred.notifyWith = list.fireWith | |
| 3968 | // deferred.resolveWith = list.fireWith | |
| 3969 | // deferred.rejectWith = list.fireWith | |
| 3970 | deferred[ tuple[ 0 ] + "With" ] = list.fireWith; | |
| 3971 | } ); | |
| 3972 | ||
| 3973 | // Make the deferred a promise | |
| 3974 | promise.promise( deferred ); | |
| 3975 | ||
| 3976 | // Call given func if any | |
| 3977 | if ( func ) { | |
| 3978 | func.call( deferred, deferred ); | |
| 3979 | } | |
| 3980 | ||
| 3981 | // All done! | |
| 3982 | return deferred; | |
| 3983 | }, | |
| 3984 | ||
| 3985 | // Deferred helper | |
| 3986 | when: function( singleValue ) { | |
| 3987 | var | |
| 3988 | ||
| 3989 | // count of uncompleted subordinates | |
| 3990 | remaining = arguments.length, | |
| 3991 | ||
| 3992 | // count of unprocessed arguments | |
| 3993 | i = remaining, | |
| 3994 | ||
| 3995 | // subordinate fulfillment data | |
| 3996 | resolveContexts = Array( i ), | |
| 3997 | resolveValues = slice.call( arguments ), | |
| 3998 | ||
| 3999 | // the master Deferred | |
| 4000 | master = jQuery.Deferred(), | |
| 4001 | ||
| 4002 | // subordinate callback factory | |
| 4003 | updateFunc = function( i ) { | |
| 4004 | return function( value ) { | |
| 4005 | resolveContexts[ i ] = this; | |
| 4006 | resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; | |
| 4007 | if ( !( --remaining ) ) { | |
| 4008 | master.resolveWith( resolveContexts, resolveValues ); | |
| 4009 | } | |
| 4010 | }; | |
| 4011 | }; | |
| 4012 | ||
| 4013 | // Single- and empty arguments are adopted like Promise.resolve | |
| 4014 | if ( remaining <= 1 ) { | |
| 4015 | adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, | |
| 4016 | !remaining ); | |
| 4017 | ||
| 4018 | // Use .then() to unwrap secondary thenables (cf. gh-3000) | |
| 4019 | if ( master.state() === "pending" || | |
| 4020 | isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { | |
| 4021 | ||
| 4022 | return master.then(); | |
| 4023 | } | |
| 4024 | } | |
| 4025 | ||
| 4026 | // Multiple arguments are aggregated like Promise.all array elements | |
| 4027 | while ( i-- ) { | |
| 4028 | adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); | |
| 4029 | } | |
| 4030 | ||
| 4031 | return master.promise(); | |
| 4032 | } | |
| 4033 | } ); | |
| 4034 | ||
| 4035 | ||
| 4036 | // These usually indicate a programmer mistake during development, | |
| 4037 | // warn about them ASAP rather than swallowing them by default. | |
| 4038 | var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; | |
| 4039 | ||
| 4040 | jQuery.Deferred.exceptionHook = function( error, stack ) { | |
| 4041 | ||
| 4042 | // Support: IE 8 - 9 only | |
| 4043 | // Console exists when dev tools are open, which can happen at any time | |
| 4044 | if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { | |
| 4045 | window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); | |
| 4046 | } | |
| 4047 | }; | |
| 4048 | ||
| 4049 | ||
| 4050 | ||
| 4051 | ||
| 4052 | jQuery.readyException = function( error ) { | |
| 4053 | window.setTimeout( function() { | |
| 4054 | throw error; | |
| 4055 | } ); | |
| 4056 | }; | |
| 4057 | ||
| 4058 | ||
| 4059 | ||
| 4060 | ||
| 4061 | // The deferred used on DOM ready | |
| 4062 | var readyList = jQuery.Deferred(); | |
| 4063 | ||
| 4064 | jQuery.fn.ready = function( fn ) { | |
| 4065 | ||
| 4066 | readyList | |
| 4067 | .then( fn ) | |
| 4068 | ||
| 4069 | // Wrap jQuery.readyException in a function so that the lookup | |
| 4070 | // happens at the time of error handling instead of callback | |
| 4071 | // registration. | |
| 4072 | .catch( function( error ) { | |
| 4073 | jQuery.readyException( error ); | |
| 4074 | } ); | |
| 4075 | ||
| 4076 | return this; | |
| 4077 | }; | |
| 4078 | ||
| 4079 | jQuery.extend( { | |
| 4080 | ||
| 4081 | // Is the DOM ready to be used? Set to true once it occurs. | |
| 4082 | isReady: false, | |
| 4083 | ||
| 4084 | // A counter to track how many items to wait for before | |
| 4085 | // the ready event fires. See #6781 | |
| 4086 | readyWait: 1, | |
| 4087 | ||
| 4088 | // Handle when the DOM is ready | |
| 4089 | ready: function( wait ) { | |
| 4090 | ||
| 4091 | // Abort if there are pending holds or we're already ready | |
| 4092 | if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { | |
| 4093 | return; | |
| 4094 | } | |
| 4095 | ||
| 4096 | // Remember that the DOM is ready | |
| 4097 | jQuery.isReady = true; | |
| 4098 | ||
| 4099 | // If a normal DOM Ready event fired, decrement, and wait if need be | |
| 4100 | if ( wait !== true && --jQuery.readyWait > 0 ) { | |
| 4101 | return; | |
| 4102 | } | |
| 4103 | ||
| 4104 | // If there are functions bound, to execute | |
| 4105 | readyList.resolveWith( document, [ jQuery ] ); | |
| 4106 | } | |
| 4107 | } ); | |
| 4108 | ||
| 4109 | jQuery.ready.then = readyList.then; | |
| 4110 | ||
| 4111 | // The ready event handler and self cleanup method | |
| 4112 | function completed() { | |
| 4113 | document.removeEventListener( "DOMContentLoaded", completed ); | |
| 4114 | window.removeEventListener( "load", completed ); | |
| 4115 | jQuery.ready(); | |
| 4116 | } | |
| 4117 | ||
| 4118 | // Catch cases where $(document).ready() is called | |
| 4119 | // after the browser event has already occurred. | |
| 4120 | // Support: IE <=9 - 10 only | |
| 4121 | // Older IE sometimes signals "interactive" too soon | |
| 4122 | if ( document.readyState === "complete" || | |
| 4123 | ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { | |
| 4124 | ||
| 4125 | // Handle it asynchronously to allow scripts the opportunity to delay ready | |
| 4126 | window.setTimeout( jQuery.ready ); | |
| 4127 | ||
| 4128 | } else { | |
| 4129 | ||
| 4130 | // Use the handy event callback | |
| 4131 | document.addEventListener( "DOMContentLoaded", completed ); | |
| 4132 | ||
| 4133 | // A fallback to window.onload, that will always work | |
| 4134 | window.addEventListener( "load", completed ); | |
| 4135 | } | |
| 4136 | ||
| 4137 | ||
| 4138 | ||
| 4139 | ||
| 4140 | // Multifunctional method to get and set values of a collection | |
| 4141 | // The value/s can optionally be executed if it's a function | |
| 4142 | var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { | |
| 4143 | var i = 0, | |
| 4144 | len = elems.length, | |
| 4145 | bulk = key == null; | |
| 4146 | ||
| 4147 | // Sets many values | |
| 4148 | if ( toType( key ) === "object" ) { | |
| 4149 | chainable = true; | |
| 4150 | for ( i in key ) { | |
| 4151 | access( elems, fn, i, key[ i ], true, emptyGet, raw ); | |
| 4152 | } | |
| 4153 | ||
| 4154 | // Sets one value | |
| 4155 | } else if ( value !== undefined ) { | |
| 4156 | chainable = true; | |
| 4157 | ||
| 4158 | if ( !isFunction( value ) ) { | |
| 4159 | raw = true; | |
| 4160 | } | |
| 4161 | ||
| 4162 | if ( bulk ) { | |
| 4163 | ||
| 4164 | // Bulk operations run against the entire set | |
| 4165 | if ( raw ) { | |
| 4166 | fn.call( elems, value ); | |
| 4167 | fn = null; | |
| 4168 | ||
| 4169 | // ...except when executing function values | |
| 4170 | } else { | |
| 4171 | bulk = fn; | |
| 4172 | fn = function( elem, _key, value ) { | |
| 4173 | return bulk.call( jQuery( elem ), value ); | |
| 4174 | }; | |
| 4175 | } | |
| 4176 | } | |
| 4177 | ||
| 4178 | if ( fn ) { | |
| 4179 | for ( ; i < len; i++ ) { | |
| 4180 | fn( | |
| 4181 | elems[ i ], key, raw ? | |
| 4182 | value : | |
| 4183 | value.call( elems[ i ], i, fn( elems[ i ], key ) ) | |
| 4184 | ); | |
| 4185 | } | |
| 4186 | } | |
| 4187 | } | |
| 4188 | ||
| 4189 | if ( chainable ) { | |
| 4190 | return elems; | |
| 4191 | } | |
| 4192 | ||
| 4193 | // Gets | |
| 4194 | if ( bulk ) { | |
| 4195 | return fn.call( elems ); | |
| 4196 | } | |
| 4197 | ||
| 4198 | return len ? fn( elems[ 0 ], key ) : emptyGet; | |
| 4199 | }; | |
| 4200 | ||
| 4201 | ||
| 4202 | // Matches dashed string for camelizing | |
| 4203 | var rmsPrefix = /^-ms-/, | |
| 4204 | rdashAlpha = /-([a-z])/g; | |
| 4205 | ||
| 4206 | // Used by camelCase as callback to replace() | |
| 4207 | function fcamelCase( _all, letter ) { | |
| 4208 | return letter.toUpperCase(); | |
| 4209 | } | |
| 4210 | ||
| 4211 | // Convert dashed to camelCase; used by the css and data modules | |
| 4212 | // Support: IE <=9 - 11, Edge 12 - 15 | |
| 4213 | // Microsoft forgot to hump their vendor prefix (#9572) | |
| 4214 | function camelCase( string ) { | |
| 4215 | return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); | |
| 4216 | } | |
| 4217 | var acceptData = function( owner ) { | |
| 4218 | ||
| 4219 | // Accepts only: | |
| 4220 | // - Node | |
| 4221 | // - Node.ELEMENT_NODE | |
| 4222 | // - Node.DOCUMENT_NODE | |
| 4223 | // - Object | |
| 4224 | // - Any | |
| 4225 | return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); | |
| 4226 | }; | |
| 4227 | ||
| 4228 | ||
| 4229 | ||
| 4230 | ||
| 4231 | function Data() { | |
| 4232 | this.expando = jQuery.expando + Data.uid++; | |
| 4233 | } | |
| 4234 | ||
| 4235 | Data.uid = 1; | |
| 4236 | ||
| 4237 | Data.prototype = { | |
| 4238 | ||
| 4239 | cache: function( owner ) { | |
| 4240 | ||
| 4241 | // Check if the owner object already has a cache | |
| 4242 | var value = owner[ this.expando ]; | |
| 4243 | ||
| 4244 | // If not, create one | |
| 4245 | if ( !value ) { | |
| 4246 | value = {}; | |
| 4247 | ||
| 4248 | // We can accept data for non-element nodes in modern browsers, | |
| 4249 | // but we should not, see #8335. | |
| 4250 | // Always return an empty object. | |
| 4251 | if ( acceptData( owner ) ) { | |
| 4252 | ||
| 4253 | // If it is a node unlikely to be stringify-ed or looped over | |
| 4254 | // use plain assignment | |
| 4255 | if ( owner.nodeType ) { | |
| 4256 | owner[ this.expando ] = value; | |
| 4257 | ||
| 4258 | // Otherwise secure it in a non-enumerable property | |
| 4259 | // configurable must be true to allow the property to be | |
| 4260 | // deleted when data is removed | |
| 4261 | } else { | |
| 4262 | Object.defineProperty( owner, this.expando, { | |
| 4263 | value: value, | |
| 4264 | configurable: true | |
| 4265 | } ); | |
| 4266 | } | |
| 4267 | } | |
| 4268 | } | |
| 4269 | ||
| 4270 | return value; | |
| 4271 | }, | |
| 4272 | set: function( owner, data, value ) { | |
| 4273 | var prop, | |
| 4274 | cache = this.cache( owner ); | |
| 4275 | ||
| 4276 | // Handle: [ owner, key, value ] args | |
| 4277 | // Always use camelCase key (gh-2257) | |
| 4278 | if ( typeof data === "string" ) { | |
| 4279 | cache[ camelCase( data ) ] = value; | |
| 4280 | ||
| 4281 | // Handle: [ owner, { properties } ] args | |
| 4282 | } else { | |
| 4283 | ||
| 4284 | // Copy the properties one-by-one to the cache object | |
| 4285 | for ( prop in data ) { | |
| 4286 | cache[ camelCase( prop ) ] = data[ prop ]; | |
| 4287 | } | |
| 4288 | } | |
| 4289 | return cache; | |
| 4290 | }, | |
| 4291 | get: function( owner, key ) { | |
| 4292 | return key === undefined ? | |
| 4293 | this.cache( owner ) : | |
| 4294 | ||
| 4295 | // Always use camelCase key (gh-2257) | |
| 4296 | owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; | |
| 4297 | }, | |
| 4298 | access: function( owner, key, value ) { | |
| 4299 | ||
| 4300 | // In cases where either: | |
| 4301 | // | |
| 4302 | // 1. No key was specified | |
| 4303 | // 2. A string key was specified, but no value provided | |
| 4304 | // | |
| 4305 | // Take the "read" path and allow the get method to determine | |
| 4306 | // which value to return, respectively either: | |
| 4307 | // | |
| 4308 | // 1. The entire cache object | |
| 4309 | // 2. The data stored at the key | |
| 4310 | // | |
| 4311 | if ( key === undefined || | |
| 4312 | ( ( key && typeof key === "string" ) && value === undefined ) ) { | |
| 4313 | ||
| 4314 | return this.get( owner, key ); | |
| 4315 | } | |
| 4316 | ||
| 4317 | // When the key is not a string, or both a key and value | |
| 4318 | // are specified, set or extend (existing objects) with either: | |
| 4319 | // | |
| 4320 | // 1. An object of properties | |
| 4321 | // 2. A key and value | |
| 4322 | // | |
| 4323 | this.set( owner, key, value ); | |
| 4324 | ||
| 4325 | // Since the "set" path can have two possible entry points | |
| 4326 | // return the expected data based on which path was taken[*] | |
| 4327 | return value !== undefined ? value : key; | |
| 4328 | }, | |
| 4329 | remove: function( owner, key ) { | |
| 4330 | var i, | |
| 4331 | cache = owner[ this.expando ]; | |
| 4332 | ||
| 4333 | if ( cache === undefined ) { | |
| 4334 | return; | |
| 4335 | } | |
| 4336 | ||
| 4337 | if ( key !== undefined ) { | |
| 4338 | ||
| 4339 | // Support array or space separated string of keys | |
| 4340 | if ( Array.isArray( key ) ) { | |
| 4341 | ||
| 4342 | // If key is an array of keys... | |
| 4343 | // We always set camelCase keys, so remove that. | |
| 4344 | key = key.map( camelCase ); | |
| 4345 | } else { | |
| 4346 | key = camelCase( key ); | |
| 4347 | ||
| 4348 | // If a key with the spaces exists, use it. | |
| 4349 | // Otherwise, create an array by matching non-whitespace | |
| 4350 | key = key in cache ? | |
| 4351 | [ key ] : | |
| 4352 | ( key.match( rnothtmlwhite ) || [] ); | |
| 4353 | } | |
| 4354 | ||
| 4355 | i = key.length; | |
| 4356 | ||
| 4357 | while ( i-- ) { | |
| 4358 | delete cache[ key[ i ] ]; | |
| 4359 | } | |
| 4360 | } | |
| 4361 | ||
| 4362 | // Remove the expando if there's no more data | |
| 4363 | if ( key === undefined || jQuery.isEmptyObject( cache ) ) { | |
| 4364 | ||
| 4365 | // Support: Chrome <=35 - 45 | |
| 4366 | // Webkit & Blink performance suffers when deleting properties | |
| 4367 | // from DOM nodes, so set to undefined instead | |
| 4368 | // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) | |
| 4369 | if ( owner.nodeType ) { | |
| 4370 | owner[ this.expando ] = undefined; | |
| 4371 | } else { | |
| 4372 | delete owner[ this.expando ]; | |
| 4373 | } | |
| 4374 | } | |
| 4375 | }, | |
| 4376 | hasData: function( owner ) { | |
| 4377 | var cache = owner[ this.expando ]; | |
| 4378 | return cache !== undefined && !jQuery.isEmptyObject( cache ); | |
| 4379 | } | |
| 4380 | }; | |
| 4381 | var dataPriv = new Data(); | |
| 4382 | ||
| 4383 | var dataUser = new Data(); | |
| 4384 | ||
| 4385 | ||
| 4386 | ||
| 4387 | // Implementation Summary | |
| 4388 | // | |
| 4389 | // 1. Enforce API surface and semantic compatibility with 1.9.x branch | |
| 4390 | // 2. Improve the module's maintainability by reducing the storage | |
| 4391 | // paths to a single mechanism. | |
| 4392 | // 3. Use the same single mechanism to support "private" and "user" data. | |
| 4393 | // 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) | |
| 4394 | // 5. Avoid exposing implementation details on user objects (eg. expando properties) | |
| 4395 | // 6. Provide a clear path for implementation upgrade to WeakMap in 2014 | |
| 4396 | ||
| 4397 | var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, | |
| 4398 | rmultiDash = /[A-Z]/g; | |
| 4399 | ||
| 4400 | function getData( data ) { | |
| 4401 | if ( data === "true" ) { | |
| 4402 | return true; | |
| 4403 | } | |
| 4404 | ||
| 4405 | if ( data === "false" ) { | |
| 4406 | return false; | |
| 4407 | } | |
| 4408 | ||
| 4409 | if ( data === "null" ) { | |
| 4410 | return null; | |
| 4411 | } | |
| 4412 | ||
| 4413 | // Only convert to a number if it doesn't change the string | |
| 4414 | if ( data === +data + "" ) { | |
| 4415 | return +data; | |
| 4416 | } | |
| 4417 | ||
| 4418 | if ( rbrace.test( data ) ) { | |
| 4419 | return JSON.parse( data ); | |
| 4420 | } | |
| 4421 | ||
| 4422 | return data; | |
| 4423 | } | |
| 4424 | ||
| 4425 | function dataAttr( elem, key, data ) { | |
| 4426 | var name; | |
| 4427 | ||
| 4428 | // If nothing was found internally, try to fetch any | |
| 4429 | // data from the HTML5 data-* attribute | |
| 4430 | if ( data === undefined && elem.nodeType === 1 ) { | |
| 4431 | name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); | |
| 4432 | data = elem.getAttribute( name ); | |
| 4433 | ||
| 4434 | if ( typeof data === "string" ) { | |
| 4435 | try { | |
| 4436 | data = getData( data ); | |
| 4437 | } catch ( e ) {} | |
| 4438 | ||
| 4439 | // Make sure we set the data so it isn't changed later | |
| 4440 | dataUser.set( elem, key, data ); | |
| 4441 | } else { | |
| 4442 | data = undefined; | |
| 4443 | } | |
| 4444 | } | |
| 4445 | return data; | |
| 4446 | } | |
| 4447 | ||
| 4448 | jQuery.extend( { | |
| 4449 | hasData: function( elem ) { | |
| 4450 | return dataUser.hasData( elem ) || dataPriv.hasData( elem ); | |
| 4451 | }, | |
| 4452 | ||
| 4453 | data: function( elem, name, data ) { | |
| 4454 | return dataUser.access( elem, name, data ); | |
| 4455 | }, | |
| 4456 | ||
| 4457 | removeData: function( elem, name ) { | |
| 4458 | dataUser.remove( elem, name ); | |
| 4459 | }, | |
| 4460 | ||
| 4461 | // TODO: Now that all calls to _data and _removeData have been replaced | |
| 4462 | // with direct calls to dataPriv methods, these can be deprecated. | |
| 4463 | _data: function( elem, name, data ) { | |
| 4464 | return dataPriv.access( elem, name, data ); | |
| 4465 | }, | |
| 4466 | ||
| 4467 | _removeData: function( elem, name ) { | |
| 4468 | dataPriv.remove( elem, name ); | |
| 4469 | } | |
| 4470 | } ); | |
| 4471 | ||
| 4472 | jQuery.fn.extend( { | |
| 4473 | data: function( key, value ) { | |
| 4474 | var i, name, data, | |
| 4475 | elem = this[ 0 ], | |
| 4476 | attrs = elem && elem.attributes; | |
| 4477 | ||
| 4478 | // Gets all values | |
| 4479 | if ( key === undefined ) { | |
| 4480 | if ( this.length ) { | |
| 4481 | data = dataUser.get( elem ); | |
| 4482 | ||
| 4483 | if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { | |
| 4484 | i = attrs.length; | |
| 4485 | while ( i-- ) { | |
| 4486 | ||
| 4487 | // Support: IE 11 only | |
| 4488 | // The attrs elements can be null (#14894) | |
| 4489 | if ( attrs[ i ] ) { | |
| 4490 | name = attrs[ i ].name; | |
| 4491 | if ( name.indexOf( "data-" ) === 0 ) { | |
| 4492 | name = camelCase( name.slice( 5 ) ); | |
| 4493 | dataAttr( elem, name, data[ name ] ); | |
| 4494 | } | |
| 4495 | } | |
| 4496 | } | |
| 4497 | dataPriv.set( elem, "hasDataAttrs", true ); | |
| 4498 | } | |
| 4499 | } | |
| 4500 | ||
| 4501 | return data; | |
| 4502 | } | |
| 4503 | ||
| 4504 | // Sets multiple values | |
| 4505 | if ( typeof key === "object" ) { | |
| 4506 | return this.each( function() { | |
| 4507 | dataUser.set( this, key ); | |
| 4508 | } ); | |
| 4509 | } | |
| 4510 | ||
| 4511 | return access( this, function( value ) { | |
| 4512 | var data; | |
| 4513 | ||
| 4514 | // The calling jQuery object (element matches) is not empty | |
| 4515 | // (and therefore has an element appears at this[ 0 ]) and the | |
| 4516 | // `value` parameter was not undefined. An empty jQuery object | |
| 4517 | // will result in `undefined` for elem = this[ 0 ] which will | |
| 4518 | // throw an exception if an attempt to read a data cache is made. | |
| 4519 | if ( elem && value === undefined ) { | |
| 4520 | ||
| 4521 | // Attempt to get data from the cache | |
| 4522 | // The key will always be camelCased in Data | |
| 4523 | data = dataUser.get( elem, key ); | |
| 4524 | if ( data !== undefined ) { | |
| 4525 | return data; | |
| 4526 | } | |
| 4527 | ||
| 4528 | // Attempt to "discover" the data in | |
| 4529 | // HTML5 custom data-* attrs | |
| 4530 | data = dataAttr( elem, key ); | |
| 4531 | if ( data !== undefined ) { | |
| 4532 | return data; | |
| 4533 | } | |
| 4534 | ||
| 4535 | // We tried really hard, but the data doesn't exist. | |
| 4536 | return; | |
| 4537 | } | |
| 4538 | ||
| 4539 | // Set the data... | |
| 4540 | this.each( function() { | |
| 4541 | ||
| 4542 | // We always store the camelCased key | |
| 4543 | dataUser.set( this, key, value ); | |
| 4544 | } ); | |
| 4545 | }, null, value, arguments.length > 1, null, true ); | |
| 4546 | }, | |
| 4547 | ||
| 4548 | removeData: function( key ) { | |
| 4549 | return this.each( function() { | |
| 4550 | dataUser.remove( this, key ); | |
| 4551 | } ); | |
| 4552 | } | |
| 4553 | } ); | |
| 4554 | ||
| 4555 | ||
| 4556 | jQuery.extend( { | |
| 4557 | queue: function( elem, type, data ) { | |
| 4558 | var queue; | |
| 4559 | ||
| 4560 | if ( elem ) { | |
| 4561 | type = ( type || "fx" ) + "queue"; | |
| 4562 | queue = dataPriv.get( elem, type ); | |
| 4563 | ||
| 4564 | // Speed up dequeue by getting out quickly if this is just a lookup | |
| 4565 | if ( data ) { | |
| 4566 | if ( !queue || Array.isArray( data ) ) { | |
| 4567 | queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); | |
| 4568 | } else { | |
| 4569 | queue.push( data ); | |
| 4570 | } | |
| 4571 | } | |
| 4572 | return queue || []; | |
| 4573 | } | |
| 4574 | }, | |
| 4575 | ||
| 4576 | dequeue: function( elem, type ) { | |
| 4577 | type = type || "fx"; | |
| 4578 | ||
| 4579 | var queue = jQuery.queue( elem, type ), | |
| 4580 | startLength = queue.length, | |
| 4581 | fn = queue.shift(), | |
| 4582 | hooks = jQuery._queueHooks( elem, type ), | |
| 4583 | next = function() { | |
| 4584 | jQuery.dequeue( elem, type ); | |
| 4585 | }; | |
| 4586 | ||
| 4587 | // If the fx queue is dequeued, always remove the progress sentinel | |
| 4588 | if ( fn === "inprogress" ) { | |
| 4589 | fn = queue.shift(); | |
| 4590 | startLength--; | |
| 4591 | } | |
| 4592 | ||
| 4593 | if ( fn ) { | |
| 4594 | ||
| 4595 | // Add a progress sentinel to prevent the fx queue from being | |
| 4596 | // automatically dequeued | |
| 4597 | if ( type === "fx" ) { | |
| 4598 | queue.unshift( "inprogress" ); | |
| 4599 | } | |
| 4600 | ||
| 4601 | // Clear up the last queue stop function | |
| 4602 | delete hooks.stop; | |
| 4603 | fn.call( elem, next, hooks ); | |
| 4604 | } | |
| 4605 | ||
| 4606 | if ( !startLength && hooks ) { | |
| 4607 | hooks.empty.fire(); | |
| 4608 | } | |
| 4609 | }, | |
| 4610 | ||
| 4611 | // Not public - generate a queueHooks object, or return the current one | |
| 4612 | _queueHooks: function( elem, type ) { | |
| 4613 | var key = type + "queueHooks"; | |
| 4614 | return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { | |
| 4615 | empty: jQuery.Callbacks( "once memory" ).add( function() { | |
| 4616 | dataPriv.remove( elem, [ type + "queue", key ] ); | |
| 4617 | } ) | |
| 4618 | } ); | |
| 4619 | } | |
| 4620 | } ); | |
| 4621 | ||
| 4622 | jQuery.fn.extend( { | |
| 4623 | queue: function( type, data ) { | |
| 4624 | var setter = 2; | |
| 4625 | ||
| 4626 | if ( typeof type !== "string" ) { | |
| 4627 | data = type; | |
| 4628 | type = "fx"; | |
| 4629 | setter--; | |
| 4630 | } | |
| 4631 | ||
| 4632 | if ( arguments.length < setter ) { | |
| 4633 | return jQuery.queue( this[ 0 ], type ); | |
| 4634 | } | |
| 4635 | ||
| 4636 | return data === undefined ? | |
| 4637 | this : | |
| 4638 | this.each( function() { | |
| 4639 | var queue = jQuery.queue( this, type, data ); | |
| 4640 | ||
| 4641 | // Ensure a hooks for this queue | |
| 4642 | jQuery._queueHooks( this, type ); | |
| 4643 | ||
| 4644 | if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { | |
| 4645 | jQuery.dequeue( this, type ); | |
| 4646 | } | |
| 4647 | } ); | |
| 4648 | }, | |
| 4649 | dequeue: function( type ) { | |
| 4650 | return this.each( function() { | |
| 4651 | jQuery.dequeue( this, type ); | |
| 4652 | } ); | |
| 4653 | }, | |
| 4654 | clearQueue: function( type ) { | |
| 4655 | return this.queue( type || "fx", [] ); | |
| 4656 | }, | |
| 4657 | ||
| 4658 | // Get a promise resolved when queues of a certain type | |
| 4659 | // are emptied (fx is the type by default) | |
| 4660 | promise: function( type, obj ) { | |
| 4661 | var tmp, | |
| 4662 | count = 1, | |
| 4663 | defer = jQuery.Deferred(), | |
| 4664 | elements = this, | |
| 4665 | i = this.length, | |
| 4666 | resolve = function() { | |
| 4667 | if ( !( --count ) ) { | |
| 4668 | defer.resolveWith( elements, [ elements ] ); | |
| 4669 | } | |
| 4670 | }; | |
| 4671 | ||
| 4672 | if ( typeof type !== "string" ) { | |
| 4673 | obj = type; | |
| 4674 | type = undefined; | |
| 4675 | } | |
| 4676 | type = type || "fx"; | |
| 4677 | ||
| 4678 | while ( i-- ) { | |
| 4679 | tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); | |
| 4680 | if ( tmp && tmp.empty ) { | |
| 4681 | count++; | |
| 4682 | tmp.empty.add( resolve ); | |
| 4683 | } | |
| 4684 | } | |
| 4685 | resolve(); | |
| 4686 | return defer.promise( obj ); | |
| 4687 | } | |
| 4688 | } ); | |
| 4689 | var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; | |
| 4690 | ||
| 4691 | var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); | |
| 4692 | ||
| 4693 | ||
| 4694 | var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; | |
| 4695 | ||
| 4696 | var documentElement = document.documentElement; | |
| 4697 | ||
| 4698 | ||
| 4699 | ||
| 4700 | var isAttached = function( elem ) { | |
| 4701 | return jQuery.contains( elem.ownerDocument, elem ); | |
| 4702 | }, | |
| 4703 | composed = { composed: true }; | |
| 4704 | ||
| 4705 | // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only | |
| 4706 | // Check attachment across shadow DOM boundaries when possible (gh-3504) | |
| 4707 | // Support: iOS 10.0-10.2 only | |
| 4708 | // Early iOS 10 versions support `attachShadow` but not `getRootNode`, | |
| 4709 | // leading to errors. We need to check for `getRootNode`. | |
| 4710 | if ( documentElement.getRootNode ) { | |
| 4711 | isAttached = function( elem ) { | |
| 4712 | return jQuery.contains( elem.ownerDocument, elem ) || | |
| 4713 | elem.getRootNode( composed ) === elem.ownerDocument; | |
| 4714 | }; | |
| 4715 | } | |
| 4716 | var isHiddenWithinTree = function( elem, el ) { | |
| 4717 | ||
| 4718 | // isHiddenWithinTree might be called from jQuery#filter function; | |
| 4719 | // in that case, element will be second argument | |
| 4720 | elem = el || elem; | |
| 4721 | ||
| 4722 | // Inline style trumps all | |
| 4723 | return elem.style.display === "none" || | |
| 4724 | elem.style.display === "" && | |
| 4725 | ||
| 4726 | // Otherwise, check computed style | |
| 4727 | // Support: Firefox <=43 - 45 | |
| 4728 | // Disconnected elements can have computed display: none, so first confirm that elem is | |
| 4729 | // in the document. | |
| 4730 | isAttached( elem ) && | |
| 4731 | ||
| 4732 | jQuery.css( elem, "display" ) === "none"; | |
| 4733 | }; | |
| 4734 | ||
| 4735 | ||
| 4736 | ||
| 4737 | function adjustCSS( elem, prop, valueParts, tween ) { | |
| 4738 | var adjusted, scale, | |
| 4739 | maxIterations = 20, | |
| 4740 | currentValue = tween ? | |
| 4741 | function() { | |
| 4742 | return tween.cur(); | |
| 4743 | } : | |
| 4744 | function() { | |
| 4745 | return jQuery.css( elem, prop, "" ); | |
| 4746 | }, | |
| 4747 | initial = currentValue(), | |
| 4748 | unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), | |
| 4749 | ||
| 4750 | // Starting value computation is required for potential unit mismatches | |
| 4751 | initialInUnit = elem.nodeType && | |
| 4752 | ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && | |
| 4753 | rcssNum.exec( jQuery.css( elem, prop ) ); | |
| 4754 | ||
| 4755 | if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { | |
| 4756 | ||
| 4757 | // Support: Firefox <=54 | |
| 4758 | // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) | |
| 4759 | initial = initial / 2; | |
| 4760 | ||
| 4761 | // Trust units reported by jQuery.css | |
| 4762 | unit = unit || initialInUnit[ 3 ]; | |
| 4763 | ||
| 4764 | // Iteratively approximate from a nonzero starting point | |
| 4765 | initialInUnit = +initial || 1; | |
| 4766 | ||
| 4767 | while ( maxIterations-- ) { | |
| 4768 | ||
| 4769 | // Evaluate and update our best guess (doubling guesses that zero out). | |
| 4770 | // Finish if the scale equals or crosses 1 (making the old*new product non-positive). | |
| 4771 | jQuery.style( elem, prop, initialInUnit + unit ); | |
| 4772 | if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { | |
| 4773 | maxIterations = 0; | |
| 4774 | } | |
| 4775 | initialInUnit = initialInUnit / scale; | |
| 4776 | ||
| 4777 | } | |
| 4778 | ||
| 4779 | initialInUnit = initialInUnit * 2; | |
| 4780 | jQuery.style( elem, prop, initialInUnit + unit ); | |
| 4781 | ||
| 4782 | // Make sure we update the tween properties later on | |
| 4783 | valueParts = valueParts || []; | |
| 4784 | } | |
| 4785 | ||
| 4786 | if ( valueParts ) { | |
| 4787 | initialInUnit = +initialInUnit || +initial || 0; | |
| 4788 | ||
| 4789 | // Apply relative offset (+=/-=) if specified | |
| 4790 | adjusted = valueParts[ 1 ] ? | |
| 4791 | initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : | |
| 4792 | +valueParts[ 2 ]; | |
| 4793 | if ( tween ) { | |
| 4794 | tween.unit = unit; | |
| 4795 | tween.start = initialInUnit; | |
| 4796 | tween.end = adjusted; | |
| 4797 | } | |
| 4798 | } | |
| 4799 | return adjusted; | |
| 4800 | } | |
| 4801 | ||
| 4802 | ||
| 4803 | var defaultDisplayMap = {}; | |
| 4804 | ||
| 4805 | function getDefaultDisplay( elem ) { | |
| 4806 | var temp, | |
| 4807 | doc = elem.ownerDocument, | |
| 4808 | nodeName = elem.nodeName, | |
| 4809 | display = defaultDisplayMap[ nodeName ]; | |
| 4810 | ||
| 4811 | if ( display ) { | |
| 4812 | return display; | |
| 4813 | } | |
| 4814 | ||
| 4815 | temp = doc.body.appendChild( doc.createElement( nodeName ) ); | |
| 4816 | display = jQuery.css( temp, "display" ); | |
| 4817 | ||
| 4818 | temp.parentNode.removeChild( temp ); | |
| 4819 | ||
| 4820 | if ( display === "none" ) { | |
| 4821 | display = "block"; | |
| 4822 | } | |
| 4823 | defaultDisplayMap[ nodeName ] = display; | |
| 4824 | ||
| 4825 | return display; | |
| 4826 | } | |
| 4827 | ||
| 4828 | function showHide( elements, show ) { | |
| 4829 | var display, elem, | |
| 4830 | values = [], | |
| 4831 | index = 0, | |
| 4832 | length = elements.length; | |
| 4833 | ||
| 4834 | // Determine new display value for elements that need to change | |
| 4835 | for ( ; index < length; index++ ) { | |
| 4836 | elem = elements[ index ]; | |
| 4837 | if ( !elem.style ) { | |
| 4838 | continue; | |
| 4839 | } | |
| 4840 | ||
| 4841 | display = elem.style.display; | |
| 4842 | if ( show ) { | |
| 4843 | ||
| 4844 | // Since we force visibility upon cascade-hidden elements, an immediate (and slow) | |
| 4845 | // check is required in this first loop unless we have a nonempty display value (either | |
| 4846 | // inline or about-to-be-restored) | |
| 4847 | if ( display === "none" ) { | |
| 4848 | values[ index ] = dataPriv.get( elem, "display" ) || null; | |
| 4849 | if ( !values[ index ] ) { | |
| 4850 | elem.style.display = ""; | |
| 4851 | } | |
| 4852 | } | |
| 4853 | if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { | |
| 4854 | values[ index ] = getDefaultDisplay( elem ); | |
| 4855 | } | |
| 4856 | } else { | |
| 4857 | if ( display !== "none" ) { | |
| 4858 | values[ index ] = "none"; | |
| 4859 | ||
| 4860 | // Remember what we're overwriting | |
| 4861 | dataPriv.set( elem, "display", display ); | |
| 4862 | } | |
| 4863 | } | |
| 4864 | } | |
| 4865 | ||
| 4866 | // Set the display of the elements in a second loop to avoid constant reflow | |
| 4867 | for ( index = 0; index < length; index++ ) { | |
| 4868 | if ( values[ index ] != null ) { | |
| 4869 | elements[ index ].style.display = values[ index ]; | |
| 4870 | } | |
| 4871 | } | |
| 4872 | ||
| 4873 | return elements; | |
| 4874 | } | |
| 4875 | ||
| 4876 | jQuery.fn.extend( { | |
| 4877 | show: function() { | |
| 4878 | return showHide( this, true ); | |
| 4879 | }, | |
| 4880 | hide: function() { | |
| 4881 | return showHide( this ); | |
| 4882 | }, | |
| 4883 | toggle: function( state ) { | |
| 4884 | if ( typeof state === "boolean" ) { | |
| 4885 | return state ? this.show() : this.hide(); | |
| 4886 | } | |
| 4887 | ||
| 4888 | return this.each( function() { | |
| 4889 | if ( isHiddenWithinTree( this ) ) { | |
| 4890 | jQuery( this ).show(); | |
| 4891 | } else { | |
| 4892 | jQuery( this ).hide(); | |
| 4893 | } | |
| 4894 | } ); | |
| 4895 | } | |
| 4896 | } ); | |
| 4897 | var rcheckableType = ( /^(?:checkbox|radio)$/i ); | |
| 4898 | ||
| 4899 | var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); | |
| 4900 | ||
| 4901 | var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); | |
| 4902 | ||
| 4903 | ||
| 4904 | ||
| 4905 | ( function() { | |
| 4906 | var fragment = document.createDocumentFragment(), | |
| 4907 | div = fragment.appendChild( document.createElement( "div" ) ), | |
| 4908 | input = document.createElement( "input" ); | |
| 4909 | ||
| 4910 | // Support: Android 4.0 - 4.3 only | |
| 4911 | // Check state lost if the name is set (#11217) | |
| 4912 | // Support: Windows Web Apps (WWA) | |
| 4913 | // `name` and `type` must use .setAttribute for WWA (#14901) | |
| 4914 | input.setAttribute( "type", "radio" ); | |
| 4915 | input.setAttribute( "checked", "checked" ); | |
| 4916 | input.setAttribute( "name", "t" ); | |
| 4917 | ||
| 4918 | div.appendChild( input ); | |
| 4919 | ||
| 4920 | // Support: Android <=4.1 only | |
| 4921 | // Older WebKit doesn't clone checked state correctly in fragments | |
| 4922 | support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; | |
| 4923 | ||
| 4924 | // Support: IE <=11 only | |
| 4925 | // Make sure textarea (and checkbox) defaultValue is properly cloned | |
| 4926 | div.innerHTML = "<textarea>x</textarea>"; | |
| 4927 | support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; | |
| 4928 | ||
| 4929 | // Support: IE <=9 only | |
| 4930 | // IE <=9 replaces <option> tags with their contents when inserted outside of | |
| 4931 | // the select element. | |
| 4932 | div.innerHTML = "<option></option>"; | |
| 4933 | support.option = !!div.lastChild; | |
| 4934 | } )(); | |
| 4935 | ||
| 4936 | ||
| 4937 | // We have to close these tags to support XHTML (#13200) | |
| 4938 | var wrapMap = { | |
| 4939 | ||
| 4940 | // XHTML parsers do not magically insert elements in the | |
| 4941 | // same way that tag soup parsers do. So we cannot shorten | |
| 4942 | // this by omitting <tbody> or other required elements. | |
| 4943 | thead: [ 1, "<table>", "</table>" ], | |
| 4944 | col: [ 2, "<table><colgroup>", "</colgroup></table>" ], | |
| 4945 | tr: [ 2, "<table><tbody>", "</tbody></table>" ], | |
| 4946 | td: [ 3, "<table><tbody><tr>", "</tr></tbody></table>" ], | |
| 4947 | ||
| 4948 | _default: [ 0, "", "" ] | |
| 4949 | }; | |
| 4950 | ||
| 4951 | wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; | |
| 4952 | wrapMap.th = wrapMap.td; | |
| 4953 | ||
| 4954 | // Support: IE <=9 only | |
| 4955 | if ( !support.option ) { | |
| 4956 | wrapMap.optgroup = wrapMap.option = [ 1, "<select multiple='multiple'>", "</select>" ]; | |
| 4957 | } | |
| 4958 | ||
| 4959 | ||
| 4960 | function getAll( context, tag ) { | |
| 4961 | ||
| 4962 | // Support: IE <=9 - 11 only | |
| 4963 | // Use typeof to avoid zero-argument method invocation on host objects (#15151) | |
| 4964 | var ret; | |
| 4965 | ||
| 4966 | if ( typeof context.getElementsByTagName !== "undefined" ) { | |
| 4967 | ret = context.getElementsByTagName( tag || "*" ); | |
| 4968 | ||
| 4969 | } else if ( typeof context.querySelectorAll !== "undefined" ) { | |
| 4970 | ret = context.querySelectorAll( tag || "*" ); | |
| 4971 | ||
| 4972 | } else { | |
| 4973 | ret = []; | |
| 4974 | } | |
| 4975 | ||
| 4976 | if ( tag === undefined || tag && nodeName( context, tag ) ) { | |
| 4977 | return jQuery.merge( [ context ], ret ); | |
| 4978 | } | |
| 4979 | ||
| 4980 | return ret; | |
| 4981 | } | |
| 4982 | ||
| 4983 | ||
| 4984 | // Mark scripts as having already been evaluated | |
| 4985 | function setGlobalEval( elems, refElements ) { | |
| 4986 | var i = 0, | |
| 4987 | l = elems.length; | |
| 4988 | ||
| 4989 | for ( ; i < l; i++ ) { | |
| 4990 | dataPriv.set( | |
| 4991 | elems[ i ], | |
| 4992 | "globalEval", | |
| 4993 | !refElements || dataPriv.get( refElements[ i ], "globalEval" ) | |
| 4994 | ); | |
| 4995 | } | |
| 4996 | } | |
| 4997 | ||
| 4998 | ||
| 4999 | var rhtml = /<|&#?\w+;/; | |
| 5000 | ||
| 5001 | function buildFragment( elems, context, scripts, selection, ignored ) { | |
| 5002 | var elem, tmp, tag, wrap, attached, j, | |
| 5003 | fragment = context.createDocumentFragment(), | |
| 5004 | nodes = [], | |
| 5005 | i = 0, | |
| 5006 | l = elems.length; | |
| 5007 | ||
| 5008 | for ( ; i < l; i++ ) { | |
| 5009 | elem = elems[ i ]; | |
| 5010 | ||
| 5011 | if ( elem || elem === 0 ) { | |
| 5012 | ||
| 5013 | // Add nodes directly | |
| 5014 | if ( toType( elem ) === "object" ) { | |
| 5015 | ||
| 5016 | // Support: Android <=4.0 only, PhantomJS 1 only | |
| 5017 | // push.apply(_, arraylike) throws on ancient WebKit | |
| 5018 | jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); | |
| 5019 | ||
| 5020 | // Convert non-html into a text node | |
| 5021 | } else if ( !rhtml.test( elem ) ) { | |
| 5022 | nodes.push( context.createTextNode( elem ) ); | |
| 5023 | ||
| 5024 | // Convert html into DOM nodes | |
| 5025 | } else { | |
| 5026 | tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); | |
| 5027 | ||
| 5028 | // Deserialize a standard representation | |
| 5029 | tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); | |
| 5030 | wrap = wrapMap[ tag ] || wrapMap._default; | |
| 5031 | tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; | |
| 5032 | ||
| 5033 | // Descend through wrappers to the right content | |
| 5034 | j = wrap[ 0 ]; | |
| 5035 | while ( j-- ) { | |
| 5036 | tmp = tmp.lastChild; | |
| 5037 | } | |
| 5038 | ||
| 5039 | // Support: Android <=4.0 only, PhantomJS 1 only | |
| 5040 | // push.apply(_, arraylike) throws on ancient WebKit | |
| 5041 | jQuery.merge( nodes, tmp.childNodes ); | |
| 5042 | ||
| 5043 | // Remember the top-level container | |
| 5044 | tmp = fragment.firstChild; | |
| 5045 | ||
| 5046 | // Ensure the created nodes are orphaned (#12392) | |
| 5047 | tmp.textContent = ""; | |
| 5048 | } | |
| 5049 | } | |
| 5050 | } | |
| 5051 | ||
| 5052 | // Remove wrapper from fragment | |
| 5053 | fragment.textContent = ""; | |
| 5054 | ||
| 5055 | i = 0; | |
| 5056 | while ( ( elem = nodes[ i++ ] ) ) { | |
| 5057 | ||
| 5058 | // Skip elements already in the context collection (trac-4087) | |
| 5059 | if ( selection && jQuery.inArray( elem, selection ) > -1 ) { | |
| 5060 | if ( ignored ) { | |
| 5061 | ignored.push( elem ); | |
| 5062 | } | |
| 5063 | continue; | |
| 5064 | } | |
| 5065 | ||
| 5066 | attached = isAttached( elem ); | |
| 5067 | ||
| 5068 | // Append to fragment | |
| 5069 | tmp = getAll( fragment.appendChild( elem ), "script" ); | |
| 5070 | ||
| 5071 | // Preserve script evaluation history | |
| 5072 | if ( attached ) { | |
| 5073 | setGlobalEval( tmp ); | |
| 5074 | } | |
| 5075 | ||
| 5076 | // Capture executables | |
| 5077 | if ( scripts ) { | |
| 5078 | j = 0; | |
| 5079 | while ( ( elem = tmp[ j++ ] ) ) { | |
| 5080 | if ( rscriptType.test( elem.type || "" ) ) { | |
| 5081 | scripts.push( elem ); | |
| 5082 | } | |
| 5083 | } | |
| 5084 | } | |
| 5085 | } | |
| 5086 | ||
| 5087 | return fragment; | |
| 5088 | } | |
| 5089 | ||
| 5090 | ||
| 5091 | var | |
| 5092 | rkeyEvent = /^key/, | |
| 5093 | rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, | |
| 5094 | rtypenamespace = /^([^.]*)(?:\.(.+)|)/; | |
| 5095 | ||
| 5096 | function returnTrue() { | |
| 5097 | return true; | |
| 5098 | } | |
| 5099 | ||
| 5100 | function returnFalse() { | |
| 5101 | return false; | |
| 5102 | } | |
| 5103 | ||
| 5104 | // Support: IE <=9 - 11+ | |
| 5105 | // focus() and blur() are asynchronous, except when they are no-op. | |
| 5106 | // So expect focus to be synchronous when the element is already active, | |
| 5107 | // and blur to be synchronous when the element is not already active. | |
| 5108 | // (focus and blur are always synchronous in other supported browsers, | |
| 5109 | // this just defines when we can count on it). | |
| 5110 | function expectSync( elem, type ) { | |
| 5111 | return ( elem === safeActiveElement() ) === ( type === "focus" ); | |
| 5112 | } | |
| 5113 | ||
| 5114 | // Support: IE <=9 only | |
| 5115 | // Accessing document.activeElement can throw unexpectedly | |
| 5116 | // https://bugs.jquery.com/ticket/13393 | |
| 5117 | function safeActiveElement() { | |
| 5118 | try { | |
| 5119 | return document.activeElement; | |
| 5120 | } catch ( err ) { } | |
| 5121 | } | |
| 5122 | ||
| 5123 | function on( elem, types, selector, data, fn, one ) { | |
| 5124 | var origFn, type; | |
| 5125 | ||
| 5126 | // Types can be a map of types/handlers | |
| 5127 | if ( typeof types === "object" ) { | |
| 5128 | ||
| 5129 | // ( types-Object, selector, data ) | |
| 5130 | if ( typeof selector !== "string" ) { | |
| 5131 | ||
| 5132 | // ( types-Object, data ) | |
| 5133 | data = data || selector; | |
| 5134 | selector = undefined; | |
| 5135 | } | |
| 5136 | for ( type in types ) { | |
| 5137 | on( elem, type, selector, data, types[ type ], one ); | |
| 5138 | } | |
| 5139 | return elem; | |
| 5140 | } | |
| 5141 | ||
| 5142 | if ( data == null && fn == null ) { | |
| 5143 | ||
| 5144 | // ( types, fn ) | |
| 5145 | fn = selector; | |
| 5146 | data = selector = undefined; | |
| 5147 | } else if ( fn == null ) { | |
| 5148 | if ( typeof selector === "string" ) { | |
| 5149 | ||
| 5150 | // ( types, selector, fn ) | |
| 5151 | fn = data; | |
| 5152 | data = undefined; | |
| 5153 | } else { | |
| 5154 | ||
| 5155 | // ( types, data, fn ) | |
| 5156 | fn = data; | |
| 5157 | data = selector; | |
| 5158 | selector = undefined; | |
| 5159 | } | |
| 5160 | } | |
| 5161 | if ( fn === false ) { | |
| 5162 | fn = returnFalse; | |
| 5163 | } else if ( !fn ) { | |
| 5164 | return elem; | |
| 5165 | } | |
| 5166 | ||
| 5167 | if ( one === 1 ) { | |
| 5168 | origFn = fn; | |
| 5169 | fn = function( event ) { | |
| 5170 | ||
| 5171 | // Can use an empty set, since event contains the info | |
| 5172 | jQuery().off( event ); | |
| 5173 | return origFn.apply( this, arguments ); | |
| 5174 | }; | |
| 5175 | ||
| 5176 | // Use same guid so caller can remove using origFn | |
| 5177 | fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); | |
| 5178 | } | |
| 5179 | return elem.each( function() { | |
| 5180 | jQuery.event.add( this, types, fn, data, selector ); | |
| 5181 | } ); | |
| 5182 | } | |
| 5183 | ||
| 5184 | /* | |
| 5185 | * Helper functions for managing events -- not part of the public interface. | |
| 5186 | * Props to Dean Edwards' addEvent library for many of the ideas. | |
| 5187 | */ | |
| 5188 | jQuery.event = { | |
| 5189 | ||
| 5190 | global: {}, | |
| 5191 | ||
| 5192 | add: function( elem, types, handler, data, selector ) { | |
| 5193 | ||
| 5194 | var handleObjIn, eventHandle, tmp, | |
| 5195 | events, t, handleObj, | |
| 5196 | special, handlers, type, namespaces, origType, | |
| 5197 | elemData = dataPriv.get( elem ); | |
| 5198 | ||
| 5199 | // Only attach events to objects that accept data | |
| 5200 | if ( !acceptData( elem ) ) { | |
| 5201 | return; | |
| 5202 | } | |
| 5203 | ||
| 5204 | // Caller can pass in an object of custom data in lieu of the handler | |
| 5205 | if ( handler.handler ) { | |
| 5206 | handleObjIn = handler; | |
| 5207 | handler = handleObjIn.handler; | |
| 5208 | selector = handleObjIn.selector; | |
| 5209 | } | |
| 5210 | ||
| 5211 | // Ensure that invalid selectors throw exceptions at attach time | |
| 5212 | // Evaluate against documentElement in case elem is a non-element node (e.g., document) | |
| 5213 | if ( selector ) { | |
| 5214 | jQuery.find.matchesSelector( documentElement, selector ); | |
| 5215 | } | |
| 5216 | ||
| 5217 | // Make sure that the handler has a unique ID, used to find/remove it later | |
| 5218 | if ( !handler.guid ) { | |
| 5219 | handler.guid = jQuery.guid++; | |
| 5220 | } | |
| 5221 | ||
| 5222 | // Init the element's event structure and main handler, if this is the first | |
| 5223 | if ( !( events = elemData.events ) ) { | |
| 5224 | events = elemData.events = Object.create( null ); | |
| 5225 | } | |
| 5226 | if ( !( eventHandle = elemData.handle ) ) { | |
| 5227 | eventHandle = elemData.handle = function( e ) { | |
| 5228 | ||
| 5229 | // Discard the second event of a jQuery.event.trigger() and | |
| 5230 | // when an event is called after a page has unloaded | |
| 5231 | return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? | |
| 5232 | jQuery.event.dispatch.apply( elem, arguments ) : undefined; | |
| 5233 | }; | |
| 5234 | } | |
| 5235 | ||
| 5236 | // Handle multiple events separated by a space | |
| 5237 | types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; | |
| 5238 | t = types.length; | |
| 5239 | while ( t-- ) { | |
| 5240 | tmp = rtypenamespace.exec( types[ t ] ) || []; | |
| 5241 | type = origType = tmp[ 1 ]; | |
| 5242 | namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); | |
| 5243 | ||
| 5244 | // There *must* be a type, no attaching namespace-only handlers | |
| 5245 | if ( !type ) { | |
| 5246 | continue; | |
| 5247 | } | |
| 5248 | ||
| 5249 | // If event changes its type, use the special event handlers for the changed type | |
| 5250 | special = jQuery.event.special[ type ] || {}; | |
| 5251 | ||
| 5252 | // If selector defined, determine special event api type, otherwise given type | |
| 5253 | type = ( selector ? special.delegateType : special.bindType ) || type; | |
| 5254 | ||
| 5255 | // Update special based on newly reset type | |
| 5256 | special = jQuery.event.special[ type ] || {}; | |
| 5257 | ||
| 5258 | // handleObj is passed to all event handlers | |
| 5259 | handleObj = jQuery.extend( { | |
| 5260 | type: type, | |
| 5261 | origType: origType, | |
| 5262 | data: data, | |
| 5263 | handler: handler, | |
| 5264 | guid: handler.guid, | |
| 5265 | selector: selector, | |
| 5266 | needsContext: selector && jQuery.expr.match.needsContext.test( selector ), | |
| 5267 | namespace: namespaces.join( "." ) | |
| 5268 | }, handleObjIn ); | |
| 5269 | ||
| 5270 | // Init the event handler queue if we're the first | |
| 5271 | if ( !( handlers = events[ type ] ) ) { | |
| 5272 | handlers = events[ type ] = []; | |
| 5273 | handlers.delegateCount = 0; | |
| 5274 | ||
| 5275 | // Only use addEventListener if the special events handler returns false | |
| 5276 | if ( !special.setup || | |
| 5277 | special.setup.call( elem, data, namespaces, eventHandle ) === false ) { | |
| 5278 | ||
| 5279 | if ( elem.addEventListener ) { | |
| 5280 | elem.addEventListener( type, eventHandle ); | |
| 5281 | } | |
| 5282 | } | |
| 5283 | } | |
| 5284 | ||
| 5285 | if ( special.add ) { | |
| 5286 | special.add.call( elem, handleObj ); | |
| 5287 | ||
| 5288 | if ( !handleObj.handler.guid ) { | |
| 5289 | handleObj.handler.guid = handler.guid; | |
| 5290 | } | |
| 5291 | } | |
| 5292 | ||
| 5293 | // Add to the element's handler list, delegates in front | |
| 5294 | if ( selector ) { | |
| 5295 | handlers.splice( handlers.delegateCount++, 0, handleObj ); | |
| 5296 | } else { | |
| 5297 | handlers.push( handleObj ); | |
| 5298 | } | |
| 5299 | ||
| 5300 | // Keep track of which events have ever been used, for event optimization | |
| 5301 | jQuery.event.global[ type ] = true; | |
| 5302 | } | |
| 5303 | ||
| 5304 | }, | |
| 5305 | ||
| 5306 | // Detach an event or set of events from an element | |
| 5307 | remove: function( elem, types, handler, selector, mappedTypes ) { | |
| 5308 | ||
| 5309 | var j, origCount, tmp, | |
| 5310 | events, t, handleObj, | |
| 5311 | special, handlers, type, namespaces, origType, | |
| 5312 | elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); | |
| 5313 | ||
| 5314 | if ( !elemData || !( events = elemData.events ) ) { | |
| 5315 | return; | |
| 5316 | } | |
| 5317 | ||
| 5318 | // Once for each type.namespace in types; type may be omitted | |
| 5319 | types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; | |
| 5320 | t = types.length; | |
| 5321 | while ( t-- ) { | |
| 5322 | tmp = rtypenamespace.exec( types[ t ] ) || []; | |
| 5323 | type = origType = tmp[ 1 ]; | |
| 5324 | namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); | |
| 5325 | ||
| 5326 | // Unbind all events (on this namespace, if provided) for the element | |
| 5327 | if ( !type ) { | |
| 5328 | for ( type in events ) { | |
| 5329 | jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); | |
| 5330 | } | |
| 5331 | continue; | |
| 5332 | } | |
| 5333 | ||
| 5334 | special = jQuery.event.special[ type ] || {}; | |
| 5335 | type = ( selector ? special.delegateType : special.bindType ) || type; | |
| 5336 | handlers = events[ type ] || []; | |
| 5337 | tmp = tmp[ 2 ] && | |
| 5338 | new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); | |
| 5339 | ||
| 5340 | // Remove matching events | |
| 5341 | origCount = j = handlers.length; | |
| 5342 | while ( j-- ) { | |
| 5343 | handleObj = handlers[ j ]; | |
| 5344 | ||
| 5345 | if ( ( mappedTypes || origType === handleObj.origType ) && | |
| 5346 | ( !handler || handler.guid === handleObj.guid ) && | |
| 5347 | ( !tmp || tmp.test( handleObj.namespace ) ) && | |
| 5348 | ( !selector || selector === handleObj.selector || | |
| 5349 | selector === "**" && handleObj.selector ) ) { | |
| 5350 | handlers.splice( j, 1 ); | |
| 5351 | ||
| 5352 | if ( handleObj.selector ) { | |
| 5353 | handlers.delegateCount--; | |
| 5354 | } | |
| 5355 | if ( special.remove ) { | |
| 5356 | special.remove.call( elem, handleObj ); | |
| 5357 | } | |
| 5358 | } | |
| 5359 | } | |
| 5360 | ||
| 5361 | // Remove generic event handler if we removed something and no more handlers exist | |
| 5362 | // (avoids potential for endless recursion during removal of special event handlers) | |
| 5363 | if ( origCount && !handlers.length ) { | |
| 5364 | if ( !special.teardown || | |
| 5365 | special.teardown.call( elem, namespaces, elemData.handle ) === false ) { | |
| 5366 | ||
| 5367 | jQuery.removeEvent( elem, type, elemData.handle ); | |
| 5368 | } | |
| 5369 | ||
| 5370 | delete events[ type ]; | |
| 5371 | } | |
| 5372 | } | |
| 5373 | ||
| 5374 | // Remove data and the expando if it's no longer used | |
| 5375 | if ( jQuery.isEmptyObject( events ) ) { | |
| 5376 | dataPriv.remove( elem, "handle events" ); | |
| 5377 | } | |
| 5378 | }, | |
| 5379 | ||
| 5380 | dispatch: function( nativeEvent ) { | |
| 5381 | ||
| 5382 | var i, j, ret, matched, handleObj, handlerQueue, | |
| 5383 | args = new Array( arguments.length ), | |
| 5384 | ||
| 5385 | // Make a writable jQuery.Event from the native event object | |
| 5386 | event = jQuery.event.fix( nativeEvent ), | |
| 5387 | ||
| 5388 | handlers = ( | |
| 5389 | dataPriv.get( this, "events" ) || Object.create( null ) | |
| 5390 | )[ event.type ] || [], | |
| 5391 | special = jQuery.event.special[ event.type ] || {}; | |
| 5392 | ||
| 5393 | // Use the fix-ed jQuery.Event rather than the (read-only) native event | |
| 5394 | args[ 0 ] = event; | |
| 5395 | ||
| 5396 | for ( i = 1; i < arguments.length; i++ ) { | |
| 5397 | args[ i ] = arguments[ i ]; | |
| 5398 | } | |
| 5399 | ||
| 5400 | event.delegateTarget = this; | |
| 5401 | ||
| 5402 | // Call the preDispatch hook for the mapped type, and let it bail if desired | |
| 5403 | if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { | |
| 5404 | return; | |
| 5405 | } | |
| 5406 | ||
| 5407 | // Determine handlers | |
| 5408 | handlerQueue = jQuery.event.handlers.call( this, event, handlers ); | |
| 5409 | ||
| 5410 | // Run delegates first; they may want to stop propagation beneath us | |
| 5411 | i = 0; | |
| 5412 | while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { | |
| 5413 | event.currentTarget = matched.elem; | |
| 5414 | ||
| 5415 | j = 0; | |
| 5416 | while ( ( handleObj = matched.handlers[ j++ ] ) && | |
| 5417 | !event.isImmediatePropagationStopped() ) { | |
| 5418 | ||
| 5419 | // If the event is namespaced, then each handler is only invoked if it is | |
| 5420 | // specially universal or its namespaces are a superset of the event's. | |
| 5421 | if ( !event.rnamespace || handleObj.namespace === false || | |
| 5422 | event.rnamespace.test( handleObj.namespace ) ) { | |
| 5423 | ||
| 5424 | event.handleObj = handleObj; | |
| 5425 | event.data = handleObj.data; | |
| 5426 | ||
| 5427 | ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || | |
| 5428 | handleObj.handler ).apply( matched.elem, args ); | |
| 5429 | ||
| 5430 | if ( ret !== undefined ) { | |
| 5431 | if ( ( event.result = ret ) === false ) { | |
| 5432 | event.preventDefault(); | |
| 5433 | event.stopPropagation(); | |
| 5434 | } | |
| 5435 | } | |
| 5436 | } | |
| 5437 | } | |
| 5438 | } | |
| 5439 | ||
| 5440 | // Call the postDispatch hook for the mapped type | |
| 5441 | if ( special.postDispatch ) { | |
| 5442 | special.postDispatch.call( this, event ); | |
| 5443 | } | |
| 5444 | ||
| 5445 | return event.result; | |
| 5446 | }, | |
| 5447 | ||
| 5448 | handlers: function( event, handlers ) { | |
| 5449 | var i, handleObj, sel, matchedHandlers, matchedSelectors, | |
| 5450 | handlerQueue = [], | |
| 5451 | delegateCount = handlers.delegateCount, | |
| 5452 | cur = event.target; | |
| 5453 | ||
| 5454 | // Find delegate handlers | |
| 5455 | if ( delegateCount && | |
| 5456 | ||
| 5457 | // Support: IE <=9 | |
| 5458 | // Black-hole SVG <use> instance trees (trac-13180) | |
| 5459 | cur.nodeType && | |
| 5460 | ||
| 5461 | // Support: Firefox <=42 | |
| 5462 | // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) | |
| 5463 | // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click | |
| 5464 | // Support: IE 11 only | |
| 5465 | // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) | |
| 5466 | !( event.type === "click" && event.button >= 1 ) ) { | |
| 5467 | ||
| 5468 | for ( ; cur !== this; cur = cur.parentNode || this ) { | |
| 5469 | ||
| 5470 | // Don't check non-elements (#13208) | |
| 5471 | // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) | |
| 5472 | if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { | |
| 5473 | matchedHandlers = []; | |
| 5474 | matchedSelectors = {}; | |
| 5475 | for ( i = 0; i < delegateCount; i++ ) { | |
| 5476 | handleObj = handlers[ i ]; | |
| 5477 | ||
| 5478 | // Don't conflict with Object.prototype properties (#13203) | |
| 5479 | sel = handleObj.selector + " "; | |
| 5480 | ||
| 5481 | if ( matchedSelectors[ sel ] === undefined ) { | |
| 5482 | matchedSelectors[ sel ] = handleObj.needsContext ? | |
| 5483 | jQuery( sel, this ).index( cur ) > -1 : | |
| 5484 | jQuery.find( sel, this, null, [ cur ] ).length; | |
| 5485 | } | |
| 5486 | if ( matchedSelectors[ sel ] ) { | |
| 5487 | matchedHandlers.push( handleObj ); | |
| 5488 | } | |
| 5489 | } | |
| 5490 | if ( matchedHandlers.length ) { | |
| 5491 | handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); | |
| 5492 | } | |
| 5493 | } | |
| 5494 | } | |
| 5495 | } | |
| 5496 | ||
| 5497 | // Add the remaining (directly-bound) handlers | |
| 5498 | cur = this; | |
| 5499 | if ( delegateCount < handlers.length ) { | |
| 5500 | handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); | |
| 5501 | } | |
| 5502 | ||
| 5503 | return handlerQueue; | |
| 5504 | }, | |
| 5505 | ||
| 5506 | addProp: function( name, hook ) { | |
| 5507 | Object.defineProperty( jQuery.Event.prototype, name, { | |
| 5508 | enumerable: true, | |
| 5509 | configurable: true, | |
| 5510 | ||
| 5511 | get: isFunction( hook ) ? | |
| 5512 | function() { | |
| 5513 | if ( this.originalEvent ) { | |
| 5514 | return hook( this.originalEvent ); | |
| 5515 | } | |
| 5516 | } : | |
| 5517 | function() { | |
| 5518 | if ( this.originalEvent ) { | |
| 5519 | return this.originalEvent[ name ]; | |
| 5520 | } | |
| 5521 | }, | |
| 5522 | ||
| 5523 | set: function( value ) { | |
| 5524 | Object.defineProperty( this, name, { | |
| 5525 | enumerable: true, | |
| 5526 | configurable: true, | |
| 5527 | writable: true, | |
| 5528 | value: value | |
| 5529 | } ); | |
| 5530 | } | |
| 5531 | } ); | |
| 5532 | }, | |
| 5533 | ||
| 5534 | fix: function( originalEvent ) { | |
| 5535 | return originalEvent[ jQuery.expando ] ? | |
| 5536 | originalEvent : | |
| 5537 | new jQuery.Event( originalEvent ); | |
| 5538 | }, | |
| 5539 | ||
| 5540 | special: { | |
| 5541 | load: { | |
| 5542 | ||
| 5543 | // Prevent triggered image.load events from bubbling to window.load | |
| 5544 | noBubble: true | |
| 5545 | }, | |
| 5546 | click: { | |
| 5547 | ||
| 5548 | // Utilize native event to ensure correct state for checkable inputs | |
| 5549 | setup: function( data ) { | |
| 5550 | ||
| 5551 | // For mutual compressibility with _default, replace `this` access with a local var. | |
| 5552 | // `|| data` is dead code meant only to preserve the variable through minification. | |
| 5553 | var el = this || data; | |
| 5554 | ||
| 5555 | // Claim the first handler | |
| 5556 | if ( rcheckableType.test( el.type ) && | |
| 5557 | el.click && nodeName( el, "input" ) ) { | |
| 5558 | ||
| 5559 | // dataPriv.set( el, "click", ... ) | |
| 5560 | leverageNative( el, "click", returnTrue ); | |
| 5561 | } | |
| 5562 | ||
| 5563 | // Return false to allow normal processing in the caller | |
| 5564 | return false; | |
| 5565 | }, | |
| 5566 | trigger: function( data ) { | |
| 5567 | ||
| 5568 | // For mutual compressibility with _default, replace `this` access with a local var. | |
| 5569 | // `|| data` is dead code meant only to preserve the variable through minification. | |
| 5570 | var el = this || data; | |
| 5571 | ||
| 5572 | // Force setup before triggering a click | |
| 5573 | if ( rcheckableType.test( el.type ) && | |
| 5574 | el.click && nodeName( el, "input" ) ) { | |
| 5575 | ||
| 5576 | leverageNative( el, "click" ); | |
| 5577 | } | |
| 5578 | ||
| 5579 | // Return non-false to allow normal event-path propagation | |
| 5580 | return true; | |
| 5581 | }, | |
| 5582 | ||
| 5583 | // For cross-browser consistency, suppress native .click() on links | |
| 5584 | // Also prevent it if we're currently inside a leveraged native-event stack | |
| 5585 | _default: function( event ) { | |
| 5586 | var target = event.target; | |
| 5587 | return rcheckableType.test( target.type ) && | |
| 5588 | target.click && nodeName( target, "input" ) && | |
| 5589 | dataPriv.get( target, "click" ) || | |
| 5590 | nodeName( target, "a" ); | |
| 5591 | } | |
| 5592 | }, | |
| 5593 | ||
| 5594 | beforeunload: { | |
| 5595 | postDispatch: function( event ) { | |
| 5596 | ||
| 5597 | // Support: Firefox 20+ | |
| 5598 | // Firefox doesn't alert if the returnValue field is not set. | |
| 5599 | if ( event.result !== undefined && event.originalEvent ) { | |
| 5600 | event.originalEvent.returnValue = event.result; | |
| 5601 | } | |
| 5602 | } | |
| 5603 | } | |
| 5604 | } | |
| 5605 | }; | |
| 5606 | ||
| 5607 | // Ensure the presence of an event listener that handles manually-triggered | |
| 5608 | // synthetic events by interrupting progress until reinvoked in response to | |
| 5609 | // *native* events that it fires directly, ensuring that state changes have | |
| 5610 | // already occurred before other listeners are invoked. | |
| 5611 | function leverageNative( el, type, expectSync ) { | |
| 5612 | ||
| 5613 | // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add | |
| 5614 | if ( !expectSync ) { | |
| 5615 | if ( dataPriv.get( el, type ) === undefined ) { | |
| 5616 | jQuery.event.add( el, type, returnTrue ); | |
| 5617 | } | |
| 5618 | return; | |
| 5619 | } | |
| 5620 | ||
| 5621 | // Register the controller as a special universal handler for all event namespaces | |
| 5622 | dataPriv.set( el, type, false ); | |
| 5623 | jQuery.event.add( el, type, { | |
| 5624 | namespace: false, | |
| 5625 | handler: function( event ) { | |
| 5626 | var notAsync, result, | |
| 5627 | saved = dataPriv.get( this, type ); | |
| 5628 | ||
| 5629 | if ( ( event.isTrigger & 1 ) && this[ type ] ) { | |
| 5630 | ||
| 5631 | // Interrupt processing of the outer synthetic .trigger()ed event | |
| 5632 | // Saved data should be false in such cases, but might be a leftover capture object | |
| 5633 | // from an async native handler (gh-4350) | |
| 5634 | if ( !saved.length ) { | |
| 5635 | ||
| 5636 | // Store arguments for use when handling the inner native event | |
| 5637 | // There will always be at least one argument (an event object), so this array | |
| 5638 | // will not be confused with a leftover capture object. | |
| 5639 | saved = slice.call( arguments ); | |
| 5640 | dataPriv.set( this, type, saved ); | |
| 5641 | ||
| 5642 | // Trigger the native event and capture its result | |
| 5643 | // Support: IE <=9 - 11+ | |
| 5644 | // focus() and blur() are asynchronous | |
| 5645 | notAsync = expectSync( this, type ); | |
| 5646 | this[ type ](); | |
| 5647 | result = dataPriv.get( this, type ); | |
| 5648 | if ( saved !== result || notAsync ) { | |
| 5649 | dataPriv.set( this, type, false ); | |
| 5650 | } else { | |
| 5651 | result = {}; | |
| 5652 | } | |
| 5653 | if ( saved !== result ) { | |
| 5654 | ||
| 5655 | // Cancel the outer synthetic event | |
| 5656 | event.stopImmediatePropagation(); | |
| 5657 | event.preventDefault(); | |
| 5658 | return result.value; | |
| 5659 | } | |
| 5660 | ||
| 5661 | // If this is an inner synthetic event for an event with a bubbling surrogate | |
| 5662 | // (focus or blur), assume that the surrogate already propagated from triggering the | |
| 5663 | // native event and prevent that from happening again here. | |
| 5664 | // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the | |
| 5665 | // bubbling surrogate propagates *after* the non-bubbling base), but that seems | |
| 5666 | // less bad than duplication. | |
| 5667 | } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { | |
| 5668 | event.stopPropagation(); | |
| 5669 | } | |
| 5670 | ||
| 5671 | // If this is a native event triggered above, everything is now in order | |
| 5672 | // Fire an inner synthetic event with the original arguments | |
| 5673 | } else if ( saved.length ) { | |
| 5674 | ||
| 5675 | // ...and capture the result | |
| 5676 | dataPriv.set( this, type, { | |
| 5677 | value: jQuery.event.trigger( | |
| 5678 | ||
| 5679 | // Support: IE <=9 - 11+ | |
| 5680 | // Extend with the prototype to reset the above stopImmediatePropagation() | |
| 5681 | jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), | |
| 5682 | saved.slice( 1 ), | |
| 5683 | this | |
| 5684 | ) | |
| 5685 | } ); | |
| 5686 | ||
| 5687 | // Abort handling of the native event | |
| 5688 | event.stopImmediatePropagation(); | |
| 5689 | } | |
| 5690 | } | |
| 5691 | } ); | |
| 5692 | } | |
| 5693 | ||
| 5694 | jQuery.removeEvent = function( elem, type, handle ) { | |
| 5695 | ||
| 5696 | // This "if" is needed for plain objects | |
| 5697 | if ( elem.removeEventListener ) { | |
| 5698 | elem.removeEventListener( type, handle ); | |
| 5699 | } | |
| 5700 | }; | |
| 5701 | ||
| 5702 | jQuery.Event = function( src, props ) { | |
| 5703 | ||
| 5704 | // Allow instantiation without the 'new' keyword | |
| 5705 | if ( !( this instanceof jQuery.Event ) ) { | |
| 5706 | return new jQuery.Event( src, props ); | |
| 5707 | } | |
| 5708 | ||
| 5709 | // Event object | |
| 5710 | if ( src && src.type ) { | |
| 5711 | this.originalEvent = src; | |
| 5712 | this.type = src.type; | |
| 5713 | ||
| 5714 | // Events bubbling up the document may have been marked as prevented | |
| 5715 | // by a handler lower down the tree; reflect the correct value. | |
| 5716 | this.isDefaultPrevented = src.defaultPrevented || | |
| 5717 | src.defaultPrevented === undefined && | |
| 5718 | ||
| 5719 | // Support: Android <=2.3 only | |
| 5720 | src.returnValue === false ? | |
| 5721 | returnTrue : | |
| 5722 | returnFalse; | |
| 5723 | ||
| 5724 | // Create target properties | |
| 5725 | // Support: Safari <=6 - 7 only | |
| 5726 | // Target should not be a text node (#504, #13143) | |
| 5727 | this.target = ( src.target && src.target.nodeType === 3 ) ? | |
| 5728 | src.target.parentNode : | |
| 5729 | src.target; | |
| 5730 | ||
| 5731 | this.currentTarget = src.currentTarget; | |
| 5732 | this.relatedTarget = src.relatedTarget; | |
| 5733 | ||
| 5734 | // Event type | |
| 5735 | } else { | |
| 5736 | this.type = src; | |
| 5737 | } | |
| 5738 | ||
| 5739 | // Put explicitly provided properties onto the event object | |
| 5740 | if ( props ) { | |
| 5741 | jQuery.extend( this, props ); | |
| 5742 | } | |
| 5743 | ||
| 5744 | // Create a timestamp if incoming event doesn't have one | |
| 5745 | this.timeStamp = src && src.timeStamp || Date.now(); | |
| 5746 | ||
| 5747 | // Mark it as fixed | |
| 5748 | this[ jQuery.expando ] = true; | |
| 5749 | }; | |
| 5750 | ||
| 5751 | // jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding | |
| 5752 | // https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html | |
| 5753 | jQuery.Event.prototype = { | |
| 5754 | constructor: jQuery.Event, | |
| 5755 | isDefaultPrevented: returnFalse, | |
| 5756 | isPropagationStopped: returnFalse, | |
| 5757 | isImmediatePropagationStopped: returnFalse, | |
| 5758 | isSimulated: false, | |
| 5759 | ||
| 5760 | preventDefault: function() { | |
| 5761 | var e = this.originalEvent; | |
| 5762 | ||
| 5763 | this.isDefaultPrevented = returnTrue; | |
| 5764 | ||
| 5765 | if ( e && !this.isSimulated ) { | |
| 5766 | e.preventDefault(); | |
| 5767 | } | |
| 5768 | }, | |
| 5769 | stopPropagation: function() { | |
| 5770 | var e = this.originalEvent; | |
| 5771 | ||
| 5772 | this.isPropagationStopped = returnTrue; | |
| 5773 | ||
| 5774 | if ( e && !this.isSimulated ) { | |
| 5775 | e.stopPropagation(); | |
| 5776 | } | |
| 5777 | }, | |
| 5778 | stopImmediatePropagation: function() { | |
| 5779 | var e = this.originalEvent; | |
| 5780 | ||
| 5781 | this.isImmediatePropagationStopped = returnTrue; | |
| 5782 | ||
| 5783 | if ( e && !this.isSimulated ) { | |
| 5784 | e.stopImmediatePropagation(); | |
| 5785 | } | |
| 5786 | ||
| 5787 | this.stopPropagation(); | |
| 5788 | } | |
| 5789 | }; | |
| 5790 | ||
| 5791 | // Includes all common event props including KeyEvent and MouseEvent specific props | |
| 5792 | jQuery.each( { | |
| 5793 | altKey: true, | |
| 5794 | bubbles: true, | |
| 5795 | cancelable: true, | |
| 5796 | changedTouches: true, | |
| 5797 | ctrlKey: true, | |
| 5798 | detail: true, | |
| 5799 | eventPhase: true, | |
| 5800 | metaKey: true, | |
| 5801 | pageX: true, | |
| 5802 | pageY: true, | |
| 5803 | shiftKey: true, | |
| 5804 | view: true, | |
| 5805 | "char": true, | |
| 5806 | code: true, | |
| 5807 | charCode: true, | |
| 5808 | key: true, | |
| 5809 | keyCode: true, | |
| 5810 | button: true, | |
| 5811 | buttons: true, | |
| 5812 | clientX: true, | |
| 5813 | clientY: true, | |
| 5814 | offsetX: true, | |
| 5815 | offsetY: true, | |
| 5816 | pointerId: true, | |
| 5817 | pointerType: true, | |
| 5818 | screenX: true, | |
| 5819 | screenY: true, | |
| 5820 | targetTouches: true, | |
| 5821 | toElement: true, | |
| 5822 | touches: true, | |
| 5823 | ||
| 5824 | which: function( event ) { | |
| 5825 | var button = event.button; | |
| 5826 | ||
| 5827 | // Add which for key events | |
| 5828 | if ( event.which == null && rkeyEvent.test( event.type ) ) { | |
| 5829 | return event.charCode != null ? event.charCode : event.keyCode; | |
| 5830 | } | |
| 5831 | ||
| 5832 | // Add which for click: 1 === left; 2 === middle; 3 === right | |
| 5833 | if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { | |
| 5834 | if ( button & 1 ) { | |
| 5835 | return 1; | |
| 5836 | } | |
| 5837 | ||
| 5838 | if ( button & 2 ) { | |
| 5839 | return 3; | |
| 5840 | } | |
| 5841 | ||
| 5842 | if ( button & 4 ) { | |
| 5843 | return 2; | |
| 5844 | } | |
| 5845 | ||
| 5846 | return 0; | |
| 5847 | } | |
| 5848 | ||
| 5849 | return event.which; | |
| 5850 | } | |
| 5851 | }, jQuery.event.addProp ); | |
| 5852 | ||
| 5853 | jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { | |
| 5854 | jQuery.event.special[ type ] = { | |
| 5855 | ||
| 5856 | // Utilize native event if possible so blur/focus sequence is correct | |
| 5857 | setup: function() { | |
| 5858 | ||
| 5859 | // Claim the first handler | |
| 5860 | // dataPriv.set( this, "focus", ... ) | |
| 5861 | // dataPriv.set( this, "blur", ... ) | |
| 5862 | leverageNative( this, type, expectSync ); | |
| 5863 | ||
| 5864 | // Return false to allow normal processing in the caller | |
| 5865 | return false; | |
| 5866 | }, | |
| 5867 | trigger: function() { | |
| 5868 | ||
| 5869 | // Force setup before trigger | |
| 5870 | leverageNative( this, type ); | |
| 5871 | ||
| 5872 | // Return non-false to allow normal event-path propagation | |
| 5873 | return true; | |
| 5874 | }, | |
| 5875 | ||
| 5876 | delegateType: delegateType | |
| 5877 | }; | |
| 5878 | } ); | |
| 5879 | ||
| 5880 | // Create mouseenter/leave events using mouseover/out and event-time checks | |
| 5881 | // so that event delegation works in jQuery. | |
| 5882 | // Do the same for pointerenter/pointerleave and pointerover/pointerout | |
| 5883 | // | |
| 5884 | // Support: Safari 7 only | |
| 5885 | // Safari sends mouseenter too often; see: | |
| 5886 | // https://bugs.chromium.org/p/chromium/issues/detail?id=470258 | |
| 5887 | // for the description of the bug (it existed in older Chrome versions as well). | |
| 5888 | jQuery.each( { | |
| 5889 | mouseenter: "mouseover", | |
| 5890 | mouseleave: "mouseout", | |
| 5891 | pointerenter: "pointerover", | |
| 5892 | pointerleave: "pointerout" | |
| 5893 | }, function( orig, fix ) { | |
| 5894 | jQuery.event.special[ orig ] = { | |
| 5895 | delegateType: fix, | |
| 5896 | bindType: fix, | |
| 5897 | ||
| 5898 | handle: function( event ) { | |
| 5899 | var ret, | |
| 5900 | target = this, | |
| 5901 | related = event.relatedTarget, | |
| 5902 | handleObj = event.handleObj; | |
| 5903 | ||
| 5904 | // For mouseenter/leave call the handler if related is outside the target. | |
| 5905 | // NB: No relatedTarget if the mouse left/entered the browser window | |
| 5906 | if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { | |
| 5907 | event.type = handleObj.origType; | |
| 5908 | ret = handleObj.handler.apply( this, arguments ); | |
| 5909 | event.type = fix; | |
| 5910 | } | |
| 5911 | return ret; | |
| 5912 | } | |
| 5913 | }; | |
| 5914 | } ); | |
| 5915 | ||
| 5916 | jQuery.fn.extend( { | |
| 5917 | ||
| 5918 | on: function( types, selector, data, fn ) { | |
| 5919 | return on( this, types, selector, data, fn ); | |
| 5920 | }, | |
| 5921 | one: function( types, selector, data, fn ) { | |
| 5922 | return on( this, types, selector, data, fn, 1 ); | |
| 5923 | }, | |
| 5924 | off: function( types, selector, fn ) { | |
| 5925 | var handleObj, type; | |
| 5926 | if ( types && types.preventDefault && types.handleObj ) { | |
| 5927 | ||
| 5928 | // ( event ) dispatched jQuery.Event | |
| 5929 | handleObj = types.handleObj; | |
| 5930 | jQuery( types.delegateTarget ).off( | |
| 5931 | handleObj.namespace ? | |
| 5932 | handleObj.origType + "." + handleObj.namespace : | |
| 5933 | handleObj.origType, | |
| 5934 | handleObj.selector, | |
| 5935 | handleObj.handler | |
| 5936 | ); | |
| 5937 | return this; | |
| 5938 | } | |
| 5939 | if ( typeof types === "object" ) { | |
| 5940 | ||
| 5941 | // ( types-object [, selector] ) | |
| 5942 | for ( type in types ) { | |
| 5943 | this.off( type, selector, types[ type ] ); | |
| 5944 | } | |
| 5945 | return this; | |
| 5946 | } | |
| 5947 | if ( selector === false || typeof selector === "function" ) { | |
| 5948 | ||
| 5949 | // ( types [, fn] ) | |
| 5950 | fn = selector; | |
| 5951 | selector = undefined; | |
| 5952 | } | |
| 5953 | if ( fn === false ) { | |
| 5954 | fn = returnFalse; | |
| 5955 | } | |
| 5956 | return this.each( function() { | |
| 5957 | jQuery.event.remove( this, types, fn, selector ); | |
| 5958 | } ); | |
| 5959 | } | |
| 5960 | } ); | |
| 5961 | ||
| 5962 | ||
| 5963 | var | |
| 5964 | ||
| 5965 | // Support: IE <=10 - 11, Edge 12 - 13 only | |
| 5966 | // In IE/Edge using regex groups here causes severe slowdowns. | |
| 5967 | // See https://connect.microsoft.com/IE/feedback/details/1736512/ | |
| 5968 | rnoInnerhtml = /<script|<style|<link/i, | |
| 5969 | ||
| 5970 | // checked="checked" or checked | |
| 5971 | rchecked = /checked\s*(?:[^=]|=\s*.checked.)/i, | |
| 5972 | rcleanScript = /^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g; | |
| 5973 | ||
| 5974 | // Prefer a tbody over its parent table for containing new rows | |
| 5975 | function manipulationTarget( elem, content ) { | |
| 5976 | if ( nodeName( elem, "table" ) && | |
| 5977 | nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { | |
| 5978 | ||
| 5979 | return jQuery( elem ).children( "tbody" )[ 0 ] || elem; | |
| 5980 | } | |
| 5981 | ||
| 5982 | return elem; | |
| 5983 | } | |
| 5984 | ||
| 5985 | // Replace/restore the type attribute of script elements for safe DOM manipulation | |
| 5986 | function disableScript( elem ) { | |
| 5987 | elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; | |
| 5988 | return elem; | |
| 5989 | } | |
| 5990 | function restoreScript( elem ) { | |
| 5991 | if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { | |
| 5992 | elem.type = elem.type.slice( 5 ); | |
| 5993 | } else { | |
| 5994 | elem.removeAttribute( "type" ); | |
| 5995 | } | |
| 5996 | ||
| 5997 | return elem; | |
| 5998 | } | |
| 5999 | ||
| 6000 | function cloneCopyEvent( src, dest ) { | |
| 6001 | var i, l, type, pdataOld, udataOld, udataCur, events; | |
| 6002 | ||
| 6003 | if ( dest.nodeType !== 1 ) { | |
| 6004 | return; | |
| 6005 | } | |
| 6006 | ||
| 6007 | // 1. Copy private data: events, handlers, etc. | |
| 6008 | if ( dataPriv.hasData( src ) ) { | |
| 6009 | pdataOld = dataPriv.get( src ); | |
| 6010 | events = pdataOld.events; | |
| 6011 | ||
| 6012 | if ( events ) { | |
| 6013 | dataPriv.remove( dest, "handle events" ); | |
| 6014 | ||
| 6015 | for ( type in events ) { | |
| 6016 | for ( i = 0, l = events[ type ].length; i < l; i++ ) { | |
| 6017 | jQuery.event.add( dest, type, events[ type ][ i ] ); | |
| 6018 | } | |
| 6019 | } | |
| 6020 | } | |
| 6021 | } | |
| 6022 | ||
| 6023 | // 2. Copy user data | |
| 6024 | if ( dataUser.hasData( src ) ) { | |
| 6025 | udataOld = dataUser.access( src ); | |
| 6026 | udataCur = jQuery.extend( {}, udataOld ); | |
| 6027 | ||
| 6028 | dataUser.set( dest, udataCur ); | |
| 6029 | } | |
| 6030 | } | |
| 6031 | ||
| 6032 | // Fix IE bugs, see support tests | |
| 6033 | function fixInput( src, dest ) { | |
| 6034 | var nodeName = dest.nodeName.toLowerCase(); | |
| 6035 | ||
| 6036 | // Fails to persist the checked state of a cloned checkbox or radio button. | |
| 6037 | if ( nodeName === "input" && rcheckableType.test( src.type ) ) { | |
| 6038 | dest.checked = src.checked; | |
| 6039 | ||
| 6040 | // Fails to return the selected option to the default selected state when cloning options | |
| 6041 | } else if ( nodeName === "input" || nodeName === "textarea" ) { | |
| 6042 | dest.defaultValue = src.defaultValue; | |
| 6043 | } | |
| 6044 | } | |
| 6045 | ||
| 6046 | function domManip( collection, args, callback, ignored ) { | |
| 6047 | ||
| 6048 | // Flatten any nested arrays | |
| 6049 | args = flat( args ); | |
| 6050 | ||
| 6051 | var fragment, first, scripts, hasScripts, node, doc, | |
| 6052 | i = 0, | |
| 6053 | l = collection.length, | |
| 6054 | iNoClone = l - 1, | |
| 6055 | value = args[ 0 ], | |
| 6056 | valueIsFunction = isFunction( value ); | |
| 6057 | ||
| 6058 | // We can't cloneNode fragments that contain checked, in WebKit | |
| 6059 | if ( valueIsFunction || | |
| 6060 | ( l > 1 && typeof value === "string" && | |
| 6061 | !support.checkClone && rchecked.test( value ) ) ) { | |
| 6062 | return collection.each( function( index ) { | |
| 6063 | var self = collection.eq( index ); | |
| 6064 | if ( valueIsFunction ) { | |
| 6065 | args[ 0 ] = value.call( this, index, self.html() ); | |
| 6066 | } | |
| 6067 | domManip( self, args, callback, ignored ); | |
| 6068 | } ); | |
| 6069 | } | |
| 6070 | ||
| 6071 | if ( l ) { | |
| 6072 | fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); | |
| 6073 | first = fragment.firstChild; | |
| 6074 | ||
| 6075 | if ( fragment.childNodes.length === 1 ) { | |
| 6076 | fragment = first; | |
| 6077 | } | |
| 6078 | ||
| 6079 | // Require either new content or an interest in ignored elements to invoke the callback | |
| 6080 | if ( first || ignored ) { | |
| 6081 | scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); | |
| 6082 | hasScripts = scripts.length; | |
| 6083 | ||
| 6084 | // Use the original fragment for the last item | |
| 6085 | // instead of the first because it can end up | |
| 6086 | // being emptied incorrectly in certain situations (#8070). | |
| 6087 | for ( ; i < l; i++ ) { | |
| 6088 | node = fragment; | |
| 6089 | ||
| 6090 | if ( i !== iNoClone ) { | |
| 6091 | node = jQuery.clone( node, true, true ); | |
| 6092 | ||
| 6093 | // Keep references to cloned scripts for later restoration | |
| 6094 | if ( hasScripts ) { | |
| 6095 | ||
| 6096 | // Support: Android <=4.0 only, PhantomJS 1 only | |
| 6097 | // push.apply(_, arraylike) throws on ancient WebKit | |
| 6098 | jQuery.merge( scripts, getAll( node, "script" ) ); | |
| 6099 | } | |
| 6100 | } | |
| 6101 | ||
| 6102 | callback.call( collection[ i ], node, i ); | |
| 6103 | } | |
| 6104 | ||
| 6105 | if ( hasScripts ) { | |
| 6106 | doc = scripts[ scripts.length - 1 ].ownerDocument; | |
| 6107 | ||
| 6108 | // Reenable scripts | |
| 6109 | jQuery.map( scripts, restoreScript ); | |
| 6110 | ||
| 6111 | // Evaluate executable scripts on first document insertion | |
| 6112 | for ( i = 0; i < hasScripts; i++ ) { | |
| 6113 | node = scripts[ i ]; | |
| 6114 | if ( rscriptType.test( node.type || "" ) && | |
| 6115 | !dataPriv.access( node, "globalEval" ) && | |
| 6116 | jQuery.contains( doc, node ) ) { | |
| 6117 | ||
| 6118 | if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { | |
| 6119 | ||
| 6120 | // Optional AJAX dependency, but won't run scripts if not present | |
| 6121 | if ( jQuery._evalUrl && !node.noModule ) { | |
| 6122 | jQuery._evalUrl( node.src, { | |
| 6123 | nonce: node.nonce || node.getAttribute( "nonce" ) | |
| 6124 | }, doc ); | |
| 6125 | } | |
| 6126 | } else { | |
| 6127 | DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); | |
| 6128 | } | |
| 6129 | } | |
| 6130 | } | |
| 6131 | } | |
| 6132 | } | |
| 6133 | } | |
| 6134 | ||
| 6135 | return collection; | |
| 6136 | } | |
| 6137 | ||
| 6138 | function remove( elem, selector, keepData ) { | |
| 6139 | var node, | |
| 6140 | nodes = selector ? jQuery.filter( selector, elem ) : elem, | |
| 6141 | i = 0; | |
| 6142 | ||
| 6143 | for ( ; ( node = nodes[ i ] ) != null; i++ ) { | |
| 6144 | if ( !keepData && node.nodeType === 1 ) { | |
| 6145 | jQuery.cleanData( getAll( node ) ); | |
| 6146 | } | |
| 6147 | ||
| 6148 | if ( node.parentNode ) { | |
| 6149 | if ( keepData && isAttached( node ) ) { | |
| 6150 | setGlobalEval( getAll( node, "script" ) ); | |
| 6151 | } | |
| 6152 | node.parentNode.removeChild( node ); | |
| 6153 | } | |
| 6154 | } | |
| 6155 | ||
| 6156 | return elem; | |
| 6157 | } | |
| 6158 | ||
| 6159 | jQuery.extend( { | |
| 6160 | htmlPrefilter: function( html ) { | |
| 6161 | return html; | |
| 6162 | }, | |
| 6163 | ||
| 6164 | clone: function( elem, dataAndEvents, deepDataAndEvents ) { | |
| 6165 | var i, l, srcElements, destElements, | |
| 6166 | clone = elem.cloneNode( true ), | |
| 6167 | inPage = isAttached( elem ); | |
| 6168 | ||
| 6169 | // Fix IE cloning issues | |
| 6170 | if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && | |
| 6171 | !jQuery.isXMLDoc( elem ) ) { | |
| 6172 | ||
| 6173 | // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 | |
| 6174 | destElements = getAll( clone ); | |
| 6175 | srcElements = getAll( elem ); | |
| 6176 | ||
| 6177 | for ( i = 0, l = srcElements.length; i < l; i++ ) { | |
| 6178 | fixInput( srcElements[ i ], destElements[ i ] ); | |
| 6179 | } | |
| 6180 | } | |
| 6181 | ||
| 6182 | // Copy the events from the original to the clone | |
| 6183 | if ( dataAndEvents ) { | |
| 6184 | if ( deepDataAndEvents ) { | |
| 6185 | srcElements = srcElements || getAll( elem ); | |
| 6186 | destElements = destElements || getAll( clone ); | |
| 6187 | ||
| 6188 | for ( i = 0, l = srcElements.length; i < l; i++ ) { | |
| 6189 | cloneCopyEvent( srcElements[ i ], destElements[ i ] ); | |
| 6190 | } | |
| 6191 | } else { | |
| 6192 | cloneCopyEvent( elem, clone ); | |
| 6193 | } | |
| 6194 | } | |
| 6195 | ||
| 6196 | // Preserve script evaluation history | |
| 6197 | destElements = getAll( clone, "script" ); | |
| 6198 | if ( destElements.length > 0 ) { | |
| 6199 | setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); | |
| 6200 | } | |
| 6201 | ||
| 6202 | // Return the cloned set | |
| 6203 | return clone; | |
| 6204 | }, | |
| 6205 | ||
| 6206 | cleanData: function( elems ) { | |
| 6207 | var data, elem, type, | |
| 6208 | special = jQuery.event.special, | |
| 6209 | i = 0; | |
| 6210 | ||
| 6211 | for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { | |
| 6212 | if ( acceptData( elem ) ) { | |
| 6213 | if ( ( data = elem[ dataPriv.expando ] ) ) { | |
| 6214 | if ( data.events ) { | |
| 6215 | for ( type in data.events ) { | |
| 6216 | if ( special[ type ] ) { | |
| 6217 | jQuery.event.remove( elem, type ); | |
| 6218 | ||
| 6219 | // This is a shortcut to avoid jQuery.event.remove's overhead | |
| 6220 | } else { | |
| 6221 | jQuery.removeEvent( elem, type, data.handle ); | |
| 6222 | } | |
| 6223 | } | |
| 6224 | } | |
| 6225 | ||
| 6226 | // Support: Chrome <=35 - 45+ | |
| 6227 | // Assign undefined instead of using delete, see Data#remove | |
| 6228 | elem[ dataPriv.expando ] = undefined; | |
| 6229 | } | |
| 6230 | if ( elem[ dataUser.expando ] ) { | |
| 6231 | ||
| 6232 | // Support: Chrome <=35 - 45+ | |
| 6233 | // Assign undefined instead of using delete, see Data#remove | |
| 6234 | elem[ dataUser.expando ] = undefined; | |
| 6235 | } | |
| 6236 | } | |
| 6237 | } | |
| 6238 | } | |
| 6239 | } ); | |
| 6240 | ||
| 6241 | jQuery.fn.extend( { | |
| 6242 | detach: function( selector ) { | |
| 6243 | return remove( this, selector, true ); | |
| 6244 | }, | |
| 6245 | ||
| 6246 | remove: function( selector ) { | |
| 6247 | return remove( this, selector ); | |
| 6248 | }, | |
| 6249 | ||
| 6250 | text: function( value ) { | |
| 6251 | return access( this, function( value ) { | |
| 6252 | return value === undefined ? | |
| 6253 | jQuery.text( this ) : | |
| 6254 | this.empty().each( function() { | |
| 6255 | if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { | |
| 6256 | this.textContent = value; | |
| 6257 | } | |
| 6258 | } ); | |
| 6259 | }, null, value, arguments.length ); | |
| 6260 | }, | |
| 6261 | ||
| 6262 | append: function() { | |
| 6263 | return domManip( this, arguments, function( elem ) { | |
| 6264 | if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { | |
| 6265 | var target = manipulationTarget( this, elem ); | |
| 6266 | target.appendChild( elem ); | |
| 6267 | } | |
| 6268 | } ); | |
| 6269 | }, | |
| 6270 | ||
| 6271 | prepend: function() { | |
| 6272 | return domManip( this, arguments, function( elem ) { | |
| 6273 | if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { | |
| 6274 | var target = manipulationTarget( this, elem ); | |
| 6275 | target.insertBefore( elem, target.firstChild ); | |
| 6276 | } | |
| 6277 | } ); | |
| 6278 | }, | |
| 6279 | ||
| 6280 | before: function() { | |
| 6281 | return domManip( this, arguments, function( elem ) { | |
| 6282 | if ( this.parentNode ) { | |
| 6283 | this.parentNode.insertBefore( elem, this ); | |
| 6284 | } | |
| 6285 | } ); | |
| 6286 | }, | |
| 6287 | ||
| 6288 | after: function() { | |
| 6289 | return domManip( this, arguments, function( elem ) { | |
| 6290 | if ( this.parentNode ) { | |
| 6291 | this.parentNode.insertBefore( elem, this.nextSibling ); | |
| 6292 | } | |
| 6293 | } ); | |
| 6294 | }, | |
| 6295 | ||
| 6296 | empty: function() { | |
| 6297 | var elem, | |
| 6298 | i = 0; | |
| 6299 | ||
| 6300 | for ( ; ( elem = this[ i ] ) != null; i++ ) { | |
| 6301 | if ( elem.nodeType === 1 ) { | |
| 6302 | ||
| 6303 | // Prevent memory leaks | |
| 6304 | jQuery.cleanData( getAll( elem, false ) ); | |
| 6305 | ||
| 6306 | // Remove any remaining nodes | |
| 6307 | elem.textContent = ""; | |
| 6308 | } | |
| 6309 | } | |
| 6310 | ||
| 6311 | return this; | |
| 6312 | }, | |
| 6313 | ||
| 6314 | clone: function( dataAndEvents, deepDataAndEvents ) { | |
| 6315 | dataAndEvents = dataAndEvents == null ? false : dataAndEvents; | |
| 6316 | deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; | |
| 6317 | ||
| 6318 | return this.map( function() { | |
| 6319 | return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); | |
| 6320 | } ); | |
| 6321 | }, | |
| 6322 | ||
| 6323 | html: function( value ) { | |
| 6324 | return access( this, function( value ) { | |
| 6325 | var elem = this[ 0 ] || {}, | |
| 6326 | i = 0, | |
| 6327 | l = this.length; | |
| 6328 | ||
| 6329 | if ( value === undefined && elem.nodeType === 1 ) { | |
| 6330 | return elem.innerHTML; | |
| 6331 | } | |
| 6332 | ||
| 6333 | // See if we can take a shortcut and just use innerHTML | |
| 6334 | if ( typeof value === "string" && !rnoInnerhtml.test( value ) && | |
| 6335 | !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { | |
| 6336 | ||
| 6337 | value = jQuery.htmlPrefilter( value ); | |
| 6338 | ||
| 6339 | try { | |
| 6340 | for ( ; i < l; i++ ) { | |
| 6341 | elem = this[ i ] || {}; | |
| 6342 | ||
| 6343 | // Remove element nodes and prevent memory leaks | |
| 6344 | if ( elem.nodeType === 1 ) { | |
| 6345 | jQuery.cleanData( getAll( elem, false ) ); | |
| 6346 | elem.innerHTML = value; | |
| 6347 | } | |
| 6348 | } | |
| 6349 | ||
| 6350 | elem = 0; | |
| 6351 | ||
| 6352 | // If using innerHTML throws an exception, use the fallback method | |
| 6353 | } catch ( e ) {} | |
| 6354 | } | |
| 6355 | ||
| 6356 | if ( elem ) { | |
| 6357 | this.empty().append( value ); | |
| 6358 | } | |
| 6359 | }, null, value, arguments.length ); | |
| 6360 | }, | |
| 6361 | ||
| 6362 | replaceWith: function() { | |
| 6363 | var ignored = []; | |
| 6364 | ||
| 6365 | // Make the changes, replacing each non-ignored context element with the new content | |
| 6366 | return domManip( this, arguments, function( elem ) { | |
| 6367 | var parent = this.parentNode; | |
| 6368 | ||
| 6369 | if ( jQuery.inArray( this, ignored ) < 0 ) { | |
| 6370 | jQuery.cleanData( getAll( this ) ); | |
| 6371 | if ( parent ) { | |
| 6372 | parent.replaceChild( elem, this ); | |
| 6373 | } | |
| 6374 | } | |
| 6375 | ||
| 6376 | // Force callback invocation | |
| 6377 | }, ignored ); | |
| 6378 | } | |
| 6379 | } ); | |
| 6380 | ||
| 6381 | jQuery.each( { | |
| 6382 | appendTo: "append", | |
| 6383 | prependTo: "prepend", | |
| 6384 | insertBefore: "before", | |
| 6385 | insertAfter: "after", | |
| 6386 | replaceAll: "replaceWith" | |
| 6387 | }, function( name, original ) { | |
| 6388 | jQuery.fn[ name ] = function( selector ) { | |
| 6389 | var elems, | |
| 6390 | ret = [], | |
| 6391 | insert = jQuery( selector ), | |
| 6392 | last = insert.length - 1, | |
| 6393 | i = 0; | |
| 6394 | ||
| 6395 | for ( ; i <= last; i++ ) { | |
| 6396 | elems = i === last ? this : this.clone( true ); | |
| 6397 | jQuery( insert[ i ] )[ original ]( elems ); | |
| 6398 | ||
| 6399 | // Support: Android <=4.0 only, PhantomJS 1 only | |
| 6400 | // .get() because push.apply(_, arraylike) throws on ancient WebKit | |
| 6401 | push.apply( ret, elems.get() ); | |
| 6402 | } | |
| 6403 | ||
| 6404 | return this.pushStack( ret ); | |
| 6405 | }; | |
| 6406 | } ); | |
| 6407 | var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); | |
| 6408 | ||
| 6409 | var getStyles = function( elem ) { | |
| 6410 | ||
| 6411 | // Support: IE <=11 only, Firefox <=30 (#15098, #14150) | |
| 6412 | // IE throws on elements created in popups | |
| 6413 | // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" | |
| 6414 | var view = elem.ownerDocument.defaultView; | |
| 6415 | ||
| 6416 | if ( !view || !view.opener ) { | |
| 6417 | view = window; | |
| 6418 | } | |
| 6419 | ||
| 6420 | return view.getComputedStyle( elem ); | |
| 6421 | }; | |
| 6422 | ||
| 6423 | var swap = function( elem, options, callback ) { | |
| 6424 | var ret, name, | |
| 6425 | old = {}; | |
| 6426 | ||
| 6427 | // Remember the old values, and insert the new ones | |
| 6428 | for ( name in options ) { | |
| 6429 | old[ name ] = elem.style[ name ]; | |
| 6430 | elem.style[ name ] = options[ name ]; | |
| 6431 | } | |
| 6432 | ||
| 6433 | ret = callback.call( elem ); | |
| 6434 | ||
| 6435 | // Revert the old values | |
| 6436 | for ( name in options ) { | |
| 6437 | elem.style[ name ] = old[ name ]; | |
| 6438 | } | |
| 6439 | ||
| 6440 | return ret; | |
| 6441 | }; | |
| 6442 | ||
| 6443 | ||
| 6444 | var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); | |
| 6445 | ||
| 6446 | ||
| 6447 | ||
| 6448 | ( function() { | |
| 6449 | ||
| 6450 | // Executing both pixelPosition & boxSizingReliable tests require only one layout | |
| 6451 | // so they're executed at the same time to save the second computation. | |
| 6452 | function computeStyleTests() { | |
| 6453 | ||
| 6454 | // This is a singleton, we need to execute it only once | |
| 6455 | if ( !div ) { | |
| 6456 | return; | |
| 6457 | } | |
| 6458 | ||
| 6459 | container.style.cssText = "position:absolute;left:-11111px;width:60px;" + | |
| 6460 | "margin-top:1px;padding:0;border:0"; | |
| 6461 | div.style.cssText = | |
| 6462 | "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + | |
| 6463 | "margin:auto;border:1px;padding:1px;" + | |
| 6464 | "width:60%;top:1%"; | |
| 6465 | documentElement.appendChild( container ).appendChild( div ); | |
| 6466 | ||
| 6467 | var divStyle = window.getComputedStyle( div ); | |
| 6468 | pixelPositionVal = divStyle.top !== "1%"; | |
| 6469 | ||
| 6470 | // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 | |
| 6471 | reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; | |
| 6472 | ||
| 6473 | // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 | |
| 6474 | // Some styles come back with percentage values, even though they shouldn't | |
| 6475 | div.style.right = "60%"; | |
| 6476 | pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; | |
| 6477 | ||
| 6478 | // Support: IE 9 - 11 only | |
| 6479 | // Detect misreporting of content dimensions for box-sizing:border-box elements | |
| 6480 | boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; | |
| 6481 | ||
| 6482 | // Support: IE 9 only | |
| 6483 | // Detect overflow:scroll screwiness (gh-3699) | |
| 6484 | // Support: Chrome <=64 | |
| 6485 | // Don't get tricked when zoom affects offsetWidth (gh-4029) | |
| 6486 | div.style.position = "absolute"; | |
| 6487 | scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; | |
| 6488 | ||
| 6489 | documentElement.removeChild( container ); | |
| 6490 | ||
| 6491 | // Nullify the div so it wouldn't be stored in the memory and | |
| 6492 | // it will also be a sign that checks already performed | |
| 6493 | div = null; | |
| 6494 | } | |
| 6495 | ||
| 6496 | function roundPixelMeasures( measure ) { | |
| 6497 | return Math.round( parseFloat( measure ) ); | |
| 6498 | } | |
| 6499 | ||
| 6500 | var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, | |
| 6501 | reliableTrDimensionsVal, reliableMarginLeftVal, | |
| 6502 | container = document.createElement( "div" ), | |
| 6503 | div = document.createElement( "div" ); | |
| 6504 | ||
| 6505 | // Finish early in limited (non-browser) environments | |
| 6506 | if ( !div.style ) { | |
| 6507 | return; | |
| 6508 | } | |
| 6509 | ||
| 6510 | // Support: IE <=9 - 11 only | |
| 6511 | // Style of cloned element affects source element cloned (#8908) | |
| 6512 | div.style.backgroundClip = "content-box"; | |
| 6513 | div.cloneNode( true ).style.backgroundClip = ""; | |
| 6514 | support.clearCloneStyle = div.style.backgroundClip === "content-box"; | |
| 6515 | ||
| 6516 | jQuery.extend( support, { | |
| 6517 | boxSizingReliable: function() { | |
| 6518 | computeStyleTests(); | |
| 6519 | return boxSizingReliableVal; | |
| 6520 | }, | |
| 6521 | pixelBoxStyles: function() { | |
| 6522 | computeStyleTests(); | |
| 6523 | return pixelBoxStylesVal; | |
| 6524 | }, | |
| 6525 | pixelPosition: function() { | |
| 6526 | computeStyleTests(); | |
| 6527 | return pixelPositionVal; | |
| 6528 | }, | |
| 6529 | reliableMarginLeft: function() { | |
| 6530 | computeStyleTests(); | |
| 6531 | return reliableMarginLeftVal; | |
| 6532 | }, | |
| 6533 | scrollboxSize: function() { | |
| 6534 | computeStyleTests(); | |
| 6535 | return scrollboxSizeVal; | |
| 6536 | }, | |
| 6537 | ||
| 6538 | // Support: IE 9 - 11+, Edge 15 - 18+ | |
| 6539 | // IE/Edge misreport `getComputedStyle` of table rows with width/height | |
| 6540 | // set in CSS while `offset*` properties report correct values. | |
| 6541 | // Behavior in IE 9 is more subtle than in newer versions & it passes | |
| 6542 | // some versions of this test; make sure not to make it pass there! | |
| 6543 | reliableTrDimensions: function() { | |
| 6544 | var table, tr, trChild, trStyle; | |
| 6545 | if ( reliableTrDimensionsVal == null ) { | |
| 6546 | table = document.createElement( "table" ); | |
| 6547 | tr = document.createElement( "tr" ); | |
| 6548 | trChild = document.createElement( "div" ); | |
| 6549 | ||
| 6550 | table.style.cssText = "position:absolute;left:-11111px"; | |
| 6551 | tr.style.height = "1px"; | |
| 6552 | trChild.style.height = "9px"; | |
| 6553 | ||
| 6554 | documentElement | |
| 6555 | .appendChild( table ) | |
| 6556 | .appendChild( tr ) | |
| 6557 | .appendChild( trChild ); | |
| 6558 | ||
| 6559 | trStyle = window.getComputedStyle( tr ); | |
| 6560 | reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; | |
| 6561 | ||
| 6562 | documentElement.removeChild( table ); | |
| 6563 | } | |
| 6564 | return reliableTrDimensionsVal; | |
| 6565 | } | |
| 6566 | } ); | |
| 6567 | } )(); | |
| 6568 | ||
| 6569 | ||
| 6570 | function curCSS( elem, name, computed ) { | |
| 6571 | var width, minWidth, maxWidth, ret, | |
| 6572 | ||
| 6573 | // Support: Firefox 51+ | |
| 6574 | // Retrieving style before computed somehow | |
| 6575 | // fixes an issue with getting wrong values | |
| 6576 | // on detached elements | |
| 6577 | style = elem.style; | |
| 6578 | ||
| 6579 | computed = computed || getStyles( elem ); | |
| 6580 | ||
| 6581 | // getPropertyValue is needed for: | |
| 6582 | // .css('filter') (IE 9 only, #12537) | |
| 6583 | // .css('--customProperty) (#3144) | |
| 6584 | if ( computed ) { | |
| 6585 | ret = computed.getPropertyValue( name ) || computed[ name ]; | |
| 6586 | ||
| 6587 | if ( ret === "" && !isAttached( elem ) ) { | |
| 6588 | ret = jQuery.style( elem, name ); | |
| 6589 | } | |
| 6590 | ||
| 6591 | // A tribute to the "awesome hack by Dean Edwards" | |
| 6592 | // Android Browser returns percentage for some values, | |
| 6593 | // but width seems to be reliably pixels. | |
| 6594 | // This is against the CSSOM draft spec: | |
| 6595 | // https://drafts.csswg.org/cssom/#resolved-values | |
| 6596 | if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { | |
| 6597 | ||
| 6598 | // Remember the original values | |
| 6599 | width = style.width; | |
| 6600 | minWidth = style.minWidth; | |
| 6601 | maxWidth = style.maxWidth; | |
| 6602 | ||
| 6603 | // Put in the new values to get a computed value out | |
| 6604 | style.minWidth = style.maxWidth = style.width = ret; | |
| 6605 | ret = computed.width; | |
| 6606 | ||
| 6607 | // Revert the changed values | |
| 6608 | style.width = width; | |
| 6609 | style.minWidth = minWidth; | |
| 6610 | style.maxWidth = maxWidth; | |
| 6611 | } | |
| 6612 | } | |
| 6613 | ||
| 6614 | return ret !== undefined ? | |
| 6615 | ||
| 6616 | // Support: IE <=9 - 11 only | |
| 6617 | // IE returns zIndex value as an integer. | |
| 6618 | ret + "" : | |
| 6619 | ret; | |
| 6620 | } | |
| 6621 | ||
| 6622 | ||
| 6623 | function addGetHookIf( conditionFn, hookFn ) { | |
| 6624 | ||
| 6625 | // Define the hook, we'll check on the first run if it's really needed. | |
| 6626 | return { | |
| 6627 | get: function() { | |
| 6628 | if ( conditionFn() ) { | |
| 6629 | ||
| 6630 | // Hook not needed (or it's not possible to use it due | |
| 6631 | // to missing dependency), remove it. | |
| 6632 | delete this.get; | |
| 6633 | return; | |
| 6634 | } | |
| 6635 | ||
| 6636 | // Hook needed; redefine it so that the support test is not executed again. | |
| 6637 | return ( this.get = hookFn ).apply( this, arguments ); | |
| 6638 | } | |
| 6639 | }; | |
| 6640 | } | |
| 6641 | ||
| 6642 | ||
| 6643 | var cssPrefixes = [ "Webkit", "Moz", "ms" ], | |
| 6644 | emptyStyle = document.createElement( "div" ).style, | |
| 6645 | vendorProps = {}; | |
| 6646 | ||
| 6647 | // Return a vendor-prefixed property or undefined | |
| 6648 | function vendorPropName( name ) { | |
| 6649 | ||
| 6650 | // Check for vendor prefixed names | |
| 6651 | var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), | |
| 6652 | i = cssPrefixes.length; | |
| 6653 | ||
| 6654 | while ( i-- ) { | |
| 6655 | name = cssPrefixes[ i ] + capName; | |
| 6656 | if ( name in emptyStyle ) { | |
| 6657 | return name; | |
| 6658 | } | |
| 6659 | } | |
| 6660 | } | |
| 6661 | ||
| 6662 | // Return a potentially-mapped jQuery.cssProps or vendor prefixed property | |
| 6663 | function finalPropName( name ) { | |
| 6664 | var final = jQuery.cssProps[ name ] || vendorProps[ name ]; | |
| 6665 | ||
| 6666 | if ( final ) { | |
| 6667 | return final; | |
| 6668 | } | |
| 6669 | if ( name in emptyStyle ) { | |
| 6670 | return name; | |
| 6671 | } | |
| 6672 | return vendorProps[ name ] = vendorPropName( name ) || name; | |
| 6673 | } | |
| 6674 | ||
| 6675 | ||
| 6676 | var | |
| 6677 | ||
| 6678 | // Swappable if display is none or starts with table | |
| 6679 | // except "table", "table-cell", or "table-caption" | |
| 6680 | // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display | |
| 6681 | rdisplayswap = /^(none|table(?!-c[ea]).+)/, | |
| 6682 | rcustomProp = /^--/, | |
| 6683 | cssShow = { position: "absolute", visibility: "hidden", display: "block" }, | |
| 6684 | cssNormalTransform = { | |
| 6685 | letterSpacing: "0", | |
| 6686 | fontWeight: "400" | |
| 6687 | }; | |
| 6688 | ||
| 6689 | function setPositiveNumber( _elem, value, subtract ) { | |
| 6690 | ||
| 6691 | // Any relative (+/-) values have already been | |
| 6692 | // normalized at this point | |
| 6693 | var matches = rcssNum.exec( value ); | |
| 6694 | return matches ? | |
| 6695 | ||
| 6696 | // Guard against undefined "subtract", e.g., when used as in cssHooks | |
| 6697 | Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : | |
| 6698 | value; | |
| 6699 | } | |
| 6700 | ||
| 6701 | function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { | |
| 6702 | var i = dimension === "width" ? 1 : 0, | |
| 6703 | extra = 0, | |
| 6704 | delta = 0; | |
| 6705 | ||
| 6706 | // Adjustment may not be necessary | |
| 6707 | if ( box === ( isBorderBox ? "border" : "content" ) ) { | |
| 6708 | return 0; | |
| 6709 | } | |
| 6710 | ||
| 6711 | for ( ; i < 4; i += 2 ) { | |
| 6712 | ||
| 6713 | // Both box models exclude margin | |
| 6714 | if ( box === "margin" ) { | |
| 6715 | delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); | |
| 6716 | } | |
| 6717 | ||
| 6718 | // If we get here with a content-box, we're seeking "padding" or "border" or "margin" | |
| 6719 | if ( !isBorderBox ) { | |
| 6720 | ||
| 6721 | // Add padding | |
| 6722 | delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); | |
| 6723 | ||
| 6724 | // For "border" or "margin", add border | |
| 6725 | if ( box !== "padding" ) { | |
| 6726 | delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); | |
| 6727 | ||
| 6728 | // But still keep track of it otherwise | |
| 6729 | } else { | |
| 6730 | extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); | |
| 6731 | } | |
| 6732 | ||
| 6733 | // If we get here with a border-box (content + padding + border), we're seeking "content" or | |
| 6734 | // "padding" or "margin" | |
| 6735 | } else { | |
| 6736 | ||
| 6737 | // For "content", subtract padding | |
| 6738 | if ( box === "content" ) { | |
| 6739 | delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); | |
| 6740 | } | |
| 6741 | ||
| 6742 | // For "content" or "padding", subtract border | |
| 6743 | if ( box !== "margin" ) { | |
| 6744 | delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); | |
| 6745 | } | |
| 6746 | } | |
| 6747 | } | |
| 6748 | ||
| 6749 | // Account for positive content-box scroll gutter when requested by providing computedVal | |
| 6750 | if ( !isBorderBox && computedVal >= 0 ) { | |
| 6751 | ||
| 6752 | // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border | |
| 6753 | // Assuming integer scroll gutter, subtract the rest and round down | |
| 6754 | delta += Math.max( 0, Math.ceil( | |
| 6755 | elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - | |
| 6756 | computedVal - | |
| 6757 | delta - | |
| 6758 | extra - | |
| 6759 | 0.5 | |
| 6760 | ||
| 6761 | // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter | |
| 6762 | // Use an explicit zero to avoid NaN (gh-3964) | |
| 6763 | ) ) || 0; | |
| 6764 | } | |
| 6765 | ||
| 6766 | return delta; | |
| 6767 | } | |
| 6768 | ||
| 6769 | function getWidthOrHeight( elem, dimension, extra ) { | |
| 6770 | ||
| 6771 | // Start with computed style | |
| 6772 | var styles = getStyles( elem ), | |
| 6773 | ||
| 6774 | // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). | |
| 6775 | // Fake content-box until we know it's needed to know the true value. | |
| 6776 | boxSizingNeeded = !support.boxSizingReliable() || extra, | |
| 6777 | isBorderBox = boxSizingNeeded && | |
| 6778 | jQuery.css( elem, "boxSizing", false, styles ) === "border-box", | |
| 6779 | valueIsBorderBox = isBorderBox, | |
| 6780 | ||
| 6781 | val = curCSS( elem, dimension, styles ), | |
| 6782 | offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); | |
| 6783 | ||
| 6784 | // Support: Firefox <=54 | |
| 6785 | // Return a confounding non-pixel value or feign ignorance, as appropriate. | |
| 6786 | if ( rnumnonpx.test( val ) ) { | |
| 6787 | if ( !extra ) { | |
| 6788 | return val; | |
| 6789 | } | |
| 6790 | val = "auto"; | |
| 6791 | } | |
| 6792 | ||
| 6793 | ||
| 6794 | // Support: IE 9 - 11 only | |
| 6795 | // Use offsetWidth/offsetHeight for when box sizing is unreliable. | |
| 6796 | // In those cases, the computed value can be trusted to be border-box. | |
| 6797 | if ( ( !support.boxSizingReliable() && isBorderBox || | |
| 6798 | ||
| 6799 | // Support: IE 10 - 11+, Edge 15 - 18+ | |
| 6800 | // IE/Edge misreport `getComputedStyle` of table rows with width/height | |
| 6801 | // set in CSS while `offset*` properties report correct values. | |
| 6802 | // Interestingly, in some cases IE 9 doesn't suffer from this issue. | |
| 6803 | !support.reliableTrDimensions() && nodeName( elem, "tr" ) || | |
| 6804 | ||
| 6805 | // Fall back to offsetWidth/offsetHeight when value is "auto" | |
| 6806 | // This happens for inline elements with no explicit setting (gh-3571) | |
| 6807 | val === "auto" || | |
| 6808 | ||
| 6809 | // Support: Android <=4.1 - 4.3 only | |
| 6810 | // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) | |
| 6811 | !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && | |
| 6812 | ||
| 6813 | // Make sure the element is visible & connected | |
| 6814 | elem.getClientRects().length ) { | |
| 6815 | ||
| 6816 | isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; | |
| 6817 | ||
| 6818 | // Where available, offsetWidth/offsetHeight approximate border box dimensions. | |
| 6819 | // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the | |
| 6820 | // retrieved value as a content box dimension. | |
| 6821 | valueIsBorderBox = offsetProp in elem; | |
| 6822 | if ( valueIsBorderBox ) { | |
| 6823 | val = elem[ offsetProp ]; | |
| 6824 | } | |
| 6825 | } | |
| 6826 | ||
| 6827 | // Normalize "" and auto | |
| 6828 | val = parseFloat( val ) || 0; | |
| 6829 | ||
| 6830 | // Adjust for the element's box model | |
| 6831 | return ( val + | |
| 6832 | boxModelAdjustment( | |
| 6833 | elem, | |
| 6834 | dimension, | |
| 6835 | extra || ( isBorderBox ? "border" : "content" ), | |
| 6836 | valueIsBorderBox, | |
| 6837 | styles, | |
| 6838 | ||
| 6839 | // Provide the current computed size to request scroll gutter calculation (gh-3589) | |
| 6840 | val | |
| 6841 | ) | |
| 6842 | ) + "px"; | |
| 6843 | } | |
| 6844 | ||
| 6845 | jQuery.extend( { | |
| 6846 | ||
| 6847 | // Add in style property hooks for overriding the default | |
| 6848 | // behavior of getting and setting a style property | |
| 6849 | cssHooks: { | |
| 6850 | opacity: { | |
| 6851 | get: function( elem, computed ) { | |
| 6852 | if ( computed ) { | |
| 6853 | ||
| 6854 | // We should always get a number back from opacity | |
| 6855 | var ret = curCSS( elem, "opacity" ); | |
| 6856 | return ret === "" ? "1" : ret; | |
| 6857 | } | |
| 6858 | } | |
| 6859 | } | |
| 6860 | }, | |
| 6861 | ||
| 6862 | // Don't automatically add "px" to these possibly-unitless properties | |
| 6863 | cssNumber: { | |
| 6864 | "animationIterationCount": true, | |
| 6865 | "columnCount": true, | |
| 6866 | "fillOpacity": true, | |
| 6867 | "flexGrow": true, | |
| 6868 | "flexShrink": true, | |
| 6869 | "fontWeight": true, | |
| 6870 | "gridArea": true, | |
| 6871 | "gridColumn": true, | |
| 6872 | "gridColumnEnd": true, | |
| 6873 | "gridColumnStart": true, | |
| 6874 | "gridRow": true, | |
| 6875 | "gridRowEnd": true, | |
| 6876 | "gridRowStart": true, | |
| 6877 | "lineHeight": true, | |
| 6878 | "opacity": true, | |
| 6879 | "order": true, | |
| 6880 | "orphans": true, | |
| 6881 | "widows": true, | |
| 6882 | "zIndex": true, | |
| 6883 | "zoom": true | |
| 6884 | }, | |
| 6885 | ||
| 6886 | // Add in properties whose names you wish to fix before | |
| 6887 | // setting or getting the value | |
| 6888 | cssProps: {}, | |
| 6889 | ||
| 6890 | // Get and set the style property on a DOM Node | |
| 6891 | style: function( elem, name, value, extra ) { | |
| 6892 | ||
| 6893 | // Don't set styles on text and comment nodes | |
| 6894 | if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { | |
| 6895 | return; | |
| 6896 | } | |
| 6897 | ||
| 6898 | // Make sure that we're working with the right name | |
| 6899 | var ret, type, hooks, | |
| 6900 | origName = camelCase( name ), | |
| 6901 | isCustomProp = rcustomProp.test( name ), | |
| 6902 | style = elem.style; | |
| 6903 | ||
| 6904 | // Make sure that we're working with the right name. We don't | |
| 6905 | // want to query the value if it is a CSS custom property | |
| 6906 | // since they are user-defined. | |
| 6907 | if ( !isCustomProp ) { | |
| 6908 | name = finalPropName( origName ); | |
| 6909 | } | |
| 6910 | ||
| 6911 | // Gets hook for the prefixed version, then unprefixed version | |
| 6912 | hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; | |
| 6913 | ||
| 6914 | // Check if we're setting a value | |
| 6915 | if ( value !== undefined ) { | |
| 6916 | type = typeof value; | |
| 6917 | ||
| 6918 | // Convert "+=" or "-=" to relative numbers (#7345) | |
| 6919 | if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { | |
| 6920 | value = adjustCSS( elem, name, ret ); | |
| 6921 | ||
| 6922 | // Fixes bug #9237 | |
| 6923 | type = "number"; | |
| 6924 | } | |
| 6925 | ||
| 6926 | // Make sure that null and NaN values aren't set (#7116) | |
| 6927 | if ( value == null || value !== value ) { | |
| 6928 | return; | |
| 6929 | } | |
| 6930 | ||
| 6931 | // If a number was passed in, add the unit (except for certain CSS properties) | |
| 6932 | // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append | |
| 6933 | // "px" to a few hardcoded values. | |
| 6934 | if ( type === "number" && !isCustomProp ) { | |
| 6935 | value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); | |
| 6936 | } | |
| 6937 | ||
| 6938 | // background-* props affect original clone's values | |
| 6939 | if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { | |
| 6940 | style[ name ] = "inherit"; | |
| 6941 | } | |
| 6942 | ||
| 6943 | // If a hook was provided, use that value, otherwise just set the specified value | |
| 6944 | if ( !hooks || !( "set" in hooks ) || | |
| 6945 | ( value = hooks.set( elem, value, extra ) ) !== undefined ) { | |
| 6946 | ||
| 6947 | if ( isCustomProp ) { | |
| 6948 | style.setProperty( name, value ); | |
| 6949 | } else { | |
| 6950 | style[ name ] = value; | |
| 6951 | } | |
| 6952 | } | |
| 6953 | ||
| 6954 | } else { | |
| 6955 | ||
| 6956 | // If a hook was provided get the non-computed value from there | |
| 6957 | if ( hooks && "get" in hooks && | |
| 6958 | ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { | |
| 6959 | ||
| 6960 | return ret; | |
| 6961 | } | |
| 6962 | ||
| 6963 | // Otherwise just get the value from the style object | |
| 6964 | return style[ name ]; | |
| 6965 | } | |
| 6966 | }, | |
| 6967 | ||
| 6968 | css: function( elem, name, extra, styles ) { | |
| 6969 | var val, num, hooks, | |
| 6970 | origName = camelCase( name ), | |
| 6971 | isCustomProp = rcustomProp.test( name ); | |
| 6972 | ||
| 6973 | // Make sure that we're working with the right name. We don't | |
| 6974 | // want to modify the value if it is a CSS custom property | |
| 6975 | // since they are user-defined. | |
| 6976 | if ( !isCustomProp ) { | |
| 6977 | name = finalPropName( origName ); | |
| 6978 | } | |
| 6979 | ||
| 6980 | // Try prefixed name followed by the unprefixed name | |
| 6981 | hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; | |
| 6982 | ||
| 6983 | // If a hook was provided get the computed value from there | |
| 6984 | if ( hooks && "get" in hooks ) { | |
| 6985 | val = hooks.get( elem, true, extra ); | |
| 6986 | } | |
| 6987 | ||
| 6988 | // Otherwise, if a way to get the computed value exists, use that | |
| 6989 | if ( val === undefined ) { | |
| 6990 | val = curCSS( elem, name, styles ); | |
| 6991 | } | |
| 6992 | ||
| 6993 | // Convert "normal" to computed value | |
| 6994 | if ( val === "normal" && name in cssNormalTransform ) { | |
| 6995 | val = cssNormalTransform[ name ]; | |
| 6996 | } | |
| 6997 | ||
| 6998 | // Make numeric if forced or a qualifier was provided and val looks numeric | |
| 6999 | if ( extra === "" || extra ) { | |
| 7000 | num = parseFloat( val ); | |
| 7001 | return extra === true || isFinite( num ) ? num || 0 : val; | |
| 7002 | } | |
| 7003 | ||
| 7004 | return val; | |
| 7005 | } | |
| 7006 | } ); | |
| 7007 | ||
| 7008 | jQuery.each( [ "height", "width" ], function( _i, dimension ) { | |
| 7009 | jQuery.cssHooks[ dimension ] = { | |
| 7010 | get: function( elem, computed, extra ) { | |
| 7011 | if ( computed ) { | |
| 7012 | ||
| 7013 | // Certain elements can have dimension info if we invisibly show them | |
| 7014 | // but it must have a current display style that would benefit | |
| 7015 | return rdisplayswap.test( jQuery.css( elem, "display" ) ) && | |
| 7016 | ||
| 7017 | // Support: Safari 8+ | |
| 7018 | // Table columns in Safari have non-zero offsetWidth & zero | |
| 7019 | // getBoundingClientRect().width unless display is changed. | |
| 7020 | // Support: IE <=11 only | |
| 7021 | // Running getBoundingClientRect on a disconnected node | |
| 7022 | // in IE throws an error. | |
| 7023 | ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? | |
| 7024 | swap( elem, cssShow, function() { | |
| 7025 | return getWidthOrHeight( elem, dimension, extra ); | |
| 7026 | } ) : | |
| 7027 | getWidthOrHeight( elem, dimension, extra ); | |
| 7028 | } | |
| 7029 | }, | |
| 7030 | ||
| 7031 | set: function( elem, value, extra ) { | |
| 7032 | var matches, | |
| 7033 | styles = getStyles( elem ), | |
| 7034 | ||
| 7035 | // Only read styles.position if the test has a chance to fail | |
| 7036 | // to avoid forcing a reflow. | |
| 7037 | scrollboxSizeBuggy = !support.scrollboxSize() && | |
| 7038 | styles.position === "absolute", | |
| 7039 | ||
| 7040 | // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) | |
| 7041 | boxSizingNeeded = scrollboxSizeBuggy || extra, | |
| 7042 | isBorderBox = boxSizingNeeded && | |
| 7043 | jQuery.css( elem, "boxSizing", false, styles ) === "border-box", | |
| 7044 | subtract = extra ? | |
| 7045 | boxModelAdjustment( | |
| 7046 | elem, | |
| 7047 | dimension, | |
| 7048 | extra, | |
| 7049 | isBorderBox, | |
| 7050 | styles | |
| 7051 | ) : | |
| 7052 | 0; | |
| 7053 | ||
| 7054 | // Account for unreliable border-box dimensions by comparing offset* to computed and | |
| 7055 | // faking a content-box to get border and padding (gh-3699) | |
| 7056 | if ( isBorderBox && scrollboxSizeBuggy ) { | |
| 7057 | subtract -= Math.ceil( | |
| 7058 | elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - | |
| 7059 | parseFloat( styles[ dimension ] ) - | |
| 7060 | boxModelAdjustment( elem, dimension, "border", false, styles ) - | |
| 7061 | 0.5 | |
| 7062 | ); | |
| 7063 | } | |
| 7064 | ||
| 7065 | // Convert to pixels if value adjustment is needed | |
| 7066 | if ( subtract && ( matches = rcssNum.exec( value ) ) && | |
| 7067 | ( matches[ 3 ] || "px" ) !== "px" ) { | |
| 7068 | ||
| 7069 | elem.style[ dimension ] = value; | |
| 7070 | value = jQuery.css( elem, dimension ); | |
| 7071 | } | |
| 7072 | ||
| 7073 | return setPositiveNumber( elem, value, subtract ); | |
| 7074 | } | |
| 7075 | }; | |
| 7076 | } ); | |
| 7077 | ||
| 7078 | jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, | |
| 7079 | function( elem, computed ) { | |
| 7080 | if ( computed ) { | |
| 7081 | return ( parseFloat( curCSS( elem, "marginLeft" ) ) || | |
| 7082 | elem.getBoundingClientRect().left - | |
| 7083 | swap( elem, { marginLeft: 0 }, function() { | |
| 7084 | return elem.getBoundingClientRect().left; | |
| 7085 | } ) | |
| 7086 | ) + "px"; | |
| 7087 | } | |
| 7088 | } | |
| 7089 | ); | |
| 7090 | ||
| 7091 | // These hooks are used by animate to expand properties | |
| 7092 | jQuery.each( { | |
| 7093 | margin: "", | |
| 7094 | padding: "", | |
| 7095 | border: "Width" | |
| 7096 | }, function( prefix, suffix ) { | |
| 7097 | jQuery.cssHooks[ prefix + suffix ] = { | |
| 7098 | expand: function( value ) { | |
| 7099 | var i = 0, | |
| 7100 | expanded = {}, | |
| 7101 | ||
| 7102 | // Assumes a single number if not a string | |
| 7103 | parts = typeof value === "string" ? value.split( " " ) : [ value ]; | |
| 7104 | ||
| 7105 | for ( ; i < 4; i++ ) { | |
| 7106 | expanded[ prefix + cssExpand[ i ] + suffix ] = | |
| 7107 | parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; | |
| 7108 | } | |
| 7109 | ||
| 7110 | return expanded; | |
| 7111 | } | |
| 7112 | }; | |
| 7113 | ||
| 7114 | if ( prefix !== "margin" ) { | |
| 7115 | jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; | |
| 7116 | } | |
| 7117 | } ); | |
| 7118 | ||
| 7119 | jQuery.fn.extend( { | |
| 7120 | css: function( name, value ) { | |
| 7121 | return access( this, function( elem, name, value ) { | |
| 7122 | var styles, len, | |
| 7123 | map = {}, | |
| 7124 | i = 0; | |
| 7125 | ||
| 7126 | if ( Array.isArray( name ) ) { | |
| 7127 | styles = getStyles( elem ); | |
| 7128 | len = name.length; | |
| 7129 | ||
| 7130 | for ( ; i < len; i++ ) { | |
| 7131 | map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); | |
| 7132 | } | |
| 7133 | ||
| 7134 | return map; | |
| 7135 | } | |
| 7136 | ||
| 7137 | return value !== undefined ? | |
| 7138 | jQuery.style( elem, name, value ) : | |
| 7139 | jQuery.css( elem, name ); | |
| 7140 | }, name, value, arguments.length > 1 ); | |
| 7141 | } | |
| 7142 | } ); | |
| 7143 | ||
| 7144 | ||
| 7145 | function Tween( elem, options, prop, end, easing ) { | |
| 7146 | return new Tween.prototype.init( elem, options, prop, end, easing ); | |
| 7147 | } | |
| 7148 | jQuery.Tween = Tween; | |
| 7149 | ||
| 7150 | Tween.prototype = { | |
| 7151 | constructor: Tween, | |
| 7152 | init: function( elem, options, prop, end, easing, unit ) { | |
| 7153 | this.elem = elem; | |
| 7154 | this.prop = prop; | |
| 7155 | this.easing = easing || jQuery.easing._default; | |
| 7156 | this.options = options; | |
| 7157 | this.start = this.now = this.cur(); | |
| 7158 | this.end = end; | |
| 7159 | this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); | |
| 7160 | }, | |
| 7161 | cur: function() { | |
| 7162 | var hooks = Tween.propHooks[ this.prop ]; | |
| 7163 | ||
| 7164 | return hooks && hooks.get ? | |
| 7165 | hooks.get( this ) : | |
| 7166 | Tween.propHooks._default.get( this ); | |
| 7167 | }, | |
| 7168 | run: function( percent ) { | |
| 7169 | var eased, | |
| 7170 | hooks = Tween.propHooks[ this.prop ]; | |
| 7171 | ||
| 7172 | if ( this.options.duration ) { | |
| 7173 | this.pos = eased = jQuery.easing[ this.easing ]( | |
| 7174 | percent, this.options.duration * percent, 0, 1, this.options.duration | |
| 7175 | ); | |
| 7176 | } else { | |
| 7177 | this.pos = eased = percent; | |
| 7178 | } | |
| 7179 | this.now = ( this.end - this.start ) * eased + this.start; | |
| 7180 | ||
| 7181 | if ( this.options.step ) { | |
| 7182 | this.options.step.call( this.elem, this.now, this ); | |
| 7183 | } | |
| 7184 | ||
| 7185 | if ( hooks && hooks.set ) { | |
| 7186 | hooks.set( this ); | |
| 7187 | } else { | |
| 7188 | Tween.propHooks._default.set( this ); | |
| 7189 | } | |
| 7190 | return this; | |
| 7191 | } | |
| 7192 | }; | |
| 7193 | ||
| 7194 | Tween.prototype.init.prototype = Tween.prototype; | |
| 7195 | ||
| 7196 | Tween.propHooks = { | |
| 7197 | _default: { | |
| 7198 | get: function( tween ) { | |
| 7199 | var result; | |
| 7200 | ||
| 7201 | // Use a property on the element directly when it is not a DOM element, | |
| 7202 | // or when there is no matching style property that exists. | |
| 7203 | if ( tween.elem.nodeType !== 1 || | |
| 7204 | tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { | |
| 7205 | return tween.elem[ tween.prop ]; | |
| 7206 | } | |
| 7207 | ||
| 7208 | // Passing an empty string as a 3rd parameter to .css will automatically | |
| 7209 | // attempt a parseFloat and fallback to a string if the parse fails. | |
| 7210 | // Simple values such as "10px" are parsed to Float; | |
| 7211 | // complex values such as "rotate(1rad)" are returned as-is. | |
| 7212 | result = jQuery.css( tween.elem, tween.prop, "" ); | |
| 7213 | ||
| 7214 | // Empty strings, null, undefined and "auto" are converted to 0. | |
| 7215 | return !result || result === "auto" ? 0 : result; | |
| 7216 | }, | |
| 7217 | set: function( tween ) { | |
| 7218 | ||
| 7219 | // Use step hook for back compat. | |
| 7220 | // Use cssHook if its there. | |
| 7221 | // Use .style if available and use plain properties where available. | |
| 7222 | if ( jQuery.fx.step[ tween.prop ] ) { | |
| 7223 | jQuery.fx.step[ tween.prop ]( tween ); | |
| 7224 | } else if ( tween.elem.nodeType === 1 && ( | |
| 7225 | jQuery.cssHooks[ tween.prop ] || | |
| 7226 | tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { | |
| 7227 | jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); | |
| 7228 | } else { | |
| 7229 | tween.elem[ tween.prop ] = tween.now; | |
| 7230 | } | |
| 7231 | } | |
| 7232 | } | |
| 7233 | }; | |
| 7234 | ||
| 7235 | // Support: IE <=9 only | |
| 7236 | // Panic based approach to setting things on disconnected nodes | |
| 7237 | Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { | |
| 7238 | set: function( tween ) { | |
| 7239 | if ( tween.elem.nodeType && tween.elem.parentNode ) { | |
| 7240 | tween.elem[ tween.prop ] = tween.now; | |
| 7241 | } | |
| 7242 | } | |
| 7243 | }; | |
| 7244 | ||
| 7245 | jQuery.easing = { | |
| 7246 | linear: function( p ) { | |
| 7247 | return p; | |
| 7248 | }, | |
| 7249 | swing: function( p ) { | |
| 7250 | return 0.5 - Math.cos( p * Math.PI ) / 2; | |
| 7251 | }, | |
| 7252 | _default: "swing" | |
| 7253 | }; | |
| 7254 | ||
| 7255 | jQuery.fx = Tween.prototype.init; | |
| 7256 | ||
| 7257 | // Back compat <1.8 extension point | |
| 7258 | jQuery.fx.step = {}; | |
| 7259 | ||
| 7260 | ||
| 7261 | ||
| 7262 | ||
| 7263 | var | |
| 7264 | fxNow, inProgress, | |
| 7265 | rfxtypes = /^(?:toggle|show|hide)$/, | |
| 7266 | rrun = /queueHooks$/; | |
| 7267 | ||
| 7268 | function schedule() { | |
| 7269 | if ( inProgress ) { | |
| 7270 | if ( document.hidden === false && window.requestAnimationFrame ) { | |
| 7271 | window.requestAnimationFrame( schedule ); | |
| 7272 | } else { | |
| 7273 | window.setTimeout( schedule, jQuery.fx.interval ); | |
| 7274 | } | |
| 7275 | ||
| 7276 | jQuery.fx.tick(); | |
| 7277 | } | |
| 7278 | } | |
| 7279 | ||
| 7280 | // Animations created synchronously will run synchronously | |
| 7281 | function createFxNow() { | |
| 7282 | window.setTimeout( function() { | |
| 7283 | fxNow = undefined; | |
| 7284 | } ); | |
| 7285 | return ( fxNow = Date.now() ); | |
| 7286 | } | |
| 7287 | ||
| 7288 | // Generate parameters to create a standard animation | |
| 7289 | function genFx( type, includeWidth ) { | |
| 7290 | var which, | |
| 7291 | i = 0, | |
| 7292 | attrs = { height: type }; | |
| 7293 | ||
| 7294 | // If we include width, step value is 1 to do all cssExpand values, | |
| 7295 | // otherwise step value is 2 to skip over Left and Right | |
| 7296 | includeWidth = includeWidth ? 1 : 0; | |
| 7297 | for ( ; i < 4; i += 2 - includeWidth ) { | |
| 7298 | which = cssExpand[ i ]; | |
| 7299 | attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; | |
| 7300 | } | |
| 7301 | ||
| 7302 | if ( includeWidth ) { | |
| 7303 | attrs.opacity = attrs.width = type; | |
| 7304 | } | |
| 7305 | ||
| 7306 | return attrs; | |
| 7307 | } | |
| 7308 | ||
| 7309 | function createTween( value, prop, animation ) { | |
| 7310 | var tween, | |
| 7311 | collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), | |
| 7312 | index = 0, | |
| 7313 | length = collection.length; | |
| 7314 | for ( ; index < length; index++ ) { | |
| 7315 | if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { | |
| 7316 | ||
| 7317 | // We're done with this property | |
| 7318 | return tween; | |
| 7319 | } | |
| 7320 | } | |
| 7321 | } | |
| 7322 | ||
| 7323 | function defaultPrefilter( elem, props, opts ) { | |
| 7324 | var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, | |
| 7325 | isBox = "width" in props || "height" in props, | |
| 7326 | anim = this, | |
| 7327 | orig = {}, | |
| 7328 | style = elem.style, | |
| 7329 | hidden = elem.nodeType && isHiddenWithinTree( elem ), | |
| 7330 | dataShow = dataPriv.get( elem, "fxshow" ); | |
| 7331 | ||
| 7332 | // Queue-skipping animations hijack the fx hooks | |
| 7333 | if ( !opts.queue ) { | |
| 7334 | hooks = jQuery._queueHooks( elem, "fx" ); | |
| 7335 | if ( hooks.unqueued == null ) { | |
| 7336 | hooks.unqueued = 0; | |
| 7337 | oldfire = hooks.empty.fire; | |
| 7338 | hooks.empty.fire = function() { | |
| 7339 | if ( !hooks.unqueued ) { | |
| 7340 | oldfire(); | |
| 7341 | } | |
| 7342 | }; | |
| 7343 | } | |
| 7344 | hooks.unqueued++; | |
| 7345 | ||
| 7346 | anim.always( function() { | |
| 7347 | ||
| 7348 | // Ensure the complete handler is called before this completes | |
| 7349 | anim.always( function() { | |
| 7350 | hooks.unqueued--; | |
| 7351 | if ( !jQuery.queue( elem, "fx" ).length ) { | |
| 7352 | hooks.empty.fire(); | |
| 7353 | } | |
| 7354 | } ); | |
| 7355 | } ); | |
| 7356 | } | |
| 7357 | ||
| 7358 | // Detect show/hide animations | |
| 7359 | for ( prop in props ) { | |
| 7360 | value = props[ prop ]; | |
| 7361 | if ( rfxtypes.test( value ) ) { | |
| 7362 | delete props[ prop ]; | |
| 7363 | toggle = toggle || value === "toggle"; | |
| 7364 | if ( value === ( hidden ? "hide" : "show" ) ) { | |
| 7365 | ||
| 7366 | // Pretend to be hidden if this is a "show" and | |
| 7367 | // there is still data from a stopped show/hide | |
| 7368 | if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { | |
| 7369 | hidden = true; | |
| 7370 | ||
| 7371 | // Ignore all other no-op show/hide data | |
| 7372 | } else { | |
| 7373 | continue; | |
| 7374 | } | |
| 7375 | } | |
| 7376 | orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); | |
| 7377 | } | |
| 7378 | } | |
| 7379 | ||
| 7380 | // Bail out if this is a no-op like .hide().hide() | |
| 7381 | propTween = !jQuery.isEmptyObject( props ); | |
| 7382 | if ( !propTween && jQuery.isEmptyObject( orig ) ) { | |
| 7383 | return; | |
| 7384 | } | |
| 7385 | ||
| 7386 | // Restrict "overflow" and "display" styles during box animations | |
| 7387 | if ( isBox && elem.nodeType === 1 ) { | |
| 7388 | ||
| 7389 | // Support: IE <=9 - 11, Edge 12 - 15 | |
| 7390 | // Record all 3 overflow attributes because IE does not infer the shorthand | |
| 7391 | // from identically-valued overflowX and overflowY and Edge just mirrors | |
| 7392 | // the overflowX value there. | |
| 7393 | opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; | |
| 7394 | ||
| 7395 | // Identify a display type, preferring old show/hide data over the CSS cascade | |
| 7396 | restoreDisplay = dataShow && dataShow.display; | |
| 7397 | if ( restoreDisplay == null ) { | |
| 7398 | restoreDisplay = dataPriv.get( elem, "display" ); | |
| 7399 | } | |
| 7400 | display = jQuery.css( elem, "display" ); | |
| 7401 | if ( display === "none" ) { | |
| 7402 | if ( restoreDisplay ) { | |
| 7403 | display = restoreDisplay; | |
| 7404 | } else { | |
| 7405 | ||
| 7406 | // Get nonempty value(s) by temporarily forcing visibility | |
| 7407 | showHide( [ elem ], true ); | |
| 7408 | restoreDisplay = elem.style.display || restoreDisplay; | |
| 7409 | display = jQuery.css( elem, "display" ); | |
| 7410 | showHide( [ elem ] ); | |
| 7411 | } | |
| 7412 | } | |
| 7413 | ||
| 7414 | // Animate inline elements as inline-block | |
| 7415 | if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { | |
| 7416 | if ( jQuery.css( elem, "float" ) === "none" ) { | |
| 7417 | ||
| 7418 | // Restore the original display value at the end of pure show/hide animations | |
| 7419 | if ( !propTween ) { | |
| 7420 | anim.done( function() { | |
| 7421 | style.display = restoreDisplay; | |
| 7422 | } ); | |
| 7423 | if ( restoreDisplay == null ) { | |
| 7424 | display = style.display; | |
| 7425 | restoreDisplay = display === "none" ? "" : display; | |
| 7426 | } | |
| 7427 | } | |
| 7428 | style.display = "inline-block"; | |
| 7429 | } | |
| 7430 | } | |
| 7431 | } | |
| 7432 | ||
| 7433 | if ( opts.overflow ) { | |
| 7434 | style.overflow = "hidden"; | |
| 7435 | anim.always( function() { | |
| 7436 | style.overflow = opts.overflow[ 0 ]; | |
| 7437 | style.overflowX = opts.overflow[ 1 ]; | |
| 7438 | style.overflowY = opts.overflow[ 2 ]; | |
| 7439 | } ); | |
| 7440 | } | |
| 7441 | ||
| 7442 | // Implement show/hide animations | |
| 7443 | propTween = false; | |
| 7444 | for ( prop in orig ) { | |
| 7445 | ||
| 7446 | // General show/hide setup for this element animation | |
| 7447 | if ( !propTween ) { | |
| 7448 | if ( dataShow ) { | |
| 7449 | if ( "hidden" in dataShow ) { | |
| 7450 | hidden = dataShow.hidden; | |
| 7451 | } | |
| 7452 | } else { | |
| 7453 | dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); | |
| 7454 | } | |
| 7455 | ||
| 7456 | // Store hidden/visible for toggle so `.stop().toggle()` "reverses" | |
| 7457 | if ( toggle ) { | |
| 7458 | dataShow.hidden = !hidden; | |
| 7459 | } | |
| 7460 | ||
| 7461 | // Show elements before animating them | |
| 7462 | if ( hidden ) { | |
| 7463 | showHide( [ elem ], true ); | |
| 7464 | } | |
| 7465 | ||
| 7466 | /* eslint-disable no-loop-func */ | |
| 7467 | ||
| 7468 | anim.done( function() { | |
| 7469 | ||
| 7470 | /* eslint-enable no-loop-func */ | |
| 7471 | ||
| 7472 | // The final step of a "hide" animation is actually hiding the element | |
| 7473 | if ( !hidden ) { | |
| 7474 | showHide( [ elem ] ); | |
| 7475 | } | |
| 7476 | dataPriv.remove( elem, "fxshow" ); | |
| 7477 | for ( prop in orig ) { | |
| 7478 | jQuery.style( elem, prop, orig[ prop ] ); | |
| 7479 | } | |
| 7480 | } ); | |
| 7481 | } | |
| 7482 | ||
| 7483 | // Per-property setup | |
| 7484 | propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); | |
| 7485 | if ( !( prop in dataShow ) ) { | |
| 7486 | dataShow[ prop ] = propTween.start; | |
| 7487 | if ( hidden ) { | |
| 7488 | propTween.end = propTween.start; | |
| 7489 | propTween.start = 0; | |
| 7490 | } | |
| 7491 | } | |
| 7492 | } | |
| 7493 | } | |
| 7494 | ||
| 7495 | function propFilter( props, specialEasing ) { | |
| 7496 | var index, name, easing, value, hooks; | |
| 7497 | ||
| 7498 | // camelCase, specialEasing and expand cssHook pass | |
| 7499 | for ( index in props ) { | |
| 7500 | name = camelCase( index ); | |
| 7501 | easing = specialEasing[ name ]; | |
| 7502 | value = props[ index ]; | |
| 7503 | if ( Array.isArray( value ) ) { | |
| 7504 | easing = value[ 1 ]; | |
| 7505 | value = props[ index ] = value[ 0 ]; | |
| 7506 | } | |
| 7507 | ||
| 7508 | if ( index !== name ) { | |
| 7509 | props[ name ] = value; | |
| 7510 | delete props[ index ]; | |
| 7511 | } | |
| 7512 | ||
| 7513 | hooks = jQuery.cssHooks[ name ]; | |
| 7514 | if ( hooks && "expand" in hooks ) { | |
| 7515 | value = hooks.expand( value ); | |
| 7516 | delete props[ name ]; | |
| 7517 | ||
| 7518 | // Not quite $.extend, this won't overwrite existing keys. | |
| 7519 | // Reusing 'index' because we have the correct "name" | |
| 7520 | for ( index in value ) { | |
| 7521 | if ( !( index in props ) ) { | |
| 7522 | props[ index ] = value[ index ]; | |
| 7523 | specialEasing[ index ] = easing; | |
| 7524 | } | |
| 7525 | } | |
| 7526 | } else { | |
| 7527 | specialEasing[ name ] = easing; | |
| 7528 | } | |
| 7529 | } | |
| 7530 | } | |
| 7531 | ||
| 7532 | function Animation( elem, properties, options ) { | |
| 7533 | var result, | |
| 7534 | stopped, | |
| 7535 | index = 0, | |
| 7536 | length = Animation.prefilters.length, | |
| 7537 | deferred = jQuery.Deferred().always( function() { | |
| 7538 | ||
| 7539 | // Don't match elem in the :animated selector | |
| 7540 | delete tick.elem; | |
| 7541 | } ), | |
| 7542 | tick = function() { | |
| 7543 | if ( stopped ) { | |
| 7544 | return false; | |
| 7545 | } | |
| 7546 | var currentTime = fxNow || createFxNow(), | |
| 7547 | remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), | |
| 7548 | ||
| 7549 | // Support: Android 2.3 only | |
| 7550 | // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) | |
| 7551 | temp = remaining / animation.duration || 0, | |
| 7552 | percent = 1 - temp, | |
| 7553 | index = 0, | |
| 7554 | length = animation.tweens.length; | |
| 7555 | ||
| 7556 | for ( ; index < length; index++ ) { | |
| 7557 | animation.tweens[ index ].run( percent ); | |
| 7558 | } | |
| 7559 | ||
| 7560 | deferred.notifyWith( elem, [ animation, percent, remaining ] ); | |
| 7561 | ||
| 7562 | // If there's more to do, yield | |
| 7563 | if ( percent < 1 && length ) { | |
| 7564 | return remaining; | |
| 7565 | } | |
| 7566 | ||
| 7567 | // If this was an empty animation, synthesize a final progress notification | |
| 7568 | if ( !length ) { | |
| 7569 | deferred.notifyWith( elem, [ animation, 1, 0 ] ); | |
| 7570 | } | |
| 7571 | ||
| 7572 | // Resolve the animation and report its conclusion | |
| 7573 | deferred.resolveWith( elem, [ animation ] ); | |
| 7574 | return false; | |
| 7575 | }, | |
| 7576 | animation = deferred.promise( { | |
| 7577 | elem: elem, | |
| 7578 | props: jQuery.extend( {}, properties ), | |
| 7579 | opts: jQuery.extend( true, { | |
| 7580 | specialEasing: {}, | |
| 7581 | easing: jQuery.easing._default | |
| 7582 | }, options ), | |
| 7583 | originalProperties: properties, | |
| 7584 | originalOptions: options, | |
| 7585 | startTime: fxNow || createFxNow(), | |
| 7586 | duration: options.duration, | |
| 7587 | tweens: [], | |
| 7588 | createTween: function( prop, end ) { | |
| 7589 | var tween = jQuery.Tween( elem, animation.opts, prop, end, | |
| 7590 | animation.opts.specialEasing[ prop ] || animation.opts.easing ); | |
| 7591 | animation.tweens.push( tween ); | |
| 7592 | return tween; | |
| 7593 | }, | |
| 7594 | stop: function( gotoEnd ) { | |
| 7595 | var index = 0, | |
| 7596 | ||
| 7597 | // If we are going to the end, we want to run all the tweens | |
| 7598 | // otherwise we skip this part | |
| 7599 | length = gotoEnd ? animation.tweens.length : 0; | |
| 7600 | if ( stopped ) { | |
| 7601 | return this; | |
| 7602 | } | |
| 7603 | stopped = true; | |
| 7604 | for ( ; index < length; index++ ) { | |
| 7605 | animation.tweens[ index ].run( 1 ); | |
| 7606 | } | |
| 7607 | ||
| 7608 | // Resolve when we played the last frame; otherwise, reject | |
| 7609 | if ( gotoEnd ) { | |
| 7610 | deferred.notifyWith( elem, [ animation, 1, 0 ] ); | |
| 7611 | deferred.resolveWith( elem, [ animation, gotoEnd ] ); | |
| 7612 | } else { | |
| 7613 | deferred.rejectWith( elem, [ animation, gotoEnd ] ); | |
| 7614 | } | |
| 7615 | return this; | |
| 7616 | } | |
| 7617 | } ), | |
| 7618 | props = animation.props; | |
| 7619 | ||
| 7620 | propFilter( props, animation.opts.specialEasing ); | |
| 7621 | ||
| 7622 | for ( ; index < length; index++ ) { | |
| 7623 | result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); | |
| 7624 | if ( result ) { | |
| 7625 | if ( isFunction( result.stop ) ) { | |
| 7626 | jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = | |
| 7627 | result.stop.bind( result ); | |
| 7628 | } | |
| 7629 | return result; | |
| 7630 | } | |
| 7631 | } | |
| 7632 | ||
| 7633 | jQuery.map( props, createTween, animation ); | |
| 7634 | ||
| 7635 | if ( isFunction( animation.opts.start ) ) { | |
| 7636 | animation.opts.start.call( elem, animation ); | |
| 7637 | } | |
| 7638 | ||
| 7639 | // Attach callbacks from options | |
| 7640 | animation | |
| 7641 | .progress( animation.opts.progress ) | |
| 7642 | .done( animation.opts.done, animation.opts.complete ) | |
| 7643 | .fail( animation.opts.fail ) | |
| 7644 | .always( animation.opts.always ); | |
| 7645 | ||
| 7646 | jQuery.fx.timer( | |
| 7647 | jQuery.extend( tick, { | |
| 7648 | elem: elem, | |
| 7649 | anim: animation, | |
| 7650 | queue: animation.opts.queue | |
| 7651 | } ) | |
| 7652 | ); | |
| 7653 | ||
| 7654 | return animation; | |
| 7655 | } | |
| 7656 | ||
| 7657 | jQuery.Animation = jQuery.extend( Animation, { | |
| 7658 | ||
| 7659 | tweeners: { | |
| 7660 | "*": [ function( prop, value ) { | |
| 7661 | var tween = this.createTween( prop, value ); | |
| 7662 | adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); | |
| 7663 | return tween; | |
| 7664 | } ] | |
| 7665 | }, | |
| 7666 | ||
| 7667 | tweener: function( props, callback ) { | |
| 7668 | if ( isFunction( props ) ) { | |
| 7669 | callback = props; | |
| 7670 | props = [ "*" ]; | |
| 7671 | } else { | |
| 7672 | props = props.match( rnothtmlwhite ); | |
| 7673 | } | |
| 7674 | ||
| 7675 | var prop, | |
| 7676 | index = 0, | |
| 7677 | length = props.length; | |
| 7678 | ||
| 7679 | for ( ; index < length; index++ ) { | |
| 7680 | prop = props[ index ]; | |
| 7681 | Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; | |
| 7682 | Animation.tweeners[ prop ].unshift( callback ); | |
| 7683 | } | |
| 7684 | }, | |
| 7685 | ||
| 7686 | prefilters: [ defaultPrefilter ], | |
| 7687 | ||
| 7688 | prefilter: function( callback, prepend ) { | |
| 7689 | if ( prepend ) { | |
| 7690 | Animation.prefilters.unshift( callback ); | |
| 7691 | } else { | |
| 7692 | Animation.prefilters.push( callback ); | |
| 7693 | } | |
| 7694 | } | |
| 7695 | } ); | |
| 7696 | ||
| 7697 | jQuery.speed = function( speed, easing, fn ) { | |
| 7698 | var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { | |
| 7699 | complete: fn || !fn && easing || | |
| 7700 | isFunction( speed ) && speed, | |
| 7701 | duration: speed, | |
| 7702 | easing: fn && easing || easing && !isFunction( easing ) && easing | |
| 7703 | }; | |
| 7704 | ||
| 7705 | // Go to the end state if fx are off | |
| 7706 | if ( jQuery.fx.off ) { | |
| 7707 | opt.duration = 0; | |
| 7708 | ||
| 7709 | } else { | |
| 7710 | if ( typeof opt.duration !== "number" ) { | |
| 7711 | if ( opt.duration in jQuery.fx.speeds ) { | |
| 7712 | opt.duration = jQuery.fx.speeds[ opt.duration ]; | |
| 7713 | ||
| 7714 | } else { | |
| 7715 | opt.duration = jQuery.fx.speeds._default; | |
| 7716 | } | |
| 7717 | } | |
| 7718 | } | |
| 7719 | ||
| 7720 | // Normalize opt.queue - true/undefined/null -> "fx" | |
| 7721 | if ( opt.queue == null || opt.queue === true ) { | |
| 7722 | opt.queue = "fx"; | |
| 7723 | } | |
| 7724 | ||
| 7725 | // Queueing | |
| 7726 | opt.old = opt.complete; | |
| 7727 | ||
| 7728 | opt.complete = function() { | |
| 7729 | if ( isFunction( opt.old ) ) { | |
| 7730 | opt.old.call( this ); | |
| 7731 | } | |
| 7732 | ||
| 7733 | if ( opt.queue ) { | |
| 7734 | jQuery.dequeue( this, opt.queue ); | |
| 7735 | } | |
| 7736 | }; | |
| 7737 | ||
| 7738 | return opt; | |
| 7739 | }; | |
| 7740 | ||
| 7741 | jQuery.fn.extend( { | |
| 7742 | fadeTo: function( speed, to, easing, callback ) { | |
| 7743 | ||
| 7744 | // Show any hidden elements after setting opacity to 0 | |
| 7745 | return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() | |
| 7746 | ||
| 7747 | // Animate to the value specified | |
| 7748 | .end().animate( { opacity: to }, speed, easing, callback ); | |
| 7749 | }, | |
| 7750 | animate: function( prop, speed, easing, callback ) { | |
| 7751 | var empty = jQuery.isEmptyObject( prop ), | |
| 7752 | optall = jQuery.speed( speed, easing, callback ), | |
| 7753 | doAnimation = function() { | |
| 7754 | ||
| 7755 | // Operate on a copy of prop so per-property easing won't be lost | |
| 7756 | var anim = Animation( this, jQuery.extend( {}, prop ), optall ); | |
| 7757 | ||
| 7758 | // Empty animations, or finishing resolves immediately | |
| 7759 | if ( empty || dataPriv.get( this, "finish" ) ) { | |
| 7760 | anim.stop( true ); | |
| 7761 | } | |
| 7762 | }; | |
| 7763 | doAnimation.finish = doAnimation; | |
| 7764 | ||
| 7765 | return empty || optall.queue === false ? | |
| 7766 | this.each( doAnimation ) : | |
| 7767 | this.queue( optall.queue, doAnimation ); | |
| 7768 | }, | |
| 7769 | stop: function( type, clearQueue, gotoEnd ) { | |
| 7770 | var stopQueue = function( hooks ) { | |
| 7771 | var stop = hooks.stop; | |
| 7772 | delete hooks.stop; | |
| 7773 | stop( gotoEnd ); | |
| 7774 | }; | |
| 7775 | ||
| 7776 | if ( typeof type !== "string" ) { | |
| 7777 | gotoEnd = clearQueue; | |
| 7778 | clearQueue = type; | |
| 7779 | type = undefined; | |
| 7780 | } | |
| 7781 | if ( clearQueue ) { | |
| 7782 | this.queue( type || "fx", [] ); | |
| 7783 | } | |
| 7784 | ||
| 7785 | return this.each( function() { | |
| 7786 | var dequeue = true, | |
| 7787 | index = type != null && type + "queueHooks", | |
| 7788 | timers = jQuery.timers, | |
| 7789 | data = dataPriv.get( this ); | |
| 7790 | ||
| 7791 | if ( index ) { | |
| 7792 | if ( data[ index ] && data[ index ].stop ) { | |
| 7793 | stopQueue( data[ index ] ); | |
| 7794 | } | |
| 7795 | } else { | |
| 7796 | for ( index in data ) { | |
| 7797 | if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { | |
| 7798 | stopQueue( data[ index ] ); | |
| 7799 | } | |
| 7800 | } | |
| 7801 | } | |
| 7802 | ||
| 7803 | for ( index = timers.length; index--; ) { | |
| 7804 | if ( timers[ index ].elem === this && | |
| 7805 | ( type == null || timers[ index ].queue === type ) ) { | |
| 7806 | ||
| 7807 | timers[ index ].anim.stop( gotoEnd ); | |
| 7808 | dequeue = false; | |
| 7809 | timers.splice( index, 1 ); | |
| 7810 | } | |
| 7811 | } | |
| 7812 | ||
| 7813 | // Start the next in the queue if the last step wasn't forced. | |
| 7814 | // Timers currently will call their complete callbacks, which | |
| 7815 | // will dequeue but only if they were gotoEnd. | |
| 7816 | if ( dequeue || !gotoEnd ) { | |
| 7817 | jQuery.dequeue( this, type ); | |
| 7818 | } | |
| 7819 | } ); | |
| 7820 | }, | |
| 7821 | finish: function( type ) { | |
| 7822 | if ( type !== false ) { | |
| 7823 | type = type || "fx"; | |
| 7824 | } | |
| 7825 | return this.each( function() { | |
| 7826 | var index, | |
| 7827 | data = dataPriv.get( this ), | |
| 7828 | queue = data[ type + "queue" ], | |
| 7829 | hooks = data[ type + "queueHooks" ], | |
| 7830 | timers = jQuery.timers, | |
| 7831 | length = queue ? queue.length : 0; | |
| 7832 | ||
| 7833 | // Enable finishing flag on private data | |
| 7834 | data.finish = true; | |
| 7835 | ||
| 7836 | // Empty the queue first | |
| 7837 | jQuery.queue( this, type, [] ); | |
| 7838 | ||
| 7839 | if ( hooks && hooks.stop ) { | |
| 7840 | hooks.stop.call( this, true ); | |
| 7841 | } | |
| 7842 | ||
| 7843 | // Look for any active animations, and finish them | |
| 7844 | for ( index = timers.length; index--; ) { | |
| 7845 | if ( timers[ index ].elem === this && timers[ index ].queue === type ) { | |
| 7846 | timers[ index ].anim.stop( true ); | |
| 7847 | timers.splice( index, 1 ); | |
| 7848 | } | |
| 7849 | } | |
| 7850 | ||
| 7851 | // Look for any animations in the old queue and finish them | |
| 7852 | for ( index = 0; index < length; index++ ) { | |
| 7853 | if ( queue[ index ] && queue[ index ].finish ) { | |
| 7854 | queue[ index ].finish.call( this ); | |
| 7855 | } | |
| 7856 | } | |
| 7857 | ||
| 7858 | // Turn off finishing flag | |
| 7859 | delete data.finish; | |
| 7860 | } ); | |
| 7861 | } | |
| 7862 | } ); | |
| 7863 | ||
| 7864 | jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { | |
| 7865 | var cssFn = jQuery.fn[ name ]; | |
| 7866 | jQuery.fn[ name ] = function( speed, easing, callback ) { | |
| 7867 | return speed == null || typeof speed === "boolean" ? | |
| 7868 | cssFn.apply( this, arguments ) : | |
| 7869 | this.animate( genFx( name, true ), speed, easing, callback ); | |
| 7870 | }; | |
| 7871 | } ); | |
| 7872 | ||
| 7873 | // Generate shortcuts for custom animations | |
| 7874 | jQuery.each( { | |
| 7875 | slideDown: genFx( "show" ), | |
| 7876 | slideUp: genFx( "hide" ), | |
| 7877 | slideToggle: genFx( "toggle" ), | |
| 7878 | fadeIn: { opacity: "show" }, | |
| 7879 | fadeOut: { opacity: "hide" }, | |
| 7880 | fadeToggle: { opacity: "toggle" } | |
| 7881 | }, function( name, props ) { | |
| 7882 | jQuery.fn[ name ] = function( speed, easing, callback ) { | |
| 7883 | return this.animate( props, speed, easing, callback ); | |
| 7884 | }; | |
| 7885 | } ); | |
| 7886 | ||
| 7887 | jQuery.timers = []; | |
| 7888 | jQuery.fx.tick = function() { | |
| 7889 | var timer, | |
| 7890 | i = 0, | |
| 7891 | timers = jQuery.timers; | |
| 7892 | ||
| 7893 | fxNow = Date.now(); | |
| 7894 | ||
| 7895 | for ( ; i < timers.length; i++ ) { | |
| 7896 | timer = timers[ i ]; | |
| 7897 | ||
| 7898 | // Run the timer and safely remove it when done (allowing for external removal) | |
| 7899 | if ( !timer() && timers[ i ] === timer ) { | |
| 7900 | timers.splice( i--, 1 ); | |
| 7901 | } | |
| 7902 | } | |
| 7903 | ||
| 7904 | if ( !timers.length ) { | |
| 7905 | jQuery.fx.stop(); | |
| 7906 | } | |
| 7907 | fxNow = undefined; | |
| 7908 | }; | |
| 7909 | ||
| 7910 | jQuery.fx.timer = function( timer ) { | |
| 7911 | jQuery.timers.push( timer ); | |
| 7912 | jQuery.fx.start(); | |
| 7913 | }; | |
| 7914 | ||
| 7915 | jQuery.fx.interval = 13; | |
| 7916 | jQuery.fx.start = function() { | |
| 7917 | if ( inProgress ) { | |
| 7918 | return; | |
| 7919 | } | |
| 7920 | ||
| 7921 | inProgress = true; | |
| 7922 | schedule(); | |
| 7923 | }; | |
| 7924 | ||
| 7925 | jQuery.fx.stop = function() { | |
| 7926 | inProgress = null; | |
| 7927 | }; | |
| 7928 | ||
| 7929 | jQuery.fx.speeds = { | |
| 7930 | slow: 600, | |
| 7931 | fast: 200, | |
| 7932 | ||
| 7933 | // Default speed | |
| 7934 | _default: 400 | |
| 7935 | }; | |
| 7936 | ||
| 7937 | ||
| 7938 | // Based off of the plugin by Clint Helfers, with permission. | |
| 7939 | // https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ | |
| 7940 | jQuery.fn.delay = function( time, type ) { | |
| 7941 | time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; | |
| 7942 | type = type || "fx"; | |
| 7943 | ||
| 7944 | return this.queue( type, function( next, hooks ) { | |
| 7945 | var timeout = window.setTimeout( next, time ); | |
| 7946 | hooks.stop = function() { | |
| 7947 | window.clearTimeout( timeout ); | |
| 7948 | }; | |
| 7949 | } ); | |
| 7950 | }; | |
| 7951 | ||
| 7952 | ||
| 7953 | ( function() { | |
| 7954 | var input = document.createElement( "input" ), | |
| 7955 | select = document.createElement( "select" ), | |
| 7956 | opt = select.appendChild( document.createElement( "option" ) ); | |
| 7957 | ||
| 7958 | input.type = "checkbox"; | |
| 7959 | ||
| 7960 | // Support: Android <=4.3 only | |
| 7961 | // Default value for a checkbox should be "on" | |
| 7962 | support.checkOn = input.value !== ""; | |
| 7963 | ||
| 7964 | // Support: IE <=11 only | |
| 7965 | // Must access selectedIndex to make default options select | |
| 7966 | support.optSelected = opt.selected; | |
| 7967 | ||
| 7968 | // Support: IE <=11 only | |
| 7969 | // An input loses its value after becoming a radio | |
| 7970 | input = document.createElement( "input" ); | |
| 7971 | input.value = "t"; | |
| 7972 | input.type = "radio"; | |
| 7973 | support.radioValue = input.value === "t"; | |
| 7974 | } )(); | |
| 7975 | ||
| 7976 | ||
| 7977 | var boolHook, | |
| 7978 | attrHandle = jQuery.expr.attrHandle; | |
| 7979 | ||
| 7980 | jQuery.fn.extend( { | |
| 7981 | attr: function( name, value ) { | |
| 7982 | return access( this, jQuery.attr, name, value, arguments.length > 1 ); | |
| 7983 | }, | |
| 7984 | ||
| 7985 | removeAttr: function( name ) { | |
| 7986 | return this.each( function() { | |
| 7987 | jQuery.removeAttr( this, name ); | |
| 7988 | } ); | |
| 7989 | } | |
| 7990 | } ); | |
| 7991 | ||
| 7992 | jQuery.extend( { | |
| 7993 | attr: function( elem, name, value ) { | |
| 7994 | var ret, hooks, | |
| 7995 | nType = elem.nodeType; | |
| 7996 | ||
| 7997 | // Don't get/set attributes on text, comment and attribute nodes | |
| 7998 | if ( nType === 3 || nType === 8 || nType === 2 ) { | |
| 7999 | return; | |
| 8000 | } | |
| 8001 | ||
| 8002 | // Fallback to prop when attributes are not supported | |
| 8003 | if ( typeof elem.getAttribute === "undefined" ) { | |
| 8004 | return jQuery.prop( elem, name, value ); | |
| 8005 | } | |
| 8006 | ||
| 8007 | // Attribute hooks are determined by the lowercase version | |
| 8008 | // Grab necessary hook if one is defined | |
| 8009 | if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { | |
| 8010 | hooks = jQuery.attrHooks[ name.toLowerCase() ] || | |
| 8011 | ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); | |
| 8012 | } | |
| 8013 | ||
| 8014 | if ( value !== undefined ) { | |
| 8015 | if ( value === null ) { | |
| 8016 | jQuery.removeAttr( elem, name ); | |
| 8017 | return; | |
| 8018 | } | |
| 8019 | ||
| 8020 | if ( hooks && "set" in hooks && | |
| 8021 | ( ret = hooks.set( elem, value, name ) ) !== undefined ) { | |
| 8022 | return ret; | |
| 8023 | } | |
| 8024 | ||
| 8025 | elem.setAttribute( name, value + "" ); | |
| 8026 | return value; | |
| 8027 | } | |
| 8028 | ||
| 8029 | if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { | |
| 8030 | return ret; | |
| 8031 | } | |
| 8032 | ||
| 8033 | ret = jQuery.find.attr( elem, name ); | |
| 8034 | ||
| 8035 | // Non-existent attributes return null, we normalize to undefined | |
| 8036 | return ret == null ? undefined : ret; | |
| 8037 | }, | |
| 8038 | ||
| 8039 | attrHooks: { | |
| 8040 | type: { | |
| 8041 | set: function( elem, value ) { | |
| 8042 | if ( !support.radioValue && value === "radio" && | |
| 8043 | nodeName( elem, "input" ) ) { | |
| 8044 | var val = elem.value; | |
| 8045 | elem.setAttribute( "type", value ); | |
| 8046 | if ( val ) { | |
| 8047 | elem.value = val; | |
| 8048 | } | |
| 8049 | return value; | |
| 8050 | } | |
| 8051 | } | |
| 8052 | } | |
| 8053 | }, | |
| 8054 | ||
| 8055 | removeAttr: function( elem, value ) { | |
| 8056 | var name, | |
| 8057 | i = 0, | |
| 8058 | ||
| 8059 | // Attribute names can contain non-HTML whitespace characters | |
| 8060 | // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 | |
| 8061 | attrNames = value && value.match( rnothtmlwhite ); | |
| 8062 | ||
| 8063 | if ( attrNames && elem.nodeType === 1 ) { | |
| 8064 | while ( ( name = attrNames[ i++ ] ) ) { | |
| 8065 | elem.removeAttribute( name ); | |
| 8066 | } | |
| 8067 | } | |
| 8068 | } | |
| 8069 | } ); | |
| 8070 | ||
| 8071 | // Hooks for boolean attributes | |
| 8072 | boolHook = { | |
| 8073 | set: function( elem, value, name ) { | |
| 8074 | if ( value === false ) { | |
| 8075 | ||
| 8076 | // Remove boolean attributes when set to false | |
| 8077 | jQuery.removeAttr( elem, name ); | |
| 8078 | } else { | |
| 8079 | elem.setAttribute( name, name ); | |
| 8080 | } | |
| 8081 | return name; | |
| 8082 | } | |
| 8083 | }; | |
| 8084 | ||
| 8085 | jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { | |
| 8086 | var getter = attrHandle[ name ] || jQuery.find.attr; | |
| 8087 | ||
| 8088 | attrHandle[ name ] = function( elem, name, isXML ) { | |
| 8089 | var ret, handle, | |
| 8090 | lowercaseName = name.toLowerCase(); | |
| 8091 | ||
| 8092 | if ( !isXML ) { | |
| 8093 | ||
| 8094 | // Avoid an infinite loop by temporarily removing this function from the getter | |
| 8095 | handle = attrHandle[ lowercaseName ]; | |
| 8096 | attrHandle[ lowercaseName ] = ret; | |
| 8097 | ret = getter( elem, name, isXML ) != null ? | |
| 8098 | lowercaseName : | |
| 8099 | null; | |
| 8100 | attrHandle[ lowercaseName ] = handle; | |
| 8101 | } | |
| 8102 | return ret; | |
| 8103 | }; | |
| 8104 | } ); | |
| 8105 | ||
| 8106 | ||
| 8107 | ||
| 8108 | ||
| 8109 | var rfocusable = /^(?:input|select|textarea|button)$/i, | |
| 8110 | rclickable = /^(?:a|area)$/i; | |
| 8111 | ||
| 8112 | jQuery.fn.extend( { | |
| 8113 | prop: function( name, value ) { | |
| 8114 | return access( this, jQuery.prop, name, value, arguments.length > 1 ); | |
| 8115 | }, | |
| 8116 | ||
| 8117 | removeProp: function( name ) { | |
| 8118 | return this.each( function() { | |
| 8119 | delete this[ jQuery.propFix[ name ] || name ]; | |
| 8120 | } ); | |
| 8121 | } | |
| 8122 | } ); | |
| 8123 | ||
| 8124 | jQuery.extend( { | |
| 8125 | prop: function( elem, name, value ) { | |
| 8126 | var ret, hooks, | |
| 8127 | nType = elem.nodeType; | |
| 8128 | ||
| 8129 | // Don't get/set properties on text, comment and attribute nodes | |
| 8130 | if ( nType === 3 || nType === 8 || nType === 2 ) { | |
| 8131 | return; | |
| 8132 | } | |
| 8133 | ||
| 8134 | if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { | |
| 8135 | ||
| 8136 | // Fix name and attach hooks | |
| 8137 | name = jQuery.propFix[ name ] || name; | |
| 8138 | hooks = jQuery.propHooks[ name ]; | |
| 8139 | } | |
| 8140 | ||
| 8141 | if ( value !== undefined ) { | |
| 8142 | if ( hooks && "set" in hooks && | |
| 8143 | ( ret = hooks.set( elem, value, name ) ) !== undefined ) { | |
| 8144 | return ret; | |
| 8145 | } | |
| 8146 | ||
| 8147 | return ( elem[ name ] = value ); | |
| 8148 | } | |
| 8149 | ||
| 8150 | if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { | |
| 8151 | return ret; | |
| 8152 | } | |
| 8153 | ||
| 8154 | return elem[ name ]; | |
| 8155 | }, | |
| 8156 | ||
| 8157 | propHooks: { | |
| 8158 | tabIndex: { | |
| 8159 | get: function( elem ) { | |
| 8160 | ||
| 8161 | // Support: IE <=9 - 11 only | |
| 8162 | // elem.tabIndex doesn't always return the | |
| 8163 | // correct value when it hasn't been explicitly set | |
| 8164 | // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ | |
| 8165 | // Use proper attribute retrieval(#12072) | |
| 8166 | var tabindex = jQuery.find.attr( elem, "tabindex" ); | |
| 8167 | ||
| 8168 | if ( tabindex ) { | |
| 8169 | return parseInt( tabindex, 10 ); | |
| 8170 | } | |
| 8171 | ||
| 8172 | if ( | |
| 8173 | rfocusable.test( elem.nodeName ) || | |
| 8174 | rclickable.test( elem.nodeName ) && | |
| 8175 | elem.href | |
| 8176 | ) { | |
| 8177 | return 0; | |
| 8178 | } | |
| 8179 | ||
| 8180 | return -1; | |
| 8181 | } | |
| 8182 | } | |
| 8183 | }, | |
| 8184 | ||
| 8185 | propFix: { | |
| 8186 | "for": "htmlFor", | |
| 8187 | "class": "className" | |
| 8188 | } | |
| 8189 | } ); | |
| 8190 | ||
| 8191 | // Support: IE <=11 only | |
| 8192 | // Accessing the selectedIndex property | |
| 8193 | // forces the browser to respect setting selected | |
| 8194 | // on the option | |
| 8195 | // The getter ensures a default option is selected | |
| 8196 | // when in an optgroup | |
| 8197 | // eslint rule "no-unused-expressions" is disabled for this code | |
| 8198 | // since it considers such accessions noop | |
| 8199 | if ( !support.optSelected ) { | |
| 8200 | jQuery.propHooks.selected = { | |
| 8201 | get: function( elem ) { | |
| 8202 | ||
| 8203 | /* eslint no-unused-expressions: "off" */ | |
| 8204 | ||
| 8205 | var parent = elem.parentNode; | |
| 8206 | if ( parent && parent.parentNode ) { | |
| 8207 | parent.parentNode.selectedIndex; | |
| 8208 | } | |
| 8209 | return null; | |
| 8210 | }, | |
| 8211 | set: function( elem ) { | |
| 8212 | ||
| 8213 | /* eslint no-unused-expressions: "off" */ | |
| 8214 | ||
| 8215 | var parent = elem.parentNode; | |
| 8216 | if ( parent ) { | |
| 8217 | parent.selectedIndex; | |
| 8218 | ||
| 8219 | if ( parent.parentNode ) { | |
| 8220 | parent.parentNode.selectedIndex; | |
| 8221 | } | |
| 8222 | } | |
| 8223 | } | |
| 8224 | }; | |
| 8225 | } | |
| 8226 | ||
| 8227 | jQuery.each( [ | |
| 8228 | "tabIndex", | |
| 8229 | "readOnly", | |
| 8230 | "maxLength", | |
| 8231 | "cellSpacing", | |
| 8232 | "cellPadding", | |
| 8233 | "rowSpan", | |
| 8234 | "colSpan", | |
| 8235 | "useMap", | |
| 8236 | "frameBorder", | |
| 8237 | "contentEditable" | |
| 8238 | ], function() { | |
| 8239 | jQuery.propFix[ this.toLowerCase() ] = this; | |
| 8240 | } ); | |
| 8241 | ||
| 8242 | ||
| 8243 | ||
| 8244 | ||
| 8245 | // Strip and collapse whitespace according to HTML spec | |
| 8246 | // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace | |
| 8247 | function stripAndCollapse( value ) { | |
| 8248 | var tokens = value.match( rnothtmlwhite ) || []; | |
| 8249 | return tokens.join( " " ); | |
| 8250 | } | |
| 8251 | ||
| 8252 | ||
| 8253 | function getClass( elem ) { | |
| 8254 | return elem.getAttribute && elem.getAttribute( "class" ) || ""; | |
| 8255 | } | |
| 8256 | ||
| 8257 | function classesToArray( value ) { | |
| 8258 | if ( Array.isArray( value ) ) { | |
| 8259 | return value; | |
| 8260 | } | |
| 8261 | if ( typeof value === "string" ) { | |
| 8262 | return value.match( rnothtmlwhite ) || []; | |
| 8263 | } | |
| 8264 | return []; | |
| 8265 | } | |
| 8266 | ||
| 8267 | jQuery.fn.extend( { | |
| 8268 | addClass: function( value ) { | |
| 8269 | var classes, elem, cur, curValue, clazz, j, finalValue, | |
| 8270 | i = 0; | |
| 8271 | ||
| 8272 | if ( isFunction( value ) ) { | |
| 8273 | return this.each( function( j ) { | |
| 8274 | jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); | |
| 8275 | } ); | |
| 8276 | } | |
| 8277 | ||
| 8278 | classes = classesToArray( value ); | |
| 8279 | ||
| 8280 | if ( classes.length ) { | |
| 8281 | while ( ( elem = this[ i++ ] ) ) { | |
| 8282 | curValue = getClass( elem ); | |
| 8283 | cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); | |
| 8284 | ||
| 8285 | if ( cur ) { | |
| 8286 | j = 0; | |
| 8287 | while ( ( clazz = classes[ j++ ] ) ) { | |
| 8288 | if ( cur.indexOf( " " + clazz + " " ) < 0 ) { | |
| 8289 | cur += clazz + " "; | |
| 8290 | } | |
| 8291 | } | |
| 8292 | ||
| 8293 | // Only assign if different to avoid unneeded rendering. | |
| 8294 | finalValue = stripAndCollapse( cur ); | |
| 8295 | if ( curValue !== finalValue ) { | |
| 8296 | elem.setAttribute( "class", finalValue ); | |
| 8297 | } | |
| 8298 | } | |
| 8299 | } | |
| 8300 | } | |
| 8301 | ||
| 8302 | return this; | |
| 8303 | }, | |
| 8304 | ||
| 8305 | removeClass: function( value ) { | |
| 8306 | var classes, elem, cur, curValue, clazz, j, finalValue, | |
| 8307 | i = 0; | |
| 8308 | ||
| 8309 | if ( isFunction( value ) ) { | |
| 8310 | return this.each( function( j ) { | |
| 8311 | jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); | |
| 8312 | } ); | |
| 8313 | } | |
| 8314 | ||
| 8315 | if ( !arguments.length ) { | |
| 8316 | return this.attr( "class", "" ); | |
| 8317 | } | |
| 8318 | ||
| 8319 | classes = classesToArray( value ); | |
| 8320 | ||
| 8321 | if ( classes.length ) { | |
| 8322 | while ( ( elem = this[ i++ ] ) ) { | |
| 8323 | curValue = getClass( elem ); | |
| 8324 | ||
| 8325 | // This expression is here for better compressibility (see addClass) | |
| 8326 | cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); | |
| 8327 | ||
| 8328 | if ( cur ) { | |
| 8329 | j = 0; | |
| 8330 | while ( ( clazz = classes[ j++ ] ) ) { | |
| 8331 | ||
| 8332 | // Remove *all* instances | |
| 8333 | while ( cur.indexOf( " " + clazz + " " ) > -1 ) { | |
| 8334 | cur = cur.replace( " " + clazz + " ", " " ); | |
| 8335 | } | |
| 8336 | } | |
| 8337 | ||
| 8338 | // Only assign if different to avoid unneeded rendering. | |
| 8339 | finalValue = stripAndCollapse( cur ); | |
| 8340 | if ( curValue !== finalValue ) { | |
| 8341 | elem.setAttribute( "class", finalValue ); | |
| 8342 | } | |
| 8343 | } | |
| 8344 | } | |
| 8345 | } | |
| 8346 | ||
| 8347 | return this; | |
| 8348 | }, | |
| 8349 | ||
| 8350 | toggleClass: function( value, stateVal ) { | |
| 8351 | var type = typeof value, | |
| 8352 | isValidValue = type === "string" || Array.isArray( value ); | |
| 8353 | ||
| 8354 | if ( typeof stateVal === "boolean" && isValidValue ) { | |
| 8355 | return stateVal ? this.addClass( value ) : this.removeClass( value ); | |
| 8356 | } | |
| 8357 | ||
| 8358 | if ( isFunction( value ) ) { | |
| 8359 | return this.each( function( i ) { | |
| 8360 | jQuery( this ).toggleClass( | |
| 8361 | value.call( this, i, getClass( this ), stateVal ), | |
| 8362 | stateVal | |
| 8363 | ); | |
| 8364 | } ); | |
| 8365 | } | |
| 8366 | ||
| 8367 | return this.each( function() { | |
| 8368 | var className, i, self, classNames; | |
| 8369 | ||
| 8370 | if ( isValidValue ) { | |
| 8371 | ||
| 8372 | // Toggle individual class names | |
| 8373 | i = 0; | |
| 8374 | self = jQuery( this ); | |
| 8375 | classNames = classesToArray( value ); | |
| 8376 | ||
| 8377 | while ( ( className = classNames[ i++ ] ) ) { | |
| 8378 | ||
| 8379 | // Check each className given, space separated list | |
| 8380 | if ( self.hasClass( className ) ) { | |
| 8381 | self.removeClass( className ); | |
| 8382 | } else { | |
| 8383 | self.addClass( className ); | |
| 8384 | } | |
| 8385 | } | |
| 8386 | ||
| 8387 | // Toggle whole class name | |
| 8388 | } else if ( value === undefined || type === "boolean" ) { | |
| 8389 | className = getClass( this ); | |
| 8390 | if ( className ) { | |
| 8391 | ||
| 8392 | // Store className if set | |
| 8393 | dataPriv.set( this, "__className__", className ); | |
| 8394 | } | |
| 8395 | ||
| 8396 | // If the element has a class name or if we're passed `false`, | |
| 8397 | // then remove the whole classname (if there was one, the above saved it). | |
| 8398 | // Otherwise bring back whatever was previously saved (if anything), | |
| 8399 | // falling back to the empty string if nothing was stored. | |
| 8400 | if ( this.setAttribute ) { | |
| 8401 | this.setAttribute( "class", | |
| 8402 | className || value === false ? | |
| 8403 | "" : | |
| 8404 | dataPriv.get( this, "__className__" ) || "" | |
| 8405 | ); | |
| 8406 | } | |
| 8407 | } | |
| 8408 | } ); | |
| 8409 | }, | |
| 8410 | ||
| 8411 | hasClass: function( selector ) { | |
| 8412 | var className, elem, | |
| 8413 | i = 0; | |
| 8414 | ||
| 8415 | className = " " + selector + " "; | |
| 8416 | while ( ( elem = this[ i++ ] ) ) { | |
| 8417 | if ( elem.nodeType === 1 && | |
| 8418 | ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { | |
| 8419 | return true; | |
| 8420 | } | |
| 8421 | } | |
| 8422 | ||
| 8423 | return false; | |
| 8424 | } | |
| 8425 | } ); | |
| 8426 | ||
| 8427 | ||
| 8428 | ||
| 8429 | ||
| 8430 | var rreturn = /\r/g; | |
| 8431 | ||
| 8432 | jQuery.fn.extend( { | |
| 8433 | val: function( value ) { | |
| 8434 | var hooks, ret, valueIsFunction, | |
| 8435 | elem = this[ 0 ]; | |
| 8436 | ||
| 8437 | if ( !arguments.length ) { | |
| 8438 | if ( elem ) { | |
| 8439 | hooks = jQuery.valHooks[ elem.type ] || | |
| 8440 | jQuery.valHooks[ elem.nodeName.toLowerCase() ]; | |
| 8441 | ||
| 8442 | if ( hooks && | |
| 8443 | "get" in hooks && | |
| 8444 | ( ret = hooks.get( elem, "value" ) ) !== undefined | |
| 8445 | ) { | |
| 8446 | return ret; | |
| 8447 | } | |
| 8448 | ||
| 8449 | ret = elem.value; | |
| 8450 | ||
| 8451 | // Handle most common string cases | |
| 8452 | if ( typeof ret === "string" ) { | |
| 8453 | return ret.replace( rreturn, "" ); | |
| 8454 | } | |
| 8455 | ||
| 8456 | // Handle cases where value is null/undef or number | |
| 8457 | return ret == null ? "" : ret; | |
| 8458 | } | |
| 8459 | ||
| 8460 | return; | |
| 8461 | } | |
| 8462 | ||
| 8463 | valueIsFunction = isFunction( value ); | |
| 8464 | ||
| 8465 | return this.each( function( i ) { | |
| 8466 | var val; | |
| 8467 | ||
| 8468 | if ( this.nodeType !== 1 ) { | |
| 8469 | return; | |
| 8470 | } | |
| 8471 | ||
| 8472 | if ( valueIsFunction ) { | |
| 8473 | val = value.call( this, i, jQuery( this ).val() ); | |
| 8474 | } else { | |
| 8475 | val = value; | |
| 8476 | } | |
| 8477 | ||
| 8478 | // Treat null/undefined as ""; convert numbers to string | |
| 8479 | if ( val == null ) { | |
| 8480 | val = ""; | |
| 8481 | ||
| 8482 | } else if ( typeof val === "number" ) { | |
| 8483 | val += ""; | |
| 8484 | ||
| 8485 | } else if ( Array.isArray( val ) ) { | |
| 8486 | val = jQuery.map( val, function( value ) { | |
| 8487 | return value == null ? "" : value + ""; | |
| 8488 | } ); | |
| 8489 | } | |
| 8490 | ||
| 8491 | hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; | |
| 8492 | ||
| 8493 | // If set returns undefined, fall back to normal setting | |
| 8494 | if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { | |
| 8495 | this.value = val; | |
| 8496 | } | |
| 8497 | } ); | |
| 8498 | } | |
| 8499 | } ); | |
| 8500 | ||
| 8501 | jQuery.extend( { | |
| 8502 | valHooks: { | |
| 8503 | option: { | |
| 8504 | get: function( elem ) { | |
| 8505 | ||
| 8506 | var val = jQuery.find.attr( elem, "value" ); | |
| 8507 | return val != null ? | |
| 8508 | val : | |
| 8509 | ||
| 8510 | // Support: IE <=10 - 11 only | |
| 8511 | // option.text throws exceptions (#14686, #14858) | |
| 8512 | // Strip and collapse whitespace | |
| 8513 | // https://html.spec.whatwg.org/#strip-and-collapse-whitespace | |
| 8514 | stripAndCollapse( jQuery.text( elem ) ); | |
| 8515 | } | |
| 8516 | }, | |
| 8517 | select: { | |
| 8518 | get: function( elem ) { | |
| 8519 | var value, option, i, | |
| 8520 | options = elem.options, | |
| 8521 | index = elem.selectedIndex, | |
| 8522 | one = elem.type === "select-one", | |
| 8523 | values = one ? null : [], | |
| 8524 | max = one ? index + 1 : options.length; | |
| 8525 | ||
| 8526 | if ( index < 0 ) { | |
| 8527 | i = max; | |
| 8528 | ||
| 8529 | } else { | |
| 8530 | i = one ? index : 0; | |
| 8531 | } | |
| 8532 | ||
| 8533 | // Loop through all the selected options | |
| 8534 | for ( ; i < max; i++ ) { | |
| 8535 | option = options[ i ]; | |
| 8536 | ||
| 8537 | // Support: IE <=9 only | |
| 8538 | // IE8-9 doesn't update selected after form reset (#2551) | |
| 8539 | if ( ( option.selected || i === index ) && | |
| 8540 | ||
| 8541 | // Don't return options that are disabled or in a disabled optgroup | |
| 8542 | !option.disabled && | |
| 8543 | ( !option.parentNode.disabled || | |
| 8544 | !nodeName( option.parentNode, "optgroup" ) ) ) { | |
| 8545 | ||
| 8546 | // Get the specific value for the option | |
| 8547 | value = jQuery( option ).val(); | |
| 8548 | ||
| 8549 | // We don't need an array for one selects | |
| 8550 | if ( one ) { | |
| 8551 | return value; | |
| 8552 | } | |
| 8553 | ||
| 8554 | // Multi-Selects return an array | |
| 8555 | values.push( value ); | |
| 8556 | } | |
| 8557 | } | |
| 8558 | ||
| 8559 | return values; | |
| 8560 | }, | |
| 8561 | ||
| 8562 | set: function( elem, value ) { | |
| 8563 | var optionSet, option, | |
| 8564 | options = elem.options, | |
| 8565 | values = jQuery.makeArray( value ), | |
| 8566 | i = options.length; | |
| 8567 | ||
| 8568 | while ( i-- ) { | |
| 8569 | option = options[ i ]; | |
| 8570 | ||
| 8571 | /* eslint-disable no-cond-assign */ | |
| 8572 | ||
| 8573 | if ( option.selected = | |
| 8574 | jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 | |
| 8575 | ) { | |
| 8576 | optionSet = true; | |
| 8577 | } | |
| 8578 | ||
| 8579 | /* eslint-enable no-cond-assign */ | |
| 8580 | } | |
| 8581 | ||
| 8582 | // Force browsers to behave consistently when non-matching value is set | |
| 8583 | if ( !optionSet ) { | |
| 8584 | elem.selectedIndex = -1; | |
| 8585 | } | |
| 8586 | return values; | |
| 8587 | } | |
| 8588 | } | |
| 8589 | } | |
| 8590 | } ); | |
| 8591 | ||
| 8592 | // Radios and checkboxes getter/setter | |
| 8593 | jQuery.each( [ "radio", "checkbox" ], function() { | |
| 8594 | jQuery.valHooks[ this ] = { | |
| 8595 | set: function( elem, value ) { | |
| 8596 | if ( Array.isArray( value ) ) { | |
| 8597 | return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); | |
| 8598 | } | |
| 8599 | } | |
| 8600 | }; | |
| 8601 | if ( !support.checkOn ) { | |
| 8602 | jQuery.valHooks[ this ].get = function( elem ) { | |
| 8603 | return elem.getAttribute( "value" ) === null ? "on" : elem.value; | |
| 8604 | }; | |
| 8605 | } | |
| 8606 | } ); | |
| 8607 | ||
| 8608 | ||
| 8609 | ||
| 8610 | ||
| 8611 | // Return jQuery for attributes-only inclusion | |
| 8612 | ||
| 8613 | ||
| 8614 | support.focusin = "onfocusin" in window; | |
| 8615 | ||
| 8616 | ||
| 8617 | var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, | |
| 8618 | stopPropagationCallback = function( e ) { | |
| 8619 | e.stopPropagation(); | |
| 8620 | }; | |
| 8621 | ||
| 8622 | jQuery.extend( jQuery.event, { | |
| 8623 | ||
| 8624 | trigger: function( event, data, elem, onlyHandlers ) { | |
| 8625 | ||
| 8626 | var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, | |
| 8627 | eventPath = [ elem || document ], | |
| 8628 | type = hasOwn.call( event, "type" ) ? event.type : event, | |
| 8629 | namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; | |
| 8630 | ||
| 8631 | cur = lastElement = tmp = elem = elem || document; | |
| 8632 | ||
| 8633 | // Don't do events on text and comment nodes | |
| 8634 | if ( elem.nodeType === 3 || elem.nodeType === 8 ) { | |
| 8635 | return; | |
| 8636 | } | |
| 8637 | ||
| 8638 | // focus/blur morphs to focusin/out; ensure we're not firing them right now | |
| 8639 | if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { | |
| 8640 | return; | |
| 8641 | } | |
| 8642 | ||
| 8643 | if ( type.indexOf( "." ) > -1 ) { | |
| 8644 | ||
| 8645 | // Namespaced trigger; create a regexp to match event type in handle() | |
| 8646 | namespaces = type.split( "." ); | |
| 8647 | type = namespaces.shift(); | |
| 8648 | namespaces.sort(); | |
| 8649 | } | |
| 8650 | ontype = type.indexOf( ":" ) < 0 && "on" + type; | |
| 8651 | ||
| 8652 | // Caller can pass in a jQuery.Event object, Object, or just an event type string | |
| 8653 | event = event[ jQuery.expando ] ? | |
| 8654 | event : | |
| 8655 | new jQuery.Event( type, typeof event === "object" && event ); | |
| 8656 | ||
| 8657 | // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) | |
| 8658 | event.isTrigger = onlyHandlers ? 2 : 3; | |
| 8659 | event.namespace = namespaces.join( "." ); | |
| 8660 | event.rnamespace = event.namespace ? | |
| 8661 | new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : | |
| 8662 | null; | |
| 8663 | ||
| 8664 | // Clean up the event in case it is being reused | |
| 8665 | event.result = undefined; | |
| 8666 | if ( !event.target ) { | |
| 8667 | event.target = elem; | |
| 8668 | } | |
| 8669 | ||
| 8670 | // Clone any incoming data and prepend the event, creating the handler arg list | |
| 8671 | data = data == null ? | |
| 8672 | [ event ] : | |
| 8673 | jQuery.makeArray( data, [ event ] ); | |
| 8674 | ||
| 8675 | // Allow special events to draw outside the lines | |
| 8676 | special = jQuery.event.special[ type ] || {}; | |
| 8677 | if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { | |
| 8678 | return; | |
| 8679 | } | |
| 8680 | ||
| 8681 | // Determine event propagation path in advance, per W3C events spec (#9951) | |
| 8682 | // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) | |
| 8683 | if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { | |
| 8684 | ||
| 8685 | bubbleType = special.delegateType || type; | |
| 8686 | if ( !rfocusMorph.test( bubbleType + type ) ) { | |
| 8687 | cur = cur.parentNode; | |
| 8688 | } | |
| 8689 | for ( ; cur; cur = cur.parentNode ) { | |
| 8690 | eventPath.push( cur ); | |
| 8691 | tmp = cur; | |
| 8692 | } | |
| 8693 | ||
| 8694 | // Only add window if we got to document (e.g., not plain obj or detached DOM) | |
| 8695 | if ( tmp === ( elem.ownerDocument || document ) ) { | |
| 8696 | eventPath.push( tmp.defaultView || tmp.parentWindow || window ); | |
| 8697 | } | |
| 8698 | } | |
| 8699 | ||
| 8700 | // Fire handlers on the event path | |
| 8701 | i = 0; | |
| 8702 | while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { | |
| 8703 | lastElement = cur; | |
| 8704 | event.type = i > 1 ? | |
| 8705 | bubbleType : | |
| 8706 | special.bindType || type; | |
| 8707 | ||
| 8708 | // jQuery handler | |
| 8709 | handle = ( | |
| 8710 | dataPriv.get( cur, "events" ) || Object.create( null ) | |
| 8711 | )[ event.type ] && | |
| 8712 | dataPriv.get( cur, "handle" ); | |
| 8713 | if ( handle ) { | |
| 8714 | handle.apply( cur, data ); | |
| 8715 | } | |
| 8716 | ||
| 8717 | // Native handler | |
| 8718 | handle = ontype && cur[ ontype ]; | |
| 8719 | if ( handle && handle.apply && acceptData( cur ) ) { | |
| 8720 | event.result = handle.apply( cur, data ); | |
| 8721 | if ( event.result === false ) { | |
| 8722 | event.preventDefault(); | |
| 8723 | } | |
| 8724 | } | |
| 8725 | } | |
| 8726 | event.type = type; | |
| 8727 | ||
| 8728 | // If nobody prevented the default action, do it now | |
| 8729 | if ( !onlyHandlers && !event.isDefaultPrevented() ) { | |
| 8730 | ||
| 8731 | if ( ( !special._default || | |
| 8732 | special._default.apply( eventPath.pop(), data ) === false ) && | |
| 8733 | acceptData( elem ) ) { | |
| 8734 | ||
| 8735 | // Call a native DOM method on the target with the same name as the event. | |
| 8736 | // Don't do default actions on window, that's where global variables be (#6170) | |
| 8737 | if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { | |
| 8738 | ||
| 8739 | // Don't re-trigger an onFOO event when we call its FOO() method | |
| 8740 | tmp = elem[ ontype ]; | |
| 8741 | ||
| 8742 | if ( tmp ) { | |
| 8743 | elem[ ontype ] = null; | |
| 8744 | } | |
| 8745 | ||
| 8746 | // Prevent re-triggering of the same event, since we already bubbled it above | |
| 8747 | jQuery.event.triggered = type; | |
| 8748 | ||
| 8749 | if ( event.isPropagationStopped() ) { | |
| 8750 | lastElement.addEventListener( type, stopPropagationCallback ); | |
| 8751 | } | |
| 8752 | ||
| 8753 | elem[ type ](); | |
| 8754 | ||
| 8755 | if ( event.isPropagationStopped() ) { | |
| 8756 | lastElement.removeEventListener( type, stopPropagationCallback ); | |
| 8757 | } | |
| 8758 | ||
| 8759 | jQuery.event.triggered = undefined; | |
| 8760 | ||
| 8761 | if ( tmp ) { | |
| 8762 | elem[ ontype ] = tmp; | |
| 8763 | } | |
| 8764 | } | |
| 8765 | } | |
| 8766 | } | |
| 8767 | ||
| 8768 | return event.result; | |
| 8769 | }, | |
| 8770 | ||
| 8771 | // Piggyback on a donor event to simulate a different one | |
| 8772 | // Used only for `focus(in | out)` events | |
| 8773 | simulate: function( type, elem, event ) { | |
| 8774 | var e = jQuery.extend( | |
| 8775 | new jQuery.Event(), | |
| 8776 | event, | |
| 8777 | { | |
| 8778 | type: type, | |
| 8779 | isSimulated: true | |
| 8780 | } | |
| 8781 | ); | |
| 8782 | ||
| 8783 | jQuery.event.trigger( e, null, elem ); | |
| 8784 | } | |
| 8785 | ||
| 8786 | } ); | |
| 8787 | ||
| 8788 | jQuery.fn.extend( { | |
| 8789 | ||
| 8790 | trigger: function( type, data ) { | |
| 8791 | return this.each( function() { | |
| 8792 | jQuery.event.trigger( type, data, this ); | |
| 8793 | } ); | |
| 8794 | }, | |
| 8795 | triggerHandler: function( type, data ) { | |
| 8796 | var elem = this[ 0 ]; | |
| 8797 | if ( elem ) { | |
| 8798 | return jQuery.event.trigger( type, data, elem, true ); | |
| 8799 | } | |
| 8800 | } | |
| 8801 | } ); | |
| 8802 | ||
| 8803 | ||
| 8804 | // Support: Firefox <=44 | |
| 8805 | // Firefox doesn't have focus(in | out) events | |
| 8806 | // Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 | |
| 8807 | // | |
| 8808 | // Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 | |
| 8809 | // focus(in | out) events fire after focus & blur events, | |
| 8810 | // which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order | |
| 8811 | // Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 | |
| 8812 | if ( !support.focusin ) { | |
| 8813 | jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { | |
| 8814 | ||
| 8815 | // Attach a single capturing handler on the document while someone wants focusin/focusout | |
| 8816 | var handler = function( event ) { | |
| 8817 | jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); | |
| 8818 | }; | |
| 8819 | ||
| 8820 | jQuery.event.special[ fix ] = { | |
| 8821 | setup: function() { | |
| 8822 | ||
| 8823 | // Handle: regular nodes (via `this.ownerDocument`), window | |
| 8824 | // (via `this.document`) & document (via `this`). | |
| 8825 | var doc = this.ownerDocument || this.document || this, | |
| 8826 | attaches = dataPriv.access( doc, fix ); | |
| 8827 | ||
| 8828 | if ( !attaches ) { | |
| 8829 | doc.addEventListener( orig, handler, true ); | |
| 8830 | } | |
| 8831 | dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); | |
| 8832 | }, | |
| 8833 | teardown: function() { | |
| 8834 | var doc = this.ownerDocument || this.document || this, | |
| 8835 | attaches = dataPriv.access( doc, fix ) - 1; | |
| 8836 | ||
| 8837 | if ( !attaches ) { | |
| 8838 | doc.removeEventListener( orig, handler, true ); | |
| 8839 | dataPriv.remove( doc, fix ); | |
| 8840 | ||
| 8841 | } else { | |
| 8842 | dataPriv.access( doc, fix, attaches ); | |
| 8843 | } | |
| 8844 | } | |
| 8845 | }; | |
| 8846 | } ); | |
| 8847 | } | |
| 8848 | var location = window.location; | |
| 8849 | ||
| 8850 | var nonce = { guid: Date.now() }; | |
| 8851 | ||
| 8852 | var rquery = ( /\?/ ); | |
| 8853 | ||
| 8854 | ||
| 8855 | ||
| 8856 | // Cross-browser xml parsing | |
| 8857 | jQuery.parseXML = function( data ) { | |
| 8858 | var xml; | |
| 8859 | if ( !data || typeof data !== "string" ) { | |
| 8860 | return null; | |
| 8861 | } | |
| 8862 | ||
| 8863 | // Support: IE 9 - 11 only | |
| 8864 | // IE throws on parseFromString with invalid input. | |
| 8865 | try { | |
| 8866 | xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); | |
| 8867 | } catch ( e ) { | |
| 8868 | xml = undefined; | |
| 8869 | } | |
| 8870 | ||
| 8871 | if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { | |
| 8872 | jQuery.error( "Invalid XML: " + data ); | |
| 8873 | } | |
| 8874 | return xml; | |
| 8875 | }; | |
| 8876 | ||
| 8877 | ||
| 8878 | var | |
| 8879 | rbracket = /\[\]$/, | |
| 8880 | rCRLF = /\r?\n/g, | |
| 8881 | rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, | |
| 8882 | rsubmittable = /^(?:input|select|textarea|keygen)/i; | |
| 8883 | ||
| 8884 | function buildParams( prefix, obj, traditional, add ) { | |
| 8885 | var name; | |
| 8886 | ||
| 8887 | if ( Array.isArray( obj ) ) { | |
| 8888 | ||
| 8889 | // Serialize array item. | |
| 8890 | jQuery.each( obj, function( i, v ) { | |
| 8891 | if ( traditional || rbracket.test( prefix ) ) { | |
| 8892 | ||
| 8893 | // Treat each array item as a scalar. | |
| 8894 | add( prefix, v ); | |
| 8895 | ||
| 8896 | } else { | |
| 8897 | ||
| 8898 | // Item is non-scalar (array or object), encode its numeric index. | |
| 8899 | buildParams( | |
| 8900 | prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", | |
| 8901 | v, | |
| 8902 | traditional, | |
| 8903 | add | |
| 8904 | ); | |
| 8905 | } | |
| 8906 | } ); | |
| 8907 | ||
| 8908 | } else if ( !traditional && toType( obj ) === "object" ) { | |
| 8909 | ||
| 8910 | // Serialize object item. | |
| 8911 | for ( name in obj ) { | |
| 8912 | buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); | |
| 8913 | } | |
| 8914 | ||
| 8915 | } else { | |
| 8916 | ||
| 8917 | // Serialize scalar item. | |
| 8918 | add( prefix, obj ); | |
| 8919 | } | |
| 8920 | } | |
| 8921 | ||
| 8922 | // Serialize an array of form elements or a set of | |
| 8923 | // key/values into a query string | |
| 8924 | jQuery.param = function( a, traditional ) { | |
| 8925 | var prefix, | |
| 8926 | s = [], | |
| 8927 | add = function( key, valueOrFunction ) { | |
| 8928 | ||
| 8929 | // If value is a function, invoke it and use its return value | |
| 8930 | var value = isFunction( valueOrFunction ) ? | |
| 8931 | valueOrFunction() : | |
| 8932 | valueOrFunction; | |
| 8933 | ||
| 8934 | s[ s.length ] = encodeURIComponent( key ) + "=" + | |
| 8935 | encodeURIComponent( value == null ? "" : value ); | |
| 8936 | }; | |
| 8937 | ||
| 8938 | if ( a == null ) { | |
| 8939 | return ""; | |
| 8940 | } | |
| 8941 | ||
| 8942 | // If an array was passed in, assume that it is an array of form elements. | |
| 8943 | if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { | |
| 8944 | ||
| 8945 | // Serialize the form elements | |
| 8946 | jQuery.each( a, function() { | |
| 8947 | add( this.name, this.value ); | |
| 8948 | } ); | |
| 8949 | ||
| 8950 | } else { | |
| 8951 | ||
| 8952 | // If traditional, encode the "old" way (the way 1.3.2 or older | |
| 8953 | // did it), otherwise encode params recursively. | |
| 8954 | for ( prefix in a ) { | |
| 8955 | buildParams( prefix, a[ prefix ], traditional, add ); | |
| 8956 | } | |
| 8957 | } | |
| 8958 | ||
| 8959 | // Return the resulting serialization | |
| 8960 | return s.join( "&" ); | |
| 8961 | }; | |
| 8962 | ||
| 8963 | jQuery.fn.extend( { | |
| 8964 | serialize: function() { | |
| 8965 | return jQuery.param( this.serializeArray() ); | |
| 8966 | }, | |
| 8967 | serializeArray: function() { | |
| 8968 | return this.map( function() { | |
| 8969 | ||
| 8970 | // Can add propHook for "elements" to filter or add form elements | |
| 8971 | var elements = jQuery.prop( this, "elements" ); | |
| 8972 | return elements ? jQuery.makeArray( elements ) : this; | |
| 8973 | } ) | |
| 8974 | .filter( function() { | |
| 8975 | var type = this.type; | |
| 8976 | ||
| 8977 | // Use .is( ":disabled" ) so that fieldset[disabled] works | |
| 8978 | return this.name && !jQuery( this ).is( ":disabled" ) && | |
| 8979 | rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && | |
| 8980 | ( this.checked || !rcheckableType.test( type ) ); | |
| 8981 | } ) | |
| 8982 | .map( function( _i, elem ) { | |
| 8983 | var val = jQuery( this ).val(); | |
| 8984 | ||
| 8985 | if ( val == null ) { | |
| 8986 | return null; | |
| 8987 | } | |
| 8988 | ||
| 8989 | if ( Array.isArray( val ) ) { | |
| 8990 | return jQuery.map( val, function( val ) { | |
| 8991 | return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; | |
| 8992 | } ); | |
| 8993 | } | |
| 8994 | ||
| 8995 | return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; | |
| 8996 | } ).get(); | |
| 8997 | } | |
| 8998 | } ); | |
| 8999 | ||
| 9000 | ||
| 9001 | var | |
| 9002 | r20 = /%20/g, | |
| 9003 | rhash = /#.*$/, | |
| 9004 | rantiCache = /([?&])_=[^&]*/, | |
| 9005 | rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, | |
| 9006 | ||
| 9007 | // #7653, #8125, #8152: local protocol detection | |
| 9008 | rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, | |
| 9009 | rnoContent = /^(?:GET|HEAD)$/, | |
| 9010 | rprotocol = /^\/\//, | |
| 9011 | ||
| 9012 | /* Prefilters | |
| 9013 | * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) | |
| 9014 | * 2) These are called: | |
| 9015 | * - BEFORE asking for a transport | |
| 9016 | * - AFTER param serialization (s.data is a string if s.processData is true) | |
| 9017 | * 3) key is the dataType | |
| 9018 | * 4) the catchall symbol "*" can be used | |
| 9019 | * 5) execution will start with transport dataType and THEN continue down to "*" if needed | |
| 9020 | */ | |
| 9021 | prefilters = {}, | |
| 9022 | ||
| 9023 | /* Transports bindings | |
| 9024 | * 1) key is the dataType | |
| 9025 | * 2) the catchall symbol "*" can be used | |
| 9026 | * 3) selection will start with transport dataType and THEN go to "*" if needed | |
| 9027 | */ | |
| 9028 | transports = {}, | |
| 9029 | ||
| 9030 | // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression | |
| 9031 | allTypes = "*/".concat( "*" ), | |
| 9032 | ||
| 9033 | // Anchor tag for parsing the document origin | |
| 9034 | originAnchor = document.createElement( "a" ); | |
| 9035 | originAnchor.href = location.href; | |
| 9036 | ||
| 9037 | // Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport | |
| 9038 | function addToPrefiltersOrTransports( structure ) { | |
| 9039 | ||
| 9040 | // dataTypeExpression is optional and defaults to "*" | |
| 9041 | return function( dataTypeExpression, func ) { | |
| 9042 | ||
| 9043 | if ( typeof dataTypeExpression !== "string" ) { | |
| 9044 | func = dataTypeExpression; | |
| 9045 | dataTypeExpression = "*"; | |
| 9046 | } | |
| 9047 | ||
| 9048 | var dataType, | |
| 9049 | i = 0, | |
| 9050 | dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; | |
| 9051 | ||
| 9052 | if ( isFunction( func ) ) { | |
| 9053 | ||
| 9054 | // For each dataType in the dataTypeExpression | |
| 9055 | while ( ( dataType = dataTypes[ i++ ] ) ) { | |
| 9056 | ||
| 9057 | // Prepend if requested | |
| 9058 | if ( dataType[ 0 ] === "+" ) { | |
| 9059 | dataType = dataType.slice( 1 ) || "*"; | |
| 9060 | ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); | |
| 9061 | ||
| 9062 | // Otherwise append | |
| 9063 | } else { | |
| 9064 | ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); | |
| 9065 | } | |
| 9066 | } | |
| 9067 | } | |
| 9068 | }; | |
| 9069 | } | |
| 9070 | ||
| 9071 | // Base inspection function for prefilters and transports | |
| 9072 | function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { | |
| 9073 | ||
| 9074 | var inspected = {}, | |
| 9075 | seekingTransport = ( structure === transports ); | |
| 9076 | ||
| 9077 | function inspect( dataType ) { | |
| 9078 | var selected; | |
| 9079 | inspected[ dataType ] = true; | |
| 9080 | jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { | |
| 9081 | var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); | |
| 9082 | if ( typeof dataTypeOrTransport === "string" && | |
| 9083 | !seekingTransport && !inspected[ dataTypeOrTransport ] ) { | |
| 9084 | ||
| 9085 | options.dataTypes.unshift( dataTypeOrTransport ); | |
| 9086 | inspect( dataTypeOrTransport ); | |
| 9087 | return false; | |
| 9088 | } else if ( seekingTransport ) { | |
| 9089 | return !( selected = dataTypeOrTransport ); | |
| 9090 | } | |
| 9091 | } ); | |
| 9092 | return selected; | |
| 9093 | } | |
| 9094 | ||
| 9095 | return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); | |
| 9096 | } | |
| 9097 | ||
| 9098 | // A special extend for ajax options | |
| 9099 | // that takes "flat" options (not to be deep extended) | |
| 9100 | // Fixes #9887 | |
| 9101 | function ajaxExtend( target, src ) { | |
| 9102 | var key, deep, | |
| 9103 | flatOptions = jQuery.ajaxSettings.flatOptions || {}; | |
| 9104 | ||
| 9105 | for ( key in src ) { | |
| 9106 | if ( src[ key ] !== undefined ) { | |
| 9107 | ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; | |
| 9108 | } | |
| 9109 | } | |
| 9110 | if ( deep ) { | |
| 9111 | jQuery.extend( true, target, deep ); | |
| 9112 | } | |
| 9113 | ||
| 9114 | return target; | |
| 9115 | } | |
| 9116 | ||
| 9117 | /* Handles responses to an ajax request: | |
| 9118 | * - finds the right dataType (mediates between content-type and expected dataType) | |
| 9119 | * - returns the corresponding response | |
| 9120 | */ | |
| 9121 | function ajaxHandleResponses( s, jqXHR, responses ) { | |
| 9122 | ||
| 9123 | var ct, type, finalDataType, firstDataType, | |
| 9124 | contents = s.contents, | |
| 9125 | dataTypes = s.dataTypes; | |
| 9126 | ||
| 9127 | // Remove auto dataType and get content-type in the process | |
| 9128 | while ( dataTypes[ 0 ] === "*" ) { | |
| 9129 | dataTypes.shift(); | |
| 9130 | if ( ct === undefined ) { | |
| 9131 | ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); | |
| 9132 | } | |
| 9133 | } | |
| 9134 | ||
| 9135 | // Check if we're dealing with a known content-type | |
| 9136 | if ( ct ) { | |
| 9137 | for ( type in contents ) { | |
| 9138 | if ( contents[ type ] && contents[ type ].test( ct ) ) { | |
| 9139 | dataTypes.unshift( type ); | |
| 9140 | break; | |
| 9141 | } | |
| 9142 | } | |
| 9143 | } | |
| 9144 | ||
| 9145 | // Check to see if we have a response for the expected dataType | |
| 9146 | if ( dataTypes[ 0 ] in responses ) { | |
| 9147 | finalDataType = dataTypes[ 0 ]; | |
| 9148 | } else { | |
| 9149 | ||
| 9150 | // Try convertible dataTypes | |
| 9151 | for ( type in responses ) { | |
| 9152 | if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { | |
| 9153 | finalDataType = type; | |
| 9154 | break; | |
| 9155 | } | |
| 9156 | if ( !firstDataType ) { | |
| 9157 | firstDataType = type; | |
| 9158 | } | |
| 9159 | } | |
| 9160 | ||
| 9161 | // Or just use first one | |
| 9162 | finalDataType = finalDataType || firstDataType; | |
| 9163 | } | |
| 9164 | ||
| 9165 | // If we found a dataType | |
| 9166 | // We add the dataType to the list if needed | |
| 9167 | // and return the corresponding response | |
| 9168 | if ( finalDataType ) { | |
| 9169 | if ( finalDataType !== dataTypes[ 0 ] ) { | |
| 9170 | dataTypes.unshift( finalDataType ); | |
| 9171 | } | |
| 9172 | return responses[ finalDataType ]; | |
| 9173 | } | |
| 9174 | } | |
| 9175 | ||
| 9176 | /* Chain conversions given the request and the original response | |
| 9177 | * Also sets the responseXXX fields on the jqXHR instance | |
| 9178 | */ | |
| 9179 | function ajaxConvert( s, response, jqXHR, isSuccess ) { | |
| 9180 | var conv2, current, conv, tmp, prev, | |
| 9181 | converters = {}, | |
| 9182 | ||
| 9183 | // Work with a copy of dataTypes in case we need to modify it for conversion | |
| 9184 | dataTypes = s.dataTypes.slice(); | |
| 9185 | ||
| 9186 | // Create converters map with lowercased keys | |
| 9187 | if ( dataTypes[ 1 ] ) { | |
| 9188 | for ( conv in s.converters ) { | |
| 9189 | converters[ conv.toLowerCase() ] = s.converters[ conv ]; | |
| 9190 | } | |
| 9191 | } | |
| 9192 | ||
| 9193 | current = dataTypes.shift(); | |
| 9194 | ||
| 9195 | // Convert to each sequential dataType | |
| 9196 | while ( current ) { | |
| 9197 | ||
| 9198 | if ( s.responseFields[ current ] ) { | |
| 9199 | jqXHR[ s.responseFields[ current ] ] = response; | |
| 9200 | } | |
| 9201 | ||
| 9202 | // Apply the dataFilter if provided | |
| 9203 | if ( !prev && isSuccess && s.dataFilter ) { | |
| 9204 | response = s.dataFilter( response, s.dataType ); | |
| 9205 | } | |
| 9206 | ||
| 9207 | prev = current; | |
| 9208 | current = dataTypes.shift(); | |
| 9209 | ||
| 9210 | if ( current ) { | |
| 9211 | ||
| 9212 | // There's only work to do if current dataType is non-auto | |
| 9213 | if ( current === "*" ) { | |
| 9214 | ||
| 9215 | current = prev; | |
| 9216 | ||
| 9217 | // Convert response if prev dataType is non-auto and differs from current | |
| 9218 | } else if ( prev !== "*" && prev !== current ) { | |
| 9219 | ||
| 9220 | // Seek a direct converter | |
| 9221 | conv = converters[ prev + " " + current ] || converters[ "* " + current ]; | |
| 9222 | ||
| 9223 | // If none found, seek a pair | |
| 9224 | if ( !conv ) { | |
| 9225 | for ( conv2 in converters ) { | |
| 9226 | ||
| 9227 | // If conv2 outputs current | |
| 9228 | tmp = conv2.split( " " ); | |
| 9229 | if ( tmp[ 1 ] === current ) { | |
| 9230 | ||
| 9231 | // If prev can be converted to accepted input | |
| 9232 | conv = converters[ prev + " " + tmp[ 0 ] ] || | |
| 9233 | converters[ "* " + tmp[ 0 ] ]; | |
| 9234 | if ( conv ) { | |
| 9235 | ||
| 9236 | // Condense equivalence converters | |
| 9237 | if ( conv === true ) { | |
| 9238 | conv = converters[ conv2 ]; | |
| 9239 | ||
| 9240 | // Otherwise, insert the intermediate dataType | |
| 9241 | } else if ( converters[ conv2 ] !== true ) { | |
| 9242 | current = tmp[ 0 ]; | |
| 9243 | dataTypes.unshift( tmp[ 1 ] ); | |
| 9244 | } | |
| 9245 | break; | |
| 9246 | } | |
| 9247 | } | |
| 9248 | } | |
| 9249 | } | |
| 9250 | ||
| 9251 | // Apply converter (if not an equivalence) | |
| 9252 | if ( conv !== true ) { | |
| 9253 | ||
| 9254 | // Unless errors are allowed to bubble, catch and return them | |
| 9255 | if ( conv && s.throws ) { | |
| 9256 | response = conv( response ); | |
| 9257 | } else { | |
| 9258 | try { | |
| 9259 | response = conv( response ); | |
| 9260 | } catch ( e ) { | |
| 9261 | return { | |
| 9262 | state: "parsererror", | |
| 9263 | error: conv ? e : "No conversion from " + prev + " to " + current | |
| 9264 | }; | |
| 9265 | } | |
| 9266 | } | |
| 9267 | } | |
| 9268 | } | |
| 9269 | } | |
| 9270 | } | |
| 9271 | ||
| 9272 | return { state: "success", data: response }; | |
| 9273 | } | |
| 9274 | ||
| 9275 | jQuery.extend( { | |
| 9276 | ||
| 9277 | // Counter for holding the number of active queries | |
| 9278 | active: 0, | |
| 9279 | ||
| 9280 | // Last-Modified header cache for next request | |
| 9281 | lastModified: {}, | |
| 9282 | etag: {}, | |
| 9283 | ||
| 9284 | ajaxSettings: { | |
| 9285 | url: location.href, | |
| 9286 | type: "GET", | |
| 9287 | isLocal: rlocalProtocol.test( location.protocol ), | |
| 9288 | global: true, | |
| 9289 | processData: true, | |
| 9290 | async: true, | |
| 9291 | contentType: "application/x-www-form-urlencoded; charset=UTF-8", | |
| 9292 | ||
| 9293 | /* | |
| 9294 | timeout: 0, | |
| 9295 | data: null, | |
| 9296 | dataType: null, | |
| 9297 | username: null, | |
| 9298 | password: null, | |
| 9299 | cache: null, | |
| 9300 | throws: false, | |
| 9301 | traditional: false, | |
| 9302 | headers: {}, | |
| 9303 | */ | |
| 9304 | ||
| 9305 | accepts: { | |
| 9306 | "*": allTypes, | |
| 9307 | text: "text/plain", | |
| 9308 | html: "text/html", | |
| 9309 | xml: "application/xml, text/xml", | |
| 9310 | json: "application/json, text/javascript" | |
| 9311 | }, | |
| 9312 | ||
| 9313 | contents: { | |
| 9314 | xml: /\bxml\b/, | |
| 9315 | html: /\bhtml/, | |
| 9316 | json: /\bjson\b/ | |
| 9317 | }, | |
| 9318 | ||
| 9319 | responseFields: { | |
| 9320 | xml: "responseXML", | |
| 9321 | text: "responseText", | |
| 9322 | json: "responseJSON" | |
| 9323 | }, | |
| 9324 | ||
| 9325 | // Data converters | |
| 9326 | // Keys separate source (or catchall "*") and destination types with a single space | |
| 9327 | converters: { | |
| 9328 | ||
| 9329 | // Convert anything to text | |
| 9330 | "* text": String, | |
| 9331 | ||
| 9332 | // Text to html (true = no transformation) | |
| 9333 | "text html": true, | |
| 9334 | ||
| 9335 | // Evaluate text as a json expression | |
| 9336 | "text json": JSON.parse, | |
| 9337 | ||
| 9338 | // Parse text as xml | |
| 9339 | "text xml": jQuery.parseXML | |
| 9340 | }, | |
| 9341 | ||
| 9342 | // For options that shouldn't be deep extended: | |
| 9343 | // you can add your own custom options here if | |
| 9344 | // and when you create one that shouldn't be | |
| 9345 | // deep extended (see ajaxExtend) | |
| 9346 | flatOptions: { | |
| 9347 | url: true, | |
| 9348 | context: true | |
| 9349 | } | |
| 9350 | }, | |
| 9351 | ||
| 9352 | // Creates a full fledged settings object into target | |
| 9353 | // with both ajaxSettings and settings fields. | |
| 9354 | // If target is omitted, writes into ajaxSettings. | |
| 9355 | ajaxSetup: function( target, settings ) { | |
| 9356 | return settings ? | |
| 9357 | ||
| 9358 | // Building a settings object | |
| 9359 | ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : | |
| 9360 | ||
| 9361 | // Extending ajaxSettings | |
| 9362 | ajaxExtend( jQuery.ajaxSettings, target ); | |
| 9363 | }, | |
| 9364 | ||
| 9365 | ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), | |
| 9366 | ajaxTransport: addToPrefiltersOrTransports( transports ), | |
| 9367 | ||
| 9368 | // Main method | |
| 9369 | ajax: function( url, options ) { | |
| 9370 | ||
| 9371 | // If url is an object, simulate pre-1.5 signature | |
| 9372 | if ( typeof url === "object" ) { | |
| 9373 | options = url; | |
| 9374 | url = undefined; | |
| 9375 | } | |
| 9376 | ||
| 9377 | // Force options to be an object | |
| 9378 | options = options || {}; | |
| 9379 | ||
| 9380 | var transport, | |
| 9381 | ||
| 9382 | // URL without anti-cache param | |
| 9383 | cacheURL, | |
| 9384 | ||
| 9385 | // Response headers | |
| 9386 | responseHeadersString, | |
| 9387 | responseHeaders, | |
| 9388 | ||
| 9389 | // timeout handle | |
| 9390 | timeoutTimer, | |
| 9391 | ||
| 9392 | // Url cleanup var | |
| 9393 | urlAnchor, | |
| 9394 | ||
| 9395 | // Request state (becomes false upon send and true upon completion) | |
| 9396 | completed, | |
| 9397 | ||
| 9398 | // To know if global events are to be dispatched | |
| 9399 | fireGlobals, | |
| 9400 | ||
| 9401 | // Loop variable | |
| 9402 | i, | |
| 9403 | ||
| 9404 | // uncached part of the url | |
| 9405 | uncached, | |
| 9406 | ||
| 9407 | // Create the final options object | |
| 9408 | s = jQuery.ajaxSetup( {}, options ), | |
| 9409 | ||
| 9410 | // Callbacks context | |
| 9411 | callbackContext = s.context || s, | |
| 9412 | ||
| 9413 | // Context for global events is callbackContext if it is a DOM node or jQuery collection | |
| 9414 | globalEventContext = s.context && | |
| 9415 | ( callbackContext.nodeType || callbackContext.jquery ) ? | |
| 9416 | jQuery( callbackContext ) : | |
| 9417 | jQuery.event, | |
| 9418 | ||
| 9419 | // Deferreds | |
| 9420 | deferred = jQuery.Deferred(), | |
| 9421 | completeDeferred = jQuery.Callbacks( "once memory" ), | |
| 9422 | ||
| 9423 | // Status-dependent callbacks | |
| 9424 | statusCode = s.statusCode || {}, | |
| 9425 | ||
| 9426 | // Headers (they are sent all at once) | |
| 9427 | requestHeaders = {}, | |
| 9428 | requestHeadersNames = {}, | |
| 9429 | ||
| 9430 | // Default abort message | |
| 9431 | strAbort = "canceled", | |
| 9432 | ||
| 9433 | // Fake xhr | |
| 9434 | jqXHR = { | |
| 9435 | readyState: 0, | |
| 9436 | ||
| 9437 | // Builds headers hashtable if needed | |
| 9438 | getResponseHeader: function( key ) { | |
| 9439 | var match; | |
| 9440 | if ( completed ) { | |
| 9441 | if ( !responseHeaders ) { | |
| 9442 | responseHeaders = {}; | |
| 9443 | while ( ( match = rheaders.exec( responseHeadersString ) ) ) { | |
| 9444 | responseHeaders[ match[ 1 ].toLowerCase() + " " ] = | |
| 9445 | ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) | |
| 9446 | .concat( match[ 2 ] ); | |
| 9447 | } | |
| 9448 | } | |
| 9449 | match = responseHeaders[ key.toLowerCase() + " " ]; | |
| 9450 | } | |
| 9451 | return match == null ? null : match.join( ", " ); | |
| 9452 | }, | |
| 9453 | ||
| 9454 | // Raw string | |
| 9455 | getAllResponseHeaders: function() { | |
| 9456 | return completed ? responseHeadersString : null; | |
| 9457 | }, | |
| 9458 | ||
| 9459 | // Caches the header | |
| 9460 | setRequestHeader: function( name, value ) { | |
| 9461 | if ( completed == null ) { | |
| 9462 | name = requestHeadersNames[ name.toLowerCase() ] = | |
| 9463 | requestHeadersNames[ name.toLowerCase() ] || name; | |
| 9464 | requestHeaders[ name ] = value; | |
| 9465 | } | |
| 9466 | return this; | |
| 9467 | }, | |
| 9468 | ||
| 9469 | // Overrides response content-type header | |
| 9470 | overrideMimeType: function( type ) { | |
| 9471 | if ( completed == null ) { | |
| 9472 | s.mimeType = type; | |
| 9473 | } | |
| 9474 | return this; | |
| 9475 | }, | |
| 9476 | ||
| 9477 | // Status-dependent callbacks | |
| 9478 | statusCode: function( map ) { | |
| 9479 | var code; | |
| 9480 | if ( map ) { | |
| 9481 | if ( completed ) { | |
| 9482 | ||
| 9483 | // Execute the appropriate callbacks | |
| 9484 | jqXHR.always( map[ jqXHR.status ] ); | |
| 9485 | } else { | |
| 9486 | ||
| 9487 | // Lazy-add the new callbacks in a way that preserves old ones | |
| 9488 | for ( code in map ) { | |
| 9489 | statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; | |
| 9490 | } | |
| 9491 | } | |
| 9492 | } | |
| 9493 | return this; | |
| 9494 | }, | |
| 9495 | ||
| 9496 | // Cancel the request | |
| 9497 | abort: function( statusText ) { | |
| 9498 | var finalText = statusText || strAbort; | |
| 9499 | if ( transport ) { | |
| 9500 | transport.abort( finalText ); | |
| 9501 | } | |
| 9502 | done( 0, finalText ); | |
| 9503 | return this; | |
| 9504 | } | |
| 9505 | }; | |
| 9506 | ||
| 9507 | // Attach deferreds | |
| 9508 | deferred.promise( jqXHR ); | |
| 9509 | ||
| 9510 | // Add protocol if not provided (prefilters might expect it) | |
| 9511 | // Handle falsy url in the settings object (#10093: consistency with old signature) | |
| 9512 | // We also use the url parameter if available | |
| 9513 | s.url = ( ( url || s.url || location.href ) + "" ) | |
| 9514 | .replace( rprotocol, location.protocol + "//" ); | |
| 9515 | ||
| 9516 | // Alias method option to type as per ticket #12004 | |
| 9517 | s.type = options.method || options.type || s.method || s.type; | |
| 9518 | ||
| 9519 | // Extract dataTypes list | |
| 9520 | s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; | |
| 9521 | ||
| 9522 | // A cross-domain request is in order when the origin doesn't match the current origin. | |
| 9523 | if ( s.crossDomain == null ) { | |
| 9524 | urlAnchor = document.createElement( "a" ); | |
| 9525 | ||
| 9526 | // Support: IE <=8 - 11, Edge 12 - 15 | |
| 9527 | // IE throws exception on accessing the href property if url is malformed, | |
| 9528 | // e.g. http://example.com:80x/ | |
| 9529 | try { | |
| 9530 | urlAnchor.href = s.url; | |
| 9531 | ||
| 9532 | // Support: IE <=8 - 11 only | |
| 9533 | // Anchor's host property isn't correctly set when s.url is relative | |
| 9534 | urlAnchor.href = urlAnchor.href; | |
| 9535 | s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== | |
| 9536 | urlAnchor.protocol + "//" + urlAnchor.host; | |
| 9537 | } catch ( e ) { | |
| 9538 | ||
| 9539 | // If there is an error parsing the URL, assume it is crossDomain, | |
| 9540 | // it can be rejected by the transport if it is invalid | |
| 9541 | s.crossDomain = true; | |
| 9542 | } | |
| 9543 | } | |
| 9544 | ||
| 9545 | // Convert data if not already a string | |
| 9546 | if ( s.data && s.processData && typeof s.data !== "string" ) { | |
| 9547 | s.data = jQuery.param( s.data, s.traditional ); | |
| 9548 | } | |
| 9549 | ||
| 9550 | // Apply prefilters | |
| 9551 | inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); | |
| 9552 | ||
| 9553 | // If request was aborted inside a prefilter, stop there | |
| 9554 | if ( completed ) { | |
| 9555 | return jqXHR; | |
| 9556 | } | |
| 9557 | ||
| 9558 | // We can fire global events as of now if asked to | |
| 9559 | // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) | |
| 9560 | fireGlobals = jQuery.event && s.global; | |
| 9561 | ||
| 9562 | // Watch for a new set of requests | |
| 9563 | if ( fireGlobals && jQuery.active++ === 0 ) { | |
| 9564 | jQuery.event.trigger( "ajaxStart" ); | |
| 9565 | } | |
| 9566 | ||
| 9567 | // Uppercase the type | |
| 9568 | s.type = s.type.toUpperCase(); | |
| 9569 | ||
| 9570 | // Determine if request has content | |
| 9571 | s.hasContent = !rnoContent.test( s.type ); | |
| 9572 | ||
| 9573 | // Save the URL in case we're toying with the If-Modified-Since | |
| 9574 | // and/or If-None-Match header later on | |
| 9575 | // Remove hash to simplify url manipulation | |
| 9576 | cacheURL = s.url.replace( rhash, "" ); | |
| 9577 | ||
| 9578 | // More options handling for requests with no content | |
| 9579 | if ( !s.hasContent ) { | |
| 9580 | ||
| 9581 | // Remember the hash so we can put it back | |
| 9582 | uncached = s.url.slice( cacheURL.length ); | |
| 9583 | ||
| 9584 | // If data is available and should be processed, append data to url | |
| 9585 | if ( s.data && ( s.processData || typeof s.data === "string" ) ) { | |
| 9586 | cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; | |
| 9587 | ||
| 9588 | // #9682: remove data so that it's not used in an eventual retry | |
| 9589 | delete s.data; | |
| 9590 | } | |
| 9591 | ||
| 9592 | // Add or update anti-cache param if needed | |
| 9593 | if ( s.cache === false ) { | |
| 9594 | cacheURL = cacheURL.replace( rantiCache, "$1" ); | |
| 9595 | uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + | |
| 9596 | uncached; | |
| 9597 | } | |
| 9598 | ||
| 9599 | // Put hash and anti-cache on the URL that will be requested (gh-1732) | |
| 9600 | s.url = cacheURL + uncached; | |
| 9601 | ||
| 9602 | // Change '%20' to '+' if this is encoded form body content (gh-2658) | |
| 9603 | } else if ( s.data && s.processData && | |
| 9604 | ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { | |
| 9605 | s.data = s.data.replace( r20, "+" ); | |
| 9606 | } | |
| 9607 | ||
| 9608 | // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. | |
| 9609 | if ( s.ifModified ) { | |
| 9610 | if ( jQuery.lastModified[ cacheURL ] ) { | |
| 9611 | jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); | |
| 9612 | } | |
| 9613 | if ( jQuery.etag[ cacheURL ] ) { | |
| 9614 | jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); | |
| 9615 | } | |
| 9616 | } | |
| 9617 | ||
| 9618 | // Set the correct header, if data is being sent | |
| 9619 | if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { | |
| 9620 | jqXHR.setRequestHeader( "Content-Type", s.contentType ); | |
| 9621 | } | |
| 9622 | ||
| 9623 | // Set the Accepts header for the server, depending on the dataType | |
| 9624 | jqXHR.setRequestHeader( | |
| 9625 | "Accept", | |
| 9626 | s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? | |
| 9627 | s.accepts[ s.dataTypes[ 0 ] ] + | |
| 9628 | ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : | |
| 9629 | s.accepts[ "*" ] | |
| 9630 | ); | |
| 9631 | ||
| 9632 | // Check for headers option | |
| 9633 | for ( i in s.headers ) { | |
| 9634 | jqXHR.setRequestHeader( i, s.headers[ i ] ); | |
| 9635 | } | |
| 9636 | ||
| 9637 | // Allow custom headers/mimetypes and early abort | |
| 9638 | if ( s.beforeSend && | |
| 9639 | ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { | |
| 9640 | ||
| 9641 | // Abort if not done already and return | |
| 9642 | return jqXHR.abort(); | |
| 9643 | } | |
| 9644 | ||
| 9645 | // Aborting is no longer a cancellation | |
| 9646 | strAbort = "abort"; | |
| 9647 | ||
| 9648 | // Install callbacks on deferreds | |
| 9649 | completeDeferred.add( s.complete ); | |
| 9650 | jqXHR.done( s.success ); | |
| 9651 | jqXHR.fail( s.error ); | |
| 9652 | ||
| 9653 | // Get transport | |
| 9654 | transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); | |
| 9655 | ||
| 9656 | // If no transport, we auto-abort | |
| 9657 | if ( !transport ) { | |
| 9658 | done( -1, "No Transport" ); | |
| 9659 | } else { | |
| 9660 | jqXHR.readyState = 1; | |
| 9661 | ||
| 9662 | // Send global event | |
| 9663 | if ( fireGlobals ) { | |
| 9664 | globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); | |
| 9665 | } | |
| 9666 | ||
| 9667 | // If request was aborted inside ajaxSend, stop there | |
| 9668 | if ( completed ) { | |
| 9669 | return jqXHR; | |
| 9670 | } | |
| 9671 | ||
| 9672 | // Timeout | |
| 9673 | if ( s.async && s.timeout > 0 ) { | |
| 9674 | timeoutTimer = window.setTimeout( function() { | |
| 9675 | jqXHR.abort( "timeout" ); | |
| 9676 | }, s.timeout ); | |
| 9677 | } | |
| 9678 | ||
| 9679 | try { | |
| 9680 | completed = false; | |
| 9681 | transport.send( requestHeaders, done ); | |
| 9682 | } catch ( e ) { | |
| 9683 | ||
| 9684 | // Rethrow post-completion exceptions | |
| 9685 | if ( completed ) { | |
| 9686 | throw e; | |
| 9687 | } | |
| 9688 | ||
| 9689 | // Propagate others as results | |
| 9690 | done( -1, e ); | |
| 9691 | } | |
| 9692 | } | |
| 9693 | ||
| 9694 | // Callback for when everything is done | |
| 9695 | function done( status, nativeStatusText, responses, headers ) { | |
| 9696 | var isSuccess, success, error, response, modified, | |
| 9697 | statusText = nativeStatusText; | |
| 9698 | ||
| 9699 | // Ignore repeat invocations | |
| 9700 | if ( completed ) { | |
| 9701 | return; | |
| 9702 | } | |
| 9703 | ||
| 9704 | completed = true; | |
| 9705 | ||
| 9706 | // Clear timeout if it exists | |
| 9707 | if ( timeoutTimer ) { | |
| 9708 | window.clearTimeout( timeoutTimer ); | |
| 9709 | } | |
| 9710 | ||
| 9711 | // Dereference transport for early garbage collection | |
| 9712 | // (no matter how long the jqXHR object will be used) | |
| 9713 | transport = undefined; | |
| 9714 | ||
| 9715 | // Cache response headers | |
| 9716 | responseHeadersString = headers || ""; | |
| 9717 | ||
| 9718 | // Set readyState | |
| 9719 | jqXHR.readyState = status > 0 ? 4 : 0; | |
| 9720 | ||
| 9721 | // Determine if successful | |
| 9722 | isSuccess = status >= 200 && status < 300 || status === 304; | |
| 9723 | ||
| 9724 | // Get response data | |
| 9725 | if ( responses ) { | |
| 9726 | response = ajaxHandleResponses( s, jqXHR, responses ); | |
| 9727 | } | |
| 9728 | ||
| 9729 | // Use a noop converter for missing script | |
| 9730 | if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { | |
| 9731 | s.converters[ "text script" ] = function() {}; | |
| 9732 | } | |
| 9733 | ||
| 9734 | // Convert no matter what (that way responseXXX fields are always set) | |
| 9735 | response = ajaxConvert( s, response, jqXHR, isSuccess ); | |
| 9736 | ||
| 9737 | // If successful, handle type chaining | |
| 9738 | if ( isSuccess ) { | |
| 9739 | ||
| 9740 | // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. | |
| 9741 | if ( s.ifModified ) { | |
| 9742 | modified = jqXHR.getResponseHeader( "Last-Modified" ); | |
| 9743 | if ( modified ) { | |
| 9744 | jQuery.lastModified[ cacheURL ] = modified; | |
| 9745 | } | |
| 9746 | modified = jqXHR.getResponseHeader( "etag" ); | |
| 9747 | if ( modified ) { | |
| 9748 | jQuery.etag[ cacheURL ] = modified; | |
| 9749 | } | |
| 9750 | } | |
| 9751 | ||
| 9752 | // if no content | |
| 9753 | if ( status === 204 || s.type === "HEAD" ) { | |
| 9754 | statusText = "nocontent"; | |
| 9755 | ||
| 9756 | // if not modified | |
| 9757 | } else if ( status === 304 ) { | |
| 9758 | statusText = "notmodified"; | |
| 9759 | ||
| 9760 | // If we have data, let's convert it | |
| 9761 | } else { | |
| 9762 | statusText = response.state; | |
| 9763 | success = response.data; | |
| 9764 | error = response.error; | |
| 9765 | isSuccess = !error; | |
| 9766 | } | |
| 9767 | } else { | |
| 9768 | ||
| 9769 | // Extract error from statusText and normalize for non-aborts | |
| 9770 | error = statusText; | |
| 9771 | if ( status || !statusText ) { | |
| 9772 | statusText = "error"; | |
| 9773 | if ( status < 0 ) { | |
| 9774 | status = 0; | |
| 9775 | } | |
| 9776 | } | |
| 9777 | } | |
| 9778 | ||
| 9779 | // Set data for the fake xhr object | |
| 9780 | jqXHR.status = status; | |
| 9781 | jqXHR.statusText = ( nativeStatusText || statusText ) + ""; | |
| 9782 | ||
| 9783 | // Success/Error | |
| 9784 | if ( isSuccess ) { | |
| 9785 | deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); | |
| 9786 | } else { | |
| 9787 | deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); | |
| 9788 | } | |
| 9789 | ||
| 9790 | // Status-dependent callbacks | |
| 9791 | jqXHR.statusCode( statusCode ); | |
| 9792 | statusCode = undefined; | |
| 9793 | ||
| 9794 | if ( fireGlobals ) { | |
| 9795 | globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", | |
| 9796 | [ jqXHR, s, isSuccess ? success : error ] ); | |
| 9797 | } | |
| 9798 | ||
| 9799 | // Complete | |
| 9800 | completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); | |
| 9801 | ||
| 9802 | if ( fireGlobals ) { | |
| 9803 | globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); | |
| 9804 | ||
| 9805 | // Handle the global AJAX counter | |
| 9806 | if ( !( --jQuery.active ) ) { | |
| 9807 | jQuery.event.trigger( "ajaxStop" ); | |
| 9808 | } | |
| 9809 | } | |
| 9810 | } | |
| 9811 | ||
| 9812 | return jqXHR; | |
| 9813 | }, | |
| 9814 | ||
| 9815 | getJSON: function( url, data, callback ) { | |
| 9816 | return jQuery.get( url, data, callback, "json" ); | |
| 9817 | }, | |
| 9818 | ||
| 9819 | getScript: function( url, callback ) { | |
| 9820 | return jQuery.get( url, undefined, callback, "script" ); | |
| 9821 | } | |
| 9822 | } ); | |
| 9823 | ||
| 9824 | jQuery.each( [ "get", "post" ], function( _i, method ) { | |
| 9825 | jQuery[ method ] = function( url, data, callback, type ) { | |
| 9826 | ||
| 9827 | // Shift arguments if data argument was omitted | |
| 9828 | if ( isFunction( data ) ) { | |
| 9829 | type = type || callback; | |
| 9830 | callback = data; | |
| 9831 | data = undefined; | |
| 9832 | } | |
| 9833 | ||
| 9834 | // The url can be an options object (which then must have .url) | |
| 9835 | return jQuery.ajax( jQuery.extend( { | |
| 9836 | url: url, | |
| 9837 | type: method, | |
| 9838 | dataType: type, | |
| 9839 | data: data, | |
| 9840 | success: callback | |
| 9841 | }, jQuery.isPlainObject( url ) && url ) ); | |
| 9842 | }; | |
| 9843 | } ); | |
| 9844 | ||
| 9845 | jQuery.ajaxPrefilter( function( s ) { | |
| 9846 | var i; | |
| 9847 | for ( i in s.headers ) { | |
| 9848 | if ( i.toLowerCase() === "content-type" ) { | |
| 9849 | s.contentType = s.headers[ i ] || ""; | |
| 9850 | } | |
| 9851 | } | |
| 9852 | } ); | |
| 9853 | ||
| 9854 | ||
| 9855 | jQuery._evalUrl = function( url, options, doc ) { | |
| 9856 | return jQuery.ajax( { | |
| 9857 | url: url, | |
| 9858 | ||
| 9859 | // Make this explicit, since user can override this through ajaxSetup (#11264) | |
| 9860 | type: "GET", | |
| 9861 | dataType: "script", | |
| 9862 | cache: true, | |
| 9863 | async: false, | |
| 9864 | global: false, | |
| 9865 | ||
| 9866 | // Only evaluate the response if it is successful (gh-4126) | |
| 9867 | // dataFilter is not invoked for failure responses, so using it instead | |
| 9868 | // of the default converter is kludgy but it works. | |
| 9869 | converters: { | |
| 9870 | "text script": function() {} | |
| 9871 | }, | |
| 9872 | dataFilter: function( response ) { | |
| 9873 | jQuery.globalEval( response, options, doc ); | |
| 9874 | } | |
| 9875 | } ); | |
| 9876 | }; | |
| 9877 | ||
| 9878 | ||
| 9879 | jQuery.fn.extend( { | |
| 9880 | wrapAll: function( html ) { | |
| 9881 | var wrap; | |
| 9882 | ||
| 9883 | if ( this[ 0 ] ) { | |
| 9884 | if ( isFunction( html ) ) { | |
| 9885 | html = html.call( this[ 0 ] ); | |
| 9886 | } | |
| 9887 | ||
| 9888 | // The elements to wrap the target around | |
| 9889 | wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); | |
| 9890 | ||
| 9891 | if ( this[ 0 ].parentNode ) { | |
| 9892 | wrap.insertBefore( this[ 0 ] ); | |
| 9893 | } | |
| 9894 | ||
| 9895 | wrap.map( function() { | |
| 9896 | var elem = this; | |
| 9897 | ||
| 9898 | while ( elem.firstElementChild ) { | |
| 9899 | elem = elem.firstElementChild; | |
| 9900 | } | |
| 9901 | ||
| 9902 | return elem; | |
| 9903 | } ).append( this ); | |
| 9904 | } | |
| 9905 | ||
| 9906 | return this; | |
| 9907 | }, | |
| 9908 | ||
| 9909 | wrapInner: function( html ) { | |
| 9910 | if ( isFunction( html ) ) { | |
| 9911 | return this.each( function( i ) { | |
| 9912 | jQuery( this ).wrapInner( html.call( this, i ) ); | |
| 9913 | } ); | |
| 9914 | } | |
| 9915 | ||
| 9916 | return this.each( function() { | |
| 9917 | var self = jQuery( this ), | |
| 9918 | contents = self.contents(); | |
| 9919 | ||
| 9920 | if ( contents.length ) { | |
| 9921 | contents.wrapAll( html ); | |
| 9922 | ||
| 9923 | } else { | |
| 9924 | self.append( html ); | |
| 9925 | } | |
| 9926 | } ); | |
| 9927 | }, | |
| 9928 | ||
| 9929 | wrap: function( html ) { | |
| 9930 | var htmlIsFunction = isFunction( html ); | |
| 9931 | ||
| 9932 | return this.each( function( i ) { | |
| 9933 | jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); | |
| 9934 | } ); | |
| 9935 | }, | |
| 9936 | ||
| 9937 | unwrap: function( selector ) { | |
| 9938 | this.parent( selector ).not( "body" ).each( function() { | |
| 9939 | jQuery( this ).replaceWith( this.childNodes ); | |
| 9940 | } ); | |
| 9941 | return this; | |
| 9942 | } | |
| 9943 | } ); | |
| 9944 | ||
| 9945 | ||
| 9946 | jQuery.expr.pseudos.hidden = function( elem ) { | |
| 9947 | return !jQuery.expr.pseudos.visible( elem ); | |
| 9948 | }; | |
| 9949 | jQuery.expr.pseudos.visible = function( elem ) { | |
| 9950 | return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); | |
| 9951 | }; | |
| 9952 | ||
| 9953 | ||
| 9954 | ||
| 9955 | ||
| 9956 | jQuery.ajaxSettings.xhr = function() { | |
| 9957 | try { | |
| 9958 | return new window.XMLHttpRequest(); | |
| 9959 | } catch ( e ) {} | |
| 9960 | }; | |
| 9961 | ||
| 9962 | var xhrSuccessStatus = { | |
| 9963 | ||
| 9964 | // File protocol always yields status code 0, assume 200 | |
| 9965 | 0: 200, | |
| 9966 | ||
| 9967 | // Support: IE <=9 only | |
| 9968 | // #1450: sometimes IE returns 1223 when it should be 204 | |
| 9969 | 1223: 204 | |
| 9970 | }, | |
| 9971 | xhrSupported = jQuery.ajaxSettings.xhr(); | |
| 9972 | ||
| 9973 | support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); | |
| 9974 | support.ajax = xhrSupported = !!xhrSupported; | |
| 9975 | ||
| 9976 | jQuery.ajaxTransport( function( options ) { | |
| 9977 | var callback, errorCallback; | |
| 9978 | ||
| 9979 | // Cross domain only allowed if supported through XMLHttpRequest | |
| 9980 | if ( support.cors || xhrSupported && !options.crossDomain ) { | |
| 9981 | return { | |
| 9982 | send: function( headers, complete ) { | |
| 9983 | var i, | |
| 9984 | xhr = options.xhr(); | |
| 9985 | ||
| 9986 | xhr.open( | |
| 9987 | options.type, | |
| 9988 | options.url, | |
| 9989 | options.async, | |
| 9990 | options.username, | |
| 9991 | options.password | |
| 9992 | ); | |
| 9993 | ||
| 9994 | // Apply custom fields if provided | |
| 9995 | if ( options.xhrFields ) { | |
| 9996 | for ( i in options.xhrFields ) { | |
| 9997 | xhr[ i ] = options.xhrFields[ i ]; | |
| 9998 | } | |
| 9999 | } | |
| 10000 | ||
| 10001 | // Override mime type if needed | |
| 10002 | if ( options.mimeType && xhr.overrideMimeType ) { | |
| 10003 | xhr.overrideMimeType( options.mimeType ); | |
| 10004 | } | |
| 10005 | ||
| 10006 | // X-Requested-With header | |
| 10007 | // For cross-domain requests, seeing as conditions for a preflight are | |
| 10008 | // akin to a jigsaw puzzle, we simply never set it to be sure. | |
| 10009 | // (it can always be set on a per-request basis or even using ajaxSetup) | |
| 10010 | // For same-domain requests, won't change header if already provided. | |
| 10011 | if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { | |
| 10012 | headers[ "X-Requested-With" ] = "XMLHttpRequest"; | |
| 10013 | } | |
| 10014 | ||
| 10015 | // Set headers | |
| 10016 | for ( i in headers ) { | |
| 10017 | xhr.setRequestHeader( i, headers[ i ] ); | |
| 10018 | } | |
| 10019 | ||
| 10020 | // Callback | |
| 10021 | callback = function( type ) { | |
| 10022 | return function() { | |
| 10023 | if ( callback ) { | |
| 10024 | callback = errorCallback = xhr.onload = | |
| 10025 | xhr.onerror = xhr.onabort = xhr.ontimeout = | |
| 10026 | xhr.onreadystatechange = null; | |
| 10027 | ||
| 10028 | if ( type === "abort" ) { | |
| 10029 | xhr.abort(); | |
| 10030 | } else if ( type === "error" ) { | |
| 10031 | ||
| 10032 | // Support: IE <=9 only | |
| 10033 | // On a manual native abort, IE9 throws | |
| 10034 | // errors on any property access that is not readyState | |
| 10035 | if ( typeof xhr.status !== "number" ) { | |
| 10036 | complete( 0, "error" ); | |
| 10037 | } else { | |
| 10038 | complete( | |
| 10039 | ||
| 10040 | // File: protocol always yields status 0; see #8605, #14207 | |
| 10041 | xhr.status, | |
| 10042 | xhr.statusText | |
| 10043 | ); | |
| 10044 | } | |
| 10045 | } else { | |
| 10046 | complete( | |
| 10047 | xhrSuccessStatus[ xhr.status ] || xhr.status, | |
| 10048 | xhr.statusText, | |
| 10049 | ||
| 10050 | // Support: IE <=9 only | |
| 10051 | // IE9 has no XHR2 but throws on binary (trac-11426) | |
| 10052 | // For XHR2 non-text, let the caller handle it (gh-2498) | |
| 10053 | ( xhr.responseType || "text" ) !== "text" || | |
| 10054 | typeof xhr.responseText !== "string" ? | |
| 10055 | { binary: xhr.response } : | |
| 10056 | { text: xhr.responseText }, | |
| 10057 | xhr.getAllResponseHeaders() | |
| 10058 | ); | |
| 10059 | } | |
| 10060 | } | |
| 10061 | }; | |
| 10062 | }; | |
| 10063 | ||
| 10064 | // Listen to events | |
| 10065 | xhr.onload = callback(); | |
| 10066 | errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); | |
| 10067 | ||
| 10068 | // Support: IE 9 only | |
| 10069 | // Use onreadystatechange to replace onabort | |
| 10070 | // to handle uncaught aborts | |
| 10071 | if ( xhr.onabort !== undefined ) { | |
| 10072 | xhr.onabort = errorCallback; | |
| 10073 | } else { | |
| 10074 | xhr.onreadystatechange = function() { | |
| 10075 | ||
| 10076 | // Check readyState before timeout as it changes | |
| 10077 | if ( xhr.readyState === 4 ) { | |
| 10078 | ||
| 10079 | // Allow onerror to be called first, | |
| 10080 | // but that will not handle a native abort | |
| 10081 | // Also, save errorCallback to a variable | |
| 10082 | // as xhr.onerror cannot be accessed | |
| 10083 | window.setTimeout( function() { | |
| 10084 | if ( callback ) { | |
| 10085 | errorCallback(); | |
| 10086 | } | |
| 10087 | } ); | |
| 10088 | } | |
| 10089 | }; | |
| 10090 | } | |
| 10091 | ||
| 10092 | // Create the abort callback | |
| 10093 | callback = callback( "abort" ); | |
| 10094 | ||
| 10095 | try { | |
| 10096 | ||
| 10097 | // Do send the request (this may raise an exception) | |
| 10098 | xhr.send( options.hasContent && options.data || null ); | |
| 10099 | } catch ( e ) { | |
| 10100 | ||
| 10101 | // #14683: Only rethrow if this hasn't been notified as an error yet | |
| 10102 | if ( callback ) { | |
| 10103 | throw e; | |
| 10104 | } | |
| 10105 | } | |
| 10106 | }, | |
| 10107 | ||
| 10108 | abort: function() { | |
| 10109 | if ( callback ) { | |
| 10110 | callback(); | |
| 10111 | } | |
| 10112 | } | |
| 10113 | }; | |
| 10114 | } | |
| 10115 | } ); | |
| 10116 | ||
| 10117 | ||
| 10118 | ||
| 10119 | ||
| 10120 | // Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) | |
| 10121 | jQuery.ajaxPrefilter( function( s ) { | |
| 10122 | if ( s.crossDomain ) { | |
| 10123 | s.contents.script = false; | |
| 10124 | } | |
| 10125 | } ); | |
| 10126 | ||
| 10127 | // Install script dataType | |
| 10128 | jQuery.ajaxSetup( { | |
| 10129 | accepts: { | |
| 10130 | script: "text/javascript, application/javascript, " + | |
| 10131 | "application/ecmascript, application/x-ecmascript" | |
| 10132 | }, | |
| 10133 | contents: { | |
| 10134 | script: /\b(?:java|ecma)script\b/ | |
| 10135 | }, | |
| 10136 | converters: { | |
| 10137 | "text script": function( text ) { | |
| 10138 | jQuery.globalEval( text ); | |
| 10139 | return text; | |
| 10140 | } | |
| 10141 | } | |
| 10142 | } ); | |
| 10143 | ||
| 10144 | // Handle cache's special case and crossDomain | |
| 10145 | jQuery.ajaxPrefilter( "script", function( s ) { | |
| 10146 | if ( s.cache === undefined ) { | |
| 10147 | s.cache = false; | |
| 10148 | } | |
| 10149 | if ( s.crossDomain ) { | |
| 10150 | s.type = "GET"; | |
| 10151 | } | |
| 10152 | } ); | |
| 10153 | ||
| 10154 | // Bind script tag hack transport | |
| 10155 | jQuery.ajaxTransport( "script", function( s ) { | |
| 10156 | ||
| 10157 | // This transport only deals with cross domain or forced-by-attrs requests | |
| 10158 | if ( s.crossDomain || s.scriptAttrs ) { | |
| 10159 | var script, callback; | |
| 10160 | return { | |
| 10161 | send: function( _, complete ) { | |
| 10162 | script = jQuery( "<script>" ) | |
| 10163 | .attr( s.scriptAttrs || {} ) | |
| 10164 | .prop( { charset: s.scriptCharset, src: s.url } ) | |
| 10165 | .on( "load error", callback = function( evt ) { | |
| 10166 | script.remove(); | |
| 10167 | callback = null; | |
| 10168 | if ( evt ) { | |
| 10169 | complete( evt.type === "error" ? 404 : 200, evt.type ); | |
| 10170 | } | |
| 10171 | } ); | |
| 10172 | ||
| 10173 | // Use native DOM manipulation to avoid our domManip AJAX trickery | |
| 10174 | document.head.appendChild( script[ 0 ] ); | |
| 10175 | }, | |
| 10176 | abort: function() { | |
| 10177 | if ( callback ) { | |
| 10178 | callback(); | |
| 10179 | } | |
| 10180 | } | |
| 10181 | }; | |
| 10182 | } | |
| 10183 | } ); | |
| 10184 | ||
| 10185 | ||
| 10186 | ||
| 10187 | ||
| 10188 | var oldCallbacks = [], | |
| 10189 | rjsonp = /(=)\?(?=&|$)|\?\?/; | |
| 10190 | ||
| 10191 | // Default jsonp settings | |
| 10192 | jQuery.ajaxSetup( { | |
| 10193 | jsonp: "callback", | |
| 10194 | jsonpCallback: function() { | |
| 10195 | var callback = oldCallbacks.pop() || ( jQuery.expando + "_" + ( nonce.guid++ ) ); | |
| 10196 | this[ callback ] = true; | |
| 10197 | return callback; | |
| 10198 | } | |
| 10199 | } ); | |
| 10200 | ||
| 10201 | // Detect, normalize options and install callbacks for jsonp requests | |
| 10202 | jQuery.ajaxPrefilter( "json jsonp", function( s, originalSettings, jqXHR ) { | |
| 10203 | ||
| 10204 | var callbackName, overwritten, responseContainer, | |
| 10205 | jsonProp = s.jsonp !== false && ( rjsonp.test( s.url ) ? | |
| 10206 | "url" : | |
| 10207 | typeof s.data === "string" && | |
| 10208 | ( s.contentType || "" ) | |
| 10209 | .indexOf( "application/x-www-form-urlencoded" ) === 0 && | |
| 10210 | rjsonp.test( s.data ) && "data" | |
| 10211 | ); | |
| 10212 | ||
| 10213 | // Handle iff the expected data type is "jsonp" or we have a parameter to set | |
| 10214 | if ( jsonProp || s.dataTypes[ 0 ] === "jsonp" ) { | |
| 10215 | ||
| 10216 | // Get callback name, remembering preexisting value associated with it | |
| 10217 | callbackName = s.jsonpCallback = isFunction( s.jsonpCallback ) ? | |
| 10218 | s.jsonpCallback() : | |
| 10219 | s.jsonpCallback; | |
| 10220 | ||
| 10221 | // Insert callback into url or form data | |
| 10222 | if ( jsonProp ) { | |
| 10223 | s[ jsonProp ] = s[ jsonProp ].replace( rjsonp, "$1" + callbackName ); | |
| 10224 | } else if ( s.jsonp !== false ) { | |
| 10225 | s.url += ( rquery.test( s.url ) ? "&" : "?" ) + s.jsonp + "=" + callbackName; | |
| 10226 | } | |
| 10227 | ||
| 10228 | // Use data converter to retrieve json after script execution | |
| 10229 | s.converters[ "script json" ] = function() { | |
| 10230 | if ( !responseContainer ) { | |
| 10231 | jQuery.error( callbackName + " was not called" ); | |
| 10232 | } | |
| 10233 | return responseContainer[ 0 ]; | |
| 10234 | }; | |
| 10235 | ||
| 10236 | // Force json dataType | |
| 10237 | s.dataTypes[ 0 ] = "json"; | |
| 10238 | ||
| 10239 | // Install callback | |
| 10240 | overwritten = window[ callbackName ]; | |
| 10241 | window[ callbackName ] = function() { | |
| 10242 | responseContainer = arguments; | |
| 10243 | }; | |
| 10244 | ||
| 10245 | // Clean-up function (fires after converters) | |
| 10246 | jqXHR.always( function() { | |
| 10247 | ||
| 10248 | // If previous value didn't exist - remove it | |
| 10249 | if ( overwritten === undefined ) { | |
| 10250 | jQuery( window ).removeProp( callbackName ); | |
| 10251 | ||
| 10252 | // Otherwise restore preexisting value | |
| 10253 | } else { | |
| 10254 | window[ callbackName ] = overwritten; | |
| 10255 | } | |
| 10256 | ||
| 10257 | // Save back as free | |
| 10258 | if ( s[ callbackName ] ) { | |
| 10259 | ||
| 10260 | // Make sure that re-using the options doesn't screw things around | |
| 10261 | s.jsonpCallback = originalSettings.jsonpCallback; | |
| 10262 | ||
| 10263 | // Save the callback name for future use | |
| 10264 | oldCallbacks.push( callbackName ); | |
| 10265 | } | |
| 10266 | ||
| 10267 | // Call if it was a function and we have a response | |
| 10268 | if ( responseContainer && isFunction( overwritten ) ) { | |
| 10269 | overwritten( responseContainer[ 0 ] ); | |
| 10270 | } | |
| 10271 | ||
| 10272 | responseContainer = overwritten = undefined; | |
| 10273 | } ); | |
| 10274 | ||
| 10275 | // Delegate to script | |
| 10276 | return "script"; | |
| 10277 | } | |
| 10278 | } ); | |
| 10279 | ||
| 10280 | ||
| 10281 | ||
| 10282 | ||
| 10283 | // Support: Safari 8 only | |
| 10284 | // In Safari 8 documents created via document.implementation.createHTMLDocument | |
| 10285 | // collapse sibling forms: the second one becomes a child of the first one. | |
| 10286 | // Because of that, this security measure has to be disabled in Safari 8. | |
| 10287 | // https://bugs.webkit.org/show_bug.cgi?id=137337 | |
| 10288 | support.createHTMLDocument = ( function() { | |
| 10289 | var body = document.implementation.createHTMLDocument( "" ).body; | |
| 10290 | body.innerHTML = "<form></form><form></form>"; | |
| 10291 | return body.childNodes.length === 2; | |
| 10292 | } )(); | |
| 10293 | ||
| 10294 | ||
| 10295 | // Argument "data" should be string of html | |
| 10296 | // context (optional): If specified, the fragment will be created in this context, | |
| 10297 | // defaults to document | |
| 10298 | // keepScripts (optional): If true, will include scripts passed in the html string | |
| 10299 | jQuery.parseHTML = function( data, context, keepScripts ) { | |
| 10300 | if ( typeof data !== "string" ) { | |
| 10301 | return []; | |
| 10302 | } | |
| 10303 | if ( typeof context === "boolean" ) { | |
| 10304 | keepScripts = context; | |
| 10305 | context = false; | |
| 10306 | } | |
| 10307 | ||
| 10308 | var base, parsed, scripts; | |
| 10309 | ||
| 10310 | if ( !context ) { | |
| 10311 | ||
| 10312 | // Stop scripts or inline event handlers from being executed immediately | |
| 10313 | // by using document.implementation | |
| 10314 | if ( support.createHTMLDocument ) { | |
| 10315 | context = document.implementation.createHTMLDocument( "" ); | |
| 10316 | ||
| 10317 | // Set the base href for the created document | |
| 10318 | // so any parsed elements with URLs | |
| 10319 | // are based on the document's URL (gh-2965) | |
| 10320 | base = context.createElement( "base" ); | |
| 10321 | base.href = document.location.href; | |
| 10322 | context.head.appendChild( base ); | |
| 10323 | } else { | |
| 10324 | context = document; | |
| 10325 | } | |
| 10326 | } | |
| 10327 | ||
| 10328 | parsed = rsingleTag.exec( data ); | |
| 10329 | scripts = !keepScripts && []; | |
| 10330 | ||
| 10331 | // Single tag | |
| 10332 | if ( parsed ) { | |
| 10333 | return [ context.createElement( parsed[ 1 ] ) ]; | |
| 10334 | } | |
| 10335 | ||
| 10336 | parsed = buildFragment( [ data ], context, scripts ); | |
| 10337 | ||
| 10338 | if ( scripts && scripts.length ) { | |
| 10339 | jQuery( scripts ).remove(); | |
| 10340 | } | |
| 10341 | ||
| 10342 | return jQuery.merge( [], parsed.childNodes ); | |
| 10343 | }; | |
| 10344 | ||
| 10345 | ||
| 10346 | /** | |
| 10347 | * Load a url into a page | |
| 10348 | */ | |
| 10349 | jQuery.fn.load = function( url, params, callback ) { | |
| 10350 | var selector, type, response, | |
| 10351 | self = this, | |
| 10352 | off = url.indexOf( " " ); | |
| 10353 | ||
| 10354 | if ( off > -1 ) { | |
| 10355 | selector = stripAndCollapse( url.slice( off ) ); | |
| 10356 | url = url.slice( 0, off ); | |
| 10357 | } | |
| 10358 | ||
| 10359 | // If it's a function | |
| 10360 | if ( isFunction( params ) ) { | |
| 10361 | ||
| 10362 | // We assume that it's the callback | |
| 10363 | callback = params; | |
| 10364 | params = undefined; | |
| 10365 | ||
| 10366 | // Otherwise, build a param string | |
| 10367 | } else if ( params && typeof params === "object" ) { | |
| 10368 | type = "POST"; | |
| 10369 | } | |
| 10370 | ||
| 10371 | // If we have elements to modify, make the request | |
| 10372 | if ( self.length > 0 ) { | |
| 10373 | jQuery.ajax( { | |
| 10374 | url: url, | |
| 10375 | ||
| 10376 | // If "type" variable is undefined, then "GET" method will be used. | |
| 10377 | // Make value of this field explicit since | |
| 10378 | // user can override it through ajaxSetup method | |
| 10379 | type: type || "GET", | |
| 10380 | dataType: "html", | |
| 10381 | data: params | |
| 10382 | } ).done( function( responseText ) { | |
| 10383 | ||
| 10384 | // Save response for use in complete callback | |
| 10385 | response = arguments; | |
| 10386 | ||
| 10387 | self.html( selector ? | |
| 10388 | ||
| 10389 | // If a selector was specified, locate the right elements in a dummy div | |
| 10390 | // Exclude scripts to avoid IE 'Permission Denied' errors | |
| 10391 | jQuery( "<div>" ).append( jQuery.parseHTML( responseText ) ).find( selector ) : | |
| 10392 | ||
| 10393 | // Otherwise use the full result | |
| 10394 | responseText ); | |
| 10395 | ||
| 10396 | // If the request succeeds, this function gets "data", "status", "jqXHR" | |
| 10397 | // but they are ignored because response was set above. | |
| 10398 | // If it fails, this function gets "jqXHR", "status", "error" | |
| 10399 | } ).always( callback && function( jqXHR, status ) { | |
| 10400 | self.each( function() { | |
| 10401 | callback.apply( this, response || [ jqXHR.responseText, status, jqXHR ] ); | |
| 10402 | } ); | |
| 10403 | } ); | |
| 10404 | } | |
| 10405 | ||
| 10406 | return this; | |
| 10407 | }; | |
| 10408 | ||
| 10409 | ||
| 10410 | ||
| 10411 | ||
| 10412 | jQuery.expr.pseudos.animated = function( elem ) { | |
| 10413 | return jQuery.grep( jQuery.timers, function( fn ) { | |
| 10414 | return elem === fn.elem; | |
| 10415 | } ).length; | |
| 10416 | }; | |
| 10417 | ||
| 10418 | ||
| 10419 | ||
| 10420 | ||
| 10421 | jQuery.offset = { | |
| 10422 | setOffset: function( elem, options, i ) { | |
| 10423 | var curPosition, curLeft, curCSSTop, curTop, curOffset, curCSSLeft, calculatePosition, | |
| 10424 | position = jQuery.css( elem, "position" ), | |
| 10425 | curElem = jQuery( elem ), | |
| 10426 | props = {}; | |
| 10427 | ||
| 10428 | // Set position first, in-case top/left are set even on static elem | |
| 10429 | if ( position === "static" ) { | |
| 10430 | elem.style.position = "relative"; | |
| 10431 | } | |
| 10432 | ||
| 10433 | curOffset = curElem.offset(); | |
| 10434 | curCSSTop = jQuery.css( elem, "top" ); | |
| 10435 | curCSSLeft = jQuery.css( elem, "left" ); | |
| 10436 | calculatePosition = ( position === "absolute" || position === "fixed" ) && | |
| 10437 | ( curCSSTop + curCSSLeft ).indexOf( "auto" ) > -1; | |
| 10438 | ||
| 10439 | // Need to be able to calculate position if either | |
| 10440 | // top or left is auto and position is either absolute or fixed | |
| 10441 | if ( calculatePosition ) { | |
| 10442 | curPosition = curElem.position(); | |
| 10443 | curTop = curPosition.top; | |
| 10444 | curLeft = curPosition.left; | |
| 10445 | ||
| 10446 | } else { | |
| 10447 | curTop = parseFloat( curCSSTop ) || 0; | |
| 10448 | curLeft = parseFloat( curCSSLeft ) || 0; | |
| 10449 | } | |
| 10450 | ||
| 10451 | if ( isFunction( options ) ) { | |
| 10452 | ||
| 10453 | // Use jQuery.extend here to allow modification of coordinates argument (gh-1848) | |
| 10454 | options = options.call( elem, i, jQuery.extend( {}, curOffset ) ); | |
| 10455 | } | |
| 10456 | ||
| 10457 | if ( options.top != null ) { | |
| 10458 | props.top = ( options.top - curOffset.top ) + curTop; | |
| 10459 | } | |
| 10460 | if ( options.left != null ) { | |
| 10461 | props.left = ( options.left - curOffset.left ) + curLeft; | |
| 10462 | } | |
| 10463 | ||
| 10464 | if ( "using" in options ) { | |
| 10465 | options.using.call( elem, props ); | |
| 10466 | ||
| 10467 | } else { | |
| 10468 | if ( typeof props.top === "number" ) { | |
| 10469 | props.top += "px"; | |
| 10470 | } | |
| 10471 | if ( typeof props.left === "number" ) { | |
| 10472 | props.left += "px"; | |
| 10473 | } | |
| 10474 | curElem.css( props ); | |
| 10475 | } | |
| 10476 | } | |
| 10477 | }; | |
| 10478 | ||
| 10479 | jQuery.fn.extend( { | |
| 10480 | ||
| 10481 | // offset() relates an element's border box to the document origin | |
| 10482 | offset: function( options ) { | |
| 10483 | ||
| 10484 | // Preserve chaining for setter | |
| 10485 | if ( arguments.length ) { | |
| 10486 | return options === undefined ? | |
| 10487 | this : | |
| 10488 | this.each( function( i ) { | |
| 10489 | jQuery.offset.setOffset( this, options, i ); | |
| 10490 | } ); | |
| 10491 | } | |
| 10492 | ||
| 10493 | var rect, win, | |
| 10494 | elem = this[ 0 ]; | |
| 10495 | ||
| 10496 | if ( !elem ) { | |
| 10497 | return; | |
| 10498 | } | |
| 10499 | ||
| 10500 | // Return zeros for disconnected and hidden (display: none) elements (gh-2310) | |
| 10501 | // Support: IE <=11 only | |
| 10502 | // Running getBoundingClientRect on a | |
| 10503 | // disconnected node in IE throws an error | |
| 10504 | if ( !elem.getClientRects().length ) { | |
| 10505 | return { top: 0, left: 0 }; | |
| 10506 | } | |
| 10507 | ||
| 10508 | // Get document-relative position by adding viewport scroll to viewport-relative gBCR | |
| 10509 | rect = elem.getBoundingClientRect(); | |
| 10510 | win = elem.ownerDocument.defaultView; | |
| 10511 | return { | |
| 10512 | top: rect.top + win.pageYOffset, | |
| 10513 | left: rect.left + win.pageXOffset | |
| 10514 | }; | |
| 10515 | }, | |
| 10516 | ||
| 10517 | // position() relates an element's margin box to its offset parent's padding box | |
| 10518 | // This corresponds to the behavior of CSS absolute positioning | |
| 10519 | position: function() { | |
| 10520 | if ( !this[ 0 ] ) { | |
| 10521 | return; | |
| 10522 | } | |
| 10523 | ||
| 10524 | var offsetParent, offset, doc, | |
| 10525 | elem = this[ 0 ], | |
| 10526 | parentOffset = { top: 0, left: 0 }; | |
| 10527 | ||
| 10528 | // position:fixed elements are offset from the viewport, which itself always has zero offset | |
| 10529 | if ( jQuery.css( elem, "position" ) === "fixed" ) { | |
| 10530 | ||
| 10531 | // Assume position:fixed implies availability of getBoundingClientRect | |
| 10532 | offset = elem.getBoundingClientRect(); | |
| 10533 | ||
| 10534 | } else { | |
| 10535 | offset = this.offset(); | |
| 10536 | ||
| 10537 | // Account for the *real* offset parent, which can be the document or its root element | |
| 10538 | // when a statically positioned element is identified | |
| 10539 | doc = elem.ownerDocument; | |
| 10540 | offsetParent = elem.offsetParent || doc.documentElement; | |
| 10541 | while ( offsetParent && | |
| 10542 | ( offsetParent === doc.body || offsetParent === doc.documentElement ) && | |
| 10543 | jQuery.css( offsetParent, "position" ) === "static" ) { | |
| 10544 | ||
| 10545 | offsetParent = offsetParent.parentNode; | |
| 10546 | } | |
| 10547 | if ( offsetParent && offsetParent !== elem && offsetParent.nodeType === 1 ) { | |
| 10548 | ||
| 10549 | // Incorporate borders into its offset, since they are outside its content origin | |
| 10550 | parentOffset = jQuery( offsetParent ).offset(); | |
| 10551 | parentOffset.top += jQuery.css( offsetParent, "borderTopWidth", true ); | |
| 10552 | parentOffset.left += jQuery.css( offsetParent, "borderLeftWidth", true ); | |
| 10553 | } | |
| 10554 | } | |
| 10555 | ||
| 10556 | // Subtract parent offsets and element margins | |
| 10557 | return { | |
| 10558 | top: offset.top - parentOffset.top - jQuery.css( elem, "marginTop", true ), | |
| 10559 | left: offset.left - parentOffset.left - jQuery.css( elem, "marginLeft", true ) | |
| 10560 | }; | |
| 10561 | }, | |
| 10562 | ||
| 10563 | // This method will return documentElement in the following cases: | |
| 10564 | // 1) For the element inside the iframe without offsetParent, this method will return | |
| 10565 | // documentElement of the parent window | |
| 10566 | // 2) For the hidden or detached element | |
| 10567 | // 3) For body or html element, i.e. in case of the html node - it will return itself | |
| 10568 | // | |
| 10569 | // but those exceptions were never presented as a real life use-cases | |
| 10570 | // and might be considered as more preferable results. | |
| 10571 | // | |
| 10572 | // This logic, however, is not guaranteed and can change at any point in the future | |
| 10573 | offsetParent: function() { | |
| 10574 | return this.map( function() { | |
| 10575 | var offsetParent = this.offsetParent; | |
| 10576 | ||
| 10577 | while ( offsetParent && jQuery.css( offsetParent, "position" ) === "static" ) { | |
| 10578 | offsetParent = offsetParent.offsetParent; | |
| 10579 | } | |
| 10580 | ||
| 10581 | return offsetParent || documentElement; | |
| 10582 | } ); | |
| 10583 | } | |
| 10584 | } ); | |
| 10585 | ||
| 10586 | // Create scrollLeft and scrollTop methods | |
| 10587 | jQuery.each( { scrollLeft: "pageXOffset", scrollTop: "pageYOffset" }, function( method, prop ) { | |
| 10588 | var top = "pageYOffset" === prop; | |
| 10589 | ||
| 10590 | jQuery.fn[ method ] = function( val ) { | |
| 10591 | return access( this, function( elem, method, val ) { | |
| 10592 | ||
| 10593 | // Coalesce documents and windows | |
| 10594 | var win; | |
| 10595 | if ( isWindow( elem ) ) { | |
| 10596 | win = elem; | |
| 10597 | } else if ( elem.nodeType === 9 ) { | |
| 10598 | win = elem.defaultView; | |
| 10599 | } | |
| 10600 | ||
| 10601 | if ( val === undefined ) { | |
| 10602 | return win ? win[ prop ] : elem[ method ]; | |
| 10603 | } | |
| 10604 | ||
| 10605 | if ( win ) { | |
| 10606 | win.scrollTo( | |
| 10607 | !top ? val : win.pageXOffset, | |
| 10608 | top ? val : win.pageYOffset | |
| 10609 | ); | |
| 10610 | ||
| 10611 | } else { | |
| 10612 | elem[ method ] = val; | |
| 10613 | } | |
| 10614 | }, method, val, arguments.length ); | |
| 10615 | }; | |
| 10616 | } ); | |
| 10617 | ||
| 10618 | // Support: Safari <=7 - 9.1, Chrome <=37 - 49 | |
| 10619 | // Add the top/left cssHooks using jQuery.fn.position | |
| 10620 | // Webkit bug: https://bugs.webkit.org/show_bug.cgi?id=29084 | |
| 10621 | // Blink bug: https://bugs.chromium.org/p/chromium/issues/detail?id=589347 | |
| 10622 | // getComputedStyle returns percent when specified for top/left/bottom/right; | |
| 10623 | // rather than make the css module depend on the offset module, just check for it here | |
| 10624 | jQuery.each( [ "top", "left" ], function( _i, prop ) { | |
| 10625 | jQuery.cssHooks[ prop ] = addGetHookIf( support.pixelPosition, | |
| 10626 | function( elem, computed ) { | |
| 10627 | if ( computed ) { | |
| 10628 | computed = curCSS( elem, prop ); | |
| 10629 | ||
| 10630 | // If curCSS returns percentage, fallback to offset | |
| 10631 | return rnumnonpx.test( computed ) ? | |
| 10632 | jQuery( elem ).position()[ prop ] + "px" : | |
| 10633 | computed; | |
| 10634 | } | |
| 10635 | } | |
| 10636 | ); | |
| 10637 | } ); | |
| 10638 | ||
| 10639 | ||
| 10640 | // Create innerHeight, innerWidth, height, width, outerHeight and outerWidth methods | |
| 10641 | jQuery.each( { Height: "height", Width: "width" }, function( name, type ) { | |
| 10642 | jQuery.each( { padding: "inner" + name, content: type, "": "outer" + name }, | |
| 10643 | function( defaultExtra, funcName ) { | |
| 10644 | ||
| 10645 | // Margin is only for outerHeight, outerWidth | |
| 10646 | jQuery.fn[ funcName ] = function( margin, value ) { | |
| 10647 | var chainable = arguments.length && ( defaultExtra || typeof margin !== "boolean" ), | |
| 10648 | extra = defaultExtra || ( margin === true || value === true ? "margin" : "border" ); | |
| 10649 | ||
| 10650 | return access( this, function( elem, type, value ) { | |
| 10651 | var doc; | |
| 10652 | ||
| 10653 | if ( isWindow( elem ) ) { | |
| 10654 | ||
| 10655 | // $( window ).outerWidth/Height return w/h including scrollbars (gh-1729) | |
| 10656 | return funcName.indexOf( "outer" ) === 0 ? | |
| 10657 | elem[ "inner" + name ] : | |
| 10658 | elem.document.documentElement[ "client" + name ]; | |
| 10659 | } | |
| 10660 | ||
| 10661 | // Get document width or height | |
| 10662 | if ( elem.nodeType === 9 ) { | |
| 10663 | doc = elem.documentElement; | |
| 10664 | ||
| 10665 | // Either scroll[Width/Height] or offset[Width/Height] or client[Width/Height], | |
| 10666 | // whichever is greatest | |
| 10667 | return Math.max( | |
| 10668 | elem.body[ "scroll" + name ], doc[ "scroll" + name ], | |
| 10669 | elem.body[ "offset" + name ], doc[ "offset" + name ], | |
| 10670 | doc[ "client" + name ] | |
| 10671 | ); | |
| 10672 | } | |
| 10673 | ||
| 10674 | return value === undefined ? | |
| 10675 | ||
| 10676 | // Get width or height on the element, requesting but not forcing parseFloat | |
| 10677 | jQuery.css( elem, type, extra ) : | |
| 10678 | ||
| 10679 | // Set width or height on the element | |
| 10680 | jQuery.style( elem, type, value, extra ); | |
| 10681 | }, type, chainable ? margin : undefined, chainable ); | |
| 10682 | }; | |
| 10683 | } ); | |
| 10684 | } ); | |
| 10685 | ||
| 10686 | ||
| 10687 | jQuery.each( [ | |
| 10688 | "ajaxStart", | |
| 10689 | "ajaxStop", | |
| 10690 | "ajaxComplete", | |
| 10691 | "ajaxError", | |
| 10692 | "ajaxSuccess", | |
| 10693 | "ajaxSend" | |
| 10694 | ], function( _i, type ) { | |
| 10695 | jQuery.fn[ type ] = function( fn ) { | |
| 10696 | return this.on( type, fn ); | |
| 10697 | }; | |
| 10698 | } ); | |
| 10699 | ||
| 10700 | ||
| 10701 | ||
| 10702 | ||
| 10703 | jQuery.fn.extend( { | |
| 10704 | ||
| 10705 | bind: function( types, data, fn ) { | |
| 10706 | return this.on( types, null, data, fn ); | |
| 10707 | }, | |
| 10708 | unbind: function( types, fn ) { | |
| 10709 | return this.off( types, null, fn ); | |
| 10710 | }, | |
| 10711 | ||
| 10712 | delegate: function( selector, types, data, fn ) { | |
| 10713 | return this.on( types, selector, data, fn ); | |
| 10714 | }, | |
| 10715 | undelegate: function( selector, types, fn ) { | |
| 10716 | ||
| 10717 | // ( namespace ) or ( selector, types [, fn] ) | |
| 10718 | return arguments.length === 1 ? | |
| 10719 | this.off( selector, "**" ) : | |
| 10720 | this.off( types, selector || "**", fn ); | |
| 10721 | }, | |
| 10722 | ||
| 10723 | hover: function( fnOver, fnOut ) { | |
| 10724 | return this.mouseenter( fnOver ).mouseleave( fnOut || fnOver ); | |
| 10725 | } | |
| 10726 | } ); | |
| 10727 | ||
| 10728 | jQuery.each( ( "blur focus focusin focusout resize scroll click dblclick " + | |
| 10729 | "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " + | |
| 10730 | "change select submit keydown keypress keyup contextmenu" ).split( " " ), | |
| 10731 | function( _i, name ) { | |
| 10732 | ||
| 10733 | // Handle event binding | |
| 10734 | jQuery.fn[ name ] = function( data, fn ) { | |
| 10735 | return arguments.length > 0 ? | |
| 10736 | this.on( name, null, data, fn ) : | |
| 10737 | this.trigger( name ); | |
| 10738 | }; | |
| 10739 | } ); | |
| 10740 | ||
| 10741 | ||
| 10742 | ||
| 10743 | ||
| 10744 | // Support: Android <=4.0 only | |
| 10745 | // Make sure we trim BOM and NBSP | |
| 10746 | var rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g; | |
| 10747 | ||
| 10748 | // Bind a function to a context, optionally partially applying any | |
| 10749 | // arguments. | |
| 10750 | // jQuery.proxy is deprecated to promote standards (specifically Function#bind) | |
| 10751 | // However, it is not slated for removal any time soon | |
| 10752 | jQuery.proxy = function( fn, context ) { | |
| 10753 | var tmp, args, proxy; | |
| 10754 | ||
| 10755 | if ( typeof context === "string" ) { | |
| 10756 | tmp = fn[ context ]; | |
| 10757 | context = fn; | |
| 10758 | fn = tmp; | |
| 10759 | } | |
| 10760 | ||
| 10761 | // Quick check to determine if target is callable, in the spec | |
| 10762 | // this throws a TypeError, but we will just return undefined. | |
| 10763 | if ( !isFunction( fn ) ) { | |
| 10764 | return undefined; | |
| 10765 | } | |
| 10766 | ||
| 10767 | // Simulated bind | |
| 10768 | args = slice.call( arguments, 2 ); | |
| 10769 | proxy = function() { | |
| 10770 | return fn.apply( context || this, args.concat( slice.call( arguments ) ) ); | |
| 10771 | }; | |
| 10772 | ||
| 10773 | // Set the guid of unique handler to the same of original handler, so it can be removed | |
| 10774 | proxy.guid = fn.guid = fn.guid || jQuery.guid++; | |
| 10775 | ||
| 10776 | return proxy; | |
| 10777 | }; | |
| 10778 | ||
| 10779 | jQuery.holdReady = function( hold ) { | |
| 10780 | if ( hold ) { | |
| 10781 | jQuery.readyWait++; | |
| 10782 | } else { | |
| 10783 | jQuery.ready( true ); | |
| 10784 | } | |
| 10785 | }; | |
| 10786 | jQuery.isArray = Array.isArray; | |
| 10787 | jQuery.parseJSON = JSON.parse; | |
| 10788 | jQuery.nodeName = nodeName; | |
| 10789 | jQuery.isFunction = isFunction; | |
| 10790 | jQuery.isWindow = isWindow; | |
| 10791 | jQuery.camelCase = camelCase; | |
| 10792 | jQuery.type = toType; | |
| 10793 | ||
| 10794 | jQuery.now = Date.now; | |
| 10795 | ||
| 10796 | jQuery.isNumeric = function( obj ) { | |
| 10797 | ||
| 10798 | // As of jQuery 3.0, isNumeric is limited to | |
| 10799 | // strings and numbers (primitives or objects) | |
| 10800 | // that can be coerced to finite numbers (gh-2662) | |
| 10801 | var type = jQuery.type( obj ); | |
| 10802 | return ( type === "number" || type === "string" ) && | |
| 10803 | ||
| 10804 | // parseFloat NaNs numeric-cast false positives ("") | |
| 10805 | // ...but misinterprets leading-number strings, particularly hex literals ("0x...") | |
| 10806 | // subtraction forces infinities to NaN | |
| 10807 | !isNaN( obj - parseFloat( obj ) ); | |
| 10808 | }; | |
| 10809 | ||
| 10810 | jQuery.trim = function( text ) { | |
| 10811 | return text == null ? | |
| 10812 | "" : | |
| 10813 | ( text + "" ).replace( rtrim, "" ); | |
| 10814 | }; | |
| 10815 | ||
| 10816 | ||
| 10817 | ||
| 10818 | // Register as a named AMD module, since jQuery can be concatenated with other | |
| 10819 | // files that may use define, but not via a proper concatenation script that | |
| 10820 | // understands anonymous AMD modules. A named AMD is safest and most robust | |
| 10821 | // way to register. Lowercase jquery is used because AMD module names are | |
| 10822 | // derived from file names, and jQuery is normally delivered in a lowercase | |
| 10823 | // file name. Do this after creating the global so that if an AMD module wants | |
| 10824 | // to call noConflict to hide this version of jQuery, it will work. | |
| 10825 | ||
| 10826 | // Note that for maximum portability, libraries that are not jQuery should | |
| 10827 | // declare themselves as anonymous modules, and avoid setting a global if an | |
| 10828 | // AMD loader is present. jQuery is a special case. For more information, see | |
| 10829 | // https://github.com/jrburke/requirejs/wiki/Updating-existing-libraries#wiki-anon | |
| 10830 | ||
| 10831 | if ( typeof define === "function" && define.amd ) { | |
| 10832 | define( "jquery", [], function() { | |
| 10833 | return jQuery; | |
| 10834 | } ); | |
| 10835 | } | |
| 10836 | ||
| 10837 | ||
| 10838 | ||
| 10839 | ||
| 10840 | var | |
| 10841 | ||
| 10842 | // Map over jQuery in case of overwrite | |
| 10843 | _jQuery = window.jQuery, | |
| 10844 | ||
| 10845 | // Map over the $ in case of overwrite | |
| 10846 | _$ = window.$; | |
| 10847 | ||
| 10848 | jQuery.noConflict = function( deep ) { | |
| 10849 | if ( window.$ === jQuery ) { | |
| 10850 | window.$ = _$; | |
| 10851 | } | |
| 10852 | ||
| 10853 | if ( deep && window.jQuery === jQuery ) { | |
| 10854 | window.jQuery = _jQuery; | |
| 10855 | } | |
| 10856 | ||
| 10857 | return jQuery; | |
| 10858 | }; | |
| 10859 | ||
| 10860 | // Expose jQuery and $ identifiers, even in AMD | |
| 10861 | // (#7102#comment:10, https://github.com/jquery/jquery/pull/557) | |
| 10862 | // and CommonJS for browser emulators (#13566) | |
| 10863 | if ( typeof noGlobal === "undefined" ) { | |
| 10864 | window.jQuery = window.$ = jQuery; | |
| 10865 | } | |
| 10866 | ||
| 10867 | ||
| 10868 | ||
| 10869 | ||
| 10870 | return jQuery; | |
| 10871 | } ); |
| 0 | /*! | |
| 1 | * jQuery JavaScript Library v1.11.3 | |
| 2 | * http://jquery.com/ | |
| 3 | * | |
| 4 | * Includes Sizzle.js | |
| 5 | * http://sizzlejs.com/ | |
| 6 | * | |
| 7 | * Copyright 2005, 2014 jQuery Foundation, Inc. and other contributors | |
| 8 | * Released under the MIT license | |
| 9 | * http://jquery.org/license | |
| 10 | * | |
| 11 | * Date: 2015-09-23T12:31Z | |
| 12 | */ | |
| 13 | ||
| 14 | (function( global, factory ) { | |
| 15 | ||
| 16 | if ( typeof module === "object" && typeof module.exports === "object" ) { | |
| 17 | // For CommonJS and CommonJS-like environments where a proper window is present, | |
| 18 | // execute the factory and get jQuery | |
| 19 | // For environments that do not inherently posses a window with a document | |
| 20 | // (such as Node.js), expose a jQuery-making factory as module.exports | |
| 21 | // This accentuates the need for the creation of a real window | |
| 22 | // e.g. var jQuery = require("jquery")(window); | |
| 23 | // See ticket #14549 for more info | |
| 24 | module.exports = global.document ? | |
| 25 | factory( global, true ) : | |
| 26 | function( w ) { | |
| 27 | if ( !w.document ) { | |
| 28 | throw new Error( "jQuery requires a window with a document" ); | |
| 29 | } | |
| 30 | return factory( w ); | |
| 31 | }; | |
| 32 | } else { | |
| 33 | factory( global ); | |
| 34 | } | |
| 35 | ||
| 36 | // Pass this if window is not defined yet | |
| 37 | }(typeof window !== "undefined" ? window : this, function( window, noGlobal ) { | |
| 38 | ||
| 39 | // Can't do this because several apps including ASP.NET trace | |
| 40 | // the stack via arguments.caller.callee and Firefox dies if | |
| 41 | // you try to trace through "use strict" call chains. (#13335) | |
| 42 | // Support: Firefox 18+ | |
| 43 | // | |
| 44 | var deletedIds = []; | |
| 45 | ||
| 46 | var slice = deletedIds.slice; | |
| 47 | ||
| 48 | var concat = deletedIds.concat; | |
| 49 | ||
| 50 | var push = deletedIds.push; | |
| 51 | ||
| 52 | var indexOf = deletedIds.indexOf; | |
| 53 | ||
| 54 | var class2type = {}; | |
| 55 | ||
| 56 | var toString = class2type.toString; | |
| 57 | ||
| 58 | var hasOwn = class2type.hasOwnProperty; | |
| 59 | ||
| 60 | var support = {}; | |
| 61 | ||
| 62 | ||
| 63 | ||
| 64 | var | |
| 65 | version = "1.11.3", | |
| 66 | ||
| 67 | // Define a local copy of jQuery | |
| 68 | jQuery = function( selector, context ) { | |
| 69 | // The jQuery object is actually just the init constructor 'enhanced' | |
| 70 | // Need init if jQuery is called (just allow error to be thrown if not included) | |
| 71 | return new jQuery.fn.init( selector, context ); | |
| 72 | }, | |
| 73 | ||
| 74 | // Support: Android<4.1, IE<9 | |
| 75 | // Make sure we trim BOM and NBSP | |
| 76 | rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g, | |
| 77 | ||
| 78 | // Matches dashed string for camelizing | |
| 79 | rmsPrefix = /^-ms-/, | |
| 80 | rdashAlpha = /-([\da-z])/gi, | |
| 81 | ||
| 82 | // Used by jQuery.camelCase as callback to replace() | |
| 83 | fcamelCase = function( all, letter ) { | |
| 84 | return letter.toUpperCase(); | |
| 85 | }; | |
| 86 | ||
| 87 | jQuery.fn = jQuery.prototype = { | |
| 88 | // The current version of jQuery being used | |
| 89 | jquery: version, | |
| 90 | ||
| 91 | constructor: jQuery, | |
| 92 | ||
| 93 | // Start with an empty selector | |
| 94 | selector: "", | |
| 95 | ||
| 96 | // The default length of a jQuery object is 0 | |
| 97 | length: 0, | |
| 98 | ||
| 99 | toArray: function() { | |
| 100 | return slice.call( this ); | |
| 101 | }, | |
| 102 | ||
| 103 | // Get the Nth element in the matched element set OR | |
| 104 | // Get the whole matched element set as a clean array | |
| 105 | get: function( num ) { | |
| 106 | return num != null ? | |
| 107 | ||
| 108 | // Return just the one element from the set | |
| 109 | ( num < 0 ? this[ num + this.length ] : this[ num ] ) : | |
| 110 | ||
| 111 | // Return all the elements in a clean array | |
| 112 | slice.call( this ); | |
| 113 | }, | |
| 114 | ||
| 115 | // Take an array of elements and push it onto the stack | |
| 116 | // (returning the new matched element set) | |
| 117 | pushStack: function( elems ) { | |
| 118 | ||
| 119 | // Build a new jQuery matched element set | |
| 120 | var ret = jQuery.merge( this.constructor(), elems ); | |
| 121 | ||
| 122 | // Add the old object onto the stack (as a reference) | |
| 123 | ret.prevObject = this; | |
| 124 | ret.context = this.context; | |
| 125 | ||
| 126 | // Return the newly-formed element set | |
| 127 | return ret; | |
| 128 | }, | |
| 129 | ||
| 130 | // Execute a callback for every element in the matched set. | |
| 131 | // (You can seed the arguments with an array of args, but this is | |
| 132 | // only used internally.) | |
| 133 | each: function( callback, args ) { | |
| 134 | return jQuery.each( this, callback, args ); | |
| 135 | }, | |
| 136 | ||
| 137 | map: function( callback ) { | |
| 138 | return this.pushStack( jQuery.map(this, function( elem, i ) { | |
| 139 | return callback.call( elem, i, elem ); | |
| 140 | })); | |
| 141 | }, | |
| 142 | ||
| 143 | slice: function() { | |
| 144 | return this.pushStack( slice.apply( this, arguments ) ); | |
| 145 | }, | |
| 146 | ||
| 147 | first: function() { | |
| 148 | return this.eq( 0 ); | |
| 149 | }, | |
| 150 | ||
| 151 | last: function() { | |
| 152 | return this.eq( -1 ); | |
| 153 | }, | |
| 154 | ||
| 155 | eq: function( i ) { | |
| 156 | var len = this.length, | |
| 157 | j = +i + ( i < 0 ? len : 0 ); | |
| 158 | return this.pushStack( j >= 0 && j < len ? [ this[j] ] : [] ); | |
| 159 | }, | |
| 160 | ||
| 161 | end: function() { | |
| 162 | return this.prevObject || this.constructor(null); | |
| 163 | }, | |
| 164 | ||
| 165 | // For internal use only. | |
| 166 | // Behaves like an Array's method, not like a jQuery method. | |
| 167 | push: push, | |
| 168 | sort: deletedIds.sort, | |
| 169 | splice: deletedIds.splice | |
| 170 | }; | |
| 171 | ||
| 172 | jQuery.extend = jQuery.fn.extend = function() { | |
| 173 | var src, copyIsArray, copy, name, options, clone, | |
| 174 | target = arguments[0] || {}, | |
| 175 | i = 1, | |
| 176 | length = arguments.length, | |
| 177 | deep = false; | |
| 178 | ||
| 179 | // Handle a deep copy situation | |
| 180 | if ( typeof target === "boolean" ) { | |
| 181 | deep = target; | |
| 182 | ||
| 183 | // skip the boolean and the target | |
| 184 | target = arguments[ i ] || {}; | |
| 185 | i++; | |
| 186 | } | |
| 187 | ||
| 188 | // Handle case when target is a string or something (possible in deep copy) | |
| 189 | if ( typeof target !== "object" && !jQuery.isFunction(target) ) { | |
| 190 | target = {}; | |
| 191 | } | |
| 192 | ||
| 193 | // extend jQuery itself if only one argument is passed | |
| 194 | if ( i === length ) { | |
| 195 | target = this; | |
| 196 | i--; | |
| 197 | } | |
| 198 | ||
| 199 | for ( ; i < length; i++ ) { | |
| 200 | // Only deal with non-null/undefined values | |
| 201 | if ( (options = arguments[ i ]) != null ) { | |
| 202 | // Extend the base object | |
| 203 | for ( name in options ) { | |
| 204 | src = target[ name ]; | |
| 205 | copy = options[ name ]; | |
| 206 | ||
| 207 | // Prevent never-ending loop | |
| 208 | if ( target === copy ) { | |
| 209 | continue; | |
| 210 | } | |
| 211 | ||
| 212 | // Recurse if we're merging plain objects or arrays | |
| 213 | if ( deep && copy && ( jQuery.isPlainObject(copy) || (copyIsArray = jQuery.isArray(copy)) ) ) { | |
| 214 | if ( copyIsArray ) { | |
| 215 | copyIsArray = false; | |
| 216 | clone = src && jQuery.isArray(src) ? src : []; | |
| 217 | ||
| 218 | } else { | |
| 219 | clone = src && jQuery.isPlainObject(src) ? src : {}; | |
| 220 | } | |
| 221 | ||
| 222 | // Never move original objects, clone them | |
| 223 | target[ name ] = jQuery.extend( deep, clone, copy ); | |
| 224 | ||
| 225 | // Don't bring in undefined values | |
| 226 | } else if ( copy !== undefined ) { | |
| 227 | target[ name ] = copy; | |
| 228 | } | |
| 229 | } | |
| 230 | } | |
| 231 | } | |
| 232 | ||
| 233 | // Return the modified object | |
| 234 | return target; | |
| 235 | }; | |
| 236 | ||
| 237 | jQuery.extend({ | |
| 238 | // Unique for each copy of jQuery on the page | |
| 239 | expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), | |
| 240 | ||
| 241 | // Assume jQuery is ready without the ready module | |
| 242 | isReady: true, | |
| 243 | ||
| 244 | error: function( msg ) { | |
| 245 | throw new Error( msg ); | |
| 246 | }, | |
| 247 | ||
| 248 | noop: function() {}, | |
| 249 | ||
| 250 | // See test/unit/core.js for details concerning isFunction. | |
| 251 | // Since version 1.3, DOM methods and functions like alert | |
| 252 | // aren't supported. They return false on IE (#2968). | |
| 253 | isFunction: function( obj ) { | |
| 254 | return jQuery.type(obj) === "function"; | |
| 255 | }, | |
| 256 | ||
| 257 | isArray: Array.isArray || function( obj ) { | |
| 258 | return jQuery.type(obj) === "array"; | |
| 259 | }, | |
| 260 | ||
| 261 | isWindow: function( obj ) { | |
| 262 | /* jshint eqeqeq: false */ | |
| 263 | return obj != null && obj == obj.window; | |
| 264 | }, | |
| 265 | ||
| 266 | isNumeric: function( obj ) { | |
| 267 | // parseFloat NaNs numeric-cast false positives (null|true|false|"") | |
| 268 | // ...but misinterprets leading-number strings, particularly hex literals ("0x...") | |
| 269 | // subtraction forces infinities to NaN | |
| 270 | // adding 1 corrects loss of precision from parseFloat (#15100) | |
| 271 | return !jQuery.isArray( obj ) && (obj - parseFloat( obj ) + 1) >= 0; | |
| 272 | }, | |
| 273 | ||
| 274 | isEmptyObject: function( obj ) { | |
| 275 | var name; | |
| 276 | for ( name in obj ) { | |
| 277 | return false; | |
| 278 | } | |
| 279 | return true; | |
| 280 | }, | |
| 281 | ||
| 282 | isPlainObject: function( obj ) { | |
| 283 | var key; | |
| 284 | ||
| 285 | // Must be an Object. | |
| 286 | // Because of IE, we also have to check the presence of the constructor property. | |
| 287 | // Make sure that DOM nodes and window objects don't pass through, as well | |
| 288 | if ( !obj || jQuery.type(obj) !== "object" || obj.nodeType || jQuery.isWindow( obj ) ) { | |
| 289 | return false; | |
| 290 | } | |
| 291 | ||
| 292 | try { | |
| 293 | // Not own constructor property must be Object | |
| 294 | if ( obj.constructor && | |
| 295 | !hasOwn.call(obj, "constructor") && | |
| 296 | !hasOwn.call(obj.constructor.prototype, "isPrototypeOf") ) { | |
| 297 | return false; | |
| 298 | } | |
| 299 | } catch ( e ) { | |
| 300 | // IE8,9 Will throw exceptions on certain host objects #9897 | |
| 301 | return false; | |
| 302 | } | |
| 303 | ||
| 304 | // Support: IE<9 | |
| 305 | // Handle iteration over inherited properties before own properties. | |
| 306 | if ( support.ownLast ) { | |
| 307 | for ( key in obj ) { | |
| 308 | return hasOwn.call( obj, key ); | |
| 309 | } | |
| 310 | } | |
| 311 | ||
| 312 | // Own properties are enumerated firstly, so to speed up, | |
| 313 | // if last one is own, then all properties are own. | |
| 314 | for ( key in obj ) {} | |
| 315 | ||
| 316 | return key === undefined || hasOwn.call( obj, key ); | |
| 317 | }, | |
| 318 | ||
| 319 | type: function( obj ) { | |
| 320 | if ( obj == null ) { | |
| 321 | return obj + ""; | |
| 322 | } | |
| 323 | return typeof obj === "object" || typeof obj === "function" ? | |
| 324 | class2type[ toString.call(obj) ] || "object" : | |
| 325 | typeof obj; | |
| 326 | }, | |
| 327 | ||
| 328 | // Evaluates a script in a global context | |
| 329 | // Workarounds based on findings by Jim Driscoll | |
| 330 | // http://weblogs.java.net/blog/driscoll/archive/2009/09/08/eval-javascript-global-context | |
| 331 | globalEval: function( data ) { | |
| 332 | if ( data && jQuery.trim( data ) ) { | |
| 333 | // We use execScript on Internet Explorer | |
| 334 | // We use an anonymous function so that context is window | |
| 335 | // rather than jQuery in Firefox | |
| 336 | ( window.execScript || function( data ) { | |
| 337 | window[ "eval" ].call( window, data ); | |
| 338 | } )( data ); | |
| 339 | } | |
| 340 | }, | |
| 341 | ||
| 342 | // Convert dashed to camelCase; used by the css and data modules | |
| 343 | // Microsoft forgot to hump their vendor prefix (#9572) | |
| 344 | camelCase: function( string ) { | |
| 345 | return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); | |
| 346 | }, | |
| 347 | ||
| 348 | nodeName: function( elem, name ) { | |
| 349 | return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); | |
| 350 | }, | |
| 351 | ||
| 352 | // args is for internal usage only | |
| 353 | each: function( obj, callback, args ) { | |
| 354 | var value, | |
| 355 | i = 0, | |
| 356 | length = obj.length, | |
| 357 | isArray = isArraylike( obj ); | |
| 358 | ||
| 359 | if ( args ) { | |
| 360 | if ( isArray ) { | |
| 361 | for ( ; i < length; i++ ) { | |
| 362 | value = callback.apply( obj[ i ], args ); | |
| 363 | ||
| 364 | if ( value === false ) { | |
| 365 | break; | |
| 366 | } | |
| 367 | } | |
| 368 | } else { | |
| 369 | for ( i in obj ) { | |
| 370 | value = callback.apply( obj[ i ], args ); | |
| 371 | ||
| 372 | if ( value === false ) { | |
| 373 | break; | |
| 374 | } | |
| 375 | } | |
| 376 | } | |
| 377 | ||
| 378 | // A special, fast, case for the most common use of each | |
| 379 | } else { | |
| 380 | if ( isArray ) { | |
| 381 | for ( ; i < length; i++ ) { | |
| 382 | value = callback.call( obj[ i ], i, obj[ i ] ); | |
| 383 | ||
| 384 | if ( value === false ) { | |
| 385 | break; | |
| 386 | } | |
| 387 | } | |
| 388 | } else { | |
| 389 | for ( i in obj ) { | |
| 390 | value = callback.call( obj[ i ], i, obj[ i ] ); | |
| 391 | ||
| 392 | if ( value === false ) { | |
| 393 | break; | |
| 394 | } | |
| 395 | } | |
| 396 | } | |
| 397 | } | |
| 398 | ||
| 399 | return obj; | |
| 400 | }, | |
| 401 | ||
| 402 | // Support: Android<4.1, IE<9 | |
| 403 | trim: function( text ) { | |
| 404 | return text == null ? | |
| 405 | "" : | |
| 406 | ( text + "" ).replace( rtrim, "" ); | |
| 407 | }, | |
| 408 | ||
| 409 | // results is for internal usage only | |
| 410 | makeArray: function( arr, results ) { | |
| 411 | var ret = results || []; | |
| 412 | ||
| 413 | if ( arr != null ) { | |
| 414 | if ( isArraylike( Object(arr) ) ) { | |
| 415 | jQuery.merge( ret, | |
| 416 | typeof arr === "string" ? | |
| 417 | [ arr ] : arr | |
| 418 | ); | |
| 419 | } else { | |
| 420 | push.call( ret, arr ); | |
| 421 | } | |
| 422 | } | |
| 423 | ||
| 424 | return ret; | |
| 425 | }, | |
| 426 | ||
| 427 | inArray: function( elem, arr, i ) { | |
| 428 | var len; | |
| 429 | ||
| 430 | if ( arr ) { | |
| 431 | if ( indexOf ) { | |
| 432 | return indexOf.call( arr, elem, i ); | |
| 433 | } | |
| 434 | ||
| 435 | len = arr.length; | |
| 436 | i = i ? i < 0 ? Math.max( 0, len + i ) : i : 0; | |
| 437 | ||
| 438 | for ( ; i < len; i++ ) { | |
| 439 | // Skip accessing in sparse arrays | |
| 440 | if ( i in arr && arr[ i ] === elem ) { | |
| 441 | return i; | |
| 442 | } | |
| 443 | } | |
| 444 | } | |
| 445 | ||
| 446 | return -1; | |
| 447 | }, | |
| 448 | ||
| 449 | merge: function( first, second ) { | |
| 450 | var len = +second.length, | |
| 451 | j = 0, | |
| 452 | i = first.length; | |
| 453 | ||
| 454 | while ( j < len ) { | |
| 455 | first[ i++ ] = second[ j++ ]; | |
| 456 | } | |
| 457 | ||
| 458 | // Support: IE<9 | |
| 459 | // Workaround casting of .length to NaN on otherwise arraylike objects (e.g., NodeLists) | |
| 460 | if ( len !== len ) { | |
| 461 | while ( second[j] !== undefined ) { | |
| 462 | first[ i++ ] = second[ j++ ]; | |
| 463 | } | |
| 464 | } | |
| 465 | ||
| 466 | first.length = i; | |
| 467 | ||
| 468 | return first; | |
| 469 | }, | |
| 470 | ||
| 471 | grep: function( elems, callback, invert ) { | |
| 472 | var callbackInverse, | |
| 473 | matches = [], | |
| 474 | i = 0, | |
| 475 | length = elems.length, | |
| 476 | callbackExpect = !invert; | |
| 477 | ||
| 478 | // Go through the array, only saving the items | |
| 479 | // that pass the validator function | |
| 480 | for ( ; i < length; i++ ) { | |
| 481 | callbackInverse = !callback( elems[ i ], i ); | |
| 482 | if ( callbackInverse !== callbackExpect ) { | |
| 483 | matches.push( elems[ i ] ); | |
| 484 | } | |
| 485 | } | |
| 486 | ||
| 487 | return matches; | |
| 488 | }, | |
| 489 | ||
| 490 | // arg is for internal usage only | |
| 491 | map: function( elems, callback, arg ) { | |
| 492 | var value, | |
| 493 | i = 0, | |
| 494 | length = elems.length, | |
| 495 | isArray = isArraylike( elems ), | |
| 496 | ret = []; | |
| 497 | ||
| 498 | // Go through the array, translating each of the items to their new values | |
| 499 | if ( isArray ) { | |
| 500 | for ( ; i < length; i++ ) { | |
| 501 | value = callback( elems[ i ], i, arg ); | |
| 502 | ||
| 503 | if ( value != null ) { | |
| 504 | ret.push( value ); | |
| 505 | } | |
| 506 | } | |
| 507 | ||
| 508 | // Go through every key on the object, | |
| 509 | } else { | |
| 510 | for ( i in elems ) { | |
| 511 | value = callback( elems[ i ], i, arg ); | |
| 512 | ||
| 513 | if ( value != null ) { | |
| 514 | ret.push( value ); | |
| 515 | } | |
| 516 | } | |
| 517 | } | |
| 518 | ||
| 519 | // Flatten any nested arrays | |
| 520 | return concat.apply( [], ret ); | |
| 521 | }, | |
| 522 | ||
| 523 | // A global GUID counter for objects | |
| 524 | guid: 1, | |
| 525 | ||
| 526 | // Bind a function to a context, optionally partially applying any | |
| 527 | // arguments. | |
| 528 | proxy: function( fn, context ) { | |
| 529 | var args, proxy, tmp; | |
| 530 | ||
| 531 | if ( typeof context === "string" ) { | |
| 532 | tmp = fn[ context ]; | |
| 533 | context = fn; | |
| 534 | fn = tmp; | |
| 535 | } | |
| 536 | ||
| 537 | // Quick check to determine if target is callable, in the spec | |
| 538 | // this throws a TypeError, but we will just return undefined. | |
| 539 | if ( !jQuery.isFunction( fn ) ) { | |
| 540 | return undefined; | |
| 541 | } | |
| 542 | ||
| 543 | // Simulated bind | |
| 544 | args = slice.call( arguments, 2 ); | |
| 545 | proxy = function() { | |
| 546 | return fn.apply( context || this, args.concat( slice.call( arguments ) ) ); | |
| 547 | }; | |
| 548 | ||
| 549 | // Set the guid of unique handler to the same of original handler, so it can be removed | |
| 550 | proxy.guid = fn.guid = fn.guid || jQuery.guid++; | |
| 551 | ||
| 552 | return proxy; | |
| 553 | }, | |
| 554 | ||
| 555 | now: function() { | |
| 556 | return +( new Date() ); | |
| 557 | }, | |
| 558 | ||
| 559 | // jQuery.support is not used in Core but other projects attach their | |
| 560 | // properties to it so it needs to exist. | |
| 561 | support: support | |
| 562 | }); | |
| 563 | ||
| 564 | // Populate the class2type map | |
| 565 | jQuery.each("Boolean Number String Function Array Date RegExp Object Error".split(" "), function(i, name) { | |
| 566 | class2type[ "[object " + name + "]" ] = name.toLowerCase(); | |
| 567 | }); | |
| 568 | ||
| 569 | function isArraylike( obj ) { | |
| 570 | ||
| 571 | // Support: iOS 8.2 (not reproducible in simulator) | |
| 572 | // `in` check used to prevent JIT error (gh-2145) | |
| 573 | // hasOwn isn't used here due to false negatives | |
| 574 | // regarding Nodelist length in IE | |
| 575 | var length = "length" in obj && obj.length, | |
| 576 | type = jQuery.type( obj ); | |
| 577 | ||
| 578 | if ( type === "function" || jQuery.isWindow( obj ) ) { | |
| 579 | return false; | |
| 580 | } | |
| 581 | ||
| 582 | if ( obj.nodeType === 1 && length ) { | |
| 583 | return true; | |
| 584 | } | |
| 585 | ||
| 586 | return type === "array" || length === 0 || | |
| 587 | typeof length === "number" && length > 0 && ( length - 1 ) in obj; | |
| 588 | } | |
| 589 | var Sizzle = | |
| 590 | /*! | |
| 591 | * Sizzle CSS Selector Engine v2.2.0-pre | |
| 592 | * http://sizzlejs.com/ | |
| 593 | * | |
| 594 | * Copyright 2008, 2014 jQuery Foundation, Inc. and other contributors | |
| 595 | * Released under the MIT license | |
| 596 | * http://jquery.org/license | |
| 597 | * | |
| 598 | * Date: 2014-12-16 | |
| 599 | */ | |
| 600 | (function( window ) { | |
| 601 | ||
| 602 | var i, | |
| 603 | support, | |
| 604 | Expr, | |
| 605 | getText, | |
| 606 | isXML, | |
| 607 | tokenize, | |
| 608 | compile, | |
| 609 | select, | |
| 610 | outermostContext, | |
| 611 | sortInput, | |
| 612 | hasDuplicate, | |
| 613 | ||
| 614 | // Local document vars | |
| 615 | setDocument, | |
| 616 | document, | |
| 617 | docElem, | |
| 618 | documentIsHTML, | |
| 619 | rbuggyQSA, | |
| 620 | rbuggyMatches, | |
| 621 | matches, | |
| 622 | contains, | |
| 623 | ||
| 624 | // Instance-specific data | |
| 625 | expando = "sizzle" + 1 * new Date(), | |
| 626 | preferredDoc = window.document, | |
| 627 | dirruns = 0, | |
| 628 | done = 0, | |
| 629 | classCache = createCache(), | |
| 630 | tokenCache = createCache(), | |
| 631 | compilerCache = createCache(), | |
| 632 | sortOrder = function( a, b ) { | |
| 633 | if ( a === b ) { | |
| 634 | hasDuplicate = true; | |
| 635 | } | |
| 636 | return 0; | |
| 637 | }, | |
| 638 | ||
| 639 | // General-purpose constants | |
| 640 | MAX_NEGATIVE = 1 << 31, | |
| 641 | ||
| 642 | // Instance methods | |
| 643 | hasOwn = ({}).hasOwnProperty, | |
| 644 | arr = [], | |
| 645 | pop = arr.pop, | |
| 646 | push_native = arr.push, | |
| 647 | push = arr.push, | |
| 648 | slice = arr.slice, | |
| 649 | // Use a stripped-down indexOf as it's faster than native | |
| 650 | // http://jsperf.com/thor-indexof-vs-for/5 | |
| 651 | indexOf = function( list, elem ) { | |
| 652 | var i = 0, | |
| 653 | len = list.length; | |
| 654 | for ( ; i < len; i++ ) { | |
| 655 | if ( list[i] === elem ) { | |
| 656 | return i; | |
| 657 | } | |
| 658 | } | |
| 659 | return -1; | |
| 660 | }, | |
| 661 | ||
| 662 | booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", | |
| 663 | ||
| 664 | // Regular expressions | |
| 665 | ||
| 666 | // Whitespace characters http://www.w3.org/TR/css3-selectors/#whitespace | |
| 667 | whitespace = "[\\x20\\t\\r\\n\\f]", | |
| 668 | // http://www.w3.org/TR/css3-syntax/#characters | |
| 669 | characterEncoding = "(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+", | |
| 670 | ||
| 671 | // Loosely modeled on CSS identifier characters | |
| 672 | // An unquoted value should be a CSS identifier http://www.w3.org/TR/css3-selectors/#attribute-selectors | |
| 673 | // Proper syntax: http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier | |
| 674 | identifier = characterEncoding.replace( "w", "w#" ), | |
| 675 | ||
| 676 | // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors | |
| 677 | attributes = "\\[" + whitespace + "*(" + characterEncoding + ")(?:" + whitespace + | |
| 678 | // Operator (capture 2) | |
| 679 | "*([*^$|!~]?=)" + whitespace + | |
| 680 | // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" | |
| 681 | "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + | |
| 682 | "*\\]", | |
| 683 | ||
| 684 | pseudos = ":(" + characterEncoding + ")(?:\\((" + | |
| 685 | // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: | |
| 686 | // 1. quoted (capture 3; capture 4 or capture 5) | |
| 687 | "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + | |
| 688 | // 2. simple (capture 6) | |
| 689 | "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + | |
| 690 | // 3. anything else (capture 2) | |
| 691 | ".*" + | |
| 692 | ")\\)|)", | |
| 693 | ||
| 694 | // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter | |
| 695 | rwhitespace = new RegExp( whitespace + "+", "g" ), | |
| 696 | rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), | |
| 697 | ||
| 698 | rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), | |
| 699 | rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), | |
| 700 | ||
| 701 | rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ), | |
| 702 | ||
| 703 | rpseudo = new RegExp( pseudos ), | |
| 704 | ridentifier = new RegExp( "^" + identifier + "$" ), | |
| 705 | ||
| 706 | matchExpr = { | |
| 707 | "ID": new RegExp( "^#(" + characterEncoding + ")" ), | |
| 708 | "CLASS": new RegExp( "^\\.(" + characterEncoding + ")" ), | |
| 709 | "TAG": new RegExp( "^(" + characterEncoding.replace( "w", "w*" ) + ")" ), | |
| 710 | "ATTR": new RegExp( "^" + attributes ), | |
| 711 | "PSEUDO": new RegExp( "^" + pseudos ), | |
| 712 | "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + | |
| 713 | "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + | |
| 714 | "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), | |
| 715 | "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), | |
| 716 | // For use in libraries implementing .is() | |
| 717 | // We use this for POS matching in `select` | |
| 718 | "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + | |
| 719 | whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) | |
| 720 | }, | |
| 721 | ||
| 722 | rinputs = /^(?:input|select|textarea|button)$/i, | |
| 723 | rheader = /^h\d$/i, | |
| 724 | ||
| 725 | rnative = /^[^{]+\{\s*\[native \w/, | |
| 726 | ||
| 727 | // Easily-parseable/retrievable ID or TAG or CLASS selectors | |
| 728 | rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, | |
| 729 | ||
| 730 | rsibling = /[+~]/, | |
| 731 | rescape = /'|\\/g, | |
| 732 | ||
| 733 | // CSS escapes http://www.w3.org/TR/CSS21/syndata.html#escaped-characters | |
| 734 | runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), | |
| 735 | funescape = function( _, escaped, escapedWhitespace ) { | |
| 736 | var high = "0x" + escaped - 0x10000; | |
| 737 | // NaN means non-codepoint | |
| 738 | // Support: Firefox<24 | |
| 739 | // Workaround erroneous numeric interpretation of +"0x" | |
| 740 | return high !== high || escapedWhitespace ? | |
| 741 | escaped : | |
| 742 | high < 0 ? | |
| 743 | // BMP codepoint | |
| 744 | String.fromCharCode( high + 0x10000 ) : | |
| 745 | // Supplemental Plane codepoint (surrogate pair) | |
| 746 | String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); | |
| 747 | }, | |
| 748 | ||
| 749 | // Used for iframes | |
| 750 | // See setDocument() | |
| 751 | // Removing the function wrapper causes a "Permission Denied" | |
| 752 | // error in IE | |
| 753 | unloadHandler = function() { | |
| 754 | setDocument(); | |
| 755 | }; | |
| 756 | ||
| 757 | // Optimize for push.apply( _, NodeList ) | |
| 758 | try { | |
| 759 | push.apply( | |
| 760 | (arr = slice.call( preferredDoc.childNodes )), | |
| 761 | preferredDoc.childNodes | |
| 762 | ); | |
| 763 | // Support: Android<4.0 | |
| 764 | // Detect silently failing push.apply | |
| 765 | arr[ preferredDoc.childNodes.length ].nodeType; | |
| 766 | } catch ( e ) { | |
| 767 | push = { apply: arr.length ? | |
| 768 | ||
| 769 | // Leverage slice if possible | |
| 770 | function( target, els ) { | |
| 771 | push_native.apply( target, slice.call(els) ); | |
| 772 | } : | |
| 773 | ||
| 774 | // Support: IE<9 | |
| 775 | // Otherwise append directly | |
| 776 | function( target, els ) { | |
| 777 | var j = target.length, | |
| 778 | i = 0; | |
| 779 | // Can't trust NodeList.length | |
| 780 | while ( (target[j++] = els[i++]) ) {} | |
| 781 | target.length = j - 1; | |
| 782 | } | |
| 783 | }; | |
| 784 | } | |
| 785 | ||
| 786 | function Sizzle( selector, context, results, seed ) { | |
| 787 | var match, elem, m, nodeType, | |
| 788 | // QSA vars | |
| 789 | i, groups, old, nid, newContext, newSelector; | |
| 790 | ||
| 791 | if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { | |
| 792 | setDocument( context ); | |
| 793 | } | |
| 794 | ||
| 795 | context = context || document; | |
| 796 | results = results || []; | |
| 797 | nodeType = context.nodeType; | |
| 798 | ||
| 799 | if ( typeof selector !== "string" || !selector || | |
| 800 | nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { | |
| 801 | ||
| 802 | return results; | |
| 803 | } | |
| 804 | ||
| 805 | if ( !seed && documentIsHTML ) { | |
| 806 | ||
| 807 | // Try to shortcut find operations when possible (e.g., not under DocumentFragment) | |
| 808 | if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { | |
| 809 | // Speed-up: Sizzle("#ID") | |
| 810 | if ( (m = match[1]) ) { | |
| 811 | if ( nodeType === 9 ) { | |
| 812 | elem = context.getElementById( m ); | |
| 813 | // Check parentNode to catch when Blackberry 4.6 returns | |
| 814 | // nodes that are no longer in the document (jQuery #6963) | |
| 815 | if ( elem && elem.parentNode ) { | |
| 816 | // Handle the case where IE, Opera, and Webkit return items | |
| 817 | // by name instead of ID | |
| 818 | if ( elem.id === m ) { | |
| 819 | results.push( elem ); | |
| 820 | return results; | |
| 821 | } | |
| 822 | } else { | |
| 823 | return results; | |
| 824 | } | |
| 825 | } else { | |
| 826 | // Context is not a document | |
| 827 | if ( context.ownerDocument && (elem = context.ownerDocument.getElementById( m )) && | |
| 828 | contains( context, elem ) && elem.id === m ) { | |
| 829 | results.push( elem ); | |
| 830 | return results; | |
| 831 | } | |
| 832 | } | |
| 833 | ||
| 834 | // Speed-up: Sizzle("TAG") | |
| 835 | } else if ( match[2] ) { | |
| 836 | push.apply( results, context.getElementsByTagName( selector ) ); | |
| 837 | return results; | |
| 838 | ||
| 839 | // Speed-up: Sizzle(".CLASS") | |
| 840 | } else if ( (m = match[3]) && support.getElementsByClassName ) { | |
| 841 | push.apply( results, context.getElementsByClassName( m ) ); | |
| 842 | return results; | |
| 843 | } | |
| 844 | } | |
| 845 | ||
| 846 | // QSA path | |
| 847 | if ( support.qsa && (!rbuggyQSA || !rbuggyQSA.test( selector )) ) { | |
| 848 | nid = old = expando; | |
| 849 | newContext = context; | |
| 850 | newSelector = nodeType !== 1 && selector; | |
| 851 | ||
| 852 | // qSA works strangely on Element-rooted queries | |
| 853 | // We can work around this by specifying an extra ID on the root | |
| 854 | // and working up from there (Thanks to Andrew Dupont for the technique) | |
| 855 | // IE 8 doesn't work on object elements | |
| 856 | if ( nodeType === 1 && context.nodeName.toLowerCase() !== "object" ) { | |
| 857 | groups = tokenize( selector ); | |
| 858 | ||
| 859 | if ( (old = context.getAttribute("id")) ) { | |
| 860 | nid = old.replace( rescape, "\\$&" ); | |
| 861 | } else { | |
| 862 | context.setAttribute( "id", nid ); | |
| 863 | } | |
| 864 | nid = "[id='" + nid + "'] "; | |
| 865 | ||
| 866 | i = groups.length; | |
| 867 | while ( i-- ) { | |
| 868 | groups[i] = nid + toSelector( groups[i] ); | |
| 869 | } | |
| 870 | newContext = rsibling.test( selector ) && testContext( context.parentNode ) || context; | |
| 871 | newSelector = groups.join(","); | |
| 872 | } | |
| 873 | ||
| 874 | if ( newSelector ) { | |
| 875 | try { | |
| 876 | push.apply( results, | |
| 877 | newContext.querySelectorAll( newSelector ) | |
| 878 | ); | |
| 879 | return results; | |
| 880 | } catch(qsaError) { | |
| 881 | } finally { | |
| 882 | if ( !old ) { | |
| 883 | context.removeAttribute("id"); | |
| 884 | } | |
| 885 | } | |
| 886 | } | |
| 887 | } | |
| 888 | } | |
| 889 | ||
| 890 | // All others | |
| 891 | return select( selector.replace( rtrim, "$1" ), context, results, seed ); | |
| 892 | } | |
| 893 | ||
| 894 | /** | |
| 895 | * Create key-value caches of limited size | |
| 896 | * @returns {Function(string, Object)} Returns the Object data after storing it on itself with | |
| 897 | * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) | |
| 898 | * deleting the oldest entry | |
| 899 | */ | |
| 900 | function createCache() { | |
| 901 | var keys = []; | |
| 902 | ||
| 903 | function cache( key, value ) { | |
| 904 | // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) | |
| 905 | if ( keys.push( key + " " ) > Expr.cacheLength ) { | |
| 906 | // Only keep the most recent entries | |
| 907 | delete cache[ keys.shift() ]; | |
| 908 | } | |
| 909 | return (cache[ key + " " ] = value); | |
| 910 | } | |
| 911 | return cache; | |
| 912 | } | |
| 913 | ||
| 914 | /** | |
| 915 | * Mark a function for special use by Sizzle | |
| 916 | * @param {Function} fn The function to mark | |
| 917 | */ | |
| 918 | function markFunction( fn ) { | |
| 919 | fn[ expando ] = true; | |
| 920 | return fn; | |
| 921 | } | |
| 922 | ||
| 923 | /** | |
| 924 | * Support testing using an element | |
| 925 | * @param {Function} fn Passed the created div and expects a boolean result | |
| 926 | */ | |
| 927 | function assert( fn ) { | |
| 928 | var div = document.createElement("div"); | |
| 929 | ||
| 930 | try { | |
| 931 | return !!fn( div ); | |
| 932 | } catch (e) { | |
| 933 | return false; | |
| 934 | } finally { | |
| 935 | // Remove from its parent by default | |
| 936 | if ( div.parentNode ) { | |
| 937 | div.parentNode.removeChild( div ); | |
| 938 | } | |
| 939 | // release memory in IE | |
| 940 | div = null; | |
| 941 | } | |
| 942 | } | |
| 943 | ||
| 944 | /** | |
| 945 | * Adds the same handler for all of the specified attrs | |
| 946 | * @param {String} attrs Pipe-separated list of attributes | |
| 947 | * @param {Function} handler The method that will be applied | |
| 948 | */ | |
| 949 | function addHandle( attrs, handler ) { | |
| 950 | var arr = attrs.split("|"), | |
| 951 | i = attrs.length; | |
| 952 | ||
| 953 | while ( i-- ) { | |
| 954 | Expr.attrHandle[ arr[i] ] = handler; | |
| 955 | } | |
| 956 | } | |
| 957 | ||
| 958 | /** | |
| 959 | * Checks document order of two siblings | |
| 960 | * @param {Element} a | |
| 961 | * @param {Element} b | |
| 962 | * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b | |
| 963 | */ | |
| 964 | function siblingCheck( a, b ) { | |
| 965 | var cur = b && a, | |
| 966 | diff = cur && a.nodeType === 1 && b.nodeType === 1 && | |
| 967 | ( ~b.sourceIndex || MAX_NEGATIVE ) - | |
| 968 | ( ~a.sourceIndex || MAX_NEGATIVE ); | |
| 969 | ||
| 970 | // Use IE sourceIndex if available on both nodes | |
| 971 | if ( diff ) { | |
| 972 | return diff; | |
| 973 | } | |
| 974 | ||
| 975 | // Check if b follows a | |
| 976 | if ( cur ) { | |
| 977 | while ( (cur = cur.nextSibling) ) { | |
| 978 | if ( cur === b ) { | |
| 979 | return -1; | |
| 980 | } | |
| 981 | } | |
| 982 | } | |
| 983 | ||
| 984 | return a ? 1 : -1; | |
| 985 | } | |
| 986 | ||
| 987 | /** | |
| 988 | * Returns a function to use in pseudos for input types | |
| 989 | * @param {String} type | |
| 990 | */ | |
| 991 | function createInputPseudo( type ) { | |
| 992 | return function( elem ) { | |
| 993 | var name = elem.nodeName.toLowerCase(); | |
| 994 | return name === "input" && elem.type === type; | |
| 995 | }; | |
| 996 | } | |
| 997 | ||
| 998 | /** | |
| 999 | * Returns a function to use in pseudos for buttons | |
| 1000 | * @param {String} type | |
| 1001 | */ | |
| 1002 | function createButtonPseudo( type ) { | |
| 1003 | return function( elem ) { | |
| 1004 | var name = elem.nodeName.toLowerCase(); | |
| 1005 | return (name === "input" || name === "button") && elem.type === type; | |
| 1006 | }; | |
| 1007 | } | |
| 1008 | ||
| 1009 | /** | |
| 1010 | * Returns a function to use in pseudos for positionals | |
| 1011 | * @param {Function} fn | |
| 1012 | */ | |
| 1013 | function createPositionalPseudo( fn ) { | |
| 1014 | return markFunction(function( argument ) { | |
| 1015 | argument = +argument; | |
| 1016 | return markFunction(function( seed, matches ) { | |
| 1017 | var j, | |
| 1018 | matchIndexes = fn( [], seed.length, argument ), | |
| 1019 | i = matchIndexes.length; | |
| 1020 | ||
| 1021 | // Match elements found at the specified indexes | |
| 1022 | while ( i-- ) { | |
| 1023 | if ( seed[ (j = matchIndexes[i]) ] ) { | |
| 1024 | seed[j] = !(matches[j] = seed[j]); | |
| 1025 | } | |
| 1026 | } | |
| 1027 | }); | |
| 1028 | }); | |
| 1029 | } | |
| 1030 | ||
| 1031 | /** | |
| 1032 | * Checks a node for validity as a Sizzle context | |
| 1033 | * @param {Element|Object=} context | |
| 1034 | * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value | |
| 1035 | */ | |
| 1036 | function testContext( context ) { | |
| 1037 | return context && typeof context.getElementsByTagName !== "undefined" && context; | |
| 1038 | } | |
| 1039 | ||
| 1040 | // Expose support vars for convenience | |
| 1041 | support = Sizzle.support = {}; | |
| 1042 | ||
| 1043 | /** | |
| 1044 | * Detects XML nodes | |
| 1045 | * @param {Element|Object} elem An element or a document | |
| 1046 | * @returns {Boolean} True iff elem is a non-HTML XML node | |
| 1047 | */ | |
| 1048 | isXML = Sizzle.isXML = function( elem ) { | |
| 1049 | // documentElement is verified for cases where it doesn't yet exist | |
| 1050 | // (such as loading iframes in IE - #4833) | |
| 1051 | var documentElement = elem && (elem.ownerDocument || elem).documentElement; | |
| 1052 | return documentElement ? documentElement.nodeName !== "HTML" : false; | |
| 1053 | }; | |
| 1054 | ||
| 1055 | /** | |
| 1056 | * Sets document-related variables once based on the current document | |
| 1057 | * @param {Element|Object} [doc] An element or document object to use to set the document | |
| 1058 | * @returns {Object} Returns the current document | |
| 1059 | */ | |
| 1060 | setDocument = Sizzle.setDocument = function( node ) { | |
| 1061 | var hasCompare, parent, | |
| 1062 | doc = node ? node.ownerDocument || node : preferredDoc; | |
| 1063 | ||
| 1064 | // If no document and documentElement is available, return | |
| 1065 | if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { | |
| 1066 | return document; | |
| 1067 | } | |
| 1068 | ||
| 1069 | // Set our document | |
| 1070 | document = doc; | |
| 1071 | docElem = doc.documentElement; | |
| 1072 | parent = doc.defaultView; | |
| 1073 | ||
| 1074 | // Support: IE>8 | |
| 1075 | // If iframe document is assigned to "document" variable and if iframe has been reloaded, | |
| 1076 | // IE will throw "permission denied" error when accessing "document" variable, see jQuery #13936 | |
| 1077 | // IE6-8 do not support the defaultView property so parent will be undefined | |
| 1078 | if ( parent && parent !== parent.top ) { | |
| 1079 | // IE11 does not have attachEvent, so all must suffer | |
| 1080 | if ( parent.addEventListener ) { | |
| 1081 | parent.addEventListener( "unload", unloadHandler, false ); | |
| 1082 | } else if ( parent.attachEvent ) { | |
| 1083 | parent.attachEvent( "onunload", unloadHandler ); | |
| 1084 | } | |
| 1085 | } | |
| 1086 | ||
| 1087 | /* Support tests | |
| 1088 | ---------------------------------------------------------------------- */ | |
| 1089 | documentIsHTML = !isXML( doc ); | |
| 1090 | ||
| 1091 | /* Attributes | |
| 1092 | ---------------------------------------------------------------------- */ | |
| 1093 | ||
| 1094 | // Support: IE<8 | |
| 1095 | // Verify that getAttribute really returns attributes and not properties | |
| 1096 | // (excepting IE8 booleans) | |
| 1097 | support.attributes = assert(function( div ) { | |
| 1098 | div.className = "i"; | |
| 1099 | return !div.getAttribute("className"); | |
| 1100 | }); | |
| 1101 | ||
| 1102 | /* getElement(s)By* | |
| 1103 | ---------------------------------------------------------------------- */ | |
| 1104 | ||
| 1105 | // Check if getElementsByTagName("*") returns only elements | |
| 1106 | support.getElementsByTagName = assert(function( div ) { | |
| 1107 | div.appendChild( doc.createComment("") ); | |
| 1108 | return !div.getElementsByTagName("*").length; | |
| 1109 | }); | |
| 1110 | ||
| 1111 | // Support: IE<9 | |
| 1112 | support.getElementsByClassName = rnative.test( doc.getElementsByClassName ); | |
| 1113 | ||
| 1114 | // Support: IE<10 | |
| 1115 | // Check if getElementById returns elements by name | |
| 1116 | // The broken getElementById methods don't pick up programatically-set names, | |
| 1117 | // so use a roundabout getElementsByName test | |
| 1118 | support.getById = assert(function( div ) { | |
| 1119 | docElem.appendChild( div ).id = expando; | |
| 1120 | return !doc.getElementsByName || !doc.getElementsByName( expando ).length; | |
| 1121 | }); | |
| 1122 | ||
| 1123 | // ID find and filter | |
| 1124 | if ( support.getById ) { | |
| 1125 | Expr.find["ID"] = function( id, context ) { | |
| 1126 | if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { | |
| 1127 | var m = context.getElementById( id ); | |
| 1128 | // Check parentNode to catch when Blackberry 4.6 returns | |
| 1129 | // nodes that are no longer in the document #6963 | |
| 1130 | return m && m.parentNode ? [ m ] : []; | |
| 1131 | } | |
| 1132 | }; | |
| 1133 | Expr.filter["ID"] = function( id ) { | |
| 1134 | var attrId = id.replace( runescape, funescape ); | |
| 1135 | return function( elem ) { | |
| 1136 | return elem.getAttribute("id") === attrId; | |
| 1137 | }; | |
| 1138 | }; | |
| 1139 | } else { | |
| 1140 | // Support: IE6/7 | |
| 1141 | // getElementById is not reliable as a find shortcut | |
| 1142 | delete Expr.find["ID"]; | |
| 1143 | ||
| 1144 | Expr.filter["ID"] = function( id ) { | |
| 1145 | var attrId = id.replace( runescape, funescape ); | |
| 1146 | return function( elem ) { | |
| 1147 | var node = typeof elem.getAttributeNode !== "undefined" && elem.getAttributeNode("id"); | |
| 1148 | return node && node.value === attrId; | |
| 1149 | }; | |
| 1150 | }; | |
| 1151 | } | |
| 1152 | ||
| 1153 | // Tag | |
| 1154 | Expr.find["TAG"] = support.getElementsByTagName ? | |
| 1155 | function( tag, context ) { | |
| 1156 | if ( typeof context.getElementsByTagName !== "undefined" ) { | |
| 1157 | return context.getElementsByTagName( tag ); | |
| 1158 | ||
| 1159 | // DocumentFragment nodes don't have gEBTN | |
| 1160 | } else if ( support.qsa ) { | |
| 1161 | return context.querySelectorAll( tag ); | |
| 1162 | } | |
| 1163 | } : | |
| 1164 | ||
| 1165 | function( tag, context ) { | |
| 1166 | var elem, | |
| 1167 | tmp = [], | |
| 1168 | i = 0, | |
| 1169 | // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too | |
| 1170 | results = context.getElementsByTagName( tag ); | |
| 1171 | ||
| 1172 | // Filter out possible comments | |
| 1173 | if ( tag === "*" ) { | |
| 1174 | while ( (elem = results[i++]) ) { | |
| 1175 | if ( elem.nodeType === 1 ) { | |
| 1176 | tmp.push( elem ); | |
| 1177 | } | |
| 1178 | } | |
| 1179 | ||
| 1180 | return tmp; | |
| 1181 | } | |
| 1182 | return results; | |
| 1183 | }; | |
| 1184 | ||
| 1185 | // Class | |
| 1186 | Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { | |
| 1187 | if ( documentIsHTML ) { | |
| 1188 | return context.getElementsByClassName( className ); | |
| 1189 | } | |
| 1190 | }; | |
| 1191 | ||
| 1192 | /* QSA/matchesSelector | |
| 1193 | ---------------------------------------------------------------------- */ | |
| 1194 | ||
| 1195 | // QSA and matchesSelector support | |
| 1196 | ||
| 1197 | // matchesSelector(:active) reports false when true (IE9/Opera 11.5) | |
| 1198 | rbuggyMatches = []; | |
| 1199 | ||
| 1200 | // qSa(:focus) reports false when true (Chrome 21) | |
| 1201 | // We allow this because of a bug in IE8/9 that throws an error | |
| 1202 | // whenever `document.activeElement` is accessed on an iframe | |
| 1203 | // So, we allow :focus to pass through QSA all the time to avoid the IE error | |
| 1204 | // See http://bugs.jquery.com/ticket/13378 | |
| 1205 | rbuggyQSA = []; | |
| 1206 | ||
| 1207 | if ( (support.qsa = rnative.test( doc.querySelectorAll )) ) { | |
| 1208 | // Build QSA regex | |
| 1209 | // Regex strategy adopted from Diego Perini | |
| 1210 | assert(function( div ) { | |
| 1211 | // Select is set to empty string on purpose | |
| 1212 | // This is to test IE's treatment of not explicitly | |
| 1213 | // setting a boolean content attribute, | |
| 1214 | // since its presence should be enough | |
| 1215 | // http://bugs.jquery.com/ticket/12359 | |
| 1216 | docElem.appendChild( div ).innerHTML = "<a id='" + expando + "'></a>" + | |
| 1217 | "<select id='" + expando + "-\f]' msallowcapture=''>" + | |
| 1218 | "<option selected=''></option></select>"; | |
| 1219 | ||
| 1220 | // Support: IE8, Opera 11-12.16 | |
| 1221 | // Nothing should be selected when empty strings follow ^= or $= or *= | |
| 1222 | // The test attribute must be unknown in Opera but "safe" for WinRT | |
| 1223 | // http://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section | |
| 1224 | if ( div.querySelectorAll("[msallowcapture^='']").length ) { | |
| 1225 | rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); | |
| 1226 | } | |
| 1227 | ||
| 1228 | // Support: IE8 | |
| 1229 | // Boolean attributes and "value" are not treated correctly | |
| 1230 | if ( !div.querySelectorAll("[selected]").length ) { | |
| 1231 | rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); | |
| 1232 | } | |
| 1233 | ||
| 1234 | // Support: Chrome<29, Android<4.2+, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.7+ | |
| 1235 | if ( !div.querySelectorAll( "[id~=" + expando + "-]" ).length ) { | |
| 1236 | rbuggyQSA.push("~="); | |
| 1237 | } | |
| 1238 | ||
| 1239 | // Webkit/Opera - :checked should return selected option elements | |
| 1240 | // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked | |
| 1241 | // IE8 throws error here and will not see later tests | |
| 1242 | if ( !div.querySelectorAll(":checked").length ) { | |
| 1243 | rbuggyQSA.push(":checked"); | |
| 1244 | } | |
| 1245 | ||
| 1246 | // Support: Safari 8+, iOS 8+ | |
| 1247 | // https://bugs.webkit.org/show_bug.cgi?id=136851 | |
| 1248 | // In-page `selector#id sibing-combinator selector` fails | |
| 1249 | if ( !div.querySelectorAll( "a#" + expando + "+*" ).length ) { | |
| 1250 | rbuggyQSA.push(".#.+[+~]"); | |
| 1251 | } | |
| 1252 | }); | |
| 1253 | ||
| 1254 | assert(function( div ) { | |
| 1255 | // Support: Windows 8 Native Apps | |
| 1256 | // The type and name attributes are restricted during .innerHTML assignment | |
| 1257 | var input = doc.createElement("input"); | |
| 1258 | input.setAttribute( "type", "hidden" ); | |
| 1259 | div.appendChild( input ).setAttribute( "name", "D" ); | |
| 1260 | ||
| 1261 | // Support: IE8 | |
| 1262 | // Enforce case-sensitivity of name attribute | |
| 1263 | if ( div.querySelectorAll("[name=d]").length ) { | |
| 1264 | rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); | |
| 1265 | } | |
| 1266 | ||
| 1267 | // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) | |
| 1268 | // IE8 throws error here and will not see later tests | |
| 1269 | if ( !div.querySelectorAll(":enabled").length ) { | |
| 1270 | rbuggyQSA.push( ":enabled", ":disabled" ); | |
| 1271 | } | |
| 1272 | ||
| 1273 | // Opera 10-11 does not throw on post-comma invalid pseudos | |
| 1274 | div.querySelectorAll("*,:x"); | |
| 1275 | rbuggyQSA.push(",.*:"); | |
| 1276 | }); | |
| 1277 | } | |
| 1278 | ||
| 1279 | if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || | |
| 1280 | docElem.webkitMatchesSelector || | |
| 1281 | docElem.mozMatchesSelector || | |
| 1282 | docElem.oMatchesSelector || | |
| 1283 | docElem.msMatchesSelector) )) ) { | |
| 1284 | ||
| 1285 | assert(function( div ) { | |
| 1286 | // Check to see if it's possible to do matchesSelector | |
| 1287 | // on a disconnected node (IE 9) | |
| 1288 | support.disconnectedMatch = matches.call( div, "div" ); | |
| 1289 | ||
| 1290 | // This should fail with an exception | |
| 1291 | // Gecko does not error, returns false instead | |
| 1292 | matches.call( div, "[s!='']:x" ); | |
| 1293 | rbuggyMatches.push( "!=", pseudos ); | |
| 1294 | }); | |
| 1295 | } | |
| 1296 | ||
| 1297 | rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); | |
| 1298 | rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); | |
| 1299 | ||
| 1300 | /* Contains | |
| 1301 | ---------------------------------------------------------------------- */ | |
| 1302 | hasCompare = rnative.test( docElem.compareDocumentPosition ); | |
| 1303 | ||
| 1304 | // Element contains another | |
| 1305 | // Purposefully does not implement inclusive descendent | |
| 1306 | // As in, an element does not contain itself | |
| 1307 | contains = hasCompare || rnative.test( docElem.contains ) ? | |
| 1308 | function( a, b ) { | |
| 1309 | var adown = a.nodeType === 9 ? a.documentElement : a, | |
| 1310 | bup = b && b.parentNode; | |
| 1311 | return a === bup || !!( bup && bup.nodeType === 1 && ( | |
| 1312 | adown.contains ? | |
| 1313 | adown.contains( bup ) : | |
| 1314 | a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 | |
| 1315 | )); | |
| 1316 | } : | |
| 1317 | function( a, b ) { | |
| 1318 | if ( b ) { | |
| 1319 | while ( (b = b.parentNode) ) { | |
| 1320 | if ( b === a ) { | |
| 1321 | return true; | |
| 1322 | } | |
| 1323 | } | |
| 1324 | } | |
| 1325 | return false; | |
| 1326 | }; | |
| 1327 | ||
| 1328 | /* Sorting | |
| 1329 | ---------------------------------------------------------------------- */ | |
| 1330 | ||
| 1331 | // Document order sorting | |
| 1332 | sortOrder = hasCompare ? | |
| 1333 | function( a, b ) { | |
| 1334 | ||
| 1335 | // Flag for duplicate removal | |
| 1336 | if ( a === b ) { | |
| 1337 | hasDuplicate = true; | |
| 1338 | return 0; | |
| 1339 | } | |
| 1340 | ||
| 1341 | // Sort on method existence if only one input has compareDocumentPosition | |
| 1342 | var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; | |
| 1343 | if ( compare ) { | |
| 1344 | return compare; | |
| 1345 | } | |
| 1346 | ||
| 1347 | // Calculate position if both inputs belong to the same document | |
| 1348 | compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? | |
| 1349 | a.compareDocumentPosition( b ) : | |
| 1350 | ||
| 1351 | // Otherwise we know they are disconnected | |
| 1352 | 1; | |
| 1353 | ||
| 1354 | // Disconnected nodes | |
| 1355 | if ( compare & 1 || | |
| 1356 | (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { | |
| 1357 | ||
| 1358 | // Choose the first element that is related to our preferred document | |
| 1359 | if ( a === doc || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { | |
| 1360 | return -1; | |
| 1361 | } | |
| 1362 | if ( b === doc || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { | |
| 1363 | return 1; | |
| 1364 | } | |
| 1365 | ||
| 1366 | // Maintain original order | |
| 1367 | return sortInput ? | |
| 1368 | ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : | |
| 1369 | 0; | |
| 1370 | } | |
| 1371 | ||
| 1372 | return compare & 4 ? -1 : 1; | |
| 1373 | } : | |
| 1374 | function( a, b ) { | |
| 1375 | // Exit early if the nodes are identical | |
| 1376 | if ( a === b ) { | |
| 1377 | hasDuplicate = true; | |
| 1378 | return 0; | |
| 1379 | } | |
| 1380 | ||
| 1381 | var cur, | |
| 1382 | i = 0, | |
| 1383 | aup = a.parentNode, | |
| 1384 | bup = b.parentNode, | |
| 1385 | ap = [ a ], | |
| 1386 | bp = [ b ]; | |
| 1387 | ||
| 1388 | // Parentless nodes are either documents or disconnected | |
| 1389 | if ( !aup || !bup ) { | |
| 1390 | return a === doc ? -1 : | |
| 1391 | b === doc ? 1 : | |
| 1392 | aup ? -1 : | |
| 1393 | bup ? 1 : | |
| 1394 | sortInput ? | |
| 1395 | ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : | |
| 1396 | 0; | |
| 1397 | ||
| 1398 | // If the nodes are siblings, we can do a quick check | |
| 1399 | } else if ( aup === bup ) { | |
| 1400 | return siblingCheck( a, b ); | |
| 1401 | } | |
| 1402 | ||
| 1403 | // Otherwise we need full lists of their ancestors for comparison | |
| 1404 | cur = a; | |
| 1405 | while ( (cur = cur.parentNode) ) { | |
| 1406 | ap.unshift( cur ); | |
| 1407 | } | |
| 1408 | cur = b; | |
| 1409 | while ( (cur = cur.parentNode) ) { | |
| 1410 | bp.unshift( cur ); | |
| 1411 | } | |
| 1412 | ||
| 1413 | // Walk down the tree looking for a discrepancy | |
| 1414 | while ( ap[i] === bp[i] ) { | |
| 1415 | i++; | |
| 1416 | } | |
| 1417 | ||
| 1418 | return i ? | |
| 1419 | // Do a sibling check if the nodes have a common ancestor | |
| 1420 | siblingCheck( ap[i], bp[i] ) : | |
| 1421 | ||
| 1422 | // Otherwise nodes in our document sort first | |
| 1423 | ap[i] === preferredDoc ? -1 : | |
| 1424 | bp[i] === preferredDoc ? 1 : | |
| 1425 | 0; | |
| 1426 | }; | |
| 1427 | ||
| 1428 | return doc; | |
| 1429 | }; | |
| 1430 | ||
| 1431 | Sizzle.matches = function( expr, elements ) { | |
| 1432 | return Sizzle( expr, null, null, elements ); | |
| 1433 | }; | |
| 1434 | ||
| 1435 | Sizzle.matchesSelector = function( elem, expr ) { | |
| 1436 | // Set document vars if needed | |
| 1437 | if ( ( elem.ownerDocument || elem ) !== document ) { | |
| 1438 | setDocument( elem ); | |
| 1439 | } | |
| 1440 | ||
| 1441 | // Make sure that attribute selectors are quoted | |
| 1442 | expr = expr.replace( rattributeQuotes, "='$1']" ); | |
| 1443 | ||
| 1444 | if ( support.matchesSelector && documentIsHTML && | |
| 1445 | ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && | |
| 1446 | ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { | |
| 1447 | ||
| 1448 | try { | |
| 1449 | var ret = matches.call( elem, expr ); | |
| 1450 | ||
| 1451 | // IE 9's matchesSelector returns false on disconnected nodes | |
| 1452 | if ( ret || support.disconnectedMatch || | |
| 1453 | // As well, disconnected nodes are said to be in a document | |
| 1454 | // fragment in IE 9 | |
| 1455 | elem.document && elem.document.nodeType !== 11 ) { | |
| 1456 | return ret; | |
| 1457 | } | |
| 1458 | } catch (e) {} | |
| 1459 | } | |
| 1460 | ||
| 1461 | return Sizzle( expr, document, null, [ elem ] ).length > 0; | |
| 1462 | }; | |
| 1463 | ||
| 1464 | Sizzle.contains = function( context, elem ) { | |
| 1465 | // Set document vars if needed | |
| 1466 | if ( ( context.ownerDocument || context ) !== document ) { | |
| 1467 | setDocument( context ); | |
| 1468 | } | |
| 1469 | return contains( context, elem ); | |
| 1470 | }; | |
| 1471 | ||
| 1472 | Sizzle.attr = function( elem, name ) { | |
| 1473 | // Set document vars if needed | |
| 1474 | if ( ( elem.ownerDocument || elem ) !== document ) { | |
| 1475 | setDocument( elem ); | |
| 1476 | } | |
| 1477 | ||
| 1478 | var fn = Expr.attrHandle[ name.toLowerCase() ], | |
| 1479 | // Don't get fooled by Object.prototype properties (jQuery #13807) | |
| 1480 | val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? | |
| 1481 | fn( elem, name, !documentIsHTML ) : | |
| 1482 | undefined; | |
| 1483 | ||
| 1484 | return val !== undefined ? | |
| 1485 | val : | |
| 1486 | support.attributes || !documentIsHTML ? | |
| 1487 | elem.getAttribute( name ) : | |
| 1488 | (val = elem.getAttributeNode(name)) && val.specified ? | |
| 1489 | val.value : | |
| 1490 | null; | |
| 1491 | }; | |
| 1492 | ||
| 1493 | Sizzle.error = function( msg ) { | |
| 1494 | throw new Error( "Syntax error, unrecognized expression: " + msg ); | |
| 1495 | }; | |
| 1496 | ||
| 1497 | /** | |
| 1498 | * Document sorting and removing duplicates | |
| 1499 | * @param {ArrayLike} results | |
| 1500 | */ | |
| 1501 | Sizzle.uniqueSort = function( results ) { | |
| 1502 | var elem, | |
| 1503 | duplicates = [], | |
| 1504 | j = 0, | |
| 1505 | i = 0; | |
| 1506 | ||
| 1507 | // Unless we *know* we can detect duplicates, assume their presence | |
| 1508 | hasDuplicate = !support.detectDuplicates; | |
| 1509 | sortInput = !support.sortStable && results.slice( 0 ); | |
| 1510 | results.sort( sortOrder ); | |
| 1511 | ||
| 1512 | if ( hasDuplicate ) { | |
| 1513 | while ( (elem = results[i++]) ) { | |
| 1514 | if ( elem === results[ i ] ) { | |
| 1515 | j = duplicates.push( i ); | |
| 1516 | } | |
| 1517 | } | |
| 1518 | while ( j-- ) { | |
| 1519 | results.splice( duplicates[ j ], 1 ); | |
| 1520 | } | |
| 1521 | } | |
| 1522 | ||
| 1523 | // Clear input after sorting to release objects | |
| 1524 | // See https://github.com/jquery/sizzle/pull/225 | |
| 1525 | sortInput = null; | |
| 1526 | ||
| 1527 | return results; | |
| 1528 | }; | |
| 1529 | ||
| 1530 | /** | |
| 1531 | * Utility function for retrieving the text value of an array of DOM nodes | |
| 1532 | * @param {Array|Element} elem | |
| 1533 | */ | |
| 1534 | getText = Sizzle.getText = function( elem ) { | |
| 1535 | var node, | |
| 1536 | ret = "", | |
| 1537 | i = 0, | |
| 1538 | nodeType = elem.nodeType; | |
| 1539 | ||
| 1540 | if ( !nodeType ) { | |
| 1541 | // If no nodeType, this is expected to be an array | |
| 1542 | while ( (node = elem[i++]) ) { | |
| 1543 | // Do not traverse comment nodes | |
| 1544 | ret += getText( node ); | |
| 1545 | } | |
| 1546 | } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { | |
| 1547 | // Use textContent for elements | |
| 1548 | // innerText usage removed for consistency of new lines (jQuery #11153) | |
| 1549 | if ( typeof elem.textContent === "string" ) { | |
| 1550 | return elem.textContent; | |
| 1551 | } else { | |
| 1552 | // Traverse its children | |
| 1553 | for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { | |
| 1554 | ret += getText( elem ); | |
| 1555 | } | |
| 1556 | } | |
| 1557 | } else if ( nodeType === 3 || nodeType === 4 ) { | |
| 1558 | return elem.nodeValue; | |
| 1559 | } | |
| 1560 | // Do not include comment or processing instruction nodes | |
| 1561 | ||
| 1562 | return ret; | |
| 1563 | }; | |
| 1564 | ||
| 1565 | Expr = Sizzle.selectors = { | |
| 1566 | ||
| 1567 | // Can be adjusted by the user | |
| 1568 | cacheLength: 50, | |
| 1569 | ||
| 1570 | createPseudo: markFunction, | |
| 1571 | ||
| 1572 | match: matchExpr, | |
| 1573 | ||
| 1574 | attrHandle: {}, | |
| 1575 | ||
| 1576 | find: {}, | |
| 1577 | ||
| 1578 | relative: { | |
| 1579 | ">": { dir: "parentNode", first: true }, | |
| 1580 | " ": { dir: "parentNode" }, | |
| 1581 | "+": { dir: "previousSibling", first: true }, | |
| 1582 | "~": { dir: "previousSibling" } | |
| 1583 | }, | |
| 1584 | ||
| 1585 | preFilter: { | |
| 1586 | "ATTR": function( match ) { | |
| 1587 | match[1] = match[1].replace( runescape, funescape ); | |
| 1588 | ||
| 1589 | // Move the given value to match[3] whether quoted or unquoted | |
| 1590 | match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); | |
| 1591 | ||
| 1592 | if ( match[2] === "~=" ) { | |
| 1593 | match[3] = " " + match[3] + " "; | |
| 1594 | } | |
| 1595 | ||
| 1596 | return match.slice( 0, 4 ); | |
| 1597 | }, | |
| 1598 | ||
| 1599 | "CHILD": function( match ) { | |
| 1600 | /* matches from matchExpr["CHILD"] | |
| 1601 | 1 type (only|nth|...) | |
| 1602 | 2 what (child|of-type) | |
| 1603 | 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) | |
| 1604 | 4 xn-component of xn+y argument ([+-]?\d*n|) | |
| 1605 | 5 sign of xn-component | |
| 1606 | 6 x of xn-component | |
| 1607 | 7 sign of y-component | |
| 1608 | 8 y of y-component | |
| 1609 | */ | |
| 1610 | match[1] = match[1].toLowerCase(); | |
| 1611 | ||
| 1612 | if ( match[1].slice( 0, 3 ) === "nth" ) { | |
| 1613 | // nth-* requires argument | |
| 1614 | if ( !match[3] ) { | |
| 1615 | Sizzle.error( match[0] ); | |
| 1616 | } | |
| 1617 | ||
| 1618 | // numeric x and y parameters for Expr.filter.CHILD | |
| 1619 | // remember that false/true cast respectively to 0/1 | |
| 1620 | match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); | |
| 1621 | match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); | |
| 1622 | ||
| 1623 | // other types prohibit arguments | |
| 1624 | } else if ( match[3] ) { | |
| 1625 | Sizzle.error( match[0] ); | |
| 1626 | } | |
| 1627 | ||
| 1628 | return match; | |
| 1629 | }, | |
| 1630 | ||
| 1631 | "PSEUDO": function( match ) { | |
| 1632 | var excess, | |
| 1633 | unquoted = !match[6] && match[2]; | |
| 1634 | ||
| 1635 | if ( matchExpr["CHILD"].test( match[0] ) ) { | |
| 1636 | return null; | |
| 1637 | } | |
| 1638 | ||
| 1639 | // Accept quoted arguments as-is | |
| 1640 | if ( match[3] ) { | |
| 1641 | match[2] = match[4] || match[5] || ""; | |
| 1642 | ||
| 1643 | // Strip excess characters from unquoted arguments | |
| 1644 | } else if ( unquoted && rpseudo.test( unquoted ) && | |
| 1645 | // Get excess from tokenize (recursively) | |
| 1646 | (excess = tokenize( unquoted, true )) && | |
| 1647 | // advance to the next closing parenthesis | |
| 1648 | (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { | |
| 1649 | ||
| 1650 | // excess is a negative index | |
| 1651 | match[0] = match[0].slice( 0, excess ); | |
| 1652 | match[2] = unquoted.slice( 0, excess ); | |
| 1653 | } | |
| 1654 | ||
| 1655 | // Return only captures needed by the pseudo filter method (type and argument) | |
| 1656 | return match.slice( 0, 3 ); | |
| 1657 | } | |
| 1658 | }, | |
| 1659 | ||
| 1660 | filter: { | |
| 1661 | ||
| 1662 | "TAG": function( nodeNameSelector ) { | |
| 1663 | var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); | |
| 1664 | return nodeNameSelector === "*" ? | |
| 1665 | function() { return true; } : | |
| 1666 | function( elem ) { | |
| 1667 | return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; | |
| 1668 | }; | |
| 1669 | }, | |
| 1670 | ||
| 1671 | "CLASS": function( className ) { | |
| 1672 | var pattern = classCache[ className + " " ]; | |
| 1673 | ||
| 1674 | return pattern || | |
| 1675 | (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && | |
| 1676 | classCache( className, function( elem ) { | |
| 1677 | return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" ); | |
| 1678 | }); | |
| 1679 | }, | |
| 1680 | ||
| 1681 | "ATTR": function( name, operator, check ) { | |
| 1682 | return function( elem ) { | |
| 1683 | var result = Sizzle.attr( elem, name ); | |
| 1684 | ||
| 1685 | if ( result == null ) { | |
| 1686 | return operator === "!="; | |
| 1687 | } | |
| 1688 | if ( !operator ) { | |
| 1689 | return true; | |
| 1690 | } | |
| 1691 | ||
| 1692 | result += ""; | |
| 1693 | ||
| 1694 | return operator === "=" ? result === check : | |
| 1695 | operator === "!=" ? result !== check : | |
| 1696 | operator === "^=" ? check && result.indexOf( check ) === 0 : | |
| 1697 | operator === "*=" ? check && result.indexOf( check ) > -1 : | |
| 1698 | operator === "$=" ? check && result.slice( -check.length ) === check : | |
| 1699 | operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : | |
| 1700 | operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : | |
| 1701 | false; | |
| 1702 | }; | |
| 1703 | }, | |
| 1704 | ||
| 1705 | "CHILD": function( type, what, argument, first, last ) { | |
| 1706 | var simple = type.slice( 0, 3 ) !== "nth", | |
| 1707 | forward = type.slice( -4 ) !== "last", | |
| 1708 | ofType = what === "of-type"; | |
| 1709 | ||
| 1710 | return first === 1 && last === 0 ? | |
| 1711 | ||
| 1712 | // Shortcut for :nth-*(n) | |
| 1713 | function( elem ) { | |
| 1714 | return !!elem.parentNode; | |
| 1715 | } : | |
| 1716 | ||
| 1717 | function( elem, context, xml ) { | |
| 1718 | var cache, outerCache, node, diff, nodeIndex, start, | |
| 1719 | dir = simple !== forward ? "nextSibling" : "previousSibling", | |
| 1720 | parent = elem.parentNode, | |
| 1721 | name = ofType && elem.nodeName.toLowerCase(), | |
| 1722 | useCache = !xml && !ofType; | |
| 1723 | ||
| 1724 | if ( parent ) { | |
| 1725 | ||
| 1726 | // :(first|last|only)-(child|of-type) | |
| 1727 | if ( simple ) { | |
| 1728 | while ( dir ) { | |
| 1729 | node = elem; | |
| 1730 | while ( (node = node[ dir ]) ) { | |
| 1731 | if ( ofType ? node.nodeName.toLowerCase() === name : node.nodeType === 1 ) { | |
| 1732 | return false; | |
| 1733 | } | |
| 1734 | } | |
| 1735 | // Reverse direction for :only-* (if we haven't yet done so) | |
| 1736 | start = dir = type === "only" && !start && "nextSibling"; | |
| 1737 | } | |
| 1738 | return true; | |
| 1739 | } | |
| 1740 | ||
| 1741 | start = [ forward ? parent.firstChild : parent.lastChild ]; | |
| 1742 | ||
| 1743 | // non-xml :nth-child(...) stores cache data on `parent` | |
| 1744 | if ( forward && useCache ) { | |
| 1745 | // Seek `elem` from a previously-cached index | |
| 1746 | outerCache = parent[ expando ] || (parent[ expando ] = {}); | |
| 1747 | cache = outerCache[ type ] || []; | |
| 1748 | nodeIndex = cache[0] === dirruns && cache[1]; | |
| 1749 | diff = cache[0] === dirruns && cache[2]; | |
| 1750 | node = nodeIndex && parent.childNodes[ nodeIndex ]; | |
| 1751 | ||
| 1752 | while ( (node = ++nodeIndex && node && node[ dir ] || | |
| 1753 | ||
| 1754 | // Fallback to seeking `elem` from the start | |
| 1755 | (diff = nodeIndex = 0) || start.pop()) ) { | |
| 1756 | ||
| 1757 | // When found, cache indexes on `parent` and break | |
| 1758 | if ( node.nodeType === 1 && ++diff && node === elem ) { | |
| 1759 | outerCache[ type ] = [ dirruns, nodeIndex, diff ]; | |
| 1760 | break; | |
| 1761 | } | |
| 1762 | } | |
| 1763 | ||
| 1764 | // Use previously-cached element index if available | |
| 1765 | } else if ( useCache && (cache = (elem[ expando ] || (elem[ expando ] = {}))[ type ]) && cache[0] === dirruns ) { | |
| 1766 | diff = cache[1]; | |
| 1767 | ||
| 1768 | // xml :nth-child(...) or :nth-last-child(...) or :nth(-last)?-of-type(...) | |
| 1769 | } else { | |
| 1770 | // Use the same loop as above to seek `elem` from the start | |
| 1771 | while ( (node = ++nodeIndex && node && node[ dir ] || | |
| 1772 | (diff = nodeIndex = 0) || start.pop()) ) { | |
| 1773 | ||
| 1774 | if ( ( ofType ? node.nodeName.toLowerCase() === name : node.nodeType === 1 ) && ++diff ) { | |
| 1775 | // Cache the index of each encountered element | |
| 1776 | if ( useCache ) { | |
| 1777 | (node[ expando ] || (node[ expando ] = {}))[ type ] = [ dirruns, diff ]; | |
| 1778 | } | |
| 1779 | ||
| 1780 | if ( node === elem ) { | |
| 1781 | break; | |
| 1782 | } | |
| 1783 | } | |
| 1784 | } | |
| 1785 | } | |
| 1786 | ||
| 1787 | // Incorporate the offset, then check against cycle size | |
| 1788 | diff -= last; | |
| 1789 | return diff === first || ( diff % first === 0 && diff / first >= 0 ); | |
| 1790 | } | |
| 1791 | }; | |
| 1792 | }, | |
| 1793 | ||
| 1794 | "PSEUDO": function( pseudo, argument ) { | |
| 1795 | // pseudo-class names are case-insensitive | |
| 1796 | // http://www.w3.org/TR/selectors/#pseudo-classes | |
| 1797 | // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters | |
| 1798 | // Remember that setFilters inherits from pseudos | |
| 1799 | var args, | |
| 1800 | fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || | |
| 1801 | Sizzle.error( "unsupported pseudo: " + pseudo ); | |
| 1802 | ||
| 1803 | // The user may use createPseudo to indicate that | |
| 1804 | // arguments are needed to create the filter function | |
| 1805 | // just as Sizzle does | |
| 1806 | if ( fn[ expando ] ) { | |
| 1807 | return fn( argument ); | |
| 1808 | } | |
| 1809 | ||
| 1810 | // But maintain support for old signatures | |
| 1811 | if ( fn.length > 1 ) { | |
| 1812 | args = [ pseudo, pseudo, "", argument ]; | |
| 1813 | return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? | |
| 1814 | markFunction(function( seed, matches ) { | |
| 1815 | var idx, | |
| 1816 | matched = fn( seed, argument ), | |
| 1817 | i = matched.length; | |
| 1818 | while ( i-- ) { | |
| 1819 | idx = indexOf( seed, matched[i] ); | |
| 1820 | seed[ idx ] = !( matches[ idx ] = matched[i] ); | |
| 1821 | } | |
| 1822 | }) : | |
| 1823 | function( elem ) { | |
| 1824 | return fn( elem, 0, args ); | |
| 1825 | }; | |
| 1826 | } | |
| 1827 | ||
| 1828 | return fn; | |
| 1829 | } | |
| 1830 | }, | |
| 1831 | ||
| 1832 | pseudos: { | |
| 1833 | // Potentially complex pseudos | |
| 1834 | "not": markFunction(function( selector ) { | |
| 1835 | // Trim the selector passed to compile | |
| 1836 | // to avoid treating leading and trailing | |
| 1837 | // spaces as combinators | |
| 1838 | var input = [], | |
| 1839 | results = [], | |
| 1840 | matcher = compile( selector.replace( rtrim, "$1" ) ); | |
| 1841 | ||
| 1842 | return matcher[ expando ] ? | |
| 1843 | markFunction(function( seed, matches, context, xml ) { | |
| 1844 | var elem, | |
| 1845 | unmatched = matcher( seed, null, xml, [] ), | |
| 1846 | i = seed.length; | |
| 1847 | ||
| 1848 | // Match elements unmatched by `matcher` | |
| 1849 | while ( i-- ) { | |
| 1850 | if ( (elem = unmatched[i]) ) { | |
| 1851 | seed[i] = !(matches[i] = elem); | |
| 1852 | } | |
| 1853 | } | |
| 1854 | }) : | |
| 1855 | function( elem, context, xml ) { | |
| 1856 | input[0] = elem; | |
| 1857 | matcher( input, null, xml, results ); | |
| 1858 | // Don't keep the element (issue #299) | |
| 1859 | input[0] = null; | |
| 1860 | return !results.pop(); | |
| 1861 | }; | |
| 1862 | }), | |
| 1863 | ||
| 1864 | "has": markFunction(function( selector ) { | |
| 1865 | return function( elem ) { | |
| 1866 | return Sizzle( selector, elem ).length > 0; | |
| 1867 | }; | |
| 1868 | }), | |
| 1869 | ||
| 1870 | "contains": markFunction(function( text ) { | |
| 1871 | text = text.replace( runescape, funescape ); | |
| 1872 | return function( elem ) { | |
| 1873 | return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1; | |
| 1874 | }; | |
| 1875 | }), | |
| 1876 | ||
| 1877 | // "Whether an element is represented by a :lang() selector | |
| 1878 | // is based solely on the element's language value | |
| 1879 | // being equal to the identifier C, | |
| 1880 | // or beginning with the identifier C immediately followed by "-". | |
| 1881 | // The matching of C against the element's language value is performed case-insensitively. | |
| 1882 | // The identifier C does not have to be a valid language name." | |
| 1883 | // http://www.w3.org/TR/selectors/#lang-pseudo | |
| 1884 | "lang": markFunction( function( lang ) { | |
| 1885 | // lang value must be a valid identifier | |
| 1886 | if ( !ridentifier.test(lang || "") ) { | |
| 1887 | Sizzle.error( "unsupported lang: " + lang ); | |
| 1888 | } | |
| 1889 | lang = lang.replace( runescape, funescape ).toLowerCase(); | |
| 1890 | return function( elem ) { | |
| 1891 | var elemLang; | |
| 1892 | do { | |
| 1893 | if ( (elemLang = documentIsHTML ? | |
| 1894 | elem.lang : | |
| 1895 | elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { | |
| 1896 | ||
| 1897 | elemLang = elemLang.toLowerCase(); | |
| 1898 | return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; | |
| 1899 | } | |
| 1900 | } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); | |
| 1901 | return false; | |
| 1902 | }; | |
| 1903 | }), | |
| 1904 | ||
| 1905 | // Miscellaneous | |
| 1906 | "target": function( elem ) { | |
| 1907 | var hash = window.location && window.location.hash; | |
| 1908 | return hash && hash.slice( 1 ) === elem.id; | |
| 1909 | }, | |
| 1910 | ||
| 1911 | "root": function( elem ) { | |
| 1912 | return elem === docElem; | |
| 1913 | }, | |
| 1914 | ||
| 1915 | "focus": function( elem ) { | |
| 1916 | return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); | |
| 1917 | }, | |
| 1918 | ||
| 1919 | // Boolean properties | |
| 1920 | "enabled": function( elem ) { | |
| 1921 | return elem.disabled === false; | |
| 1922 | }, | |
| 1923 | ||
| 1924 | "disabled": function( elem ) { | |
| 1925 | return elem.disabled === true; | |
| 1926 | }, | |
| 1927 | ||
| 1928 | "checked": function( elem ) { | |
| 1929 | // In CSS3, :checked should return both checked and selected elements | |
| 1930 | // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked | |
| 1931 | var nodeName = elem.nodeName.toLowerCase(); | |
| 1932 | return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); | |
| 1933 | }, | |
| 1934 | ||
| 1935 | "selected": function( elem ) { | |
| 1936 | // Accessing this property makes selected-by-default | |
| 1937 | // options in Safari work properly | |
| 1938 | if ( elem.parentNode ) { | |
| 1939 | elem.parentNode.selectedIndex; | |
| 1940 | } | |
| 1941 | ||
| 1942 | return elem.selected === true; | |
| 1943 | }, | |
| 1944 | ||
| 1945 | // Contents | |
| 1946 | "empty": function( elem ) { | |
| 1947 | // http://www.w3.org/TR/selectors/#empty-pseudo | |
| 1948 | // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), | |
| 1949 | // but not by others (comment: 8; processing instruction: 7; etc.) | |
| 1950 | // nodeType < 6 works because attributes (2) do not appear as children | |
| 1951 | for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { | |
| 1952 | if ( elem.nodeType < 6 ) { | |
| 1953 | return false; | |
| 1954 | } | |
| 1955 | } | |
| 1956 | return true; | |
| 1957 | }, | |
| 1958 | ||
| 1959 | "parent": function( elem ) { | |
| 1960 | return !Expr.pseudos["empty"]( elem ); | |
| 1961 | }, | |
| 1962 | ||
| 1963 | // Element/input types | |
| 1964 | "header": function( elem ) { | |
| 1965 | return rheader.test( elem.nodeName ); | |
| 1966 | }, | |
| 1967 | ||
| 1968 | "input": function( elem ) { | |
| 1969 | return rinputs.test( elem.nodeName ); | |
| 1970 | }, | |
| 1971 | ||
| 1972 | "button": function( elem ) { | |
| 1973 | var name = elem.nodeName.toLowerCase(); | |
| 1974 | return name === "input" && elem.type === "button" || name === "button"; | |
| 1975 | }, | |
| 1976 | ||
| 1977 | "text": function( elem ) { | |
| 1978 | var attr; | |
| 1979 | return elem.nodeName.toLowerCase() === "input" && | |
| 1980 | elem.type === "text" && | |
| 1981 | ||
| 1982 | // Support: IE<8 | |
| 1983 | // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" | |
| 1984 | ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); | |
| 1985 | }, | |
| 1986 | ||
| 1987 | // Position-in-collection | |
| 1988 | "first": createPositionalPseudo(function() { | |
| 1989 | return [ 0 ]; | |
| 1990 | }), | |
| 1991 | ||
| 1992 | "last": createPositionalPseudo(function( matchIndexes, length ) { | |
| 1993 | return [ length - 1 ]; | |
| 1994 | }), | |
| 1995 | ||
| 1996 | "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { | |
| 1997 | return [ argument < 0 ? argument + length : argument ]; | |
| 1998 | }), | |
| 1999 | ||
| 2000 | "even": createPositionalPseudo(function( matchIndexes, length ) { | |
| 2001 | var i = 0; | |
| 2002 | for ( ; i < length; i += 2 ) { | |
| 2003 | matchIndexes.push( i ); | |
| 2004 | } | |
| 2005 | return matchIndexes; | |
| 2006 | }), | |
| 2007 | ||
| 2008 | "odd": createPositionalPseudo(function( matchIndexes, length ) { | |
| 2009 | var i = 1; | |
| 2010 | for ( ; i < length; i += 2 ) { | |
| 2011 | matchIndexes.push( i ); | |
| 2012 | } | |
| 2013 | return matchIndexes; | |
| 2014 | }), | |
| 2015 | ||
| 2016 | "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { | |
| 2017 | var i = argument < 0 ? argument + length : argument; | |
| 2018 | for ( ; --i >= 0; ) { | |
| 2019 | matchIndexes.push( i ); | |
| 2020 | } | |
| 2021 | return matchIndexes; | |
| 2022 | }), | |
| 2023 | ||
| 2024 | "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { | |
| 2025 | var i = argument < 0 ? argument + length : argument; | |
| 2026 | for ( ; ++i < length; ) { | |
| 2027 | matchIndexes.push( i ); | |
| 2028 | } | |
| 2029 | return matchIndexes; | |
| 2030 | }) | |
| 2031 | } | |
| 2032 | }; | |
| 2033 | ||
| 2034 | Expr.pseudos["nth"] = Expr.pseudos["eq"]; | |
| 2035 | ||
| 2036 | // Add button/input type pseudos | |
| 2037 | for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { | |
| 2038 | Expr.pseudos[ i ] = createInputPseudo( i ); | |
| 2039 | } | |
| 2040 | for ( i in { submit: true, reset: true } ) { | |
| 2041 | Expr.pseudos[ i ] = createButtonPseudo( i ); | |
| 2042 | } | |
| 2043 | ||
| 2044 | // Easy API for creating new setFilters | |
| 2045 | function setFilters() {} | |
| 2046 | setFilters.prototype = Expr.filters = Expr.pseudos; | |
| 2047 | Expr.setFilters = new setFilters(); | |
| 2048 | ||
| 2049 | tokenize = Sizzle.tokenize = function( selector, parseOnly ) { | |
| 2050 | var matched, match, tokens, type, | |
| 2051 | soFar, groups, preFilters, | |
| 2052 | cached = tokenCache[ selector + " " ]; | |
| 2053 | ||
| 2054 | if ( cached ) { | |
| 2055 | return parseOnly ? 0 : cached.slice( 0 ); | |
| 2056 | } | |
| 2057 | ||
| 2058 | soFar = selector; | |
| 2059 | groups = []; | |
| 2060 | preFilters = Expr.preFilter; | |
| 2061 | ||
| 2062 | while ( soFar ) { | |
| 2063 | ||
| 2064 | // Comma and first run | |
| 2065 | if ( !matched || (match = rcomma.exec( soFar )) ) { | |
| 2066 | if ( match ) { | |
| 2067 | // Don't consume trailing commas as valid | |
| 2068 | soFar = soFar.slice( match[0].length ) || soFar; | |
| 2069 | } | |
| 2070 | groups.push( (tokens = []) ); | |
| 2071 | } | |
| 2072 | ||
| 2073 | matched = false; | |
| 2074 | ||
| 2075 | // Combinators | |
| 2076 | if ( (match = rcombinators.exec( soFar )) ) { | |
| 2077 | matched = match.shift(); | |
| 2078 | tokens.push({ | |
| 2079 | value: matched, | |
| 2080 | // Cast descendant combinators to space | |
| 2081 | type: match[0].replace( rtrim, " " ) | |
| 2082 | }); | |
| 2083 | soFar = soFar.slice( matched.length ); | |
| 2084 | } | |
| 2085 | ||
| 2086 | // Filters | |
| 2087 | for ( type in Expr.filter ) { | |
| 2088 | if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || | |
| 2089 | (match = preFilters[ type ]( match ))) ) { | |
| 2090 | matched = match.shift(); | |
| 2091 | tokens.push({ | |
| 2092 | value: matched, | |
| 2093 | type: type, | |
| 2094 | matches: match | |
| 2095 | }); | |
| 2096 | soFar = soFar.slice( matched.length ); | |
| 2097 | } | |
| 2098 | } | |
| 2099 | ||
| 2100 | if ( !matched ) { | |
| 2101 | break; | |
| 2102 | } | |
| 2103 | } | |
| 2104 | ||
| 2105 | // Return the length of the invalid excess | |
| 2106 | // if we're just parsing | |
| 2107 | // Otherwise, throw an error or return tokens | |
| 2108 | return parseOnly ? | |
| 2109 | soFar.length : | |
| 2110 | soFar ? | |
| 2111 | Sizzle.error( selector ) : | |
| 2112 | // Cache the tokens | |
| 2113 | tokenCache( selector, groups ).slice( 0 ); | |
| 2114 | }; | |
| 2115 | ||
| 2116 | function toSelector( tokens ) { | |
| 2117 | var i = 0, | |
| 2118 | len = tokens.length, | |
| 2119 | selector = ""; | |
| 2120 | for ( ; i < len; i++ ) { | |
| 2121 | selector += tokens[i].value; | |
| 2122 | } | |
| 2123 | return selector; | |
| 2124 | } | |
| 2125 | ||
| 2126 | function addCombinator( matcher, combinator, base ) { | |
| 2127 | var dir = combinator.dir, | |
| 2128 | checkNonElements = base && dir === "parentNode", | |
| 2129 | doneName = done++; | |
| 2130 | ||
| 2131 | return combinator.first ? | |
| 2132 | // Check against closest ancestor/preceding element | |
| 2133 | function( elem, context, xml ) { | |
| 2134 | while ( (elem = elem[ dir ]) ) { | |
| 2135 | if ( elem.nodeType === 1 || checkNonElements ) { | |
| 2136 | return matcher( elem, context, xml ); | |
| 2137 | } | |
| 2138 | } | |
| 2139 | } : | |
| 2140 | ||
| 2141 | // Check against all ancestor/preceding elements | |
| 2142 | function( elem, context, xml ) { | |
| 2143 | var oldCache, outerCache, | |
| 2144 | newCache = [ dirruns, doneName ]; | |
| 2145 | ||
| 2146 | // We can't set arbitrary data on XML nodes, so they don't benefit from dir caching | |
| 2147 | if ( xml ) { | |
| 2148 | while ( (elem = elem[ dir ]) ) { | |
| 2149 | if ( elem.nodeType === 1 || checkNonElements ) { | |
| 2150 | if ( matcher( elem, context, xml ) ) { | |
| 2151 | return true; | |
| 2152 | } | |
| 2153 | } | |
| 2154 | } | |
| 2155 | } else { | |
| 2156 | while ( (elem = elem[ dir ]) ) { | |
| 2157 | if ( elem.nodeType === 1 || checkNonElements ) { | |
| 2158 | outerCache = elem[ expando ] || (elem[ expando ] = {}); | |
| 2159 | if ( (oldCache = outerCache[ dir ]) && | |
| 2160 | oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { | |
| 2161 | ||
| 2162 | // Assign to newCache so results back-propagate to previous elements | |
| 2163 | return (newCache[ 2 ] = oldCache[ 2 ]); | |
| 2164 | } else { | |
| 2165 | // Reuse newcache so results back-propagate to previous elements | |
| 2166 | outerCache[ dir ] = newCache; | |
| 2167 | ||
| 2168 | // A match means we're done; a fail means we have to keep checking | |
| 2169 | if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { | |
| 2170 | return true; | |
| 2171 | } | |
| 2172 | } | |
| 2173 | } | |
| 2174 | } | |
| 2175 | } | |
| 2176 | }; | |
| 2177 | } | |
| 2178 | ||
| 2179 | function elementMatcher( matchers ) { | |
| 2180 | return matchers.length > 1 ? | |
| 2181 | function( elem, context, xml ) { | |
| 2182 | var i = matchers.length; | |
| 2183 | while ( i-- ) { | |
| 2184 | if ( !matchers[i]( elem, context, xml ) ) { | |
| 2185 | return false; | |
| 2186 | } | |
| 2187 | } | |
| 2188 | return true; | |
| 2189 | } : | |
| 2190 | matchers[0]; | |
| 2191 | } | |
| 2192 | ||
| 2193 | function multipleContexts( selector, contexts, results ) { | |
| 2194 | var i = 0, | |
| 2195 | len = contexts.length; | |
| 2196 | for ( ; i < len; i++ ) { | |
| 2197 | Sizzle( selector, contexts[i], results ); | |
| 2198 | } | |
| 2199 | return results; | |
| 2200 | } | |
| 2201 | ||
| 2202 | function condense( unmatched, map, filter, context, xml ) { | |
| 2203 | var elem, | |
| 2204 | newUnmatched = [], | |
| 2205 | i = 0, | |
| 2206 | len = unmatched.length, | |
| 2207 | mapped = map != null; | |
| 2208 | ||
| 2209 | for ( ; i < len; i++ ) { | |
| 2210 | if ( (elem = unmatched[i]) ) { | |
| 2211 | if ( !filter || filter( elem, context, xml ) ) { | |
| 2212 | newUnmatched.push( elem ); | |
| 2213 | if ( mapped ) { | |
| 2214 | map.push( i ); | |
| 2215 | } | |
| 2216 | } | |
| 2217 | } | |
| 2218 | } | |
| 2219 | ||
| 2220 | return newUnmatched; | |
| 2221 | } | |
| 2222 | ||
| 2223 | function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { | |
| 2224 | if ( postFilter && !postFilter[ expando ] ) { | |
| 2225 | postFilter = setMatcher( postFilter ); | |
| 2226 | } | |
| 2227 | if ( postFinder && !postFinder[ expando ] ) { | |
| 2228 | postFinder = setMatcher( postFinder, postSelector ); | |
| 2229 | } | |
| 2230 | return markFunction(function( seed, results, context, xml ) { | |
| 2231 | var temp, i, elem, | |
| 2232 | preMap = [], | |
| 2233 | postMap = [], | |
| 2234 | preexisting = results.length, | |
| 2235 | ||
| 2236 | // Get initial elements from seed or context | |
| 2237 | elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), | |
| 2238 | ||
| 2239 | // Prefilter to get matcher input, preserving a map for seed-results synchronization | |
| 2240 | matcherIn = preFilter && ( seed || !selector ) ? | |
| 2241 | condense( elems, preMap, preFilter, context, xml ) : | |
| 2242 | elems, | |
| 2243 | ||
| 2244 | matcherOut = matcher ? | |
| 2245 | // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, | |
| 2246 | postFinder || ( seed ? preFilter : preexisting || postFilter ) ? | |
| 2247 | ||
| 2248 | // ...intermediate processing is necessary | |
| 2249 | [] : | |
| 2250 | ||
| 2251 | // ...otherwise use results directly | |
| 2252 | results : | |
| 2253 | matcherIn; | |
| 2254 | ||
| 2255 | // Find primary matches | |
| 2256 | if ( matcher ) { | |
| 2257 | matcher( matcherIn, matcherOut, context, xml ); | |
| 2258 | } | |
| 2259 | ||
| 2260 | // Apply postFilter | |
| 2261 | if ( postFilter ) { | |
| 2262 | temp = condense( matcherOut, postMap ); | |
| 2263 | postFilter( temp, [], context, xml ); | |
| 2264 | ||
| 2265 | // Un-match failing elements by moving them back to matcherIn | |
| 2266 | i = temp.length; | |
| 2267 | while ( i-- ) { | |
| 2268 | if ( (elem = temp[i]) ) { | |
| 2269 | matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); | |
| 2270 | } | |
| 2271 | } | |
| 2272 | } | |
| 2273 | ||
| 2274 | if ( seed ) { | |
| 2275 | if ( postFinder || preFilter ) { | |
| 2276 | if ( postFinder ) { | |
| 2277 | // Get the final matcherOut by condensing this intermediate into postFinder contexts | |
| 2278 | temp = []; | |
| 2279 | i = matcherOut.length; | |
| 2280 | while ( i-- ) { | |
| 2281 | if ( (elem = matcherOut[i]) ) { | |
| 2282 | // Restore matcherIn since elem is not yet a final match | |
| 2283 | temp.push( (matcherIn[i] = elem) ); | |
| 2284 | } | |
| 2285 | } | |
| 2286 | postFinder( null, (matcherOut = []), temp, xml ); | |
| 2287 | } | |
| 2288 | ||
| 2289 | // Move matched elements from seed to results to keep them synchronized | |
| 2290 | i = matcherOut.length; | |
| 2291 | while ( i-- ) { | |
| 2292 | if ( (elem = matcherOut[i]) && | |
| 2293 | (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) { | |
| 2294 | ||
| 2295 | seed[temp] = !(results[temp] = elem); | |
| 2296 | } | |
| 2297 | } | |
| 2298 | } | |
| 2299 | ||
| 2300 | // Add elements to results, through postFinder if defined | |
| 2301 | } else { | |
| 2302 | matcherOut = condense( | |
| 2303 | matcherOut === results ? | |
| 2304 | matcherOut.splice( preexisting, matcherOut.length ) : | |
| 2305 | matcherOut | |
| 2306 | ); | |
| 2307 | if ( postFinder ) { | |
| 2308 | postFinder( null, results, matcherOut, xml ); | |
| 2309 | } else { | |
| 2310 | push.apply( results, matcherOut ); | |
| 2311 | } | |
| 2312 | } | |
| 2313 | }); | |
| 2314 | } | |
| 2315 | ||
| 2316 | function matcherFromTokens( tokens ) { | |
| 2317 | var checkContext, matcher, j, | |
| 2318 | len = tokens.length, | |
| 2319 | leadingRelative = Expr.relative[ tokens[0].type ], | |
| 2320 | implicitRelative = leadingRelative || Expr.relative[" "], | |
| 2321 | i = leadingRelative ? 1 : 0, | |
| 2322 | ||
| 2323 | // The foundational matcher ensures that elements are reachable from top-level context(s) | |
| 2324 | matchContext = addCombinator( function( elem ) { | |
| 2325 | return elem === checkContext; | |
| 2326 | }, implicitRelative, true ), | |
| 2327 | matchAnyContext = addCombinator( function( elem ) { | |
| 2328 | return indexOf( checkContext, elem ) > -1; | |
| 2329 | }, implicitRelative, true ), | |
| 2330 | matchers = [ function( elem, context, xml ) { | |
| 2331 | var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( | |
| 2332 | (checkContext = context).nodeType ? | |
| 2333 | matchContext( elem, context, xml ) : | |
| 2334 | matchAnyContext( elem, context, xml ) ); | |
| 2335 | // Avoid hanging onto element (issue #299) | |
| 2336 | checkContext = null; | |
| 2337 | return ret; | |
| 2338 | } ]; | |
| 2339 | ||
| 2340 | for ( ; i < len; i++ ) { | |
| 2341 | if ( (matcher = Expr.relative[ tokens[i].type ]) ) { | |
| 2342 | matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; | |
| 2343 | } else { | |
| 2344 | matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); | |
| 2345 | ||
| 2346 | // Return special upon seeing a positional matcher | |
| 2347 | if ( matcher[ expando ] ) { | |
| 2348 | // Find the next relative operator (if any) for proper handling | |
| 2349 | j = ++i; | |
| 2350 | for ( ; j < len; j++ ) { | |
| 2351 | if ( Expr.relative[ tokens[j].type ] ) { | |
| 2352 | break; | |
| 2353 | } | |
| 2354 | } | |
| 2355 | return setMatcher( | |
| 2356 | i > 1 && elementMatcher( matchers ), | |
| 2357 | i > 1 && toSelector( | |
| 2358 | // If the preceding token was a descendant combinator, insert an implicit any-element `*` | |
| 2359 | tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) | |
| 2360 | ).replace( rtrim, "$1" ), | |
| 2361 | matcher, | |
| 2362 | i < j && matcherFromTokens( tokens.slice( i, j ) ), | |
| 2363 | j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), | |
| 2364 | j < len && toSelector( tokens ) | |
| 2365 | ); | |
| 2366 | } | |
| 2367 | matchers.push( matcher ); | |
| 2368 | } | |
| 2369 | } | |
| 2370 | ||
| 2371 | return elementMatcher( matchers ); | |
| 2372 | } | |
| 2373 | ||
| 2374 | function matcherFromGroupMatchers( elementMatchers, setMatchers ) { | |
| 2375 | var bySet = setMatchers.length > 0, | |
| 2376 | byElement = elementMatchers.length > 0, | |
| 2377 | superMatcher = function( seed, context, xml, results, outermost ) { | |
| 2378 | var elem, j, matcher, | |
| 2379 | matchedCount = 0, | |
| 2380 | i = "0", | |
| 2381 | unmatched = seed && [], | |
| 2382 | setMatched = [], | |
| 2383 | contextBackup = outermostContext, | |
| 2384 | // We must always have either seed elements or outermost context | |
| 2385 | elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), | |
| 2386 | // Use integer dirruns iff this is the outermost matcher | |
| 2387 | dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), | |
| 2388 | len = elems.length; | |
| 2389 | ||
| 2390 | if ( outermost ) { | |
| 2391 | outermostContext = context !== document && context; | |
| 2392 | } | |
| 2393 | ||
| 2394 | // Add elements passing elementMatchers directly to results | |
| 2395 | // Keep `i` a string if there are no elements so `matchedCount` will be "00" below | |
| 2396 | // Support: IE<9, Safari | |
| 2397 | // Tolerate NodeList properties (IE: "length"; Safari: <number>) matching elements by id | |
| 2398 | for ( ; i !== len && (elem = elems[i]) != null; i++ ) { | |
| 2399 | if ( byElement && elem ) { | |
| 2400 | j = 0; | |
| 2401 | while ( (matcher = elementMatchers[j++]) ) { | |
| 2402 | if ( matcher( elem, context, xml ) ) { | |
| 2403 | results.push( elem ); | |
| 2404 | break; | |
| 2405 | } | |
| 2406 | } | |
| 2407 | if ( outermost ) { | |
| 2408 | dirruns = dirrunsUnique; | |
| 2409 | } | |
| 2410 | } | |
| 2411 | ||
| 2412 | // Track unmatched elements for set filters | |
| 2413 | if ( bySet ) { | |
| 2414 | // They will have gone through all possible matchers | |
| 2415 | if ( (elem = !matcher && elem) ) { | |
| 2416 | matchedCount--; | |
| 2417 | } | |
| 2418 | ||
| 2419 | // Lengthen the array for every element, matched or not | |
| 2420 | if ( seed ) { | |
| 2421 | unmatched.push( elem ); | |
| 2422 | } | |
| 2423 | } | |
| 2424 | } | |
| 2425 | ||
| 2426 | // Apply set filters to unmatched elements | |
| 2427 | matchedCount += i; | |
| 2428 | if ( bySet && i !== matchedCount ) { | |
| 2429 | j = 0; | |
| 2430 | while ( (matcher = setMatchers[j++]) ) { | |
| 2431 | matcher( unmatched, setMatched, context, xml ); | |
| 2432 | } | |
| 2433 | ||
| 2434 | if ( seed ) { | |
| 2435 | // Reintegrate element matches to eliminate the need for sorting | |
| 2436 | if ( matchedCount > 0 ) { | |
| 2437 | while ( i-- ) { | |
| 2438 | if ( !(unmatched[i] || setMatched[i]) ) { | |
| 2439 | setMatched[i] = pop.call( results ); | |
| 2440 | } | |
| 2441 | } | |
| 2442 | } | |
| 2443 | ||
| 2444 | // Discard index placeholder values to get only actual matches | |
| 2445 | setMatched = condense( setMatched ); | |
| 2446 | } | |
| 2447 | ||
| 2448 | // Add matches to results | |
| 2449 | push.apply( results, setMatched ); | |
| 2450 | ||
| 2451 | // Seedless set matches succeeding multiple successful matchers stipulate sorting | |
| 2452 | if ( outermost && !seed && setMatched.length > 0 && | |
| 2453 | ( matchedCount + setMatchers.length ) > 1 ) { | |
| 2454 | ||
| 2455 | Sizzle.uniqueSort( results ); | |
| 2456 | } | |
| 2457 | } | |
| 2458 | ||
| 2459 | // Override manipulation of globals by nested matchers | |
| 2460 | if ( outermost ) { | |
| 2461 | dirruns = dirrunsUnique; | |
| 2462 | outermostContext = contextBackup; | |
| 2463 | } | |
| 2464 | ||
| 2465 | return unmatched; | |
| 2466 | }; | |
| 2467 | ||
| 2468 | return bySet ? | |
| 2469 | markFunction( superMatcher ) : | |
| 2470 | superMatcher; | |
| 2471 | } | |
| 2472 | ||
| 2473 | compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { | |
| 2474 | var i, | |
| 2475 | setMatchers = [], | |
| 2476 | elementMatchers = [], | |
| 2477 | cached = compilerCache[ selector + " " ]; | |
| 2478 | ||
| 2479 | if ( !cached ) { | |
| 2480 | // Generate a function of recursive functions that can be used to check each element | |
| 2481 | if ( !match ) { | |
| 2482 | match = tokenize( selector ); | |
| 2483 | } | |
| 2484 | i = match.length; | |
| 2485 | while ( i-- ) { | |
| 2486 | cached = matcherFromTokens( match[i] ); | |
| 2487 | if ( cached[ expando ] ) { | |
| 2488 | setMatchers.push( cached ); | |
| 2489 | } else { | |
| 2490 | elementMatchers.push( cached ); | |
| 2491 | } | |
| 2492 | } | |
| 2493 | ||
| 2494 | // Cache the compiled function | |
| 2495 | cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); | |
| 2496 | ||
| 2497 | // Save selector and tokenization | |
| 2498 | cached.selector = selector; | |
| 2499 | } | |
| 2500 | return cached; | |
| 2501 | }; | |
| 2502 | ||
| 2503 | /** | |
| 2504 | * A low-level selection function that works with Sizzle's compiled | |
| 2505 | * selector functions | |
| 2506 | * @param {String|Function} selector A selector or a pre-compiled | |
| 2507 | * selector function built with Sizzle.compile | |
| 2508 | * @param {Element} context | |
| 2509 | * @param {Array} [results] | |
| 2510 | * @param {Array} [seed] A set of elements to match against | |
| 2511 | */ | |
| 2512 | select = Sizzle.select = function( selector, context, results, seed ) { | |
| 2513 | var i, tokens, token, type, find, | |
| 2514 | compiled = typeof selector === "function" && selector, | |
| 2515 | match = !seed && tokenize( (selector = compiled.selector || selector) ); | |
| 2516 | ||
| 2517 | results = results || []; | |
| 2518 | ||
| 2519 | // Try to minimize operations if there is no seed and only one group | |
| 2520 | if ( match.length === 1 ) { | |
| 2521 | ||
| 2522 | // Take a shortcut and set the context if the root selector is an ID | |
| 2523 | tokens = match[0] = match[0].slice( 0 ); | |
| 2524 | if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && | |
| 2525 | support.getById && context.nodeType === 9 && documentIsHTML && | |
| 2526 | Expr.relative[ tokens[1].type ] ) { | |
| 2527 | ||
| 2528 | context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; | |
| 2529 | if ( !context ) { | |
| 2530 | return results; | |
| 2531 | ||
| 2532 | // Precompiled matchers will still verify ancestry, so step up a level | |
| 2533 | } else if ( compiled ) { | |
| 2534 | context = context.parentNode; | |
| 2535 | } | |
| 2536 | ||
| 2537 | selector = selector.slice( tokens.shift().value.length ); | |
| 2538 | } | |
| 2539 | ||
| 2540 | // Fetch a seed set for right-to-left matching | |
| 2541 | i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; | |
| 2542 | while ( i-- ) { | |
| 2543 | token = tokens[i]; | |
| 2544 | ||
| 2545 | // Abort if we hit a combinator | |
| 2546 | if ( Expr.relative[ (type = token.type) ] ) { | |
| 2547 | break; | |
| 2548 | } | |
| 2549 | if ( (find = Expr.find[ type ]) ) { | |
| 2550 | // Search, expanding context for leading sibling combinators | |
| 2551 | if ( (seed = find( | |
| 2552 | token.matches[0].replace( runescape, funescape ), | |
| 2553 | rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context | |
| 2554 | )) ) { | |
| 2555 | ||
| 2556 | // If seed is empty or no tokens remain, we can return early | |
| 2557 | tokens.splice( i, 1 ); | |
| 2558 | selector = seed.length && toSelector( tokens ); | |
| 2559 | if ( !selector ) { | |
| 2560 | push.apply( results, seed ); | |
| 2561 | return results; | |
| 2562 | } | |
| 2563 | ||
| 2564 | break; | |
| 2565 | } | |
| 2566 | } | |
| 2567 | } | |
| 2568 | } | |
| 2569 | ||
| 2570 | // Compile and execute a filtering function if one is not provided | |
| 2571 | // Provide `match` to avoid retokenization if we modified the selector above | |
| 2572 | ( compiled || compile( selector, match ) )( | |
| 2573 | seed, | |
| 2574 | context, | |
| 2575 | !documentIsHTML, | |
| 2576 | results, | |
| 2577 | rsibling.test( selector ) && testContext( context.parentNode ) || context | |
| 2578 | ); | |
| 2579 | return results; | |
| 2580 | }; | |
| 2581 | ||
| 2582 | // One-time assignments | |
| 2583 | ||
| 2584 | // Sort stability | |
| 2585 | support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; | |
| 2586 | ||
| 2587 | // Support: Chrome 14-35+ | |
| 2588 | // Always assume duplicates if they aren't passed to the comparison function | |
| 2589 | support.detectDuplicates = !!hasDuplicate; | |
| 2590 | ||
| 2591 | // Initialize against the default document | |
| 2592 | setDocument(); | |
| 2593 | ||
| 2594 | // Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) | |
| 2595 | // Detached nodes confoundingly follow *each other* | |
| 2596 | support.sortDetached = assert(function( div1 ) { | |
| 2597 | // Should return 1, but returns 4 (following) | |
| 2598 | return div1.compareDocumentPosition( document.createElement("div") ) & 1; | |
| 2599 | }); | |
| 2600 | ||
| 2601 | // Support: IE<8 | |
| 2602 | // Prevent attribute/property "interpolation" | |
| 2603 | // http://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx | |
| 2604 | if ( !assert(function( div ) { | |
| 2605 | div.innerHTML = "<a href='#'></a>"; | |
| 2606 | return div.firstChild.getAttribute("href") === "#" ; | |
| 2607 | }) ) { | |
| 2608 | addHandle( "type|href|height|width", function( elem, name, isXML ) { | |
| 2609 | if ( !isXML ) { | |
| 2610 | return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); | |
| 2611 | } | |
| 2612 | }); | |
| 2613 | } | |
| 2614 | ||
| 2615 | // Support: IE<9 | |
| 2616 | // Use defaultValue in place of getAttribute("value") | |
| 2617 | if ( !support.attributes || !assert(function( div ) { | |
| 2618 | div.innerHTML = "<input/>"; | |
| 2619 | div.firstChild.setAttribute( "value", "" ); | |
| 2620 | return div.firstChild.getAttribute( "value" ) === ""; | |
| 2621 | }) ) { | |
| 2622 | addHandle( "value", function( elem, name, isXML ) { | |
| 2623 | if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { | |
| 2624 | return elem.defaultValue; | |
| 2625 | } | |
| 2626 | }); | |
| 2627 | } | |
| 2628 | ||
| 2629 | // Support: IE<9 | |
| 2630 | // Use getAttributeNode to fetch booleans when getAttribute lies | |
| 2631 | if ( !assert(function( div ) { | |
| 2632 | return div.getAttribute("disabled") == null; | |
| 2633 | }) ) { | |
| 2634 | addHandle( booleans, function( elem, name, isXML ) { | |
| 2635 | var val; | |
| 2636 | if ( !isXML ) { | |
| 2637 | return elem[ name ] === true ? name.toLowerCase() : | |
| 2638 | (val = elem.getAttributeNode( name )) && val.specified ? | |
| 2639 | val.value : | |
| 2640 | null; | |
| 2641 | } | |
| 2642 | }); | |
| 2643 | } | |
| 2644 | ||
| 2645 | return Sizzle; | |
| 2646 | ||
| 2647 | })( window ); | |
| 2648 | ||
| 2649 | ||
| 2650 | ||
| 2651 | jQuery.find = Sizzle; | |
| 2652 | jQuery.expr = Sizzle.selectors; | |
| 2653 | jQuery.expr[":"] = jQuery.expr.pseudos; | |
| 2654 | jQuery.unique = Sizzle.uniqueSort; | |
| 2655 | jQuery.text = Sizzle.getText; | |
| 2656 | jQuery.isXMLDoc = Sizzle.isXML; | |
| 2657 | jQuery.contains = Sizzle.contains; | |
| 2658 | ||
| 2659 | ||
| 2660 | ||
| 2661 | var rneedsContext = jQuery.expr.match.needsContext; | |
| 2662 | ||
| 2663 | var rsingleTag = (/^<(\w+)\s*\/?>(?:<\/\1>|)$/); | |
| 2664 | ||
| 2665 | ||
| 2666 | ||
| 2667 | var risSimple = /^.[^:#\[\.,]*$/; | |
| 2668 | ||
| 2669 | // Implement the identical functionality for filter and not | |
| 2670 | function winnow( elements, qualifier, not ) { | |
| 2671 | if ( jQuery.isFunction( qualifier ) ) { | |
| 2672 | return jQuery.grep( elements, function( elem, i ) { | |
| 2673 | /* jshint -W018 */ | |
| 2674 | return !!qualifier.call( elem, i, elem ) !== not; | |
| 2675 | }); | |
| 2676 | ||
| 2677 | } | |
| 2678 | ||
| 2679 | if ( qualifier.nodeType ) { | |
| 2680 | return jQuery.grep( elements, function( elem ) { | |
| 2681 | return ( elem === qualifier ) !== not; | |
| 2682 | }); | |
| 2683 | ||
| 2684 | } | |
| 2685 | ||
| 2686 | if ( typeof qualifier === "string" ) { | |
| 2687 | if ( risSimple.test( qualifier ) ) { | |
| 2688 | return jQuery.filter( qualifier, elements, not ); | |
| 2689 | } | |
| 2690 | ||
| 2691 | qualifier = jQuery.filter( qualifier, elements ); | |
| 2692 | } | |
| 2693 | ||
| 2694 | return jQuery.grep( elements, function( elem ) { | |
| 2695 | return ( jQuery.inArray( elem, qualifier ) >= 0 ) !== not; | |
| 2696 | }); | |
| 2697 | } | |
| 2698 | ||
| 2699 | jQuery.filter = function( expr, elems, not ) { | |
| 2700 | var elem = elems[ 0 ]; | |
| 2701 | ||
| 2702 | if ( not ) { | |
| 2703 | expr = ":not(" + expr + ")"; | |
| 2704 | } | |
| 2705 | ||
| 2706 | return elems.length === 1 && elem.nodeType === 1 ? | |
| 2707 | jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : [] : | |
| 2708 | jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { | |
| 2709 | return elem.nodeType === 1; | |
| 2710 | })); | |
| 2711 | }; | |
| 2712 | ||
| 2713 | jQuery.fn.extend({ | |
| 2714 | find: function( selector ) { | |
| 2715 | var i, | |
| 2716 | ret = [], | |
| 2717 | self = this, | |
| 2718 | len = self.length; | |
| 2719 | ||
| 2720 | if ( typeof selector !== "string" ) { | |
| 2721 | return this.pushStack( jQuery( selector ).filter(function() { | |
| 2722 | for ( i = 0; i < len; i++ ) { | |
| 2723 | if ( jQuery.contains( self[ i ], this ) ) { | |
| 2724 | return true; | |
| 2725 | } | |
| 2726 | } | |
| 2727 | }) ); | |
| 2728 | } | |
| 2729 | ||
| 2730 | for ( i = 0; i < len; i++ ) { | |
| 2731 | jQuery.find( selector, self[ i ], ret ); | |
| 2732 | } | |
| 2733 | ||
| 2734 | // Needed because $( selector, context ) becomes $( context ).find( selector ) | |
| 2735 | ret = this.pushStack( len > 1 ? jQuery.unique( ret ) : ret ); | |
| 2736 | ret.selector = this.selector ? this.selector + " " + selector : selector; | |
| 2737 | return ret; | |
| 2738 | }, | |
| 2739 | filter: function( selector ) { | |
| 2740 | return this.pushStack( winnow(this, selector || [], false) ); | |
| 2741 | }, | |
| 2742 | not: function( selector ) { | |
| 2743 | return this.pushStack( winnow(this, selector || [], true) ); | |
| 2744 | }, | |
| 2745 | is: function( selector ) { | |
| 2746 | return !!winnow( | |
| 2747 | this, | |
| 2748 | ||
| 2749 | // If this is a positional/relative selector, check membership in the returned set | |
| 2750 | // so $("p:first").is("p:last") won't return true for a doc with two "p". | |
| 2751 | typeof selector === "string" && rneedsContext.test( selector ) ? | |
| 2752 | jQuery( selector ) : | |
| 2753 | selector || [], | |
| 2754 | false | |
| 2755 | ).length; | |
| 2756 | } | |
| 2757 | }); | |
| 2758 | ||
| 2759 | ||
| 2760 | // Initialize a jQuery object | |
| 2761 | ||
| 2762 | ||
| 2763 | // A central reference to the root jQuery(document) | |
| 2764 | var rootjQuery, | |
| 2765 | ||
| 2766 | // Use the correct document accordingly with window argument (sandbox) | |
| 2767 | document = window.document, | |
| 2768 | ||
| 2769 | // A simple way to check for HTML strings | |
| 2770 | // Prioritize #id over <tag> to avoid XSS via location.hash (#9521) | |
| 2771 | // Strict HTML recognition (#11290: must start with <) | |
| 2772 | rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/, | |
| 2773 | ||
| 2774 | init = jQuery.fn.init = function( selector, context ) { | |
| 2775 | var match, elem; | |
| 2776 | ||
| 2777 | // HANDLE: $(""), $(null), $(undefined), $(false) | |
| 2778 | if ( !selector ) { | |
| 2779 | return this; | |
| 2780 | } | |
| 2781 | ||
| 2782 | // Handle HTML strings | |
| 2783 | if ( typeof selector === "string" ) { | |
| 2784 | if ( selector.charAt(0) === "<" && selector.charAt( selector.length - 1 ) === ">" && selector.length >= 3 ) { | |
| 2785 | // Assume that strings that start and end with <> are HTML and skip the regex check | |
| 2786 | match = [ null, selector, null ]; | |
| 2787 | ||
| 2788 | } else { | |
| 2789 | match = rquickExpr.exec( selector ); | |
| 2790 | } | |
| 2791 | ||
| 2792 | // Match html or make sure no context is specified for #id | |
| 2793 | if ( match && (match[1] || !context) ) { | |
| 2794 | ||
| 2795 | // HANDLE: $(html) -> $(array) | |
| 2796 | if ( match[1] ) { | |
| 2797 | context = context instanceof jQuery ? context[0] : context; | |
| 2798 | ||
| 2799 | // scripts is true for back-compat | |
| 2800 | // Intentionally let the error be thrown if parseHTML is not present | |
| 2801 | jQuery.merge( this, jQuery.parseHTML( | |
| 2802 | match[1], | |
| 2803 | context && context.nodeType ? context.ownerDocument || context : document, | |
| 2804 | true | |
| 2805 | ) ); | |
| 2806 | ||
| 2807 | // HANDLE: $(html, props) | |
| 2808 | if ( rsingleTag.test( match[1] ) && jQuery.isPlainObject( context ) ) { | |
| 2809 | for ( match in context ) { | |
| 2810 | // Properties of context are called as methods if possible | |
| 2811 | if ( jQuery.isFunction( this[ match ] ) ) { | |
| 2812 | this[ match ]( context[ match ] ); | |
| 2813 | ||
| 2814 | // ...and otherwise set as attributes | |
| 2815 | } else { | |
| 2816 | this.attr( match, context[ match ] ); | |
| 2817 | } | |
| 2818 | } | |
| 2819 | } | |
| 2820 | ||
| 2821 | return this; | |
| 2822 | ||
| 2823 | // HANDLE: $(#id) | |
| 2824 | } else { | |
| 2825 | elem = document.getElementById( match[2] ); | |
| 2826 | ||
| 2827 | // Check parentNode to catch when Blackberry 4.6 returns | |
| 2828 | // nodes that are no longer in the document #6963 | |
| 2829 | if ( elem && elem.parentNode ) { | |
| 2830 | // Handle the case where IE and Opera return items | |
| 2831 | // by name instead of ID | |
| 2832 | if ( elem.id !== match[2] ) { | |
| 2833 | return rootjQuery.find( selector ); | |
| 2834 | } | |
| 2835 | ||
| 2836 | // Otherwise, we inject the element directly into the jQuery object | |
| 2837 | this.length = 1; | |
| 2838 | this[0] = elem; | |
| 2839 | } | |
| 2840 | ||
| 2841 | this.context = document; | |
| 2842 | this.selector = selector; | |
| 2843 | return this; | |
| 2844 | } | |
| 2845 | ||
| 2846 | // HANDLE: $(expr, $(...)) | |
| 2847 | } else if ( !context || context.jquery ) { | |
| 2848 | return ( context || rootjQuery ).find( selector ); | |
| 2849 | ||
| 2850 | // HANDLE: $(expr, context) | |
| 2851 | // (which is just equivalent to: $(context).find(expr) | |
| 2852 | } else { | |
| 2853 | return this.constructor( context ).find( selector ); | |
| 2854 | } | |
| 2855 | ||
| 2856 | // HANDLE: $(DOMElement) | |
| 2857 | } else if ( selector.nodeType ) { | |
| 2858 | this.context = this[0] = selector; | |
| 2859 | this.length = 1; | |
| 2860 | return this; | |
| 2861 | ||
| 2862 | // HANDLE: $(function) | |
| 2863 | // Shortcut for document ready | |
| 2864 | } else if ( jQuery.isFunction( selector ) ) { | |
| 2865 | return typeof rootjQuery.ready !== "undefined" ? | |
| 2866 | rootjQuery.ready( selector ) : | |
| 2867 | // Execute immediately if ready is not present | |
| 2868 | selector( jQuery ); | |
| 2869 | } | |
| 2870 | ||
| 2871 | if ( selector.selector !== undefined ) { | |
| 2872 | this.selector = selector.selector; | |
| 2873 | this.context = selector.context; | |
| 2874 | } | |
| 2875 | ||
| 2876 | return jQuery.makeArray( selector, this ); | |
| 2877 | }; | |
| 2878 | ||
| 2879 | // Give the init function the jQuery prototype for later instantiation | |
| 2880 | init.prototype = jQuery.fn; | |
| 2881 | ||
| 2882 | // Initialize central reference | |
| 2883 | rootjQuery = jQuery( document ); | |
| 2884 | ||
| 2885 | ||
| 2886 | var rparentsprev = /^(?:parents|prev(?:Until|All))/, | |
| 2887 | // methods guaranteed to produce a unique set when starting from a unique set | |
| 2888 | guaranteedUnique = { | |
| 2889 | children: true, | |
| 2890 | contents: true, | |
| 2891 | next: true, | |
| 2892 | prev: true | |
| 2893 | }; | |
| 2894 | ||
| 2895 | jQuery.extend({ | |
| 2896 | dir: function( elem, dir, until ) { | |
| 2897 | var matched = [], | |
| 2898 | cur = elem[ dir ]; | |
| 2899 | ||
| 2900 | while ( cur && cur.nodeType !== 9 && (until === undefined || cur.nodeType !== 1 || !jQuery( cur ).is( until )) ) { | |
| 2901 | if ( cur.nodeType === 1 ) { | |
| 2902 | matched.push( cur ); | |
| 2903 | } | |
| 2904 | cur = cur[dir]; | |
| 2905 | } | |
| 2906 | return matched; | |
| 2907 | }, | |
| 2908 | ||
| 2909 | sibling: function( n, elem ) { | |
| 2910 | var r = []; | |
| 2911 | ||
| 2912 | for ( ; n; n = n.nextSibling ) { | |
| 2913 | if ( n.nodeType === 1 && n !== elem ) { | |
| 2914 | r.push( n ); | |
| 2915 | } | |
| 2916 | } | |
| 2917 | ||
| 2918 | return r; | |
| 2919 | } | |
| 2920 | }); | |
| 2921 | ||
| 2922 | jQuery.fn.extend({ | |
| 2923 | has: function( target ) { | |
| 2924 | var i, | |
| 2925 | targets = jQuery( target, this ), | |
| 2926 | len = targets.length; | |
| 2927 | ||
| 2928 | return this.filter(function() { | |
| 2929 | for ( i = 0; i < len; i++ ) { | |
| 2930 | if ( jQuery.contains( this, targets[i] ) ) { | |
| 2931 | return true; | |
| 2932 | } | |
| 2933 | } | |
| 2934 | }); | |
| 2935 | }, | |
| 2936 | ||
| 2937 | closest: function( selectors, context ) { | |
| 2938 | var cur, | |
| 2939 | i = 0, | |
| 2940 | l = this.length, | |
| 2941 | matched = [], | |
| 2942 | pos = rneedsContext.test( selectors ) || typeof selectors !== "string" ? | |
| 2943 | jQuery( selectors, context || this.context ) : | |
| 2944 | 0; | |
| 2945 | ||
| 2946 | for ( ; i < l; i++ ) { | |
| 2947 | for ( cur = this[i]; cur && cur !== context; cur = cur.parentNode ) { | |
| 2948 | // Always skip document fragments | |
| 2949 | if ( cur.nodeType < 11 && (pos ? | |
| 2950 | pos.index(cur) > -1 : | |
| 2951 | ||
| 2952 | // Don't pass non-elements to Sizzle | |
| 2953 | cur.nodeType === 1 && | |
| 2954 | jQuery.find.matchesSelector(cur, selectors)) ) { | |
| 2955 | ||
| 2956 | matched.push( cur ); | |
| 2957 | break; | |
| 2958 | } | |
| 2959 | } | |
| 2960 | } | |
| 2961 | ||
| 2962 | return this.pushStack( matched.length > 1 ? jQuery.unique( matched ) : matched ); | |
| 2963 | }, | |
| 2964 | ||
| 2965 | // Determine the position of an element within | |
| 2966 | // the matched set of elements | |
| 2967 | index: function( elem ) { | |
| 2968 | ||
| 2969 | // No argument, return index in parent | |
| 2970 | if ( !elem ) { | |
| 2971 | return ( this[0] && this[0].parentNode ) ? this.first().prevAll().length : -1; | |
| 2972 | } | |
| 2973 | ||
| 2974 | // index in selector | |
| 2975 | if ( typeof elem === "string" ) { | |
| 2976 | return jQuery.inArray( this[0], jQuery( elem ) ); | |
| 2977 | } | |
| 2978 | ||
| 2979 | // Locate the position of the desired element | |
| 2980 | return jQuery.inArray( | |
| 2981 | // If it receives a jQuery object, the first element is used | |
| 2982 | elem.jquery ? elem[0] : elem, this ); | |
| 2983 | }, | |
| 2984 | ||
| 2985 | add: function( selector, context ) { | |
| 2986 | return this.pushStack( | |
| 2987 | jQuery.unique( | |
| 2988 | jQuery.merge( this.get(), jQuery( selector, context ) ) | |
| 2989 | ) | |
| 2990 | ); | |
| 2991 | }, | |
| 2992 | ||
| 2993 | addBack: function( selector ) { | |
| 2994 | return this.add( selector == null ? | |
| 2995 | this.prevObject : this.prevObject.filter(selector) | |
| 2996 | ); | |
| 2997 | } | |
| 2998 | }); | |
| 2999 | ||
| 3000 | function sibling( cur, dir ) { | |
| 3001 | do { | |
| 3002 | cur = cur[ dir ]; | |
| 3003 | } while ( cur && cur.nodeType !== 1 ); | |
| 3004 | ||
| 3005 | return cur; | |
| 3006 | } | |
| 3007 | ||
| 3008 | jQuery.each({ | |
| 3009 | parent: function( elem ) { | |
| 3010 | var parent = elem.parentNode; | |
| 3011 | return parent && parent.nodeType !== 11 ? parent : null; | |
| 3012 | }, | |
| 3013 | parents: function( elem ) { | |
| 3014 | return jQuery.dir( elem, "parentNode" ); | |
| 3015 | }, | |
| 3016 | parentsUntil: function( elem, i, until ) { | |
| 3017 | return jQuery.dir( elem, "parentNode", until ); | |
| 3018 | }, | |
| 3019 | next: function( elem ) { | |
| 3020 | return sibling( elem, "nextSibling" ); | |
| 3021 | }, | |
| 3022 | prev: function( elem ) { | |
| 3023 | return sibling( elem, "previousSibling" ); | |
| 3024 | }, | |
| 3025 | nextAll: function( elem ) { | |
| 3026 | return jQuery.dir( elem, "nextSibling" ); | |
| 3027 | }, | |
| 3028 | prevAll: function( elem ) { | |
| 3029 | return jQuery.dir( elem, "previousSibling" ); | |
| 3030 | }, | |
| 3031 | nextUntil: function( elem, i, until ) { | |
| 3032 | return jQuery.dir( elem, "nextSibling", until ); | |
| 3033 | }, | |
| 3034 | prevUntil: function( elem, i, until ) { | |
| 3035 | return jQuery.dir( elem, "previousSibling", until ); | |
| 3036 | }, | |
| 3037 | siblings: function( elem ) { | |
| 3038 | return jQuery.sibling( ( elem.parentNode || {} ).firstChild, elem ); | |
| 3039 | }, | |
| 3040 | children: function( elem ) { | |
| 3041 | return jQuery.sibling( elem.firstChild ); | |
| 3042 | }, | |
| 3043 | contents: function( elem ) { | |
| 3044 | return jQuery.nodeName( elem, "iframe" ) ? | |
| 3045 | elem.contentDocument || elem.contentWindow.document : | |
| 3046 | jQuery.merge( [], elem.childNodes ); | |
| 3047 | } | |
| 3048 | }, function( name, fn ) { | |
| 3049 | jQuery.fn[ name ] = function( until, selector ) { | |
| 3050 | var ret = jQuery.map( this, fn, until ); | |
| 3051 | ||
| 3052 | if ( name.slice( -5 ) !== "Until" ) { | |
| 3053 | selector = until; | |
| 3054 | } | |
| 3055 | ||
| 3056 | if ( selector && typeof selector === "string" ) { | |
| 3057 | ret = jQuery.filter( selector, ret ); | |
| 3058 | } | |
| 3059 | ||
| 3060 | if ( this.length > 1 ) { | |
| 3061 | // Remove duplicates | |
| 3062 | if ( !guaranteedUnique[ name ] ) { | |
| 3063 | ret = jQuery.unique( ret ); | |
| 3064 | } | |
| 3065 | ||
| 3066 | // Reverse order for parents* and prev-derivatives | |
| 3067 | if ( rparentsprev.test( name ) ) { | |
| 3068 | ret = ret.reverse(); | |
| 3069 | } | |
| 3070 | } | |
| 3071 | ||
| 3072 | return this.pushStack( ret ); | |
| 3073 | }; | |
| 3074 | }); | |
| 3075 | var rnotwhite = (/\S+/g); | |
| 3076 | ||
| 3077 | ||
| 3078 | ||
| 3079 | // String to Object options format cache | |
| 3080 | var optionsCache = {}; | |
| 3081 | ||
| 3082 | // Convert String-formatted options into Object-formatted ones and store in cache | |
| 3083 | function createOptions( options ) { | |
| 3084 | var object = optionsCache[ options ] = {}; | |
| 3085 | jQuery.each( options.match( rnotwhite ) || [], function( _, flag ) { | |
| 3086 | object[ flag ] = true; | |
| 3087 | }); | |
| 3088 | return object; | |
| 3089 | } | |
| 3090 | ||
| 3091 | /* | |
| 3092 | * Create a callback list using the following parameters: | |
| 3093 | * | |
| 3094 | * options: an optional list of space-separated options that will change how | |
| 3095 | * the callback list behaves or a more traditional option object | |
| 3096 | * | |
| 3097 | * By default a callback list will act like an event callback list and can be | |
| 3098 | * "fired" multiple times. | |
| 3099 | * | |
| 3100 | * Possible options: | |
| 3101 | * | |
| 3102 | * once: will ensure the callback list can only be fired once (like a Deferred) | |
| 3103 | * | |
| 3104 | * memory: will keep track of previous values and will call any callback added | |
| 3105 | * after the list has been fired right away with the latest "memorized" | |
| 3106 | * values (like a Deferred) | |
| 3107 | * | |
| 3108 | * unique: will ensure a callback can only be added once (no duplicate in the list) | |
| 3109 | * | |
| 3110 | * stopOnFalse: interrupt callings when a callback returns false | |
| 3111 | * | |
| 3112 | */ | |
| 3113 | jQuery.Callbacks = function( options ) { | |
| 3114 | ||
| 3115 | // Convert options from String-formatted to Object-formatted if needed | |
| 3116 | // (we check in cache first) | |
| 3117 | options = typeof options === "string" ? | |
| 3118 | ( optionsCache[ options ] || createOptions( options ) ) : | |
| 3119 | jQuery.extend( {}, options ); | |
| 3120 | ||
| 3121 | var // Flag to know if list is currently firing | |
| 3122 | firing, | |
| 3123 | // Last fire value (for non-forgettable lists) | |
| 3124 | memory, | |
| 3125 | // Flag to know if list was already fired | |
| 3126 | fired, | |
| 3127 | // End of the loop when firing | |
| 3128 | firingLength, | |
| 3129 | // Index of currently firing callback (modified by remove if needed) | |
| 3130 | firingIndex, | |
| 3131 | // First callback to fire (used internally by add and fireWith) | |
| 3132 | firingStart, | |
| 3133 | // Actual callback list | |
| 3134 | list = [], | |
| 3135 | // Stack of fire calls for repeatable lists | |
| 3136 | stack = !options.once && [], | |
| 3137 | // Fire callbacks | |
| 3138 | fire = function( data ) { | |
| 3139 | memory = options.memory && data; | |
| 3140 | fired = true; | |
| 3141 | firingIndex = firingStart || 0; | |
| 3142 | firingStart = 0; | |
| 3143 | firingLength = list.length; | |
| 3144 | firing = true; | |
| 3145 | for ( ; list && firingIndex < firingLength; firingIndex++ ) { | |
| 3146 | if ( list[ firingIndex ].apply( data[ 0 ], data[ 1 ] ) === false && options.stopOnFalse ) { | |
| 3147 | memory = false; // To prevent further calls using add | |
| 3148 | break; | |
| 3149 | } | |
| 3150 | } | |
| 3151 | firing = false; | |
| 3152 | if ( list ) { | |
| 3153 | if ( stack ) { | |
| 3154 | if ( stack.length ) { | |
| 3155 | fire( stack.shift() ); | |
| 3156 | } | |
| 3157 | } else if ( memory ) { | |
| 3158 | list = []; | |
| 3159 | } else { | |
| 3160 | self.disable(); | |
| 3161 | } | |
| 3162 | } | |
| 3163 | }, | |
| 3164 | // Actual Callbacks object | |
| 3165 | self = { | |
| 3166 | // Add a callback or a collection of callbacks to the list | |
| 3167 | add: function() { | |
| 3168 | if ( list ) { | |
| 3169 | // First, we save the current length | |
| 3170 | var start = list.length; | |
| 3171 | (function add( args ) { | |
| 3172 | jQuery.each( args, function( _, arg ) { | |
| 3173 | var type = jQuery.type( arg ); | |
| 3174 | if ( type === "function" ) { | |
| 3175 | if ( !options.unique || !self.has( arg ) ) { | |
| 3176 | list.push( arg ); | |
| 3177 | } | |
| 3178 | } else if ( arg && arg.length && type !== "string" ) { | |
| 3179 | // Inspect recursively | |
| 3180 | add( arg ); | |
| 3181 | } | |
| 3182 | }); | |
| 3183 | })( arguments ); | |
| 3184 | // Do we need to add the callbacks to the | |
| 3185 | // current firing batch? | |
| 3186 | if ( firing ) { | |
| 3187 | firingLength = list.length; | |
| 3188 | // With memory, if we're not firing then | |
| 3189 | // we should call right away | |
| 3190 | } else if ( memory ) { | |
| 3191 | firingStart = start; | |
| 3192 | fire( memory ); | |
| 3193 | } | |
| 3194 | } | |
| 3195 | return this; | |
| 3196 | }, | |
| 3197 | // Remove a callback from the list | |
| 3198 | remove: function() { | |
| 3199 | if ( list ) { | |
| 3200 | jQuery.each( arguments, function( _, arg ) { | |
| 3201 | var index; | |
| 3202 | while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { | |
| 3203 | list.splice( index, 1 ); | |
| 3204 | // Handle firing indexes | |
| 3205 | if ( firing ) { | |
| 3206 | if ( index <= firingLength ) { | |
| 3207 | firingLength--; | |
| 3208 | } | |
| 3209 | if ( index <= firingIndex ) { | |
| 3210 | firingIndex--; | |
| 3211 | } | |
| 3212 | } | |
| 3213 | } | |
| 3214 | }); | |
| 3215 | } | |
| 3216 | return this; | |
| 3217 | }, | |
| 3218 | // Check if a given callback is in the list. | |
| 3219 | // If no argument is given, return whether or not list has callbacks attached. | |
| 3220 | has: function( fn ) { | |
| 3221 | return fn ? jQuery.inArray( fn, list ) > -1 : !!( list && list.length ); | |
| 3222 | }, | |
| 3223 | // Remove all callbacks from the list | |
| 3224 | empty: function() { | |
| 3225 | list = []; | |
| 3226 | firingLength = 0; | |
| 3227 | return this; | |
| 3228 | }, | |
| 3229 | // Have the list do nothing anymore | |
| 3230 | disable: function() { | |
| 3231 | list = stack = memory = undefined; | |
| 3232 | return this; | |
| 3233 | }, | |
| 3234 | // Is it disabled? | |
| 3235 | disabled: function() { | |
| 3236 | return !list; | |
| 3237 | }, | |
| 3238 | // Lock the list in its current state | |
| 3239 | lock: function() { | |
| 3240 | stack = undefined; | |
| 3241 | if ( !memory ) { | |
| 3242 | self.disable(); | |
| 3243 | } | |
| 3244 | return this; | |
| 3245 | }, | |
| 3246 | // Is it locked? | |
| 3247 | locked: function() { | |
| 3248 | return !stack; | |
| 3249 | }, | |
| 3250 | // Call all callbacks with the given context and arguments | |
| 3251 | fireWith: function( context, args ) { | |
| 3252 | if ( list && ( !fired || stack ) ) { | |
| 3253 | args = args || []; | |
| 3254 | args = [ context, args.slice ? args.slice() : args ]; | |
| 3255 | if ( firing ) { | |
| 3256 | stack.push( args ); | |
| 3257 | } else { | |
| 3258 | fire( args ); | |
| 3259 | } | |
| 3260 | } | |
| 3261 | return this; | |
| 3262 | }, | |
| 3263 | // Call all the callbacks with the given arguments | |
| 3264 | fire: function() { | |
| 3265 | self.fireWith( this, arguments ); | |
| 3266 | return this; | |
| 3267 | }, | |
| 3268 | // To know if the callbacks have already been called at least once | |
| 3269 | fired: function() { | |
| 3270 | return !!fired; | |
| 3271 | } | |
| 3272 | }; | |
| 3273 | ||
| 3274 | return self; | |
| 3275 | }; | |
| 3276 | ||
| 3277 | ||
| 3278 | jQuery.extend({ | |
| 3279 | ||
| 3280 | Deferred: function( func ) { | |
| 3281 | var tuples = [ | |
| 3282 | // action, add listener, listener list, final state | |
| 3283 | [ "resolve", "done", jQuery.Callbacks("once memory"), "resolved" ], | |
| 3284 | [ "reject", "fail", jQuery.Callbacks("once memory"), "rejected" ], | |
| 3285 | [ "notify", "progress", jQuery.Callbacks("memory") ] | |
| 3286 | ], | |
| 3287 | state = "pending", | |
| 3288 | promise = { | |
| 3289 | state: function() { | |
| 3290 | return state; | |
| 3291 | }, | |
| 3292 | always: function() { | |
| 3293 | deferred.done( arguments ).fail( arguments ); | |
| 3294 | return this; | |
| 3295 | }, | |
| 3296 | then: function( /* fnDone, fnFail, fnProgress */ ) { | |
| 3297 | var fns = arguments; | |
| 3298 | return jQuery.Deferred(function( newDefer ) { | |
| 3299 | jQuery.each( tuples, function( i, tuple ) { | |
| 3300 | var fn = jQuery.isFunction( fns[ i ] ) && fns[ i ]; | |
| 3301 | // deferred[ done | fail | progress ] for forwarding actions to newDefer | |
| 3302 | deferred[ tuple[1] ](function() { | |
| 3303 | var returned = fn && fn.apply( this, arguments ); | |
| 3304 | if ( returned && jQuery.isFunction( returned.promise ) ) { | |
| 3305 | returned.promise() | |
| 3306 | .done( newDefer.resolve ) | |
| 3307 | .fail( newDefer.reject ) | |
| 3308 | .progress( newDefer.notify ); | |
| 3309 | } else { | |
| 3310 | newDefer[ tuple[ 0 ] + "With" ]( this === promise ? newDefer.promise() : this, fn ? [ returned ] : arguments ); | |
| 3311 | } | |
| 3312 | }); | |
| 3313 | }); | |
| 3314 | fns = null; | |
| 3315 | }).promise(); | |
| 3316 | }, | |
| 3317 | // Get a promise for this deferred | |
| 3318 | // If obj is provided, the promise aspect is added to the object | |
| 3319 | promise: function( obj ) { | |
| 3320 | return obj != null ? jQuery.extend( obj, promise ) : promise; | |
| 3321 | } | |
| 3322 | }, | |
| 3323 | deferred = {}; | |
| 3324 | ||
| 3325 | // Keep pipe for back-compat | |
| 3326 | promise.pipe = promise.then; | |
| 3327 | ||
| 3328 | // Add list-specific methods | |
| 3329 | jQuery.each( tuples, function( i, tuple ) { | |
| 3330 | var list = tuple[ 2 ], | |
| 3331 | stateString = tuple[ 3 ]; | |
| 3332 | ||
| 3333 | // promise[ done | fail | progress ] = list.add | |
| 3334 | promise[ tuple[1] ] = list.add; | |
| 3335 | ||
| 3336 | // Handle state | |
| 3337 | if ( stateString ) { | |
| 3338 | list.add(function() { | |
| 3339 | // state = [ resolved | rejected ] | |
| 3340 | state = stateString; | |
| 3341 | ||
| 3342 | // [ reject_list | resolve_list ].disable; progress_list.lock | |
| 3343 | }, tuples[ i ^ 1 ][ 2 ].disable, tuples[ 2 ][ 2 ].lock ); | |
| 3344 | } | |
| 3345 | ||
| 3346 | // deferred[ resolve | reject | notify ] | |
| 3347 | deferred[ tuple[0] ] = function() { | |
| 3348 | deferred[ tuple[0] + "With" ]( this === deferred ? promise : this, arguments ); | |
| 3349 | return this; | |
| 3350 | }; | |
| 3351 | deferred[ tuple[0] + "With" ] = list.fireWith; | |
| 3352 | }); | |
| 3353 | ||
| 3354 | // Make the deferred a promise | |
| 3355 | promise.promise( deferred ); | |
| 3356 | ||
| 3357 | // Call given func if any | |
| 3358 | if ( func ) { | |
| 3359 | func.call( deferred, deferred ); | |
| 3360 | } | |
| 3361 | ||
| 3362 | // All done! | |
| 3363 | return deferred; | |
| 3364 | }, | |
| 3365 | ||
| 3366 | // Deferred helper | |
| 3367 | when: function( subordinate /* , ..., subordinateN */ ) { | |
| 3368 | var i = 0, | |
| 3369 | resolveValues = slice.call( arguments ), | |
| 3370 | length = resolveValues.length, | |
| 3371 | ||
| 3372 | // the count of uncompleted subordinates | |
| 3373 | remaining = length !== 1 || ( subordinate && jQuery.isFunction( subordinate.promise ) ) ? length : 0, | |
| 3374 | ||
| 3375 | // the master Deferred. If resolveValues consist of only a single Deferred, just use that. | |
| 3376 | deferred = remaining === 1 ? subordinate : jQuery.Deferred(), | |
| 3377 | ||
| 3378 | // Update function for both resolve and progress values | |
| 3379 | updateFunc = function( i, contexts, values ) { | |
| 3380 | return function( value ) { | |
| 3381 | contexts[ i ] = this; | |
| 3382 | values[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; | |
| 3383 | if ( values === progressValues ) { | |
| 3384 | deferred.notifyWith( contexts, values ); | |
| 3385 | ||
| 3386 | } else if ( !(--remaining) ) { | |
| 3387 | deferred.resolveWith( contexts, values ); | |
| 3388 | } | |
| 3389 | }; | |
| 3390 | }, | |
| 3391 | ||
| 3392 | progressValues, progressContexts, resolveContexts; | |
| 3393 | ||
| 3394 | // add listeners to Deferred subordinates; treat others as resolved | |
| 3395 | if ( length > 1 ) { | |
| 3396 | progressValues = new Array( length ); | |
| 3397 | progressContexts = new Array( length ); | |
| 3398 | resolveContexts = new Array( length ); | |
| 3399 | for ( ; i < length; i++ ) { | |
| 3400 | if ( resolveValues[ i ] && jQuery.isFunction( resolveValues[ i ].promise ) ) { | |
| 3401 | resolveValues[ i ].promise() | |
| 3402 | .done( updateFunc( i, resolveContexts, resolveValues ) ) | |
| 3403 | .fail( deferred.reject ) | |
| 3404 | .progress( updateFunc( i, progressContexts, progressValues ) ); | |
| 3405 | } else { | |
| 3406 | --remaining; | |
| 3407 | } | |
| 3408 | } | |
| 3409 | } | |
| 3410 | ||
| 3411 | // if we're not waiting on anything, resolve the master | |
| 3412 | if ( !remaining ) { | |
| 3413 | deferred.resolveWith( resolveContexts, resolveValues ); | |
| 3414 | } | |
| 3415 | ||
| 3416 | return deferred.promise(); | |
| 3417 | } | |
| 3418 | }); | |
| 3419 | ||
| 3420 | ||
| 3421 | // The deferred used on DOM ready | |
| 3422 | var readyList; | |
| 3423 | ||
| 3424 | jQuery.fn.ready = function( fn ) { | |
| 3425 | // Add the callback | |
| 3426 | jQuery.ready.promise().done( fn ); | |
| 3427 | ||
| 3428 | return this; | |
| 3429 | }; | |
| 3430 | ||
| 3431 | jQuery.extend({ | |
| 3432 | // Is the DOM ready to be used? Set to true once it occurs. | |
| 3433 | isReady: false, | |
| 3434 | ||
| 3435 | // A counter to track how many items to wait for before | |
| 3436 | // the ready event fires. See #6781 | |
| 3437 | readyWait: 1, | |
| 3438 | ||
| 3439 | // Hold (or release) the ready event | |
| 3440 | holdReady: function( hold ) { | |
| 3441 | if ( hold ) { | |
| 3442 | jQuery.readyWait++; | |
| 3443 | } else { | |
| 3444 | jQuery.ready( true ); | |
| 3445 | } | |
| 3446 | }, | |
| 3447 | ||
| 3448 | // Handle when the DOM is ready | |
| 3449 | ready: function( wait ) { | |
| 3450 | ||
| 3451 | // Abort if there are pending holds or we're already ready | |
| 3452 | if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { | |
| 3453 | return; | |
| 3454 | } | |
| 3455 | ||
| 3456 | // Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443). | |
| 3457 | if ( !document.body ) { | |
| 3458 | return setTimeout( jQuery.ready ); | |
| 3459 | } | |
| 3460 | ||
| 3461 | // Remember that the DOM is ready | |
| 3462 | jQuery.isReady = true; | |
| 3463 | ||
| 3464 | // If a normal DOM Ready event fired, decrement, and wait if need be | |
| 3465 | if ( wait !== true && --jQuery.readyWait > 0 ) { | |
| 3466 | return; | |
| 3467 | } | |
| 3468 | ||
| 3469 | // If there are functions bound, to execute | |
| 3470 | readyList.resolveWith( document, [ jQuery ] ); | |
| 3471 | ||
| 3472 | // Trigger any bound ready events | |
| 3473 | if ( jQuery.fn.triggerHandler ) { | |
| 3474 | jQuery( document ).triggerHandler( "ready" ); | |
| 3475 | jQuery( document ).off( "ready" ); | |
| 3476 | } | |
| 3477 | } | |
| 3478 | }); | |
| 3479 | ||
| 3480 | /** | |
| 3481 | * Clean-up method for dom ready events | |
| 3482 | */ | |
| 3483 | function detach() { | |
| 3484 | if ( document.addEventListener ) { | |
| 3485 | document.removeEventListener( "DOMContentLoaded", completed, false ); | |
| 3486 | window.removeEventListener( "load", completed, false ); | |
| 3487 | ||
| 3488 | } else { | |
| 3489 | document.detachEvent( "onreadystatechange", completed ); | |
| 3490 | window.detachEvent( "onload", completed ); | |
| 3491 | } | |
| 3492 | } | |
| 3493 | ||
| 3494 | /** | |
| 3495 | * The ready event handler and self cleanup method | |
| 3496 | */ | |
| 3497 | function completed() { | |
| 3498 | // readyState === "complete" is good enough for us to call the dom ready in oldIE | |
| 3499 | if ( document.addEventListener || event.type === "load" || document.readyState === "complete" ) { | |
| 3500 | detach(); | |
| 3501 | jQuery.ready(); | |
| 3502 | } | |
| 3503 | } | |
| 3504 | ||
| 3505 | jQuery.ready.promise = function( obj ) { | |
| 3506 | if ( !readyList ) { | |
| 3507 | ||
| 3508 | readyList = jQuery.Deferred(); | |
| 3509 | ||
| 3510 | // Catch cases where $(document).ready() is called after the browser event has already occurred. | |
| 3511 | // we once tried to use readyState "interactive" here, but it caused issues like the one | |
| 3512 | // discovered by ChrisS here: http://bugs.jquery.com/ticket/12282#comment:15 | |
| 3513 | if ( document.readyState === "complete" ) { | |
| 3514 | // Handle it asynchronously to allow scripts the opportunity to delay ready | |
| 3515 | setTimeout( jQuery.ready ); | |
| 3516 | ||
| 3517 | // Standards-based browsers support DOMContentLoaded | |
| 3518 | } else if ( document.addEventListener ) { | |
| 3519 | // Use the handy event callback | |
| 3520 | document.addEventListener( "DOMContentLoaded", completed, false ); | |
| 3521 | ||
| 3522 | // A fallback to window.onload, that will always work | |
| 3523 | window.addEventListener( "load", completed, false ); | |
| 3524 | ||
| 3525 | // If IE event model is used | |
| 3526 | } else { | |
| 3527 | // Ensure firing before onload, maybe late but safe also for iframes | |
| 3528 | document.attachEvent( "onreadystatechange", completed ); | |
| 3529 | ||
| 3530 | // A fallback to window.onload, that will always work | |
| 3531 | window.attachEvent( "onload", completed ); | |
| 3532 | ||
| 3533 | // If IE and not a frame | |
| 3534 | // continually check to see if the document is ready | |
| 3535 | var top = false; | |
| 3536 | ||
| 3537 | try { | |
| 3538 | top = window.frameElement == null && document.documentElement; | |
| 3539 | } catch(e) {} | |
| 3540 | ||
| 3541 | if ( top && top.doScroll ) { | |
| 3542 | (function doScrollCheck() { | |
| 3543 | if ( !jQuery.isReady ) { | |
| 3544 | ||
| 3545 | try { | |
| 3546 | // Use the trick by Diego Perini | |
| 3547 | // http://javascript.nwbox.com/IEContentLoaded/ | |
| 3548 | top.doScroll("left"); | |
| 3549 | } catch(e) { | |
| 3550 | return setTimeout( doScrollCheck, 50 ); | |
| 3551 | } | |
| 3552 | ||
| 3553 | // detach all dom ready events | |
| 3554 | detach(); | |
| 3555 | ||
| 3556 | // and execute any waiting functions | |
| 3557 | jQuery.ready(); | |
| 3558 | } | |
| 3559 | })(); | |
| 3560 | } | |
| 3561 | } | |
| 3562 | } | |
| 3563 | return readyList.promise( obj ); | |
| 3564 | }; | |
| 3565 | ||
| 3566 | ||
| 3567 | var strundefined = typeof undefined; | |
| 3568 | ||
| 3569 | ||
| 3570 | ||
| 3571 | // Support: IE<9 | |
| 3572 | // Iteration over object's inherited properties before its own | |
| 3573 | var i; | |
| 3574 | for ( i in jQuery( support ) ) { | |
| 3575 | break; | |
| 3576 | } | |
| 3577 | support.ownLast = i !== "0"; | |
| 3578 | ||
| 3579 | // Note: most support tests are defined in their respective modules. | |
| 3580 | // false until the test is run | |
| 3581 | support.inlineBlockNeedsLayout = false; | |
| 3582 | ||
| 3583 | // Execute ASAP in case we need to set body.style.zoom | |
| 3584 | jQuery(function() { | |
| 3585 | // Minified: var a,b,c,d | |
| 3586 | var val, div, body, container; | |
| 3587 | ||
| 3588 | body = document.getElementsByTagName( "body" )[ 0 ]; | |
| 3589 | if ( !body || !body.style ) { | |
| 3590 | // Return for frameset docs that don't have a body | |
| 3591 | return; | |
| 3592 | } | |
| 3593 | ||
| 3594 | // Setup | |
| 3595 | div = document.createElement( "div" ); | |
| 3596 | container = document.createElement( "div" ); | |
| 3597 | container.style.cssText = "position:absolute;border:0;width:0;height:0;top:0;left:-9999px"; | |
| 3598 | body.appendChild( container ).appendChild( div ); | |
| 3599 | ||
| 3600 | if ( typeof div.style.zoom !== strundefined ) { | |
| 3601 | // Support: IE<8 | |
| 3602 | // Check if natively block-level elements act like inline-block | |
| 3603 | // elements when setting their display to 'inline' and giving | |
| 3604 | // them layout | |
| 3605 | div.style.cssText = "display:inline;margin:0;border:0;padding:1px;width:1px;zoom:1"; | |
| 3606 | ||
| 3607 | support.inlineBlockNeedsLayout = val = div.offsetWidth === 3; | |
| 3608 | if ( val ) { | |
| 3609 | // Prevent IE 6 from affecting layout for positioned elements #11048 | |
| 3610 | // Prevent IE from shrinking the body in IE 7 mode #12869 | |
| 3611 | // Support: IE<8 | |
| 3612 | body.style.zoom = 1; | |
| 3613 | } | |
| 3614 | } | |
| 3615 | ||
| 3616 | body.removeChild( container ); | |
| 3617 | }); | |
| 3618 | ||
| 3619 | ||
| 3620 | ||
| 3621 | ||
| 3622 | (function() { | |
| 3623 | var div = document.createElement( "div" ); | |
| 3624 | ||
| 3625 | // Execute the test only if not already executed in another module. | |
| 3626 | if (support.deleteExpando == null) { | |
| 3627 | // Support: IE<9 | |
| 3628 | support.deleteExpando = true; | |
| 3629 | try { | |
| 3630 | delete div.test; | |
| 3631 | } catch( e ) { | |
| 3632 | support.deleteExpando = false; | |
| 3633 | } | |
| 3634 | } | |
| 3635 | ||
| 3636 | // Null elements to avoid leaks in IE. | |
| 3637 | div = null; | |
| 3638 | })(); | |
| 3639 | ||
| 3640 | ||
| 3641 | /** | |
| 3642 | * Determines whether an object can have data | |
| 3643 | */ | |
| 3644 | jQuery.acceptData = function( elem ) { | |
| 3645 | var noData = jQuery.noData[ (elem.nodeName + " ").toLowerCase() ], | |
| 3646 | nodeType = +elem.nodeType || 1; | |
| 3647 | ||
| 3648 | // Do not set data on non-element DOM nodes because it will not be cleared (#8335). | |
| 3649 | return nodeType !== 1 && nodeType !== 9 ? | |
| 3650 | false : | |
| 3651 | ||
| 3652 | // Nodes accept data unless otherwise specified; rejection can be conditional | |
| 3653 | !noData || noData !== true && elem.getAttribute("classid") === noData; | |
| 3654 | }; | |
| 3655 | ||
| 3656 | ||
| 3657 | var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, | |
| 3658 | rmultiDash = /([A-Z])/g; | |
| 3659 | ||
| 3660 | function dataAttr( elem, key, data ) { | |
| 3661 | // If nothing was found internally, try to fetch any | |
| 3662 | // data from the HTML5 data-* attribute | |
| 3663 | if ( data === undefined && elem.nodeType === 1 ) { | |
| 3664 | ||
| 3665 | var name = "data-" + key.replace( rmultiDash, "-$1" ).toLowerCase(); | |
| 3666 | ||
| 3667 | data = elem.getAttribute( name ); | |
| 3668 | ||
| 3669 | if ( typeof data === "string" ) { | |
| 3670 | try { | |
| 3671 | data = data === "true" ? true : | |
| 3672 | data === "false" ? false : | |
| 3673 | data === "null" ? null : | |
| 3674 | // Only convert to a number if it doesn't change the string | |
| 3675 | +data + "" === data ? +data : | |
| 3676 | rbrace.test( data ) ? jQuery.parseJSON( data ) : | |
| 3677 | data; | |
| 3678 | } catch( e ) {} | |
| 3679 | ||
| 3680 | // Make sure we set the data so it isn't changed later | |
| 3681 | jQuery.data( elem, key, data ); | |
| 3682 | ||
| 3683 | } else { | |
| 3684 | data = undefined; | |
| 3685 | } | |
| 3686 | } | |
| 3687 | ||
| 3688 | return data; | |
| 3689 | } | |
| 3690 | ||
| 3691 | // checks a cache object for emptiness | |
| 3692 | function isEmptyDataObject( obj ) { | |
| 3693 | var name; | |
| 3694 | for ( name in obj ) { | |
| 3695 | ||
| 3696 | // if the public data object is empty, the private is still empty | |
| 3697 | if ( name === "data" && jQuery.isEmptyObject( obj[name] ) ) { | |
| 3698 | continue; | |
| 3699 | } | |
| 3700 | if ( name !== "toJSON" ) { | |
| 3701 | return false; | |
| 3702 | } | |
| 3703 | } | |
| 3704 | ||
| 3705 | return true; | |
| 3706 | } | |
| 3707 | ||
| 3708 | function internalData( elem, name, data, pvt /* Internal Use Only */ ) { | |
| 3709 | if ( !jQuery.acceptData( elem ) ) { | |
| 3710 | return; | |
| 3711 | } | |
| 3712 | ||
| 3713 | var ret, thisCache, | |
| 3714 | internalKey = jQuery.expando, | |
| 3715 | ||
| 3716 | // We have to handle DOM nodes and JS objects differently because IE6-7 | |
| 3717 | // can't GC object references properly across the DOM-JS boundary | |
| 3718 | isNode = elem.nodeType, | |
| 3719 | ||
| 3720 | // Only DOM nodes need the global jQuery cache; JS object data is | |
| 3721 | // attached directly to the object so GC can occur automatically | |
| 3722 | cache = isNode ? jQuery.cache : elem, | |
| 3723 | ||
| 3724 | // Only defining an ID for JS objects if its cache already exists allows | |
| 3725 | // the code to shortcut on the same path as a DOM node with no cache | |
| 3726 | id = isNode ? elem[ internalKey ] : elem[ internalKey ] && internalKey; | |
| 3727 | ||
| 3728 | // Avoid doing any more work than we need to when trying to get data on an | |
| 3729 | // object that has no data at all | |
| 3730 | if ( (!id || !cache[id] || (!pvt && !cache[id].data)) && data === undefined && typeof name === "string" ) { | |
| 3731 | return; | |
| 3732 | } | |
| 3733 | ||
| 3734 | if ( !id ) { | |
| 3735 | // Only DOM nodes need a new unique ID for each element since their data | |
| 3736 | // ends up in the global cache | |
| 3737 | if ( isNode ) { | |
| 3738 | id = elem[ internalKey ] = deletedIds.pop() || jQuery.guid++; | |
| 3739 | } else { | |
| 3740 | id = internalKey; | |
| 3741 | } | |
| 3742 | } | |
| 3743 | ||
| 3744 | if ( !cache[ id ] ) { | |
| 3745 | // Avoid exposing jQuery metadata on plain JS objects when the object | |
| 3746 | // is serialized using JSON.stringify | |
| 3747 | cache[ id ] = isNode ? {} : { toJSON: jQuery.noop }; | |
| 3748 | } | |
| 3749 | ||
| 3750 | // An object can be passed to jQuery.data instead of a key/value pair; this gets | |
| 3751 | // shallow copied over onto the existing cache | |
| 3752 | if ( typeof name === "object" || typeof name === "function" ) { | |
| 3753 | if ( pvt ) { | |
| 3754 | cache[ id ] = jQuery.extend( cache[ id ], name ); | |
| 3755 | } else { | |
| 3756 | cache[ id ].data = jQuery.extend( cache[ id ].data, name ); | |
| 3757 | } | |
| 3758 | } | |
| 3759 | ||
| 3760 | thisCache = cache[ id ]; | |
| 3761 | ||
| 3762 | // jQuery data() is stored in a separate object inside the object's internal data | |
| 3763 | // cache in order to avoid key collisions between internal data and user-defined | |
| 3764 | // data. | |
| 3765 | if ( !pvt ) { | |
| 3766 | if ( !thisCache.data ) { | |
| 3767 | thisCache.data = {}; | |
| 3768 | } | |
| 3769 | ||
| 3770 | thisCache = thisCache.data; | |
| 3771 | } | |
| 3772 | ||
| 3773 | if ( data !== undefined ) { | |
| 3774 | thisCache[ jQuery.camelCase( name ) ] = data; | |
| 3775 | } | |
| 3776 | ||
| 3777 | // Check for both converted-to-camel and non-converted data property names | |
| 3778 | // If a data property was specified | |
| 3779 | if ( typeof name === "string" ) { | |
| 3780 | ||
| 3781 | // First Try to find as-is property data | |
| 3782 | ret = thisCache[ name ]; | |
| 3783 | ||
| 3784 | // Test for null|undefined property data | |
| 3785 | if ( ret == null ) { | |
| 3786 | ||
| 3787 | // Try to find the camelCased property | |
| 3788 | ret = thisCache[ jQuery.camelCase( name ) ]; | |
| 3789 | } | |
| 3790 | } else { | |
| 3791 | ret = thisCache; | |
| 3792 | } | |
| 3793 | ||
| 3794 | return ret; | |
| 3795 | } | |
| 3796 | ||
| 3797 | function internalRemoveData( elem, name, pvt ) { | |
| 3798 | if ( !jQuery.acceptData( elem ) ) { | |
| 3799 | return; | |
| 3800 | } | |
| 3801 | ||
| 3802 | var thisCache, i, | |
| 3803 | isNode = elem.nodeType, | |
| 3804 | ||
| 3805 | // See jQuery.data for more information | |
| 3806 | cache = isNode ? jQuery.cache : elem, | |
| 3807 | id = isNode ? elem[ jQuery.expando ] : jQuery.expando; | |
| 3808 | ||
| 3809 | // If there is already no cache entry for this object, there is no | |
| 3810 | // purpose in continuing | |
| 3811 | if ( !cache[ id ] ) { | |
| 3812 | return; | |
| 3813 | } | |
| 3814 | ||
| 3815 | if ( name ) { | |
| 3816 | ||
| 3817 | thisCache = pvt ? cache[ id ] : cache[ id ].data; | |
| 3818 | ||
| 3819 | if ( thisCache ) { | |
| 3820 | ||
| 3821 | // Support array or space separated string names for data keys | |
| 3822 | if ( !jQuery.isArray( name ) ) { | |
| 3823 | ||
| 3824 | // try the string as a key before any manipulation | |
| 3825 | if ( name in thisCache ) { | |
| 3826 | name = [ name ]; | |
| 3827 | } else { | |
| 3828 | ||
| 3829 | // split the camel cased version by spaces unless a key with the spaces exists | |
| 3830 | name = jQuery.camelCase( name ); | |
| 3831 | if ( name in thisCache ) { | |
| 3832 | name = [ name ]; | |
| 3833 | } else { | |
| 3834 | name = name.split(" "); | |
| 3835 | } | |
| 3836 | } | |
| 3837 | } else { | |
| 3838 | // If "name" is an array of keys... | |
| 3839 | // When data is initially created, via ("key", "val") signature, | |
| 3840 | // keys will be converted to camelCase. | |
| 3841 | // Since there is no way to tell _how_ a key was added, remove | |
| 3842 | // both plain key and camelCase key. #12786 | |
| 3843 | // This will only penalize the array argument path. | |
| 3844 | name = name.concat( jQuery.map( name, jQuery.camelCase ) ); | |
| 3845 | } | |
| 3846 | ||
| 3847 | i = name.length; | |
| 3848 | while ( i-- ) { | |
| 3849 | delete thisCache[ name[i] ]; | |
| 3850 | } | |
| 3851 | ||
| 3852 | // If there is no data left in the cache, we want to continue | |
| 3853 | // and let the cache object itself get destroyed | |
| 3854 | if ( pvt ? !isEmptyDataObject(thisCache) : !jQuery.isEmptyObject(thisCache) ) { | |
| 3855 | return; | |
| 3856 | } | |
| 3857 | } | |
| 3858 | } | |
| 3859 | ||
| 3860 | // See jQuery.data for more information | |
| 3861 | if ( !pvt ) { | |
| 3862 | delete cache[ id ].data; | |
| 3863 | ||
| 3864 | // Don't destroy the parent cache unless the internal data object | |
| 3865 | // had been the only thing left in it | |
| 3866 | if ( !isEmptyDataObject( cache[ id ] ) ) { | |
| 3867 | return; | |
| 3868 | } | |
| 3869 | } | |
| 3870 | ||
| 3871 | // Destroy the cache | |
| 3872 | if ( isNode ) { | |
| 3873 | jQuery.cleanData( [ elem ], true ); | |
| 3874 | ||
| 3875 | // Use delete when supported for expandos or `cache` is not a window per isWindow (#10080) | |
| 3876 | /* jshint eqeqeq: false */ | |
| 3877 | } else if ( support.deleteExpando || cache != cache.window ) { | |
| 3878 | /* jshint eqeqeq: true */ | |
| 3879 | delete cache[ id ]; | |
| 3880 | ||
| 3881 | // When all else fails, null | |
| 3882 | } else { | |
| 3883 | cache[ id ] = null; | |
| 3884 | } | |
| 3885 | } | |
| 3886 | ||
| 3887 | jQuery.extend({ | |
| 3888 | cache: {}, | |
| 3889 | ||
| 3890 | // The following elements (space-suffixed to avoid Object.prototype collisions) | |
| 3891 | // throw uncatchable exceptions if you attempt to set expando properties | |
| 3892 | noData: { | |
| 3893 | "applet ": true, | |
| 3894 | "embed ": true, | |
| 3895 | // ...but Flash objects (which have this classid) *can* handle expandos | |
| 3896 | "object ": "clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" | |
| 3897 | }, | |
| 3898 | ||
| 3899 | hasData: function( elem ) { | |
| 3900 | elem = elem.nodeType ? jQuery.cache[ elem[jQuery.expando] ] : elem[ jQuery.expando ]; | |
| 3901 | return !!elem && !isEmptyDataObject( elem ); | |
| 3902 | }, | |
| 3903 | ||
| 3904 | data: function( elem, name, data ) { | |
| 3905 | return internalData( elem, name, data ); | |
| 3906 | }, | |
| 3907 | ||
| 3908 | removeData: function( elem, name ) { | |
| 3909 | return internalRemoveData( elem, name ); | |
| 3910 | }, | |
| 3911 | ||
| 3912 | // For internal use only. | |
| 3913 | _data: function( elem, name, data ) { | |
| 3914 | return internalData( elem, name, data, true ); | |
| 3915 | }, | |
| 3916 | ||
| 3917 | _removeData: function( elem, name ) { | |
| 3918 | return internalRemoveData( elem, name, true ); | |
| 3919 | } | |
| 3920 | }); | |
| 3921 | ||
| 3922 | jQuery.fn.extend({ | |
| 3923 | data: function( key, value ) { | |
| 3924 | var i, name, data, | |
| 3925 | elem = this[0], | |
| 3926 | attrs = elem && elem.attributes; | |
| 3927 | ||
| 3928 | // Special expections of .data basically thwart jQuery.access, | |
| 3929 | // so implement the relevant behavior ourselves | |
| 3930 | ||
| 3931 | // Gets all values | |
| 3932 | if ( key === undefined ) { | |
| 3933 | if ( this.length ) { | |
| 3934 | data = jQuery.data( elem ); | |
| 3935 | ||
| 3936 | if ( elem.nodeType === 1 && !jQuery._data( elem, "parsedAttrs" ) ) { | |
| 3937 | i = attrs.length; | |
| 3938 | while ( i-- ) { | |
| 3939 | ||
| 3940 | // Support: IE11+ | |
| 3941 | // The attrs elements can be null (#14894) | |
| 3942 | if ( attrs[ i ] ) { | |
| 3943 | name = attrs[ i ].name; | |
| 3944 | if ( name.indexOf( "data-" ) === 0 ) { | |
| 3945 | name = jQuery.camelCase( name.slice(5) ); | |
| 3946 | dataAttr( elem, name, data[ name ] ); | |
| 3947 | } | |
| 3948 | } | |
| 3949 | } | |
| 3950 | jQuery._data( elem, "parsedAttrs", true ); | |
| 3951 | } | |
| 3952 | } | |
| 3953 | ||
| 3954 | return data; | |
| 3955 | } | |
| 3956 | ||
| 3957 | // Sets multiple values | |
| 3958 | if ( typeof key === "object" ) { | |
| 3959 | return this.each(function() { | |
| 3960 | jQuery.data( this, key ); | |
| 3961 | }); | |
| 3962 | } | |
| 3963 | ||
| 3964 | return arguments.length > 1 ? | |
| 3965 | ||
| 3966 | // Sets one value | |
| 3967 | this.each(function() { | |
| 3968 | jQuery.data( this, key, value ); | |
| 3969 | }) : | |
| 3970 | ||
| 3971 | // Gets one value | |
| 3972 | // Try to fetch any internally stored data first | |
| 3973 | elem ? dataAttr( elem, key, jQuery.data( elem, key ) ) : undefined; | |
| 3974 | }, | |
| 3975 | ||
| 3976 | removeData: function( key ) { | |
| 3977 | return this.each(function() { | |
| 3978 | jQuery.removeData( this, key ); | |
| 3979 | }); | |
| 3980 | } | |
| 3981 | }); | |
| 3982 | ||
| 3983 | ||
| 3984 | jQuery.extend({ | |
| 3985 | queue: function( elem, type, data ) { | |
| 3986 | var queue; | |
| 3987 | ||
| 3988 | if ( elem ) { | |
| 3989 | type = ( type || "fx" ) + "queue"; | |
| 3990 | queue = jQuery._data( elem, type ); | |
| 3991 | ||
| 3992 | // Speed up dequeue by getting out quickly if this is just a lookup | |
| 3993 | if ( data ) { | |
| 3994 | if ( !queue || jQuery.isArray(data) ) { | |
| 3995 | queue = jQuery._data( elem, type, jQuery.makeArray(data) ); | |
| 3996 | } else { | |
| 3997 | queue.push( data ); | |
| 3998 | } | |
| 3999 | } | |
| 4000 | return queue || []; | |
| 4001 | } | |
| 4002 | }, | |
| 4003 | ||
| 4004 | dequeue: function( elem, type ) { | |
| 4005 | type = type || "fx"; | |
| 4006 | ||
| 4007 | var queue = jQuery.queue( elem, type ), | |
| 4008 | startLength = queue.length, | |
| 4009 | fn = queue.shift(), | |
| 4010 | hooks = jQuery._queueHooks( elem, type ), | |
| 4011 | next = function() { | |
| 4012 | jQuery.dequeue( elem, type ); | |
| 4013 | }; | |
| 4014 | ||
| 4015 | // If the fx queue is dequeued, always remove the progress sentinel | |
| 4016 | if ( fn === "inprogress" ) { | |
| 4017 | fn = queue.shift(); | |
| 4018 | startLength--; | |
| 4019 | } | |
| 4020 | ||
| 4021 | if ( fn ) { | |
| 4022 | ||
| 4023 | // Add a progress sentinel to prevent the fx queue from being | |
| 4024 | // automatically dequeued | |
| 4025 | if ( type === "fx" ) { | |
| 4026 | queue.unshift( "inprogress" ); | |
| 4027 | } | |
| 4028 | ||
| 4029 | // clear up the last queue stop function | |
| 4030 | delete hooks.stop; | |
| 4031 | fn.call( elem, next, hooks ); | |
| 4032 | } | |
| 4033 | ||
| 4034 | if ( !startLength && hooks ) { | |
| 4035 | hooks.empty.fire(); | |
| 4036 | } | |
| 4037 | }, | |
| 4038 | ||
| 4039 | // not intended for public consumption - generates a queueHooks object, or returns the current one | |
| 4040 | _queueHooks: function( elem, type ) { | |
| 4041 | var key = type + "queueHooks"; | |
| 4042 | return jQuery._data( elem, key ) || jQuery._data( elem, key, { | |
| 4043 | empty: jQuery.Callbacks("once memory").add(function() { | |
| 4044 | jQuery._removeData( elem, type + "queue" ); | |
| 4045 | jQuery._removeData( elem, key ); | |
| 4046 | }) | |
| 4047 | }); | |
| 4048 | } | |
| 4049 | }); | |
| 4050 | ||
| 4051 | jQuery.fn.extend({ | |
| 4052 | queue: function( type, data ) { | |
| 4053 | var setter = 2; | |
| 4054 | ||
| 4055 | if ( typeof type !== "string" ) { | |
| 4056 | data = type; | |
| 4057 | type = "fx"; | |
| 4058 | setter--; | |
| 4059 | } | |
| 4060 | ||
| 4061 | if ( arguments.length < setter ) { | |
| 4062 | return jQuery.queue( this[0], type ); | |
| 4063 | } | |
| 4064 | ||
| 4065 | return data === undefined ? | |
| 4066 | this : | |
| 4067 | this.each(function() { | |
| 4068 | var queue = jQuery.queue( this, type, data ); | |
| 4069 | ||
| 4070 | // ensure a hooks for this queue | |
| 4071 | jQuery._queueHooks( this, type ); | |
| 4072 | ||
| 4073 | if ( type === "fx" && queue[0] !== "inprogress" ) { | |
| 4074 | jQuery.dequeue( this, type ); | |
| 4075 | } | |
| 4076 | }); | |
| 4077 | }, | |
| 4078 | dequeue: function( type ) { | |
| 4079 | return this.each(function() { | |
| 4080 | jQuery.dequeue( this, type ); | |
| 4081 | }); | |
| 4082 | }, | |
| 4083 | clearQueue: function( type ) { | |
| 4084 | return this.queue( type || "fx", [] ); | |
| 4085 | }, | |
| 4086 | // Get a promise resolved when queues of a certain type | |
| 4087 | // are emptied (fx is the type by default) | |
| 4088 | promise: function( type, obj ) { | |
| 4089 | var tmp, | |
| 4090 | count = 1, | |
| 4091 | defer = jQuery.Deferred(), | |
| 4092 | elements = this, | |
| 4093 | i = this.length, | |
| 4094 | resolve = function() { | |
| 4095 | if ( !( --count ) ) { | |
| 4096 | defer.resolveWith( elements, [ elements ] ); | |
| 4097 | } | |
| 4098 | }; | |
| 4099 | ||
| 4100 | if ( typeof type !== "string" ) { | |
| 4101 | obj = type; | |
| 4102 | type = undefined; | |
| 4103 | } | |
| 4104 | type = type || "fx"; | |
| 4105 | ||
| 4106 | while ( i-- ) { | |
| 4107 | tmp = jQuery._data( elements[ i ], type + "queueHooks" ); | |
| 4108 | if ( tmp && tmp.empty ) { | |
| 4109 | count++; | |
| 4110 | tmp.empty.add( resolve ); | |
| 4111 | } | |
| 4112 | } | |
| 4113 | resolve(); | |
| 4114 | return defer.promise( obj ); | |
| 4115 | } | |
| 4116 | }); | |
| 4117 | var pnum = (/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/).source; | |
| 4118 | ||
| 4119 | var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; | |
| 4120 | ||
| 4121 | var isHidden = function( elem, el ) { | |
| 4122 | // isHidden might be called from jQuery#filter function; | |
| 4123 | // in that case, element will be second argument | |
| 4124 | elem = el || elem; | |
| 4125 | return jQuery.css( elem, "display" ) === "none" || !jQuery.contains( elem.ownerDocument, elem ); | |
| 4126 | }; | |
| 4127 | ||
| 4128 | ||
| 4129 | ||
| 4130 | // Multifunctional method to get and set values of a collection | |
| 4131 | // The value/s can optionally be executed if it's a function | |
| 4132 | var access = jQuery.access = function( elems, fn, key, value, chainable, emptyGet, raw ) { | |
| 4133 | var i = 0, | |
| 4134 | length = elems.length, | |
| 4135 | bulk = key == null; | |
| 4136 | ||
| 4137 | // Sets many values | |
| 4138 | if ( jQuery.type( key ) === "object" ) { | |
| 4139 | chainable = true; | |
| 4140 | for ( i in key ) { | |
| 4141 | jQuery.access( elems, fn, i, key[i], true, emptyGet, raw ); | |
| 4142 | } | |
| 4143 | ||
| 4144 | // Sets one value | |
| 4145 | } else if ( value !== undefined ) { | |
| 4146 | chainable = true; | |
| 4147 | ||
| 4148 | if ( !jQuery.isFunction( value ) ) { | |
| 4149 | raw = true; | |
| 4150 | } | |
| 4151 | ||
| 4152 | if ( bulk ) { | |
| 4153 | // Bulk operations run against the entire set | |
| 4154 | if ( raw ) { | |
| 4155 | fn.call( elems, value ); | |
| 4156 | fn = null; | |
| 4157 | ||
| 4158 | // ...except when executing function values | |
| 4159 | } else { | |
| 4160 | bulk = fn; | |
| 4161 | fn = function( elem, key, value ) { | |
| 4162 | return bulk.call( jQuery( elem ), value ); | |
| 4163 | }; | |
| 4164 | } | |
| 4165 | } | |
| 4166 | ||
| 4167 | if ( fn ) { | |
| 4168 | for ( ; i < length; i++ ) { | |
| 4169 | fn( elems[i], key, raw ? value : value.call( elems[i], i, fn( elems[i], key ) ) ); | |
| 4170 | } | |
| 4171 | } | |
| 4172 | } | |
| 4173 | ||
| 4174 | return chainable ? | |
| 4175 | elems : | |
| 4176 | ||
| 4177 | // Gets | |
| 4178 | bulk ? | |
| 4179 | fn.call( elems ) : | |
| 4180 | length ? fn( elems[0], key ) : emptyGet; | |
| 4181 | }; | |
| 4182 | var rcheckableType = (/^(?:checkbox|radio)$/i); | |
| 4183 | ||
| 4184 | ||
| 4185 | ||
| 4186 | (function() { | |
| 4187 | // Minified: var a,b,c | |
| 4188 | var input = document.createElement( "input" ), | |
| 4189 | div = document.createElement( "div" ), | |
| 4190 | fragment = document.createDocumentFragment(); | |
| 4191 | ||
| 4192 | // Setup | |
| 4193 | div.innerHTML = " <link/><table></table><a href='/a'>a</a><input type='checkbox'/>"; | |
| 4194 | ||
| 4195 | // IE strips leading whitespace when .innerHTML is used | |
| 4196 | support.leadingWhitespace = div.firstChild.nodeType === 3; | |
| 4197 | ||
| 4198 | // Make sure that tbody elements aren't automatically inserted | |
| 4199 | // IE will insert them into empty tables | |
| 4200 | support.tbody = !div.getElementsByTagName( "tbody" ).length; | |
| 4201 | ||
| 4202 | // Make sure that link elements get serialized correctly by innerHTML | |
| 4203 | // This requires a wrapper element in IE | |
| 4204 | support.htmlSerialize = !!div.getElementsByTagName( "link" ).length; | |
| 4205 | ||
| 4206 | // Makes sure cloning an html5 element does not cause problems | |
| 4207 | // Where outerHTML is undefined, this still works | |
| 4208 | support.html5Clone = | |
| 4209 | document.createElement( "nav" ).cloneNode( true ).outerHTML !== "<:nav></:nav>"; | |
| 4210 | ||
| 4211 | // Check if a disconnected checkbox will retain its checked | |
| 4212 | // value of true after appended to the DOM (IE6/7) | |
| 4213 | input.type = "checkbox"; | |
| 4214 | input.checked = true; | |
| 4215 | fragment.appendChild( input ); | |
| 4216 | support.appendChecked = input.checked; | |
| 4217 | ||
| 4218 | // Make sure textarea (and checkbox) defaultValue is properly cloned | |
| 4219 | // Support: IE6-IE11+ | |
| 4220 | div.innerHTML = "<textarea>x</textarea>"; | |
| 4221 | support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; | |
| 4222 | ||
| 4223 | // #11217 - WebKit loses check when the name is after the checked attribute | |
| 4224 | fragment.appendChild( div ); | |
| 4225 | div.innerHTML = "<input type='radio' checked='checked' name='t'/>"; | |
| 4226 | ||
| 4227 | // Support: Safari 5.1, iOS 5.1, Android 4.x, Android 2.3 | |
| 4228 | // old WebKit doesn't clone checked state correctly in fragments | |
| 4229 | support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; | |
| 4230 | ||
| 4231 | // Support: IE<9 | |
| 4232 | // Opera does not clone events (and typeof div.attachEvent === undefined). | |
| 4233 | // IE9-10 clones events bound via attachEvent, but they don't trigger with .click() | |
| 4234 | support.noCloneEvent = true; | |
| 4235 | if ( div.attachEvent ) { | |
| 4236 | div.attachEvent( "onclick", function() { | |
| 4237 | support.noCloneEvent = false; | |
| 4238 | }); | |
| 4239 | ||
| 4240 | div.cloneNode( true ).click(); | |
| 4241 | } | |
| 4242 | ||
| 4243 | // Execute the test only if not already executed in another module. | |
| 4244 | if (support.deleteExpando == null) { | |
| 4245 | // Support: IE<9 | |
| 4246 | support.deleteExpando = true; | |
| 4247 | try { | |
| 4248 | delete div.test; | |
| 4249 | } catch( e ) { | |
| 4250 | support.deleteExpando = false; | |
| 4251 | } | |
| 4252 | } | |
| 4253 | })(); | |
| 4254 | ||
| 4255 | ||
| 4256 | (function() { | |
| 4257 | var i, eventName, | |
| 4258 | div = document.createElement( "div" ); | |
| 4259 | ||
| 4260 | // Support: IE<9 (lack submit/change bubble), Firefox 23+ (lack focusin event) | |
| 4261 | for ( i in { submit: true, change: true, focusin: true }) { | |
| 4262 | eventName = "on" + i; | |
| 4263 | ||
| 4264 | if ( !(support[ i + "Bubbles" ] = eventName in window) ) { | |
| 4265 | // Beware of CSP restrictions (https://developer.mozilla.org/en/Security/CSP) | |
| 4266 | div.setAttribute( eventName, "t" ); | |
| 4267 | support[ i + "Bubbles" ] = div.attributes[ eventName ].expando === false; | |
| 4268 | } | |
| 4269 | } | |
| 4270 | ||
| 4271 | // Null elements to avoid leaks in IE. | |
| 4272 | div = null; | |
| 4273 | })(); | |
| 4274 | ||
| 4275 | ||
| 4276 | var rformElems = /^(?:input|select|textarea)$/i, | |
| 4277 | rkeyEvent = /^key/, | |
| 4278 | rmouseEvent = /^(?:mouse|pointer|contextmenu)|click/, | |
| 4279 | rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, | |
| 4280 | rtypenamespace = /^([^.]*)(?:\.(.+)|)$/; | |
| 4281 | ||
| 4282 | function returnTrue() { | |
| 4283 | return true; | |
| 4284 | } | |
| 4285 | ||
| 4286 | function returnFalse() { | |
| 4287 | return false; | |
| 4288 | } | |
| 4289 | ||
| 4290 | function safeActiveElement() { | |
| 4291 | try { | |
| 4292 | return document.activeElement; | |
| 4293 | } catch ( err ) { } | |
| 4294 | } | |
| 4295 | ||
| 4296 | /* | |
| 4297 | * Helper functions for managing events -- not part of the public interface. | |
| 4298 | * Props to Dean Edwards' addEvent library for many of the ideas. | |
| 4299 | */ | |
| 4300 | jQuery.event = { | |
| 4301 | ||
| 4302 | global: {}, | |
| 4303 | ||
| 4304 | add: function( elem, types, handler, data, selector ) { | |
| 4305 | var tmp, events, t, handleObjIn, | |
| 4306 | special, eventHandle, handleObj, | |
| 4307 | handlers, type, namespaces, origType, | |
| 4308 | elemData = jQuery._data( elem ); | |
| 4309 | ||
| 4310 | // Don't attach events to noData or text/comment nodes (but allow plain objects) | |
| 4311 | if ( !elemData ) { | |
| 4312 | return; | |
| 4313 | } | |
| 4314 | ||
| 4315 | // Caller can pass in an object of custom data in lieu of the handler | |
| 4316 | if ( handler.handler ) { | |
| 4317 | handleObjIn = handler; | |
| 4318 | handler = handleObjIn.handler; | |
| 4319 | selector = handleObjIn.selector; | |
| 4320 | } | |
| 4321 | ||
| 4322 | // Make sure that the handler has a unique ID, used to find/remove it later | |
| 4323 | if ( !handler.guid ) { | |
| 4324 | handler.guid = jQuery.guid++; | |
| 4325 | } | |
| 4326 | ||
| 4327 | // Init the element's event structure and main handler, if this is the first | |
| 4328 | if ( !(events = elemData.events) ) { | |
| 4329 | events = elemData.events = {}; | |
| 4330 | } | |
| 4331 | if ( !(eventHandle = elemData.handle) ) { | |
| 4332 | eventHandle = elemData.handle = function( e ) { | |
| 4333 | // Discard the second event of a jQuery.event.trigger() and | |
| 4334 | // when an event is called after a page has unloaded | |
| 4335 | return typeof jQuery !== strundefined && (!e || jQuery.event.triggered !== e.type) ? | |
| 4336 | jQuery.event.dispatch.apply( eventHandle.elem, arguments ) : | |
| 4337 | undefined; | |
| 4338 | }; | |
| 4339 | // Add elem as a property of the handle fn to prevent a memory leak with IE non-native events | |
| 4340 | eventHandle.elem = elem; | |
| 4341 | } | |
| 4342 | ||
| 4343 | // Handle multiple events separated by a space | |
| 4344 | types = ( types || "" ).match( rnotwhite ) || [ "" ]; | |
| 4345 | t = types.length; | |
| 4346 | while ( t-- ) { | |
| 4347 | tmp = rtypenamespace.exec( types[t] ) || []; | |
| 4348 | type = origType = tmp[1]; | |
| 4349 | namespaces = ( tmp[2] || "" ).split( "." ).sort(); | |
| 4350 | ||
| 4351 | // There *must* be a type, no attaching namespace-only handlers | |
| 4352 | if ( !type ) { | |
| 4353 | continue; | |
| 4354 | } | |
| 4355 | ||
| 4356 | // If event changes its type, use the special event handlers for the changed type | |
| 4357 | special = jQuery.event.special[ type ] || {}; | |
| 4358 | ||
| 4359 | // If selector defined, determine special event api type, otherwise given type | |
| 4360 | type = ( selector ? special.delegateType : special.bindType ) || type; | |
| 4361 | ||
| 4362 | // Update special based on newly reset type | |
| 4363 | special = jQuery.event.special[ type ] || {}; | |
| 4364 | ||
| 4365 | // handleObj is passed to all event handlers | |
| 4366 | handleObj = jQuery.extend({ | |
| 4367 | type: type, | |
| 4368 | origType: origType, | |
| 4369 | data: data, | |
| 4370 | handler: handler, | |
| 4371 | guid: handler.guid, | |
| 4372 | selector: selector, | |
| 4373 | needsContext: selector && jQuery.expr.match.needsContext.test( selector ), | |
| 4374 | namespace: namespaces.join(".") | |
| 4375 | }, handleObjIn ); | |
| 4376 | ||
| 4377 | // Init the event handler queue if we're the first | |
| 4378 | if ( !(handlers = events[ type ]) ) { | |
| 4379 | handlers = events[ type ] = []; | |
| 4380 | handlers.delegateCount = 0; | |
| 4381 | ||
| 4382 | // Only use addEventListener/attachEvent if the special events handler returns false | |
| 4383 | if ( !special.setup || special.setup.call( elem, data, namespaces, eventHandle ) === false ) { | |
| 4384 | // Bind the global event handler to the element | |
| 4385 | if ( elem.addEventListener ) { | |
| 4386 | elem.addEventListener( type, eventHandle, false ); | |
| 4387 | ||
| 4388 | } else if ( elem.attachEvent ) { | |
| 4389 | elem.attachEvent( "on" + type, eventHandle ); | |
| 4390 | } | |
| 4391 | } | |
| 4392 | } | |
| 4393 | ||
| 4394 | if ( special.add ) { | |
| 4395 | special.add.call( elem, handleObj ); | |
| 4396 | ||
| 4397 | if ( !handleObj.handler.guid ) { | |
| 4398 | handleObj.handler.guid = handler.guid; | |
| 4399 | } | |
| 4400 | } | |
| 4401 | ||
| 4402 | // Add to the element's handler list, delegates in front | |
| 4403 | if ( selector ) { | |
| 4404 | handlers.splice( handlers.delegateCount++, 0, handleObj ); | |
| 4405 | } else { | |
| 4406 | handlers.push( handleObj ); | |
| 4407 | } | |
| 4408 | ||
| 4409 | // Keep track of which events have ever been used, for event optimization | |
| 4410 | jQuery.event.global[ type ] = true; | |
| 4411 | } | |
| 4412 | ||
| 4413 | // Nullify elem to prevent memory leaks in IE | |
| 4414 | elem = null; | |
| 4415 | }, | |
| 4416 | ||
| 4417 | // Detach an event or set of events from an element | |
| 4418 | remove: function( elem, types, handler, selector, mappedTypes ) { | |
| 4419 | var j, handleObj, tmp, | |
| 4420 | origCount, t, events, | |
| 4421 | special, handlers, type, | |
| 4422 | namespaces, origType, | |
| 4423 | elemData = jQuery.hasData( elem ) && jQuery._data( elem ); | |
| 4424 | ||
| 4425 | if ( !elemData || !(events = elemData.events) ) { | |
| 4426 | return; | |
| 4427 | } | |
| 4428 | ||
| 4429 | // Once for each type.namespace in types; type may be omitted | |
| 4430 | types = ( types || "" ).match( rnotwhite ) || [ "" ]; | |
| 4431 | t = types.length; | |
| 4432 | while ( t-- ) { | |
| 4433 | tmp = rtypenamespace.exec( types[t] ) || []; | |
| 4434 | type = origType = tmp[1]; | |
| 4435 | namespaces = ( tmp[2] || "" ).split( "." ).sort(); | |
| 4436 | ||
| 4437 | // Unbind all events (on this namespace, if provided) for the element | |
| 4438 | if ( !type ) { | |
| 4439 | for ( type in events ) { | |
| 4440 | jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); | |
| 4441 | } | |
| 4442 | continue; | |
| 4443 | } | |
| 4444 | ||
| 4445 | special = jQuery.event.special[ type ] || {}; | |
| 4446 | type = ( selector ? special.delegateType : special.bindType ) || type; | |
| 4447 | handlers = events[ type ] || []; | |
| 4448 | tmp = tmp[2] && new RegExp( "(^|\\.)" + namespaces.join("\\.(?:.*\\.|)") + "(\\.|$)" ); | |
| 4449 | ||
| 4450 | // Remove matching events | |
| 4451 | origCount = j = handlers.length; | |
| 4452 | while ( j-- ) { | |
| 4453 | handleObj = handlers[ j ]; | |
| 4454 | ||
| 4455 | if ( ( mappedTypes || origType === handleObj.origType ) && | |
| 4456 | ( !handler || handler.guid === handleObj.guid ) && | |
| 4457 | ( !tmp || tmp.test( handleObj.namespace ) ) && | |
| 4458 | ( !selector || selector === handleObj.selector || selector === "**" && handleObj.selector ) ) { | |
| 4459 | handlers.splice( j, 1 ); | |
| 4460 | ||
| 4461 | if ( handleObj.selector ) { | |
| 4462 | handlers.delegateCount--; | |
| 4463 | } | |
| 4464 | if ( special.remove ) { | |
| 4465 | special.remove.call( elem, handleObj ); | |
| 4466 | } | |
| 4467 | } | |
| 4468 | } | |
| 4469 | ||
| 4470 | // Remove generic event handler if we removed something and no more handlers exist | |
| 4471 | // (avoids potential for endless recursion during removal of special event handlers) | |
| 4472 | if ( origCount && !handlers.length ) { | |
| 4473 | if ( !special.teardown || special.teardown.call( elem, namespaces, elemData.handle ) === false ) { | |
| 4474 | jQuery.removeEvent( elem, type, elemData.handle ); | |
| 4475 | } | |
| 4476 | ||
| 4477 | delete events[ type ]; | |
| 4478 | } | |
| 4479 | } | |
| 4480 | ||
| 4481 | // Remove the expando if it's no longer used | |
| 4482 | if ( jQuery.isEmptyObject( events ) ) { | |
| 4483 | delete elemData.handle; | |
| 4484 | ||
| 4485 | // removeData also checks for emptiness and clears the expando if empty | |
| 4486 | // so use it instead of delete | |
| 4487 | jQuery._removeData( elem, "events" ); | |
| 4488 | } | |
| 4489 | }, | |
| 4490 | ||
| 4491 | trigger: function( event, data, elem, onlyHandlers ) { | |
| 4492 | var handle, ontype, cur, | |
| 4493 | bubbleType, special, tmp, i, | |
| 4494 | eventPath = [ elem || document ], | |
| 4495 | type = hasOwn.call( event, "type" ) ? event.type : event, | |
| 4496 | namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split(".") : []; | |
| 4497 | ||
| 4498 | cur = tmp = elem = elem || document; | |
| 4499 | ||
| 4500 | // Don't do events on text and comment nodes | |
| 4501 | if ( elem.nodeType === 3 || elem.nodeType === 8 ) { | |
| 4502 | return; | |
| 4503 | } | |
| 4504 | ||
| 4505 | // focus/blur morphs to focusin/out; ensure we're not firing them right now | |
| 4506 | if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { | |
| 4507 | return; | |
| 4508 | } | |
| 4509 | ||
| 4510 | if ( type.indexOf(".") >= 0 ) { | |
| 4511 | // Namespaced trigger; create a regexp to match event type in handle() | |
| 4512 | namespaces = type.split("."); | |
| 4513 | type = namespaces.shift(); | |
| 4514 | namespaces.sort(); | |
| 4515 | } | |
| 4516 | ontype = type.indexOf(":") < 0 && "on" + type; | |
| 4517 | ||
| 4518 | // Caller can pass in a jQuery.Event object, Object, or just an event type string | |
| 4519 | event = event[ jQuery.expando ] ? | |
| 4520 | event : | |
| 4521 | new jQuery.Event( type, typeof event === "object" && event ); | |
| 4522 | ||
| 4523 | // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) | |
| 4524 | event.isTrigger = onlyHandlers ? 2 : 3; | |
| 4525 | event.namespace = namespaces.join("."); | |
| 4526 | event.namespace_re = event.namespace ? | |
| 4527 | new RegExp( "(^|\\.)" + namespaces.join("\\.(?:.*\\.|)") + "(\\.|$)" ) : | |
| 4528 | null; | |
| 4529 | ||
| 4530 | // Clean up the event in case it is being reused | |
| 4531 | event.result = undefined; | |
| 4532 | if ( !event.target ) { | |
| 4533 | event.target = elem; | |
| 4534 | } | |
| 4535 | ||
| 4536 | // Clone any incoming data and prepend the event, creating the handler arg list | |
| 4537 | data = data == null ? | |
| 4538 | [ event ] : | |
| 4539 | jQuery.makeArray( data, [ event ] ); | |
| 4540 | ||
| 4541 | // Allow special events to draw outside the lines | |
| 4542 | special = jQuery.event.special[ type ] || {}; | |
| 4543 | if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { | |
| 4544 | return; | |
| 4545 | } | |
| 4546 | ||
| 4547 | // Determine event propagation path in advance, per W3C events spec (#9951) | |
| 4548 | // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) | |
| 4549 | if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) { | |
| 4550 | ||
| 4551 | bubbleType = special.delegateType || type; | |
| 4552 | if ( !rfocusMorph.test( bubbleType + type ) ) { | |
| 4553 | cur = cur.parentNode; | |
| 4554 | } | |
| 4555 | for ( ; cur; cur = cur.parentNode ) { | |
| 4556 | eventPath.push( cur ); | |
| 4557 | tmp = cur; | |
| 4558 | } | |
| 4559 | ||
| 4560 | // Only add window if we got to document (e.g., not plain obj or detached DOM) | |
| 4561 | if ( tmp === (elem.ownerDocument || document) ) { | |
| 4562 | eventPath.push( tmp.defaultView || tmp.parentWindow || window ); | |
| 4563 | } | |
| 4564 | } | |
| 4565 | ||
| 4566 | // Fire handlers on the event path | |
| 4567 | i = 0; | |
| 4568 | while ( (cur = eventPath[i++]) && !event.isPropagationStopped() ) { | |
| 4569 | ||
| 4570 | event.type = i > 1 ? | |
| 4571 | bubbleType : | |
| 4572 | special.bindType || type; | |
| 4573 | ||
| 4574 | // jQuery handler | |
| 4575 | handle = ( jQuery._data( cur, "events" ) || {} )[ event.type ] && jQuery._data( cur, "handle" ); | |
| 4576 | if ( handle ) { | |
| 4577 | handle.apply( cur, data ); | |
| 4578 | } | |
| 4579 | ||
| 4580 | // Native handler | |
| 4581 | handle = ontype && cur[ ontype ]; | |
| 4582 | if ( handle && handle.apply && jQuery.acceptData( cur ) ) { | |
| 4583 | event.result = handle.apply( cur, data ); | |
| 4584 | if ( event.result === false ) { | |
| 4585 | event.preventDefault(); | |
| 4586 | } | |
| 4587 | } | |
| 4588 | } | |
| 4589 | event.type = type; | |
| 4590 | ||
| 4591 | // If nobody prevented the default action, do it now | |
| 4592 | if ( !onlyHandlers && !event.isDefaultPrevented() ) { | |
| 4593 | ||
| 4594 | if ( (!special._default || special._default.apply( eventPath.pop(), data ) === false) && | |
| 4595 | jQuery.acceptData( elem ) ) { | |
| 4596 | ||
| 4597 | // Call a native DOM method on the target with the same name name as the event. | |
| 4598 | // Can't use an .isFunction() check here because IE6/7 fails that test. | |
| 4599 | // Don't do default actions on window, that's where global variables be (#6170) | |
| 4600 | if ( ontype && elem[ type ] && !jQuery.isWindow( elem ) ) { | |
| 4601 | ||
| 4602 | // Don't re-trigger an onFOO event when we call its FOO() method | |
| 4603 | tmp = elem[ ontype ]; | |
| 4604 | ||
| 4605 | if ( tmp ) { | |
| 4606 | elem[ ontype ] = null; | |
| 4607 | } | |
| 4608 | ||
| 4609 | // Prevent re-triggering of the same event, since we already bubbled it above | |
| 4610 | jQuery.event.triggered = type; | |
| 4611 | try { | |
| 4612 | elem[ type ](); | |
| 4613 | } catch ( e ) { | |
| 4614 | // IE<9 dies on focus/blur to hidden element (#1486,#12518) | |
| 4615 | // only reproducible on winXP IE8 native, not IE9 in IE8 mode | |
| 4616 | } | |
| 4617 | jQuery.event.triggered = undefined; | |
| 4618 | ||
| 4619 | if ( tmp ) { | |
| 4620 | elem[ ontype ] = tmp; | |
| 4621 | } | |
| 4622 | } | |
| 4623 | } | |
| 4624 | } | |
| 4625 | ||
| 4626 | return event.result; | |
| 4627 | }, | |
| 4628 | ||
| 4629 | dispatch: function( event ) { | |
| 4630 | ||
| 4631 | // Make a writable jQuery.Event from the native event object | |
| 4632 | event = jQuery.event.fix( event ); | |
| 4633 | ||
| 4634 | var i, ret, handleObj, matched, j, | |
| 4635 | handlerQueue = [], | |
| 4636 | args = slice.call( arguments ), | |
| 4637 | handlers = ( jQuery._data( this, "events" ) || {} )[ event.type ] || [], | |
| 4638 | special = jQuery.event.special[ event.type ] || {}; | |
| 4639 | ||
| 4640 | // Use the fix-ed jQuery.Event rather than the (read-only) native event | |
| 4641 | args[0] = event; | |
| 4642 | event.delegateTarget = this; | |
| 4643 | ||
| 4644 | // Call the preDispatch hook for the mapped type, and let it bail if desired | |
| 4645 | if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { | |
| 4646 | return; | |
| 4647 | } | |
| 4648 | ||
| 4649 | // Determine handlers | |
| 4650 | handlerQueue = jQuery.event.handlers.call( this, event, handlers ); | |
| 4651 | ||
| 4652 | // Run delegates first; they may want to stop propagation beneath us | |
| 4653 | i = 0; | |
| 4654 | while ( (matched = handlerQueue[ i++ ]) && !event.isPropagationStopped() ) { | |
| 4655 | event.currentTarget = matched.elem; | |
| 4656 | ||
| 4657 | j = 0; | |
| 4658 | while ( (handleObj = matched.handlers[ j++ ]) && !event.isImmediatePropagationStopped() ) { | |
| 4659 | ||
| 4660 | // Triggered event must either 1) have no namespace, or | |
| 4661 | // 2) have namespace(s) a subset or equal to those in the bound event (both can have no namespace). | |
| 4662 | if ( !event.namespace_re || event.namespace_re.test( handleObj.namespace ) ) { | |
| 4663 | ||
| 4664 | event.handleObj = handleObj; | |
| 4665 | event.data = handleObj.data; | |
| 4666 | ||
| 4667 | ret = ( (jQuery.event.special[ handleObj.origType ] || {}).handle || handleObj.handler ) | |
| 4668 | .apply( matched.elem, args ); | |
| 4669 | ||
| 4670 | if ( ret !== undefined ) { | |
| 4671 | if ( (event.result = ret) === false ) { | |
| 4672 | event.preventDefault(); | |
| 4673 | event.stopPropagation(); | |
| 4674 | } | |
| 4675 | } | |
| 4676 | } | |
| 4677 | } | |
| 4678 | } | |
| 4679 | ||
| 4680 | // Call the postDispatch hook for the mapped type | |
| 4681 | if ( special.postDispatch ) { | |
| 4682 | special.postDispatch.call( this, event ); | |
| 4683 | } | |
| 4684 | ||
| 4685 | return event.result; | |
| 4686 | }, | |
| 4687 | ||
| 4688 | handlers: function( event, handlers ) { | |
| 4689 | var sel, handleObj, matches, i, | |
| 4690 | handlerQueue = [], | |
| 4691 | delegateCount = handlers.delegateCount, | |
| 4692 | cur = event.target; | |
| 4693 | ||
| 4694 | // Find delegate handlers | |
| 4695 | // Black-hole SVG <use> instance trees (#13180) | |
| 4696 | // Avoid non-left-click bubbling in Firefox (#3861) | |
| 4697 | if ( delegateCount && cur.nodeType && (!event.button || event.type !== "click") ) { | |
| 4698 | ||
| 4699 | /* jshint eqeqeq: false */ | |
| 4700 | for ( ; cur != this; cur = cur.parentNode || this ) { | |
| 4701 | /* jshint eqeqeq: true */ | |
| 4702 | ||
| 4703 | // Don't check non-elements (#13208) | |
| 4704 | // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) | |
| 4705 | if ( cur.nodeType === 1 && (cur.disabled !== true || event.type !== "click") ) { | |
| 4706 | matches = []; | |
| 4707 | for ( i = 0; i < delegateCount; i++ ) { | |
| 4708 | handleObj = handlers[ i ]; | |
| 4709 | ||
| 4710 | // Don't conflict with Object.prototype properties (#13203) | |
| 4711 | sel = handleObj.selector + " "; | |
| 4712 | ||
| 4713 | if ( matches[ sel ] === undefined ) { | |
| 4714 | matches[ sel ] = handleObj.needsContext ? | |
| 4715 | jQuery( sel, this ).index( cur ) >= 0 : | |
| 4716 | jQuery.find( sel, this, null, [ cur ] ).length; | |
| 4717 | } | |
| 4718 | if ( matches[ sel ] ) { | |
| 4719 | matches.push( handleObj ); | |
| 4720 | } | |
| 4721 | } | |
| 4722 | if ( matches.length ) { | |
| 4723 | handlerQueue.push({ elem: cur, handlers: matches }); | |
| 4724 | } | |
| 4725 | } | |
| 4726 | } | |
| 4727 | } | |
| 4728 | ||
| 4729 | // Add the remaining (directly-bound) handlers | |
| 4730 | if ( delegateCount < handlers.length ) { | |
| 4731 | handlerQueue.push({ elem: this, handlers: handlers.slice( delegateCount ) }); | |
| 4732 | } | |
| 4733 | ||
| 4734 | return handlerQueue; | |
| 4735 | }, | |
| 4736 | ||
| 4737 | fix: function( event ) { | |
| 4738 | if ( event[ jQuery.expando ] ) { | |
| 4739 | return event; | |
| 4740 | } | |
| 4741 | ||
| 4742 | // Create a writable copy of the event object and normalize some properties | |
| 4743 | var i, prop, copy, | |
| 4744 | type = event.type, | |
| 4745 | originalEvent = event, | |
| 4746 | fixHook = this.fixHooks[ type ]; | |
| 4747 | ||
| 4748 | if ( !fixHook ) { | |
| 4749 | this.fixHooks[ type ] = fixHook = | |
| 4750 | rmouseEvent.test( type ) ? this.mouseHooks : | |
| 4751 | rkeyEvent.test( type ) ? this.keyHooks : | |
| 4752 | {}; | |
| 4753 | } | |
| 4754 | copy = fixHook.props ? this.props.concat( fixHook.props ) : this.props; | |
| 4755 | ||
| 4756 | event = new jQuery.Event( originalEvent ); | |
| 4757 | ||
| 4758 | i = copy.length; | |
| 4759 | while ( i-- ) { | |
| 4760 | prop = copy[ i ]; | |
| 4761 | event[ prop ] = originalEvent[ prop ]; | |
| 4762 | } | |
| 4763 | ||
| 4764 | // Support: IE<9 | |
| 4765 | // Fix target property (#1925) | |
| 4766 | if ( !event.target ) { | |
| 4767 | event.target = originalEvent.srcElement || document; | |
| 4768 | } | |
| 4769 | ||
| 4770 | // Support: Chrome 23+, Safari? | |
| 4771 | // Target should not be a text node (#504, #13143) | |
| 4772 | if ( event.target.nodeType === 3 ) { | |
| 4773 | event.target = event.target.parentNode; | |
| 4774 | } | |
| 4775 | ||
| 4776 | // Support: IE<9 | |
| 4777 | // For mouse/key events, metaKey==false if it's undefined (#3368, #11328) | |
| 4778 | event.metaKey = !!event.metaKey; | |
| 4779 | ||
| 4780 | return fixHook.filter ? fixHook.filter( event, originalEvent ) : event; | |
| 4781 | }, | |
| 4782 | ||
| 4783 | // Includes some event props shared by KeyEvent and MouseEvent | |
| 4784 | props: "altKey bubbles cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey target timeStamp view which".split(" "), | |
| 4785 | ||
| 4786 | fixHooks: {}, | |
| 4787 | ||
| 4788 | keyHooks: { | |
| 4789 | props: "char charCode key keyCode".split(" "), | |
| 4790 | filter: function( event, original ) { | |
| 4791 | ||
| 4792 | // Add which for key events | |
| 4793 | if ( event.which == null ) { | |
| 4794 | event.which = original.charCode != null ? original.charCode : original.keyCode; | |
| 4795 | } | |
| 4796 | ||
| 4797 | return event; | |
| 4798 | } | |
| 4799 | }, | |
| 4800 | ||
| 4801 | mouseHooks: { | |
| 4802 | props: "button buttons clientX clientY fromElement offsetX offsetY pageX pageY screenX screenY toElement".split(" "), | |
| 4803 | filter: function( event, original ) { | |
| 4804 | var body, eventDoc, doc, | |
| 4805 | button = original.button, | |
| 4806 | fromElement = original.fromElement; | |
| 4807 | ||
| 4808 | // Calculate pageX/Y if missing and clientX/Y available | |
| 4809 | if ( event.pageX == null && original.clientX != null ) { | |
| 4810 | eventDoc = event.target.ownerDocument || document; | |
| 4811 | doc = eventDoc.documentElement; | |
| 4812 | body = eventDoc.body; | |
| 4813 | ||
| 4814 | event.pageX = original.clientX + ( doc && doc.scrollLeft || body && body.scrollLeft || 0 ) - ( doc && doc.clientLeft || body && body.clientLeft || 0 ); | |
| 4815 | event.pageY = original.clientY + ( doc && doc.scrollTop || body && body.scrollTop || 0 ) - ( doc && doc.clientTop || body && body.clientTop || 0 ); | |
| 4816 | } | |
| 4817 | ||
| 4818 | // Add relatedTarget, if necessary | |
| 4819 | if ( !event.relatedTarget && fromElement ) { | |
| 4820 | event.relatedTarget = fromElement === event.target ? original.toElement : fromElement; | |
| 4821 | } | |
| 4822 | ||
| 4823 | // Add which for click: 1 === left; 2 === middle; 3 === right | |
| 4824 | // Note: button is not normalized, so don't use it | |
| 4825 | if ( !event.which && button !== undefined ) { | |
| 4826 | event.which = ( button & 1 ? 1 : ( button & 2 ? 3 : ( button & 4 ? 2 : 0 ) ) ); | |
| 4827 | } | |
| 4828 | ||
| 4829 | return event; | |
| 4830 | } | |
| 4831 | }, | |
| 4832 | ||
| 4833 | special: { | |
| 4834 | load: { | |
| 4835 | // Prevent triggered image.load events from bubbling to window.load | |
| 4836 | noBubble: true | |
| 4837 | }, | |
| 4838 | focus: { | |
| 4839 | // Fire native event if possible so blur/focus sequence is correct | |
| 4840 | trigger: function() { | |
| 4841 | if ( this !== safeActiveElement() && this.focus ) { | |
| 4842 | try { | |
| 4843 | this.focus(); | |
| 4844 | return false; | |
| 4845 | } catch ( e ) { | |
| 4846 | // Support: IE<9 | |
| 4847 | // If we error on focus to hidden element (#1486, #12518), | |
| 4848 | // let .trigger() run the handlers | |
| 4849 | } | |
| 4850 | } | |
| 4851 | }, | |
| 4852 | delegateType: "focusin" | |
| 4853 | }, | |
| 4854 | blur: { | |
| 4855 | trigger: function() { | |
| 4856 | if ( this === safeActiveElement() && this.blur ) { | |
| 4857 | this.blur(); | |
| 4858 | return false; | |
| 4859 | } | |
| 4860 | }, | |
| 4861 | delegateType: "focusout" | |
| 4862 | }, | |
| 4863 | click: { | |
| 4864 | // For checkbox, fire native event so checked state will be right | |
| 4865 | trigger: function() { | |
| 4866 | if ( jQuery.nodeName( this, "input" ) && this.type === "checkbox" && this.click ) { | |
| 4867 | this.click(); | |
| 4868 | return false; | |
| 4869 | } | |
| 4870 | }, | |
| 4871 | ||
| 4872 | // For cross-browser consistency, don't fire native .click() on links | |
| 4873 | _default: function( event ) { | |
| 4874 | return jQuery.nodeName( event.target, "a" ); | |
| 4875 | } | |
| 4876 | }, | |
| 4877 | ||
| 4878 | beforeunload: { | |
| 4879 | postDispatch: function( event ) { | |
| 4880 | ||
| 4881 | // Support: Firefox 20+ | |
| 4882 | // Firefox doesn't alert if the returnValue field is not set. | |
| 4883 | if ( event.result !== undefined && event.originalEvent ) { | |
| 4884 | event.originalEvent.returnValue = event.result; | |
| 4885 | } | |
| 4886 | } | |
| 4887 | } | |
| 4888 | }, | |
| 4889 | ||
| 4890 | simulate: function( type, elem, event, bubble ) { | |
| 4891 | // Piggyback on a donor event to simulate a different one. | |
| 4892 | // Fake originalEvent to avoid donor's stopPropagation, but if the | |
| 4893 | // simulated event prevents default then we do the same on the donor. | |
| 4894 | var e = jQuery.extend( | |
| 4895 | new jQuery.Event(), | |
| 4896 | event, | |
| 4897 | { | |
| 4898 | type: type, | |
| 4899 | isSimulated: true, | |
| 4900 | originalEvent: {} | |
| 4901 | } | |
| 4902 | ); | |
| 4903 | if ( bubble ) { | |
| 4904 | jQuery.event.trigger( e, null, elem ); | |
| 4905 | } else { | |
| 4906 | jQuery.event.dispatch.call( elem, e ); | |
| 4907 | } | |
| 4908 | if ( e.isDefaultPrevented() ) { | |
| 4909 | event.preventDefault(); | |
| 4910 | } | |
| 4911 | } | |
| 4912 | }; | |
| 4913 | ||
| 4914 | jQuery.removeEvent = document.removeEventListener ? | |
| 4915 | function( elem, type, handle ) { | |
| 4916 | if ( elem.removeEventListener ) { | |
| 4917 | elem.removeEventListener( type, handle, false ); | |
| 4918 | } | |
| 4919 | } : | |
| 4920 | function( elem, type, handle ) { | |
| 4921 | var name = "on" + type; | |
| 4922 | ||
| 4923 | if ( elem.detachEvent ) { | |
| 4924 | ||
| 4925 | // #8545, #7054, preventing memory leaks for custom events in IE6-8 | |
| 4926 | // detachEvent needed property on element, by name of that event, to properly expose it to GC | |
| 4927 | if ( typeof elem[ name ] === strundefined ) { | |
| 4928 | elem[ name ] = null; | |
| 4929 | } | |
| 4930 | ||
| 4931 | elem.detachEvent( name, handle ); | |
| 4932 | } | |
| 4933 | }; | |
| 4934 | ||
| 4935 | jQuery.Event = function( src, props ) { | |
| 4936 | // Allow instantiation without the 'new' keyword | |
| 4937 | if ( !(this instanceof jQuery.Event) ) { | |
| 4938 | return new jQuery.Event( src, props ); | |
| 4939 | } | |
| 4940 | ||
| 4941 | // Event object | |
| 4942 | if ( src && src.type ) { | |
| 4943 | this.originalEvent = src; | |
| 4944 | this.type = src.type; | |
| 4945 | ||
| 4946 | // Events bubbling up the document may have been marked as prevented | |
| 4947 | // by a handler lower down the tree; reflect the correct value. | |
| 4948 | this.isDefaultPrevented = src.defaultPrevented || | |
| 4949 | src.defaultPrevented === undefined && | |
| 4950 | // Support: IE < 9, Android < 4.0 | |
| 4951 | src.returnValue === false ? | |
| 4952 | returnTrue : | |
| 4953 | returnFalse; | |
| 4954 | ||
| 4955 | // Event type | |
| 4956 | } else { | |
| 4957 | this.type = src; | |
| 4958 | } | |
| 4959 | ||
| 4960 | // Put explicitly provided properties onto the event object | |
| 4961 | if ( props ) { | |
| 4962 | jQuery.extend( this, props ); | |
| 4963 | } | |
| 4964 | ||
| 4965 | // Create a timestamp if incoming event doesn't have one | |
| 4966 | this.timeStamp = src && src.timeStamp || jQuery.now(); | |
| 4967 | ||
| 4968 | // Mark it as fixed | |
| 4969 | this[ jQuery.expando ] = true; | |
| 4970 | }; | |
| 4971 | ||
| 4972 | // jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding | |
| 4973 | // http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html | |
| 4974 | jQuery.Event.prototype = { | |
| 4975 | isDefaultPrevented: returnFalse, | |
| 4976 | isPropagationStopped: returnFalse, | |
| 4977 | isImmediatePropagationStopped: returnFalse, | |
| 4978 | ||
| 4979 | preventDefault: function() { | |
| 4980 | var e = this.originalEvent; | |
| 4981 | ||
| 4982 | this.isDefaultPrevented = returnTrue; | |
| 4983 | if ( !e ) { | |
| 4984 | return; | |
| 4985 | } | |
| 4986 | ||
| 4987 | // If preventDefault exists, run it on the original event | |
| 4988 | if ( e.preventDefault ) { | |
| 4989 | e.preventDefault(); | |
| 4990 | ||
| 4991 | // Support: IE | |
| 4992 | // Otherwise set the returnValue property of the original event to false | |
| 4993 | } else { | |
| 4994 | e.returnValue = false; | |
| 4995 | } | |
| 4996 | }, | |
| 4997 | stopPropagation: function() { | |
| 4998 | var e = this.originalEvent; | |
| 4999 | ||
| 5000 | this.isPropagationStopped = returnTrue; | |
| 5001 | if ( !e ) { | |
| 5002 | return; | |
| 5003 | } | |
| 5004 | // If stopPropagation exists, run it on the original event | |
| 5005 | if ( e.stopPropagation ) { | |
| 5006 | e.stopPropagation(); | |
| 5007 | } | |
| 5008 | ||
| 5009 | // Support: IE | |
| 5010 | // Set the cancelBubble property of the original event to true | |
| 5011 | e.cancelBubble = true; | |
| 5012 | }, | |
| 5013 | stopImmediatePropagation: function() { | |
| 5014 | var e = this.originalEvent; | |
| 5015 | ||
| 5016 | this.isImmediatePropagationStopped = returnTrue; | |
| 5017 | ||
| 5018 | if ( e && e.stopImmediatePropagation ) { | |
| 5019 | e.stopImmediatePropagation(); | |
| 5020 | } | |
| 5021 | ||
| 5022 | this.stopPropagation(); | |
| 5023 | } | |
| 5024 | }; | |
| 5025 | ||
| 5026 | // Create mouseenter/leave events using mouseover/out and event-time checks | |
| 5027 | jQuery.each({ | |
| 5028 | mouseenter: "mouseover", | |
| 5029 | mouseleave: "mouseout", | |
| 5030 | pointerenter: "pointerover", | |
| 5031 | pointerleave: "pointerout" | |
| 5032 | }, function( orig, fix ) { | |
| 5033 | jQuery.event.special[ orig ] = { | |
| 5034 | delegateType: fix, | |
| 5035 | bindType: fix, | |
| 5036 | ||
| 5037 | handle: function( event ) { | |
| 5038 | var ret, | |
| 5039 | target = this, | |
| 5040 | related = event.relatedTarget, | |
| 5041 | handleObj = event.handleObj; | |
| 5042 | ||
| 5043 | // For mousenter/leave call the handler if related is outside the target. | |
| 5044 | // NB: No relatedTarget if the mouse left/entered the browser window | |
| 5045 | if ( !related || (related !== target && !jQuery.contains( target, related )) ) { | |
| 5046 | event.type = handleObj.origType; | |
| 5047 | ret = handleObj.handler.apply( this, arguments ); | |
| 5048 | event.type = fix; | |
| 5049 | } | |
| 5050 | return ret; | |
| 5051 | } | |
| 5052 | }; | |
| 5053 | }); | |
| 5054 | ||
| 5055 | // IE submit delegation | |
| 5056 | if ( !support.submitBubbles ) { | |
| 5057 | ||
| 5058 | jQuery.event.special.submit = { | |
| 5059 | setup: function() { | |
| 5060 | // Only need this for delegated form submit events | |
| 5061 | if ( jQuery.nodeName( this, "form" ) ) { | |
| 5062 | return false; | |
| 5063 | } | |
| 5064 | ||
| 5065 | // Lazy-add a submit handler when a descendant form may potentially be submitted | |
| 5066 | jQuery.event.add( this, "click._submit keypress._submit", function( e ) { | |
| 5067 | // Node name check avoids a VML-related crash in IE (#9807) | |
| 5068 | var elem = e.target, | |
| 5069 | form = jQuery.nodeName( elem, "input" ) || jQuery.nodeName( elem, "button" ) ? elem.form : undefined; | |
| 5070 | if ( form && !jQuery._data( form, "submitBubbles" ) ) { | |
| 5071 | jQuery.event.add( form, "submit._submit", function( event ) { | |
| 5072 | event._submit_bubble = true; | |
| 5073 | }); | |
| 5074 | jQuery._data( form, "submitBubbles", true ); | |
| 5075 | } | |
| 5076 | }); | |
| 5077 | // return undefined since we don't need an event listener | |
| 5078 | }, | |
| 5079 | ||
| 5080 | postDispatch: function( event ) { | |
| 5081 | // If form was submitted by the user, bubble the event up the tree | |
| 5082 | if ( event._submit_bubble ) { | |
| 5083 | delete event._submit_bubble; | |
| 5084 | if ( this.parentNode && !event.isTrigger ) { | |
| 5085 | jQuery.event.simulate( "submit", this.parentNode, event, true ); | |
| 5086 | } | |
| 5087 | } | |
| 5088 | }, | |
| 5089 | ||
| 5090 | teardown: function() { | |
| 5091 | // Only need this for delegated form submit events | |
| 5092 | if ( jQuery.nodeName( this, "form" ) ) { | |
| 5093 | return false; | |
| 5094 | } | |
| 5095 | ||
| 5096 | // Remove delegated handlers; cleanData eventually reaps submit handlers attached above | |
| 5097 | jQuery.event.remove( this, "._submit" ); | |
| 5098 | } | |
| 5099 | }; | |
| 5100 | } | |
| 5101 | ||
| 5102 | // IE change delegation and checkbox/radio fix | |
| 5103 | if ( !support.changeBubbles ) { | |
| 5104 | ||
| 5105 | jQuery.event.special.change = { | |
| 5106 | ||
| 5107 | setup: function() { | |
| 5108 | ||
| 5109 | if ( rformElems.test( this.nodeName ) ) { | |
| 5110 | // IE doesn't fire change on a check/radio until blur; trigger it on click | |
| 5111 | // after a propertychange. Eat the blur-change in special.change.handle. | |
| 5112 | // This still fires onchange a second time for check/radio after blur. | |
| 5113 | if ( this.type === "checkbox" || this.type === "radio" ) { | |
| 5114 | jQuery.event.add( this, "propertychange._change", function( event ) { | |
| 5115 | if ( event.originalEvent.propertyName === "checked" ) { | |
| 5116 | this._just_changed = true; | |
| 5117 | } | |
| 5118 | }); | |
| 5119 | jQuery.event.add( this, "click._change", function( event ) { | |
| 5120 | if ( this._just_changed && !event.isTrigger ) { | |
| 5121 | this._just_changed = false; | |
| 5122 | } | |
| 5123 | // Allow triggered, simulated change events (#11500) | |
| 5124 | jQuery.event.simulate( "change", this, event, true ); | |
| 5125 | }); | |
| 5126 | } | |
| 5127 | return false; | |
| 5128 | } | |
| 5129 | // Delegated event; lazy-add a change handler on descendant inputs | |
| 5130 | jQuery.event.add( this, "beforeactivate._change", function( e ) { | |
| 5131 | var elem = e.target; | |
| 5132 | ||
| 5133 | if ( rformElems.test( elem.nodeName ) && !jQuery._data( elem, "changeBubbles" ) ) { | |
| 5134 | jQuery.event.add( elem, "change._change", function( event ) { | |
| 5135 | if ( this.parentNode && !event.isSimulated && !event.isTrigger ) { | |
| 5136 | jQuery.event.simulate( "change", this.parentNode, event, true ); | |
| 5137 | } | |
| 5138 | }); | |
| 5139 | jQuery._data( elem, "changeBubbles", true ); | |
| 5140 | } | |
| 5141 | }); | |
| 5142 | }, | |
| 5143 | ||
| 5144 | handle: function( event ) { | |
| 5145 | var elem = event.target; | |
| 5146 | ||
| 5147 | // Swallow native change events from checkbox/radio, we already triggered them above | |
| 5148 | if ( this !== elem || event.isSimulated || event.isTrigger || (elem.type !== "radio" && elem.type !== "checkbox") ) { | |
| 5149 | return event.handleObj.handler.apply( this, arguments ); | |
| 5150 | } | |
| 5151 | }, | |
| 5152 | ||
| 5153 | teardown: function() { | |
| 5154 | jQuery.event.remove( this, "._change" ); | |
| 5155 | ||
| 5156 | return !rformElems.test( this.nodeName ); | |
| 5157 | } | |
| 5158 | }; | |
| 5159 | } | |
| 5160 | ||
| 5161 | // Create "bubbling" focus and blur events | |
| 5162 | if ( !support.focusinBubbles ) { | |
| 5163 | jQuery.each({ focus: "focusin", blur: "focusout" }, function( orig, fix ) { | |
| 5164 | ||
| 5165 | // Attach a single capturing handler on the document while someone wants focusin/focusout | |
| 5166 | var handler = function( event ) { | |
| 5167 | jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ), true ); | |
| 5168 | }; | |
| 5169 | ||
| 5170 | jQuery.event.special[ fix ] = { | |
| 5171 | setup: function() { | |
| 5172 | var doc = this.ownerDocument || this, | |
| 5173 | attaches = jQuery._data( doc, fix ); | |
| 5174 | ||
| 5175 | if ( !attaches ) { | |
| 5176 | doc.addEventListener( orig, handler, true ); | |
| 5177 | } | |
| 5178 | jQuery._data( doc, fix, ( attaches || 0 ) + 1 ); | |
| 5179 | }, | |
| 5180 | teardown: function() { | |
| 5181 | var doc = this.ownerDocument || this, | |
| 5182 | attaches = jQuery._data( doc, fix ) - 1; | |
| 5183 | ||
| 5184 | if ( !attaches ) { | |
| 5185 | doc.removeEventListener( orig, handler, true ); | |
| 5186 | jQuery._removeData( doc, fix ); | |
| 5187 | } else { | |
| 5188 | jQuery._data( doc, fix, attaches ); | |
| 5189 | } | |
| 5190 | } | |
| 5191 | }; | |
| 5192 | }); | |
| 5193 | } | |
| 5194 | ||
| 5195 | jQuery.fn.extend({ | |
| 5196 | ||
| 5197 | on: function( types, selector, data, fn, /*INTERNAL*/ one ) { | |
| 5198 | var type, origFn; | |
| 5199 | ||
| 5200 | // Types can be a map of types/handlers | |
| 5201 | if ( typeof types === "object" ) { | |
| 5202 | // ( types-Object, selector, data ) | |
| 5203 | if ( typeof selector !== "string" ) { | |
| 5204 | // ( types-Object, data ) | |
| 5205 | data = data || selector; | |
| 5206 | selector = undefined; | |
| 5207 | } | |
| 5208 | for ( type in types ) { | |
| 5209 | this.on( type, selector, data, types[ type ], one ); | |
| 5210 | } | |
| 5211 | return this; | |
| 5212 | } | |
| 5213 | ||
| 5214 | if ( data == null && fn == null ) { | |
| 5215 | // ( types, fn ) | |
| 5216 | fn = selector; | |
| 5217 | data = selector = undefined; | |
| 5218 | } else if ( fn == null ) { | |
| 5219 | if ( typeof selector === "string" ) { | |
| 5220 | // ( types, selector, fn ) | |
| 5221 | fn = data; | |
| 5222 | data = undefined; | |
| 5223 | } else { | |
| 5224 | // ( types, data, fn ) | |
| 5225 | fn = data; | |
| 5226 | data = selector; | |
| 5227 | selector = undefined; | |
| 5228 | } | |
| 5229 | } | |
| 5230 | if ( fn === false ) { | |
| 5231 | fn = returnFalse; | |
| 5232 | } else if ( !fn ) { | |
| 5233 | return this; | |
| 5234 | } | |
| 5235 | ||
| 5236 | if ( one === 1 ) { | |
| 5237 | origFn = fn; | |
| 5238 | fn = function( event ) { | |
| 5239 | // Can use an empty set, since event contains the info | |
| 5240 | jQuery().off( event ); | |
| 5241 | return origFn.apply( this, arguments ); | |
| 5242 | }; | |
| 5243 | // Use same guid so caller can remove using origFn | |
| 5244 | fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); | |
| 5245 | } | |
| 5246 | return this.each( function() { | |
| 5247 | jQuery.event.add( this, types, fn, data, selector ); | |
| 5248 | }); | |
| 5249 | }, | |
| 5250 | one: function( types, selector, data, fn ) { | |
| 5251 | return this.on( types, selector, data, fn, 1 ); | |
| 5252 | }, | |
| 5253 | off: function( types, selector, fn ) { | |
| 5254 | var handleObj, type; | |
| 5255 | if ( types && types.preventDefault && types.handleObj ) { | |
| 5256 | // ( event ) dispatched jQuery.Event | |
| 5257 | handleObj = types.handleObj; | |
| 5258 | jQuery( types.delegateTarget ).off( | |
| 5259 | handleObj.namespace ? handleObj.origType + "." + handleObj.namespace : handleObj.origType, | |
| 5260 | handleObj.selector, | |
| 5261 | handleObj.handler | |
| 5262 | ); | |
| 5263 | return this; | |
| 5264 | } | |
| 5265 | if ( typeof types === "object" ) { | |
| 5266 | // ( types-object [, selector] ) | |
| 5267 | for ( type in types ) { | |
| 5268 | this.off( type, selector, types[ type ] ); | |
| 5269 | } | |
| 5270 | return this; | |
| 5271 | } | |
| 5272 | if ( selector === false || typeof selector === "function" ) { | |
| 5273 | // ( types [, fn] ) | |
| 5274 | fn = selector; | |
| 5275 | selector = undefined; | |
| 5276 | } | |
| 5277 | if ( fn === false ) { | |
| 5278 | fn = returnFalse; | |
| 5279 | } | |
| 5280 | return this.each(function() { | |
| 5281 | jQuery.event.remove( this, types, fn, selector ); | |
| 5282 | }); | |
| 5283 | }, | |
| 5284 | ||
| 5285 | trigger: function( type, data ) { | |
| 5286 | return this.each(function() { | |
| 5287 | jQuery.event.trigger( type, data, this ); | |
| 5288 | }); | |
| 5289 | }, | |
| 5290 | triggerHandler: function( type, data ) { | |
| 5291 | var elem = this[0]; | |
| 5292 | if ( elem ) { | |
| 5293 | return jQuery.event.trigger( type, data, elem, true ); | |
| 5294 | } | |
| 5295 | } | |
| 5296 | }); | |
| 5297 | ||
| 5298 | ||
| 5299 | function createSafeFragment( document ) { | |
| 5300 | var list = nodeNames.split( "|" ), | |
| 5301 | safeFrag = document.createDocumentFragment(); | |
| 5302 | ||
| 5303 | if ( safeFrag.createElement ) { | |
| 5304 | while ( list.length ) { | |
| 5305 | safeFrag.createElement( | |
| 5306 | list.pop() | |
| 5307 | ); | |
| 5308 | } | |
| 5309 | } | |
| 5310 | return safeFrag; | |
| 5311 | } | |
| 5312 | ||
| 5313 | var nodeNames = "abbr|article|aside|audio|bdi|canvas|data|datalist|details|figcaption|figure|footer|" + | |
| 5314 | "header|hgroup|mark|meter|nav|output|progress|section|summary|time|video", | |
| 5315 | rinlinejQuery = / jQuery\d+="(?:null|\d+)"/g, | |
| 5316 | rnoshimcache = new RegExp("<(?:" + nodeNames + ")[\\s/>]", "i"), | |
| 5317 | rleadingWhitespace = /^\s+/, | |
| 5318 | rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi, | |
| 5319 | rtagName = /<([\w:]+)/, | |
| 5320 | rtbody = /<tbody/i, | |
| 5321 | rhtml = /<|&#?\w+;/, | |
| 5322 | rnoInnerhtml = /<(?:script|style|link)/i, | |
| 5323 | // checked="checked" or checked | |
| 5324 | rchecked = /checked\s*(?:[^=]|=\s*.checked.)/i, | |
| 5325 | rscriptType = /^$|\/(?:java|ecma)script/i, | |
| 5326 | rscriptTypeMasked = /^true\/(.*)/, | |
| 5327 | rcleanScript = /^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g, | |
| 5328 | ||
| 5329 | // We have to close these tags to support XHTML (#13200) | |
| 5330 | wrapMap = { | |
| 5331 | option: [ 1, "<select multiple='multiple'>", "</select>" ], | |
| 5332 | legend: [ 1, "<fieldset>", "</fieldset>" ], | |
| 5333 | area: [ 1, "<map>", "</map>" ], | |
| 5334 | param: [ 1, "<object>", "</object>" ], | |
| 5335 | thead: [ 1, "<table>", "</table>" ], | |
| 5336 | tr: [ 2, "<table><tbody>", "</tbody></table>" ], | |
| 5337 | col: [ 2, "<table><tbody></tbody><colgroup>", "</colgroup></table>" ], | |
| 5338 | td: [ 3, "<table><tbody><tr>", "</tr></tbody></table>" ], | |
| 5339 | ||
| 5340 | // IE6-8 can't serialize link, script, style, or any html5 (NoScope) tags, | |
| 5341 | // unless wrapped in a div with non-breaking characters in front of it. | |
| 5342 | _default: support.htmlSerialize ? [ 0, "", "" ] : [ 1, "X<div>", "</div>" ] | |
| 5343 | }, | |
| 5344 | safeFragment = createSafeFragment( document ), | |
| 5345 | fragmentDiv = safeFragment.appendChild( document.createElement("div") ); | |
| 5346 | ||
| 5347 | wrapMap.optgroup = wrapMap.option; | |
| 5348 | wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; | |
| 5349 | wrapMap.th = wrapMap.td; | |
| 5350 | ||
| 5351 | function getAll( context, tag ) { | |
| 5352 | var elems, elem, | |
| 5353 | i = 0, | |
| 5354 | found = typeof context.getElementsByTagName !== strundefined ? context.getElementsByTagName( tag || "*" ) : | |
| 5355 | typeof context.querySelectorAll !== strundefined ? context.querySelectorAll( tag || "*" ) : | |
| 5356 | undefined; | |
| 5357 | ||
| 5358 | if ( !found ) { | |
| 5359 | for ( found = [], elems = context.childNodes || context; (elem = elems[i]) != null; i++ ) { | |
| 5360 | if ( !tag || jQuery.nodeName( elem, tag ) ) { | |
| 5361 | found.push( elem ); | |
| 5362 | } else { | |
| 5363 | jQuery.merge( found, getAll( elem, tag ) ); | |
| 5364 | } | |
| 5365 | } | |
| 5366 | } | |
| 5367 | ||
| 5368 | return tag === undefined || tag && jQuery.nodeName( context, tag ) ? | |
| 5369 | jQuery.merge( [ context ], found ) : | |
| 5370 | found; | |
| 5371 | } | |
| 5372 | ||
| 5373 | // Used in buildFragment, fixes the defaultChecked property | |
| 5374 | function fixDefaultChecked( elem ) { | |
| 5375 | if ( rcheckableType.test( elem.type ) ) { | |
| 5376 | elem.defaultChecked = elem.checked; | |
| 5377 | } | |
| 5378 | } | |
| 5379 | ||
| 5380 | // Support: IE<8 | |
| 5381 | // Manipulating tables requires a tbody | |
| 5382 | function manipulationTarget( elem, content ) { | |
| 5383 | return jQuery.nodeName( elem, "table" ) && | |
| 5384 | jQuery.nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ? | |
| 5385 | ||
| 5386 | elem.getElementsByTagName("tbody")[0] || | |
| 5387 | elem.appendChild( elem.ownerDocument.createElement("tbody") ) : | |
| 5388 | elem; | |
| 5389 | } | |
| 5390 | ||
| 5391 | // Replace/restore the type attribute of script elements for safe DOM manipulation | |
| 5392 | function disableScript( elem ) { | |
| 5393 | elem.type = (jQuery.find.attr( elem, "type" ) !== null) + "/" + elem.type; | |
| 5394 | return elem; | |
| 5395 | } | |
| 5396 | function restoreScript( elem ) { | |
| 5397 | var match = rscriptTypeMasked.exec( elem.type ); | |
| 5398 | if ( match ) { | |
| 5399 | elem.type = match[1]; | |
| 5400 | } else { | |
| 5401 | elem.removeAttribute("type"); | |
| 5402 | } | |
| 5403 | return elem; | |
| 5404 | } | |
| 5405 | ||
| 5406 | // Mark scripts as having already been evaluated | |
| 5407 | function setGlobalEval( elems, refElements ) { | |
| 5408 | var elem, | |
| 5409 | i = 0; | |
| 5410 | for ( ; (elem = elems[i]) != null; i++ ) { | |
| 5411 | jQuery._data( elem, "globalEval", !refElements || jQuery._data( refElements[i], "globalEval" ) ); | |
| 5412 | } | |
| 5413 | } | |
| 5414 | ||
| 5415 | function cloneCopyEvent( src, dest ) { | |
| 5416 | ||
| 5417 | if ( dest.nodeType !== 1 || !jQuery.hasData( src ) ) { | |
| 5418 | return; | |
| 5419 | } | |
| 5420 | ||
| 5421 | var type, i, l, | |
| 5422 | oldData = jQuery._data( src ), | |
| 5423 | curData = jQuery._data( dest, oldData ), | |
| 5424 | events = oldData.events; | |
| 5425 | ||
| 5426 | if ( events ) { | |
| 5427 | delete curData.handle; | |
| 5428 | curData.events = {}; | |
| 5429 | ||
| 5430 | for ( type in events ) { | |
| 5431 | for ( i = 0, l = events[ type ].length; i < l; i++ ) { | |
| 5432 | jQuery.event.add( dest, type, events[ type ][ i ] ); | |
| 5433 | } | |
| 5434 | } | |
| 5435 | } | |
| 5436 | ||
| 5437 | // make the cloned public data object a copy from the original | |
| 5438 | if ( curData.data ) { | |
| 5439 | curData.data = jQuery.extend( {}, curData.data ); | |
| 5440 | } | |
| 5441 | } | |
| 5442 | ||
| 5443 | function fixCloneNodeIssues( src, dest ) { | |
| 5444 | var nodeName, e, data; | |
| 5445 | ||
| 5446 | // We do not need to do anything for non-Elements | |
| 5447 | if ( dest.nodeType !== 1 ) { | |
| 5448 | return; | |
| 5449 | } | |
| 5450 | ||
| 5451 | nodeName = dest.nodeName.toLowerCase(); | |
| 5452 | ||
| 5453 | // IE6-8 copies events bound via attachEvent when using cloneNode. | |
| 5454 | if ( !support.noCloneEvent && dest[ jQuery.expando ] ) { | |
| 5455 | data = jQuery._data( dest ); | |
| 5456 | ||
| 5457 | for ( e in data.events ) { | |
| 5458 | jQuery.removeEvent( dest, e, data.handle ); | |
| 5459 | } | |
| 5460 | ||
| 5461 | // Event data gets referenced instead of copied if the expando gets copied too | |
| 5462 | dest.removeAttribute( jQuery.expando ); | |
| 5463 | } | |
| 5464 | ||
| 5465 | // IE blanks contents when cloning scripts, and tries to evaluate newly-set text | |
| 5466 | if ( nodeName === "script" && dest.text !== src.text ) { | |
| 5467 | disableScript( dest ).text = src.text; | |
| 5468 | restoreScript( dest ); | |
| 5469 | ||
| 5470 | // IE6-10 improperly clones children of object elements using classid. | |
| 5471 | // IE10 throws NoModificationAllowedError if parent is null, #12132. | |
| 5472 | } else if ( nodeName === "object" ) { | |
| 5473 | if ( dest.parentNode ) { | |
| 5474 | dest.outerHTML = src.outerHTML; | |
| 5475 | } | |
| 5476 | ||
| 5477 | // This path appears unavoidable for IE9. When cloning an object | |
| 5478 | // element in IE9, the outerHTML strategy above is not sufficient. | |
| 5479 | // If the src has innerHTML and the destination does not, | |
| 5480 | // copy the src.innerHTML into the dest.innerHTML. #10324 | |
| 5481 | if ( support.html5Clone && ( src.innerHTML && !jQuery.trim(dest.innerHTML) ) ) { | |
| 5482 | dest.innerHTML = src.innerHTML; | |
| 5483 | } | |
| 5484 | ||
| 5485 | } else if ( nodeName === "input" && rcheckableType.test( src.type ) ) { | |
| 5486 | // IE6-8 fails to persist the checked state of a cloned checkbox | |
| 5487 | // or radio button. Worse, IE6-7 fail to give the cloned element | |
| 5488 | // a checked appearance if the defaultChecked value isn't also set | |
| 5489 | ||
| 5490 | dest.defaultChecked = dest.checked = src.checked; | |
| 5491 | ||
| 5492 | // IE6-7 get confused and end up setting the value of a cloned | |
| 5493 | // checkbox/radio button to an empty string instead of "on" | |
| 5494 | if ( dest.value !== src.value ) { | |
| 5495 | dest.value = src.value; | |
| 5496 | } | |
| 5497 | ||
| 5498 | // IE6-8 fails to return the selected option to the default selected | |
| 5499 | // state when cloning options | |
| 5500 | } else if ( nodeName === "option" ) { | |
| 5501 | dest.defaultSelected = dest.selected = src.defaultSelected; | |
| 5502 | ||
| 5503 | // IE6-8 fails to set the defaultValue to the correct value when | |
| 5504 | // cloning other types of input fields | |
| 5505 | } else if ( nodeName === "input" || nodeName === "textarea" ) { | |
| 5506 | dest.defaultValue = src.defaultValue; | |
| 5507 | } | |
| 5508 | } | |
| 5509 | ||
| 5510 | jQuery.extend({ | |
| 5511 | clone: function( elem, dataAndEvents, deepDataAndEvents ) { | |
| 5512 | var destElements, node, clone, i, srcElements, | |
| 5513 | inPage = jQuery.contains( elem.ownerDocument, elem ); | |
| 5514 | ||
| 5515 | if ( support.html5Clone || jQuery.isXMLDoc(elem) || !rnoshimcache.test( "<" + elem.nodeName + ">" ) ) { | |
| 5516 | clone = elem.cloneNode( true ); | |
| 5517 | ||
| 5518 | // IE<=8 does not properly clone detached, unknown element nodes | |
| 5519 | } else { | |
| 5520 | fragmentDiv.innerHTML = elem.outerHTML; | |
| 5521 | fragmentDiv.removeChild( clone = fragmentDiv.firstChild ); | |
| 5522 | } | |
| 5523 | ||
| 5524 | if ( (!support.noCloneEvent || !support.noCloneChecked) && | |
| 5525 | (elem.nodeType === 1 || elem.nodeType === 11) && !jQuery.isXMLDoc(elem) ) { | |
| 5526 | ||
| 5527 | // We eschew Sizzle here for performance reasons: http://jsperf.com/getall-vs-sizzle/2 | |
| 5528 | destElements = getAll( clone ); | |
| 5529 | srcElements = getAll( elem ); | |
| 5530 | ||
| 5531 | // Fix all IE cloning issues | |
| 5532 | for ( i = 0; (node = srcElements[i]) != null; ++i ) { | |
| 5533 | // Ensure that the destination node is not null; Fixes #9587 | |
| 5534 | if ( destElements[i] ) { | |
| 5535 | fixCloneNodeIssues( node, destElements[i] ); | |
| 5536 | } | |
| 5537 | } | |
| 5538 | } | |
| 5539 | ||
| 5540 | // Copy the events from the original to the clone | |
| 5541 | if ( dataAndEvents ) { | |
| 5542 | if ( deepDataAndEvents ) { | |
| 5543 | srcElements = srcElements || getAll( elem ); | |
| 5544 | destElements = destElements || getAll( clone ); | |
| 5545 | ||
| 5546 | for ( i = 0; (node = srcElements[i]) != null; i++ ) { | |
| 5547 | cloneCopyEvent( node, destElements[i] ); | |
| 5548 | } | |
| 5549 | } else { | |
| 5550 | cloneCopyEvent( elem, clone ); | |
| 5551 | } | |
| 5552 | } | |
| 5553 | ||
| 5554 | // Preserve script evaluation history | |
| 5555 | destElements = getAll( clone, "script" ); | |
| 5556 | if ( destElements.length > 0 ) { | |
| 5557 | setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); | |
| 5558 | } | |
| 5559 | ||
| 5560 | destElements = srcElements = node = null; | |
| 5561 | ||
| 5562 | // Return the cloned set | |
| 5563 | return clone; | |
| 5564 | }, | |
| 5565 | ||
| 5566 | buildFragment: function( elems, context, scripts, selection ) { | |
| 5567 | var j, elem, contains, | |
| 5568 | tmp, tag, tbody, wrap, | |
| 5569 | l = elems.length, | |
| 5570 | ||
| 5571 | // Ensure a safe fragment | |
| 5572 | safe = createSafeFragment( context ), | |
| 5573 | ||
| 5574 | nodes = [], | |
| 5575 | i = 0; | |
| 5576 | ||
| 5577 | for ( ; i < l; i++ ) { | |
| 5578 | elem = elems[ i ]; | |
| 5579 | ||
| 5580 | if ( elem || elem === 0 ) { | |
| 5581 | ||
| 5582 | // Add nodes directly | |
| 5583 | if ( jQuery.type( elem ) === "object" ) { | |
| 5584 | jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); | |
| 5585 | ||
| 5586 | // Convert non-html into a text node | |
| 5587 | } else if ( !rhtml.test( elem ) ) { | |
| 5588 | nodes.push( context.createTextNode( elem ) ); | |
| 5589 | ||
| 5590 | // Convert html into DOM nodes | |
| 5591 | } else { | |
| 5592 | tmp = tmp || safe.appendChild( context.createElement("div") ); | |
| 5593 | ||
| 5594 | // Deserialize a standard representation | |
| 5595 | tag = (rtagName.exec( elem ) || [ "", "" ])[ 1 ].toLowerCase(); | |
| 5596 | wrap = wrapMap[ tag ] || wrapMap._default; | |
| 5597 | ||
| 5598 | tmp.innerHTML = wrap[1] + elem.replace( rxhtmlTag, "<$1></$2>" ) + wrap[2]; | |
| 5599 | ||
| 5600 | // Descend through wrappers to the right content | |
| 5601 | j = wrap[0]; | |
| 5602 | while ( j-- ) { | |
| 5603 | tmp = tmp.lastChild; | |
| 5604 | } | |
| 5605 | ||
| 5606 | // Manually add leading whitespace removed by IE | |
| 5607 | if ( !support.leadingWhitespace && rleadingWhitespace.test( elem ) ) { | |
| 5608 | nodes.push( context.createTextNode( rleadingWhitespace.exec( elem )[0] ) ); | |
| 5609 | } | |
| 5610 | ||
| 5611 | // Remove IE's autoinserted <tbody> from table fragments | |
| 5612 | if ( !support.tbody ) { | |
| 5613 | ||
| 5614 | // String was a <table>, *may* have spurious <tbody> | |
| 5615 | elem = tag === "table" && !rtbody.test( elem ) ? | |
| 5616 | tmp.firstChild : | |
| 5617 | ||
| 5618 | // String was a bare <thead> or <tfoot> | |
| 5619 | wrap[1] === "<table>" && !rtbody.test( elem ) ? | |
| 5620 | tmp : | |
| 5621 | 0; | |
| 5622 | ||
| 5623 | j = elem && elem.childNodes.length; | |
| 5624 | while ( j-- ) { | |
| 5625 | if ( jQuery.nodeName( (tbody = elem.childNodes[j]), "tbody" ) && !tbody.childNodes.length ) { | |
| 5626 | elem.removeChild( tbody ); | |
| 5627 | } | |
| 5628 | } | |
| 5629 | } | |
| 5630 | ||
| 5631 | jQuery.merge( nodes, tmp.childNodes ); | |
| 5632 | ||
| 5633 | // Fix #12392 for WebKit and IE > 9 | |
| 5634 | tmp.textContent = ""; | |
| 5635 | ||
| 5636 | // Fix #12392 for oldIE | |
| 5637 | while ( tmp.firstChild ) { | |
| 5638 | tmp.removeChild( tmp.firstChild ); | |
| 5639 | } | |
| 5640 | ||
| 5641 | // Remember the top-level container for proper cleanup | |
| 5642 | tmp = safe.lastChild; | |
| 5643 | } | |
| 5644 | } | |
| 5645 | } | |
| 5646 | ||
| 5647 | // Fix #11356: Clear elements from fragment | |
| 5648 | if ( tmp ) { | |
| 5649 | safe.removeChild( tmp ); | |
| 5650 | } | |
| 5651 | ||
| 5652 | // Reset defaultChecked for any radios and checkboxes | |
| 5653 | // about to be appended to the DOM in IE 6/7 (#8060) | |
| 5654 | if ( !support.appendChecked ) { | |
| 5655 | jQuery.grep( getAll( nodes, "input" ), fixDefaultChecked ); | |
| 5656 | } | |
| 5657 | ||
| 5658 | i = 0; | |
| 5659 | while ( (elem = nodes[ i++ ]) ) { | |
| 5660 | ||
| 5661 | // #4087 - If origin and destination elements are the same, and this is | |
| 5662 | // that element, do not do anything | |
| 5663 | if ( selection && jQuery.inArray( elem, selection ) !== -1 ) { | |
| 5664 | continue; | |
| 5665 | } | |
| 5666 | ||
| 5667 | contains = jQuery.contains( elem.ownerDocument, elem ); | |
| 5668 | ||
| 5669 | // Append to fragment | |
| 5670 | tmp = getAll( safe.appendChild( elem ), "script" ); | |
| 5671 | ||
| 5672 | // Preserve script evaluation history | |
| 5673 | if ( contains ) { | |
| 5674 | setGlobalEval( tmp ); | |
| 5675 | } | |
| 5676 | ||
| 5677 | // Capture executables | |
| 5678 | if ( scripts ) { | |
| 5679 | j = 0; | |
| 5680 | while ( (elem = tmp[ j++ ]) ) { | |
| 5681 | if ( rscriptType.test( elem.type || "" ) ) { | |
| 5682 | scripts.push( elem ); | |
| 5683 | } | |
| 5684 | } | |
| 5685 | } | |
| 5686 | } | |
| 5687 | ||
| 5688 | tmp = null; | |
| 5689 | ||
| 5690 | return safe; | |
| 5691 | }, | |
| 5692 | ||
| 5693 | cleanData: function( elems, /* internal */ acceptData ) { | |
| 5694 | var elem, type, id, data, | |
| 5695 | i = 0, | |
| 5696 | internalKey = jQuery.expando, | |
| 5697 | cache = jQuery.cache, | |
| 5698 | deleteExpando = support.deleteExpando, | |
| 5699 | special = jQuery.event.special; | |
| 5700 | ||
| 5701 | for ( ; (elem = elems[i]) != null; i++ ) { | |
| 5702 | if ( acceptData || jQuery.acceptData( elem ) ) { | |
| 5703 | ||
| 5704 | id = elem[ internalKey ]; | |
| 5705 | data = id && cache[ id ]; | |
| 5706 | ||
| 5707 | if ( data ) { | |
| 5708 | if ( data.events ) { | |
| 5709 | for ( type in data.events ) { | |
| 5710 | if ( special[ type ] ) { | |
| 5711 | jQuery.event.remove( elem, type ); | |
| 5712 | ||
| 5713 | // This is a shortcut to avoid jQuery.event.remove's overhead | |
| 5714 | } else { | |
| 5715 | jQuery.removeEvent( elem, type, data.handle ); | |
| 5716 | } | |
| 5717 | } | |
| 5718 | } | |
| 5719 | ||
| 5720 | // Remove cache only if it was not already removed by jQuery.event.remove | |
| 5721 | if ( cache[ id ] ) { | |
| 5722 | ||
| 5723 | delete cache[ id ]; | |
| 5724 | ||
| 5725 | // IE does not allow us to delete expando properties from nodes, | |
| 5726 | // nor does it have a removeAttribute function on Document nodes; | |
| 5727 | // we must handle all of these cases | |
| 5728 | if ( deleteExpando ) { | |
| 5729 | delete elem[ internalKey ]; | |
| 5730 | ||
| 5731 | } else if ( typeof elem.removeAttribute !== strundefined ) { | |
| 5732 | elem.removeAttribute( internalKey ); | |
| 5733 | ||
| 5734 | } else { | |
| 5735 | elem[ internalKey ] = null; | |
| 5736 | } | |
| 5737 | ||
| 5738 | deletedIds.push( id ); | |
| 5739 | } | |
| 5740 | } | |
| 5741 | } | |
| 5742 | } | |
| 5743 | } | |
| 5744 | }); | |
| 5745 | ||
| 5746 | jQuery.fn.extend({ | |
| 5747 | text: function( value ) { | |
| 5748 | return access( this, function( value ) { | |
| 5749 | return value === undefined ? | |
| 5750 | jQuery.text( this ) : | |
| 5751 | this.empty().append( ( this[0] && this[0].ownerDocument || document ).createTextNode( value ) ); | |
| 5752 | }, null, value, arguments.length ); | |
| 5753 | }, | |
| 5754 | ||
| 5755 | append: function() { | |
| 5756 | return this.domManip( arguments, function( elem ) { | |
| 5757 | if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { | |
| 5758 | var target = manipulationTarget( this, elem ); | |
| 5759 | target.appendChild( elem ); | |
| 5760 | } | |
| 5761 | }); | |
| 5762 | }, | |
| 5763 | ||
| 5764 | prepend: function() { | |
| 5765 | return this.domManip( arguments, function( elem ) { | |
| 5766 | if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { | |
| 5767 | var target = manipulationTarget( this, elem ); | |
| 5768 | target.insertBefore( elem, target.firstChild ); | |
| 5769 | } | |
| 5770 | }); | |
| 5771 | }, | |
| 5772 | ||
| 5773 | before: function() { | |
| 5774 | return this.domManip( arguments, function( elem ) { | |
| 5775 | if ( this.parentNode ) { | |
| 5776 | this.parentNode.insertBefore( elem, this ); | |
| 5777 | } | |
| 5778 | }); | |
| 5779 | }, | |
| 5780 | ||
| 5781 | after: function() { | |
| 5782 | return this.domManip( arguments, function( elem ) { | |
| 5783 | if ( this.parentNode ) { | |
| 5784 | this.parentNode.insertBefore( elem, this.nextSibling ); | |
| 5785 | } | |
| 5786 | }); | |
| 5787 | }, | |
| 5788 | ||
| 5789 | remove: function( selector, keepData /* Internal Use Only */ ) { | |
| 5790 | var elem, | |
| 5791 | elems = selector ? jQuery.filter( selector, this ) : this, | |
| 5792 | i = 0; | |
| 5793 | ||
| 5794 | for ( ; (elem = elems[i]) != null; i++ ) { | |
| 5795 | ||
| 5796 | if ( !keepData && elem.nodeType === 1 ) { | |
| 5797 | jQuery.cleanData( getAll( elem ) ); | |
| 5798 | } | |
| 5799 | ||
| 5800 | if ( elem.parentNode ) { | |
| 5801 | if ( keepData && jQuery.contains( elem.ownerDocument, elem ) ) { | |
| 5802 | setGlobalEval( getAll( elem, "script" ) ); | |
| 5803 | } | |
| 5804 | elem.parentNode.removeChild( elem ); | |
| 5805 | } | |
| 5806 | } | |
| 5807 | ||
| 5808 | return this; | |
| 5809 | }, | |
| 5810 | ||
| 5811 | empty: function() { | |
| 5812 | var elem, | |
| 5813 | i = 0; | |
| 5814 | ||
| 5815 | for ( ; (elem = this[i]) != null; i++ ) { | |
| 5816 | // Remove element nodes and prevent memory leaks | |
| 5817 | if ( elem.nodeType === 1 ) { | |
| 5818 | jQuery.cleanData( getAll( elem, false ) ); | |
| 5819 | } | |
| 5820 | ||
| 5821 | // Remove any remaining nodes | |
| 5822 | while ( elem.firstChild ) { | |
| 5823 | elem.removeChild( elem.firstChild ); | |
| 5824 | } | |
| 5825 | ||
| 5826 | // If this is a select, ensure that it displays empty (#12336) | |
| 5827 | // Support: IE<9 | |
| 5828 | if ( elem.options && jQuery.nodeName( elem, "select" ) ) { | |
| 5829 | elem.options.length = 0; | |
| 5830 | } | |
| 5831 | } | |
| 5832 | ||
| 5833 | return this; | |
| 5834 | }, | |
| 5835 | ||
| 5836 | clone: function( dataAndEvents, deepDataAndEvents ) { | |
| 5837 | dataAndEvents = dataAndEvents == null ? false : dataAndEvents; | |
| 5838 | deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; | |
| 5839 | ||
| 5840 | return this.map(function() { | |
| 5841 | return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); | |
| 5842 | }); | |
| 5843 | }, | |
| 5844 | ||
| 5845 | html: function( value ) { | |
| 5846 | return access( this, function( value ) { | |
| 5847 | var elem = this[ 0 ] || {}, | |
| 5848 | i = 0, | |
| 5849 | l = this.length; | |
| 5850 | ||
| 5851 | if ( value === undefined ) { | |
| 5852 | return elem.nodeType === 1 ? | |
| 5853 | elem.innerHTML.replace( rinlinejQuery, "" ) : | |
| 5854 | undefined; | |
| 5855 | } | |
| 5856 | ||
| 5857 | // See if we can take a shortcut and just use innerHTML | |
| 5858 | if ( typeof value === "string" && !rnoInnerhtml.test( value ) && | |
| 5859 | ( support.htmlSerialize || !rnoshimcache.test( value ) ) && | |
| 5860 | ( support.leadingWhitespace || !rleadingWhitespace.test( value ) ) && | |
| 5861 | !wrapMap[ (rtagName.exec( value ) || [ "", "" ])[ 1 ].toLowerCase() ] ) { | |
| 5862 | ||
| 5863 | value = value.replace( rxhtmlTag, "<$1></$2>" ); | |
| 5864 | ||
| 5865 | try { | |
| 5866 | for (; i < l; i++ ) { | |
| 5867 | // Remove element nodes and prevent memory leaks | |
| 5868 | elem = this[i] || {}; | |
| 5869 | if ( elem.nodeType === 1 ) { | |
| 5870 | jQuery.cleanData( getAll( elem, false ) ); | |
| 5871 | elem.innerHTML = value; | |
| 5872 | } | |
| 5873 | } | |
| 5874 | ||
| 5875 | elem = 0; | |
| 5876 | ||
| 5877 | // If using innerHTML throws an exception, use the fallback method | |
| 5878 | } catch(e) {} | |
| 5879 | } | |
| 5880 | ||
| 5881 | if ( elem ) { | |
| 5882 | this.empty().append( value ); | |
| 5883 | } | |
| 5884 | }, null, value, arguments.length ); | |
| 5885 | }, | |
| 5886 | ||
| 5887 | replaceWith: function() { | |
| 5888 | var arg = arguments[ 0 ]; | |
| 5889 | ||
| 5890 | // Make the changes, replacing each context element with the new content | |
| 5891 | this.domManip( arguments, function( elem ) { | |
| 5892 | arg = this.parentNode; | |
| 5893 | ||
| 5894 | jQuery.cleanData( getAll( this ) ); | |
| 5895 | ||
| 5896 | if ( arg ) { | |
| 5897 | arg.replaceChild( elem, this ); | |
| 5898 | } | |
| 5899 | }); | |
| 5900 | ||
| 5901 | // Force removal if there was no new content (e.g., from empty arguments) | |
| 5902 | return arg && (arg.length || arg.nodeType) ? this : this.remove(); | |
| 5903 | }, | |
| 5904 | ||
| 5905 | detach: function( selector ) { | |
| 5906 | return this.remove( selector, true ); | |
| 5907 | }, | |
| 5908 | ||
| 5909 | domManip: function( args, callback ) { | |
| 5910 | ||
| 5911 | // Flatten any nested arrays | |
| 5912 | args = concat.apply( [], args ); | |
| 5913 | ||
| 5914 | var first, node, hasScripts, | |
| 5915 | scripts, doc, fragment, | |
| 5916 | i = 0, | |
| 5917 | l = this.length, | |
| 5918 | set = this, | |
| 5919 | iNoClone = l - 1, | |
| 5920 | value = args[0], | |
| 5921 | isFunction = jQuery.isFunction( value ); | |
| 5922 | ||
| 5923 | // We can't cloneNode fragments that contain checked, in WebKit | |
| 5924 | if ( isFunction || | |
| 5925 | ( l > 1 && typeof value === "string" && | |
| 5926 | !support.checkClone && rchecked.test( value ) ) ) { | |
| 5927 | return this.each(function( index ) { | |
| 5928 | var self = set.eq( index ); | |
| 5929 | if ( isFunction ) { | |
| 5930 | args[0] = value.call( this, index, self.html() ); | |
| 5931 | } | |
| 5932 | self.domManip( args, callback ); | |
| 5933 | }); | |
| 5934 | } | |
| 5935 | ||
| 5936 | if ( l ) { | |
| 5937 | fragment = jQuery.buildFragment( args, this[ 0 ].ownerDocument, false, this ); | |
| 5938 | first = fragment.firstChild; | |
| 5939 | ||
| 5940 | if ( fragment.childNodes.length === 1 ) { | |
| 5941 | fragment = first; | |
| 5942 | } | |
| 5943 | ||
| 5944 | if ( first ) { | |
| 5945 | scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); | |
| 5946 | hasScripts = scripts.length; | |
| 5947 | ||
| 5948 | // Use the original fragment for the last item instead of the first because it can end up | |
| 5949 | // being emptied incorrectly in certain situations (#8070). | |
| 5950 | for ( ; i < l; i++ ) { | |
| 5951 | node = fragment; | |
| 5952 | ||
| 5953 | if ( i !== iNoClone ) { | |
| 5954 | node = jQuery.clone( node, true, true ); | |
| 5955 | ||
| 5956 | // Keep references to cloned scripts for later restoration | |
| 5957 | if ( hasScripts ) { | |
| 5958 | jQuery.merge( scripts, getAll( node, "script" ) ); | |
| 5959 | } | |
| 5960 | } | |
| 5961 | ||
| 5962 | callback.call( this[i], node, i ); | |
| 5963 | } | |
| 5964 | ||
| 5965 | if ( hasScripts ) { | |
| 5966 | doc = scripts[ scripts.length - 1 ].ownerDocument; | |
| 5967 | ||
| 5968 | // Reenable scripts | |
| 5969 | jQuery.map( scripts, restoreScript ); | |
| 5970 | ||
| 5971 | // Evaluate executable scripts on first document insertion | |
| 5972 | for ( i = 0; i < hasScripts; i++ ) { | |
| 5973 | node = scripts[ i ]; | |
| 5974 | if ( rscriptType.test( node.type || "" ) && | |
| 5975 | !jQuery._data( node, "globalEval" ) && jQuery.contains( doc, node ) ) { | |
| 5976 | ||
| 5977 | if ( node.src ) { | |
| 5978 | // Optional AJAX dependency, but won't run scripts if not present | |
| 5979 | if ( jQuery._evalUrl ) { | |
| 5980 | jQuery._evalUrl( node.src ); | |
| 5981 | } | |
| 5982 | } else { | |
| 5983 | jQuery.globalEval( ( node.text || node.textContent || node.innerHTML || "" ).replace( rcleanScript, "" ) ); | |
| 5984 | } | |
| 5985 | } | |
| 5986 | } | |
| 5987 | } | |
| 5988 | ||
| 5989 | // Fix #11809: Avoid leaking memory | |
| 5990 | fragment = first = null; | |
| 5991 | } | |
| 5992 | } | |
| 5993 | ||
| 5994 | return this; | |
| 5995 | } | |
| 5996 | }); | |
| 5997 | ||
| 5998 | jQuery.each({ | |
| 5999 | appendTo: "append", | |
| 6000 | prependTo: "prepend", | |
| 6001 | insertBefore: "before", | |
| 6002 | insertAfter: "after", | |
| 6003 | replaceAll: "replaceWith" | |
| 6004 | }, function( name, original ) { | |
| 6005 | jQuery.fn[ name ] = function( selector ) { | |
| 6006 | var elems, | |
| 6007 | i = 0, | |
| 6008 | ret = [], | |
| 6009 | insert = jQuery( selector ), | |
| 6010 | last = insert.length - 1; | |
| 6011 | ||
| 6012 | for ( ; i <= last; i++ ) { | |
| 6013 | elems = i === last ? this : this.clone(true); | |
| 6014 | jQuery( insert[i] )[ original ]( elems ); | |
| 6015 | ||
| 6016 | // Modern browsers can apply jQuery collections as arrays, but oldIE needs a .get() | |
| 6017 | push.apply( ret, elems.get() ); | |
| 6018 | } | |
| 6019 | ||
| 6020 | return this.pushStack( ret ); | |
| 6021 | }; | |
| 6022 | }); | |
| 6023 | ||
| 6024 | ||
| 6025 | var iframe, | |
| 6026 | elemdisplay = {}; | |
| 6027 | ||
| 6028 | /** | |
| 6029 | * Retrieve the actual display of a element | |
| 6030 | * @param {String} name nodeName of the element | |
| 6031 | * @param {Object} doc Document object | |
| 6032 | */ | |
| 6033 | // Called only from within defaultDisplay | |
| 6034 | function actualDisplay( name, doc ) { | |
| 6035 | var style, | |
| 6036 | elem = jQuery( doc.createElement( name ) ).appendTo( doc.body ), | |
| 6037 | ||
| 6038 | // getDefaultComputedStyle might be reliably used only on attached element | |
| 6039 | display = window.getDefaultComputedStyle && ( style = window.getDefaultComputedStyle( elem[ 0 ] ) ) ? | |
| 6040 | ||
| 6041 | // Use of this method is a temporary fix (more like optmization) until something better comes along, | |
| 6042 | // since it was removed from specification and supported only in FF | |
| 6043 | style.display : jQuery.css( elem[ 0 ], "display" ); | |
| 6044 | ||
| 6045 | // We don't have any data stored on the element, | |
| 6046 | // so use "detach" method as fast way to get rid of the element | |
| 6047 | elem.detach(); | |
| 6048 | ||
| 6049 | return display; | |
| 6050 | } | |
| 6051 | ||
| 6052 | /** | |
| 6053 | * Try to determine the default display value of an element | |
| 6054 | * @param {String} nodeName | |
| 6055 | */ | |
| 6056 | function defaultDisplay( nodeName ) { | |
| 6057 | var doc = document, | |
| 6058 | display = elemdisplay[ nodeName ]; | |
| 6059 | ||
| 6060 | if ( !display ) { | |
| 6061 | display = actualDisplay( nodeName, doc ); | |
| 6062 | ||
| 6063 | // If the simple way fails, read from inside an iframe | |
| 6064 | if ( display === "none" || !display ) { | |
| 6065 | ||
| 6066 | // Use the already-created iframe if possible | |
| 6067 | iframe = (iframe || jQuery( "<iframe frameborder='0' width='0' height='0'/>" )).appendTo( doc.documentElement ); | |
| 6068 | ||
| 6069 | // Always write a new HTML skeleton so Webkit and Firefox don't choke on reuse | |
| 6070 | doc = ( iframe[ 0 ].contentWindow || iframe[ 0 ].contentDocument ).document; | |
| 6071 | ||
| 6072 | // Support: IE | |
| 6073 | doc.write(); | |
| 6074 | doc.close(); | |
| 6075 | ||
| 6076 | display = actualDisplay( nodeName, doc ); | |
| 6077 | iframe.detach(); | |
| 6078 | } | |
| 6079 | ||
| 6080 | // Store the correct default display | |
| 6081 | elemdisplay[ nodeName ] = display; | |
| 6082 | } | |
| 6083 | ||
| 6084 | return display; | |
| 6085 | } | |
| 6086 | ||
| 6087 | ||
| 6088 | (function() { | |
| 6089 | var shrinkWrapBlocksVal; | |
| 6090 | ||
| 6091 | support.shrinkWrapBlocks = function() { | |
| 6092 | if ( shrinkWrapBlocksVal != null ) { | |
| 6093 | return shrinkWrapBlocksVal; | |
| 6094 | } | |
| 6095 | ||
| 6096 | // Will be changed later if needed. | |
| 6097 | shrinkWrapBlocksVal = false; | |
| 6098 | ||
| 6099 | // Minified: var b,c,d | |
| 6100 | var div, body, container; | |
| 6101 | ||
| 6102 | body = document.getElementsByTagName( "body" )[ 0 ]; | |
| 6103 | if ( !body || !body.style ) { | |
| 6104 | // Test fired too early or in an unsupported environment, exit. | |
| 6105 | return; | |
| 6106 | } | |
| 6107 | ||
| 6108 | // Setup | |
| 6109 | div = document.createElement( "div" ); | |
| 6110 | container = document.createElement( "div" ); | |
| 6111 | container.style.cssText = "position:absolute;border:0;width:0;height:0;top:0;left:-9999px"; | |
| 6112 | body.appendChild( container ).appendChild( div ); | |
| 6113 | ||
| 6114 | // Support: IE6 | |
| 6115 | // Check if elements with layout shrink-wrap their children | |
| 6116 | if ( typeof div.style.zoom !== strundefined ) { | |
| 6117 | // Reset CSS: box-sizing; display; margin; border | |
| 6118 | div.style.cssText = | |
| 6119 | // Support: Firefox<29, Android 2.3 | |
| 6120 | // Vendor-prefix box-sizing | |
| 6121 | "-webkit-box-sizing:content-box;-moz-box-sizing:content-box;" + | |
| 6122 | "box-sizing:content-box;display:block;margin:0;border:0;" + | |
| 6123 | "padding:1px;width:1px;zoom:1"; | |
| 6124 | div.appendChild( document.createElement( "div" ) ).style.width = "5px"; | |
| 6125 | shrinkWrapBlocksVal = div.offsetWidth !== 3; | |
| 6126 | } | |
| 6127 | ||
| 6128 | body.removeChild( container ); | |
| 6129 | ||
| 6130 | return shrinkWrapBlocksVal; | |
| 6131 | }; | |
| 6132 | ||
| 6133 | })(); | |
| 6134 | var rmargin = (/^margin/); | |
| 6135 | ||
| 6136 | var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); | |
| 6137 | ||
| 6138 | ||
| 6139 | ||
| 6140 | var getStyles, curCSS, | |
| 6141 | rposition = /^(top|right|bottom|left)$/; | |
| 6142 | ||
| 6143 | if ( window.getComputedStyle ) { | |
| 6144 | getStyles = function( elem ) { | |
| 6145 | // Support: IE<=11+, Firefox<=30+ (#15098, #14150) | |
| 6146 | // IE throws on elements created in popups | |
| 6147 | // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" | |
| 6148 | if ( elem.ownerDocument.defaultView.opener ) { | |
| 6149 | return elem.ownerDocument.defaultView.getComputedStyle( elem, null ); | |
| 6150 | } | |
| 6151 | ||
| 6152 | return window.getComputedStyle( elem, null ); | |
| 6153 | }; | |
| 6154 | ||
| 6155 | curCSS = function( elem, name, computed ) { | |
| 6156 | var width, minWidth, maxWidth, ret, | |
| 6157 | style = elem.style; | |
| 6158 | ||
| 6159 | computed = computed || getStyles( elem ); | |
| 6160 | ||
| 6161 | // getPropertyValue is only needed for .css('filter') in IE9, see #12537 | |
| 6162 | ret = computed ? computed.getPropertyValue( name ) || computed[ name ] : undefined; | |
| 6163 | ||
| 6164 | if ( computed ) { | |
| 6165 | ||
| 6166 | if ( ret === "" && !jQuery.contains( elem.ownerDocument, elem ) ) { | |
| 6167 | ret = jQuery.style( elem, name ); | |
| 6168 | } | |
| 6169 | ||
| 6170 | // A tribute to the "awesome hack by Dean Edwards" | |
| 6171 | // Chrome < 17 and Safari 5.0 uses "computed value" instead of "used value" for margin-right | |
| 6172 | // Safari 5.1.7 (at least) returns percentage for a larger set of values, but width seems to be reliably pixels | |
| 6173 | // this is against the CSSOM draft spec: http://dev.w3.org/csswg/cssom/#resolved-values | |
| 6174 | if ( rnumnonpx.test( ret ) && rmargin.test( name ) ) { | |
| 6175 | ||
| 6176 | // Remember the original values | |
| 6177 | width = style.width; | |
| 6178 | minWidth = style.minWidth; | |
| 6179 | maxWidth = style.maxWidth; | |
| 6180 | ||
| 6181 | // Put in the new values to get a computed value out | |
| 6182 | style.minWidth = style.maxWidth = style.width = ret; | |
| 6183 | ret = computed.width; | |
| 6184 | ||
| 6185 | // Revert the changed values | |
| 6186 | style.width = width; | |
| 6187 | style.minWidth = minWidth; | |
| 6188 | style.maxWidth = maxWidth; | |
| 6189 | } | |
| 6190 | } | |
| 6191 | ||
| 6192 | // Support: IE | |
| 6193 | // IE returns zIndex value as an integer. | |
| 6194 | return ret === undefined ? | |
| 6195 | ret : | |
| 6196 | ret + ""; | |
| 6197 | }; | |
| 6198 | } else if ( document.documentElement.currentStyle ) { | |
| 6199 | getStyles = function( elem ) { | |
| 6200 | return elem.currentStyle; | |
| 6201 | }; | |
| 6202 | ||
| 6203 | curCSS = function( elem, name, computed ) { | |
| 6204 | var left, rs, rsLeft, ret, | |
| 6205 | style = elem.style; | |
| 6206 | ||
| 6207 | computed = computed || getStyles( elem ); | |
| 6208 | ret = computed ? computed[ name ] : undefined; | |
| 6209 | ||
| 6210 | // Avoid setting ret to empty string here | |
| 6211 | // so we don't default to auto | |
| 6212 | if ( ret == null && style && style[ name ] ) { | |
| 6213 | ret = style[ name ]; | |
| 6214 | } | |
| 6215 | ||
| 6216 | // From the awesome hack by Dean Edwards | |
| 6217 | // http://erik.eae.net/archives/2007/07/27/18.54.15/#comment-102291 | |
| 6218 | ||
| 6219 | // If we're not dealing with a regular pixel number | |
| 6220 | // but a number that has a weird ending, we need to convert it to pixels | |
| 6221 | // but not position css attributes, as those are proportional to the parent element instead | |
| 6222 | // and we can't measure the parent instead because it might trigger a "stacking dolls" problem | |
| 6223 | if ( rnumnonpx.test( ret ) && !rposition.test( name ) ) { | |
| 6224 | ||
| 6225 | // Remember the original values | |
| 6226 | left = style.left; | |
| 6227 | rs = elem.runtimeStyle; | |
| 6228 | rsLeft = rs && rs.left; | |
| 6229 | ||
| 6230 | // Put in the new values to get a computed value out | |
| 6231 | if ( rsLeft ) { | |
| 6232 | rs.left = elem.currentStyle.left; | |
| 6233 | } | |
| 6234 | style.left = name === "fontSize" ? "1em" : ret; | |
| 6235 | ret = style.pixelLeft + "px"; | |
| 6236 | ||
| 6237 | // Revert the changed values | |
| 6238 | style.left = left; | |
| 6239 | if ( rsLeft ) { | |
| 6240 | rs.left = rsLeft; | |
| 6241 | } | |
| 6242 | } | |
| 6243 | ||
| 6244 | // Support: IE | |
| 6245 | // IE returns zIndex value as an integer. | |
| 6246 | return ret === undefined ? | |
| 6247 | ret : | |
| 6248 | ret + "" || "auto"; | |
| 6249 | }; | |
| 6250 | } | |
| 6251 | ||
| 6252 | ||
| 6253 | ||
| 6254 | ||
| 6255 | function addGetHookIf( conditionFn, hookFn ) { | |
| 6256 | // Define the hook, we'll check on the first run if it's really needed. | |
| 6257 | return { | |
| 6258 | get: function() { | |
| 6259 | var condition = conditionFn(); | |
| 6260 | ||
| 6261 | if ( condition == null ) { | |
| 6262 | // The test was not ready at this point; screw the hook this time | |
| 6263 | // but check again when needed next time. | |
| 6264 | return; | |
| 6265 | } | |
| 6266 | ||
| 6267 | if ( condition ) { | |
| 6268 | // Hook not needed (or it's not possible to use it due to missing dependency), | |
| 6269 | // remove it. | |
| 6270 | // Since there are no other hooks for marginRight, remove the whole object. | |
| 6271 | delete this.get; | |
| 6272 | return; | |
| 6273 | } | |
| 6274 | ||
| 6275 | // Hook needed; redefine it so that the support test is not executed again. | |
| 6276 | ||
| 6277 | return (this.get = hookFn).apply( this, arguments ); | |
| 6278 | } | |
| 6279 | }; | |
| 6280 | } | |
| 6281 | ||
| 6282 | ||
| 6283 | (function() { | |
| 6284 | // Minified: var b,c,d,e,f,g, h,i | |
| 6285 | var div, style, a, pixelPositionVal, boxSizingReliableVal, | |
| 6286 | reliableHiddenOffsetsVal, reliableMarginRightVal; | |
| 6287 | ||
| 6288 | // Setup | |
| 6289 | div = document.createElement( "div" ); | |
| 6290 | div.innerHTML = " <link/><table></table><a href='/a'>a</a><input type='checkbox'/>"; | |
| 6291 | a = div.getElementsByTagName( "a" )[ 0 ]; | |
| 6292 | style = a && a.style; | |
| 6293 | ||
| 6294 | // Finish early in limited (non-browser) environments | |
| 6295 | if ( !style ) { | |
| 6296 | return; | |
| 6297 | } | |
| 6298 | ||
| 6299 | style.cssText = "float:left;opacity:.5"; | |
| 6300 | ||
| 6301 | // Support: IE<9 | |
| 6302 | // Make sure that element opacity exists (as opposed to filter) | |
| 6303 | support.opacity = style.opacity === "0.5"; | |
| 6304 | ||
| 6305 | // Verify style float existence | |
| 6306 | // (IE uses styleFloat instead of cssFloat) | |
| 6307 | support.cssFloat = !!style.cssFloat; | |
| 6308 | ||
| 6309 | div.style.backgroundClip = "content-box"; | |
| 6310 | div.cloneNode( true ).style.backgroundClip = ""; | |
| 6311 | support.clearCloneStyle = div.style.backgroundClip === "content-box"; | |
| 6312 | ||
| 6313 | // Support: Firefox<29, Android 2.3 | |
| 6314 | // Vendor-prefix box-sizing | |
| 6315 | support.boxSizing = style.boxSizing === "" || style.MozBoxSizing === "" || | |
| 6316 | style.WebkitBoxSizing === ""; | |
| 6317 | ||
| 6318 | jQuery.extend(support, { | |
| 6319 | reliableHiddenOffsets: function() { | |
| 6320 | if ( reliableHiddenOffsetsVal == null ) { | |
| 6321 | computeStyleTests(); | |
| 6322 | } | |
| 6323 | return reliableHiddenOffsetsVal; | |
| 6324 | }, | |
| 6325 | ||
| 6326 | boxSizingReliable: function() { | |
| 6327 | if ( boxSizingReliableVal == null ) { | |
| 6328 | computeStyleTests(); | |
| 6329 | } | |
| 6330 | return boxSizingReliableVal; | |
| 6331 | }, | |
| 6332 | ||
| 6333 | pixelPosition: function() { | |
| 6334 | if ( pixelPositionVal == null ) { | |
| 6335 | computeStyleTests(); | |
| 6336 | } | |
| 6337 | return pixelPositionVal; | |
| 6338 | }, | |
| 6339 | ||
| 6340 | // Support: Android 2.3 | |
| 6341 | reliableMarginRight: function() { | |
| 6342 | if ( reliableMarginRightVal == null ) { | |
| 6343 | computeStyleTests(); | |
| 6344 | } | |
| 6345 | return reliableMarginRightVal; | |
| 6346 | } | |
| 6347 | }); | |
| 6348 | ||
| 6349 | function computeStyleTests() { | |
| 6350 | // Minified: var b,c,d,j | |
| 6351 | var div, body, container, contents; | |
| 6352 | ||
| 6353 | body = document.getElementsByTagName( "body" )[ 0 ]; | |
| 6354 | if ( !body || !body.style ) { | |
| 6355 | // Test fired too early or in an unsupported environment, exit. | |
| 6356 | return; | |
| 6357 | } | |
| 6358 | ||
| 6359 | // Setup | |
| 6360 | div = document.createElement( "div" ); | |
| 6361 | container = document.createElement( "div" ); | |
| 6362 | container.style.cssText = "position:absolute;border:0;width:0;height:0;top:0;left:-9999px"; | |
| 6363 | body.appendChild( container ).appendChild( div ); | |
| 6364 | ||
| 6365 | div.style.cssText = | |
| 6366 | // Support: Firefox<29, Android 2.3 | |
| 6367 | // Vendor-prefix box-sizing | |
| 6368 | "-webkit-box-sizing:border-box;-moz-box-sizing:border-box;" + | |
| 6369 | "box-sizing:border-box;display:block;margin-top:1%;top:1%;" + | |
| 6370 | "border:1px;padding:1px;width:4px;position:absolute"; | |
| 6371 | ||
| 6372 | // Support: IE<9 | |
| 6373 | // Assume reasonable values in the absence of getComputedStyle | |
| 6374 | pixelPositionVal = boxSizingReliableVal = false; | |
| 6375 | reliableMarginRightVal = true; | |
| 6376 | ||
| 6377 | // Check for getComputedStyle so that this code is not run in IE<9. | |
| 6378 | if ( window.getComputedStyle ) { | |
| 6379 | pixelPositionVal = ( window.getComputedStyle( div, null ) || {} ).top !== "1%"; | |
| 6380 | boxSizingReliableVal = | |
| 6381 | ( window.getComputedStyle( div, null ) || { width: "4px" } ).width === "4px"; | |
| 6382 | ||
| 6383 | // Support: Android 2.3 | |
| 6384 | // Div with explicit width and no margin-right incorrectly | |
| 6385 | // gets computed margin-right based on width of container (#3333) | |
| 6386 | // WebKit Bug 13343 - getComputedStyle returns wrong value for margin-right | |
| 6387 | contents = div.appendChild( document.createElement( "div" ) ); | |
| 6388 | ||
| 6389 | // Reset CSS: box-sizing; display; margin; border; padding | |
| 6390 | contents.style.cssText = div.style.cssText = | |
| 6391 | // Support: Firefox<29, Android 2.3 | |
| 6392 | // Vendor-prefix box-sizing | |
| 6393 | "-webkit-box-sizing:content-box;-moz-box-sizing:content-box;" + | |
| 6394 | "box-sizing:content-box;display:block;margin:0;border:0;padding:0"; | |
| 6395 | contents.style.marginRight = contents.style.width = "0"; | |
| 6396 | div.style.width = "1px"; | |
| 6397 | ||
| 6398 | reliableMarginRightVal = | |
| 6399 | !parseFloat( ( window.getComputedStyle( contents, null ) || {} ).marginRight ); | |
| 6400 | ||
| 6401 | div.removeChild( contents ); | |
| 6402 | } | |
| 6403 | ||
| 6404 | // Support: IE8 | |
| 6405 | // Check if table cells still have offsetWidth/Height when they are set | |
| 6406 | // to display:none and there are still other visible table cells in a | |
| 6407 | // table row; if so, offsetWidth/Height are not reliable for use when | |
| 6408 | // determining if an element has been hidden directly using | |
| 6409 | // display:none (it is still safe to use offsets if a parent element is | |
| 6410 | // hidden; don safety goggles and see bug #4512 for more information). | |
| 6411 | div.innerHTML = "<table><tr><td></td><td>t</td></tr></table>"; | |
| 6412 | contents = div.getElementsByTagName( "td" ); | |
| 6413 | contents[ 0 ].style.cssText = "margin:0;border:0;padding:0;display:none"; | |
| 6414 | reliableHiddenOffsetsVal = contents[ 0 ].offsetHeight === 0; | |
| 6415 | if ( reliableHiddenOffsetsVal ) { | |
| 6416 | contents[ 0 ].style.display = ""; | |
| 6417 | contents[ 1 ].style.display = "none"; | |
| 6418 | reliableHiddenOffsetsVal = contents[ 0 ].offsetHeight === 0; | |
| 6419 | } | |
| 6420 | ||
| 6421 | body.removeChild( container ); | |
| 6422 | } | |
| 6423 | ||
| 6424 | })(); | |
| 6425 | ||
| 6426 | ||
| 6427 | // A method for quickly swapping in/out CSS properties to get correct calculations. | |
| 6428 | jQuery.swap = function( elem, options, callback, args ) { | |
| 6429 | var ret, name, | |
| 6430 | old = {}; | |
| 6431 | ||
| 6432 | // Remember the old values, and insert the new ones | |
| 6433 | for ( name in options ) { | |
| 6434 | old[ name ] = elem.style[ name ]; | |
| 6435 | elem.style[ name ] = options[ name ]; | |
| 6436 | } | |
| 6437 | ||
| 6438 | ret = callback.apply( elem, args || [] ); | |
| 6439 | ||
| 6440 | // Revert the old values | |
| 6441 | for ( name in options ) { | |
| 6442 | elem.style[ name ] = old[ name ]; | |
| 6443 | } | |
| 6444 | ||
| 6445 | return ret; | |
| 6446 | }; | |
| 6447 | ||
| 6448 | ||
| 6449 | var | |
| 6450 | ralpha = /alpha\([^)]*\)/i, | |
| 6451 | ropacity = /opacity\s*=\s*([^)]*)/, | |
| 6452 | ||
| 6453 | // swappable if display is none or starts with table except "table", "table-cell", or "table-caption" | |
| 6454 | // see here for display values: https://developer.mozilla.org/en-US/docs/CSS/display | |
| 6455 | rdisplayswap = /^(none|table(?!-c[ea]).+)/, | |
| 6456 | rnumsplit = new RegExp( "^(" + pnum + ")(.*)$", "i" ), | |
| 6457 | rrelNum = new RegExp( "^([+-])=(" + pnum + ")", "i" ), | |
| 6458 | ||
| 6459 | cssShow = { position: "absolute", visibility: "hidden", display: "block" }, | |
| 6460 | cssNormalTransform = { | |
| 6461 | letterSpacing: "0", | |
| 6462 | fontWeight: "400" | |
| 6463 | }, | |
| 6464 | ||
| 6465 | cssPrefixes = [ "Webkit", "O", "Moz", "ms" ]; | |
| 6466 | ||
| 6467 | ||
| 6468 | // return a css property mapped to a potentially vendor prefixed property | |
| 6469 | function vendorPropName( style, name ) { | |
| 6470 | ||
| 6471 | // shortcut for names that are not vendor prefixed | |
| 6472 | if ( name in style ) { | |
| 6473 | return name; | |
| 6474 | } | |
| 6475 | ||
| 6476 | // check for vendor prefixed names | |
| 6477 | var capName = name.charAt(0).toUpperCase() + name.slice(1), | |
| 6478 | origName = name, | |
| 6479 | i = cssPrefixes.length; | |
| 6480 | ||
| 6481 | while ( i-- ) { | |
| 6482 | name = cssPrefixes[ i ] + capName; | |
| 6483 | if ( name in style ) { | |
| 6484 | return name; | |
| 6485 | } | |
| 6486 | } | |
| 6487 | ||
| 6488 | return origName; | |
| 6489 | } | |
| 6490 | ||
| 6491 | function showHide( elements, show ) { | |
| 6492 | var display, elem, hidden, | |
| 6493 | values = [], | |
| 6494 | index = 0, | |
| 6495 | length = elements.length; | |
| 6496 | ||
| 6497 | for ( ; index < length; index++ ) { | |
| 6498 | elem = elements[ index ]; | |
| 6499 | if ( !elem.style ) { | |
| 6500 | continue; | |
| 6501 | } | |
| 6502 | ||
| 6503 | values[ index ] = jQuery._data( elem, "olddisplay" ); | |
| 6504 | display = elem.style.display; | |
| 6505 | if ( show ) { | |
| 6506 | // Reset the inline display of this element to learn if it is | |
| 6507 | // being hidden by cascaded rules or not | |
| 6508 | if ( !values[ index ] && display === "none" ) { | |
| 6509 | elem.style.display = ""; | |
| 6510 | } | |
| 6511 | ||
| 6512 | // Set elements which have been overridden with display: none | |
| 6513 | // in a stylesheet to whatever the default browser style is | |
| 6514 | // for such an element | |
| 6515 | if ( elem.style.display === "" && isHidden( elem ) ) { | |
| 6516 | values[ index ] = jQuery._data( elem, "olddisplay", defaultDisplay(elem.nodeName) ); | |
| 6517 | } | |
| 6518 | } else { | |
| 6519 | hidden = isHidden( elem ); | |
| 6520 | ||
| 6521 | if ( display && display !== "none" || !hidden ) { | |
| 6522 | jQuery._data( elem, "olddisplay", hidden ? display : jQuery.css( elem, "display" ) ); | |
| 6523 | } | |
| 6524 | } | |
| 6525 | } | |
| 6526 | ||
| 6527 | // Set the display of most of the elements in a second loop | |
| 6528 | // to avoid the constant reflow | |
| 6529 | for ( index = 0; index < length; index++ ) { | |
| 6530 | elem = elements[ index ]; | |
| 6531 | if ( !elem.style ) { | |
| 6532 | continue; | |
| 6533 | } | |
| 6534 | if ( !show || elem.style.display === "none" || elem.style.display === "" ) { | |
| 6535 | elem.style.display = show ? values[ index ] || "" : "none"; | |
| 6536 | } | |
| 6537 | } | |
| 6538 | ||
| 6539 | return elements; | |
| 6540 | } | |
| 6541 | ||
| 6542 | function setPositiveNumber( elem, value, subtract ) { | |
| 6543 | var matches = rnumsplit.exec( value ); | |
| 6544 | return matches ? | |
| 6545 | // Guard against undefined "subtract", e.g., when used as in cssHooks | |
| 6546 | Math.max( 0, matches[ 1 ] - ( subtract || 0 ) ) + ( matches[ 2 ] || "px" ) : | |
| 6547 | value; | |
| 6548 | } | |
| 6549 | ||
| 6550 | function augmentWidthOrHeight( elem, name, extra, isBorderBox, styles ) { | |
| 6551 | var i = extra === ( isBorderBox ? "border" : "content" ) ? | |
| 6552 | // If we already have the right measurement, avoid augmentation | |
| 6553 | 4 : | |
| 6554 | // Otherwise initialize for horizontal or vertical properties | |
| 6555 | name === "width" ? 1 : 0, | |
| 6556 | ||
| 6557 | val = 0; | |
| 6558 | ||
| 6559 | for ( ; i < 4; i += 2 ) { | |
| 6560 | // both box models exclude margin, so add it if we want it | |
| 6561 | if ( extra === "margin" ) { | |
| 6562 | val += jQuery.css( elem, extra + cssExpand[ i ], true, styles ); | |
| 6563 | } | |
| 6564 | ||
| 6565 | if ( isBorderBox ) { | |
| 6566 | // border-box includes padding, so remove it if we want content | |
| 6567 | if ( extra === "content" ) { | |
| 6568 | val -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); | |
| 6569 | } | |
| 6570 | ||
| 6571 | // at this point, extra isn't border nor margin, so remove border | |
| 6572 | if ( extra !== "margin" ) { | |
| 6573 | val -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); | |
| 6574 | } | |
| 6575 | } else { | |
| 6576 | // at this point, extra isn't content, so add padding | |
| 6577 | val += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); | |
| 6578 | ||
| 6579 | // at this point, extra isn't content nor padding, so add border | |
| 6580 | if ( extra !== "padding" ) { | |
| 6581 | val += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); | |
| 6582 | } | |
| 6583 | } | |
| 6584 | } | |
| 6585 | ||
| 6586 | return val; | |
| 6587 | } | |
| 6588 | ||
| 6589 | function getWidthOrHeight( elem, name, extra ) { | |
| 6590 | ||
| 6591 | // Start with offset property, which is equivalent to the border-box value | |
| 6592 | var valueIsBorderBox = true, | |
| 6593 | val = name === "width" ? elem.offsetWidth : elem.offsetHeight, | |
| 6594 | styles = getStyles( elem ), | |
| 6595 | isBorderBox = support.boxSizing && jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; | |
| 6596 | ||
| 6597 | // some non-html elements return undefined for offsetWidth, so check for null/undefined | |
| 6598 | // svg - https://bugzilla.mozilla.org/show_bug.cgi?id=649285 | |
| 6599 | // MathML - https://bugzilla.mozilla.org/show_bug.cgi?id=491668 | |
| 6600 | if ( val <= 0 || val == null ) { | |
| 6601 | // Fall back to computed then uncomputed css if necessary | |
| 6602 | val = curCSS( elem, name, styles ); | |
| 6603 | if ( val < 0 || val == null ) { | |
| 6604 | val = elem.style[ name ]; | |
| 6605 | } | |
| 6606 | ||
| 6607 | // Computed unit is not pixels. Stop here and return. | |
| 6608 | if ( rnumnonpx.test(val) ) { | |
| 6609 | return val; | |
| 6610 | } | |
| 6611 | ||
| 6612 | // we need the check for style in case a browser which returns unreliable values | |
| 6613 | // for getComputedStyle silently falls back to the reliable elem.style | |
| 6614 | valueIsBorderBox = isBorderBox && ( support.boxSizingReliable() || val === elem.style[ name ] ); | |
| 6615 | ||
| 6616 | // Normalize "", auto, and prepare for extra | |
| 6617 | val = parseFloat( val ) || 0; | |
| 6618 | } | |
| 6619 | ||
| 6620 | // use the active box-sizing model to add/subtract irrelevant styles | |
| 6621 | return ( val + | |
| 6622 | augmentWidthOrHeight( | |
| 6623 | elem, | |
| 6624 | name, | |
| 6625 | extra || ( isBorderBox ? "border" : "content" ), | |
| 6626 | valueIsBorderBox, | |
| 6627 | styles | |
| 6628 | ) | |
| 6629 | ) + "px"; | |
| 6630 | } | |
| 6631 | ||
| 6632 | jQuery.extend({ | |
| 6633 | // Add in style property hooks for overriding the default | |
| 6634 | // behavior of getting and setting a style property | |
| 6635 | cssHooks: { | |
| 6636 | opacity: { | |
| 6637 | get: function( elem, computed ) { | |
| 6638 | if ( computed ) { | |
| 6639 | // We should always get a number back from opacity | |
| 6640 | var ret = curCSS( elem, "opacity" ); | |
| 6641 | return ret === "" ? "1" : ret; | |
| 6642 | } | |
| 6643 | } | |
| 6644 | } | |
| 6645 | }, | |
| 6646 | ||
| 6647 | // Don't automatically add "px" to these possibly-unitless properties | |
| 6648 | cssNumber: { | |
| 6649 | "columnCount": true, | |
| 6650 | "fillOpacity": true, | |
| 6651 | "flexGrow": true, | |
| 6652 | "flexShrink": true, | |
| 6653 | "fontWeight": true, | |
| 6654 | "lineHeight": true, | |
| 6655 | "opacity": true, | |
| 6656 | "order": true, | |
| 6657 | "orphans": true, | |
| 6658 | "widows": true, | |
| 6659 | "zIndex": true, | |
| 6660 | "zoom": true | |
| 6661 | }, | |
| 6662 | ||
| 6663 | // Add in properties whose names you wish to fix before | |
| 6664 | // setting or getting the value | |
| 6665 | cssProps: { | |
| 6666 | // normalize float css property | |
| 6667 | "float": support.cssFloat ? "cssFloat" : "styleFloat" | |
| 6668 | }, | |
| 6669 | ||
| 6670 | // Get and set the style property on a DOM Node | |
| 6671 | style: function( elem, name, value, extra ) { | |
| 6672 | // Don't set styles on text and comment nodes | |
| 6673 | if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { | |
| 6674 | return; | |
| 6675 | } | |
| 6676 | ||
| 6677 | // Make sure that we're working with the right name | |
| 6678 | var ret, type, hooks, | |
| 6679 | origName = jQuery.camelCase( name ), | |
| 6680 | style = elem.style; | |
| 6681 | ||
| 6682 | name = jQuery.cssProps[ origName ] || ( jQuery.cssProps[ origName ] = vendorPropName( style, origName ) ); | |
| 6683 | ||
| 6684 | // gets hook for the prefixed version | |
| 6685 | // followed by the unprefixed version | |
| 6686 | hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; | |
| 6687 | ||
| 6688 | // Check if we're setting a value | |
| 6689 | if ( value !== undefined ) { | |
| 6690 | type = typeof value; | |
| 6691 | ||
| 6692 | // convert relative number strings (+= or -=) to relative numbers. #7345 | |
| 6693 | if ( type === "string" && (ret = rrelNum.exec( value )) ) { | |
| 6694 | value = ( ret[1] + 1 ) * ret[2] + parseFloat( jQuery.css( elem, name ) ); | |
| 6695 | // Fixes bug #9237 | |
| 6696 | type = "number"; | |
| 6697 | } | |
| 6698 | ||
| 6699 | // Make sure that null and NaN values aren't set. See: #7116 | |
| 6700 | if ( value == null || value !== value ) { | |
| 6701 | return; | |
| 6702 | } | |
| 6703 | ||
| 6704 | // If a number was passed in, add 'px' to the (except for certain CSS properties) | |
| 6705 | if ( type === "number" && !jQuery.cssNumber[ origName ] ) { | |
| 6706 | value += "px"; | |
| 6707 | } | |
| 6708 | ||
| 6709 | // Fixes #8908, it can be done more correctly by specifing setters in cssHooks, | |
| 6710 | // but it would mean to define eight (for every problematic property) identical functions | |
| 6711 | if ( !support.clearCloneStyle && value === "" && name.indexOf("background") === 0 ) { | |
| 6712 | style[ name ] = "inherit"; | |
| 6713 | } | |
| 6714 | ||
| 6715 | // If a hook was provided, use that value, otherwise just set the specified value | |
| 6716 | if ( !hooks || !("set" in hooks) || (value = hooks.set( elem, value, extra )) !== undefined ) { | |
| 6717 | ||
| 6718 | // Support: IE | |
| 6719 | // Swallow errors from 'invalid' CSS values (#5509) | |
| 6720 | try { | |
| 6721 | style[ name ] = value; | |
| 6722 | } catch(e) {} | |
| 6723 | } | |
| 6724 | ||
| 6725 | } else { | |
| 6726 | // If a hook was provided get the non-computed value from there | |
| 6727 | if ( hooks && "get" in hooks && (ret = hooks.get( elem, false, extra )) !== undefined ) { | |
| 6728 | return ret; | |
| 6729 | } | |
| 6730 | ||
| 6731 | // Otherwise just get the value from the style object | |
| 6732 | return style[ name ]; | |
| 6733 | } | |
| 6734 | }, | |
| 6735 | ||
| 6736 | css: function( elem, name, extra, styles ) { | |
| 6737 | var num, val, hooks, | |
| 6738 | origName = jQuery.camelCase( name ); | |
| 6739 | ||
| 6740 | // Make sure that we're working with the right name | |
| 6741 | name = jQuery.cssProps[ origName ] || ( jQuery.cssProps[ origName ] = vendorPropName( elem.style, origName ) ); | |
| 6742 | ||
| 6743 | // gets hook for the prefixed version | |
| 6744 | // followed by the unprefixed version | |
| 6745 | hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; | |
| 6746 | ||
| 6747 | // If a hook was provided get the computed value from there | |
| 6748 | if ( hooks && "get" in hooks ) { | |
| 6749 | val = hooks.get( elem, true, extra ); | |
| 6750 | } | |
| 6751 | ||
| 6752 | // Otherwise, if a way to get the computed value exists, use that | |
| 6753 | if ( val === undefined ) { | |
| 6754 | val = curCSS( elem, name, styles ); | |
| 6755 | } | |
| 6756 | ||
| 6757 | //convert "normal" to computed value | |
| 6758 | if ( val === "normal" && name in cssNormalTransform ) { | |
| 6759 | val = cssNormalTransform[ name ]; | |
| 6760 | } | |
| 6761 | ||
| 6762 | // Return, converting to number if forced or a qualifier was provided and val looks numeric | |
| 6763 | if ( extra === "" || extra ) { | |
| 6764 | num = parseFloat( val ); | |
| 6765 | return extra === true || jQuery.isNumeric( num ) ? num || 0 : val; | |
| 6766 | } | |
| 6767 | return val; | |
| 6768 | } | |
| 6769 | }); | |
| 6770 | ||
| 6771 | jQuery.each([ "height", "width" ], function( i, name ) { | |
| 6772 | jQuery.cssHooks[ name ] = { | |
| 6773 | get: function( elem, computed, extra ) { | |
| 6774 | if ( computed ) { | |
| 6775 | // certain elements can have dimension info if we invisibly show them | |
| 6776 | // however, it must have a current display style that would benefit from this | |
| 6777 | return rdisplayswap.test( jQuery.css( elem, "display" ) ) && elem.offsetWidth === 0 ? | |
| 6778 | jQuery.swap( elem, cssShow, function() { | |
| 6779 | return getWidthOrHeight( elem, name, extra ); | |
| 6780 | }) : | |
| 6781 | getWidthOrHeight( elem, name, extra ); | |
| 6782 | } | |
| 6783 | }, | |
| 6784 | ||
| 6785 | set: function( elem, value, extra ) { | |
| 6786 | var styles = extra && getStyles( elem ); | |
| 6787 | return setPositiveNumber( elem, value, extra ? | |
| 6788 | augmentWidthOrHeight( | |
| 6789 | elem, | |
| 6790 | name, | |
| 6791 | extra, | |
| 6792 | support.boxSizing && jQuery.css( elem, "boxSizing", false, styles ) === "border-box", | |
| 6793 | styles | |
| 6794 | ) : 0 | |
| 6795 | ); | |
| 6796 | } | |
| 6797 | }; | |
| 6798 | }); | |
| 6799 | ||
| 6800 | if ( !support.opacity ) { | |
| 6801 | jQuery.cssHooks.opacity = { | |
| 6802 | get: function( elem, computed ) { | |
| 6803 | // IE uses filters for opacity | |
| 6804 | return ropacity.test( (computed && elem.currentStyle ? elem.currentStyle.filter : elem.style.filter) || "" ) ? | |
| 6805 | ( 0.01 * parseFloat( RegExp.$1 ) ) + "" : | |
| 6806 | computed ? "1" : ""; | |
| 6807 | }, | |
| 6808 | ||
| 6809 | set: function( elem, value ) { | |
| 6810 | var style = elem.style, | |
| 6811 | currentStyle = elem.currentStyle, | |
| 6812 | opacity = jQuery.isNumeric( value ) ? "alpha(opacity=" + value * 100 + ")" : "", | |
| 6813 | filter = currentStyle && currentStyle.filter || style.filter || ""; | |
| 6814 | ||
| 6815 | // IE has trouble with opacity if it does not have layout | |
| 6816 | // Force it by setting the zoom level | |
| 6817 | style.zoom = 1; | |
| 6818 | ||
| 6819 | // if setting opacity to 1, and no other filters exist - attempt to remove filter attribute #6652 | |
| 6820 | // if value === "", then remove inline opacity #12685 | |
| 6821 | if ( ( value >= 1 || value === "" ) && | |
| 6822 | jQuery.trim( filter.replace( ralpha, "" ) ) === "" && | |
| 6823 | style.removeAttribute ) { | |
| 6824 | ||
| 6825 | // Setting style.filter to null, "" & " " still leave "filter:" in the cssText | |
| 6826 | // if "filter:" is present at all, clearType is disabled, we want to avoid this | |
| 6827 | // style.removeAttribute is IE Only, but so apparently is this code path... | |
| 6828 | style.removeAttribute( "filter" ); | |
| 6829 | ||
| 6830 | // if there is no filter style applied in a css rule or unset inline opacity, we are done | |
| 6831 | if ( value === "" || currentStyle && !currentStyle.filter ) { | |
| 6832 | return; | |
| 6833 | } | |
| 6834 | } | |
| 6835 | ||
| 6836 | // otherwise, set new filter values | |
| 6837 | style.filter = ralpha.test( filter ) ? | |
| 6838 | filter.replace( ralpha, opacity ) : | |
| 6839 | filter + " " + opacity; | |
| 6840 | } | |
| 6841 | }; | |
| 6842 | } | |
| 6843 | ||
| 6844 | jQuery.cssHooks.marginRight = addGetHookIf( support.reliableMarginRight, | |
| 6845 | function( elem, computed ) { | |
| 6846 | if ( computed ) { | |
| 6847 | // WebKit Bug 13343 - getComputedStyle returns wrong value for margin-right | |
| 6848 | // Work around by temporarily setting element display to inline-block | |
| 6849 | return jQuery.swap( elem, { "display": "inline-block" }, | |
| 6850 | curCSS, [ elem, "marginRight" ] ); | |
| 6851 | } | |
| 6852 | } | |
| 6853 | ); | |
| 6854 | ||
| 6855 | // These hooks are used by animate to expand properties | |
| 6856 | jQuery.each({ | |
| 6857 | margin: "", | |
| 6858 | padding: "", | |
| 6859 | border: "Width" | |
| 6860 | }, function( prefix, suffix ) { | |
| 6861 | jQuery.cssHooks[ prefix + suffix ] = { | |
| 6862 | expand: function( value ) { | |
| 6863 | var i = 0, | |
| 6864 | expanded = {}, | |
| 6865 | ||
| 6866 | // assumes a single number if not a string | |
| 6867 | parts = typeof value === "string" ? value.split(" ") : [ value ]; | |
| 6868 | ||
| 6869 | for ( ; i < 4; i++ ) { | |
| 6870 | expanded[ prefix + cssExpand[ i ] + suffix ] = | |
| 6871 | parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; | |
| 6872 | } | |
| 6873 | ||
| 6874 | return expanded; | |
| 6875 | } | |
| 6876 | }; | |
| 6877 | ||
| 6878 | if ( !rmargin.test( prefix ) ) { | |
| 6879 | jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; | |
| 6880 | } | |
| 6881 | }); | |
| 6882 | ||
| 6883 | jQuery.fn.extend({ | |
| 6884 | css: function( name, value ) { | |
| 6885 | return access( this, function( elem, name, value ) { | |
| 6886 | var styles, len, | |
| 6887 | map = {}, | |
| 6888 | i = 0; | |
| 6889 | ||
| 6890 | if ( jQuery.isArray( name ) ) { | |
| 6891 | styles = getStyles( elem ); | |
| 6892 | len = name.length; | |
| 6893 | ||
| 6894 | for ( ; i < len; i++ ) { | |
| 6895 | map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); | |
| 6896 | } | |
| 6897 | ||
| 6898 | return map; | |
| 6899 | } | |
| 6900 | ||
| 6901 | return value !== undefined ? | |
| 6902 | jQuery.style( elem, name, value ) : | |
| 6903 | jQuery.css( elem, name ); | |
| 6904 | }, name, value, arguments.length > 1 ); | |
| 6905 | }, | |
| 6906 | show: function() { | |
| 6907 | return showHide( this, true ); | |
| 6908 | }, | |
| 6909 | hide: function() { | |
| 6910 | return showHide( this ); | |
| 6911 | }, | |
| 6912 | toggle: function( state ) { | |
| 6913 | if ( typeof state === "boolean" ) { | |
| 6914 | return state ? this.show() : this.hide(); | |
| 6915 | } | |
| 6916 | ||
| 6917 | return this.each(function() { | |
| 6918 | if ( isHidden( this ) ) { | |
| 6919 | jQuery( this ).show(); | |
| 6920 | } else { | |
| 6921 | jQuery( this ).hide(); | |
| 6922 | } | |
| 6923 | }); | |
| 6924 | } | |
| 6925 | }); | |
| 6926 | ||
| 6927 | ||
| 6928 | function Tween( elem, options, prop, end, easing ) { | |
| 6929 | return new Tween.prototype.init( elem, options, prop, end, easing ); | |
| 6930 | } | |
| 6931 | jQuery.Tween = Tween; | |
| 6932 | ||
| 6933 | Tween.prototype = { | |
| 6934 | constructor: Tween, | |
| 6935 | init: function( elem, options, prop, end, easing, unit ) { | |
| 6936 | this.elem = elem; | |
| 6937 | this.prop = prop; | |
| 6938 | this.easing = easing || "swing"; | |
| 6939 | this.options = options; | |
| 6940 | this.start = this.now = this.cur(); | |
| 6941 | this.end = end; | |
| 6942 | this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); | |
| 6943 | }, | |
| 6944 | cur: function() { | |
| 6945 | var hooks = Tween.propHooks[ this.prop ]; | |
| 6946 | ||
| 6947 | return hooks && hooks.get ? | |
| 6948 | hooks.get( this ) : | |
| 6949 | Tween.propHooks._default.get( this ); | |
| 6950 | }, | |
| 6951 | run: function( percent ) { | |
| 6952 | var eased, | |
| 6953 | hooks = Tween.propHooks[ this.prop ]; | |
| 6954 | ||
| 6955 | if ( this.options.duration ) { | |
| 6956 | this.pos = eased = jQuery.easing[ this.easing ]( | |
| 6957 | percent, this.options.duration * percent, 0, 1, this.options.duration | |
| 6958 | ); | |
| 6959 | } else { | |
| 6960 | this.pos = eased = percent; | |
| 6961 | } | |
| 6962 | this.now = ( this.end - this.start ) * eased + this.start; | |
| 6963 | ||
| 6964 | if ( this.options.step ) { | |
| 6965 | this.options.step.call( this.elem, this.now, this ); | |
| 6966 | } | |
| 6967 | ||
| 6968 | if ( hooks && hooks.set ) { | |
| 6969 | hooks.set( this ); | |
| 6970 | } else { | |
| 6971 | Tween.propHooks._default.set( this ); | |
| 6972 | } | |
| 6973 | return this; | |
| 6974 | } | |
| 6975 | }; | |
| 6976 | ||
| 6977 | Tween.prototype.init.prototype = Tween.prototype; | |
| 6978 | ||
| 6979 | Tween.propHooks = { | |
| 6980 | _default: { | |
| 6981 | get: function( tween ) { | |
| 6982 | var result; | |
| 6983 | ||
| 6984 | if ( tween.elem[ tween.prop ] != null && | |
| 6985 | (!tween.elem.style || tween.elem.style[ tween.prop ] == null) ) { | |
| 6986 | return tween.elem[ tween.prop ]; | |
| 6987 | } | |
| 6988 | ||
| 6989 | // passing an empty string as a 3rd parameter to .css will automatically | |
| 6990 | // attempt a parseFloat and fallback to a string if the parse fails | |
| 6991 | // so, simple values such as "10px" are parsed to Float. | |
| 6992 | // complex values such as "rotate(1rad)" are returned as is. | |
| 6993 | result = jQuery.css( tween.elem, tween.prop, "" ); | |
| 6994 | // Empty strings, null, undefined and "auto" are converted to 0. | |
| 6995 | return !result || result === "auto" ? 0 : result; | |
| 6996 | }, | |
| 6997 | set: function( tween ) { | |
| 6998 | // use step hook for back compat - use cssHook if its there - use .style if its | |
| 6999 | // available and use plain properties where available | |
| 7000 | if ( jQuery.fx.step[ tween.prop ] ) { | |
| 7001 | jQuery.fx.step[ tween.prop ]( tween ); | |
| 7002 | } else if ( tween.elem.style && ( tween.elem.style[ jQuery.cssProps[ tween.prop ] ] != null || jQuery.cssHooks[ tween.prop ] ) ) { | |
| 7003 | jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); | |
| 7004 | } else { | |
| 7005 | tween.elem[ tween.prop ] = tween.now; | |
| 7006 | } | |
| 7007 | } | |
| 7008 | } | |
| 7009 | }; | |
| 7010 | ||
| 7011 | // Support: IE <=9 | |
| 7012 | // Panic based approach to setting things on disconnected nodes | |
| 7013 | ||
| 7014 | Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { | |
| 7015 | set: function( tween ) { | |
| 7016 | if ( tween.elem.nodeType && tween.elem.parentNode ) { | |
| 7017 | tween.elem[ tween.prop ] = tween.now; | |
| 7018 | } | |
| 7019 | } | |
| 7020 | }; | |
| 7021 | ||
| 7022 | jQuery.easing = { | |
| 7023 | linear: function( p ) { | |
| 7024 | return p; | |
| 7025 | }, | |
| 7026 | swing: function( p ) { | |
| 7027 | return 0.5 - Math.cos( p * Math.PI ) / 2; | |
| 7028 | } | |
| 7029 | }; | |
| 7030 | ||
| 7031 | jQuery.fx = Tween.prototype.init; | |
| 7032 | ||
| 7033 | // Back Compat <1.8 extension point | |
| 7034 | jQuery.fx.step = {}; | |
| 7035 | ||
| 7036 | ||
| 7037 | ||
| 7038 | ||
| 7039 | var | |
| 7040 | fxNow, timerId, | |
| 7041 | rfxtypes = /^(?:toggle|show|hide)$/, | |
| 7042 | rfxnum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ), | |
| 7043 | rrun = /queueHooks$/, | |
| 7044 | animationPrefilters = [ defaultPrefilter ], | |
| 7045 | tweeners = { | |
| 7046 | "*": [ function( prop, value ) { | |
| 7047 | var tween = this.createTween( prop, value ), | |
| 7048 | target = tween.cur(), | |
| 7049 | parts = rfxnum.exec( value ), | |
| 7050 | unit = parts && parts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), | |
| 7051 | ||
| 7052 | // Starting value computation is required for potential unit mismatches | |
| 7053 | start = ( jQuery.cssNumber[ prop ] || unit !== "px" && +target ) && | |
| 7054 | rfxnum.exec( jQuery.css( tween.elem, prop ) ), | |
| 7055 | scale = 1, | |
| 7056 | maxIterations = 20; | |
| 7057 | ||
| 7058 | if ( start && start[ 3 ] !== unit ) { | |
| 7059 | // Trust units reported by jQuery.css | |
| 7060 | unit = unit || start[ 3 ]; | |
| 7061 | ||
| 7062 | // Make sure we update the tween properties later on | |
| 7063 | parts = parts || []; | |
| 7064 | ||
| 7065 | // Iteratively approximate from a nonzero starting point | |
| 7066 | start = +target || 1; | |
| 7067 | ||
| 7068 | do { | |
| 7069 | // If previous iteration zeroed out, double until we get *something* | |
| 7070 | // Use a string for doubling factor so we don't accidentally see scale as unchanged below | |
| 7071 | scale = scale || ".5"; | |
| 7072 | ||
| 7073 | // Adjust and apply | |
| 7074 | start = start / scale; | |
| 7075 | jQuery.style( tween.elem, prop, start + unit ); | |
| 7076 | ||
| 7077 | // Update scale, tolerating zero or NaN from tween.cur() | |
| 7078 | // And breaking the loop if scale is unchanged or perfect, or if we've just had enough | |
| 7079 | } while ( scale !== (scale = tween.cur() / target) && scale !== 1 && --maxIterations ); | |
| 7080 | } | |
| 7081 | ||
| 7082 | // Update tween properties | |
| 7083 | if ( parts ) { | |
| 7084 | start = tween.start = +start || +target || 0; | |
| 7085 | tween.unit = unit; | |
| 7086 | // If a +=/-= token was provided, we're doing a relative animation | |
| 7087 | tween.end = parts[ 1 ] ? | |
| 7088 | start + ( parts[ 1 ] + 1 ) * parts[ 2 ] : | |
| 7089 | +parts[ 2 ]; | |
| 7090 | } | |
| 7091 | ||
| 7092 | return tween; | |
| 7093 | } ] | |
| 7094 | }; | |
| 7095 | ||
| 7096 | // Animations created synchronously will run synchronously | |
| 7097 | function createFxNow() { | |
| 7098 | setTimeout(function() { | |
| 7099 | fxNow = undefined; | |
| 7100 | }); | |
| 7101 | return ( fxNow = jQuery.now() ); | |
| 7102 | } | |
| 7103 | ||
| 7104 | // Generate parameters to create a standard animation | |
| 7105 | function genFx( type, includeWidth ) { | |
| 7106 | var which, | |
| 7107 | attrs = { height: type }, | |
| 7108 | i = 0; | |
| 7109 | ||
| 7110 | // if we include width, step value is 1 to do all cssExpand values, | |
| 7111 | // if we don't include width, step value is 2 to skip over Left and Right | |
| 7112 | includeWidth = includeWidth ? 1 : 0; | |
| 7113 | for ( ; i < 4 ; i += 2 - includeWidth ) { | |
| 7114 | which = cssExpand[ i ]; | |
| 7115 | attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; | |
| 7116 | } | |
| 7117 | ||
| 7118 | if ( includeWidth ) { | |
| 7119 | attrs.opacity = attrs.width = type; | |
| 7120 | } | |
| 7121 | ||
| 7122 | return attrs; | |
| 7123 | } | |
| 7124 | ||
| 7125 | function createTween( value, prop, animation ) { | |
| 7126 | var tween, | |
| 7127 | collection = ( tweeners[ prop ] || [] ).concat( tweeners[ "*" ] ), | |
| 7128 | index = 0, | |
| 7129 | length = collection.length; | |
| 7130 | for ( ; index < length; index++ ) { | |
| 7131 | if ( (tween = collection[ index ].call( animation, prop, value )) ) { | |
| 7132 | ||
| 7133 | // we're done with this property | |
| 7134 | return tween; | |
| 7135 | } | |
| 7136 | } | |
| 7137 | } | |
| 7138 | ||
| 7139 | function defaultPrefilter( elem, props, opts ) { | |
| 7140 | /* jshint validthis: true */ | |
| 7141 | var prop, value, toggle, tween, hooks, oldfire, display, checkDisplay, | |
| 7142 | anim = this, | |
| 7143 | orig = {}, | |
| 7144 | style = elem.style, | |
| 7145 | hidden = elem.nodeType && isHidden( elem ), | |
| 7146 | dataShow = jQuery._data( elem, "fxshow" ); | |
| 7147 | ||
| 7148 | // handle queue: false promises | |
| 7149 | if ( !opts.queue ) { | |
| 7150 | hooks = jQuery._queueHooks( elem, "fx" ); | |
| 7151 | if ( hooks.unqueued == null ) { | |
| 7152 | hooks.unqueued = 0; | |
| 7153 | oldfire = hooks.empty.fire; | |
| 7154 | hooks.empty.fire = function() { | |
| 7155 | if ( !hooks.unqueued ) { | |
| 7156 | oldfire(); | |
| 7157 | } | |
| 7158 | }; | |
| 7159 | } | |
| 7160 | hooks.unqueued++; | |
| 7161 | ||
| 7162 | anim.always(function() { | |
| 7163 | // doing this makes sure that the complete handler will be called | |
| 7164 | // before this completes | |
| 7165 | anim.always(function() { | |
| 7166 | hooks.unqueued--; | |
| 7167 | if ( !jQuery.queue( elem, "fx" ).length ) { | |
| 7168 | hooks.empty.fire(); | |
| 7169 | } | |
| 7170 | }); | |
| 7171 | }); | |
| 7172 | } | |
| 7173 | ||
| 7174 | // height/width overflow pass | |
| 7175 | if ( elem.nodeType === 1 && ( "height" in props || "width" in props ) ) { | |
| 7176 | // Make sure that nothing sneaks out | |
| 7177 | // Record all 3 overflow attributes because IE does not | |
| 7178 | // change the overflow attribute when overflowX and | |
| 7179 | // overflowY are set to the same value | |
| 7180 | opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; | |
| 7181 | ||
| 7182 | // Set display property to inline-block for height/width | |
| 7183 | // animations on inline elements that are having width/height animated | |
| 7184 | display = jQuery.css( elem, "display" ); | |
| 7185 | ||
| 7186 | // Test default display if display is currently "none" | |
| 7187 | checkDisplay = display === "none" ? | |
| 7188 | jQuery._data( elem, "olddisplay" ) || defaultDisplay( elem.nodeName ) : display; | |
| 7189 | ||
| 7190 | if ( checkDisplay === "inline" && jQuery.css( elem, "float" ) === "none" ) { | |
| 7191 | ||
| 7192 | // inline-level elements accept inline-block; | |
| 7193 | // block-level elements need to be inline with layout | |
| 7194 | if ( !support.inlineBlockNeedsLayout || defaultDisplay( elem.nodeName ) === "inline" ) { | |
| 7195 | style.display = "inline-block"; | |
| 7196 | } else { | |
| 7197 | style.zoom = 1; | |
| 7198 | } | |
| 7199 | } | |
| 7200 | } | |
| 7201 | ||
| 7202 | if ( opts.overflow ) { | |
| 7203 | style.overflow = "hidden"; | |
| 7204 | if ( !support.shrinkWrapBlocks() ) { | |
| 7205 | anim.always(function() { | |
| 7206 | style.overflow = opts.overflow[ 0 ]; | |
| 7207 | style.overflowX = opts.overflow[ 1 ]; | |
| 7208 | style.overflowY = opts.overflow[ 2 ]; | |
| 7209 | }); | |
| 7210 | } | |
| 7211 | } | |
| 7212 | ||
| 7213 | // show/hide pass | |
| 7214 | for ( prop in props ) { | |
| 7215 | value = props[ prop ]; | |
| 7216 | if ( rfxtypes.exec( value ) ) { | |
| 7217 | delete props[ prop ]; | |
| 7218 | toggle = toggle || value === "toggle"; | |
| 7219 | if ( value === ( hidden ? "hide" : "show" ) ) { | |
| 7220 | ||
| 7221 | // If there is dataShow left over from a stopped hide or show and we are going to proceed with show, we should pretend to be hidden | |
| 7222 | if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { | |
| 7223 | hidden = true; | |
| 7224 | } else { | |
| 7225 | continue; | |
| 7226 | } | |
| 7227 | } | |
| 7228 | orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); | |
| 7229 | ||
| 7230 | // Any non-fx value stops us from restoring the original display value | |
| 7231 | } else { | |
| 7232 | display = undefined; | |
| 7233 | } | |
| 7234 | } | |
| 7235 | ||
| 7236 | if ( !jQuery.isEmptyObject( orig ) ) { | |
| 7237 | if ( dataShow ) { | |
| 7238 | if ( "hidden" in dataShow ) { | |
| 7239 | hidden = dataShow.hidden; | |
| 7240 | } | |
| 7241 | } else { | |
| 7242 | dataShow = jQuery._data( elem, "fxshow", {} ); | |
| 7243 | } | |
| 7244 | ||
| 7245 | // store state if its toggle - enables .stop().toggle() to "reverse" | |
| 7246 | if ( toggle ) { | |
| 7247 | dataShow.hidden = !hidden; | |
| 7248 | } | |
| 7249 | if ( hidden ) { | |
| 7250 | jQuery( elem ).show(); | |
| 7251 | } else { | |
| 7252 | anim.done(function() { | |
| 7253 | jQuery( elem ).hide(); | |
| 7254 | }); | |
| 7255 | } | |
| 7256 | anim.done(function() { | |
| 7257 | var prop; | |
| 7258 | jQuery._removeData( elem, "fxshow" ); | |
| 7259 | for ( prop in orig ) { | |
| 7260 | jQuery.style( elem, prop, orig[ prop ] ); | |
| 7261 | } | |
| 7262 | }); | |
| 7263 | for ( prop in orig ) { | |
| 7264 | tween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); | |
| 7265 | ||
| 7266 | if ( !( prop in dataShow ) ) { | |
| 7267 | dataShow[ prop ] = tween.start; | |
| 7268 | if ( hidden ) { | |
| 7269 | tween.end = tween.start; | |
| 7270 | tween.start = prop === "width" || prop === "height" ? 1 : 0; | |
| 7271 | } | |
| 7272 | } | |
| 7273 | } | |
| 7274 | ||
| 7275 | // If this is a noop like .hide().hide(), restore an overwritten display value | |
| 7276 | } else if ( (display === "none" ? defaultDisplay( elem.nodeName ) : display) === "inline" ) { | |
| 7277 | style.display = display; | |
| 7278 | } | |
| 7279 | } | |
| 7280 | ||
| 7281 | function propFilter( props, specialEasing ) { | |
| 7282 | var index, name, easing, value, hooks; | |
| 7283 | ||
| 7284 | // camelCase, specialEasing and expand cssHook pass | |
| 7285 | for ( index in props ) { | |
| 7286 | name = jQuery.camelCase( index ); | |
| 7287 | easing = specialEasing[ name ]; | |
| 7288 | value = props[ index ]; | |
| 7289 | if ( jQuery.isArray( value ) ) { | |
| 7290 | easing = value[ 1 ]; | |
| 7291 | value = props[ index ] = value[ 0 ]; | |
| 7292 | } | |
| 7293 | ||
| 7294 | if ( index !== name ) { | |
| 7295 | props[ name ] = value; | |
| 7296 | delete props[ index ]; | |
| 7297 | } | |
| 7298 | ||
| 7299 | hooks = jQuery.cssHooks[ name ]; | |
| 7300 | if ( hooks && "expand" in hooks ) { | |
| 7301 | value = hooks.expand( value ); | |
| 7302 | delete props[ name ]; | |
| 7303 | ||
| 7304 | // not quite $.extend, this wont overwrite keys already present. | |
| 7305 | // also - reusing 'index' from above because we have the correct "name" | |
| 7306 | for ( index in value ) { | |
| 7307 | if ( !( index in props ) ) { | |
| 7308 | props[ index ] = value[ index ]; | |
| 7309 | specialEasing[ index ] = easing; | |
| 7310 | } | |
| 7311 | } | |
| 7312 | } else { | |
| 7313 | specialEasing[ name ] = easing; | |
| 7314 | } | |
| 7315 | } | |
| 7316 | } | |
| 7317 | ||
| 7318 | function Animation( elem, properties, options ) { | |
| 7319 | var result, | |
| 7320 | stopped, | |
| 7321 | index = 0, | |
| 7322 | length = animationPrefilters.length, | |
| 7323 | deferred = jQuery.Deferred().always( function() { | |
| 7324 | // don't match elem in the :animated selector | |
| 7325 | delete tick.elem; | |
| 7326 | }), | |
| 7327 | tick = function() { | |
| 7328 | if ( stopped ) { | |
| 7329 | return false; | |
| 7330 | } | |
| 7331 | var currentTime = fxNow || createFxNow(), | |
| 7332 | remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), | |
| 7333 | // archaic crash bug won't allow us to use 1 - ( 0.5 || 0 ) (#12497) | |
| 7334 | temp = remaining / animation.duration || 0, | |
| 7335 | percent = 1 - temp, | |
| 7336 | index = 0, | |
| 7337 | length = animation.tweens.length; | |
| 7338 | ||
| 7339 | for ( ; index < length ; index++ ) { | |
| 7340 | animation.tweens[ index ].run( percent ); | |
| 7341 | } | |
| 7342 | ||
| 7343 | deferred.notifyWith( elem, [ animation, percent, remaining ]); | |
| 7344 | ||
| 7345 | if ( percent < 1 && length ) { | |
| 7346 | return remaining; | |
| 7347 | } else { | |
| 7348 | deferred.resolveWith( elem, [ animation ] ); | |
| 7349 | return false; | |
| 7350 | } | |
| 7351 | }, | |
| 7352 | animation = deferred.promise({ | |
| 7353 | elem: elem, | |
| 7354 | props: jQuery.extend( {}, properties ), | |
| 7355 | opts: jQuery.extend( true, { specialEasing: {} }, options ), | |
| 7356 | originalProperties: properties, | |
| 7357 | originalOptions: options, | |
| 7358 | startTime: fxNow || createFxNow(), | |
| 7359 | duration: options.duration, | |
| 7360 | tweens: [], | |
| 7361 | createTween: function( prop, end ) { | |
| 7362 | var tween = jQuery.Tween( elem, animation.opts, prop, end, | |
| 7363 | animation.opts.specialEasing[ prop ] || animation.opts.easing ); | |
| 7364 | animation.tweens.push( tween ); | |
| 7365 | return tween; | |
| 7366 | }, | |
| 7367 | stop: function( gotoEnd ) { | |
| 7368 | var index = 0, | |
| 7369 | // if we are going to the end, we want to run all the tweens | |
| 7370 | // otherwise we skip this part | |
| 7371 | length = gotoEnd ? animation.tweens.length : 0; | |
| 7372 | if ( stopped ) { | |
| 7373 | return this; | |
| 7374 | } | |
| 7375 | stopped = true; | |
| 7376 | for ( ; index < length ; index++ ) { | |
| 7377 | animation.tweens[ index ].run( 1 ); | |
| 7378 | } | |
| 7379 | ||
| 7380 | // resolve when we played the last frame | |
| 7381 | // otherwise, reject | |
| 7382 | if ( gotoEnd ) { | |
| 7383 | deferred.resolveWith( elem, [ animation, gotoEnd ] ); | |
| 7384 | } else { | |
| 7385 | deferred.rejectWith( elem, [ animation, gotoEnd ] ); | |
| 7386 | } | |
| 7387 | return this; | |
| 7388 | } | |
| 7389 | }), | |
| 7390 | props = animation.props; | |
| 7391 | ||
| 7392 | propFilter( props, animation.opts.specialEasing ); | |
| 7393 | ||
| 7394 | for ( ; index < length ; index++ ) { | |
| 7395 | result = animationPrefilters[ index ].call( animation, elem, props, animation.opts ); | |
| 7396 | if ( result ) { | |
| 7397 | return result; | |
| 7398 | } | |
| 7399 | } | |
| 7400 | ||
| 7401 | jQuery.map( props, createTween, animation ); | |
| 7402 | ||
| 7403 | if ( jQuery.isFunction( animation.opts.start ) ) { | |
| 7404 | animation.opts.start.call( elem, animation ); | |
| 7405 | } | |
| 7406 | ||
| 7407 | jQuery.fx.timer( | |
| 7408 | jQuery.extend( tick, { | |
| 7409 | elem: elem, | |
| 7410 | anim: animation, | |
| 7411 | queue: animation.opts.queue | |
| 7412 | }) | |
| 7413 | ); | |
| 7414 | ||
| 7415 | // attach callbacks from options | |
| 7416 | return animation.progress( animation.opts.progress ) | |
| 7417 | .done( animation.opts.done, animation.opts.complete ) | |
| 7418 | .fail( animation.opts.fail ) | |
| 7419 | .always( animation.opts.always ); | |
| 7420 | } | |
| 7421 | ||
| 7422 | jQuery.Animation = jQuery.extend( Animation, { | |
| 7423 | tweener: function( props, callback ) { | |
| 7424 | if ( jQuery.isFunction( props ) ) { | |
| 7425 | callback = props; | |
| 7426 | props = [ "*" ]; | |
| 7427 | } else { | |
| 7428 | props = props.split(" "); | |
| 7429 | } | |
| 7430 | ||
| 7431 | var prop, | |
| 7432 | index = 0, | |
| 7433 | length = props.length; | |
| 7434 | ||
| 7435 | for ( ; index < length ; index++ ) { | |
| 7436 | prop = props[ index ]; | |
| 7437 | tweeners[ prop ] = tweeners[ prop ] || []; | |
| 7438 | tweeners[ prop ].unshift( callback ); | |
| 7439 | } | |
| 7440 | }, | |
| 7441 | ||
| 7442 | prefilter: function( callback, prepend ) { | |
| 7443 | if ( prepend ) { | |
| 7444 | animationPrefilters.unshift( callback ); | |
| 7445 | } else { | |
| 7446 | animationPrefilters.push( callback ); | |
| 7447 | } | |
| 7448 | } | |
| 7449 | }); | |
| 7450 | ||
| 7451 | jQuery.speed = function( speed, easing, fn ) { | |
| 7452 | var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { | |
| 7453 | complete: fn || !fn && easing || | |
| 7454 | jQuery.isFunction( speed ) && speed, | |
| 7455 | duration: speed, | |
| 7456 | easing: fn && easing || easing && !jQuery.isFunction( easing ) && easing | |
| 7457 | }; | |
| 7458 | ||
| 7459 | opt.duration = jQuery.fx.off ? 0 : typeof opt.duration === "number" ? opt.duration : | |
| 7460 | opt.duration in jQuery.fx.speeds ? jQuery.fx.speeds[ opt.duration ] : jQuery.fx.speeds._default; | |
| 7461 | ||
| 7462 | // normalize opt.queue - true/undefined/null -> "fx" | |
| 7463 | if ( opt.queue == null || opt.queue === true ) { | |
| 7464 | opt.queue = "fx"; | |
| 7465 | } | |
| 7466 | ||
| 7467 | // Queueing | |
| 7468 | opt.old = opt.complete; | |
| 7469 | ||
| 7470 | opt.complete = function() { | |
| 7471 | if ( jQuery.isFunction( opt.old ) ) { | |
| 7472 | opt.old.call( this ); | |
| 7473 | } | |
| 7474 | ||
| 7475 | if ( opt.queue ) { | |
| 7476 | jQuery.dequeue( this, opt.queue ); | |
| 7477 | } | |
| 7478 | }; | |
| 7479 | ||
| 7480 | return opt; | |
| 7481 | }; | |
| 7482 | ||
| 7483 | jQuery.fn.extend({ | |
| 7484 | fadeTo: function( speed, to, easing, callback ) { | |
| 7485 | ||
| 7486 | // show any hidden elements after setting opacity to 0 | |
| 7487 | return this.filter( isHidden ).css( "opacity", 0 ).show() | |
| 7488 | ||
| 7489 | // animate to the value specified | |
| 7490 | .end().animate({ opacity: to }, speed, easing, callback ); | |
| 7491 | }, | |
| 7492 | animate: function( prop, speed, easing, callback ) { | |
| 7493 | var empty = jQuery.isEmptyObject( prop ), | |
| 7494 | optall = jQuery.speed( speed, easing, callback ), | |
| 7495 | doAnimation = function() { | |
| 7496 | // Operate on a copy of prop so per-property easing won't be lost | |
| 7497 | var anim = Animation( this, jQuery.extend( {}, prop ), optall ); | |
| 7498 | ||
| 7499 | // Empty animations, or finishing resolves immediately | |
| 7500 | if ( empty || jQuery._data( this, "finish" ) ) { | |
| 7501 | anim.stop( true ); | |
| 7502 | } | |
| 7503 | }; | |
| 7504 | doAnimation.finish = doAnimation; | |
| 7505 | ||
| 7506 | return empty || optall.queue === false ? | |
| 7507 | this.each( doAnimation ) : | |
| 7508 | this.queue( optall.queue, doAnimation ); | |
| 7509 | }, | |
| 7510 | stop: function( type, clearQueue, gotoEnd ) { | |
| 7511 | var stopQueue = function( hooks ) { | |
| 7512 | var stop = hooks.stop; | |
| 7513 | delete hooks.stop; | |
| 7514 | stop( gotoEnd ); | |
| 7515 | }; | |
| 7516 | ||
| 7517 | if ( typeof type !== "string" ) { | |
| 7518 | gotoEnd = clearQueue; | |
| 7519 | clearQueue = type; | |
| 7520 | type = undefined; | |
| 7521 | } | |
| 7522 | if ( clearQueue && type !== false ) { | |
| 7523 | this.queue( type || "fx", [] ); | |
| 7524 | } | |
| 7525 | ||
| 7526 | return this.each(function() { | |
| 7527 | var dequeue = true, | |
| 7528 | index = type != null && type + "queueHooks", | |
| 7529 | timers = jQuery.timers, | |
| 7530 | data = jQuery._data( this ); | |
| 7531 | ||
| 7532 | if ( index ) { | |
| 7533 | if ( data[ index ] && data[ index ].stop ) { | |
| 7534 | stopQueue( data[ index ] ); | |
| 7535 | } | |
| 7536 | } else { | |
| 7537 | for ( index in data ) { | |
| 7538 | if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { | |
| 7539 | stopQueue( data[ index ] ); | |
| 7540 | } | |
| 7541 | } | |
| 7542 | } | |
| 7543 | ||
| 7544 | for ( index = timers.length; index--; ) { | |
| 7545 | if ( timers[ index ].elem === this && (type == null || timers[ index ].queue === type) ) { | |
| 7546 | timers[ index ].anim.stop( gotoEnd ); | |
| 7547 | dequeue = false; | |
| 7548 | timers.splice( index, 1 ); | |
| 7549 | } | |
| 7550 | } | |
| 7551 | ||
| 7552 | // start the next in the queue if the last step wasn't forced | |
| 7553 | // timers currently will call their complete callbacks, which will dequeue | |
| 7554 | // but only if they were gotoEnd | |
| 7555 | if ( dequeue || !gotoEnd ) { | |
| 7556 | jQuery.dequeue( this, type ); | |
| 7557 | } | |
| 7558 | }); | |
| 7559 | }, | |
| 7560 | finish: function( type ) { | |
| 7561 | if ( type !== false ) { | |
| 7562 | type = type || "fx"; | |
| 7563 | } | |
| 7564 | return this.each(function() { | |
| 7565 | var index, | |
| 7566 | data = jQuery._data( this ), | |
| 7567 | queue = data[ type + "queue" ], | |
| 7568 | hooks = data[ type + "queueHooks" ], | |
| 7569 | timers = jQuery.timers, | |
| 7570 | length = queue ? queue.length : 0; | |
| 7571 | ||
| 7572 | // enable finishing flag on private data | |
| 7573 | data.finish = true; | |
| 7574 | ||
| 7575 | // empty the queue first | |
| 7576 | jQuery.queue( this, type, [] ); | |
| 7577 | ||
| 7578 | if ( hooks && hooks.stop ) { | |
| 7579 | hooks.stop.call( this, true ); | |
| 7580 | } | |
| 7581 | ||
| 7582 | // look for any active animations, and finish them | |
| 7583 | for ( index = timers.length; index--; ) { | |
| 7584 | if ( timers[ index ].elem === this && timers[ index ].queue === type ) { | |
| 7585 | timers[ index ].anim.stop( true ); | |
| 7586 | timers.splice( index, 1 ); | |
| 7587 | } | |
| 7588 | } | |
| 7589 | ||
| 7590 | // look for any animations in the old queue and finish them | |
| 7591 | for ( index = 0; index < length; index++ ) { | |
| 7592 | if ( queue[ index ] && queue[ index ].finish ) { | |
| 7593 | queue[ index ].finish.call( this ); | |
| 7594 | } | |
| 7595 | } | |
| 7596 | ||
| 7597 | // turn off finishing flag | |
| 7598 | delete data.finish; | |
| 7599 | }); | |
| 7600 | } | |
| 7601 | }); | |
| 7602 | ||
| 7603 | jQuery.each([ "toggle", "show", "hide" ], function( i, name ) { | |
| 7604 | var cssFn = jQuery.fn[ name ]; | |
| 7605 | jQuery.fn[ name ] = function( speed, easing, callback ) { | |
| 7606 | return speed == null || typeof speed === "boolean" ? | |
| 7607 | cssFn.apply( this, arguments ) : | |
| 7608 | this.animate( genFx( name, true ), speed, easing, callback ); | |
| 7609 | }; | |
| 7610 | }); | |
| 7611 | ||
| 7612 | // Generate shortcuts for custom animations | |
| 7613 | jQuery.each({ | |
| 7614 | slideDown: genFx("show"), | |
| 7615 | slideUp: genFx("hide"), | |
| 7616 | slideToggle: genFx("toggle"), | |
| 7617 | fadeIn: { opacity: "show" }, | |
| 7618 | fadeOut: { opacity: "hide" }, | |
| 7619 | fadeToggle: { opacity: "toggle" } | |
| 7620 | }, function( name, props ) { | |
| 7621 | jQuery.fn[ name ] = function( speed, easing, callback ) { | |
| 7622 | return this.animate( props, speed, easing, callback ); | |
| 7623 | }; | |
| 7624 | }); | |
| 7625 | ||
| 7626 | jQuery.timers = []; | |
| 7627 | jQuery.fx.tick = function() { | |
| 7628 | var timer, | |
| 7629 | timers = jQuery.timers, | |
| 7630 | i = 0; | |
| 7631 | ||
| 7632 | fxNow = jQuery.now(); | |
| 7633 | ||
| 7634 | for ( ; i < timers.length; i++ ) { | |
| 7635 | timer = timers[ i ]; | |
| 7636 | // Checks the timer has not already been removed | |
| 7637 | if ( !timer() && timers[ i ] === timer ) { | |
| 7638 | timers.splice( i--, 1 ); | |
| 7639 | } | |
| 7640 | } | |
| 7641 | ||
| 7642 | if ( !timers.length ) { | |
| 7643 | jQuery.fx.stop(); | |
| 7644 | } | |
| 7645 | fxNow = undefined; | |
| 7646 | }; | |
| 7647 | ||
| 7648 | jQuery.fx.timer = function( timer ) { | |
| 7649 | jQuery.timers.push( timer ); | |
| 7650 | if ( timer() ) { | |
| 7651 | jQuery.fx.start(); | |
| 7652 | } else { | |
| 7653 | jQuery.timers.pop(); | |
| 7654 | } | |
| 7655 | }; | |
| 7656 | ||
| 7657 | jQuery.fx.interval = 13; | |
| 7658 | ||
| 7659 | jQuery.fx.start = function() { | |
| 7660 | if ( !timerId ) { | |
| 7661 | timerId = setInterval( jQuery.fx.tick, jQuery.fx.interval ); | |
| 7662 | } | |
| 7663 | }; | |
| 7664 | ||
| 7665 | jQuery.fx.stop = function() { | |
| 7666 | clearInterval( timerId ); | |
| 7667 | timerId = null; | |
| 7668 | }; | |
| 7669 | ||
| 7670 | jQuery.fx.speeds = { | |
| 7671 | slow: 600, | |
| 7672 | fast: 200, | |
| 7673 | // Default speed | |
| 7674 | _default: 400 | |
| 7675 | }; | |
| 7676 | ||
| 7677 | ||
| 7678 | // Based off of the plugin by Clint Helfers, with permission. | |
| 7679 | // http://blindsignals.com/index.php/2009/07/jquery-delay/ | |
| 7680 | jQuery.fn.delay = function( time, type ) { | |
| 7681 | time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; | |
| 7682 | type = type || "fx"; | |
| 7683 | ||
| 7684 | return this.queue( type, function( next, hooks ) { | |
| 7685 | var timeout = setTimeout( next, time ); | |
| 7686 | hooks.stop = function() { | |
| 7687 | clearTimeout( timeout ); | |
| 7688 | }; | |
| 7689 | }); | |
| 7690 | }; | |
| 7691 | ||
| 7692 | ||
| 7693 | (function() { | |
| 7694 | // Minified: var a,b,c,d,e | |
| 7695 | var input, div, select, a, opt; | |
| 7696 | ||
| 7697 | // Setup | |
| 7698 | div = document.createElement( "div" ); | |
| 7699 | div.setAttribute( "className", "t" ); | |
| 7700 | div.innerHTML = " <link/><table></table><a href='/a'>a</a><input type='checkbox'/>"; | |
| 7701 | a = div.getElementsByTagName("a")[ 0 ]; | |
| 7702 | ||
| 7703 | // First batch of tests. | |
| 7704 | select = document.createElement("select"); | |
| 7705 | opt = select.appendChild( document.createElement("option") ); | |
| 7706 | input = div.getElementsByTagName("input")[ 0 ]; | |
| 7707 | ||
| 7708 | a.style.cssText = "top:1px"; | |
| 7709 | ||
| 7710 | // Test setAttribute on camelCase class. If it works, we need attrFixes when doing get/setAttribute (ie6/7) | |
| 7711 | support.getSetAttribute = div.className !== "t"; | |
| 7712 | ||
| 7713 | // Get the style information from getAttribute | |
| 7714 | // (IE uses .cssText instead) | |
| 7715 | support.style = /top/.test( a.getAttribute("style") ); | |
| 7716 | ||
| 7717 | // Make sure that URLs aren't manipulated | |
| 7718 | // (IE normalizes it by default) | |
| 7719 | support.hrefNormalized = a.getAttribute("href") === "/a"; | |
| 7720 | ||
| 7721 | // Check the default checkbox/radio value ("" on WebKit; "on" elsewhere) | |
| 7722 | support.checkOn = !!input.value; | |
| 7723 | ||
| 7724 | // Make sure that a selected-by-default option has a working selected property. | |
| 7725 | // (WebKit defaults to false instead of true, IE too, if it's in an optgroup) | |
| 7726 | support.optSelected = opt.selected; | |
| 7727 | ||
| 7728 | // Tests for enctype support on a form (#6743) | |
| 7729 | support.enctype = !!document.createElement("form").enctype; | |
| 7730 | ||
| 7731 | // Make sure that the options inside disabled selects aren't marked as disabled | |
| 7732 | // (WebKit marks them as disabled) | |
| 7733 | select.disabled = true; | |
| 7734 | support.optDisabled = !opt.disabled; | |
| 7735 | ||
| 7736 | // Support: IE8 only | |
| 7737 | // Check if we can trust getAttribute("value") | |
| 7738 | input = document.createElement( "input" ); | |
| 7739 | input.setAttribute( "value", "" ); | |
| 7740 | support.input = input.getAttribute( "value" ) === ""; | |
| 7741 | ||
| 7742 | // Check if an input maintains its value after becoming a radio | |
| 7743 | input.value = "t"; | |
| 7744 | input.setAttribute( "type", "radio" ); | |
| 7745 | support.radioValue = input.value === "t"; | |
| 7746 | })(); | |
| 7747 | ||
| 7748 | ||
| 7749 | var rreturn = /\r/g; | |
| 7750 | ||
| 7751 | jQuery.fn.extend({ | |
| 7752 | val: function( value ) { | |
| 7753 | var hooks, ret, isFunction, | |
| 7754 | elem = this[0]; | |
| 7755 | ||
| 7756 | if ( !arguments.length ) { | |
| 7757 | if ( elem ) { | |
| 7758 | hooks = jQuery.valHooks[ elem.type ] || jQuery.valHooks[ elem.nodeName.toLowerCase() ]; | |
| 7759 | ||
| 7760 | if ( hooks && "get" in hooks && (ret = hooks.get( elem, "value" )) !== undefined ) { | |
| 7761 | return ret; | |
| 7762 | } | |
| 7763 | ||
| 7764 | ret = elem.value; | |
| 7765 | ||
| 7766 | return typeof ret === "string" ? | |
| 7767 | // handle most common string cases | |
| 7768 | ret.replace(rreturn, "") : | |
| 7769 | // handle cases where value is null/undef or number | |
| 7770 | ret == null ? "" : ret; | |
| 7771 | } | |
| 7772 | ||
| 7773 | return; | |
| 7774 | } | |
| 7775 | ||
| 7776 | isFunction = jQuery.isFunction( value ); | |
| 7777 | ||
| 7778 | return this.each(function( i ) { | |
| 7779 | var val; | |
| 7780 | ||
| 7781 | if ( this.nodeType !== 1 ) { | |
| 7782 | return; | |
| 7783 | } | |
| 7784 | ||
| 7785 | if ( isFunction ) { | |
| 7786 | val = value.call( this, i, jQuery( this ).val() ); | |
| 7787 | } else { | |
| 7788 | val = value; | |
| 7789 | } | |
| 7790 | ||
| 7791 | // Treat null/undefined as ""; convert numbers to string | |
| 7792 | if ( val == null ) { | |
| 7793 | val = ""; | |
| 7794 | } else if ( typeof val === "number" ) { | |
| 7795 | val += ""; | |
| 7796 | } else if ( jQuery.isArray( val ) ) { | |
| 7797 | val = jQuery.map( val, function( value ) { | |
| 7798 | return value == null ? "" : value + ""; | |
| 7799 | }); | |
| 7800 | } | |
| 7801 | ||
| 7802 | hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; | |
| 7803 | ||
| 7804 | // If set returns undefined, fall back to normal setting | |
| 7805 | if ( !hooks || !("set" in hooks) || hooks.set( this, val, "value" ) === undefined ) { | |
| 7806 | this.value = val; | |
| 7807 | } | |
| 7808 | }); | |
| 7809 | } | |
| 7810 | }); | |
| 7811 | ||
| 7812 | jQuery.extend({ | |
| 7813 | valHooks: { | |
| 7814 | option: { | |
| 7815 | get: function( elem ) { | |
| 7816 | var val = jQuery.find.attr( elem, "value" ); | |
| 7817 | return val != null ? | |
| 7818 | val : | |
| 7819 | // Support: IE10-11+ | |
| 7820 | // option.text throws exceptions (#14686, #14858) | |
| 7821 | jQuery.trim( jQuery.text( elem ) ); | |
| 7822 | } | |
| 7823 | }, | |
| 7824 | select: { | |
| 7825 | get: function( elem ) { | |
| 7826 | var value, option, | |
| 7827 | options = elem.options, | |
| 7828 | index = elem.selectedIndex, | |
| 7829 | one = elem.type === "select-one" || index < 0, | |
| 7830 | values = one ? null : [], | |
| 7831 | max = one ? index + 1 : options.length, | |
| 7832 | i = index < 0 ? | |
| 7833 | max : | |
| 7834 | one ? index : 0; | |
| 7835 | ||
| 7836 | // Loop through all the selected options | |
| 7837 | for ( ; i < max; i++ ) { | |
| 7838 | option = options[ i ]; | |
| 7839 | ||
| 7840 | // oldIE doesn't update selected after form reset (#2551) | |
| 7841 | if ( ( option.selected || i === index ) && | |
| 7842 | // Don't return options that are disabled or in a disabled optgroup | |
| 7843 | ( support.optDisabled ? !option.disabled : option.getAttribute("disabled") === null ) && | |
| 7844 | ( !option.parentNode.disabled || !jQuery.nodeName( option.parentNode, "optgroup" ) ) ) { | |
| 7845 | ||
| 7846 | // Get the specific value for the option | |
| 7847 | value = jQuery( option ).val(); | |
| 7848 | ||
| 7849 | // We don't need an array for one selects | |
| 7850 | if ( one ) { | |
| 7851 | return value; | |
| 7852 | } | |
| 7853 | ||
| 7854 | // Multi-Selects return an array | |
| 7855 | values.push( value ); | |
| 7856 | } | |
| 7857 | } | |
| 7858 | ||
| 7859 | return values; | |
| 7860 | }, | |
| 7861 | ||
| 7862 | set: function( elem, value ) { | |
| 7863 | var optionSet, option, | |
| 7864 | options = elem.options, | |
| 7865 | values = jQuery.makeArray( value ), | |
| 7866 | i = options.length; | |
| 7867 | ||
| 7868 | while ( i-- ) { | |
| 7869 | option = options[ i ]; | |
| 7870 | ||
| 7871 | if ( jQuery.inArray( jQuery.valHooks.option.get( option ), values ) >= 0 ) { | |
| 7872 | ||
| 7873 | // Support: IE6 | |
| 7874 | // When new option element is added to select box we need to | |
| 7875 | // force reflow of newly added node in order to workaround delay | |
| 7876 | // of initialization properties | |
| 7877 | try { | |
| 7878 | option.selected = optionSet = true; | |
| 7879 | ||
| 7880 | } catch ( _ ) { | |
| 7881 | ||
| 7882 | // Will be executed only in IE6 | |
| 7883 | option.scrollHeight; | |
| 7884 | } | |
| 7885 | ||
| 7886 | } else { | |
| 7887 | option.selected = false; | |
| 7888 | } | |
| 7889 | } | |
| 7890 | ||
| 7891 | // Force browsers to behave consistently when non-matching value is set | |
| 7892 | if ( !optionSet ) { | |
| 7893 | elem.selectedIndex = -1; | |
| 7894 | } | |
| 7895 | ||
| 7896 | return options; | |
| 7897 | } | |
| 7898 | } | |
| 7899 | } | |
| 7900 | }); | |
| 7901 | ||
| 7902 | // Radios and checkboxes getter/setter | |
| 7903 | jQuery.each([ "radio", "checkbox" ], function() { | |
| 7904 | jQuery.valHooks[ this ] = { | |
| 7905 | set: function( elem, value ) { | |
| 7906 | if ( jQuery.isArray( value ) ) { | |
| 7907 | return ( elem.checked = jQuery.inArray( jQuery(elem).val(), value ) >= 0 ); | |
| 7908 | } | |
| 7909 | } | |
| 7910 | }; | |
| 7911 | if ( !support.checkOn ) { | |
| 7912 | jQuery.valHooks[ this ].get = function( elem ) { | |
| 7913 | // Support: Webkit | |
| 7914 | // "" is returned instead of "on" if a value isn't specified | |
| 7915 | return elem.getAttribute("value") === null ? "on" : elem.value; | |
| 7916 | }; | |
| 7917 | } | |
| 7918 | }); | |
| 7919 | ||
| 7920 | ||
| 7921 | ||
| 7922 | ||
| 7923 | var nodeHook, boolHook, | |
| 7924 | attrHandle = jQuery.expr.attrHandle, | |
| 7925 | ruseDefault = /^(?:checked|selected)$/i, | |
| 7926 | getSetAttribute = support.getSetAttribute, | |
| 7927 | getSetInput = support.input; | |
| 7928 | ||
| 7929 | jQuery.fn.extend({ | |
| 7930 | attr: function( name, value ) { | |
| 7931 | return access( this, jQuery.attr, name, value, arguments.length > 1 ); | |
| 7932 | }, | |
| 7933 | ||
| 7934 | removeAttr: function( name ) { | |
| 7935 | return this.each(function() { | |
| 7936 | jQuery.removeAttr( this, name ); | |
| 7937 | }); | |
| 7938 | } | |
| 7939 | }); | |
| 7940 | ||
| 7941 | jQuery.extend({ | |
| 7942 | attr: function( elem, name, value ) { | |
| 7943 | var hooks, ret, | |
| 7944 | nType = elem.nodeType; | |
| 7945 | ||
| 7946 | // don't get/set attributes on text, comment and attribute nodes | |
| 7947 | if ( !elem || nType === 3 || nType === 8 || nType === 2 ) { | |
| 7948 | return; | |
| 7949 | } | |
| 7950 | ||
| 7951 | // Fallback to prop when attributes are not supported | |
| 7952 | if ( typeof elem.getAttribute === strundefined ) { | |
| 7953 | return jQuery.prop( elem, name, value ); | |
| 7954 | } | |
| 7955 | ||
| 7956 | // All attributes are lowercase | |
| 7957 | // Grab necessary hook if one is defined | |
| 7958 | if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { | |
| 7959 | name = name.toLowerCase(); | |
| 7960 | hooks = jQuery.attrHooks[ name ] || | |
| 7961 | ( jQuery.expr.match.bool.test( name ) ? boolHook : nodeHook ); | |
| 7962 | } | |
| 7963 | ||
| 7964 | if ( value !== undefined ) { | |
| 7965 | ||
| 7966 | if ( value === null ) { | |
| 7967 | jQuery.removeAttr( elem, name ); | |
| 7968 | ||
| 7969 | } else if ( hooks && "set" in hooks && (ret = hooks.set( elem, value, name )) !== undefined ) { | |
| 7970 | return ret; | |
| 7971 | ||
| 7972 | } else { | |
| 7973 | elem.setAttribute( name, value + "" ); | |
| 7974 | return value; | |
| 7975 | } | |
| 7976 | ||
| 7977 | } else if ( hooks && "get" in hooks && (ret = hooks.get( elem, name )) !== null ) { | |
| 7978 | return ret; | |
| 7979 | ||
| 7980 | } else { | |
| 7981 | ret = jQuery.find.attr( elem, name ); | |
| 7982 | ||
| 7983 | // Non-existent attributes return null, we normalize to undefined | |
| 7984 | return ret == null ? | |
| 7985 | undefined : | |
| 7986 | ret; | |
| 7987 | } | |
| 7988 | }, | |
| 7989 | ||
| 7990 | removeAttr: function( elem, value ) { | |
| 7991 | var name, propName, | |
| 7992 | i = 0, | |
| 7993 | attrNames = value && value.match( rnotwhite ); | |
| 7994 | ||
| 7995 | if ( attrNames && elem.nodeType === 1 ) { | |
| 7996 | while ( (name = attrNames[i++]) ) { | |
| 7997 | propName = jQuery.propFix[ name ] || name; | |
| 7998 | ||
| 7999 | // Boolean attributes get special treatment (#10870) | |
| 8000 | if ( jQuery.expr.match.bool.test( name ) ) { | |
| 8001 | // Set corresponding property to false | |
| 8002 | if ( getSetInput && getSetAttribute || !ruseDefault.test( name ) ) { | |
| 8003 | elem[ propName ] = false; | |
| 8004 | // Support: IE<9 | |
| 8005 | // Also clear defaultChecked/defaultSelected (if appropriate) | |
| 8006 | } else { | |
| 8007 | elem[ jQuery.camelCase( "default-" + name ) ] = | |
| 8008 | elem[ propName ] = false; | |
| 8009 | } | |
| 8010 | ||
| 8011 | // See #9699 for explanation of this approach (setting first, then removal) | |
| 8012 | } else { | |
| 8013 | jQuery.attr( elem, name, "" ); | |
| 8014 | } | |
| 8015 | ||
| 8016 | elem.removeAttribute( getSetAttribute ? name : propName ); | |
| 8017 | } | |
| 8018 | } | |
| 8019 | }, | |
| 8020 | ||
| 8021 | attrHooks: { | |
| 8022 | type: { | |
| 8023 | set: function( elem, value ) { | |
| 8024 | if ( !support.radioValue && value === "radio" && jQuery.nodeName(elem, "input") ) { | |
| 8025 | // Setting the type on a radio button after the value resets the value in IE6-9 | |
| 8026 | // Reset value to default in case type is set after value during creation | |
| 8027 | var val = elem.value; | |
| 8028 | elem.setAttribute( "type", value ); | |
| 8029 | if ( val ) { | |
| 8030 | elem.value = val; | |
| 8031 | } | |
| 8032 | return value; | |
| 8033 | } | |
| 8034 | } | |
| 8035 | } | |
| 8036 | } | |
| 8037 | }); | |
| 8038 | ||
| 8039 | // Hook for boolean attributes | |
| 8040 | boolHook = { | |
| 8041 | set: function( elem, value, name ) { | |
| 8042 | if ( value === false ) { | |
| 8043 | // Remove boolean attributes when set to false | |
| 8044 | jQuery.removeAttr( elem, name ); | |
| 8045 | } else if ( getSetInput && getSetAttribute || !ruseDefault.test( name ) ) { | |
| 8046 | // IE<8 needs the *property* name | |
| 8047 | elem.setAttribute( !getSetAttribute && jQuery.propFix[ name ] || name, name ); | |
| 8048 | ||
| 8049 | // Use defaultChecked and defaultSelected for oldIE | |
| 8050 | } else { | |
| 8051 | elem[ jQuery.camelCase( "default-" + name ) ] = elem[ name ] = true; | |
| 8052 | } | |
| 8053 | ||
| 8054 | return name; | |
| 8055 | } | |
| 8056 | }; | |
| 8057 | ||
| 8058 | // Retrieve booleans specially | |
| 8059 | jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) { | |
| 8060 | ||
| 8061 | var getter = attrHandle[ name ] || jQuery.find.attr; | |
| 8062 | ||
| 8063 | attrHandle[ name ] = getSetInput && getSetAttribute || !ruseDefault.test( name ) ? | |
| 8064 | function( elem, name, isXML ) { | |
| 8065 | var ret, handle; | |
| 8066 | if ( !isXML ) { | |
| 8067 | // Avoid an infinite loop by temporarily removing this function from the getter | |
| 8068 | handle = attrHandle[ name ]; | |
| 8069 | attrHandle[ name ] = ret; | |
| 8070 | ret = getter( elem, name, isXML ) != null ? | |
| 8071 | name.toLowerCase() : | |
| 8072 | null; | |
| 8073 | attrHandle[ name ] = handle; | |
| 8074 | } | |
| 8075 | return ret; | |
| 8076 | } : | |
| 8077 | function( elem, name, isXML ) { | |
| 8078 | if ( !isXML ) { | |
| 8079 | return elem[ jQuery.camelCase( "default-" + name ) ] ? | |
| 8080 | name.toLowerCase() : | |
| 8081 | null; | |
| 8082 | } | |
| 8083 | }; | |
| 8084 | }); | |
| 8085 | ||
| 8086 | // fix oldIE attroperties | |
| 8087 | if ( !getSetInput || !getSetAttribute ) { | |
| 8088 | jQuery.attrHooks.value = { | |
| 8089 | set: function( elem, value, name ) { | |
| 8090 | if ( jQuery.nodeName( elem, "input" ) ) { | |
| 8091 | // Does not return so that setAttribute is also used | |
| 8092 | elem.defaultValue = value; | |
| 8093 | } else { | |
| 8094 | // Use nodeHook if defined (#1954); otherwise setAttribute is fine | |
| 8095 | return nodeHook && nodeHook.set( elem, value, name ); | |
| 8096 | } | |
| 8097 | } | |
| 8098 | }; | |
| 8099 | } | |
| 8100 | ||
| 8101 | // IE6/7 do not support getting/setting some attributes with get/setAttribute | |
| 8102 | if ( !getSetAttribute ) { | |
| 8103 | ||
| 8104 | // Use this for any attribute in IE6/7 | |
| 8105 | // This fixes almost every IE6/7 issue | |
| 8106 | nodeHook = { | |
| 8107 | set: function( elem, value, name ) { | |
| 8108 | // Set the existing or create a new attribute node | |
| 8109 | var ret = elem.getAttributeNode( name ); | |
| 8110 | if ( !ret ) { | |
| 8111 | elem.setAttributeNode( | |
| 8112 | (ret = elem.ownerDocument.createAttribute( name )) | |
| 8113 | ); | |
| 8114 | } | |
| 8115 | ||
| 8116 | ret.value = value += ""; | |
| 8117 | ||
| 8118 | // Break association with cloned elements by also using setAttribute (#9646) | |
| 8119 | if ( name === "value" || value === elem.getAttribute( name ) ) { | |
| 8120 | return value; | |
| 8121 | } | |
| 8122 | } | |
| 8123 | }; | |
| 8124 | ||
| 8125 | // Some attributes are constructed with empty-string values when not defined | |
| 8126 | attrHandle.id = attrHandle.name = attrHandle.coords = | |
| 8127 | function( elem, name, isXML ) { | |
| 8128 | var ret; | |
| 8129 | if ( !isXML ) { | |
| 8130 | return (ret = elem.getAttributeNode( name )) && ret.value !== "" ? | |
| 8131 | ret.value : | |
| 8132 | null; | |
| 8133 | } | |
| 8134 | }; | |
| 8135 | ||
| 8136 | // Fixing value retrieval on a button requires this module | |
| 8137 | jQuery.valHooks.button = { | |
| 8138 | get: function( elem, name ) { | |
| 8139 | var ret = elem.getAttributeNode( name ); | |
| 8140 | if ( ret && ret.specified ) { | |
| 8141 | return ret.value; | |
| 8142 | } | |
| 8143 | }, | |
| 8144 | set: nodeHook.set | |
| 8145 | }; | |
| 8146 | ||
| 8147 | // Set contenteditable to false on removals(#10429) | |
| 8148 | // Setting to empty string throws an error as an invalid value | |
| 8149 | jQuery.attrHooks.contenteditable = { | |
| 8150 | set: function( elem, value, name ) { | |
| 8151 | nodeHook.set( elem, value === "" ? false : value, name ); | |
| 8152 | } | |
| 8153 | }; | |
| 8154 | ||
| 8155 | // Set width and height to auto instead of 0 on empty string( Bug #8150 ) | |
| 8156 | // This is for removals | |
| 8157 | jQuery.each([ "width", "height" ], function( i, name ) { | |
| 8158 | jQuery.attrHooks[ name ] = { | |
| 8159 | set: function( elem, value ) { | |
| 8160 | if ( value === "" ) { | |
| 8161 | elem.setAttribute( name, "auto" ); | |
| 8162 | return value; | |
| 8163 | } | |
| 8164 | } | |
| 8165 | }; | |
| 8166 | }); | |
| 8167 | } | |
| 8168 | ||
| 8169 | if ( !support.style ) { | |
| 8170 | jQuery.attrHooks.style = { | |
| 8171 | get: function( elem ) { | |
| 8172 | // Return undefined in the case of empty string | |
| 8173 | // Note: IE uppercases css property names, but if we were to .toLowerCase() | |
| 8174 | // .cssText, that would destroy case senstitivity in URL's, like in "background" | |
| 8175 | return elem.style.cssText || undefined; | |
| 8176 | }, | |
| 8177 | set: function( elem, value ) { | |
| 8178 | return ( elem.style.cssText = value + "" ); | |
| 8179 | } | |
| 8180 | }; | |
| 8181 | } | |
| 8182 | ||
| 8183 | ||
| 8184 | ||
| 8185 | ||
| 8186 | var rfocusable = /^(?:input|select|textarea|button|object)$/i, | |
| 8187 | rclickable = /^(?:a|area)$/i; | |
| 8188 | ||
| 8189 | jQuery.fn.extend({ | |
| 8190 | prop: function( name, value ) { | |
| 8191 | return access( this, jQuery.prop, name, value, arguments.length > 1 ); | |
| 8192 | }, | |
| 8193 | ||
| 8194 | removeProp: function( name ) { | |
| 8195 | name = jQuery.propFix[ name ] || name; | |
| 8196 | return this.each(function() { | |
| 8197 | // try/catch handles cases where IE balks (such as removing a property on window) | |
| 8198 | try { | |
| 8199 | this[ name ] = undefined; | |
| 8200 | delete this[ name ]; | |
| 8201 | } catch( e ) {} | |
| 8202 | }); | |
| 8203 | } | |
| 8204 | }); | |
| 8205 | ||
| 8206 | jQuery.extend({ | |
| 8207 | propFix: { | |
| 8208 | "for": "htmlFor", | |
| 8209 | "class": "className" | |
| 8210 | }, | |
| 8211 | ||
| 8212 | prop: function( elem, name, value ) { | |
| 8213 | var ret, hooks, notxml, | |
| 8214 | nType = elem.nodeType; | |
| 8215 | ||
| 8216 | // don't get/set properties on text, comment and attribute nodes | |
| 8217 | if ( !elem || nType === 3 || nType === 8 || nType === 2 ) { | |
| 8218 | return; | |
| 8219 | } | |
| 8220 | ||
| 8221 | notxml = nType !== 1 || !jQuery.isXMLDoc( elem ); | |
| 8222 | ||
| 8223 | if ( notxml ) { | |
| 8224 | // Fix name and attach hooks | |
| 8225 | name = jQuery.propFix[ name ] || name; | |
| 8226 | hooks = jQuery.propHooks[ name ]; | |
| 8227 | } | |
| 8228 | ||
| 8229 | if ( value !== undefined ) { | |
| 8230 | return hooks && "set" in hooks && (ret = hooks.set( elem, value, name )) !== undefined ? | |
| 8231 | ret : | |
| 8232 | ( elem[ name ] = value ); | |
| 8233 | ||
| 8234 | } else { | |
| 8235 | return hooks && "get" in hooks && (ret = hooks.get( elem, name )) !== null ? | |
| 8236 | ret : | |
| 8237 | elem[ name ]; | |
| 8238 | } | |
| 8239 | }, | |
| 8240 | ||
| 8241 | propHooks: { | |
| 8242 | tabIndex: { | |
| 8243 | get: function( elem ) { | |
| 8244 | // elem.tabIndex doesn't always return the correct value when it hasn't been explicitly set | |
| 8245 | // http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ | |
| 8246 | // Use proper attribute retrieval(#12072) | |
| 8247 | var tabindex = jQuery.find.attr( elem, "tabindex" ); | |
| 8248 | ||
| 8249 | return tabindex ? | |
| 8250 | parseInt( tabindex, 10 ) : | |
| 8251 | rfocusable.test( elem.nodeName ) || rclickable.test( elem.nodeName ) && elem.href ? | |
| 8252 | 0 : | |
| 8253 | -1; | |
| 8254 | } | |
| 8255 | } | |
| 8256 | } | |
| 8257 | }); | |
| 8258 | ||
| 8259 | // Some attributes require a special call on IE | |
| 8260 | // http://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx | |
| 8261 | if ( !support.hrefNormalized ) { | |
| 8262 | // href/src property should get the full normalized URL (#10299/#12915) | |
| 8263 | jQuery.each([ "href", "src" ], function( i, name ) { | |
| 8264 | jQuery.propHooks[ name ] = { | |
| 8265 | get: function( elem ) { | |
| 8266 | return elem.getAttribute( name, 4 ); | |
| 8267 | } | |
| 8268 | }; | |
| 8269 | }); | |
| 8270 | } | |
| 8271 | ||
| 8272 | // Support: Safari, IE9+ | |
| 8273 | // mis-reports the default selected property of an option | |
| 8274 | // Accessing the parent's selectedIndex property fixes it | |
| 8275 | if ( !support.optSelected ) { | |
| 8276 | jQuery.propHooks.selected = { | |
| 8277 | get: function( elem ) { | |
| 8278 | var parent = elem.parentNode; | |
| 8279 | ||
| 8280 | if ( parent ) { | |
| 8281 | parent.selectedIndex; | |
| 8282 | ||
| 8283 | // Make sure that it also works with optgroups, see #5701 | |
| 8284 | if ( parent.parentNode ) { | |
| 8285 | parent.parentNode.selectedIndex; | |
| 8286 | } | |
| 8287 | } | |
| 8288 | return null; | |
| 8289 | } | |
| 8290 | }; | |
| 8291 | } | |
| 8292 | ||
| 8293 | jQuery.each([ | |
| 8294 | "tabIndex", | |
| 8295 | "readOnly", | |
| 8296 | "maxLength", | |
| 8297 | "cellSpacing", | |
| 8298 | "cellPadding", | |
| 8299 | "rowSpan", | |
| 8300 | "colSpan", | |
| 8301 | "useMap", | |
| 8302 | "frameBorder", | |
| 8303 | "contentEditable" | |
| 8304 | ], function() { | |
| 8305 | jQuery.propFix[ this.toLowerCase() ] = this; | |
| 8306 | }); | |
| 8307 | ||
| 8308 | // IE6/7 call enctype encoding | |
| 8309 | if ( !support.enctype ) { | |
| 8310 | jQuery.propFix.enctype = "encoding"; | |
| 8311 | } | |
| 8312 | ||
| 8313 | ||
| 8314 | ||
| 8315 | ||
| 8316 | var rclass = /[\t\r\n\f]/g; | |
| 8317 | ||
| 8318 | jQuery.fn.extend({ | |
| 8319 | addClass: function( value ) { | |
| 8320 | var classes, elem, cur, clazz, j, finalValue, | |
| 8321 | i = 0, | |
| 8322 | len = this.length, | |
| 8323 | proceed = typeof value === "string" && value; | |
| 8324 | ||
| 8325 | if ( jQuery.isFunction( value ) ) { | |
| 8326 | return this.each(function( j ) { | |
| 8327 | jQuery( this ).addClass( value.call( this, j, this.className ) ); | |
| 8328 | }); | |
| 8329 | } | |
| 8330 | ||
| 8331 | if ( proceed ) { | |
| 8332 | // The disjunction here is for better compressibility (see removeClass) | |
| 8333 | classes = ( value || "" ).match( rnotwhite ) || []; | |
| 8334 | ||
| 8335 | for ( ; i < len; i++ ) { | |
| 8336 | elem = this[ i ]; | |
| 8337 | cur = elem.nodeType === 1 && ( elem.className ? | |
| 8338 | ( " " + elem.className + " " ).replace( rclass, " " ) : | |
| 8339 | " " | |
| 8340 | ); | |
| 8341 | ||
| 8342 | if ( cur ) { | |
| 8343 | j = 0; | |
| 8344 | while ( (clazz = classes[j++]) ) { | |
| 8345 | if ( cur.indexOf( " " + clazz + " " ) < 0 ) { | |
| 8346 | cur += clazz + " "; | |
| 8347 | } | |
| 8348 | } | |
| 8349 | ||
| 8350 | // only assign if different to avoid unneeded rendering. | |
| 8351 | finalValue = jQuery.trim( cur ); | |
| 8352 | if ( elem.className !== finalValue ) { | |
| 8353 | elem.className = finalValue; | |
| 8354 | } | |
| 8355 | } | |
| 8356 | } | |
| 8357 | } | |
| 8358 | ||
| 8359 | return this; | |
| 8360 | }, | |
| 8361 | ||
| 8362 | removeClass: function( value ) { | |
| 8363 | var classes, elem, cur, clazz, j, finalValue, | |
| 8364 | i = 0, | |
| 8365 | len = this.length, | |
| 8366 | proceed = arguments.length === 0 || typeof value === "string" && value; | |
| 8367 | ||
| 8368 | if ( jQuery.isFunction( value ) ) { | |
| 8369 | return this.each(function( j ) { | |
| 8370 | jQuery( this ).removeClass( value.call( this, j, this.className ) ); | |
| 8371 | }); | |
| 8372 | } | |
| 8373 | if ( proceed ) { | |
| 8374 | classes = ( value || "" ).match( rnotwhite ) || []; | |
| 8375 | ||
| 8376 | for ( ; i < len; i++ ) { | |
| 8377 | elem = this[ i ]; | |
| 8378 | // This expression is here for better compressibility (see addClass) | |
| 8379 | cur = elem.nodeType === 1 && ( elem.className ? | |
| 8380 | ( " " + elem.className + " " ).replace( rclass, " " ) : | |
| 8381 | "" | |
| 8382 | ); | |
| 8383 | ||
| 8384 | if ( cur ) { | |
| 8385 | j = 0; | |
| 8386 | while ( (clazz = classes[j++]) ) { | |
| 8387 | // Remove *all* instances | |
| 8388 | while ( cur.indexOf( " " + clazz + " " ) >= 0 ) { | |
| 8389 | cur = cur.replace( " " + clazz + " ", " " ); | |
| 8390 | } | |
| 8391 | } | |
| 8392 | ||
| 8393 | // only assign if different to avoid unneeded rendering. | |
| 8394 | finalValue = value ? jQuery.trim( cur ) : ""; | |
| 8395 | if ( elem.className !== finalValue ) { | |
| 8396 | elem.className = finalValue; | |
| 8397 | } | |
| 8398 | } | |
| 8399 | } | |
| 8400 | } | |
| 8401 | ||
| 8402 | return this; | |
| 8403 | }, | |
| 8404 | ||
| 8405 | toggleClass: function( value, stateVal ) { | |
| 8406 | var type = typeof value; | |
| 8407 | ||
| 8408 | if ( typeof stateVal === "boolean" && type === "string" ) { | |
| 8409 | return stateVal ? this.addClass( value ) : this.removeClass( value ); | |
| 8410 | } | |
| 8411 | ||
| 8412 | if ( jQuery.isFunction( value ) ) { | |
| 8413 | return this.each(function( i ) { | |
| 8414 | jQuery( this ).toggleClass( value.call(this, i, this.className, stateVal), stateVal ); | |
| 8415 | }); | |
| 8416 | } | |
| 8417 | ||
| 8418 | return this.each(function() { | |
| 8419 | if ( type === "string" ) { | |
| 8420 | // toggle individual class names | |
| 8421 | var className, | |
| 8422 | i = 0, | |
| 8423 | self = jQuery( this ), | |
| 8424 | classNames = value.match( rnotwhite ) || []; | |
| 8425 | ||
| 8426 | while ( (className = classNames[ i++ ]) ) { | |
| 8427 | // check each className given, space separated list | |
| 8428 | if ( self.hasClass( className ) ) { | |
| 8429 | self.removeClass( className ); | |
| 8430 | } else { | |
| 8431 | self.addClass( className ); | |
| 8432 | } | |
| 8433 | } | |
| 8434 | ||
| 8435 | // Toggle whole class name | |
| 8436 | } else if ( type === strundefined || type === "boolean" ) { | |
| 8437 | if ( this.className ) { | |
| 8438 | // store className if set | |
| 8439 | jQuery._data( this, "__className__", this.className ); | |
| 8440 | } | |
| 8441 | ||
| 8442 | // If the element has a class name or if we're passed "false", | |
| 8443 | // then remove the whole classname (if there was one, the above saved it). | |
| 8444 | // Otherwise bring back whatever was previously saved (if anything), | |
| 8445 | // falling back to the empty string if nothing was stored. | |
| 8446 | this.className = this.className || value === false ? "" : jQuery._data( this, "__className__" ) || ""; | |
| 8447 | } | |
| 8448 | }); | |
| 8449 | }, | |
| 8450 | ||
| 8451 | hasClass: function( selector ) { | |
| 8452 | var className = " " + selector + " ", | |
| 8453 | i = 0, | |
| 8454 | l = this.length; | |
| 8455 | for ( ; i < l; i++ ) { | |
| 8456 | if ( this[i].nodeType === 1 && (" " + this[i].className + " ").replace(rclass, " ").indexOf( className ) >= 0 ) { | |
| 8457 | return true; | |
| 8458 | } | |
| 8459 | } | |
| 8460 | ||
| 8461 | return false; | |
| 8462 | } | |
| 8463 | }); | |
| 8464 | ||
| 8465 | ||
| 8466 | ||
| 8467 | ||
| 8468 | // Return jQuery for attributes-only inclusion | |
| 8469 | ||
| 8470 | ||
| 8471 | jQuery.each( ("blur focus focusin focusout load resize scroll unload click dblclick " + | |
| 8472 | "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " + | |
| 8473 | "change select submit keydown keypress keyup error contextmenu").split(" "), function( i, name ) { | |
| 8474 | ||
| 8475 | // Handle event binding | |
| 8476 | jQuery.fn[ name ] = function( data, fn ) { | |
| 8477 | return arguments.length > 0 ? | |
| 8478 | this.on( name, null, data, fn ) : | |
| 8479 | this.trigger( name ); | |
| 8480 | }; | |
| 8481 | }); | |
| 8482 | ||
| 8483 | jQuery.fn.extend({ | |
| 8484 | hover: function( fnOver, fnOut ) { | |
| 8485 | return this.mouseenter( fnOver ).mouseleave( fnOut || fnOver ); | |
| 8486 | }, | |
| 8487 | ||
| 8488 | bind: function( types, data, fn ) { | |
| 8489 | return this.on( types, null, data, fn ); | |
| 8490 | }, | |
| 8491 | unbind: function( types, fn ) { | |
| 8492 | return this.off( types, null, fn ); | |
| 8493 | }, | |
| 8494 | ||
| 8495 | delegate: function( selector, types, data, fn ) { | |
| 8496 | return this.on( types, selector, data, fn ); | |
| 8497 | }, | |
| 8498 | undelegate: function( selector, types, fn ) { | |
| 8499 | // ( namespace ) or ( selector, types [, fn] ) | |
| 8500 | return arguments.length === 1 ? this.off( selector, "**" ) : this.off( types, selector || "**", fn ); | |
| 8501 | } | |
| 8502 | }); | |
| 8503 | ||
| 8504 | ||
| 8505 | var nonce = jQuery.now(); | |
| 8506 | ||
| 8507 | var rquery = (/\?/); | |
| 8508 | ||
| 8509 | ||
| 8510 | ||
| 8511 | var rvalidtokens = /(,)|(\[|{)|(}|])|"(?:[^"\\\r\n]|\\["\\\/bfnrt]|\\u[\da-fA-F]{4})*"\s*:?|true|false|null|-?(?!0\d)\d+(?:\.\d+|)(?:[eE][+-]?\d+|)/g; | |
| 8512 | ||
| 8513 | jQuery.parseJSON = function( data ) { | |
| 8514 | // Attempt to parse using the native JSON parser first | |
| 8515 | if ( window.JSON && window.JSON.parse ) { | |
| 8516 | // Support: Android 2.3 | |
| 8517 | // Workaround failure to string-cast null input | |
| 8518 | return window.JSON.parse( data + "" ); | |
| 8519 | } | |
| 8520 | ||
| 8521 | var requireNonComma, | |
| 8522 | depth = null, | |
| 8523 | str = jQuery.trim( data + "" ); | |
| 8524 | ||
| 8525 | // Guard against invalid (and possibly dangerous) input by ensuring that nothing remains | |
| 8526 | // after removing valid tokens | |
| 8527 | return str && !jQuery.trim( str.replace( rvalidtokens, function( token, comma, open, close ) { | |
| 8528 | ||
| 8529 | // Force termination if we see a misplaced comma | |
| 8530 | if ( requireNonComma && comma ) { | |
| 8531 | depth = 0; | |
| 8532 | } | |
| 8533 | ||
| 8534 | // Perform no more replacements after returning to outermost depth | |
| 8535 | if ( depth === 0 ) { | |
| 8536 | return token; | |
| 8537 | } | |
| 8538 | ||
| 8539 | // Commas must not follow "[", "{", or "," | |
| 8540 | requireNonComma = open || comma; | |
| 8541 | ||
| 8542 | // Determine new depth | |
| 8543 | // array/object open ("[" or "{"): depth += true - false (increment) | |
| 8544 | // array/object close ("]" or "}"): depth += false - true (decrement) | |
| 8545 | // other cases ("," or primitive): depth += true - true (numeric cast) | |
| 8546 | depth += !close - !open; | |
| 8547 | ||
| 8548 | // Remove this token | |
| 8549 | return ""; | |
| 8550 | }) ) ? | |
| 8551 | ( Function( "return " + str ) )() : | |
| 8552 | jQuery.error( "Invalid JSON: " + data ); | |
| 8553 | }; | |
| 8554 | ||
| 8555 | ||
| 8556 | // Cross-browser xml parsing | |
| 8557 | jQuery.parseXML = function( data ) { | |
| 8558 | var xml, tmp; | |
| 8559 | if ( !data || typeof data !== "string" ) { | |
| 8560 | return null; | |
| 8561 | } | |
| 8562 | try { | |
| 8563 | if ( window.DOMParser ) { // Standard | |
| 8564 | tmp = new DOMParser(); | |
| 8565 | xml = tmp.parseFromString( data, "text/xml" ); | |
| 8566 | } else { // IE | |
| 8567 | xml = new ActiveXObject( "Microsoft.XMLDOM" ); | |
| 8568 | xml.async = "false"; | |
| 8569 | xml.loadXML( data ); | |
| 8570 | } | |
| 8571 | } catch( e ) { | |
| 8572 | xml = undefined; | |
| 8573 | } | |
| 8574 | if ( !xml || !xml.documentElement || xml.getElementsByTagName( "parsererror" ).length ) { | |
| 8575 | jQuery.error( "Invalid XML: " + data ); | |
| 8576 | } | |
| 8577 | return xml; | |
| 8578 | }; | |
| 8579 | ||
| 8580 | ||
| 8581 | var | |
| 8582 | // Document location | |
| 8583 | ajaxLocParts, | |
| 8584 | ajaxLocation, | |
| 8585 | ||
| 8586 | rhash = /#.*$/, | |
| 8587 | rts = /([?&])_=[^&]*/, | |
| 8588 | rheaders = /^(.*?):[ \t]*([^\r\n]*)\r?$/mg, // IE leaves an \r character at EOL | |
| 8589 | // #7653, #8125, #8152: local protocol detection | |
| 8590 | rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, | |
| 8591 | rnoContent = /^(?:GET|HEAD)$/, | |
| 8592 | rprotocol = /^\/\//, | |
| 8593 | rurl = /^([\w.+-]+:)(?:\/\/(?:[^\/?#]*@|)([^\/?#:]*)(?::(\d+)|)|)/, | |
| 8594 | ||
| 8595 | /* Prefilters | |
| 8596 | * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) | |
| 8597 | * 2) These are called: | |
| 8598 | * - BEFORE asking for a transport | |
| 8599 | * - AFTER param serialization (s.data is a string if s.processData is true) | |
| 8600 | * 3) key is the dataType | |
| 8601 | * 4) the catchall symbol "*" can be used | |
| 8602 | * 5) execution will start with transport dataType and THEN continue down to "*" if needed | |
| 8603 | */ | |
| 8604 | prefilters = {}, | |
| 8605 | ||
| 8606 | /* Transports bindings | |
| 8607 | * 1) key is the dataType | |
| 8608 | * 2) the catchall symbol "*" can be used | |
| 8609 | * 3) selection will start with transport dataType and THEN go to "*" if needed | |
| 8610 | */ | |
| 8611 | transports = {}, | |
| 8612 | ||
| 8613 | // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression | |
| 8614 | allTypes = "*/".concat("*"); | |
| 8615 | ||
| 8616 | // #8138, IE may throw an exception when accessing | |
| 8617 | // a field from window.location if document.domain has been set | |
| 8618 | try { | |
| 8619 | ajaxLocation = location.href; | |
| 8620 | } catch( e ) { | |
| 8621 | // Use the href attribute of an A element | |
| 8622 | // since IE will modify it given document.location | |
| 8623 | ajaxLocation = document.createElement( "a" ); | |
| 8624 | ajaxLocation.href = ""; | |
| 8625 | ajaxLocation = ajaxLocation.href; | |
| 8626 | } | |
| 8627 | ||
| 8628 | // Segment location into parts | |
| 8629 | ajaxLocParts = rurl.exec( ajaxLocation.toLowerCase() ) || []; | |
| 8630 | ||
| 8631 | // Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport | |
| 8632 | function addToPrefiltersOrTransports( structure ) { | |
| 8633 | ||
| 8634 | // dataTypeExpression is optional and defaults to "*" | |
| 8635 | return function( dataTypeExpression, func ) { | |
| 8636 | ||
| 8637 | if ( typeof dataTypeExpression !== "string" ) { | |
| 8638 | func = dataTypeExpression; | |
| 8639 | dataTypeExpression = "*"; | |
| 8640 | } | |
| 8641 | ||
| 8642 | var dataType, | |
| 8643 | i = 0, | |
| 8644 | dataTypes = dataTypeExpression.toLowerCase().match( rnotwhite ) || []; | |
| 8645 | ||
| 8646 | if ( jQuery.isFunction( func ) ) { | |
| 8647 | // For each dataType in the dataTypeExpression | |
| 8648 | while ( (dataType = dataTypes[i++]) ) { | |
| 8649 | // Prepend if requested | |
| 8650 | if ( dataType.charAt( 0 ) === "+" ) { | |
| 8651 | dataType = dataType.slice( 1 ) || "*"; | |
| 8652 | (structure[ dataType ] = structure[ dataType ] || []).unshift( func ); | |
| 8653 | ||
| 8654 | // Otherwise append | |
| 8655 | } else { | |
| 8656 | (structure[ dataType ] = structure[ dataType ] || []).push( func ); | |
| 8657 | } | |
| 8658 | } | |
| 8659 | } | |
| 8660 | }; | |
| 8661 | } | |
| 8662 | ||
| 8663 | // Base inspection function for prefilters and transports | |
| 8664 | function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { | |
| 8665 | ||
| 8666 | var inspected = {}, | |
| 8667 | seekingTransport = ( structure === transports ); | |
| 8668 | ||
| 8669 | function inspect( dataType ) { | |
| 8670 | var selected; | |
| 8671 | inspected[ dataType ] = true; | |
| 8672 | jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { | |
| 8673 | var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); | |
| 8674 | if ( typeof dataTypeOrTransport === "string" && !seekingTransport && !inspected[ dataTypeOrTransport ] ) { | |
| 8675 | options.dataTypes.unshift( dataTypeOrTransport ); | |
| 8676 | inspect( dataTypeOrTransport ); | |
| 8677 | return false; | |
| 8678 | } else if ( seekingTransport ) { | |
| 8679 | return !( selected = dataTypeOrTransport ); | |
| 8680 | } | |
| 8681 | }); | |
| 8682 | return selected; | |
| 8683 | } | |
| 8684 | ||
| 8685 | return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); | |
| 8686 | } | |
| 8687 | ||
| 8688 | // A special extend for ajax options | |
| 8689 | // that takes "flat" options (not to be deep extended) | |
| 8690 | // Fixes #9887 | |
| 8691 | function ajaxExtend( target, src ) { | |
| 8692 | var deep, key, | |
| 8693 | flatOptions = jQuery.ajaxSettings.flatOptions || {}; | |
| 8694 | ||
| 8695 | for ( key in src ) { | |
| 8696 | if ( src[ key ] !== undefined ) { | |
| 8697 | ( flatOptions[ key ] ? target : ( deep || (deep = {}) ) )[ key ] = src[ key ]; | |
| 8698 | } | |
| 8699 | } | |
| 8700 | if ( deep ) { | |
| 8701 | jQuery.extend( true, target, deep ); | |
| 8702 | } | |
| 8703 | ||
| 8704 | return target; | |
| 8705 | } | |
| 8706 | ||
| 8707 | /* Handles responses to an ajax request: | |
| 8708 | * - finds the right dataType (mediates between content-type and expected dataType) | |
| 8709 | * - returns the corresponding response | |
| 8710 | */ | |
| 8711 | function ajaxHandleResponses( s, jqXHR, responses ) { | |
| 8712 | var firstDataType, ct, finalDataType, type, | |
| 8713 | contents = s.contents, | |
| 8714 | dataTypes = s.dataTypes; | |
| 8715 | ||
| 8716 | // Remove auto dataType and get content-type in the process | |
| 8717 | while ( dataTypes[ 0 ] === "*" ) { | |
| 8718 | dataTypes.shift(); | |
| 8719 | if ( ct === undefined ) { | |
| 8720 | ct = s.mimeType || jqXHR.getResponseHeader("Content-Type"); | |
| 8721 | } | |
| 8722 | } | |
| 8723 | ||
| 8724 | // Check if we're dealing with a known content-type | |
| 8725 | if ( ct ) { | |
| 8726 | for ( type in contents ) { | |
| 8727 | if ( contents[ type ] && contents[ type ].test( ct ) ) { | |
| 8728 | dataTypes.unshift( type ); | |
| 8729 | break; | |
| 8730 | } | |
| 8731 | } | |
| 8732 | } | |
| 8733 | ||
| 8734 | // Check to see if we have a response for the expected dataType | |
| 8735 | if ( dataTypes[ 0 ] in responses ) { | |
| 8736 | finalDataType = dataTypes[ 0 ]; | |
| 8737 | } else { | |
| 8738 | // Try convertible dataTypes | |
| 8739 | for ( type in responses ) { | |
| 8740 | if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[0] ] ) { | |
| 8741 | finalDataType = type; | |
| 8742 | break; | |
| 8743 | } | |
| 8744 | if ( !firstDataType ) { | |
| 8745 | firstDataType = type; | |
| 8746 | } | |
| 8747 | } | |
| 8748 | // Or just use first one | |
| 8749 | finalDataType = finalDataType || firstDataType; | |
| 8750 | } | |
| 8751 | ||
| 8752 | // If we found a dataType | |
| 8753 | // We add the dataType to the list if needed | |
| 8754 | // and return the corresponding response | |
| 8755 | if ( finalDataType ) { | |
| 8756 | if ( finalDataType !== dataTypes[ 0 ] ) { | |
| 8757 | dataTypes.unshift( finalDataType ); | |
| 8758 | } | |
| 8759 | return responses[ finalDataType ]; | |
| 8760 | } | |
| 8761 | } | |
| 8762 | ||
| 8763 | /* Chain conversions given the request and the original response | |
| 8764 | * Also sets the responseXXX fields on the jqXHR instance | |
| 8765 | */ | |
| 8766 | function ajaxConvert( s, response, jqXHR, isSuccess ) { | |
| 8767 | var conv2, current, conv, tmp, prev, | |
| 8768 | converters = {}, | |
| 8769 | // Work with a copy of dataTypes in case we need to modify it for conversion | |
| 8770 | dataTypes = s.dataTypes.slice(); | |
| 8771 | ||
| 8772 | // Create converters map with lowercased keys | |
| 8773 | if ( dataTypes[ 1 ] ) { | |
| 8774 | for ( conv in s.converters ) { | |
| 8775 | converters[ conv.toLowerCase() ] = s.converters[ conv ]; | |
| 8776 | } | |
| 8777 | } | |
| 8778 | ||
| 8779 | current = dataTypes.shift(); | |
| 8780 | ||
| 8781 | // Convert to each sequential dataType | |
| 8782 | while ( current ) { | |
| 8783 | ||
| 8784 | if ( s.responseFields[ current ] ) { | |
| 8785 | jqXHR[ s.responseFields[ current ] ] = response; | |
| 8786 | } | |
| 8787 | ||
| 8788 | // Apply the dataFilter if provided | |
| 8789 | if ( !prev && isSuccess && s.dataFilter ) { | |
| 8790 | response = s.dataFilter( response, s.dataType ); | |
| 8791 | } | |
| 8792 | ||
| 8793 | prev = current; | |
| 8794 | current = dataTypes.shift(); | |
| 8795 | ||
| 8796 | if ( current ) { | |
| 8797 | ||
| 8798 | // There's only work to do if current dataType is non-auto | |
| 8799 | if ( current === "*" ) { | |
| 8800 | ||
| 8801 | current = prev; | |
| 8802 | ||
| 8803 | // Convert response if prev dataType is non-auto and differs from current | |
| 8804 | } else if ( prev !== "*" && prev !== current ) { | |
| 8805 | ||
| 8806 | // Seek a direct converter | |
| 8807 | conv = converters[ prev + " " + current ] || converters[ "* " + current ]; | |
| 8808 | ||
| 8809 | // If none found, seek a pair | |
| 8810 | if ( !conv ) { | |
| 8811 | for ( conv2 in converters ) { | |
| 8812 | ||
| 8813 | // If conv2 outputs current | |
| 8814 | tmp = conv2.split( " " ); | |
| 8815 | if ( tmp[ 1 ] === current ) { | |
| 8816 | ||
| 8817 | // If prev can be converted to accepted input | |
| 8818 | conv = converters[ prev + " " + tmp[ 0 ] ] || | |
| 8819 | converters[ "* " + tmp[ 0 ] ]; | |
| 8820 | if ( conv ) { | |
| 8821 | // Condense equivalence converters | |
| 8822 | if ( conv === true ) { | |
| 8823 | conv = converters[ conv2 ]; | |
| 8824 | ||
| 8825 | // Otherwise, insert the intermediate dataType | |
| 8826 | } else if ( converters[ conv2 ] !== true ) { | |
| 8827 | current = tmp[ 0 ]; | |
| 8828 | dataTypes.unshift( tmp[ 1 ] ); | |
| 8829 | } | |
| 8830 | break; | |
| 8831 | } | |
| 8832 | } | |
| 8833 | } | |
| 8834 | } | |
| 8835 | ||
| 8836 | // Apply converter (if not an equivalence) | |
| 8837 | if ( conv !== true ) { | |
| 8838 | ||
| 8839 | // Unless errors are allowed to bubble, catch and return them | |
| 8840 | if ( conv && s[ "throws" ] ) { | |
| 8841 | response = conv( response ); | |
| 8842 | } else { | |
| 8843 | try { | |
| 8844 | response = conv( response ); | |
| 8845 | } catch ( e ) { | |
| 8846 | return { state: "parsererror", error: conv ? e : "No conversion from " + prev + " to " + current }; | |
| 8847 | } | |
| 8848 | } | |
| 8849 | } | |
| 8850 | } | |
| 8851 | } | |
| 8852 | } | |
| 8853 | ||
| 8854 | return { state: "success", data: response }; | |
| 8855 | } | |
| 8856 | ||
| 8857 | jQuery.extend({ | |
| 8858 | ||
| 8859 | // Counter for holding the number of active queries | |
| 8860 | active: 0, | |
| 8861 | ||
| 8862 | // Last-Modified header cache for next request | |
| 8863 | lastModified: {}, | |
| 8864 | etag: {}, | |
| 8865 | ||
| 8866 | ajaxSettings: { | |
| 8867 | url: ajaxLocation, | |
| 8868 | type: "GET", | |
| 8869 | isLocal: rlocalProtocol.test( ajaxLocParts[ 1 ] ), | |
| 8870 | global: true, | |
| 8871 | processData: true, | |
| 8872 | async: true, | |
| 8873 | contentType: "application/x-www-form-urlencoded; charset=UTF-8", | |
| 8874 | /* | |
| 8875 | timeout: 0, | |
| 8876 | data: null, | |
| 8877 | dataType: null, | |
| 8878 | username: null, | |
| 8879 | password: null, | |
| 8880 | cache: null, | |
| 8881 | throws: false, | |
| 8882 | traditional: false, | |
| 8883 | headers: {}, | |
| 8884 | */ | |
| 8885 | ||
| 8886 | accepts: { | |
| 8887 | "*": allTypes, | |
| 8888 | text: "text/plain", | |
| 8889 | html: "text/html", | |
| 8890 | xml: "application/xml, text/xml", | |
| 8891 | json: "application/json, text/javascript" | |
| 8892 | }, | |
| 8893 | ||
| 8894 | contents: { | |
| 8895 | xml: /xml/, | |
| 8896 | html: /html/, | |
| 8897 | json: /json/ | |
| 8898 | }, | |
| 8899 | ||
| 8900 | responseFields: { | |
| 8901 | xml: "responseXML", | |
| 8902 | text: "responseText", | |
| 8903 | json: "responseJSON" | |
| 8904 | }, | |
| 8905 | ||
| 8906 | // Data converters | |
| 8907 | // Keys separate source (or catchall "*") and destination types with a single space | |
| 8908 | converters: { | |
| 8909 | ||
| 8910 | // Convert anything to text | |
| 8911 | "* text": String, | |
| 8912 | ||
| 8913 | // Text to html (true = no transformation) | |
| 8914 | "text html": true, | |
| 8915 | ||
| 8916 | // Evaluate text as a json expression | |
| 8917 | "text json": jQuery.parseJSON, | |
| 8918 | ||
| 8919 | // Parse text as xml | |
| 8920 | "text xml": jQuery.parseXML | |
| 8921 | }, | |
| 8922 | ||
| 8923 | // For options that shouldn't be deep extended: | |
| 8924 | // you can add your own custom options here if | |
| 8925 | // and when you create one that shouldn't be | |
| 8926 | // deep extended (see ajaxExtend) | |
| 8927 | flatOptions: { | |
| 8928 | url: true, | |
| 8929 | context: true | |
| 8930 | } | |
| 8931 | }, | |
| 8932 | ||
| 8933 | // Creates a full fledged settings object into target | |
| 8934 | // with both ajaxSettings and settings fields. | |
| 8935 | // If target is omitted, writes into ajaxSettings. | |
| 8936 | ajaxSetup: function( target, settings ) { | |
| 8937 | return settings ? | |
| 8938 | ||
| 8939 | // Building a settings object | |
| 8940 | ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : | |
| 8941 | ||
| 8942 | // Extending ajaxSettings | |
| 8943 | ajaxExtend( jQuery.ajaxSettings, target ); | |
| 8944 | }, | |
| 8945 | ||
| 8946 | ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), | |
| 8947 | ajaxTransport: addToPrefiltersOrTransports( transports ), | |
| 8948 | ||
| 8949 | // Main method | |
| 8950 | ajax: function( url, options ) { | |
| 8951 | ||
| 8952 | // If url is an object, simulate pre-1.5 signature | |
| 8953 | if ( typeof url === "object" ) { | |
| 8954 | options = url; | |
| 8955 | url = undefined; | |
| 8956 | } | |
| 8957 | ||
| 8958 | // Force options to be an object | |
| 8959 | options = options || {}; | |
| 8960 | ||
| 8961 | var // Cross-domain detection vars | |
| 8962 | parts, | |
| 8963 | // Loop variable | |
| 8964 | i, | |
| 8965 | // URL without anti-cache param | |
| 8966 | cacheURL, | |
| 8967 | // Response headers as string | |
| 8968 | responseHeadersString, | |
| 8969 | // timeout handle | |
| 8970 | timeoutTimer, | |
| 8971 | ||
| 8972 | // To know if global events are to be dispatched | |
| 8973 | fireGlobals, | |
| 8974 | ||
| 8975 | transport, | |
| 8976 | // Response headers | |
| 8977 | responseHeaders, | |
| 8978 | // Create the final options object | |
| 8979 | s = jQuery.ajaxSetup( {}, options ), | |
| 8980 | // Callbacks context | |
| 8981 | callbackContext = s.context || s, | |
| 8982 | // Context for global events is callbackContext if it is a DOM node or jQuery collection | |
| 8983 | globalEventContext = s.context && ( callbackContext.nodeType || callbackContext.jquery ) ? | |
| 8984 | jQuery( callbackContext ) : | |
| 8985 | jQuery.event, | |
| 8986 | // Deferreds | |
| 8987 | deferred = jQuery.Deferred(), | |
| 8988 | completeDeferred = jQuery.Callbacks("once memory"), | |
| 8989 | // Status-dependent callbacks | |
| 8990 | statusCode = s.statusCode || {}, | |
| 8991 | // Headers (they are sent all at once) | |
| 8992 | requestHeaders = {}, | |
| 8993 | requestHeadersNames = {}, | |
| 8994 | // The jqXHR state | |
| 8995 | state = 0, | |
| 8996 | // Default abort message | |
| 8997 | strAbort = "canceled", | |
| 8998 | // Fake xhr | |
| 8999 | jqXHR = { | |
| 9000 | readyState: 0, | |
| 9001 | ||
| 9002 | // Builds headers hashtable if needed | |
| 9003 | getResponseHeader: function( key ) { | |
| 9004 | var match; | |
| 9005 | if ( state === 2 ) { | |
| 9006 | if ( !responseHeaders ) { | |
| 9007 | responseHeaders = {}; | |
| 9008 | while ( (match = rheaders.exec( responseHeadersString )) ) { | |
| 9009 | responseHeaders[ match[1].toLowerCase() ] = match[ 2 ]; | |
| 9010 | } | |
| 9011 | } | |
| 9012 | match = responseHeaders[ key.toLowerCase() ]; | |
| 9013 | } | |
| 9014 | return match == null ? null : match; | |
| 9015 | }, | |
| 9016 | ||
| 9017 | // Raw string | |
| 9018 | getAllResponseHeaders: function() { | |
| 9019 | return state === 2 ? responseHeadersString : null; | |
| 9020 | }, | |
| 9021 | ||
| 9022 | // Caches the header | |
| 9023 | setRequestHeader: function( name, value ) { | |
| 9024 | var lname = name.toLowerCase(); | |
| 9025 | if ( !state ) { | |
| 9026 | name = requestHeadersNames[ lname ] = requestHeadersNames[ lname ] || name; | |
| 9027 | requestHeaders[ name ] = value; | |
| 9028 | } | |
| 9029 | return this; | |
| 9030 | }, | |
| 9031 | ||
| 9032 | // Overrides response content-type header | |
| 9033 | overrideMimeType: function( type ) { | |
| 9034 | if ( !state ) { | |
| 9035 | s.mimeType = type; | |
| 9036 | } | |
| 9037 | return this; | |
| 9038 | }, | |
| 9039 | ||
| 9040 | // Status-dependent callbacks | |
| 9041 | statusCode: function( map ) { | |
| 9042 | var code; | |
| 9043 | if ( map ) { | |
| 9044 | if ( state < 2 ) { | |
| 9045 | for ( code in map ) { | |
| 9046 | // Lazy-add the new callback in a way that preserves old ones | |
| 9047 | statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; | |
| 9048 | } | |
| 9049 | } else { | |
| 9050 | // Execute the appropriate callbacks | |
| 9051 | jqXHR.always( map[ jqXHR.status ] ); | |
| 9052 | } | |
| 9053 | } | |
| 9054 | return this; | |
| 9055 | }, | |
| 9056 | ||
| 9057 | // Cancel the request | |
| 9058 | abort: function( statusText ) { | |
| 9059 | var finalText = statusText || strAbort; | |
| 9060 | if ( transport ) { | |
| 9061 | transport.abort( finalText ); | |
| 9062 | } | |
| 9063 | done( 0, finalText ); | |
| 9064 | return this; | |
| 9065 | } | |
| 9066 | }; | |
| 9067 | ||
| 9068 | // Attach deferreds | |
| 9069 | deferred.promise( jqXHR ).complete = completeDeferred.add; | |
| 9070 | jqXHR.success = jqXHR.done; | |
| 9071 | jqXHR.error = jqXHR.fail; | |
| 9072 | ||
| 9073 | // Remove hash character (#7531: and string promotion) | |
| 9074 | // Add protocol if not provided (#5866: IE7 issue with protocol-less urls) | |
| 9075 | // Handle falsy url in the settings object (#10093: consistency with old signature) | |
| 9076 | // We also use the url parameter if available | |
| 9077 | s.url = ( ( url || s.url || ajaxLocation ) + "" ).replace( rhash, "" ).replace( rprotocol, ajaxLocParts[ 1 ] + "//" ); | |
| 9078 | ||
| 9079 | // Alias method option to type as per ticket #12004 | |
| 9080 | s.type = options.method || options.type || s.method || s.type; | |
| 9081 | ||
| 9082 | // Extract dataTypes list | |
| 9083 | s.dataTypes = jQuery.trim( s.dataType || "*" ).toLowerCase().match( rnotwhite ) || [ "" ]; | |
| 9084 | ||
| 9085 | // A cross-domain request is in order when we have a protocol:host:port mismatch | |
| 9086 | if ( s.crossDomain == null ) { | |
| 9087 | parts = rurl.exec( s.url.toLowerCase() ); | |
| 9088 | s.crossDomain = !!( parts && | |
| 9089 | ( parts[ 1 ] !== ajaxLocParts[ 1 ] || parts[ 2 ] !== ajaxLocParts[ 2 ] || | |
| 9090 | ( parts[ 3 ] || ( parts[ 1 ] === "http:" ? "80" : "443" ) ) !== | |
| 9091 | ( ajaxLocParts[ 3 ] || ( ajaxLocParts[ 1 ] === "http:" ? "80" : "443" ) ) ) | |
| 9092 | ); | |
| 9093 | } | |
| 9094 | ||
| 9095 | // Convert data if not already a string | |
| 9096 | if ( s.data && s.processData && typeof s.data !== "string" ) { | |
| 9097 | s.data = jQuery.param( s.data, s.traditional ); | |
| 9098 | } | |
| 9099 | ||
| 9100 | // Apply prefilters | |
| 9101 | inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); | |
| 9102 | ||
| 9103 | // If request was aborted inside a prefilter, stop there | |
| 9104 | if ( state === 2 ) { | |
| 9105 | return jqXHR; | |
| 9106 | } | |
| 9107 | ||
| 9108 | // We can fire global events as of now if asked to | |
| 9109 | // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) | |
| 9110 | fireGlobals = jQuery.event && s.global; | |
| 9111 | ||
| 9112 | // Watch for a new set of requests | |
| 9113 | if ( fireGlobals && jQuery.active++ === 0 ) { | |
| 9114 | jQuery.event.trigger("ajaxStart"); | |
| 9115 | } | |
| 9116 | ||
| 9117 | // Uppercase the type | |
| 9118 | s.type = s.type.toUpperCase(); | |
| 9119 | ||
| 9120 | // Determine if request has content | |
| 9121 | s.hasContent = !rnoContent.test( s.type ); | |
| 9122 | ||
| 9123 | // Save the URL in case we're toying with the If-Modified-Since | |
| 9124 | // and/or If-None-Match header later on | |
| 9125 | cacheURL = s.url; | |
| 9126 | ||
| 9127 | // More options handling for requests with no content | |
| 9128 | if ( !s.hasContent ) { | |
| 9129 | ||
| 9130 | // If data is available, append data to url | |
| 9131 | if ( s.data ) { | |
| 9132 | cacheURL = ( s.url += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data ); | |
| 9133 | // #9682: remove data so that it's not used in an eventual retry | |
| 9134 | delete s.data; | |
| 9135 | } | |
| 9136 | ||
| 9137 | // Add anti-cache in url if needed | |
| 9138 | if ( s.cache === false ) { | |
| 9139 | s.url = rts.test( cacheURL ) ? | |
| 9140 | ||
| 9141 | // If there is already a '_' parameter, set its value | |
| 9142 | cacheURL.replace( rts, "$1_=" + nonce++ ) : | |
| 9143 | ||
| 9144 | // Otherwise add one to the end | |
| 9145 | cacheURL + ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + nonce++; | |
| 9146 | } | |
| 9147 | } | |
| 9148 | ||
| 9149 | // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. | |
| 9150 | if ( s.ifModified ) { | |
| 9151 | if ( jQuery.lastModified[ cacheURL ] ) { | |
| 9152 | jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); | |
| 9153 | } | |
| 9154 | if ( jQuery.etag[ cacheURL ] ) { | |
| 9155 | jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); | |
| 9156 | } | |
| 9157 | } | |
| 9158 | ||
| 9159 | // Set the correct header, if data is being sent | |
| 9160 | if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { | |
| 9161 | jqXHR.setRequestHeader( "Content-Type", s.contentType ); | |
| 9162 | } | |
| 9163 | ||
| 9164 | // Set the Accepts header for the server, depending on the dataType | |
| 9165 | jqXHR.setRequestHeader( | |
| 9166 | "Accept", | |
| 9167 | s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[0] ] ? | |
| 9168 | s.accepts[ s.dataTypes[0] ] + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : | |
| 9169 | s.accepts[ "*" ] | |
| 9170 | ); | |
| 9171 | ||
| 9172 | // Check for headers option | |
| 9173 | for ( i in s.headers ) { | |
| 9174 | jqXHR.setRequestHeader( i, s.headers[ i ] ); | |
| 9175 | } | |
| 9176 | ||
| 9177 | // Allow custom headers/mimetypes and early abort | |
| 9178 | if ( s.beforeSend && ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || state === 2 ) ) { | |
| 9179 | // Abort if not done already and return | |
| 9180 | return jqXHR.abort(); | |
| 9181 | } | |
| 9182 | ||
| 9183 | // aborting is no longer a cancellation | |
| 9184 | strAbort = "abort"; | |
| 9185 | ||
| 9186 | // Install callbacks on deferreds | |
| 9187 | for ( i in { success: 1, error: 1, complete: 1 } ) { | |
| 9188 | jqXHR[ i ]( s[ i ] ); | |
| 9189 | } | |
| 9190 | ||
| 9191 | // Get transport | |
| 9192 | transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); | |
| 9193 | ||
| 9194 | // If no transport, we auto-abort | |
| 9195 | if ( !transport ) { | |
| 9196 | done( -1, "No Transport" ); | |
| 9197 | } else { | |
| 9198 | jqXHR.readyState = 1; | |
| 9199 | ||
| 9200 | // Send global event | |
| 9201 | if ( fireGlobals ) { | |
| 9202 | globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); | |
| 9203 | } | |
| 9204 | // Timeout | |
| 9205 | if ( s.async && s.timeout > 0 ) { | |
| 9206 | timeoutTimer = setTimeout(function() { | |
| 9207 | jqXHR.abort("timeout"); | |
| 9208 | }, s.timeout ); | |
| 9209 | } | |
| 9210 | ||
| 9211 | try { | |
| 9212 | state = 1; | |
| 9213 | transport.send( requestHeaders, done ); | |
| 9214 | } catch ( e ) { | |
| 9215 | // Propagate exception as error if not done | |
| 9216 | if ( state < 2 ) { | |
| 9217 | done( -1, e ); | |
| 9218 | // Simply rethrow otherwise | |
| 9219 | } else { | |
| 9220 | throw e; | |
| 9221 | } | |
| 9222 | } | |
| 9223 | } | |
| 9224 | ||
| 9225 | // Callback for when everything is done | |
| 9226 | function done( status, nativeStatusText, responses, headers ) { | |
| 9227 | var isSuccess, success, error, response, modified, | |
| 9228 | statusText = nativeStatusText; | |
| 9229 | ||
| 9230 | // Called once | |
| 9231 | if ( state === 2 ) { | |
| 9232 | return; | |
| 9233 | } | |
| 9234 | ||
| 9235 | // State is "done" now | |
| 9236 | state = 2; | |
| 9237 | ||
| 9238 | // Clear timeout if it exists | |
| 9239 | if ( timeoutTimer ) { | |
| 9240 | clearTimeout( timeoutTimer ); | |
| 9241 | } | |
| 9242 | ||
| 9243 | // Dereference transport for early garbage collection | |
| 9244 | // (no matter how long the jqXHR object will be used) | |
| 9245 | transport = undefined; | |
| 9246 | ||
| 9247 | // Cache response headers | |
| 9248 | responseHeadersString = headers || ""; | |
| 9249 | ||
| 9250 | // Set readyState | |
| 9251 | jqXHR.readyState = status > 0 ? 4 : 0; | |
| 9252 | ||
| 9253 | // Determine if successful | |
| 9254 | isSuccess = status >= 200 && status < 300 || status === 304; | |
| 9255 | ||
| 9256 | // Get response data | |
| 9257 | if ( responses ) { | |
| 9258 | response = ajaxHandleResponses( s, jqXHR, responses ); | |
| 9259 | } | |
| 9260 | ||
| 9261 | // Convert no matter what (that way responseXXX fields are always set) | |
| 9262 | response = ajaxConvert( s, response, jqXHR, isSuccess ); | |
| 9263 | ||
| 9264 | // If successful, handle type chaining | |
| 9265 | if ( isSuccess ) { | |
| 9266 | ||
| 9267 | // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. | |
| 9268 | if ( s.ifModified ) { | |
| 9269 | modified = jqXHR.getResponseHeader("Last-Modified"); | |
| 9270 | if ( modified ) { | |
| 9271 | jQuery.lastModified[ cacheURL ] = modified; | |
| 9272 | } | |
| 9273 | modified = jqXHR.getResponseHeader("etag"); | |
| 9274 | if ( modified ) { | |
| 9275 | jQuery.etag[ cacheURL ] = modified; | |
| 9276 | } | |
| 9277 | } | |
| 9278 | ||
| 9279 | // if no content | |
| 9280 | if ( status === 204 || s.type === "HEAD" ) { | |
| 9281 | statusText = "nocontent"; | |
| 9282 | ||
| 9283 | // if not modified | |
| 9284 | } else if ( status === 304 ) { | |
| 9285 | statusText = "notmodified"; | |
| 9286 | ||
| 9287 | // If we have data, let's convert it | |
| 9288 | } else { | |
| 9289 | statusText = response.state; | |
| 9290 | success = response.data; | |
| 9291 | error = response.error; | |
| 9292 | isSuccess = !error; | |
| 9293 | } | |
| 9294 | } else { | |
| 9295 | // We extract error from statusText | |
| 9296 | // then normalize statusText and status for non-aborts | |
| 9297 | error = statusText; | |
| 9298 | if ( status || !statusText ) { | |
| 9299 | statusText = "error"; | |
| 9300 | if ( status < 0 ) { | |
| 9301 | status = 0; | |
| 9302 | } | |
| 9303 | } | |
| 9304 | } | |
| 9305 | ||
| 9306 | // Set data for the fake xhr object | |
| 9307 | jqXHR.status = status; | |
| 9308 | jqXHR.statusText = ( nativeStatusText || statusText ) + ""; | |
| 9309 | ||
| 9310 | // Success/Error | |
| 9311 | if ( isSuccess ) { | |
| 9312 | deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); | |
| 9313 | } else { | |
| 9314 | deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); | |
| 9315 | } | |
| 9316 | ||
| 9317 | // Status-dependent callbacks | |
| 9318 | jqXHR.statusCode( statusCode ); | |
| 9319 | statusCode = undefined; | |
| 9320 | ||
| 9321 | if ( fireGlobals ) { | |
| 9322 | globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", | |
| 9323 | [ jqXHR, s, isSuccess ? success : error ] ); | |
| 9324 | } | |
| 9325 | ||
| 9326 | // Complete | |
| 9327 | completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); | |
| 9328 | ||
| 9329 | if ( fireGlobals ) { | |
| 9330 | globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); | |
| 9331 | // Handle the global AJAX counter | |
| 9332 | if ( !( --jQuery.active ) ) { | |
| 9333 | jQuery.event.trigger("ajaxStop"); | |
| 9334 | } | |
| 9335 | } | |
| 9336 | } | |
| 9337 | ||
| 9338 | return jqXHR; | |
| 9339 | }, | |
| 9340 | ||
| 9341 | getJSON: function( url, data, callback ) { | |
| 9342 | return jQuery.get( url, data, callback, "json" ); | |
| 9343 | }, | |
| 9344 | ||
| 9345 | getScript: function( url, callback ) { | |
| 9346 | return jQuery.get( url, undefined, callback, "script" ); | |
| 9347 | } | |
| 9348 | }); | |
| 9349 | ||
| 9350 | jQuery.each( [ "get", "post" ], function( i, method ) { | |
| 9351 | jQuery[ method ] = function( url, data, callback, type ) { | |
| 9352 | // shift arguments if data argument was omitted | |
| 9353 | if ( jQuery.isFunction( data ) ) { | |
| 9354 | type = type || callback; | |
| 9355 | callback = data; | |
| 9356 | data = undefined; | |
| 9357 | } | |
| 9358 | ||
| 9359 | return jQuery.ajax({ | |
| 9360 | url: url, | |
| 9361 | type: method, | |
| 9362 | dataType: type, | |
| 9363 | data: data, | |
| 9364 | success: callback | |
| 9365 | }); | |
| 9366 | }; | |
| 9367 | }); | |
| 9368 | ||
| 9369 | ||
| 9370 | jQuery._evalUrl = function( url ) { | |
| 9371 | return jQuery.ajax({ | |
| 9372 | url: url, | |
| 9373 | type: "GET", | |
| 9374 | dataType: "script", | |
| 9375 | async: false, | |
| 9376 | global: false, | |
| 9377 | "throws": true | |
| 9378 | }); | |
| 9379 | }; | |
| 9380 | ||
| 9381 | ||
| 9382 | jQuery.fn.extend({ | |
| 9383 | wrapAll: function( html ) { | |
| 9384 | if ( jQuery.isFunction( html ) ) { | |
| 9385 | return this.each(function(i) { | |
| 9386 | jQuery(this).wrapAll( html.call(this, i) ); | |
| 9387 | }); | |
| 9388 | } | |
| 9389 | ||
| 9390 | if ( this[0] ) { | |
| 9391 | // The elements to wrap the target around | |
| 9392 | var wrap = jQuery( html, this[0].ownerDocument ).eq(0).clone(true); | |
| 9393 | ||
| 9394 | if ( this[0].parentNode ) { | |
| 9395 | wrap.insertBefore( this[0] ); | |
| 9396 | } | |
| 9397 | ||
| 9398 | wrap.map(function() { | |
| 9399 | var elem = this; | |
| 9400 | ||
| 9401 | while ( elem.firstChild && elem.firstChild.nodeType === 1 ) { | |
| 9402 | elem = elem.firstChild; | |
| 9403 | } | |
| 9404 | ||
| 9405 | return elem; | |
| 9406 | }).append( this ); | |
| 9407 | } | |
| 9408 | ||
| 9409 | return this; | |
| 9410 | }, | |
| 9411 | ||
| 9412 | wrapInner: function( html ) { | |
| 9413 | if ( jQuery.isFunction( html ) ) { | |
| 9414 | return this.each(function(i) { | |
| 9415 | jQuery(this).wrapInner( html.call(this, i) ); | |
| 9416 | }); | |
| 9417 | } | |
| 9418 | ||
| 9419 | return this.each(function() { | |
| 9420 | var self = jQuery( this ), | |
| 9421 | contents = self.contents(); | |
| 9422 | ||
| 9423 | if ( contents.length ) { | |
| 9424 | contents.wrapAll( html ); | |
| 9425 | ||
| 9426 | } else { | |
| 9427 | self.append( html ); | |
| 9428 | } | |
| 9429 | }); | |
| 9430 | }, | |
| 9431 | ||
| 9432 | wrap: function( html ) { | |
| 9433 | var isFunction = jQuery.isFunction( html ); | |
| 9434 | ||
| 9435 | return this.each(function(i) { | |
| 9436 | jQuery( this ).wrapAll( isFunction ? html.call(this, i) : html ); | |
| 9437 | }); | |
| 9438 | }, | |
| 9439 | ||
| 9440 | unwrap: function() { | |
| 9441 | return this.parent().each(function() { | |
| 9442 | if ( !jQuery.nodeName( this, "body" ) ) { | |
| 9443 | jQuery( this ).replaceWith( this.childNodes ); | |
| 9444 | } | |
| 9445 | }).end(); | |
| 9446 | } | |
| 9447 | }); | |
| 9448 | ||
| 9449 | ||
| 9450 | jQuery.expr.filters.hidden = function( elem ) { | |
| 9451 | // Support: Opera <= 12.12 | |
| 9452 | // Opera reports offsetWidths and offsetHeights less than zero on some elements | |
| 9453 | return elem.offsetWidth <= 0 && elem.offsetHeight <= 0 || | |
| 9454 | (!support.reliableHiddenOffsets() && | |
| 9455 | ((elem.style && elem.style.display) || jQuery.css( elem, "display" )) === "none"); | |
| 9456 | }; | |
| 9457 | ||
| 9458 | jQuery.expr.filters.visible = function( elem ) { | |
| 9459 | return !jQuery.expr.filters.hidden( elem ); | |
| 9460 | }; | |
| 9461 | ||
| 9462 | ||
| 9463 | ||
| 9464 | ||
| 9465 | var r20 = /%20/g, | |
| 9466 | rbracket = /\[\]$/, | |
| 9467 | rCRLF = /\r?\n/g, | |
| 9468 | rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, | |
| 9469 | rsubmittable = /^(?:input|select|textarea|keygen)/i; | |
| 9470 | ||
| 9471 | function buildParams( prefix, obj, traditional, add ) { | |
| 9472 | var name; | |
| 9473 | ||
| 9474 | if ( jQuery.isArray( obj ) ) { | |
| 9475 | // Serialize array item. | |
| 9476 | jQuery.each( obj, function( i, v ) { | |
| 9477 | if ( traditional || rbracket.test( prefix ) ) { | |
| 9478 | // Treat each array item as a scalar. | |
| 9479 | add( prefix, v ); | |
| 9480 | ||
| 9481 | } else { | |
| 9482 | // Item is non-scalar (array or object), encode its numeric index. | |
| 9483 | buildParams( prefix + "[" + ( typeof v === "object" ? i : "" ) + "]", v, traditional, add ); | |
| 9484 | } | |
| 9485 | }); | |
| 9486 | ||
| 9487 | } else if ( !traditional && jQuery.type( obj ) === "object" ) { | |
| 9488 | // Serialize object item. | |
| 9489 | for ( name in obj ) { | |
| 9490 | buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); | |
| 9491 | } | |
| 9492 | ||
| 9493 | } else { | |
| 9494 | // Serialize scalar item. | |
| 9495 | add( prefix, obj ); | |
| 9496 | } | |
| 9497 | } | |
| 9498 | ||
| 9499 | // Serialize an array of form elements or a set of | |
| 9500 | // key/values into a query string | |
| 9501 | jQuery.param = function( a, traditional ) { | |
| 9502 | var prefix, | |
| 9503 | s = [], | |
| 9504 | add = function( key, value ) { | |
| 9505 | // If value is a function, invoke it and return its value | |
| 9506 | value = jQuery.isFunction( value ) ? value() : ( value == null ? "" : value ); | |
| 9507 | s[ s.length ] = encodeURIComponent( key ) + "=" + encodeURIComponent( value ); | |
| 9508 | }; | |
| 9509 | ||
| 9510 | // Set traditional to true for jQuery <= 1.3.2 behavior. | |
| 9511 | if ( traditional === undefined ) { | |
| 9512 | traditional = jQuery.ajaxSettings && jQuery.ajaxSettings.traditional; | |
| 9513 | } | |
| 9514 | ||
| 9515 | // If an array was passed in, assume that it is an array of form elements. | |
| 9516 | if ( jQuery.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { | |
| 9517 | // Serialize the form elements | |
| 9518 | jQuery.each( a, function() { | |
| 9519 | add( this.name, this.value ); | |
| 9520 | }); | |
| 9521 | ||
| 9522 | } else { | |
| 9523 | // If traditional, encode the "old" way (the way 1.3.2 or older | |
| 9524 | // did it), otherwise encode params recursively. | |
| 9525 | for ( prefix in a ) { | |
| 9526 | buildParams( prefix, a[ prefix ], traditional, add ); | |
| 9527 | } | |
| 9528 | } | |
| 9529 | ||
| 9530 | // Return the resulting serialization | |
| 9531 | return s.join( "&" ).replace( r20, "+" ); | |
| 9532 | }; | |
| 9533 | ||
| 9534 | jQuery.fn.extend({ | |
| 9535 | serialize: function() { | |
| 9536 | return jQuery.param( this.serializeArray() ); | |
| 9537 | }, | |
| 9538 | serializeArray: function() { | |
| 9539 | return this.map(function() { | |
| 9540 | // Can add propHook for "elements" to filter or add form elements | |
| 9541 | var elements = jQuery.prop( this, "elements" ); | |
| 9542 | return elements ? jQuery.makeArray( elements ) : this; | |
| 9543 | }) | |
| 9544 | .filter(function() { | |
| 9545 | var type = this.type; | |
| 9546 | // Use .is(":disabled") so that fieldset[disabled] works | |
| 9547 | return this.name && !jQuery( this ).is( ":disabled" ) && | |
| 9548 | rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && | |
| 9549 | ( this.checked || !rcheckableType.test( type ) ); | |
| 9550 | }) | |
| 9551 | .map(function( i, elem ) { | |
| 9552 | var val = jQuery( this ).val(); | |
| 9553 | ||
| 9554 | return val == null ? | |
| 9555 | null : | |
| 9556 | jQuery.isArray( val ) ? | |
| 9557 | jQuery.map( val, function( val ) { | |
| 9558 | return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; | |
| 9559 | }) : | |
| 9560 | { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; | |
| 9561 | }).get(); | |
| 9562 | } | |
| 9563 | }); | |
| 9564 | ||
| 9565 | ||
| 9566 | // Create the request object | |
| 9567 | // (This is still attached to ajaxSettings for backward compatibility) | |
| 9568 | jQuery.ajaxSettings.xhr = window.ActiveXObject !== undefined ? | |
| 9569 | // Support: IE6+ | |
| 9570 | function() { | |
| 9571 | ||
| 9572 | // XHR cannot access local files, always use ActiveX for that case | |
| 9573 | return !this.isLocal && | |
| 9574 | ||
| 9575 | // Support: IE7-8 | |
| 9576 | // oldIE XHR does not support non-RFC2616 methods (#13240) | |
| 9577 | // See http://msdn.microsoft.com/en-us/library/ie/ms536648(v=vs.85).aspx | |
| 9578 | // and http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9 | |
| 9579 | // Although this check for six methods instead of eight | |
| 9580 | // since IE also does not support "trace" and "connect" | |
| 9581 | /^(get|post|head|put|delete|options)$/i.test( this.type ) && | |
| 9582 | ||
| 9583 | createStandardXHR() || createActiveXHR(); | |
| 9584 | } : | |
| 9585 | // For all other browsers, use the standard XMLHttpRequest object | |
| 9586 | createStandardXHR; | |
| 9587 | ||
| 9588 | var xhrId = 0, | |
| 9589 | xhrCallbacks = {}, | |
| 9590 | xhrSupported = jQuery.ajaxSettings.xhr(); | |
| 9591 | ||
| 9592 | // Support: IE<10 | |
| 9593 | // Open requests must be manually aborted on unload (#5280) | |
| 9594 | // See https://support.microsoft.com/kb/2856746 for more info | |
| 9595 | if ( window.attachEvent ) { | |
| 9596 | window.attachEvent( "onunload", function() { | |
| 9597 | for ( var key in xhrCallbacks ) { | |
| 9598 | xhrCallbacks[ key ]( undefined, true ); | |
| 9599 | } | |
| 9600 | }); | |
| 9601 | } | |
| 9602 | ||
| 9603 | // Determine support properties | |
| 9604 | support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); | |
| 9605 | xhrSupported = support.ajax = !!xhrSupported; | |
| 9606 | ||
| 9607 | // Create transport if the browser can provide an xhr | |
| 9608 | if ( xhrSupported ) { | |
| 9609 | ||
| 9610 | jQuery.ajaxTransport(function( options ) { | |
| 9611 | // Cross domain only allowed if supported through XMLHttpRequest | |
| 9612 | if ( !options.crossDomain || support.cors ) { | |
| 9613 | ||
| 9614 | var callback; | |
| 9615 | ||
| 9616 | return { | |
| 9617 | send: function( headers, complete ) { | |
| 9618 | var i, | |
| 9619 | xhr = options.xhr(), | |
| 9620 | id = ++xhrId; | |
| 9621 | ||
| 9622 | // Open the socket | |
| 9623 | xhr.open( options.type, options.url, options.async, options.username, options.password ); | |
| 9624 | ||
| 9625 | // Apply custom fields if provided | |
| 9626 | if ( options.xhrFields ) { | |
| 9627 | for ( i in options.xhrFields ) { | |
| 9628 | xhr[ i ] = options.xhrFields[ i ]; | |
| 9629 | } | |
| 9630 | } | |
| 9631 | ||
| 9632 | // Override mime type if needed | |
| 9633 | if ( options.mimeType && xhr.overrideMimeType ) { | |
| 9634 | xhr.overrideMimeType( options.mimeType ); | |
| 9635 | } | |
| 9636 | ||
| 9637 | // X-Requested-With header | |
| 9638 | // For cross-domain requests, seeing as conditions for a preflight are | |
| 9639 | // akin to a jigsaw puzzle, we simply never set it to be sure. | |
| 9640 | // (it can always be set on a per-request basis or even using ajaxSetup) | |
| 9641 | // For same-domain requests, won't change header if already provided. | |
| 9642 | if ( !options.crossDomain && !headers["X-Requested-With"] ) { | |
| 9643 | headers["X-Requested-With"] = "XMLHttpRequest"; | |
| 9644 | } | |
| 9645 | ||
| 9646 | // Set headers | |
| 9647 | for ( i in headers ) { | |
| 9648 | // Support: IE<9 | |
| 9649 | // IE's ActiveXObject throws a 'Type Mismatch' exception when setting | |
| 9650 | // request header to a null-value. | |
| 9651 | // | |
| 9652 | // To keep consistent with other XHR implementations, cast the value | |
| 9653 | // to string and ignore `undefined`. | |
| 9654 | if ( headers[ i ] !== undefined ) { | |
| 9655 | xhr.setRequestHeader( i, headers[ i ] + "" ); | |
| 9656 | } | |
| 9657 | } | |
| 9658 | ||
| 9659 | // Do send the request | |
| 9660 | // This may raise an exception which is actually | |
| 9661 | // handled in jQuery.ajax (so no try/catch here) | |
| 9662 | xhr.send( ( options.hasContent && options.data ) || null ); | |
| 9663 | ||
| 9664 | // Listener | |
| 9665 | callback = function( _, isAbort ) { | |
| 9666 | var status, statusText, responses; | |
| 9667 | ||
| 9668 | // Was never called and is aborted or complete | |
| 9669 | if ( callback && ( isAbort || xhr.readyState === 4 ) ) { | |
| 9670 | // Clean up | |
| 9671 | delete xhrCallbacks[ id ]; | |
| 9672 | callback = undefined; | |
| 9673 | xhr.onreadystatechange = jQuery.noop; | |
| 9674 | ||
| 9675 | // Abort manually if needed | |
| 9676 | if ( isAbort ) { | |
| 9677 | if ( xhr.readyState !== 4 ) { | |
| 9678 | xhr.abort(); | |
| 9679 | } | |
| 9680 | } else { | |
| 9681 | responses = {}; | |
| 9682 | status = xhr.status; | |
| 9683 | ||
| 9684 | // Support: IE<10 | |
| 9685 | // Accessing binary-data responseText throws an exception | |
| 9686 | // (#11426) | |
| 9687 | if ( typeof xhr.responseText === "string" ) { | |
| 9688 | responses.text = xhr.responseText; | |
| 9689 | } | |
| 9690 | ||
| 9691 | // Firefox throws an exception when accessing | |
| 9692 | // statusText for faulty cross-domain requests | |
| 9693 | try { | |
| 9694 | statusText = xhr.statusText; | |
| 9695 | } catch( e ) { | |
| 9696 | // We normalize with Webkit giving an empty statusText | |
| 9697 | statusText = ""; | |
| 9698 | } | |
| 9699 | ||
| 9700 | // Filter status for non standard behaviors | |
| 9701 | ||
| 9702 | // If the request is local and we have data: assume a success | |
| 9703 | // (success with no data won't get notified, that's the best we | |
| 9704 | // can do given current implementations) | |
| 9705 | if ( !status && options.isLocal && !options.crossDomain ) { | |
| 9706 | status = responses.text ? 200 : 404; | |
| 9707 | // IE - #1450: sometimes returns 1223 when it should be 204 | |
| 9708 | } else if ( status === 1223 ) { | |
| 9709 | status = 204; | |
| 9710 | } | |
| 9711 | } | |
| 9712 | } | |
| 9713 | ||
| 9714 | // Call complete if needed | |
| 9715 | if ( responses ) { | |
| 9716 | complete( status, statusText, responses, xhr.getAllResponseHeaders() ); | |
| 9717 | } | |
| 9718 | }; | |
| 9719 | ||
| 9720 | if ( !options.async ) { | |
| 9721 | // if we're in sync mode we fire the callback | |
| 9722 | callback(); | |
| 9723 | } else if ( xhr.readyState === 4 ) { | |
| 9724 | // (IE6 & IE7) if it's in cache and has been | |
| 9725 | // retrieved directly we need to fire the callback | |
| 9726 | setTimeout( callback ); | |
| 9727 | } else { | |
| 9728 | // Add to the list of active xhr callbacks | |
| 9729 | xhr.onreadystatechange = xhrCallbacks[ id ] = callback; | |
| 9730 | } | |
| 9731 | }, | |
| 9732 | ||
| 9733 | abort: function() { | |
| 9734 | if ( callback ) { | |
| 9735 | callback( undefined, true ); | |
| 9736 | } | |
| 9737 | } | |
| 9738 | }; | |
| 9739 | } | |
| 9740 | }); | |
| 9741 | } | |
| 9742 | ||
| 9743 | // Functions to create xhrs | |
| 9744 | function createStandardXHR() { | |
| 9745 | try { | |
| 9746 | return new window.XMLHttpRequest(); | |
| 9747 | } catch( e ) {} | |
| 9748 | } | |
| 9749 | ||
| 9750 | function createActiveXHR() { | |
| 9751 | try { | |
| 9752 | return new window.ActiveXObject( "Microsoft.XMLHTTP" ); | |
| 9753 | } catch( e ) {} | |
| 9754 | } | |
| 9755 | ||
| 9756 | ||
| 9757 | ||
| 9758 | ||
| 9759 | // Install script dataType | |
| 9760 | jQuery.ajaxSetup({ | |
| 9761 | accepts: { | |
| 9762 | script: "text/javascript, application/javascript, application/ecmascript, application/x-ecmascript" | |
| 9763 | }, | |
| 9764 | contents: { | |
| 9765 | script: /(?:java|ecma)script/ | |
| 9766 | }, | |
| 9767 | converters: { | |
| 9768 | "text script": function( text ) { | |
| 9769 | jQuery.globalEval( text ); | |
| 9770 | return text; | |
| 9771 | } | |
| 9772 | } | |
| 9773 | }); | |
| 9774 | ||
| 9775 | // Handle cache's special case and global | |
| 9776 | jQuery.ajaxPrefilter( "script", function( s ) { | |
| 9777 | if ( s.cache === undefined ) { | |
| 9778 | s.cache = false; | |
| 9779 | } | |
| 9780 | if ( s.crossDomain ) { | |
| 9781 | s.type = "GET"; | |
| 9782 | s.global = false; | |
| 9783 | } | |
| 9784 | }); | |
| 9785 | ||
| 9786 | // Bind script tag hack transport | |
| 9787 | jQuery.ajaxTransport( "script", function(s) { | |
| 9788 | ||
| 9789 | // This transport only deals with cross domain requests | |
| 9790 | if ( s.crossDomain ) { | |
| 9791 | ||
| 9792 | var script, | |
| 9793 | head = document.head || jQuery("head")[0] || document.documentElement; | |
| 9794 | ||
| 9795 | return { | |
| 9796 | ||
| 9797 | send: function( _, callback ) { | |
| 9798 | ||
| 9799 | script = document.createElement("script"); | |
| 9800 | ||
| 9801 | script.async = true; | |
| 9802 | ||
| 9803 | if ( s.scriptCharset ) { | |
| 9804 | script.charset = s.scriptCharset; | |
| 9805 | } | |
| 9806 | ||
| 9807 | script.src = s.url; | |
| 9808 | ||
| 9809 | // Attach handlers for all browsers | |
| 9810 | script.onload = script.onreadystatechange = function( _, isAbort ) { | |
| 9811 | ||
| 9812 | if ( isAbort || !script.readyState || /loaded|complete/.test( script.readyState ) ) { | |
| 9813 | ||
| 9814 | // Handle memory leak in IE | |
| 9815 | script.onload = script.onreadystatechange = null; | |
| 9816 | ||
| 9817 | // Remove the script | |
| 9818 | if ( script.parentNode ) { | |
| 9819 | script.parentNode.removeChild( script ); | |
| 9820 | } | |
| 9821 | ||
| 9822 | // Dereference the script | |
| 9823 | script = null; | |
| 9824 | ||
| 9825 | // Callback if not abort | |
| 9826 | if ( !isAbort ) { | |
| 9827 | callback( 200, "success" ); | |
| 9828 | } | |
| 9829 | } | |
| 9830 | }; | |
| 9831 | ||
| 9832 | // Circumvent IE6 bugs with base elements (#2709 and #4378) by prepending | |
| 9833 | // Use native DOM manipulation to avoid our domManip AJAX trickery | |
| 9834 | head.insertBefore( script, head.firstChild ); | |
| 9835 | }, | |
| 9836 | ||
| 9837 | abort: function() { | |
| 9838 | if ( script ) { | |
| 9839 | script.onload( undefined, true ); | |
| 9840 | } | |
| 9841 | } | |
| 9842 | }; | |
| 9843 | } | |
| 9844 | }); | |
| 9845 | ||
| 9846 | ||
| 9847 | ||
| 9848 | ||
| 9849 | var oldCallbacks = [], | |
| 9850 | rjsonp = /(=)\?(?=&|$)|\?\?/; | |
| 9851 | ||
| 9852 | // Default jsonp settings | |
| 9853 | jQuery.ajaxSetup({ | |
| 9854 | jsonp: "callback", | |
| 9855 | jsonpCallback: function() { | |
| 9856 | var callback = oldCallbacks.pop() || ( jQuery.expando + "_" + ( nonce++ ) ); | |
| 9857 | this[ callback ] = true; | |
| 9858 | return callback; | |
| 9859 | } | |
| 9860 | }); | |
| 9861 | ||
| 9862 | // Detect, normalize options and install callbacks for jsonp requests | |
| 9863 | jQuery.ajaxPrefilter( "json jsonp", function( s, originalSettings, jqXHR ) { | |
| 9864 | ||
| 9865 | var callbackName, overwritten, responseContainer, | |
| 9866 | jsonProp = s.jsonp !== false && ( rjsonp.test( s.url ) ? | |
| 9867 | "url" : | |
| 9868 | typeof s.data === "string" && !( s.contentType || "" ).indexOf("application/x-www-form-urlencoded") && rjsonp.test( s.data ) && "data" | |
| 9869 | ); | |
| 9870 | ||
| 9871 | // Handle iff the expected data type is "jsonp" or we have a parameter to set | |
| 9872 | if ( jsonProp || s.dataTypes[ 0 ] === "jsonp" ) { | |
| 9873 | ||
| 9874 | // Get callback name, remembering preexisting value associated with it | |
| 9875 | callbackName = s.jsonpCallback = jQuery.isFunction( s.jsonpCallback ) ? | |
| 9876 | s.jsonpCallback() : | |
| 9877 | s.jsonpCallback; | |
| 9878 | ||
| 9879 | // Insert callback into url or form data | |
| 9880 | if ( jsonProp ) { | |
| 9881 | s[ jsonProp ] = s[ jsonProp ].replace( rjsonp, "$1" + callbackName ); | |
| 9882 | } else if ( s.jsonp !== false ) { | |
| 9883 | s.url += ( rquery.test( s.url ) ? "&" : "?" ) + s.jsonp + "=" + callbackName; | |
| 9884 | } | |
| 9885 | ||
| 9886 | // Use data converter to retrieve json after script execution | |
| 9887 | s.converters["script json"] = function() { | |
| 9888 | if ( !responseContainer ) { | |
| 9889 | jQuery.error( callbackName + " was not called" ); | |
| 9890 | } | |
| 9891 | return responseContainer[ 0 ]; | |
| 9892 | }; | |
| 9893 | ||
| 9894 | // force json dataType | |
| 9895 | s.dataTypes[ 0 ] = "json"; | |
| 9896 | ||
| 9897 | // Install callback | |
| 9898 | overwritten = window[ callbackName ]; | |
| 9899 | window[ callbackName ] = function() { | |
| 9900 | responseContainer = arguments; | |
| 9901 | }; | |
| 9902 | ||
| 9903 | // Clean-up function (fires after converters) | |
| 9904 | jqXHR.always(function() { | |
| 9905 | // Restore preexisting value | |
| 9906 | window[ callbackName ] = overwritten; | |
| 9907 | ||
| 9908 | // Save back as free | |
| 9909 | if ( s[ callbackName ] ) { | |
| 9910 | // make sure that re-using the options doesn't screw things around | |
| 9911 | s.jsonpCallback = originalSettings.jsonpCallback; | |
| 9912 | ||
| 9913 | // save the callback name for future use | |
| 9914 | oldCallbacks.push( callbackName ); | |
| 9915 | } | |
| 9916 | ||
| 9917 | // Call if it was a function and we have a response | |
| 9918 | if ( responseContainer && jQuery.isFunction( overwritten ) ) { | |
| 9919 | overwritten( responseContainer[ 0 ] ); | |
| 9920 | } | |
| 9921 | ||
| 9922 | responseContainer = overwritten = undefined; | |
| 9923 | }); | |
| 9924 | ||
| 9925 | // Delegate to script | |
| 9926 | return "script"; | |
| 9927 | } | |
| 9928 | }); | |
| 9929 | ||
| 9930 | ||
| 9931 | ||
| 9932 | ||
| 9933 | // data: string of html | |
| 9934 | // context (optional): If specified, the fragment will be created in this context, defaults to document | |
| 9935 | // keepScripts (optional): If true, will include scripts passed in the html string | |
| 9936 | jQuery.parseHTML = function( data, context, keepScripts ) { | |
| 9937 | if ( !data || typeof data !== "string" ) { | |
| 9938 | return null; | |
| 9939 | } | |
| 9940 | if ( typeof context === "boolean" ) { | |
| 9941 | keepScripts = context; | |
| 9942 | context = false; | |
| 9943 | } | |
| 9944 | context = context || document; | |
| 9945 | ||
| 9946 | var parsed = rsingleTag.exec( data ), | |
| 9947 | scripts = !keepScripts && []; | |
| 9948 | ||
| 9949 | // Single tag | |
| 9950 | if ( parsed ) { | |
| 9951 | return [ context.createElement( parsed[1] ) ]; | |
| 9952 | } | |
| 9953 | ||
| 9954 | parsed = jQuery.buildFragment( [ data ], context, scripts ); | |
| 9955 | ||
| 9956 | if ( scripts && scripts.length ) { | |
| 9957 | jQuery( scripts ).remove(); | |
| 9958 | } | |
| 9959 | ||
| 9960 | return jQuery.merge( [], parsed.childNodes ); | |
| 9961 | }; | |
| 9962 | ||
| 9963 | ||
| 9964 | // Keep a copy of the old load method | |
| 9965 | var _load = jQuery.fn.load; | |
| 9966 | ||
| 9967 | /** | |
| 9968 | * Load a url into a page | |
| 9969 | */ | |
| 9970 | jQuery.fn.load = function( url, params, callback ) { | |
| 9971 | if ( typeof url !== "string" && _load ) { | |
| 9972 | return _load.apply( this, arguments ); | |
| 9973 | } | |
| 9974 | ||
| 9975 | var selector, response, type, | |
| 9976 | self = this, | |
| 9977 | off = url.indexOf(" "); | |
| 9978 | ||
| 9979 | if ( off >= 0 ) { | |
| 9980 | selector = jQuery.trim( url.slice( off, url.length ) ); | |
| 9981 | url = url.slice( 0, off ); | |
| 9982 | } | |
| 9983 | ||
| 9984 | // If it's a function | |
| 9985 | if ( jQuery.isFunction( params ) ) { | |
| 9986 | ||
| 9987 | // We assume that it's the callback | |
| 9988 | callback = params; | |
| 9989 | params = undefined; | |
| 9990 | ||
| 9991 | // Otherwise, build a param string | |
| 9992 | } else if ( params && typeof params === "object" ) { | |
| 9993 | type = "POST"; | |
| 9994 | } | |
| 9995 | ||
| 9996 | // If we have elements to modify, make the request | |
| 9997 | if ( self.length > 0 ) { | |
| 9998 | jQuery.ajax({ | |
| 9999 | url: url, | |
| 10000 | ||
| 10001 | // if "type" variable is undefined, then "GET" method will be used | |
| 10002 | type: type, | |
| 10003 | dataType: "html", | |
| 10004 | data: params | |
| 10005 | }).done(function( responseText ) { | |
| 10006 | ||
| 10007 | // Save response for use in complete callback | |
| 10008 | response = arguments; | |
| 10009 | ||
| 10010 | self.html( selector ? | |
| 10011 | ||
| 10012 | // If a selector was specified, locate the right elements in a dummy div | |
| 10013 | // Exclude scripts to avoid IE 'Permission Denied' errors | |
| 10014 | jQuery("<div>").append( jQuery.parseHTML( responseText ) ).find( selector ) : | |
| 10015 | ||
| 10016 | // Otherwise use the full result | |
| 10017 | responseText ); | |
| 10018 | ||
| 10019 | }).complete( callback && function( jqXHR, status ) { | |
| 10020 | self.each( callback, response || [ jqXHR.responseText, status, jqXHR ] ); | |
| 10021 | }); | |
| 10022 | } | |
| 10023 | ||
| 10024 | return this; | |
| 10025 | }; | |
| 10026 | ||
| 10027 | ||
| 10028 | ||
| 10029 | ||
| 10030 | // Attach a bunch of functions for handling common AJAX events | |
| 10031 | jQuery.each( [ "ajaxStart", "ajaxStop", "ajaxComplete", "ajaxError", "ajaxSuccess", "ajaxSend" ], function( i, type ) { | |
| 10032 | jQuery.fn[ type ] = function( fn ) { | |
| 10033 | return this.on( type, fn ); | |
| 10034 | }; | |
| 10035 | }); | |
| 10036 | ||
| 10037 | ||
| 10038 | ||
| 10039 | ||
| 10040 | jQuery.expr.filters.animated = function( elem ) { | |
| 10041 | return jQuery.grep(jQuery.timers, function( fn ) { | |
| 10042 | return elem === fn.elem; | |
| 10043 | }).length; | |
| 10044 | }; | |
| 10045 | ||
| 10046 | ||
| 10047 | ||
| 10048 | ||
| 10049 | ||
| 10050 | var docElem = window.document.documentElement; | |
| 10051 | ||
| 10052 | /** | |
| 10053 | * Gets a window from an element | |
| 10054 | */ | |
| 10055 | function getWindow( elem ) { | |
| 10056 | return jQuery.isWindow( elem ) ? | |
| 10057 | elem : | |
| 10058 | elem.nodeType === 9 ? | |
| 10059 | elem.defaultView || elem.parentWindow : | |
| 10060 | false; | |
| 10061 | } | |
| 10062 | ||
| 10063 | jQuery.offset = { | |
| 10064 | setOffset: function( elem, options, i ) { | |
| 10065 | var curPosition, curLeft, curCSSTop, curTop, curOffset, curCSSLeft, calculatePosition, | |
| 10066 | position = jQuery.css( elem, "position" ), | |
| 10067 | curElem = jQuery( elem ), | |
| 10068 | props = {}; | |
| 10069 | ||
| 10070 | // set position first, in-case top/left are set even on static elem | |
| 10071 | if ( position === "static" ) { | |
| 10072 | elem.style.position = "relative"; | |
| 10073 | } | |
| 10074 | ||
| 10075 | curOffset = curElem.offset(); | |
| 10076 | curCSSTop = jQuery.css( elem, "top" ); | |
| 10077 | curCSSLeft = jQuery.css( elem, "left" ); | |
| 10078 | calculatePosition = ( position === "absolute" || position === "fixed" ) && | |
| 10079 | jQuery.inArray("auto", [ curCSSTop, curCSSLeft ] ) > -1; | |
| 10080 | ||
| 10081 | // need to be able to calculate position if either top or left is auto and position is either absolute or fixed | |
| 10082 | if ( calculatePosition ) { | |
| 10083 | curPosition = curElem.position(); | |
| 10084 | curTop = curPosition.top; | |
| 10085 | curLeft = curPosition.left; | |
| 10086 | } else { | |
| 10087 | curTop = parseFloat( curCSSTop ) || 0; | |
| 10088 | curLeft = parseFloat( curCSSLeft ) || 0; | |
| 10089 | } | |
| 10090 | ||
| 10091 | if ( jQuery.isFunction( options ) ) { | |
| 10092 | options = options.call( elem, i, curOffset ); | |
| 10093 | } | |
| 10094 | ||
| 10095 | if ( options.top != null ) { | |
| 10096 | props.top = ( options.top - curOffset.top ) + curTop; | |
| 10097 | } | |
| 10098 | if ( options.left != null ) { | |
| 10099 | props.left = ( options.left - curOffset.left ) + curLeft; | |
| 10100 | } | |
| 10101 | ||
| 10102 | if ( "using" in options ) { | |
| 10103 | options.using.call( elem, props ); | |
| 10104 | } else { | |
| 10105 | curElem.css( props ); | |
| 10106 | } | |
| 10107 | } | |
| 10108 | }; | |
| 10109 | ||
| 10110 | jQuery.fn.extend({ | |
| 10111 | offset: function( options ) { | |
| 10112 | if ( arguments.length ) { | |
| 10113 | return options === undefined ? | |
| 10114 | this : | |
| 10115 | this.each(function( i ) { | |
| 10116 | jQuery.offset.setOffset( this, options, i ); | |
| 10117 | }); | |
| 10118 | } | |
| 10119 | ||
| 10120 | var docElem, win, | |
| 10121 | box = { top: 0, left: 0 }, | |
| 10122 | elem = this[ 0 ], | |
| 10123 | doc = elem && elem.ownerDocument; | |
| 10124 | ||
| 10125 | if ( !doc ) { | |
| 10126 | return; | |
| 10127 | } | |
| 10128 | ||
| 10129 | docElem = doc.documentElement; | |
| 10130 | ||
| 10131 | // Make sure it's not a disconnected DOM node | |
| 10132 | if ( !jQuery.contains( docElem, elem ) ) { | |
| 10133 | return box; | |
| 10134 | } | |
| 10135 | ||
| 10136 | // If we don't have gBCR, just use 0,0 rather than error | |
| 10137 | // BlackBerry 5, iOS 3 (original iPhone) | |
| 10138 | if ( typeof elem.getBoundingClientRect !== strundefined ) { | |
| 10139 | box = elem.getBoundingClientRect(); | |
| 10140 | } | |
| 10141 | win = getWindow( doc ); | |
| 10142 | return { | |
| 10143 | top: box.top + ( win.pageYOffset || docElem.scrollTop ) - ( docElem.clientTop || 0 ), | |
| 10144 | left: box.left + ( win.pageXOffset || docElem.scrollLeft ) - ( docElem.clientLeft || 0 ) | |
| 10145 | }; | |
| 10146 | }, | |
| 10147 | ||
| 10148 | position: function() { | |
| 10149 | if ( !this[ 0 ] ) { | |
| 10150 | return; | |
| 10151 | } | |
| 10152 | ||
| 10153 | var offsetParent, offset, | |
| 10154 | parentOffset = { top: 0, left: 0 }, | |
| 10155 | elem = this[ 0 ]; | |
| 10156 | ||
| 10157 | // fixed elements are offset from window (parentOffset = {top:0, left: 0}, because it is its only offset parent | |
| 10158 | if ( jQuery.css( elem, "position" ) === "fixed" ) { | |
| 10159 | // we assume that getBoundingClientRect is available when computed position is fixed | |
| 10160 | offset = elem.getBoundingClientRect(); | |
| 10161 | } else { | |
| 10162 | // Get *real* offsetParent | |
| 10163 | offsetParent = this.offsetParent(); | |
| 10164 | ||
| 10165 | // Get correct offsets | |
| 10166 | offset = this.offset(); | |
| 10167 | if ( !jQuery.nodeName( offsetParent[ 0 ], "html" ) ) { | |
| 10168 | parentOffset = offsetParent.offset(); | |
| 10169 | } | |
| 10170 | ||
| 10171 | // Add offsetParent borders | |
| 10172 | parentOffset.top += jQuery.css( offsetParent[ 0 ], "borderTopWidth", true ); | |
| 10173 | parentOffset.left += jQuery.css( offsetParent[ 0 ], "borderLeftWidth", true ); | |
| 10174 | } | |
| 10175 | ||
| 10176 | // Subtract parent offsets and element margins | |
| 10177 | // note: when an element has margin: auto the offsetLeft and marginLeft | |
| 10178 | // are the same in Safari causing offset.left to incorrectly be 0 | |
| 10179 | return { | |
| 10180 | top: offset.top - parentOffset.top - jQuery.css( elem, "marginTop", true ), | |
| 10181 | left: offset.left - parentOffset.left - jQuery.css( elem, "marginLeft", true) | |
| 10182 | }; | |
| 10183 | }, | |
| 10184 | ||
| 10185 | offsetParent: function() { | |
| 10186 | return this.map(function() { | |
| 10187 | var offsetParent = this.offsetParent || docElem; | |
| 10188 | ||
| 10189 | while ( offsetParent && ( !jQuery.nodeName( offsetParent, "html" ) && jQuery.css( offsetParent, "position" ) === "static" ) ) { | |
| 10190 | offsetParent = offsetParent.offsetParent; | |
| 10191 | } | |
| 10192 | return offsetParent || docElem; | |
| 10193 | }); | |
| 10194 | } | |
| 10195 | }); | |
| 10196 | ||
| 10197 | // Create scrollLeft and scrollTop methods | |
| 10198 | jQuery.each( { scrollLeft: "pageXOffset", scrollTop: "pageYOffset" }, function( method, prop ) { | |
| 10199 | var top = /Y/.test( prop ); | |
| 10200 | ||
| 10201 | jQuery.fn[ method ] = function( val ) { | |
| 10202 | return access( this, function( elem, method, val ) { | |
| 10203 | var win = getWindow( elem ); | |
| 10204 | ||
| 10205 | if ( val === undefined ) { | |
| 10206 | return win ? (prop in win) ? win[ prop ] : | |
| 10207 | win.document.documentElement[ method ] : | |
| 10208 | elem[ method ]; | |
| 10209 | } | |
| 10210 | ||
| 10211 | if ( win ) { | |
| 10212 | win.scrollTo( | |
| 10213 | !top ? val : jQuery( win ).scrollLeft(), | |
| 10214 | top ? val : jQuery( win ).scrollTop() | |
| 10215 | ); | |
| 10216 | ||
| 10217 | } else { | |
| 10218 | elem[ method ] = val; | |
| 10219 | } | |
| 10220 | }, method, val, arguments.length, null ); | |
| 10221 | }; | |
| 10222 | }); | |
| 10223 | ||
| 10224 | // Add the top/left cssHooks using jQuery.fn.position | |
| 10225 | // Webkit bug: https://bugs.webkit.org/show_bug.cgi?id=29084 | |
| 10226 | // getComputedStyle returns percent when specified for top/left/bottom/right | |
| 10227 | // rather than make the css module depend on the offset module, we just check for it here | |
| 10228 | jQuery.each( [ "top", "left" ], function( i, prop ) { | |
| 10229 | jQuery.cssHooks[ prop ] = addGetHookIf( support.pixelPosition, | |
| 10230 | function( elem, computed ) { | |
| 10231 | if ( computed ) { | |
| 10232 | computed = curCSS( elem, prop ); | |
| 10233 | // if curCSS returns percentage, fallback to offset | |
| 10234 | return rnumnonpx.test( computed ) ? | |
| 10235 | jQuery( elem ).position()[ prop ] + "px" : | |
| 10236 | computed; | |
| 10237 | } | |
| 10238 | } | |
| 10239 | ); | |
| 10240 | }); | |
| 10241 | ||
| 10242 | ||
| 10243 | // Create innerHeight, innerWidth, height, width, outerHeight and outerWidth methods | |
| 10244 | jQuery.each( { Height: "height", Width: "width" }, function( name, type ) { | |
| 10245 | jQuery.each( { padding: "inner" + name, content: type, "": "outer" + name }, function( defaultExtra, funcName ) { | |
| 10246 | // margin is only for outerHeight, outerWidth | |
| 10247 | jQuery.fn[ funcName ] = function( margin, value ) { | |
| 10248 | var chainable = arguments.length && ( defaultExtra || typeof margin !== "boolean" ), | |
| 10249 | extra = defaultExtra || ( margin === true || value === true ? "margin" : "border" ); | |
| 10250 | ||
| 10251 | return access( this, function( elem, type, value ) { | |
| 10252 | var doc; | |
| 10253 | ||
| 10254 | if ( jQuery.isWindow( elem ) ) { | |
| 10255 | // As of 5/8/2012 this will yield incorrect results for Mobile Safari, but there | |
| 10256 | // isn't a whole lot we can do. See pull request at this URL for discussion: | |
| 10257 | // https://github.com/jquery/jquery/pull/764 | |
| 10258 | return elem.document.documentElement[ "client" + name ]; | |
| 10259 | } | |
| 10260 | ||
| 10261 | // Get document width or height | |
| 10262 | if ( elem.nodeType === 9 ) { | |
| 10263 | doc = elem.documentElement; | |
| 10264 | ||
| 10265 | // Either scroll[Width/Height] or offset[Width/Height] or client[Width/Height], whichever is greatest | |
| 10266 | // unfortunately, this causes bug #3838 in IE6/8 only, but there is currently no good, small way to fix it. | |
| 10267 | return Math.max( | |
| 10268 | elem.body[ "scroll" + name ], doc[ "scroll" + name ], | |
| 10269 | elem.body[ "offset" + name ], doc[ "offset" + name ], | |
| 10270 | doc[ "client" + name ] | |
| 10271 | ); | |
| 10272 | } | |
| 10273 | ||
| 10274 | return value === undefined ? | |
| 10275 | // Get width or height on the element, requesting but not forcing parseFloat | |
| 10276 | jQuery.css( elem, type, extra ) : | |
| 10277 | ||
| 10278 | // Set width or height on the element | |
| 10279 | jQuery.style( elem, type, value, extra ); | |
| 10280 | }, type, chainable ? margin : undefined, chainable, null ); | |
| 10281 | }; | |
| 10282 | }); | |
| 10283 | }); | |
| 10284 | ||
| 10285 | ||
| 10286 | // The number of elements contained in the matched element set | |
| 10287 | jQuery.fn.size = function() { | |
| 10288 | return this.length; | |
| 10289 | }; | |
| 10290 | ||
| 10291 | jQuery.fn.andSelf = jQuery.fn.addBack; | |
| 10292 | ||
| 10293 | ||
| 10294 | ||
| 10295 | ||
| 10296 | // Register as a named AMD module, since jQuery can be concatenated with other | |
| 10297 | // files that may use define, but not via a proper concatenation script that | |
| 10298 | // understands anonymous AMD modules. A named AMD is safest and most robust | |
| 10299 | // way to register. Lowercase jquery is used because AMD module names are | |
| 10300 | // derived from file names, and jQuery is normally delivered in a lowercase | |
| 10301 | // file name. Do this after creating the global so that if an AMD module wants | |
| 10302 | // to call noConflict to hide this version of jQuery, it will work. | |
| 10303 | ||
| 10304 | // Note that for maximum portability, libraries that are not jQuery should | |
| 10305 | // declare themselves as anonymous modules, and avoid setting a global if an | |
| 10306 | // AMD loader is present. jQuery is a special case. For more information, see | |
| 10307 | // https://github.com/jrburke/requirejs/wiki/Updating-existing-libraries#wiki-anon | |
| 10308 | ||
| 10309 | if ( typeof define === "function" && define.amd ) { | |
| 10310 | define( "jquery", [], function() { | |
| 10311 | return jQuery; | |
| 10312 | }); | |
| 10313 | } | |
| 10314 | ||
| 10315 | ||
| 10316 | ||
| 10317 | ||
| 10318 | var | |
| 10319 | // Map over jQuery in case of overwrite | |
| 10320 | _jQuery = window.jQuery, | |
| 10321 | ||
| 10322 | // Map over the $ in case of overwrite | |
| 10323 | _$ = window.$; | |
| 10324 | ||
| 10325 | jQuery.noConflict = function( deep ) { | |
| 10326 | if ( window.$ === jQuery ) { | |
| 10327 | window.$ = _$; | |
| 10328 | } | |
| 10329 | ||
| 10330 | if ( deep && window.jQuery === jQuery ) { | |
| 10331 | window.jQuery = _jQuery; | |
| 10332 | } | |
| 10333 | ||
| 10334 | return jQuery; | |
| 10335 | }; | |
| 10336 | ||
| 10337 | // Expose jQuery and $ identifiers, even in | |
| 10338 | // AMD (#7102#comment:10, https://github.com/jquery/jquery/pull/557) | |
| 10339 | // and CommonJS for browser emulators (#13566) | |
| 10340 | if ( typeof noGlobal === strundefined ) { | |
| 10341 | window.jQuery = window.$ = jQuery; | |
| 10342 | } | |
| 10343 | ||
| 10344 | ||
| 10345 | ||
| 10346 | ||
| 10347 | return jQuery; | |
| 10348 | ||
| 10349 | ||
| 10350 | })); | |
| 0 | /*! jQuery v3.5.1 | (c) JS Foundation and other contributors | jquery.org/license */ | |
| 1 | !function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.5.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0<t&&t-1 in e)}S.fn=S.prototype={jquery:f,constructor:S,length:0,toArray:function(){return s.call(this)},get:function(e){return null==e?s.call(this):e<0?this[e+this.length]:this[e]},pushStack:function(e){var t=S.merge(this.constructor(),e);return t.prevObject=this,t},each:function(e){return S.each(this,e)},map:function(n){return this.pushStack(S.map(this,function(e,t){return n.call(e,t,e)}))},slice:function(){return this.pushStack(s.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},even:function(){return this.pushStack(S.grep(this,function(e,t){return(t+1)%2}))},odd:function(){return this.pushStack(S.grep(this,function(e,t){return t%2}))},eq:function(e){var t=this.length,n=+e+(e<0?t:0);return this.pushStack(0<=n&&n<t?[this[n]]:[])},end:function(){return this.prevObject||this.constructor()},push:u,sort:t.sort,splice:t.splice},S.extend=S.fn.extend=function(){var e,t,n,r,i,o,a=arguments[0]||{},s=1,u=arguments.length,l=!1;for("boolean"==typeof a&&(l=a,a=arguments[s]||{},s++),"object"==typeof a||m(a)||(a={}),s===u&&(a=this,s--);s<u;s++)if(null!=(e=arguments[s]))for(t in e)r=e[t],"__proto__"!==t&&a!==r&&(l&&r&&(S.isPlainObject(r)||(i=Array.isArray(r)))?(n=a[t],o=i&&!Array.isArray(n)?[]:i||S.isPlainObject(n)?n:{},i=!1,a[t]=S.extend(l,o,r)):void 0!==r&&(a[t]=r));return a},S.extend({expando:"jQuery"+(f+Math.random()).replace(/\D/g,""),isReady:!0,error:function(e){throw new Error(e)},noop:function(){},isPlainObject:function(e){var t,n;return!(!e||"[object Object]"!==o.call(e))&&(!(t=r(e))||"function"==typeof(n=v.call(t,"constructor")&&t.constructor)&&a.call(n)===l)},isEmptyObject:function(e){var t;for(t in e)return!1;return!0},globalEval:function(e,t,n){b(e,{nonce:t&&t.nonce},n)},each:function(e,t){var n,r=0;if(p(e)){for(n=e.length;r<n;r++)if(!1===t.call(e[r],r,e[r]))break}else for(r in e)if(!1===t.call(e[r],r,e[r]))break;return e},makeArray:function(e,t){var n=t||[];return null!=e&&(p(Object(e))?S.merge(n,"string"==typeof e?[e]:e):u.call(n,e)),n},inArray:function(e,t,n){return null==t?-1:i.call(t,e,n)},merge:function(e,t){for(var n=+t.length,r=0,i=e.length;r<n;r++)e[i++]=t[r];return e.length=i,e},grep:function(e,t,n){for(var r=[],i=0,o=e.length,a=!n;i<o;i++)!t(e[i],i)!==a&&r.push(e[i]);return r},map:function(e,t,n){var r,i,o=0,a=[];if(p(e))for(r=e.length;o<r;o++)null!=(i=t(e[o],o,n))&&a.push(i);else for(o in e)null!=(i=t(e[o],o,n))&&a.push(i);return g(a)},guid:1,support:y}),"function"==typeof Symbol&&(S.fn[Symbol.iterator]=t[Symbol.iterator]),S.each("Boolean Number String Function Array Date RegExp Object Error Symbol".split(" "),function(e,t){n["[object "+t+"]"]=t.toLowerCase()});var d=function(n){var e,d,b,o,i,h,f,g,w,u,l,T,C,a,E,v,s,c,y,S="sizzle"+1*new Date,p=n.document,k=0,r=0,m=ue(),x=ue(),A=ue(),N=ue(),D=function(e,t){return e===t&&(l=!0),0},j={}.hasOwnProperty,t=[],q=t.pop,L=t.push,H=t.push,O=t.slice,P=function(e,t){for(var n=0,r=e.length;n<r;n++)if(e[n]===t)return n;return-1},R="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",M="[\\x20\\t\\r\\n\\f]",I="(?:\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+",W="\\["+M+"*("+I+")(?:"+M+"*([*^$|!~]?=)"+M+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+I+"))|)"+M+"*\\]",F=":("+I+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+W+")*)|.*)\\)|)",B=new RegExp(M+"+","g"),$=new RegExp("^"+M+"+|((?:^|[^\\\\])(?:\\\\.)*)"+M+"+$","g"),_=new RegExp("^"+M+"*,"+M+"*"),z=new RegExp("^"+M+"*([>+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="<a id='"+S+"'></a><select id='"+S+"-\r\\' msallowcapture=''><option selected=''></option></select>",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="<a href='' disabled='disabled'></a><select disabled='disabled'><option/></select>";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0<se(t,C,null,[e]).length},se.contains=function(e,t){return(e.ownerDocument||e)!=C&&T(e),y(e,t)},se.attr=function(e,t){(e.ownerDocument||e)!=C&&T(e);var n=b.attrHandle[t.toLowerCase()],r=n&&j.call(b.attrHandle,t.toLowerCase())?n(e,t,!E):void 0;return void 0!==r?r:d.attributes||!E?e.getAttribute(t):(r=e.getAttributeNode(t))&&r.specified?r.value:null},se.escape=function(e){return(e+"").replace(re,ie)},se.error=function(e){throw new Error("Syntax error, unrecognized expression: "+e)},se.uniqueSort=function(e){var t,n=[],r=0,i=0;if(l=!d.detectDuplicates,u=!d.sortStable&&e.slice(0),e.sort(D),l){while(t=e[i++])t===e[i]&&(r=n.push(i));while(r--)e.splice(n[r],1)}return u=null,e},o=se.getText=function(e){var t,n="",r=0,i=e.nodeType;if(i){if(1===i||9===i||11===i){if("string"==typeof e.textContent)return e.textContent;for(e=e.firstChild;e;e=e.nextSibling)n+=o(e)}else if(3===i||4===i)return e.nodeValue}else while(t=e[r++])n+=o(t);return n},(b=se.selectors={cacheLength:50,createPseudo:le,match:G,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1<t.indexOf(i):"$="===r?i&&t.slice(-i.length)===i:"~="===r?-1<(" "+t.replace(B," ")+" ").indexOf(i):"|="===r&&(t===i||t.slice(0,i.length+1)===i+"-"))}},CHILD:function(h,e,t,g,v){var y="nth"!==h.slice(0,3),m="last"!==h.slice(-4),x="of-type"===e;return 1===g&&0===v?function(e){return!!e.parentNode}:function(e,t,n){var r,i,o,a,s,u,l=y!==m?"nextSibling":"previousSibling",c=e.parentNode,f=x&&e.nodeName.toLowerCase(),p=!n&&!x,d=!1;if(c){if(y){while(l){a=e;while(a=a[l])if(x?a.nodeName.toLowerCase()===f:1===a.nodeType)return!1;u=l="only"===h&&!u&&"nextSibling"}return!0}if(u=[m?c.firstChild:c.lastChild],m&&p){d=(s=(r=(i=(o=(a=c)[S]||(a[S]={}))[a.uniqueID]||(o[a.uniqueID]={}))[h]||[])[0]===k&&r[1])&&r[2],a=s&&c.childNodes[s];while(a=++s&&a&&a[l]||(d=s=0)||u.pop())if(1===a.nodeType&&++d&&a===e){i[h]=[k,s,d];break}}else if(p&&(d=s=(r=(i=(o=(a=e)[S]||(a[S]={}))[a.uniqueID]||(o[a.uniqueID]={}))[h]||[])[0]===k&&r[1]),!1===d)while(a=++s&&a&&a[l]||(d=s=0)||u.pop())if((x?a.nodeName.toLowerCase()===f:1===a.nodeType)&&++d&&(p&&((i=(o=a[S]||(a[S]={}))[a.uniqueID]||(o[a.uniqueID]={}))[h]=[k,d]),a===e))break;return(d-=v)===g||d%g==0&&0<=d/g}}},PSEUDO:function(e,o){var t,a=b.pseudos[e]||b.setFilters[e.toLowerCase()]||se.error("unsupported pseudo: "+e);return a[S]?a(o):1<a.length?(t=[e,e,"",o],b.setFilters.hasOwnProperty(e.toLowerCase())?le(function(e,t){var n,r=a(e,o),i=r.length;while(i--)e[n=P(e,r[i])]=!(t[n]=r[i])}):function(e){return a(e,0,t)}):a}},pseudos:{not:le(function(e){var r=[],i=[],s=f(e.replace($,"$1"));return s[S]?le(function(e,t,n,r){var i,o=s(e,null,r,[]),a=e.length;while(a--)(i=o[a])&&(e[a]=!(t[a]=i))}):function(e,t,n){return r[0]=e,s(r,null,n,i),r[0]=null,!i.pop()}}),has:le(function(t){return function(e){return 0<se(t,e).length}}),contains:le(function(t){return t=t.replace(te,ne),function(e){return-1<(e.textContent||o(e)).indexOf(t)}}),lang:le(function(n){return V.test(n||"")||se.error("unsupported lang: "+n),n=n.replace(te,ne).toLowerCase(),function(e){var t;do{if(t=E?e.lang:e.getAttribute("xml:lang")||e.getAttribute("lang"))return(t=t.toLowerCase())===n||0===t.indexOf(n+"-")}while((e=e.parentNode)&&1===e.nodeType);return!1}}),target:function(e){var t=n.location&&n.location.hash;return t&&t.slice(1)===e.id},root:function(e){return e===a},focus:function(e){return e===C.activeElement&&(!C.hasFocus||C.hasFocus())&&!!(e.type||e.href||~e.tabIndex)},enabled:ge(!1),disabled:ge(!0),checked:function(e){var t=e.nodeName.toLowerCase();return"input"===t&&!!e.checked||"option"===t&&!!e.selected},selected:function(e){return e.parentNode&&e.parentNode.selectedIndex,!0===e.selected},empty:function(e){for(e=e.firstChild;e;e=e.nextSibling)if(e.nodeType<6)return!1;return!0},parent:function(e){return!b.pseudos.empty(e)},header:function(e){return J.test(e.nodeName)},input:function(e){return Q.test(e.nodeName)},button:function(e){var t=e.nodeName.toLowerCase();return"input"===t&&"button"===e.type||"button"===t},text:function(e){var t;return"input"===e.nodeName.toLowerCase()&&"text"===e.type&&(null==(t=e.getAttribute("type"))||"text"===t.toLowerCase())},first:ve(function(){return[0]}),last:ve(function(e,t){return[t-1]}),eq:ve(function(e,t,n){return[n<0?n+t:n]}),even:ve(function(e,t){for(var n=0;n<t;n+=2)e.push(n);return e}),odd:ve(function(e,t){for(var n=1;n<t;n+=2)e.push(n);return e}),lt:ve(function(e,t,n){for(var r=n<0?n+t:t<n?t:n;0<=--r;)e.push(r);return e}),gt:ve(function(e,t,n){for(var r=n<0?n+t:n;++r<t;)e.push(r);return e})}}).pseudos.nth=b.pseudos.eq,{radio:!0,checkbox:!0,file:!0,password:!0,image:!0})b.pseudos[e]=de(e);for(e in{submit:!0,reset:!0})b.pseudos[e]=he(e);function me(){}function xe(e){for(var t=0,n=e.length,r="";t<n;t++)r+=e[t].value;return r}function be(s,e,t){var u=e.dir,l=e.next,c=l||u,f=t&&"parentNode"===c,p=r++;return e.first?function(e,t,n){while(e=e[u])if(1===e.nodeType||f)return s(e,t,n);return!1}:function(e,t,n){var r,i,o,a=[k,p];if(n){while(e=e[u])if((1===e.nodeType||f)&&s(e,t,n))return!0}else while(e=e[u])if(1===e.nodeType||f)if(i=(o=e[S]||(e[S]={}))[e.uniqueID]||(o[e.uniqueID]={}),l&&l===e.nodeName.toLowerCase())e=e[u]||e;else{if((r=i[c])&&r[0]===k&&r[1]===p)return a[2]=r[2];if((i[c]=a)[2]=s(e,t,n))return!0}return!1}}function we(i){return 1<i.length?function(e,t,n){var r=i.length;while(r--)if(!i[r](e,t,n))return!1;return!0}:i[0]}function Te(e,t,n,r,i){for(var o,a=[],s=0,u=e.length,l=null!=t;s<u;s++)(o=e[s])&&(n&&!n(o,r,i)||(a.push(o),l&&t.push(s)));return a}function Ce(d,h,g,v,y,e){return v&&!v[S]&&(v=Ce(v)),y&&!y[S]&&(y=Ce(y,e)),le(function(e,t,n,r){var i,o,a,s=[],u=[],l=t.length,c=e||function(e,t,n){for(var r=0,i=t.length;r<i;r++)se(e,t[r],n);return n}(h||"*",n.nodeType?[n]:n,[]),f=!d||!e&&h?c:Te(c,s,d,n,r),p=g?y||(e?d:l||v)?[]:t:f;if(g&&g(f,p,n,r),v){i=Te(p,u),v(i,[],n,r),o=i.length;while(o--)(a=i[o])&&(p[u[o]]=!(f[u[o]]=a))}if(e){if(y||d){if(y){i=[],o=p.length;while(o--)(a=p[o])&&i.push(f[o]=a);y(null,p=[],i,r)}o=p.length;while(o--)(a=p[o])&&-1<(i=y?P(e,a):s[o])&&(e[i]=!(t[i]=a))}}else p=Te(p===t?p.splice(l,p.length):p),y?y(null,t,p,r):H.apply(t,p)})}function Ee(e){for(var i,t,n,r=e.length,o=b.relative[e[0].type],a=o||b.relative[" "],s=o?1:0,u=be(function(e){return e===i},a,!0),l=be(function(e){return-1<P(i,e)},a,!0),c=[function(e,t,n){var r=!o&&(n||t!==w)||((i=t).nodeType?u(e,t,n):l(e,t,n));return i=null,r}];s<r;s++)if(t=b.relative[e[s].type])c=[be(we(c),t)];else{if((t=b.filter[e[s].type].apply(null,e[s].matches))[S]){for(n=++s;n<r;n++)if(b.relative[e[n].type])break;return Ce(1<s&&we(c),1<s&&xe(e.slice(0,s-1).concat({value:" "===e[s-2].type?"*":""})).replace($,"$1"),t,s<n&&Ee(e.slice(s,n)),n<r&&Ee(e=e.slice(n)),n<r&&xe(e))}c.push(t)}return we(c)}return me.prototype=b.filters=b.pseudos,b.setFilters=new me,h=se.tokenize=function(e,t){var n,r,i,o,a,s,u,l=x[e+" "];if(l)return t?0:l.slice(0);a=e,s=[],u=b.preFilter;while(a){for(o in n&&!(r=_.exec(a))||(r&&(a=a.slice(r[0].length)||a),s.push(i=[])),n=!1,(r=z.exec(a))&&(n=r.shift(),i.push({value:n,type:r[0].replace($," ")}),a=a.slice(n.length)),b.filter)!(r=G[o].exec(a))||u[o]&&!(r=u[o](r))||(n=r.shift(),i.push({value:n,type:o,matches:r}),a=a.slice(n.length));if(!n)break}return t?a.length:a?se.error(e):x(e,s).slice(0)},f=se.compile=function(e,t){var n,v,y,m,x,r,i=[],o=[],a=A[e+" "];if(!a){t||(t=h(e)),n=t.length;while(n--)(a=Ee(t[n]))[S]?i.push(a):o.push(a);(a=A(e,(v=o,m=0<(y=i).length,x=0<v.length,r=function(e,t,n,r,i){var o,a,s,u=0,l="0",c=e&&[],f=[],p=w,d=e||x&&b.find.TAG("*",i),h=k+=null==p?1:Math.random()||.1,g=d.length;for(i&&(w=t==C||t||i);l!==g&&null!=(o=d[l]);l++){if(x&&o){a=0,t||o.ownerDocument==C||(T(o),n=!E);while(s=v[a++])if(s(o,t||C,n)){r.push(o);break}i&&(k=h)}m&&((o=!s&&o)&&u--,e&&c.push(o))}if(u+=l,m&&l!==u){a=0;while(s=y[a++])s(c,f,t,n);if(e){if(0<u)while(l--)c[l]||f[l]||(f[l]=q.call(r));f=Te(f)}H.apply(r,f),i&&!e&&0<f.length&&1<u+y.length&&se.uniqueSort(r)}return i&&(k=h,w=p),c},m?le(r):r))).selector=e}return a},g=se.select=function(e,t,n,r){var i,o,a,s,u,l="function"==typeof e&&e,c=!r&&h(e=l.selector||e);if(n=n||[],1===c.length){if(2<(o=c[0]=c[0].slice(0)).length&&"ID"===(a=o[0]).type&&9===t.nodeType&&E&&b.relative[o[1].type]){if(!(t=(b.find.ID(a.matches[0].replace(te,ne),t)||[])[0]))return n;l&&(t=t.parentNode),e=e.slice(o.shift().value.length)}i=G.needsContext.test(e)?0:o.length;while(i--){if(a=o[i],b.relative[s=a.type])break;if((u=b.find[s])&&(r=u(a.matches[0].replace(te,ne),ee.test(o[0].type)&&ye(t.parentNode)||t))){if(o.splice(i,1),!(e=r.length&&xe(o)))return H.apply(n,r),n;break}}}return(l||f(e,c))(r,t,!E,n,!t||ee.test(e)&&ye(t.parentNode)||t),n},d.sortStable=S.split("").sort(D).join("")===S,d.detectDuplicates=!!l,T(),d.sortDetached=ce(function(e){return 1&e.compareDocumentPosition(C.createElement("fieldset"))}),ce(function(e){return e.innerHTML="<a href='#'></a>","#"===e.firstChild.getAttribute("href")})||fe("type|href|height|width",function(e,t,n){if(!n)return e.getAttribute(t,"type"===t.toLowerCase()?1:2)}),d.attributes&&ce(function(e){return e.innerHTML="<input/>",e.firstChild.setAttribute("value",""),""===e.firstChild.getAttribute("value")})||fe("value",function(e,t,n){if(!n&&"input"===e.nodeName.toLowerCase())return e.defaultValue}),ce(function(e){return null==e.getAttribute("disabled")})||fe(R,function(e,t,n){var r;if(!n)return!0===e[t]?t.toLowerCase():(r=e.getAttributeNode(t))&&r.specified?r.value:null}),se}(C);S.find=d,S.expr=d.selectors,S.expr[":"]=S.expr.pseudos,S.uniqueSort=S.unique=d.uniqueSort,S.text=d.getText,S.isXMLDoc=d.isXML,S.contains=d.contains,S.escapeSelector=d.escape;var h=function(e,t,n){var r=[],i=void 0!==n;while((e=e[t])&&9!==e.nodeType)if(1===e.nodeType){if(i&&S(e).is(n))break;r.push(e)}return r},T=function(e,t){for(var n=[];e;e=e.nextSibling)1===e.nodeType&&e!==t&&n.push(e);return n},k=S.expr.match.needsContext;function A(e,t){return e.nodeName&&e.nodeName.toLowerCase()===t.toLowerCase()}var N=/^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function D(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1<i.call(n,e)!==r}):S.filter(n,e,r)}S.filter=function(e,t,n){var r=t[0];return n&&(e=":not("+e+")"),1===t.length&&1===r.nodeType?S.find.matchesSelector(r,e)?[r]:[]:S.find.matches(e,S.grep(t,function(e){return 1===e.nodeType}))},S.fn.extend({find:function(e){var t,n,r=this.length,i=this;if("string"!=typeof e)return this.pushStack(S(e).filter(function(){for(t=0;t<r;t++)if(S.contains(i[t],this))return!0}));for(n=this.pushStack([]),t=0;t<r;t++)S.find(e,i[t],n);return 1<r?S.uniqueSort(n):n},filter:function(e){return this.pushStack(D(this,e||[],!1))},not:function(e){return this.pushStack(D(this,e||[],!0))},is:function(e){return!!D(this,"string"==typeof e&&k.test(e)?S(e):e||[],!1).length}});var j,q=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||j,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,j=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e<n;e++)if(S.contains(this,t[e]))return!0})},closest:function(e,t){var n,r=0,i=this.length,o=[],a="string"!=typeof e&&S(e);if(!k.test(e))for(;r<i;r++)for(n=this[r];n&&n!==t;n=n.parentNode)if(n.nodeType<11&&(a?-1<a.index(n):1===n.nodeType&&S.find.matchesSelector(n,e))){o.push(n);break}return this.pushStack(1<o.length?S.uniqueSort(o):o)},index:function(e){return e?"string"==typeof e?i.call(S(e),this[0]):i.call(this,e.jquery?e[0]:e):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(e,t){return this.pushStack(S.uniqueSort(S.merge(this.get(),S(e,t))))},addBack:function(e){return this.add(null==e?this.prevObject:this.prevObject.filter(e))}}),S.each({parent:function(e){var t=e.parentNode;return t&&11!==t.nodeType?t:null},parents:function(e){return h(e,"parentNode")},parentsUntil:function(e,t,n){return h(e,"parentNode",n)},next:function(e){return O(e,"nextSibling")},prev:function(e){return O(e,"previousSibling")},nextAll:function(e){return h(e,"nextSibling")},prevAll:function(e){return h(e,"previousSibling")},nextUntil:function(e,t,n){return h(e,"nextSibling",n)},prevUntil:function(e,t,n){return h(e,"previousSibling",n)},siblings:function(e){return T((e.parentNode||{}).firstChild,e)},children:function(e){return T(e.firstChild)},contents:function(e){return null!=e.contentDocument&&r(e.contentDocument)?e.contentDocument:(A(e,"template")&&(e=e.content||e),S.merge([],e.childNodes))}},function(r,i){S.fn[r]=function(e,t){var n=S.map(this,i,e);return"Until"!==r.slice(-5)&&(t=e),t&&"string"==typeof t&&(n=S.filter(t,n)),1<this.length&&(H[r]||S.uniqueSort(n),L.test(r)&&n.reverse()),this.pushStack(n)}});var P=/[^\x20\t\r\n\f]+/g;function R(e){return e}function M(e){throw e}function I(e,t,n,r){var i;try{e&&m(i=e.promise)?i.call(e).done(t).fail(n):e&&m(i=e.then)?i.call(e,t,n):t.apply(void 0,[e].slice(r))}catch(e){n.apply(void 0,[e])}}S.Callbacks=function(r){var e,n;r="string"==typeof r?(e=r,n={},S.each(e.match(P)||[],function(e,t){n[t]=!0}),n):S.extend({},r);var i,t,o,a,s=[],u=[],l=-1,c=function(){for(a=a||r.once,o=i=!0;u.length;l=-1){t=u.shift();while(++l<s.length)!1===s[l].apply(t[0],t[1])&&r.stopOnFalse&&(l=s.length,t=!1)}r.memory||(t=!1),i=!1,a&&(s=t?[]:"")},f={add:function(){return s&&(t&&!i&&(l=s.length-1,u.push(t)),function n(e){S.each(e,function(e,t){m(t)?r.unique&&f.has(t)||s.push(t):t&&t.length&&"string"!==w(t)&&n(t)})}(arguments),t&&!i&&c()),this},remove:function(){return S.each(arguments,function(e,t){var n;while(-1<(n=S.inArray(t,s,n)))s.splice(n,1),n<=l&&l--}),this},has:function(e){return e?-1<S.inArray(e,s):0<s.length},empty:function(){return s&&(s=[]),this},disable:function(){return a=u=[],s=t="",this},disabled:function(){return!s},lock:function(){return a=u=[],t||i||(s=t=""),this},locked:function(){return!!a},fireWith:function(e,t){return a||(t=[e,(t=t||[]).slice?t.slice():t],u.push(t),i||c()),this},fire:function(){return f.fireWith(this,arguments),this},fired:function(){return!!o}};return f},S.extend({Deferred:function(e){var o=[["notify","progress",S.Callbacks("memory"),S.Callbacks("memory"),2],["resolve","done",S.Callbacks("once memory"),S.Callbacks("once memory"),0,"resolved"],["reject","fail",S.Callbacks("once memory"),S.Callbacks("once memory"),1,"rejected"]],i="pending",a={state:function(){return i},always:function(){return s.done(arguments).fail(arguments),this},"catch":function(e){return a.then(null,e)},pipe:function(){var i=arguments;return S.Deferred(function(r){S.each(o,function(e,t){var n=m(i[t[4]])&&i[t[4]];s[t[1]](function(){var e=n&&n.apply(this,arguments);e&&m(e.promise)?e.promise().progress(r.notify).done(r.resolve).fail(r.reject):r[t[0]+"With"](this,n?[e]:arguments)})}),i=null}).promise()},then:function(t,n,r){var u=0;function l(i,o,a,s){return function(){var n=this,r=arguments,e=function(){var e,t;if(!(i<u)){if((e=a.apply(n,r))===o.promise())throw new TypeError("Thenable self-resolution");t=e&&("object"==typeof e||"function"==typeof e)&&e.then,m(t)?s?t.call(e,l(u,o,R,s),l(u,o,M,s)):(u++,t.call(e,l(u,o,R,s),l(u,o,M,s),l(u,o,R,o.notifyWith))):(a!==R&&(n=void 0,r=[e]),(s||o.resolveWith)(n,r))}},t=s?e:function(){try{e()}catch(e){S.Deferred.exceptionHook&&S.Deferred.exceptionHook(e,t.stackTrace),u<=i+1&&(a!==M&&(n=void 0,r=[e]),o.rejectWith(n,r))}};i?t():(S.Deferred.getStackHook&&(t.stackTrace=S.Deferred.getStackHook()),C.setTimeout(t))}}return S.Deferred(function(e){o[0][3].add(l(0,e,m(r)?r:R,e.notifyWith)),o[1][3].add(l(0,e,m(t)?t:R)),o[2][3].add(l(0,e,m(n)?n:M))}).promise()},promise:function(e){return null!=e?S.extend(e,a):a}},s={};return S.each(o,function(e,t){var n=t[2],r=t[5];a[t[1]]=n.add,r&&n.add(function(){i=r},o[3-e][2].disable,o[3-e][3].disable,o[0][2].lock,o[0][3].lock),n.add(t[3].fire),s[t[0]]=function(){return s[t[0]+"With"](this===s?void 0:this,arguments),this},s[t[0]+"With"]=n.fireWith}),a.promise(s),e&&e.call(s,s),s},when:function(e){var n=arguments.length,t=n,r=Array(t),i=s.call(arguments),o=S.Deferred(),a=function(t){return function(e){r[t]=this,i[t]=1<arguments.length?s.call(arguments):e,--n||o.resolveWith(r,i)}};if(n<=1&&(I(e,o.done(a(t)).resolve,o.reject,!n),"pending"===o.state()||m(i[t]&&i[t].then)))return o.then();while(t--)I(i[t],a(t),o.reject);return o.promise()}});var W=/^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;S.Deferred.exceptionHook=function(e,t){C.console&&C.console.warn&&e&&W.test(e.name)&&C.console.warn("jQuery.Deferred exception: "+e.message,e.stack,t)},S.readyException=function(e){C.setTimeout(function(){throw e})};var F=S.Deferred();function B(){E.removeEventListener("DOMContentLoaded",B),C.removeEventListener("load",B),S.ready()}S.fn.ready=function(e){return F.then(e)["catch"](function(e){S.readyException(e)}),this},S.extend({isReady:!1,readyWait:1,ready:function(e){(!0===e?--S.readyWait:S.isReady)||(S.isReady=!0)!==e&&0<--S.readyWait||F.resolveWith(E,[S])}}),S.ready.then=F.then,"complete"===E.readyState||"loading"!==E.readyState&&!E.documentElement.doScroll?C.setTimeout(S.ready):(E.addEventListener("DOMContentLoaded",B),C.addEventListener("load",B));var $=function(e,t,n,r,i,o,a){var s=0,u=e.length,l=null==n;if("object"===w(n))for(s in i=!0,n)$(e,t,s,n[s],!0,o,a);else if(void 0!==r&&(i=!0,m(r)||(a=!0),l&&(a?(t.call(e,r),t=null):(l=t,t=function(e,t,n){return l.call(S(e),n)})),t))for(;s<u;s++)t(e[s],n,a?r:r.call(e[s],s,t(e[s],n)));return i?e:l?t.call(e):u?t(e[0],n):o},_=/^-ms-/,z=/-([a-z])/g;function U(e,t){return t.toUpperCase()}function X(e){return e.replace(_,"ms-").replace(z,U)}var V=function(e){return 1===e.nodeType||9===e.nodeType||!+e.nodeType};function G(){this.expando=S.expando+G.uid++}G.uid=1,G.prototype={cache:function(e){var t=e[this.expando];return t||(t={},V(e)&&(e.nodeType?e[this.expando]=t:Object.defineProperty(e,this.expando,{value:t,configurable:!0}))),t},set:function(e,t,n){var r,i=this.cache(e);if("string"==typeof t)i[X(t)]=n;else for(r in t)i[X(r)]=t[r];return i},get:function(e,t){return void 0===t?this.cache(e):e[this.expando]&&e[this.expando][X(t)]},access:function(e,t,n){return void 0===t||t&&"string"==typeof t&&void 0===n?this.get(e,t):(this.set(e,t,n),void 0!==n?n:t)},remove:function(e,t){var n,r=e[this.expando];if(void 0!==r){if(void 0!==t){n=(t=Array.isArray(t)?t.map(X):(t=X(t))in r?[t]:t.match(P)||[]).length;while(n--)delete r[t[n]]}(void 0===t||S.isEmptyObject(r))&&(e.nodeType?e[this.expando]=void 0:delete e[this.expando])}},hasData:function(e){var t=e[this.expando];return void 0!==t&&!S.isEmptyObject(t)}};var Y=new G,Q=new G,J=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,K=/[A-Z]/g;function Z(e,t,n){var r,i;if(void 0===n&&1===e.nodeType)if(r="data-"+t.replace(K,"-$&").toLowerCase(),"string"==typeof(n=e.getAttribute(r))){try{n="true"===(i=n)||"false"!==i&&("null"===i?null:i===+i+""?+i:J.test(i)?JSON.parse(i):i)}catch(e){}Q.set(e,t,n)}else n=void 0;return n}S.extend({hasData:function(e){return Q.hasData(e)||Y.hasData(e)},data:function(e,t,n){return Q.access(e,t,n)},removeData:function(e,t){Q.remove(e,t)},_data:function(e,t,n){return Y.access(e,t,n)},_removeData:function(e,t){Y.remove(e,t)}}),S.fn.extend({data:function(n,e){var t,r,i,o=this[0],a=o&&o.attributes;if(void 0===n){if(this.length&&(i=Q.get(o),1===o.nodeType&&!Y.get(o,"hasDataAttrs"))){t=a.length;while(t--)a[t]&&0===(r=a[t].name).indexOf("data-")&&(r=X(r.slice(5)),Z(o,r,i[r]));Y.set(o,"hasDataAttrs",!0)}return i}return"object"==typeof n?this.each(function(){Q.set(this,n)}):$(this,function(e){var t;if(o&&void 0===e)return void 0!==(t=Q.get(o,n))?t:void 0!==(t=Z(o,n))?t:void 0;this.each(function(){Q.set(this,n,e)})},null,e,1<arguments.length,null,!0)},removeData:function(e){return this.each(function(){Q.remove(this,e)})}}),S.extend({queue:function(e,t,n){var r;if(e)return t=(t||"fx")+"queue",r=Y.get(e,t),n&&(!r||Array.isArray(n)?r=Y.access(e,t,S.makeArray(n)):r.push(n)),r||[]},dequeue:function(e,t){t=t||"fx";var n=S.queue(e,t),r=n.length,i=n.shift(),o=S._queueHooks(e,t);"inprogress"===i&&(i=n.shift(),r--),i&&("fx"===t&&n.unshift("inprogress"),delete o.stop,i.call(e,function(){S.dequeue(e,t)},o)),!r&&o&&o.empty.fire()},_queueHooks:function(e,t){var n=t+"queueHooks";return Y.get(e,n)||Y.access(e,n,{empty:S.Callbacks("once memory").add(function(){Y.remove(e,[t+"queue",n])})})}}),S.fn.extend({queue:function(t,n){var e=2;return"string"!=typeof t&&(n=t,t="fx",e--),arguments.length<e?S.queue(this[0],t):void 0===n?this:this.each(function(){var e=S.queue(this,t,n);S._queueHooks(this,t),"fx"===t&&"inprogress"!==e[0]&&S.dequeue(this,t)})},dequeue:function(e){return this.each(function(){S.dequeue(this,e)})},clearQueue:function(e){return this.queue(e||"fx",[])},promise:function(e,t){var n,r=1,i=S.Deferred(),o=this,a=this.length,s=function(){--r||i.resolveWith(o,[o])};"string"!=typeof e&&(t=e,e=void 0),e=e||"fx";while(a--)(n=Y.get(o[a],e+"queueHooks"))&&n.empty&&(r++,n.empty.add(s));return s(),i.promise(t)}});var ee=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,te=new RegExp("^(?:([+-])=|)("+ee+")([a-z%]*)$","i"),ne=["Top","Right","Bottom","Left"],re=E.documentElement,ie=function(e){return S.contains(e.ownerDocument,e)},oe={composed:!0};re.getRootNode&&(ie=function(e){return S.contains(e.ownerDocument,e)||e.getRootNode(oe)===e.ownerDocument});var ae=function(e,t){return"none"===(e=t||e).style.display||""===e.style.display&&ie(e)&&"none"===S.css(e,"display")};function se(e,t,n,r){var i,o,a=20,s=r?function(){return r.cur()}:function(){return S.css(e,t,"")},u=s(),l=n&&n[3]||(S.cssNumber[t]?"":"px"),c=e.nodeType&&(S.cssNumber[t]||"px"!==l&&+u)&&te.exec(S.css(e,t));if(c&&c[3]!==l){u/=2,l=l||c[3],c=+u||1;while(a--)S.style(e,t,c+l),(1-o)*(1-(o=s()/u||.5))<=0&&(a=0),c/=o;c*=2,S.style(e,t,c+l),n=n||[]}return n&&(c=+c||+u||0,i=n[1]?c+(n[1]+1)*n[2]:+n[2],r&&(r.unit=l,r.start=c,r.end=i)),i}var ue={};function le(e,t){for(var n,r,i,o,a,s,u,l=[],c=0,f=e.length;c<f;c++)(r=e[c]).style&&(n=r.style.display,t?("none"===n&&(l[c]=Y.get(r,"display")||null,l[c]||(r.style.display="")),""===r.style.display&&ae(r)&&(l[c]=(u=a=o=void 0,a=(i=r).ownerDocument,s=i.nodeName,(u=ue[s])||(o=a.body.appendChild(a.createElement(s)),u=S.css(o,"display"),o.parentNode.removeChild(o),"none"===u&&(u="block"),ue[s]=u)))):"none"!==n&&(l[c]="none",Y.set(r,"display",n)));for(c=0;c<f;c++)null!=l[c]&&(e[c].style.display=l[c]);return e}S.fn.extend({show:function(){return le(this,!0)},hide:function(){return le(this)},toggle:function(e){return"boolean"==typeof e?e?this.show():this.hide():this.each(function(){ae(this)?S(this).show():S(this).hide()})}});var ce,fe,pe=/^(?:checkbox|radio)$/i,de=/<([a-z][^\/\0>\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="<textarea>x</textarea>",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="<option></option>",y.option=!!ce.lastChild;var ge={thead:[1,"<table>","</table>"],col:[2,"<table><colgroup>","</colgroup></table>"],tr:[2,"<table><tbody>","</tbody></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n<r;n++)Y.set(e[n],"globalEval",!t||Y.get(t[n],"globalEval"))}ge.tbody=ge.tfoot=ge.colgroup=ge.caption=ge.thead,ge.th=ge.td,y.option||(ge.optgroup=ge.option=[1,"<select multiple='multiple'>","</select>"]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d<h;d++)if((o=e[d])||0===o)if("object"===w(o))S.merge(p,o.nodeType?[o]:o);else if(me.test(o)){a=a||f.appendChild(t.createElement("div")),s=(de.exec(o)||["",""])[1].toLowerCase(),u=ge[s]||ge._default,a.innerHTML=u[1]+S.htmlPrefilter(o)+u[2],c=u[0];while(c--)a=a.lastChild;S.merge(p,a.childNodes),(a=f.firstChild).textContent=""}else p.push(t.createTextNode(o));f.textContent="",d=0;while(o=p[d++])if(r&&-1<S.inArray(o,r))i&&i.push(o);else if(l=ie(o),a=ve(f.appendChild(o),"script"),l&&ye(a),n){c=0;while(o=a[c++])he.test(o.type||"")&&n.push(o)}return f}var be=/^key/,we=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Te=/^([^.]*)(?:\.(.+)|)/;function Ce(){return!0}function Ee(){return!1}function Se(e,t){return e===function(){try{return E.activeElement}catch(e){}}()==("focus"===t)}function ke(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)ke(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=Ee;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return S().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=S.guid++)),e.each(function(){S.event.add(this,t,i,r,n)})}function Ae(e,i,o){o?(Y.set(e,i,!1),S.event.add(e,i,{namespace:!1,handler:function(e){var t,n,r=Y.get(this,i);if(1&e.isTrigger&&this[i]){if(r.length)(S.event.special[i]||{}).delegateType&&e.stopPropagation();else if(r=s.call(arguments),Y.set(this,i,r),t=o(this,i),this[i](),r!==(n=Y.get(this,i))||t?Y.set(this,i,!1):n={},r!==n)return e.stopImmediatePropagation(),e.preventDefault(),n.value}else r.length&&(Y.set(this,i,{value:S.event.trigger(S.extend(r[0],S.Event.prototype),r.slice(1),this)}),e.stopImmediatePropagation())}})):void 0===Y.get(e,i)&&S.event.add(e,i,Ce)}S.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Y.get(t);if(V(t)){n.handler&&(n=(o=n).handler,i=o.selector),i&&S.find.matchesSelector(re,i),n.guid||(n.guid=S.guid++),(u=v.events)||(u=v.events=Object.create(null)),(a=v.handle)||(a=v.handle=function(e){return"undefined"!=typeof S&&S.event.triggered!==e.type?S.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(P)||[""]).length;while(l--)d=g=(s=Te.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=S.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=S.event.special[d]||{},c=S.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&S.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),S.event.global[d]=!0)}},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Y.hasData(e)&&Y.get(e);if(v&&(u=v.events)){l=(t=(t||"").match(P)||[""]).length;while(l--)if(d=g=(s=Te.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){f=S.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;while(o--)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||S.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)S.event.remove(e,d+t[l],n,r,!0);S.isEmptyObject(u)&&Y.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=new Array(arguments.length),u=S.event.fix(e),l=(Y.get(this,"events")||Object.create(null))[u.type]||[],c=S.event.special[u.type]||{};for(s[0]=u,t=1;t<arguments.length;t++)s[t]=arguments[t];if(u.delegateTarget=this,!c.preDispatch||!1!==c.preDispatch.call(this,u)){a=S.event.handlers.call(this,u,l),t=0;while((i=a[t++])&&!u.isPropagationStopped()){u.currentTarget=i.elem,n=0;while((o=i.handlers[n++])&&!u.isImmediatePropagationStopped())u.rnamespace&&!1!==o.namespace&&!u.rnamespace.test(o.namespace)||(u.handleObj=o,u.data=o.data,void 0!==(r=((S.event.special[o.origType]||{}).handle||o.handler).apply(i.elem,s))&&!1===(u.result=r)&&(u.preventDefault(),u.stopPropagation()))}return c.postDispatch&&c.postDispatch.call(this,u),u.result}},handlers:function(e,t){var n,r,i,o,a,s=[],u=t.delegateCount,l=e.target;if(u&&l.nodeType&&!("click"===e.type&&1<=e.button))for(;l!==this;l=l.parentNode||this)if(1===l.nodeType&&("click"!==e.type||!0!==l.disabled)){for(o=[],a={},n=0;n<u;n++)void 0===a[i=(r=t[n]).selector+" "]&&(a[i]=r.needsContext?-1<S(i,this).index(l):S.find(i,this,null,[l]).length),a[i]&&o.push(r);o.length&&s.push({elem:l,handlers:o})}return l=this,u<t.length&&s.push({elem:l,handlers:t.slice(u)}),s},addProp:function(t,e){Object.defineProperty(S.Event.prototype,t,{enumerable:!0,configurable:!0,get:m(e)?function(){if(this.originalEvent)return e(this.originalEvent)}:function(){if(this.originalEvent)return this.originalEvent[t]},set:function(e){Object.defineProperty(this,t,{enumerable:!0,configurable:!0,writable:!0,value:e})}})},fix:function(e){return e[S.expando]?e:new S.Event(e)},special:{load:{noBubble:!0},click:{setup:function(e){var t=this||e;return pe.test(t.type)&&t.click&&A(t,"input")&&Ae(t,"click",Ce),!1},trigger:function(e){var t=this||e;return pe.test(t.type)&&t.click&&A(t,"input")&&Ae(t,"click"),!0},_default:function(e){var t=e.target;return pe.test(t.type)&&t.click&&A(t,"input")&&Y.get(t,"click")||A(t,"a")}},beforeunload:{postDispatch:function(e){void 0!==e.result&&e.originalEvent&&(e.originalEvent.returnValue=e.result)}}}},S.removeEvent=function(e,t,n){e.removeEventListener&&e.removeEventListener(t,n)},S.Event=function(e,t){if(!(this instanceof S.Event))return new S.Event(e,t);e&&e.type?(this.originalEvent=e,this.type=e.type,this.isDefaultPrevented=e.defaultPrevented||void 0===e.defaultPrevented&&!1===e.returnValue?Ce:Ee,this.target=e.target&&3===e.target.nodeType?e.target.parentNode:e.target,this.currentTarget=e.currentTarget,this.relatedTarget=e.relatedTarget):this.type=e,t&&S.extend(this,t),this.timeStamp=e&&e.timeStamp||Date.now(),this[S.expando]=!0},S.Event.prototype={constructor:S.Event,isDefaultPrevented:Ee,isPropagationStopped:Ee,isImmediatePropagationStopped:Ee,isSimulated:!1,preventDefault:function(){var e=this.originalEvent;this.isDefaultPrevented=Ce,e&&!this.isSimulated&&e.preventDefault()},stopPropagation:function(){var e=this.originalEvent;this.isPropagationStopped=Ce,e&&!this.isSimulated&&e.stopPropagation()},stopImmediatePropagation:function(){var e=this.originalEvent;this.isImmediatePropagationStopped=Ce,e&&!this.isSimulated&&e.stopImmediatePropagation(),this.stopPropagation()}},S.each({altKey:!0,bubbles:!0,cancelable:!0,changedTouches:!0,ctrlKey:!0,detail:!0,eventPhase:!0,metaKey:!0,pageX:!0,pageY:!0,shiftKey:!0,view:!0,"char":!0,code:!0,charCode:!0,key:!0,keyCode:!0,button:!0,buttons:!0,clientX:!0,clientY:!0,offsetX:!0,offsetY:!0,pointerId:!0,pointerType:!0,screenX:!0,screenY:!0,targetTouches:!0,toElement:!0,touches:!0,which:function(e){var t=e.button;return null==e.which&&be.test(e.type)?null!=e.charCode?e.charCode:e.keyCode:!e.which&&void 0!==t&&we.test(e.type)?1&t?1:2&t?3:4&t?2:0:e.which}},S.event.addProp),S.each({focus:"focusin",blur:"focusout"},function(e,t){S.event.special[e]={setup:function(){return Ae(this,e,Se),!1},trigger:function(){return Ae(this,e),!0},delegateType:t}}),S.each({mouseenter:"mouseover",mouseleave:"mouseout",pointerenter:"pointerover",pointerleave:"pointerout"},function(e,i){S.event.special[e]={delegateType:i,bindType:i,handle:function(e){var t,n=e.relatedTarget,r=e.handleObj;return n&&(n===this||S.contains(this,n))||(e.type=r.origType,t=r.handler.apply(this,arguments),e.type=i),t}}}),S.fn.extend({on:function(e,t,n,r){return ke(this,e,t,n,r)},one:function(e,t,n,r){return ke(this,e,t,n,r,1)},off:function(e,t,n){var r,i;if(e&&e.preventDefault&&e.handleObj)return r=e.handleObj,S(e.delegateTarget).off(r.namespace?r.origType+"."+r.namespace:r.origType,r.selector,r.handler),this;if("object"==typeof e){for(i in e)this.off(i,t,e[i]);return this}return!1!==t&&"function"!=typeof t||(n=t,t=void 0),!1===n&&(n=Ee),this.each(function(){S.event.remove(this,e,n,t)})}});var Ne=/<script|<style|<link/i,De=/checked\s*(?:[^=]|=\s*.checked.)/i,je=/^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g;function qe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function Le(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function He(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Oe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n<r;n++)S.event.add(t,i,s[i][n]);Q.hasData(e)&&(o=Q.access(e),a=S.extend({},o),Q.set(t,a))}}function Pe(n,r,i,o){r=g(r);var e,t,a,s,u,l,c=0,f=n.length,p=f-1,d=r[0],h=m(d);if(h||1<f&&"string"==typeof d&&!y.checkClone&&De.test(d))return n.each(function(e){var t=n.eq(e);h&&(r[0]=d.call(this,e,t.html())),Pe(t,r,i,o)});if(f&&(t=(e=xe(r,n[0].ownerDocument,!1,n,o)).firstChild,1===e.childNodes.length&&(e=t),t||o)){for(s=(a=S.map(ve(e,"script"),Le)).length;c<f;c++)u=e,c!==p&&(u=S.clone(u,!0,!0),s&&S.merge(a,ve(u,"script"))),i.call(n[c],u,c);if(s)for(l=a[a.length-1].ownerDocument,S.map(a,He),c=0;c<s;c++)u=a[c],he.test(u.type||"")&&!Y.access(u,"globalEval")&&S.contains(l,u)&&(u.src&&"module"!==(u.type||"").toLowerCase()?S._evalUrl&&!u.noModule&&S._evalUrl(u.src,{nonce:u.nonce||u.getAttribute("nonce")},l):b(u.textContent.replace(je,""),u,l))}return n}function Re(e,t,n){for(var r,i=t?S.filter(t,e):e,o=0;null!=(r=i[o]);o++)n||1!==r.nodeType||S.cleanData(ve(r)),r.parentNode&&(n&&ie(r)&&ye(ve(r,"script")),r.parentNode.removeChild(r));return e}S.extend({htmlPrefilter:function(e){return e},clone:function(e,t,n){var r,i,o,a,s,u,l,c=e.cloneNode(!0),f=ie(e);if(!(y.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||S.isXMLDoc(e)))for(a=ve(c),r=0,i=(o=ve(e)).length;r<i;r++)s=o[r],u=a[r],void 0,"input"===(l=u.nodeName.toLowerCase())&&pe.test(s.type)?u.checked=s.checked:"input"!==l&&"textarea"!==l||(u.defaultValue=s.defaultValue);if(t)if(n)for(o=o||ve(e),a=a||ve(c),r=0,i=o.length;r<i;r++)Oe(o[r],a[r]);else Oe(e,c);return 0<(a=ve(c,"script")).length&&ye(a,!f&&ve(e,"script")),c},cleanData:function(e){for(var t,n,r,i=S.event.special,o=0;void 0!==(n=e[o]);o++)if(V(n)){if(t=n[Y.expando]){if(t.events)for(r in t.events)i[r]?S.event.remove(n,r):S.removeEvent(n,r,t.handle);n[Y.expando]=void 0}n[Q.expando]&&(n[Q.expando]=void 0)}}}),S.fn.extend({detach:function(e){return Re(this,e,!0)},remove:function(e){return Re(this,e)},text:function(e){return $(this,function(e){return void 0===e?S.text(this):this.empty().each(function(){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||(this.textContent=e)})},null,e,arguments.length)},append:function(){return Pe(this,arguments,function(e){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||qe(this,e).appendChild(e)})},prepend:function(){return Pe(this,arguments,function(e){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var t=qe(this,e);t.insertBefore(e,t.firstChild)}})},before:function(){return Pe(this,arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this)})},after:function(){return Pe(this,arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this.nextSibling)})},empty:function(){for(var e,t=0;null!=(e=this[t]);t++)1===e.nodeType&&(S.cleanData(ve(e,!1)),e.textContent="");return this},clone:function(e,t){return e=null!=e&&e,t=null==t?e:t,this.map(function(){return S.clone(this,e,t)})},html:function(e){return $(this,function(e){var t=this[0]||{},n=0,r=this.length;if(void 0===e&&1===t.nodeType)return t.innerHTML;if("string"==typeof e&&!Ne.test(e)&&!ge[(de.exec(e)||["",""])[1].toLowerCase()]){e=S.htmlPrefilter(e);try{for(;n<r;n++)1===(t=this[n]||{}).nodeType&&(S.cleanData(ve(t,!1)),t.innerHTML=e);t=0}catch(e){}}t&&this.empty().append(e)},null,e,arguments.length)},replaceWith:function(){var n=[];return Pe(this,arguments,function(e){var t=this.parentNode;S.inArray(this,n)<0&&(S.cleanData(ve(this)),t&&t.replaceChild(e,this))},n)}}),S.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(e,a){S.fn[e]=function(e){for(var t,n=[],r=S(e),i=r.length-1,o=0;o<=i;o++)t=o===i?this:this.clone(!0),S(r[o])[a](t),u.apply(n,t.get());return this.pushStack(n)}});var Me=new RegExp("^("+ee+")(?!px)[a-z%]+$","i"),Ie=function(e){var t=e.ownerDocument.defaultView;return t&&t.opener||(t=C),t.getComputedStyle(e)},We=function(e,t,n){var r,i,o={};for(i in t)o[i]=e.style[i],e.style[i]=t[i];for(i in r=n.call(e),t)e.style[i]=o[i];return r},Fe=new RegExp(ne.join("|"),"i");function Be(e,t,n){var r,i,o,a,s=e.style;return(n=n||Ie(e))&&(""!==(a=n.getPropertyValue(t)||n[t])||ie(e)||(a=S.style(e,t)),!y.pixelBoxStyles()&&Me.test(a)&&Fe.test(t)&&(r=s.width,i=s.minWidth,o=s.maxWidth,s.minWidth=s.maxWidth=s.width=a,a=n.width,s.width=r,s.minWidth=i,s.maxWidth=o)),void 0!==a?a+"":a}function $e(e,t){return{get:function(){if(!e())return(this.get=t).apply(this,arguments);delete this.get}}}!function(){function e(){if(l){u.style.cssText="position:absolute;left:-11111px;width:60px;margin-top:1px;padding:0;border:0",l.style.cssText="position:relative;display:block;box-sizing:border-box;overflow:scroll;margin:auto;border:1px;padding:1px;width:60%;top:1%",re.appendChild(u).appendChild(l);var e=C.getComputedStyle(l);n="1%"!==e.top,s=12===t(e.marginLeft),l.style.right="60%",o=36===t(e.right),r=36===t(e.width),l.style.position="absolute",i=12===t(l.offsetWidth/3),re.removeChild(u),l=null}}function t(e){return Math.round(parseFloat(e))}var n,r,i,o,a,s,u=E.createElement("div"),l=E.createElement("div");l.style&&(l.style.backgroundClip="content-box",l.cloneNode(!0).style.backgroundClip="",y.clearCloneStyle="content-box"===l.style.backgroundClip,S.extend(y,{boxSizingReliable:function(){return e(),r},pixelBoxStyles:function(){return e(),o},pixelPosition:function(){return e(),n},reliableMarginLeft:function(){return e(),s},scrollboxSize:function(){return e(),i},reliableTrDimensions:function(){var e,t,n,r;return null==a&&(e=E.createElement("table"),t=E.createElement("tr"),n=E.createElement("div"),e.style.cssText="position:absolute;left:-11111px",t.style.height="1px",n.style.height="9px",re.appendChild(e).appendChild(t).appendChild(n),r=C.getComputedStyle(t),a=3<parseInt(r.height),re.removeChild(e)),a}}))}();var _e=["Webkit","Moz","ms"],ze=E.createElement("div").style,Ue={};function Xe(e){var t=S.cssProps[e]||Ue[e];return t||(e in ze?e:Ue[e]=function(e){var t=e[0].toUpperCase()+e.slice(1),n=_e.length;while(n--)if((e=_e[n]+t)in ze)return e}(e)||e)}var Ve=/^(none|table(?!-c[ea]).+)/,Ge=/^--/,Ye={position:"absolute",visibility:"hidden",display:"block"},Qe={letterSpacing:"0",fontWeight:"400"};function Je(e,t,n){var r=te.exec(t);return r?Math.max(0,r[2]-(n||0))+(r[3]||"px"):t}function Ke(e,t,n,r,i,o){var a="width"===t?1:0,s=0,u=0;if(n===(r?"border":"content"))return 0;for(;a<4;a+=2)"margin"===n&&(u+=S.css(e,n+ne[a],!0,i)),r?("content"===n&&(u-=S.css(e,"padding"+ne[a],!0,i)),"margin"!==n&&(u-=S.css(e,"border"+ne[a]+"Width",!0,i))):(u+=S.css(e,"padding"+ne[a],!0,i),"padding"!==n?u+=S.css(e,"border"+ne[a]+"Width",!0,i):s+=S.css(e,"border"+ne[a]+"Width",!0,i));return!r&&0<=o&&(u+=Math.max(0,Math.ceil(e["offset"+t[0].toUpperCase()+t.slice(1)]-o-u-s-.5))||0),u}function Ze(e,t,n){var r=Ie(e),i=(!y.boxSizingReliable()||n)&&"border-box"===S.css(e,"boxSizing",!1,r),o=i,a=Be(e,t,r),s="offset"+t[0].toUpperCase()+t.slice(1);if(Me.test(a)){if(!n)return a;a="auto"}return(!y.boxSizingReliable()&&i||!y.reliableTrDimensions()&&A(e,"tr")||"auto"===a||!parseFloat(a)&&"inline"===S.css(e,"display",!1,r))&&e.getClientRects().length&&(i="border-box"===S.css(e,"boxSizing",!1,r),(o=s in e)&&(a=e[s])),(a=parseFloat(a)||0)+Ke(e,t,n||(i?"border":"content"),o,r,a)+"px"}function et(e,t,n,r,i){return new et.prototype.init(e,t,n,r,i)}S.extend({cssHooks:{opacity:{get:function(e,t){if(t){var n=Be(e,"opacity");return""===n?"1":n}}}},cssNumber:{animationIterationCount:!0,columnCount:!0,fillOpacity:!0,flexGrow:!0,flexShrink:!0,fontWeight:!0,gridArea:!0,gridColumn:!0,gridColumnEnd:!0,gridColumnStart:!0,gridRow:!0,gridRowEnd:!0,gridRowStart:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{},style:function(e,t,n,r){if(e&&3!==e.nodeType&&8!==e.nodeType&&e.style){var i,o,a,s=X(t),u=Ge.test(t),l=e.style;if(u||(t=Xe(s)),a=S.cssHooks[t]||S.cssHooks[s],void 0===n)return a&&"get"in a&&void 0!==(i=a.get(e,!1,r))?i:l[t];"string"===(o=typeof n)&&(i=te.exec(n))&&i[1]&&(n=se(e,t,i),o="number"),null!=n&&n==n&&("number"!==o||u||(n+=i&&i[3]||(S.cssNumber[s]?"":"px")),y.clearCloneStyle||""!==n||0!==t.indexOf("background")||(l[t]="inherit"),a&&"set"in a&&void 0===(n=a.set(e,n,r))||(u?l.setProperty(t,n):l[t]=n))}},css:function(e,t,n,r){var i,o,a,s=X(t);return Ge.test(t)||(t=Xe(s)),(a=S.cssHooks[t]||S.cssHooks[s])&&"get"in a&&(i=a.get(e,!0,n)),void 0===i&&(i=Be(e,t,r)),"normal"===i&&t in Qe&&(i=Qe[t]),""===n||n?(o=parseFloat(i),!0===n||isFinite(o)?o||0:i):i}}),S.each(["height","width"],function(e,u){S.cssHooks[u]={get:function(e,t,n){if(t)return!Ve.test(S.css(e,"display"))||e.getClientRects().length&&e.getBoundingClientRect().width?Ze(e,u,n):We(e,Ye,function(){return Ze(e,u,n)})},set:function(e,t,n){var r,i=Ie(e),o=!y.scrollboxSize()&&"absolute"===i.position,a=(o||n)&&"border-box"===S.css(e,"boxSizing",!1,i),s=n?Ke(e,u,n,a,i):0;return a&&o&&(s-=Math.ceil(e["offset"+u[0].toUpperCase()+u.slice(1)]-parseFloat(i[u])-Ke(e,u,"border",!1,i)-.5)),s&&(r=te.exec(t))&&"px"!==(r[3]||"px")&&(e.style[u]=t,t=S.css(e,u)),Je(0,t,s)}}}),S.cssHooks.marginLeft=$e(y.reliableMarginLeft,function(e,t){if(t)return(parseFloat(Be(e,"marginLeft"))||e.getBoundingClientRect().left-We(e,{marginLeft:0},function(){return e.getBoundingClientRect().left}))+"px"}),S.each({margin:"",padding:"",border:"Width"},function(i,o){S.cssHooks[i+o]={expand:function(e){for(var t=0,n={},r="string"==typeof e?e.split(" "):[e];t<4;t++)n[i+ne[t]+o]=r[t]||r[t-2]||r[0];return n}},"margin"!==i&&(S.cssHooks[i+o].set=Je)}),S.fn.extend({css:function(e,t){return $(this,function(e,t,n){var r,i,o={},a=0;if(Array.isArray(t)){for(r=Ie(e),i=t.length;a<i;a++)o[t[a]]=S.css(e,t[a],!1,r);return o}return void 0!==n?S.style(e,t,n):S.css(e,t)},e,t,1<arguments.length)}}),((S.Tween=et).prototype={constructor:et,init:function(e,t,n,r,i,o){this.elem=e,this.prop=n,this.easing=i||S.easing._default,this.options=t,this.start=this.now=this.cur(),this.end=r,this.unit=o||(S.cssNumber[n]?"":"px")},cur:function(){var e=et.propHooks[this.prop];return e&&e.get?e.get(this):et.propHooks._default.get(this)},run:function(e){var t,n=et.propHooks[this.prop];return this.options.duration?this.pos=t=S.easing[this.easing](e,this.options.duration*e,0,1,this.options.duration):this.pos=t=e,this.now=(this.end-this.start)*t+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),n&&n.set?n.set(this):et.propHooks._default.set(this),this}}).init.prototype=et.prototype,(et.propHooks={_default:{get:function(e){var t;return 1!==e.elem.nodeType||null!=e.elem[e.prop]&&null==e.elem.style[e.prop]?e.elem[e.prop]:(t=S.css(e.elem,e.prop,""))&&"auto"!==t?t:0},set:function(e){S.fx.step[e.prop]?S.fx.step[e.prop](e):1!==e.elem.nodeType||!S.cssHooks[e.prop]&&null==e.elem.style[Xe(e.prop)]?e.elem[e.prop]=e.now:S.style(e.elem,e.prop,e.now+e.unit)}}}).scrollTop=et.propHooks.scrollLeft={set:function(e){e.elem.nodeType&&e.elem.parentNode&&(e.elem[e.prop]=e.now)}},S.easing={linear:function(e){return e},swing:function(e){return.5-Math.cos(e*Math.PI)/2},_default:"swing"},S.fx=et.prototype.init,S.fx.step={};var tt,nt,rt,it,ot=/^(?:toggle|show|hide)$/,at=/queueHooks$/;function st(){nt&&(!1===E.hidden&&C.requestAnimationFrame?C.requestAnimationFrame(st):C.setTimeout(st,S.fx.interval),S.fx.tick())}function ut(){return C.setTimeout(function(){tt=void 0}),tt=Date.now()}function lt(e,t){var n,r=0,i={height:e};for(t=t?1:0;r<4;r+=2-t)i["margin"+(n=ne[r])]=i["padding"+n]=e;return t&&(i.opacity=i.width=e),i}function ct(e,t,n){for(var r,i=(ft.tweeners[t]||[]).concat(ft.tweeners["*"]),o=0,a=i.length;o<a;o++)if(r=i[o].call(n,t,e))return r}function ft(o,e,t){var n,a,r=0,i=ft.prefilters.length,s=S.Deferred().always(function(){delete u.elem}),u=function(){if(a)return!1;for(var e=tt||ut(),t=Math.max(0,l.startTime+l.duration-e),n=1-(t/l.duration||0),r=0,i=l.tweens.length;r<i;r++)l.tweens[r].run(n);return s.notifyWith(o,[l,n,t]),n<1&&i?t:(i||s.notifyWith(o,[l,1,0]),s.resolveWith(o,[l]),!1)},l=s.promise({elem:o,props:S.extend({},e),opts:S.extend(!0,{specialEasing:{},easing:S.easing._default},t),originalProperties:e,originalOptions:t,startTime:tt||ut(),duration:t.duration,tweens:[],createTween:function(e,t){var n=S.Tween(o,l.opts,e,t,l.opts.specialEasing[e]||l.opts.easing);return l.tweens.push(n),n},stop:function(e){var t=0,n=e?l.tweens.length:0;if(a)return this;for(a=!0;t<n;t++)l.tweens[t].run(1);return e?(s.notifyWith(o,[l,1,0]),s.resolveWith(o,[l,e])):s.rejectWith(o,[l,e]),this}}),c=l.props;for(!function(e,t){var n,r,i,o,a;for(n in e)if(i=t[r=X(n)],o=e[n],Array.isArray(o)&&(i=o[1],o=e[n]=o[0]),n!==r&&(e[r]=o,delete e[n]),(a=S.cssHooks[r])&&"expand"in a)for(n in o=a.expand(o),delete e[r],o)n in e||(e[n]=o[n],t[n]=i);else t[r]=i}(c,l.opts.specialEasing);r<i;r++)if(n=ft.prefilters[r].call(l,o,c,l.opts))return m(n.stop)&&(S._queueHooks(l.elem,l.opts.queue).stop=n.stop.bind(n)),n;return S.map(c,ct,l),m(l.opts.start)&&l.opts.start.call(o,l),l.progress(l.opts.progress).done(l.opts.done,l.opts.complete).fail(l.opts.fail).always(l.opts.always),S.fx.timer(S.extend(u,{elem:o,anim:l,queue:l.opts.queue})),l}S.Animation=S.extend(ft,{tweeners:{"*":[function(e,t){var n=this.createTween(e,t);return se(n.elem,e,te.exec(t),n),n}]},tweener:function(e,t){m(e)?(t=e,e=["*"]):e=e.match(P);for(var n,r=0,i=e.length;r<i;r++)n=e[r],ft.tweeners[n]=ft.tweeners[n]||[],ft.tweeners[n].unshift(t)},prefilters:[function(e,t,n){var r,i,o,a,s,u,l,c,f="width"in t||"height"in t,p=this,d={},h=e.style,g=e.nodeType&&ae(e),v=Y.get(e,"fxshow");for(r in n.queue||(null==(a=S._queueHooks(e,"fx")).unqueued&&(a.unqueued=0,s=a.empty.fire,a.empty.fire=function(){a.unqueued||s()}),a.unqueued++,p.always(function(){p.always(function(){a.unqueued--,S.queue(e,"fx").length||a.empty.fire()})})),t)if(i=t[r],ot.test(i)){if(delete t[r],o=o||"toggle"===i,i===(g?"hide":"show")){if("show"!==i||!v||void 0===v[r])continue;g=!0}d[r]=v&&v[r]||S.style(e,r)}if((u=!S.isEmptyObject(t))||!S.isEmptyObject(d))for(r in f&&1===e.nodeType&&(n.overflow=[h.overflow,h.overflowX,h.overflowY],null==(l=v&&v.display)&&(l=Y.get(e,"display")),"none"===(c=S.css(e,"display"))&&(l?c=l:(le([e],!0),l=e.style.display||l,c=S.css(e,"display"),le([e]))),("inline"===c||"inline-block"===c&&null!=l)&&"none"===S.css(e,"float")&&(u||(p.done(function(){h.display=l}),null==l&&(c=h.display,l="none"===c?"":c)),h.display="inline-block")),n.overflow&&(h.overflow="hidden",p.always(function(){h.overflow=n.overflow[0],h.overflowX=n.overflow[1],h.overflowY=n.overflow[2]})),u=!1,d)u||(v?"hidden"in v&&(g=v.hidden):v=Y.access(e,"fxshow",{display:l}),o&&(v.hidden=!g),g&&le([e],!0),p.done(function(){for(r in g||le([e]),Y.remove(e,"fxshow"),d)S.style(e,r,d[r])})),u=ct(g?v[r]:0,r,p),r in v||(v[r]=u.start,g&&(u.end=u.start,u.start=0))}],prefilter:function(e,t){t?ft.prefilters.unshift(e):ft.prefilters.push(e)}}),S.speed=function(e,t,n){var r=e&&"object"==typeof e?S.extend({},e):{complete:n||!n&&t||m(e)&&e,duration:e,easing:n&&t||t&&!m(t)&&t};return S.fx.off?r.duration=0:"number"!=typeof r.duration&&(r.duration in S.fx.speeds?r.duration=S.fx.speeds[r.duration]:r.duration=S.fx.speeds._default),null!=r.queue&&!0!==r.queue||(r.queue="fx"),r.old=r.complete,r.complete=function(){m(r.old)&&r.old.call(this),r.queue&&S.dequeue(this,r.queue)},r},S.fn.extend({fadeTo:function(e,t,n,r){return this.filter(ae).css("opacity",0).show().end().animate({opacity:t},e,n,r)},animate:function(t,e,n,r){var i=S.isEmptyObject(t),o=S.speed(e,n,r),a=function(){var e=ft(this,S.extend({},t),o);(i||Y.get(this,"finish"))&&e.stop(!0)};return a.finish=a,i||!1===o.queue?this.each(a):this.queue(o.queue,a)},stop:function(i,e,o){var a=function(e){var t=e.stop;delete e.stop,t(o)};return"string"!=typeof i&&(o=e,e=i,i=void 0),e&&this.queue(i||"fx",[]),this.each(function(){var e=!0,t=null!=i&&i+"queueHooks",n=S.timers,r=Y.get(this);if(t)r[t]&&r[t].stop&&a(r[t]);else for(t in r)r[t]&&r[t].stop&&at.test(t)&&a(r[t]);for(t=n.length;t--;)n[t].elem!==this||null!=i&&n[t].queue!==i||(n[t].anim.stop(o),e=!1,n.splice(t,1));!e&&o||S.dequeue(this,i)})},finish:function(a){return!1!==a&&(a=a||"fx"),this.each(function(){var e,t=Y.get(this),n=t[a+"queue"],r=t[a+"queueHooks"],i=S.timers,o=n?n.length:0;for(t.finish=!0,S.queue(this,a,[]),r&&r.stop&&r.stop.call(this,!0),e=i.length;e--;)i[e].elem===this&&i[e].queue===a&&(i[e].anim.stop(!0),i.splice(e,1));for(e=0;e<o;e++)n[e]&&n[e].finish&&n[e].finish.call(this);delete t.finish})}}),S.each(["toggle","show","hide"],function(e,r){var i=S.fn[r];S.fn[r]=function(e,t,n){return null==e||"boolean"==typeof e?i.apply(this,arguments):this.animate(lt(r,!0),e,t,n)}}),S.each({slideDown:lt("show"),slideUp:lt("hide"),slideToggle:lt("toggle"),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(e,r){S.fn[e]=function(e,t,n){return this.animate(r,e,t,n)}}),S.timers=[],S.fx.tick=function(){var e,t=0,n=S.timers;for(tt=Date.now();t<n.length;t++)(e=n[t])()||n[t]!==e||n.splice(t--,1);n.length||S.fx.stop(),tt=void 0},S.fx.timer=function(e){S.timers.push(e),S.fx.start()},S.fx.interval=13,S.fx.start=function(){nt||(nt=!0,st())},S.fx.stop=function(){nt=null},S.fx.speeds={slow:600,fast:200,_default:400},S.fn.delay=function(r,e){return r=S.fx&&S.fx.speeds[r]||r,e=e||"fx",this.queue(e,function(e,t){var n=C.setTimeout(e,r);t.stop=function(){C.clearTimeout(n)}})},rt=E.createElement("input"),it=E.createElement("select").appendChild(E.createElement("option")),rt.type="checkbox",y.checkOn=""!==rt.value,y.optSelected=it.selected,(rt=E.createElement("input")).value="t",rt.type="radio",y.radioValue="t"===rt.value;var pt,dt=S.expr.attrHandle;S.fn.extend({attr:function(e,t){return $(this,S.attr,e,t,1<arguments.length)},removeAttr:function(e){return this.each(function(){S.removeAttr(this,e)})}}),S.extend({attr:function(e,t,n){var r,i,o=e.nodeType;if(3!==o&&8!==o&&2!==o)return"undefined"==typeof e.getAttribute?S.prop(e,t,n):(1===o&&S.isXMLDoc(e)||(i=S.attrHooks[t.toLowerCase()]||(S.expr.match.bool.test(t)?pt:void 0)),void 0!==n?null===n?void S.removeAttr(e,t):i&&"set"in i&&void 0!==(r=i.set(e,n,t))?r:(e.setAttribute(t,n+""),n):i&&"get"in i&&null!==(r=i.get(e,t))?r:null==(r=S.find.attr(e,t))?void 0:r)},attrHooks:{type:{set:function(e,t){if(!y.radioValue&&"radio"===t&&A(e,"input")){var n=e.value;return e.setAttribute("type",t),n&&(e.value=n),t}}}},removeAttr:function(e,t){var n,r=0,i=t&&t.match(P);if(i&&1===e.nodeType)while(n=i[r++])e.removeAttribute(n)}}),pt={set:function(e,t,n){return!1===t?S.removeAttr(e,n):e.setAttribute(n,n),n}},S.each(S.expr.match.bool.source.match(/\w+/g),function(e,t){var a=dt[t]||S.find.attr;dt[t]=function(e,t,n){var r,i,o=t.toLowerCase();return n||(i=dt[o],dt[o]=r,r=null!=a(e,t,n)?o:null,dt[o]=i),r}});var ht=/^(?:input|select|textarea|button)$/i,gt=/^(?:a|area)$/i;function vt(e){return(e.match(P)||[]).join(" ")}function yt(e){return e.getAttribute&&e.getAttribute("class")||""}function mt(e){return Array.isArray(e)?e:"string"==typeof e&&e.match(P)||[]}S.fn.extend({prop:function(e,t){return $(this,S.prop,e,t,1<arguments.length)},removeProp:function(e){return this.each(function(){delete this[S.propFix[e]||e]})}}),S.extend({prop:function(e,t,n){var r,i,o=e.nodeType;if(3!==o&&8!==o&&2!==o)return 1===o&&S.isXMLDoc(e)||(t=S.propFix[t]||t,i=S.propHooks[t]),void 0!==n?i&&"set"in i&&void 0!==(r=i.set(e,n,t))?r:e[t]=n:i&&"get"in i&&null!==(r=i.get(e,t))?r:e[t]},propHooks:{tabIndex:{get:function(e){var t=S.find.attr(e,"tabindex");return t?parseInt(t,10):ht.test(e.nodeName)||gt.test(e.nodeName)&&e.href?0:-1}}},propFix:{"for":"htmlFor","class":"className"}}),y.optSelected||(S.propHooks.selected={get:function(e){var t=e.parentNode;return t&&t.parentNode&&t.parentNode.selectedIndex,null},set:function(e){var t=e.parentNode;t&&(t.selectedIndex,t.parentNode&&t.parentNode.selectedIndex)}}),S.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){S.propFix[this.toLowerCase()]=this}),S.fn.extend({addClass:function(t){var e,n,r,i,o,a,s,u=0;if(m(t))return this.each(function(e){S(this).addClass(t.call(this,e,yt(this)))});if((e=mt(t)).length)while(n=this[u++])if(i=yt(n),r=1===n.nodeType&&" "+vt(i)+" "){a=0;while(o=e[a++])r.indexOf(" "+o+" ")<0&&(r+=o+" ");i!==(s=vt(r))&&n.setAttribute("class",s)}return this},removeClass:function(t){var e,n,r,i,o,a,s,u=0;if(m(t))return this.each(function(e){S(this).removeClass(t.call(this,e,yt(this)))});if(!arguments.length)return this.attr("class","");if((e=mt(t)).length)while(n=this[u++])if(i=yt(n),r=1===n.nodeType&&" "+vt(i)+" "){a=0;while(o=e[a++])while(-1<r.indexOf(" "+o+" "))r=r.replace(" "+o+" "," ");i!==(s=vt(r))&&n.setAttribute("class",s)}return this},toggleClass:function(i,t){var o=typeof i,a="string"===o||Array.isArray(i);return"boolean"==typeof t&&a?t?this.addClass(i):this.removeClass(i):m(i)?this.each(function(e){S(this).toggleClass(i.call(this,e,yt(this),t),t)}):this.each(function(){var e,t,n,r;if(a){t=0,n=S(this),r=mt(i);while(e=r[t++])n.hasClass(e)?n.removeClass(e):n.addClass(e)}else void 0!==i&&"boolean"!==o||((e=yt(this))&&Y.set(this,"__className__",e),this.setAttribute&&this.setAttribute("class",e||!1===i?"":Y.get(this,"__className__")||""))})},hasClass:function(e){var t,n,r=0;t=" "+e+" ";while(n=this[r++])if(1===n.nodeType&&-1<(" "+vt(yt(n))+" ").indexOf(t))return!0;return!1}});var xt=/\r/g;S.fn.extend({val:function(n){var r,e,i,t=this[0];return arguments.length?(i=m(n),this.each(function(e){var t;1===this.nodeType&&(null==(t=i?n.call(this,e,S(this).val()):n)?t="":"number"==typeof t?t+="":Array.isArray(t)&&(t=S.map(t,function(e){return null==e?"":e+""})),(r=S.valHooks[this.type]||S.valHooks[this.nodeName.toLowerCase()])&&"set"in r&&void 0!==r.set(this,t,"value")||(this.value=t))})):t?(r=S.valHooks[t.type]||S.valHooks[t.nodeName.toLowerCase()])&&"get"in r&&void 0!==(e=r.get(t,"value"))?e:"string"==typeof(e=t.value)?e.replace(xt,""):null==e?"":e:void 0}}),S.extend({valHooks:{option:{get:function(e){var t=S.find.attr(e,"value");return null!=t?t:vt(S.text(e))}},select:{get:function(e){var t,n,r,i=e.options,o=e.selectedIndex,a="select-one"===e.type,s=a?null:[],u=a?o+1:i.length;for(r=o<0?u:a?o:0;r<u;r++)if(((n=i[r]).selected||r===o)&&!n.disabled&&(!n.parentNode.disabled||!A(n.parentNode,"optgroup"))){if(t=S(n).val(),a)return t;s.push(t)}return s},set:function(e,t){var n,r,i=e.options,o=S.makeArray(t),a=i.length;while(a--)((r=i[a]).selected=-1<S.inArray(S.valHooks.option.get(r),o))&&(n=!0);return n||(e.selectedIndex=-1),o}}}}),S.each(["radio","checkbox"],function(){S.valHooks[this]={set:function(e,t){if(Array.isArray(t))return e.checked=-1<S.inArray(S(e).val(),t)}},y.checkOn||(S.valHooks[this].get=function(e){return null===e.getAttribute("value")?"on":e.value})}),y.focusin="onfocusin"in C;var bt=/^(?:focusinfocus|focusoutblur)$/,wt=function(e){e.stopPropagation()};S.extend(S.event,{trigger:function(e,t,n,r){var i,o,a,s,u,l,c,f,p=[n||E],d=v.call(e,"type")?e.type:e,h=v.call(e,"namespace")?e.namespace.split("."):[];if(o=f=a=n=n||E,3!==n.nodeType&&8!==n.nodeType&&!bt.test(d+S.event.triggered)&&(-1<d.indexOf(".")&&(d=(h=d.split(".")).shift(),h.sort()),u=d.indexOf(":")<0&&"on"+d,(e=e[S.expando]?e:new S.Event(d,"object"==typeof e&&e)).isTrigger=r?2:3,e.namespace=h.join("."),e.rnamespace=e.namespace?new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,e.result=void 0,e.target||(e.target=n),t=null==t?[e]:S.makeArray(t,[e]),c=S.event.special[d]||{},r||!c.trigger||!1!==c.trigger.apply(n,t))){if(!r&&!c.noBubble&&!x(n)){for(s=c.delegateType||d,bt.test(s+d)||(o=o.parentNode);o;o=o.parentNode)p.push(o),a=o;a===(n.ownerDocument||E)&&p.push(a.defaultView||a.parentWindow||C)}i=0;while((o=p[i++])&&!e.isPropagationStopped())f=o,e.type=1<i?s:c.bindType||d,(l=(Y.get(o,"events")||Object.create(null))[e.type]&&Y.get(o,"handle"))&&l.apply(o,t),(l=u&&o[u])&&l.apply&&V(o)&&(e.result=l.apply(o,t),!1===e.result&&e.preventDefault());return e.type=d,r||e.isDefaultPrevented()||c._default&&!1!==c._default.apply(p.pop(),t)||!V(n)||u&&m(n[d])&&!x(n)&&((a=n[u])&&(n[u]=null),S.event.triggered=d,e.isPropagationStopped()&&f.addEventListener(d,wt),n[d](),e.isPropagationStopped()&&f.removeEventListener(d,wt),S.event.triggered=void 0,a&&(n[u]=a)),e.result}},simulate:function(e,t,n){var r=S.extend(new S.Event,n,{type:e,isSimulated:!0});S.event.trigger(r,null,t)}}),S.fn.extend({trigger:function(e,t){return this.each(function(){S.event.trigger(e,t,this)})},triggerHandler:function(e,t){var n=this[0];if(n)return S.event.trigger(e,t,n,!0)}}),y.focusin||S.each({focus:"focusin",blur:"focusout"},function(n,r){var i=function(e){S.event.simulate(r,e.target,S.event.fix(e))};S.event.special[r]={setup:function(){var e=this.ownerDocument||this.document||this,t=Y.access(e,r);t||e.addEventListener(n,i,!0),Y.access(e,r,(t||0)+1)},teardown:function(){var e=this.ownerDocument||this.document||this,t=Y.access(e,r)-1;t?Y.access(e,r,t):(e.removeEventListener(n,i,!0),Y.remove(e,r))}}});var Tt=C.location,Ct={guid:Date.now()},Et=/\?/;S.parseXML=function(e){var t;if(!e||"string"!=typeof e)return null;try{t=(new C.DOMParser).parseFromString(e,"text/xml")}catch(e){t=void 0}return t&&!t.getElementsByTagName("parsererror").length||S.error("Invalid XML: "+e),t};var St=/\[\]$/,kt=/\r?\n/g,At=/^(?:submit|button|image|reset|file)$/i,Nt=/^(?:input|select|textarea|keygen)/i;function Dt(n,e,r,i){var t;if(Array.isArray(e))S.each(e,function(e,t){r||St.test(n)?i(n,t):Dt(n+"["+("object"==typeof t&&null!=t?e:"")+"]",t,r,i)});else if(r||"object"!==w(e))i(n,e);else for(t in e)Dt(n+"["+t+"]",e[t],r,i)}S.param=function(e,t){var n,r=[],i=function(e,t){var n=m(t)?t():t;r[r.length]=encodeURIComponent(e)+"="+encodeURIComponent(null==n?"":n)};if(null==e)return"";if(Array.isArray(e)||e.jquery&&!S.isPlainObject(e))S.each(e,function(){i(this.name,this.value)});else for(n in e)Dt(n,e[n],t,i);return r.join("&")},S.fn.extend({serialize:function(){return S.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var e=S.prop(this,"elements");return e?S.makeArray(e):this}).filter(function(){var e=this.type;return this.name&&!S(this).is(":disabled")&&Nt.test(this.nodeName)&&!At.test(e)&&(this.checked||!pe.test(e))}).map(function(e,t){var n=S(this).val();return null==n?null:Array.isArray(n)?S.map(n,function(e){return{name:t.name,value:e.replace(kt,"\r\n")}}):{name:t.name,value:n.replace(kt,"\r\n")}}).get()}});var jt=/%20/g,qt=/#.*$/,Lt=/([?&])_=[^&]*/,Ht=/^(.*?):[ \t]*([^\r\n]*)$/gm,Ot=/^(?:GET|HEAD)$/,Pt=/^\/\//,Rt={},Mt={},It="*/".concat("*"),Wt=E.createElement("a");function Ft(o){return function(e,t){"string"!=typeof e&&(t=e,e="*");var n,r=0,i=e.toLowerCase().match(P)||[];if(m(t))while(n=i[r++])"+"===n[0]?(n=n.slice(1)||"*",(o[n]=o[n]||[]).unshift(t)):(o[n]=o[n]||[]).push(t)}}function Bt(t,i,o,a){var s={},u=t===Mt;function l(e){var r;return s[e]=!0,S.each(t[e]||[],function(e,t){var n=t(i,o,a);return"string"!=typeof n||u||s[n]?u?!(r=n):void 0:(i.dataTypes.unshift(n),l(n),!1)}),r}return l(i.dataTypes[0])||!s["*"]&&l("*")}function $t(e,t){var n,r,i=S.ajaxSettings.flatOptions||{};for(n in t)void 0!==t[n]&&((i[n]?e:r||(r={}))[n]=t[n]);return r&&S.extend(!0,e,r),e}Wt.href=Tt.href,S.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:Tt.href,type:"GET",isLocal:/^(?:about|app|app-storage|.+-extension|file|res|widget):$/.test(Tt.protocol),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":It,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/\bxml\b/,html:/\bhtml/,json:/\bjson\b/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":JSON.parse,"text xml":S.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(e,t){return t?$t($t(e,S.ajaxSettings),t):$t(S.ajaxSettings,e)},ajaxPrefilter:Ft(Rt),ajaxTransport:Ft(Mt),ajax:function(e,t){"object"==typeof e&&(t=e,e=void 0),t=t||{};var c,f,p,n,d,r,h,g,i,o,v=S.ajaxSetup({},t),y=v.context||v,m=v.context&&(y.nodeType||y.jquery)?S(y):S.event,x=S.Deferred(),b=S.Callbacks("once memory"),w=v.statusCode||{},a={},s={},u="canceled",T={readyState:0,getResponseHeader:function(e){var t;if(h){if(!n){n={};while(t=Ht.exec(p))n[t[1].toLowerCase()+" "]=(n[t[1].toLowerCase()+" "]||[]).concat(t[2])}t=n[e.toLowerCase()+" "]}return null==t?null:t.join(", ")},getAllResponseHeaders:function(){return h?p:null},setRequestHeader:function(e,t){return null==h&&(e=s[e.toLowerCase()]=s[e.toLowerCase()]||e,a[e]=t),this},overrideMimeType:function(e){return null==h&&(v.mimeType=e),this},statusCode:function(e){var t;if(e)if(h)T.always(e[T.status]);else for(t in e)w[t]=[w[t],e[t]];return this},abort:function(e){var t=e||u;return c&&c.abort(t),l(0,t),this}};if(x.promise(T),v.url=((e||v.url||Tt.href)+"").replace(Pt,Tt.protocol+"//"),v.type=t.method||t.type||v.method||v.type,v.dataTypes=(v.dataType||"*").toLowerCase().match(P)||[""],null==v.crossDomain){r=E.createElement("a");try{r.href=v.url,r.href=r.href,v.crossDomain=Wt.protocol+"//"+Wt.host!=r.protocol+"//"+r.host}catch(e){v.crossDomain=!0}}if(v.data&&v.processData&&"string"!=typeof v.data&&(v.data=S.param(v.data,v.traditional)),Bt(Rt,v,t,T),h)return T;for(i in(g=S.event&&v.global)&&0==S.active++&&S.event.trigger("ajaxStart"),v.type=v.type.toUpperCase(),v.hasContent=!Ot.test(v.type),f=v.url.replace(qt,""),v.hasContent?v.data&&v.processData&&0===(v.contentType||"").indexOf("application/x-www-form-urlencoded")&&(v.data=v.data.replace(jt,"+")):(o=v.url.slice(f.length),v.data&&(v.processData||"string"==typeof v.data)&&(f+=(Et.test(f)?"&":"?")+v.data,delete v.data),!1===v.cache&&(f=f.replace(Lt,"$1"),o=(Et.test(f)?"&":"?")+"_="+Ct.guid+++o),v.url=f+o),v.ifModified&&(S.lastModified[f]&&T.setRequestHeader("If-Modified-Since",S.lastModified[f]),S.etag[f]&&T.setRequestHeader("If-None-Match",S.etag[f])),(v.data&&v.hasContent&&!1!==v.contentType||t.contentType)&&T.setRequestHeader("Content-Type",v.contentType),T.setRequestHeader("Accept",v.dataTypes[0]&&v.accepts[v.dataTypes[0]]?v.accepts[v.dataTypes[0]]+("*"!==v.dataTypes[0]?", "+It+"; q=0.01":""):v.accepts["*"]),v.headers)T.setRequestHeader(i,v.headers[i]);if(v.beforeSend&&(!1===v.beforeSend.call(y,T,v)||h))return T.abort();if(u="abort",b.add(v.complete),T.done(v.success),T.fail(v.error),c=Bt(Mt,v,t,T)){if(T.readyState=1,g&&m.trigger("ajaxSend",[T,v]),h)return T;v.async&&0<v.timeout&&(d=C.setTimeout(function(){T.abort("timeout")},v.timeout));try{h=!1,c.send(a,l)}catch(e){if(h)throw e;l(-1,e)}}else l(-1,"No Transport");function l(e,t,n,r){var i,o,a,s,u,l=t;h||(h=!0,d&&C.clearTimeout(d),c=void 0,p=r||"",T.readyState=0<e?4:0,i=200<=e&&e<300||304===e,n&&(s=function(e,t,n){var r,i,o,a,s=e.contents,u=e.dataTypes;while("*"===u[0])u.shift(),void 0===r&&(r=e.mimeType||t.getResponseHeader("Content-Type"));if(r)for(i in s)if(s[i]&&s[i].test(r)){u.unshift(i);break}if(u[0]in n)o=u[0];else{for(i in n){if(!u[0]||e.converters[i+" "+u[0]]){o=i;break}a||(a=i)}o=o||a}if(o)return o!==u[0]&&u.unshift(o),n[o]}(v,T,n)),!i&&-1<S.inArray("script",v.dataTypes)&&(v.converters["text script"]=function(){}),s=function(e,t,n,r){var i,o,a,s,u,l={},c=e.dataTypes.slice();if(c[1])for(a in e.converters)l[a.toLowerCase()]=e.converters[a];o=c.shift();while(o)if(e.responseFields[o]&&(n[e.responseFields[o]]=t),!u&&r&&e.dataFilter&&(t=e.dataFilter(t,e.dataType)),u=o,o=c.shift())if("*"===o)o=u;else if("*"!==u&&u!==o){if(!(a=l[u+" "+o]||l["* "+o]))for(i in l)if((s=i.split(" "))[1]===o&&(a=l[u+" "+s[0]]||l["* "+s[0]])){!0===a?a=l[i]:!0!==l[i]&&(o=s[0],c.unshift(s[1]));break}if(!0!==a)if(a&&e["throws"])t=a(t);else try{t=a(t)}catch(e){return{state:"parsererror",error:a?e:"No conversion from "+u+" to "+o}}}return{state:"success",data:t}}(v,s,T,i),i?(v.ifModified&&((u=T.getResponseHeader("Last-Modified"))&&(S.lastModified[f]=u),(u=T.getResponseHeader("etag"))&&(S.etag[f]=u)),204===e||"HEAD"===v.type?l="nocontent":304===e?l="notmodified":(l=s.state,o=s.data,i=!(a=s.error))):(a=l,!e&&l||(l="error",e<0&&(e=0))),T.status=e,T.statusText=(t||l)+"",i?x.resolveWith(y,[o,l,T]):x.rejectWith(y,[T,l,a]),T.statusCode(w),w=void 0,g&&m.trigger(i?"ajaxSuccess":"ajaxError",[T,v,i?o:a]),b.fireWith(y,[T,l]),g&&(m.trigger("ajaxComplete",[T,v]),--S.active||S.event.trigger("ajaxStop")))}return T},getJSON:function(e,t,n){return S.get(e,t,n,"json")},getScript:function(e,t){return S.get(e,void 0,t,"script")}}),S.each(["get","post"],function(e,i){S[i]=function(e,t,n,r){return m(t)&&(r=r||n,n=t,t=void 0),S.ajax(S.extend({url:e,type:i,dataType:r,data:t,success:n},S.isPlainObject(e)&&e))}}),S.ajaxPrefilter(function(e){var t;for(t in e.headers)"content-type"===t.toLowerCase()&&(e.contentType=e.headers[t]||"")}),S._evalUrl=function(e,t,n){return S.ajax({url:e,type:"GET",dataType:"script",cache:!0,async:!1,global:!1,converters:{"text script":function(){}},dataFilter:function(e){S.globalEval(e,t,n)}})},S.fn.extend({wrapAll:function(e){var t;return this[0]&&(m(e)&&(e=e.call(this[0])),t=S(e,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&t.insertBefore(this[0]),t.map(function(){var e=this;while(e.firstElementChild)e=e.firstElementChild;return e}).append(this)),this},wrapInner:function(n){return m(n)?this.each(function(e){S(this).wrapInner(n.call(this,e))}):this.each(function(){var e=S(this),t=e.contents();t.length?t.wrapAll(n):e.append(n)})},wrap:function(t){var n=m(t);return this.each(function(e){S(this).wrapAll(n?t.call(this,e):t)})},unwrap:function(e){return this.parent(e).not("body").each(function(){S(this).replaceWith(this.childNodes)}),this}}),S.expr.pseudos.hidden=function(e){return!S.expr.pseudos.visible(e)},S.expr.pseudos.visible=function(e){return!!(e.offsetWidth||e.offsetHeight||e.getClientRects().length)},S.ajaxSettings.xhr=function(){try{return new C.XMLHttpRequest}catch(e){}};var _t={0:200,1223:204},zt=S.ajaxSettings.xhr();y.cors=!!zt&&"withCredentials"in zt,y.ajax=zt=!!zt,S.ajaxTransport(function(i){var o,a;if(y.cors||zt&&!i.crossDomain)return{send:function(e,t){var n,r=i.xhr();if(r.open(i.type,i.url,i.async,i.username,i.password),i.xhrFields)for(n in i.xhrFields)r[n]=i.xhrFields[n];for(n in i.mimeType&&r.overrideMimeType&&r.overrideMimeType(i.mimeType),i.crossDomain||e["X-Requested-With"]||(e["X-Requested-With"]="XMLHttpRequest"),e)r.setRequestHeader(n,e[n]);o=function(e){return function(){o&&(o=a=r.onload=r.onerror=r.onabort=r.ontimeout=r.onreadystatechange=null,"abort"===e?r.abort():"error"===e?"number"!=typeof r.status?t(0,"error"):t(r.status,r.statusText):t(_t[r.status]||r.status,r.statusText,"text"!==(r.responseType||"text")||"string"!=typeof r.responseText?{binary:r.response}:{text:r.responseText},r.getAllResponseHeaders()))}},r.onload=o(),a=r.onerror=r.ontimeout=o("error"),void 0!==r.onabort?r.onabort=a:r.onreadystatechange=function(){4===r.readyState&&C.setTimeout(function(){o&&a()})},o=o("abort");try{r.send(i.hasContent&&i.data||null)}catch(e){if(o)throw e}},abort:function(){o&&o()}}}),S.ajaxPrefilter(function(e){e.crossDomain&&(e.contents.script=!1)}),S.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/\b(?:java|ecma)script\b/},converters:{"text script":function(e){return S.globalEval(e),e}}}),S.ajaxPrefilter("script",function(e){void 0===e.cache&&(e.cache=!1),e.crossDomain&&(e.type="GET")}),S.ajaxTransport("script",function(n){var r,i;if(n.crossDomain||n.scriptAttrs)return{send:function(e,t){r=S("<script>").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="<form></form><form></form>",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1<s&&(r=vt(e.slice(s)),e=e.slice(0,s)),m(t)?(n=t,t=void 0):t&&"object"==typeof t&&(i="POST"),0<a.length&&S.ajax({url:e,type:i||"GET",dataType:"html",data:t}).done(function(e){o=arguments,a.html(r?S("<div>").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):("number"==typeof f.top&&(f.top+="px"),"number"==typeof f.left&&(f.left+="px"),c.css(f))}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=$e(y.pixelPosition,function(e,t){if(t)return t=Be(e,n),Me.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0<arguments.length?this.on(n,null,e,t):this.trigger(n)}});var Gt=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;S.proxy=function(e,t){var n,r,i;if("string"==typeof t&&(n=e[t],t=e,e=n),m(e))return r=s.call(arguments,2),(i=function(){return e.apply(t||this,r.concat(s.call(arguments)))}).guid=e.guid=e.guid||S.guid++,i},S.holdReady=function(e){e?S.readyWait++:S.ready(!0)},S.isArray=Array.isArray,S.parseJSON=JSON.parse,S.nodeName=A,S.isFunction=m,S.isWindow=x,S.camelCase=X,S.type=w,S.now=Date.now,S.isNumeric=function(e){var t=S.type(e);return("number"===t||"string"===t)&&!isNaN(e-parseFloat(e))},S.trim=function(e){return null==e?"":(e+"").replace(Gt,"")},"function"==typeof define&&define.amd&&define("jquery",[],function(){return S});var Yt=C.jQuery,Qt=C.$;return S.noConflict=function(e){return C.$===S&&(C.$=Qt),e&&C.jQuery===S&&(C.jQuery=Yt),S},"undefined"==typeof e&&(C.jQuery=C.$=S),S}); |
| 0 | /* | |
| 1 | * language_data.js | |
| 2 | * ~~~~~~~~~~~~~~~~ | |
| 3 | * | |
| 4 | * This script contains the language-specific data used by searchtools.js, | |
| 5 | * namely the list of stopwords, stemmer, scorer and splitter. | |
| 6 | * | |
| 7 | * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. | |
| 8 | * :license: BSD, see LICENSE for details. | |
| 9 | * | |
| 10 | */ | |
| 11 | ||
| 12 | var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]; | |
| 13 | ||
| 14 | ||
| 15 | /* Non-minified version JS is _stemmer.js if file is provided */ | |
| 16 | /** | |
| 17 | * Porter Stemmer | |
| 18 | */ | |
| 19 | var Stemmer = function() { | |
| 20 | ||
| 21 | var step2list = { | |
| 22 | ational: 'ate', | |
| 23 | tional: 'tion', | |
| 24 | enci: 'ence', | |
| 25 | anci: 'ance', | |
| 26 | izer: 'ize', | |
| 27 | bli: 'ble', | |
| 28 | alli: 'al', | |
| 29 | entli: 'ent', | |
| 30 | eli: 'e', | |
| 31 | ousli: 'ous', | |
| 32 | ization: 'ize', | |
| 33 | ation: 'ate', | |
| 34 | ator: 'ate', | |
| 35 | alism: 'al', | |
| 36 | iveness: 'ive', | |
| 37 | fulness: 'ful', | |
| 38 | ousness: 'ous', | |
| 39 | aliti: 'al', | |
| 40 | iviti: 'ive', | |
| 41 | biliti: 'ble', | |
| 42 | logi: 'log' | |
| 43 | }; | |
| 44 | ||
| 45 | var step3list = { | |
| 46 | icate: 'ic', | |
| 47 | ative: '', | |
| 48 | alize: 'al', | |
| 49 | iciti: 'ic', | |
| 50 | ical: 'ic', | |
| 51 | ful: '', | |
| 52 | ness: '' | |
| 53 | }; | |
| 54 | ||
| 55 | var c = "[^aeiou]"; // consonant | |
| 56 | var v = "[aeiouy]"; // vowel | |
| 57 | var C = c + "[^aeiouy]*"; // consonant sequence | |
| 58 | var V = v + "[aeiou]*"; // vowel sequence | |
| 59 | ||
| 60 | var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 | |
| 61 | var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 | |
| 62 | var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 | |
| 63 | var s_v = "^(" + C + ")?" + v; // vowel in stem | |
| 64 | ||
| 65 | this.stemWord = function (w) { | |
| 66 | var stem; | |
| 67 | var suffix; | |
| 68 | var firstch; | |
| 69 | var origword = w; | |
| 70 | ||
| 71 | if (w.length < 3) | |
| 72 | return w; | |
| 73 | ||
| 74 | var re; | |
| 75 | var re2; | |
| 76 | var re3; | |
| 77 | var re4; | |
| 78 | ||
| 79 | firstch = w.substr(0,1); | |
| 80 | if (firstch == "y") | |
| 81 | w = firstch.toUpperCase() + w.substr(1); | |
| 82 | ||
| 83 | // Step 1a | |
| 84 | re = /^(.+?)(ss|i)es$/; | |
| 85 | re2 = /^(.+?)([^s])s$/; | |
| 86 | ||
| 87 | if (re.test(w)) | |
| 88 | w = w.replace(re,"$1$2"); | |
| 89 | else if (re2.test(w)) | |
| 90 | w = w.replace(re2,"$1$2"); | |
| 91 | ||
| 92 | // Step 1b | |
| 93 | re = /^(.+?)eed$/; | |
| 94 | re2 = /^(.+?)(ed|ing)$/; | |
| 95 | if (re.test(w)) { | |
| 96 | var fp = re.exec(w); | |
| 97 | re = new RegExp(mgr0); | |
| 98 | if (re.test(fp[1])) { | |
| 99 | re = /.$/; | |
| 100 | w = w.replace(re,""); | |
| 101 | } | |
| 102 | } | |
| 103 | else if (re2.test(w)) { | |
| 104 | var fp = re2.exec(w); | |
| 105 | stem = fp[1]; | |
| 106 | re2 = new RegExp(s_v); | |
| 107 | if (re2.test(stem)) { | |
| 108 | w = stem; | |
| 109 | re2 = /(at|bl|iz)$/; | |
| 110 | re3 = new RegExp("([^aeiouylsz])\\1$"); | |
| 111 | re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); | |
| 112 | if (re2.test(w)) | |
| 113 | w = w + "e"; | |
| 114 | else if (re3.test(w)) { | |
| 115 | re = /.$/; | |
| 116 | w = w.replace(re,""); | |
| 117 | } | |
| 118 | else if (re4.test(w)) | |
| 119 | w = w + "e"; | |
| 120 | } | |
| 121 | } | |
| 122 | ||
| 123 | // Step 1c | |
| 124 | re = /^(.+?)y$/; | |
| 125 | if (re.test(w)) { | |
| 126 | var fp = re.exec(w); | |
| 127 | stem = fp[1]; | |
| 128 | re = new RegExp(s_v); | |
| 129 | if (re.test(stem)) | |
| 130 | w = stem + "i"; | |
| 131 | } | |
| 132 | ||
| 133 | // Step 2 | |
| 134 | re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; | |
| 135 | if (re.test(w)) { | |
| 136 | var fp = re.exec(w); | |
| 137 | stem = fp[1]; | |
| 138 | suffix = fp[2]; | |
| 139 | re = new RegExp(mgr0); | |
| 140 | if (re.test(stem)) | |
| 141 | w = stem + step2list[suffix]; | |
| 142 | } | |
| 143 | ||
| 144 | // Step 3 | |
| 145 | re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; | |
| 146 | if (re.test(w)) { | |
| 147 | var fp = re.exec(w); | |
| 148 | stem = fp[1]; | |
| 149 | suffix = fp[2]; | |
| 150 | re = new RegExp(mgr0); | |
| 151 | if (re.test(stem)) | |
| 152 | w = stem + step3list[suffix]; | |
| 153 | } | |
| 154 | ||
| 155 | // Step 4 | |
| 156 | re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; | |
| 157 | re2 = /^(.+?)(s|t)(ion)$/; | |
| 158 | if (re.test(w)) { | |
| 159 | var fp = re.exec(w); | |
| 160 | stem = fp[1]; | |
| 161 | re = new RegExp(mgr1); | |
| 162 | if (re.test(stem)) | |
| 163 | w = stem; | |
| 164 | } | |
| 165 | else if (re2.test(w)) { | |
| 166 | var fp = re2.exec(w); | |
| 167 | stem = fp[1] + fp[2]; | |
| 168 | re2 = new RegExp(mgr1); | |
| 169 | if (re2.test(stem)) | |
| 170 | w = stem; | |
| 171 | } | |
| 172 | ||
| 173 | // Step 5 | |
| 174 | re = /^(.+?)e$/; | |
| 175 | if (re.test(w)) { | |
| 176 | var fp = re.exec(w); | |
| 177 | stem = fp[1]; | |
| 178 | re = new RegExp(mgr1); | |
| 179 | re2 = new RegExp(meq1); | |
| 180 | re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); | |
| 181 | if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) | |
| 182 | w = stem; | |
| 183 | } | |
| 184 | re = /ll$/; | |
| 185 | re2 = new RegExp(mgr1); | |
| 186 | if (re.test(w) && re2.test(w)) { | |
| 187 | re = /.$/; | |
| 188 | w = w.replace(re,""); | |
| 189 | } | |
| 190 | ||
| 191 | // and turn initial Y back to y | |
| 192 | if (firstch == "y") | |
| 193 | w = firstch.toLowerCase() + w.substr(1); | |
| 194 | return w; | |
| 195 | } | |
| 196 | } | |
| 197 | ||
| 198 | ||
| 199 | ||
| 200 | ||
| 201 | ||
| 202 | var splitChars = (function() { | |
| 203 | var result = {}; | |
| 204 | var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648, | |
| 205 | 1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702, | |
| 206 | 2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971, | |
| 207 | 2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345, | |
| 208 | 3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761, | |
| 209 | 3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823, | |
| 210 | 4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125, | |
| 211 | 8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695, | |
| 212 | 11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587, | |
| 213 | 43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141]; | |
| 214 | var i, j, start, end; | |
| 215 | for (i = 0; i < singles.length; i++) { | |
| 216 | result[singles[i]] = true; | |
| 217 | } | |
| 218 | var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709], | |
| 219 | [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161], | |
| 220 | [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568], | |
| 221 | [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807], | |
| 222 | [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047], | |
| 223 | [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383], | |
| 224 | [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450], | |
| 225 | [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547], | |
| 226 | [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673], | |
| 227 | [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820], | |
| 228 | [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946], | |
| 229 | [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023], | |
| 230 | [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173], | |
| 231 | [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332], | |
| 232 | [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481], | |
| 233 | [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718], | |
| 234 | [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791], | |
| 235 | [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095], | |
| 236 | [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205], | |
| 237 | [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687], | |
| 238 | [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968], | |
| 239 | [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869], | |
| 240 | [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102], | |
| 241 | [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271], | |
| 242 | [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592], | |
| 243 | [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822], | |
| 244 | [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167], | |
| 245 | [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959], | |
| 246 | [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143], | |
| 247 | [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318], | |
| 248 | [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483], | |
| 249 | [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101], | |
| 250 | [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567], | |
| 251 | [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292], | |
| 252 | [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444], | |
| 253 | [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783], | |
| 254 | [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311], | |
| 255 | [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511], | |
| 256 | [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774], | |
| 257 | [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071], | |
| 258 | [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263], | |
| 259 | [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519], | |
| 260 | [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647], | |
| 261 | [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967], | |
| 262 | [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295], | |
| 263 | [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274], | |
| 264 | [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007], | |
| 265 | [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381], | |
| 266 | [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]]; | |
| 267 | for (i = 0; i < ranges.length; i++) { | |
| 268 | start = ranges[i][0]; | |
| 269 | end = ranges[i][1]; | |
| 270 | for (j = start; j <= end; j++) { | |
| 271 | result[j] = true; | |
| 272 | } | |
| 273 | } | |
| 274 | return result; | |
| 275 | })(); | |
| 276 | ||
| 277 | function splitQuery(query) { | |
| 278 | var result = []; | |
| 279 | var start = -1; | |
| 280 | for (var i = 0; i < query.length; i++) { | |
| 281 | if (splitChars[query.charCodeAt(i)]) { | |
| 282 | if (start !== -1) { | |
| 283 | result.push(query.slice(start, i)); | |
| 284 | start = -1; | |
| 285 | } | |
| 286 | } else if (start === -1) { | |
| 287 | start = i; | |
| 288 | } | |
| 289 | } | |
| 290 | if (start !== -1) { | |
| 291 | result.push(query.slice(start)); | |
| 292 | } | |
| 293 | return result; | |
| 294 | } | |
| 295 | ||
| 296 |
Binary diff not shown
Binary diff not shown
Binary diff not shown
| 0 | pre { line-height: 125%; } | |
| 1 | td.linenos pre { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; } | |
| 2 | span.linenos { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; } | |
| 3 | td.linenos pre.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } | |
| 4 | span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } | |
| 0 | 5 | .highlight .hll { background-color: #ffffcc } |
| 1 | .highlight { background: #eeffcc; } | |
| 6 | .highlight { background: #eeffcc; } | |
| 2 | 7 | .highlight .c { color: #408090; font-style: italic } /* Comment */ |
| 3 | 8 | .highlight .err { border: 1px solid #FF0000 } /* Error */ |
| 4 | 9 | .highlight .k { color: #007020; font-weight: bold } /* Keyword */ |
| 46 | 51 | .highlight .mh { color: #208050 } /* Literal.Number.Hex */ |
| 47 | 52 | .highlight .mi { color: #208050 } /* Literal.Number.Integer */ |
| 48 | 53 | .highlight .mo { color: #208050 } /* Literal.Number.Oct */ |
| 54 | .highlight .sa { color: #4070a0 } /* Literal.String.Affix */ | |
| 49 | 55 | .highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ |
| 50 | 56 | .highlight .sc { color: #4070a0 } /* Literal.String.Char */ |
| 57 | .highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */ | |
| 51 | 58 | .highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ |
| 52 | 59 | .highlight .s2 { color: #4070a0 } /* Literal.String.Double */ |
| 53 | 60 | .highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ |
| 58 | 65 | .highlight .s1 { color: #4070a0 } /* Literal.String.Single */ |
| 59 | 66 | .highlight .ss { color: #517918 } /* Literal.String.Symbol */ |
| 60 | 67 | .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ |
| 68 | .highlight .fm { color: #06287e } /* Name.Function.Magic */ | |
| 61 | 69 | .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ |
| 62 | 70 | .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ |
| 63 | 71 | .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ |
| 72 | .highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */ | |
| 64 | 73 | .highlight .il { color: #208050 } /* Literal.Number.Integer.Long */⏎ |
| 0 | 0 | /* |
| 1 | * searchtools.js_t | |
| 1 | * searchtools.js | |
| 2 | 2 | * ~~~~~~~~~~~~~~~~ |
| 3 | 3 | * |
| 4 | * Sphinx JavaScript utilties for the full-text search. | |
| 4 | * Sphinx JavaScript utilities for the full-text search. | |
| 5 | 5 | * |
| 6 | * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. | |
| 6 | * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. | |
| 7 | 7 | * :license: BSD, see LICENSE for details. |
| 8 | 8 | * |
| 9 | 9 | */ |
| 10 | 10 | |
| 11 | ||
| 12 | /* Non-minified version JS is _stemmer.js if file is provided */ | |
| 13 | /** | |
| 14 | * Porter Stemmer | |
| 15 | */ | |
| 16 | var Stemmer = function() { | |
| 17 | ||
| 18 | var step2list = { | |
| 19 | ational: 'ate', | |
| 20 | tional: 'tion', | |
| 21 | enci: 'ence', | |
| 22 | anci: 'ance', | |
| 23 | izer: 'ize', | |
| 24 | bli: 'ble', | |
| 25 | alli: 'al', | |
| 26 | entli: 'ent', | |
| 27 | eli: 'e', | |
| 28 | ousli: 'ous', | |
| 29 | ization: 'ize', | |
| 30 | ation: 'ate', | |
| 31 | ator: 'ate', | |
| 32 | alism: 'al', | |
| 33 | iveness: 'ive', | |
| 34 | fulness: 'ful', | |
| 35 | ousness: 'ous', | |
| 36 | aliti: 'al', | |
| 37 | iviti: 'ive', | |
| 38 | biliti: 'ble', | |
| 39 | logi: 'log' | |
| 11 | if (!Scorer) { | |
| 12 | /** | |
| 13 | * Simple result scoring code. | |
| 14 | */ | |
| 15 | var Scorer = { | |
| 16 | // Implement the following function to further tweak the score for each result | |
| 17 | // The function takes a result array [filename, title, anchor, descr, score] | |
| 18 | // and returns the new score. | |
| 19 | /* | |
| 20 | score: function(result) { | |
| 21 | return result[4]; | |
| 22 | }, | |
| 23 | */ | |
| 24 | ||
| 25 | // query matches the full name of an object | |
| 26 | objNameMatch: 11, | |
| 27 | // or matches in the last dotted part of the object name | |
| 28 | objPartialMatch: 6, | |
| 29 | // Additive scores depending on the priority of the object | |
| 30 | objPrio: {0: 15, // used to be importantResults | |
| 31 | 1: 5, // used to be objectResults | |
| 32 | 2: -5}, // used to be unimportantResults | |
| 33 | // Used when the priority is not in the mapping. | |
| 34 | objPrioDefault: 0, | |
| 35 | ||
| 36 | // query found in title | |
| 37 | title: 15, | |
| 38 | partialTitle: 7, | |
| 39 | // query found in terms | |
| 40 | term: 5, | |
| 41 | partialTerm: 2 | |
| 40 | 42 | }; |
| 41 | ||
| 42 | var step3list = { | |
| 43 | icate: 'ic', | |
| 44 | ative: '', | |
| 45 | alize: 'al', | |
| 46 | iciti: 'ic', | |
| 47 | ical: 'ic', | |
| 48 | ful: '', | |
| 49 | ness: '' | |
| 50 | }; | |
| 51 | ||
| 52 | var c = "[^aeiou]"; // consonant | |
| 53 | var v = "[aeiouy]"; // vowel | |
| 54 | var C = c + "[^aeiouy]*"; // consonant sequence | |
| 55 | var V = v + "[aeiou]*"; // vowel sequence | |
| 56 | ||
| 57 | var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 | |
| 58 | var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 | |
| 59 | var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 | |
| 60 | var s_v = "^(" + C + ")?" + v; // vowel in stem | |
| 61 | ||
| 62 | this.stemWord = function (w) { | |
| 63 | var stem; | |
| 64 | var suffix; | |
| 65 | var firstch; | |
| 66 | var origword = w; | |
| 67 | ||
| 68 | if (w.length < 3) | |
| 69 | return w; | |
| 70 | ||
| 71 | var re; | |
| 72 | var re2; | |
| 73 | var re3; | |
| 74 | var re4; | |
| 75 | ||
| 76 | firstch = w.substr(0,1); | |
| 77 | if (firstch == "y") | |
| 78 | w = firstch.toUpperCase() + w.substr(1); | |
| 79 | ||
| 80 | // Step 1a | |
| 81 | re = /^(.+?)(ss|i)es$/; | |
| 82 | re2 = /^(.+?)([^s])s$/; | |
| 83 | ||
| 84 | if (re.test(w)) | |
| 85 | w = w.replace(re,"$1$2"); | |
| 86 | else if (re2.test(w)) | |
| 87 | w = w.replace(re2,"$1$2"); | |
| 88 | ||
| 89 | // Step 1b | |
| 90 | re = /^(.+?)eed$/; | |
| 91 | re2 = /^(.+?)(ed|ing)$/; | |
| 92 | if (re.test(w)) { | |
| 93 | var fp = re.exec(w); | |
| 94 | re = new RegExp(mgr0); | |
| 95 | if (re.test(fp[1])) { | |
| 96 | re = /.$/; | |
| 97 | w = w.replace(re,""); | |
| 98 | } | |
| 99 | } | |
| 100 | else if (re2.test(w)) { | |
| 101 | var fp = re2.exec(w); | |
| 102 | stem = fp[1]; | |
| 103 | re2 = new RegExp(s_v); | |
| 104 | if (re2.test(stem)) { | |
| 105 | w = stem; | |
| 106 | re2 = /(at|bl|iz)$/; | |
| 107 | re3 = new RegExp("([^aeiouylsz])\\1$"); | |
| 108 | re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); | |
| 109 | if (re2.test(w)) | |
| 110 | w = w + "e"; | |
| 111 | else if (re3.test(w)) { | |
| 112 | re = /.$/; | |
| 113 | w = w.replace(re,""); | |
| 114 | } | |
| 115 | else if (re4.test(w)) | |
| 116 | w = w + "e"; | |
| 117 | } | |
| 118 | } | |
| 119 | ||
| 120 | // Step 1c | |
| 121 | re = /^(.+?)y$/; | |
| 122 | if (re.test(w)) { | |
| 123 | var fp = re.exec(w); | |
| 124 | stem = fp[1]; | |
| 125 | re = new RegExp(s_v); | |
| 126 | if (re.test(stem)) | |
| 127 | w = stem + "i"; | |
| 128 | } | |
| 129 | ||
| 130 | // Step 2 | |
| 131 | re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; | |
| 132 | if (re.test(w)) { | |
| 133 | var fp = re.exec(w); | |
| 134 | stem = fp[1]; | |
| 135 | suffix = fp[2]; | |
| 136 | re = new RegExp(mgr0); | |
| 137 | if (re.test(stem)) | |
| 138 | w = stem + step2list[suffix]; | |
| 139 | } | |
| 140 | ||
| 141 | // Step 3 | |
| 142 | re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; | |
| 143 | if (re.test(w)) { | |
| 144 | var fp = re.exec(w); | |
| 145 | stem = fp[1]; | |
| 146 | suffix = fp[2]; | |
| 147 | re = new RegExp(mgr0); | |
| 148 | if (re.test(stem)) | |
| 149 | w = stem + step3list[suffix]; | |
| 150 | } | |
| 151 | ||
| 152 | // Step 4 | |
| 153 | re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; | |
| 154 | re2 = /^(.+?)(s|t)(ion)$/; | |
| 155 | if (re.test(w)) { | |
| 156 | var fp = re.exec(w); | |
| 157 | stem = fp[1]; | |
| 158 | re = new RegExp(mgr1); | |
| 159 | if (re.test(stem)) | |
| 160 | w = stem; | |
| 161 | } | |
| 162 | else if (re2.test(w)) { | |
| 163 | var fp = re2.exec(w); | |
| 164 | stem = fp[1] + fp[2]; | |
| 165 | re2 = new RegExp(mgr1); | |
| 166 | if (re2.test(stem)) | |
| 167 | w = stem; | |
| 168 | } | |
| 169 | ||
| 170 | // Step 5 | |
| 171 | re = /^(.+?)e$/; | |
| 172 | if (re.test(w)) { | |
| 173 | var fp = re.exec(w); | |
| 174 | stem = fp[1]; | |
| 175 | re = new RegExp(mgr1); | |
| 176 | re2 = new RegExp(meq1); | |
| 177 | re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); | |
| 178 | if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) | |
| 179 | w = stem; | |
| 180 | } | |
| 181 | re = /ll$/; | |
| 182 | re2 = new RegExp(mgr1); | |
| 183 | if (re.test(w) && re2.test(w)) { | |
| 184 | re = /.$/; | |
| 185 | w = w.replace(re,""); | |
| 186 | } | |
| 187 | ||
| 188 | // and turn initial Y back to y | |
| 189 | if (firstch == "y") | |
| 190 | w = firstch.toLowerCase() + w.substr(1); | |
| 191 | return w; | |
| 43 | } | |
| 44 | ||
| 45 | if (!splitQuery) { | |
| 46 | function splitQuery(query) { | |
| 47 | return query.split(/\s+/); | |
| 192 | 48 | } |
| 193 | 49 | } |
| 194 | ||
| 195 | ||
| 196 | ||
| 197 | /** | |
| 198 | * Simple result scoring code. | |
| 199 | */ | |
| 200 | var Scorer = { | |
| 201 | // Implement the following function to further tweak the score for each result | |
| 202 | // The function takes a result array [filename, title, anchor, descr, score] | |
| 203 | // and returns the new score. | |
| 204 | /* | |
| 205 | score: function(result) { | |
| 206 | return result[4]; | |
| 207 | }, | |
| 208 | */ | |
| 209 | ||
| 210 | // query matches the full name of an object | |
| 211 | objNameMatch: 11, | |
| 212 | // or matches in the last dotted part of the object name | |
| 213 | objPartialMatch: 6, | |
| 214 | // Additive scores depending on the priority of the object | |
| 215 | objPrio: {0: 15, // used to be importantResults | |
| 216 | 1: 5, // used to be objectResults | |
| 217 | 2: -5}, // used to be unimportantResults | |
| 218 | // Used when the priority is not in the mapping. | |
| 219 | objPrioDefault: 0, | |
| 220 | ||
| 221 | // query found in title | |
| 222 | title: 15, | |
| 223 | // query found in terms | |
| 224 | term: 5 | |
| 225 | }; | |
| 226 | ||
| 227 | 50 | |
| 228 | 51 | /** |
| 229 | 52 | * Search Module |
| 233 | 56 | _index : null, |
| 234 | 57 | _queued_query : null, |
| 235 | 58 | _pulse_status : -1, |
| 59 | ||
| 60 | htmlToText : function(htmlString) { | |
| 61 | var virtualDocument = document.implementation.createHTMLDocument('virtual'); | |
| 62 | var htmlElement = $(htmlString, virtualDocument); | |
| 63 | htmlElement.find('.headerlink').remove(); | |
| 64 | docContent = htmlElement.find('[role=main]')[0]; | |
| 65 | if(docContent === undefined) { | |
| 66 | console.warn("Content block not found. Sphinx search tries to obtain it " + | |
| 67 | "via '[role=main]'. Could you check your theme or template."); | |
| 68 | return ""; | |
| 69 | } | |
| 70 | return docContent.textContent || docContent.innerText; | |
| 71 | }, | |
| 236 | 72 | |
| 237 | 73 | init : function() { |
| 238 | 74 | var params = $.getQueryParameters(); |
| 298 | 134 | this.out = $('#search-results'); |
| 299 | 135 | this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out); |
| 300 | 136 | this.dots = $('<span></span>').appendTo(this.title); |
| 301 | this.status = $('<p style="display: none"></p>').appendTo(this.out); | |
| 137 | this.status = $('<p class="search-summary"> </p>').appendTo(this.out); | |
| 302 | 138 | this.output = $('<ul class="search"/>').appendTo(this.out); |
| 303 | 139 | |
| 304 | 140 | $('#search-progress').text(_('Preparing search...')); |
| 316 | 152 | */ |
| 317 | 153 | query : function(query) { |
| 318 | 154 | var i; |
| 319 | var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]; | |
| 320 | 155 | |
| 321 | 156 | // stem the searchterms and add them to the correct list |
| 322 | 157 | var stemmer = new Stemmer(); |
| 323 | 158 | var searchterms = []; |
| 324 | 159 | var excluded = []; |
| 325 | 160 | var hlterms = []; |
| 326 | var tmp = query.split(/\s+/); | |
| 161 | var tmp = splitQuery(query); | |
| 327 | 162 | var objectterms = []; |
| 328 | 163 | for (i = 0; i < tmp.length; i++) { |
| 329 | 164 | if (tmp[i] !== "") { |
| 330 | 165 | objectterms.push(tmp[i].toLowerCase()); |
| 331 | 166 | } |
| 332 | 167 | |
| 333 | if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i].match(/^\d+$/) || | |
| 334 | tmp[i] === "") { | |
| 168 | if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") { | |
| 335 | 169 | // skip this "word" |
| 336 | 170 | continue; |
| 337 | 171 | } |
| 338 | 172 | // stem the word |
| 339 | 173 | var word = stemmer.stemWord(tmp[i].toLowerCase()); |
| 174 | // prevent stemmer from cutting word smaller than two chars | |
| 175 | if(word.length < 3 && tmp[i].length >= 3) { | |
| 176 | word = tmp[i]; | |
| 177 | } | |
| 340 | 178 | var toAppend; |
| 341 | 179 | // select the correct list |
| 342 | 180 | if (word[0] == '-') { |
| 410 | 248 | if (results.length) { |
| 411 | 249 | var item = results.pop(); |
| 412 | 250 | var listItem = $('<li style="display:none"></li>'); |
| 413 | if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') { | |
| 251 | var requestUrl = ""; | |
| 252 | var linkUrl = ""; | |
| 253 | if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') { | |
| 414 | 254 | // dirhtml builder |
| 415 | 255 | var dirname = item[0] + '/'; |
| 416 | 256 | if (dirname.match(/\/index\/$/)) { |
| 418 | 258 | } else if (dirname == 'index/') { |
| 419 | 259 | dirname = ''; |
| 420 | 260 | } |
| 421 | listItem.append($('<a/>').attr('href', | |
| 422 | DOCUMENTATION_OPTIONS.URL_ROOT + dirname + | |
| 423 | highlightstring + item[2]).html(item[1])); | |
| 261 | requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname; | |
| 262 | linkUrl = requestUrl; | |
| 263 | ||
| 424 | 264 | } else { |
| 425 | 265 | // normal html builders |
| 426 | listItem.append($('<a/>').attr('href', | |
| 427 | item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + | |
| 266 | requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX; | |
| 267 | linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX; | |
| 268 | } | |
| 269 | listItem.append($('<a/>').attr('href', | |
| 270 | linkUrl + | |
| 428 | 271 | highlightstring + item[2]).html(item[1])); |
| 429 | } | |
| 430 | 272 | if (item[3]) { |
| 431 | 273 | listItem.append($('<span> (' + item[3] + ')</span>')); |
| 432 | 274 | Search.output.append(listItem); |
| 434 | 276 | displayNextItem(); |
| 435 | 277 | }); |
| 436 | 278 | } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { |
| 437 | $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[0] + '.txt', | |
| 279 | $.ajax({url: requestUrl, | |
| 438 | 280 | dataType: "text", |
| 439 | 281 | complete: function(jqxhr, textstatus) { |
| 440 | 282 | var data = jqxhr.responseText; |
| 473 | 315 | */ |
| 474 | 316 | performObjectSearch : function(object, otherterms) { |
| 475 | 317 | var filenames = this._index.filenames; |
| 318 | var docnames = this._index.docnames; | |
| 476 | 319 | var objects = this._index.objects; |
| 477 | 320 | var objnames = this._index.objnames; |
| 478 | 321 | var titles = this._index.titles; |
| 483 | 326 | for (var prefix in objects) { |
| 484 | 327 | for (var name in objects[prefix]) { |
| 485 | 328 | var fullname = (prefix ? prefix + '.' : '') + name; |
| 486 | if (fullname.toLowerCase().indexOf(object) > -1) { | |
| 329 | var fullnameLower = fullname.toLowerCase() | |
| 330 | if (fullnameLower.indexOf(object) > -1) { | |
| 487 | 331 | var score = 0; |
| 488 | var parts = fullname.split('.'); | |
| 332 | var parts = fullnameLower.split('.'); | |
| 489 | 333 | // check for different match types: exact matches of full name or |
| 490 | 334 | // "last name" (i.e. last dotted part) |
| 491 | if (fullname == object || parts[parts.length - 1] == object) { | |
| 335 | if (fullnameLower == object || parts[parts.length - 1] == object) { | |
| 492 | 336 | score += Scorer.objNameMatch; |
| 493 | 337 | // matches in last name |
| 494 | 338 | } else if (parts[parts.length - 1].indexOf(object) > -1) { |
| 526 | 370 | } else { |
| 527 | 371 | score += Scorer.objPrioDefault; |
| 528 | 372 | } |
| 529 | results.push([filenames[match[0]], fullname, '#'+anchor, descr, score]); | |
| 373 | results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]); | |
| 530 | 374 | } |
| 531 | 375 | } |
| 532 | 376 | } |
| 538 | 382 | * search for full-text terms in the index |
| 539 | 383 | */ |
| 540 | 384 | performTermsSearch : function(searchterms, excluded, terms, titleterms) { |
| 385 | var docnames = this._index.docnames; | |
| 541 | 386 | var filenames = this._index.filenames; |
| 542 | 387 | var titles = this._index.titles; |
| 543 | 388 | |
| 554 | 399 | {files: terms[word], score: Scorer.term}, |
| 555 | 400 | {files: titleterms[word], score: Scorer.title} |
| 556 | 401 | ]; |
| 402 | // add support for partial matches | |
| 403 | if (word.length > 2) { | |
| 404 | for (var w in terms) { | |
| 405 | if (w.match(word) && !terms[word]) { | |
| 406 | _o.push({files: terms[w], score: Scorer.partialTerm}) | |
| 407 | } | |
| 408 | } | |
| 409 | for (var w in titleterms) { | |
| 410 | if (w.match(word) && !titleterms[word]) { | |
| 411 | _o.push({files: titleterms[w], score: Scorer.partialTitle}) | |
| 412 | } | |
| 413 | } | |
| 414 | } | |
| 557 | 415 | |
| 558 | 416 | // no match but word was a required one |
| 559 | 417 | if ($u.every(_o, function(o){return o.files === undefined;})) { |
| 573 | 431 | for (j = 0; j < _files.length; j++) { |
| 574 | 432 | file = _files[j]; |
| 575 | 433 | if (!(file in scoreMap)) |
| 576 | scoreMap[file] = {} | |
| 434 | scoreMap[file] = {}; | |
| 577 | 435 | scoreMap[file][word] = o.score; |
| 578 | 436 | } |
| 579 | 437 | }); |
| 581 | 439 | // create the mapping |
| 582 | 440 | for (j = 0; j < files.length; j++) { |
| 583 | 441 | file = files[j]; |
| 584 | if (file in fileMap) | |
| 442 | if (file in fileMap && fileMap[file].indexOf(word) === -1) | |
| 585 | 443 | fileMap[file].push(word); |
| 586 | 444 | else |
| 587 | 445 | fileMap[file] = [word]; |
| 593 | 451 | var valid = true; |
| 594 | 452 | |
| 595 | 453 | // check if all requirements are matched |
| 596 | if (fileMap[file].length != searchterms.length) | |
| 597 | continue; | |
| 454 | var filteredTermCount = // as search terms with length < 3 are discarded: ignore | |
| 455 | searchterms.filter(function(term){return term.length > 2}).length | |
| 456 | if ( | |
| 457 | fileMap[file].length != searchterms.length && | |
| 458 | fileMap[file].length != filteredTermCount | |
| 459 | ) continue; | |
| 598 | 460 | |
| 599 | 461 | // ensure that none of the excluded terms is in the search result |
| 600 | 462 | for (i = 0; i < excluded.length; i++) { |
| 612 | 474 | // select one (max) score for the file. |
| 613 | 475 | // for better ranking, we should calculate ranking by using words statistics like basic tf-idf... |
| 614 | 476 | var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]})); |
| 615 | results.push([filenames[file], titles[file], '', null, score]); | |
| 477 | results.push([docnames[file], titles[file], '', null, score, filenames[file]]); | |
| 616 | 478 | } |
| 617 | 479 | } |
| 618 | 480 | return results; |
| 622 | 484 | * helper function to return a node containing the |
| 623 | 485 | * search summary for a given text. keywords is a list |
| 624 | 486 | * of stemmed words, hlwords is the list of normal, unstemmed |
| 625 | * words. the first one is used to find the occurance, the | |
| 487 | * words. the first one is used to find the occurrence, the | |
| 626 | 488 | * latter for highlighting it. |
| 627 | 489 | */ |
| 628 | makeSearchSummary : function(text, keywords, hlwords) { | |
| 490 | makeSearchSummary : function(htmlText, keywords, hlwords) { | |
| 491 | var text = Search.htmlToText(htmlText); | |
| 629 | 492 | var textLower = text.toLowerCase(); |
| 630 | 493 | var start = 0; |
| 631 | 494 | $.each(keywords, function() { |
| 647 | 510 | |
| 648 | 511 | $(document).ready(function() { |
| 649 | 512 | Search.init(); |
| 650 | });⏎ | |
| 513 | }); | |
| 4 | 4 | * Sphinx stylesheet -- sphinxdoc theme. Originally created by |
| 5 | 5 | * Armin Ronacher for Werkzeug. |
| 6 | 6 | * |
| 7 | * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. | |
| 7 | * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. | |
| 8 | 8 | * :license: BSD, see LICENSE for details. |
| 9 | 9 | * |
| 10 | 10 | */ |
| 36 | 36 | background-repeat: repeat-x; |
| 37 | 37 | } |
| 38 | 38 | |
| 39 | div.documentwrapper { | |
| 40 | float: left; | |
| 41 | width: 100%; | |
| 42 | } | |
| 43 | ||
| 39 | 44 | div.bodywrapper { |
| 40 | margin: 0 240px 0 0; | |
| 45 | margin: 0 calc(230px + 10px) 0 0; | |
| 41 | 46 | border-right: 1px solid #ccc; |
| 42 | 47 | } |
| 43 | 48 | |
| 85 | 90 | } |
| 86 | 91 | |
| 87 | 92 | div.sphinxsidebar { |
| 88 | margin: 0; | |
| 89 | 93 | padding: 0.5em 15px 15px 0; |
| 90 | width: 210px; | |
| 94 | width: calc(230px - 20px); | |
| 91 | 95 | float: right; |
| 92 | 96 | font-size: 1em; |
| 93 | 97 | text-align: left; |
| 133 | 137 | |
| 134 | 138 | /* -- body styles ----------------------------------------------------------- */ |
| 135 | 139 | |
| 136 | p { | |
| 140 | p { | |
| 137 | 141 | margin: 0.8em 0 0.5em 0; |
| 138 | 142 | } |
| 139 | 143 | |
| 242 | 246 | line-height: 120%; |
| 243 | 247 | padding: 0.5em; |
| 244 | 248 | border: 1px solid #ccc; |
| 245 | background-color: #f8f8f8; | |
| 246 | 249 | } |
| 247 | 250 | |
| 248 | 251 | pre a { |
| 0 | // Underscore.js 1.3.1 | |
| 1 | // (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc. | |
| 2 | // Underscore is freely distributable under the MIT license. | |
| 3 | // Portions of Underscore are inspired or borrowed from Prototype, | |
| 4 | // Oliver Steele's Functional, and John Resig's Micro-Templating. | |
| 5 | // For all details and documentation: | |
| 6 | // http://documentcloud.github.com/underscore | |
| 7 | ||
| 8 | (function() { | |
| 9 | ||
| 10 | // Baseline setup | |
| 11 | // -------------- | |
| 12 | ||
| 13 | // Establish the root object, `window` in the browser, or `global` on the server. | |
| 14 | var root = this; | |
| 15 | ||
| 16 | // Save the previous value of the `_` variable. | |
| 17 | var previousUnderscore = root._; | |
| 18 | ||
| 19 | // Establish the object that gets returned to break out of a loop iteration. | |
| 20 | var breaker = {}; | |
| 21 | ||
| 22 | // Save bytes in the minified (but not gzipped) version: | |
| 23 | var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype; | |
| 24 | ||
| 25 | // Create quick reference variables for speed access to core prototypes. | |
| 26 | var slice = ArrayProto.slice, | |
| 27 | unshift = ArrayProto.unshift, | |
| 28 | toString = ObjProto.toString, | |
| 29 | hasOwnProperty = ObjProto.hasOwnProperty; | |
| 30 | ||
| 31 | // All **ECMAScript 5** native function implementations that we hope to use | |
| 32 | // are declared here. | |
| 33 | var | |
| 34 | nativeForEach = ArrayProto.forEach, | |
| 35 | nativeMap = ArrayProto.map, | |
| 36 | nativeReduce = ArrayProto.reduce, | |
| 37 | nativeReduceRight = ArrayProto.reduceRight, | |
| 38 | nativeFilter = ArrayProto.filter, | |
| 39 | nativeEvery = ArrayProto.every, | |
| 40 | nativeSome = ArrayProto.some, | |
| 41 | nativeIndexOf = ArrayProto.indexOf, | |
| 42 | nativeLastIndexOf = ArrayProto.lastIndexOf, | |
| 43 | nativeIsArray = Array.isArray, | |
| 44 | nativeKeys = Object.keys, | |
| 45 | nativeBind = FuncProto.bind; | |
| 46 | ||
| 47 | // Create a safe reference to the Underscore object for use below. | |
| 48 | var _ = function(obj) { return new wrapper(obj); }; | |
| 49 | ||
| 50 | // Export the Underscore object for **Node.js**, with | |
| 51 | // backwards-compatibility for the old `require()` API. If we're in | |
| 52 | // the browser, add `_` as a global object via a string identifier, | |
| 53 | // for Closure Compiler "advanced" mode. | |
| 54 | if (typeof exports !== 'undefined') { | |
| 55 | if (typeof module !== 'undefined' && module.exports) { | |
| 56 | exports = module.exports = _; | |
| 57 | } | |
| 58 | exports._ = _; | |
| 59 | } else { | |
| 60 | root['_'] = _; | |
| 61 | } | |
| 62 | ||
| 63 | // Current version. | |
| 64 | _.VERSION = '1.3.1'; | |
| 65 | ||
| 66 | // Collection Functions | |
| 67 | // -------------------- | |
| 68 | ||
| 69 | // The cornerstone, an `each` implementation, aka `forEach`. | |
| 70 | // Handles objects with the built-in `forEach`, arrays, and raw objects. | |
| 71 | // Delegates to **ECMAScript 5**'s native `forEach` if available. | |
| 72 | var each = _.each = _.forEach = function(obj, iterator, context) { | |
| 73 | if (obj == null) return; | |
| 74 | if (nativeForEach && obj.forEach === nativeForEach) { | |
| 75 | obj.forEach(iterator, context); | |
| 76 | } else if (obj.length === +obj.length) { | |
| 77 | for (var i = 0, l = obj.length; i < l; i++) { | |
| 78 | if (i in obj && iterator.call(context, obj[i], i, obj) === breaker) return; | |
| 79 | } | |
| 80 | } else { | |
| 81 | for (var key in obj) { | |
| 82 | if (_.has(obj, key)) { | |
| 83 | if (iterator.call(context, obj[key], key, obj) === breaker) return; | |
| 84 | } | |
| 85 | } | |
| 86 | } | |
| 87 | }; | |
| 88 | ||
| 89 | // Return the results of applying the iterator to each element. | |
| 90 | // Delegates to **ECMAScript 5**'s native `map` if available. | |
| 91 | _.map = _.collect = function(obj, iterator, context) { | |
| 92 | var results = []; | |
| 93 | if (obj == null) return results; | |
| 94 | if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context); | |
| 95 | each(obj, function(value, index, list) { | |
| 96 | results[results.length] = iterator.call(context, value, index, list); | |
| 97 | }); | |
| 98 | if (obj.length === +obj.length) results.length = obj.length; | |
| 99 | return results; | |
| 100 | }; | |
| 101 | ||
| 102 | // **Reduce** builds up a single result from a list of values, aka `inject`, | |
| 103 | // or `foldl`. Delegates to **ECMAScript 5**'s native `reduce` if available. | |
| 104 | _.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) { | |
| 105 | var initial = arguments.length > 2; | |
| 106 | if (obj == null) obj = []; | |
| 107 | if (nativeReduce && obj.reduce === nativeReduce) { | |
| 108 | if (context) iterator = _.bind(iterator, context); | |
| 109 | return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator); | |
| 110 | } | |
| 111 | each(obj, function(value, index, list) { | |
| 112 | if (!initial) { | |
| 113 | memo = value; | |
| 114 | initial = true; | |
| 115 | } else { | |
| 116 | memo = iterator.call(context, memo, value, index, list); | |
| 117 | } | |
| 118 | }); | |
| 119 | if (!initial) throw new TypeError('Reduce of empty array with no initial value'); | |
| 120 | return memo; | |
| 121 | }; | |
| 122 | ||
| 123 | // The right-associative version of reduce, also known as `foldr`. | |
| 124 | // Delegates to **ECMAScript 5**'s native `reduceRight` if available. | |
| 125 | _.reduceRight = _.foldr = function(obj, iterator, memo, context) { | |
| 126 | var initial = arguments.length > 2; | |
| 127 | if (obj == null) obj = []; | |
| 128 | if (nativeReduceRight && obj.reduceRight === nativeReduceRight) { | |
| 129 | if (context) iterator = _.bind(iterator, context); | |
| 130 | return initial ? obj.reduceRight(iterator, memo) : obj.reduceRight(iterator); | |
| 131 | } | |
| 132 | var reversed = _.toArray(obj).reverse(); | |
| 133 | if (context && !initial) iterator = _.bind(iterator, context); | |
| 134 | return initial ? _.reduce(reversed, iterator, memo, context) : _.reduce(reversed, iterator); | |
| 135 | }; | |
| 136 | ||
| 137 | // Return the first value which passes a truth test. Aliased as `detect`. | |
| 138 | _.find = _.detect = function(obj, iterator, context) { | |
| 139 | var result; | |
| 140 | any(obj, function(value, index, list) { | |
| 141 | if (iterator.call(context, value, index, list)) { | |
| 142 | result = value; | |
| 143 | return true; | |
| 144 | } | |
| 145 | }); | |
| 146 | return result; | |
| 147 | }; | |
| 148 | ||
| 149 | // Return all the elements that pass a truth test. | |
| 150 | // Delegates to **ECMAScript 5**'s native `filter` if available. | |
| 151 | // Aliased as `select`. | |
| 152 | _.filter = _.select = function(obj, iterator, context) { | |
| 153 | var results = []; | |
| 154 | if (obj == null) return results; | |
| 155 | if (nativeFilter && obj.filter === nativeFilter) return obj.filter(iterator, context); | |
| 156 | each(obj, function(value, index, list) { | |
| 157 | if (iterator.call(context, value, index, list)) results[results.length] = value; | |
| 158 | }); | |
| 159 | return results; | |
| 160 | }; | |
| 161 | ||
| 162 | // Return all the elements for which a truth test fails. | |
| 163 | _.reject = function(obj, iterator, context) { | |
| 164 | var results = []; | |
| 165 | if (obj == null) return results; | |
| 166 | each(obj, function(value, index, list) { | |
| 167 | if (!iterator.call(context, value, index, list)) results[results.length] = value; | |
| 168 | }); | |
| 169 | return results; | |
| 170 | }; | |
| 171 | ||
| 172 | // Determine whether all of the elements match a truth test. | |
| 173 | // Delegates to **ECMAScript 5**'s native `every` if available. | |
| 174 | // Aliased as `all`. | |
| 175 | _.every = _.all = function(obj, iterator, context) { | |
| 176 | var result = true; | |
| 177 | if (obj == null) return result; | |
| 178 | if (nativeEvery && obj.every === nativeEvery) return obj.every(iterator, context); | |
| 179 | each(obj, function(value, index, list) { | |
| 180 | if (!(result = result && iterator.call(context, value, index, list))) return breaker; | |
| 181 | }); | |
| 182 | return result; | |
| 183 | }; | |
| 184 | ||
| 185 | // Determine if at least one element in the object matches a truth test. | |
| 186 | // Delegates to **ECMAScript 5**'s native `some` if available. | |
| 187 | // Aliased as `any`. | |
| 188 | var any = _.some = _.any = function(obj, iterator, context) { | |
| 189 | iterator || (iterator = _.identity); | |
| 190 | var result = false; | |
| 191 | if (obj == null) return result; | |
| 192 | if (nativeSome && obj.some === nativeSome) return obj.some(iterator, context); | |
| 193 | each(obj, function(value, index, list) { | |
| 194 | if (result || (result = iterator.call(context, value, index, list))) return breaker; | |
| 195 | }); | |
| 196 | return !!result; | |
| 197 | }; | |
| 198 | ||
| 199 | // Determine if a given value is included in the array or object using `===`. | |
| 200 | // Aliased as `contains`. | |
| 201 | _.include = _.contains = function(obj, target) { | |
| 202 | var found = false; | |
| 203 | if (obj == null) return found; | |
| 204 | if (nativeIndexOf && obj.indexOf === nativeIndexOf) return obj.indexOf(target) != -1; | |
| 205 | found = any(obj, function(value) { | |
| 206 | return value === target; | |
| 207 | }); | |
| 208 | return found; | |
| 209 | }; | |
| 210 | ||
| 211 | // Invoke a method (with arguments) on every item in a collection. | |
| 212 | _.invoke = function(obj, method) { | |
| 213 | var args = slice.call(arguments, 2); | |
| 214 | return _.map(obj, function(value) { | |
| 215 | return (_.isFunction(method) ? method || value : value[method]).apply(value, args); | |
| 216 | }); | |
| 217 | }; | |
| 218 | ||
| 219 | // Convenience version of a common use case of `map`: fetching a property. | |
| 220 | _.pluck = function(obj, key) { | |
| 221 | return _.map(obj, function(value){ return value[key]; }); | |
| 222 | }; | |
| 223 | ||
| 224 | // Return the maximum element or (element-based computation). | |
| 225 | _.max = function(obj, iterator, context) { | |
| 226 | if (!iterator && _.isArray(obj)) return Math.max.apply(Math, obj); | |
| 227 | if (!iterator && _.isEmpty(obj)) return -Infinity; | |
| 228 | var result = {computed : -Infinity}; | |
| 229 | each(obj, function(value, index, list) { | |
| 230 | var computed = iterator ? iterator.call(context, value, index, list) : value; | |
| 231 | computed >= result.computed && (result = {value : value, computed : computed}); | |
| 232 | }); | |
| 233 | return result.value; | |
| 234 | }; | |
| 235 | ||
| 236 | // Return the minimum element (or element-based computation). | |
| 237 | _.min = function(obj, iterator, context) { | |
| 238 | if (!iterator && _.isArray(obj)) return Math.min.apply(Math, obj); | |
| 239 | if (!iterator && _.isEmpty(obj)) return Infinity; | |
| 240 | var result = {computed : Infinity}; | |
| 241 | each(obj, function(value, index, list) { | |
| 242 | var computed = iterator ? iterator.call(context, value, index, list) : value; | |
| 243 | computed < result.computed && (result = {value : value, computed : computed}); | |
| 244 | }); | |
| 245 | return result.value; | |
| 246 | }; | |
| 247 | ||
| 248 | // Shuffle an array. | |
| 249 | _.shuffle = function(obj) { | |
| 250 | var shuffled = [], rand; | |
| 251 | each(obj, function(value, index, list) { | |
| 252 | if (index == 0) { | |
| 253 | shuffled[0] = value; | |
| 254 | } else { | |
| 255 | rand = Math.floor(Math.random() * (index + 1)); | |
| 256 | shuffled[index] = shuffled[rand]; | |
| 257 | shuffled[rand] = value; | |
| 258 | } | |
| 259 | }); | |
| 260 | return shuffled; | |
| 261 | }; | |
| 262 | ||
| 263 | // Sort the object's values by a criterion produced by an iterator. | |
| 264 | _.sortBy = function(obj, iterator, context) { | |
| 265 | return _.pluck(_.map(obj, function(value, index, list) { | |
| 266 | return { | |
| 267 | value : value, | |
| 268 | criteria : iterator.call(context, value, index, list) | |
| 269 | }; | |
| 270 | }).sort(function(left, right) { | |
| 271 | var a = left.criteria, b = right.criteria; | |
| 272 | return a < b ? -1 : a > b ? 1 : 0; | |
| 273 | }), 'value'); | |
| 274 | }; | |
| 275 | ||
| 276 | // Groups the object's values by a criterion. Pass either a string attribute | |
| 277 | // to group by, or a function that returns the criterion. | |
| 278 | _.groupBy = function(obj, val) { | |
| 279 | var result = {}; | |
| 280 | var iterator = _.isFunction(val) ? val : function(obj) { return obj[val]; }; | |
| 281 | each(obj, function(value, index) { | |
| 282 | var key = iterator(value, index); | |
| 283 | (result[key] || (result[key] = [])).push(value); | |
| 284 | }); | |
| 285 | return result; | |
| 286 | }; | |
| 287 | ||
| 288 | // Use a comparator function to figure out at what index an object should | |
| 289 | // be inserted so as to maintain order. Uses binary search. | |
| 290 | _.sortedIndex = function(array, obj, iterator) { | |
| 291 | iterator || (iterator = _.identity); | |
| 292 | var low = 0, high = array.length; | |
| 293 | while (low < high) { | |
| 294 | var mid = (low + high) >> 1; | |
| 295 | iterator(array[mid]) < iterator(obj) ? low = mid + 1 : high = mid; | |
| 296 | } | |
| 297 | return low; | |
| 298 | }; | |
| 299 | ||
| 300 | // Safely convert anything iterable into a real, live array. | |
| 301 | _.toArray = function(iterable) { | |
| 302 | if (!iterable) return []; | |
| 303 | if (iterable.toArray) return iterable.toArray(); | |
| 304 | if (_.isArray(iterable)) return slice.call(iterable); | |
| 305 | if (_.isArguments(iterable)) return slice.call(iterable); | |
| 306 | return _.values(iterable); | |
| 307 | }; | |
| 308 | ||
| 309 | // Return the number of elements in an object. | |
| 310 | _.size = function(obj) { | |
| 311 | return _.toArray(obj).length; | |
| 312 | }; | |
| 313 | ||
| 314 | // Array Functions | |
| 315 | // --------------- | |
| 316 | ||
| 317 | // Get the first element of an array. Passing **n** will return the first N | |
| 318 | // values in the array. Aliased as `head`. The **guard** check allows it to work | |
| 319 | // with `_.map`. | |
| 320 | _.first = _.head = function(array, n, guard) { | |
| 321 | return (n != null) && !guard ? slice.call(array, 0, n) : array[0]; | |
| 322 | }; | |
| 323 | ||
| 324 | // Returns everything but the last entry of the array. Especcialy useful on | |
| 325 | // the arguments object. Passing **n** will return all the values in | |
| 326 | // the array, excluding the last N. The **guard** check allows it to work with | |
| 327 | // `_.map`. | |
| 328 | _.initial = function(array, n, guard) { | |
| 329 | return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n)); | |
| 330 | }; | |
| 331 | ||
| 332 | // Get the last element of an array. Passing **n** will return the last N | |
| 333 | // values in the array. The **guard** check allows it to work with `_.map`. | |
| 334 | _.last = function(array, n, guard) { | |
| 335 | if ((n != null) && !guard) { | |
| 336 | return slice.call(array, Math.max(array.length - n, 0)); | |
| 337 | } else { | |
| 338 | return array[array.length - 1]; | |
| 339 | } | |
| 340 | }; | |
| 341 | ||
| 342 | // Returns everything but the first entry of the array. Aliased as `tail`. | |
| 343 | // Especially useful on the arguments object. Passing an **index** will return | |
| 344 | // the rest of the values in the array from that index onward. The **guard** | |
| 345 | // check allows it to work with `_.map`. | |
| 346 | _.rest = _.tail = function(array, index, guard) { | |
| 347 | return slice.call(array, (index == null) || guard ? 1 : index); | |
| 348 | }; | |
| 349 | ||
| 350 | // Trim out all falsy values from an array. | |
| 351 | _.compact = function(array) { | |
| 352 | return _.filter(array, function(value){ return !!value; }); | |
| 353 | }; | |
| 354 | ||
| 355 | // Return a completely flattened version of an array. | |
| 356 | _.flatten = function(array, shallow) { | |
| 357 | return _.reduce(array, function(memo, value) { | |
| 358 | if (_.isArray(value)) return memo.concat(shallow ? value : _.flatten(value)); | |
| 359 | memo[memo.length] = value; | |
| 360 | return memo; | |
| 361 | }, []); | |
| 362 | }; | |
| 363 | ||
| 364 | // Return a version of the array that does not contain the specified value(s). | |
| 365 | _.without = function(array) { | |
| 366 | return _.difference(array, slice.call(arguments, 1)); | |
| 367 | }; | |
| 368 | ||
| 369 | // Produce a duplicate-free version of the array. If the array has already | |
| 370 | // been sorted, you have the option of using a faster algorithm. | |
| 371 | // Aliased as `unique`. | |
| 372 | _.uniq = _.unique = function(array, isSorted, iterator) { | |
| 373 | var initial = iterator ? _.map(array, iterator) : array; | |
| 374 | var result = []; | |
| 375 | _.reduce(initial, function(memo, el, i) { | |
| 376 | if (0 == i || (isSorted === true ? _.last(memo) != el : !_.include(memo, el))) { | |
| 377 | memo[memo.length] = el; | |
| 378 | result[result.length] = array[i]; | |
| 379 | } | |
| 380 | return memo; | |
| 381 | }, []); | |
| 382 | return result; | |
| 383 | }; | |
| 384 | ||
| 385 | // Produce an array that contains the union: each distinct element from all of | |
| 386 | // the passed-in arrays. | |
| 387 | _.union = function() { | |
| 388 | return _.uniq(_.flatten(arguments, true)); | |
| 389 | }; | |
| 390 | ||
| 391 | // Produce an array that contains every item shared between all the | |
| 392 | // passed-in arrays. (Aliased as "intersect" for back-compat.) | |
| 393 | _.intersection = _.intersect = function(array) { | |
| 394 | var rest = slice.call(arguments, 1); | |
| 395 | return _.filter(_.uniq(array), function(item) { | |
| 396 | return _.every(rest, function(other) { | |
| 397 | return _.indexOf(other, item) >= 0; | |
| 398 | }); | |
| 399 | }); | |
| 400 | }; | |
| 401 | ||
| 402 | // Take the difference between one array and a number of other arrays. | |
| 403 | // Only the elements present in just the first array will remain. | |
| 404 | _.difference = function(array) { | |
| 405 | var rest = _.flatten(slice.call(arguments, 1)); | |
| 406 | return _.filter(array, function(value){ return !_.include(rest, value); }); | |
| 407 | }; | |
| 408 | ||
| 409 | // Zip together multiple lists into a single array -- elements that share | |
| 410 | // an index go together. | |
| 411 | _.zip = function() { | |
| 412 | var args = slice.call(arguments); | |
| 413 | var length = _.max(_.pluck(args, 'length')); | |
| 414 | var results = new Array(length); | |
| 415 | for (var i = 0; i < length; i++) results[i] = _.pluck(args, "" + i); | |
| 416 | return results; | |
| 417 | }; | |
| 418 | ||
| 419 | // If the browser doesn't supply us with indexOf (I'm looking at you, **MSIE**), | |
| 420 | // we need this function. Return the position of the first occurrence of an | |
| 421 | // item in an array, or -1 if the item is not included in the array. | |
| 422 | // Delegates to **ECMAScript 5**'s native `indexOf` if available. | |
| 423 | // If the array is large and already in sort order, pass `true` | |
| 424 | // for **isSorted** to use binary search. | |
| 425 | _.indexOf = function(array, item, isSorted) { | |
| 426 | if (array == null) return -1; | |
| 427 | var i, l; | |
| 428 | if (isSorted) { | |
| 429 | i = _.sortedIndex(array, item); | |
| 430 | return array[i] === item ? i : -1; | |
| 431 | } | |
| 432 | if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item); | |
| 433 | for (i = 0, l = array.length; i < l; i++) if (i in array && array[i] === item) return i; | |
| 434 | return -1; | |
| 435 | }; | |
| 436 | ||
| 437 | // Delegates to **ECMAScript 5**'s native `lastIndexOf` if available. | |
| 438 | _.lastIndexOf = function(array, item) { | |
| 439 | if (array == null) return -1; | |
| 440 | if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) return array.lastIndexOf(item); | |
| 441 | var i = array.length; | |
| 442 | while (i--) if (i in array && array[i] === item) return i; | |
| 443 | return -1; | |
| 444 | }; | |
| 445 | ||
| 446 | // Generate an integer Array containing an arithmetic progression. A port of | |
| 447 | // the native Python `range()` function. See | |
| 448 | // [the Python documentation](http://docs.python.org/library/functions.html#range). | |
| 449 | _.range = function(start, stop, step) { | |
| 450 | if (arguments.length <= 1) { | |
| 451 | stop = start || 0; | |
| 452 | start = 0; | |
| 453 | } | |
| 454 | step = arguments[2] || 1; | |
| 455 | ||
| 456 | var len = Math.max(Math.ceil((stop - start) / step), 0); | |
| 457 | var idx = 0; | |
| 458 | var range = new Array(len); | |
| 459 | ||
| 460 | while(idx < len) { | |
| 461 | range[idx++] = start; | |
| 462 | start += step; | |
| 463 | } | |
| 464 | ||
| 465 | return range; | |
| 466 | }; | |
| 467 | ||
| 468 | // Function (ahem) Functions | |
| 469 | // ------------------ | |
| 470 | ||
| 471 | // Reusable constructor function for prototype setting. | |
| 472 | var ctor = function(){}; | |
| 473 | ||
| 474 | // Create a function bound to a given object (assigning `this`, and arguments, | |
| 475 | // optionally). Binding with arguments is also known as `curry`. | |
| 476 | // Delegates to **ECMAScript 5**'s native `Function.bind` if available. | |
| 477 | // We check for `func.bind` first, to fail fast when `func` is undefined. | |
| 478 | _.bind = function bind(func, context) { | |
| 479 | var bound, args; | |
| 480 | if (func.bind === nativeBind && nativeBind) return nativeBind.apply(func, slice.call(arguments, 1)); | |
| 481 | if (!_.isFunction(func)) throw new TypeError; | |
| 482 | args = slice.call(arguments, 2); | |
| 483 | return bound = function() { | |
| 484 | if (!(this instanceof bound)) return func.apply(context, args.concat(slice.call(arguments))); | |
| 485 | ctor.prototype = func.prototype; | |
| 486 | var self = new ctor; | |
| 487 | var result = func.apply(self, args.concat(slice.call(arguments))); | |
| 488 | if (Object(result) === result) return result; | |
| 489 | return self; | |
| 490 | }; | |
| 491 | }; | |
| 492 | ||
| 493 | // Bind all of an object's methods to that object. Useful for ensuring that | |
| 494 | // all callbacks defined on an object belong to it. | |
| 495 | _.bindAll = function(obj) { | |
| 496 | var funcs = slice.call(arguments, 1); | |
| 497 | if (funcs.length == 0) funcs = _.functions(obj); | |
| 498 | each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); }); | |
| 499 | return obj; | |
| 500 | }; | |
| 501 | ||
| 502 | // Memoize an expensive function by storing its results. | |
| 503 | _.memoize = function(func, hasher) { | |
| 504 | var memo = {}; | |
| 505 | hasher || (hasher = _.identity); | |
| 506 | return function() { | |
| 507 | var key = hasher.apply(this, arguments); | |
| 508 | return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments)); | |
| 509 | }; | |
| 510 | }; | |
| 511 | ||
| 512 | // Delays a function for the given number of milliseconds, and then calls | |
| 513 | // it with the arguments supplied. | |
| 514 | _.delay = function(func, wait) { | |
| 515 | var args = slice.call(arguments, 2); | |
| 516 | return setTimeout(function(){ return func.apply(func, args); }, wait); | |
| 517 | }; | |
| 518 | ||
| 519 | // Defers a function, scheduling it to run after the current call stack has | |
| 520 | // cleared. | |
| 521 | _.defer = function(func) { | |
| 522 | return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1))); | |
| 523 | }; | |
| 524 | ||
| 525 | // Returns a function, that, when invoked, will only be triggered at most once | |
| 526 | // during a given window of time. | |
| 527 | _.throttle = function(func, wait) { | |
| 528 | var context, args, timeout, throttling, more; | |
| 529 | var whenDone = _.debounce(function(){ more = throttling = false; }, wait); | |
| 530 | return function() { | |
| 531 | context = this; args = arguments; | |
| 532 | var later = function() { | |
| 533 | timeout = null; | |
| 534 | if (more) func.apply(context, args); | |
| 535 | whenDone(); | |
| 536 | }; | |
| 537 | if (!timeout) timeout = setTimeout(later, wait); | |
| 538 | if (throttling) { | |
| 539 | more = true; | |
| 540 | } else { | |
| 541 | func.apply(context, args); | |
| 542 | } | |
| 543 | whenDone(); | |
| 544 | throttling = true; | |
| 545 | }; | |
| 546 | }; | |
| 547 | ||
| 548 | // Returns a function, that, as long as it continues to be invoked, will not | |
| 549 | // be triggered. The function will be called after it stops being called for | |
| 550 | // N milliseconds. | |
| 551 | _.debounce = function(func, wait) { | |
| 552 | var timeout; | |
| 553 | return function() { | |
| 554 | var context = this, args = arguments; | |
| 555 | var later = function() { | |
| 556 | timeout = null; | |
| 557 | func.apply(context, args); | |
| 558 | }; | |
| 559 | clearTimeout(timeout); | |
| 560 | timeout = setTimeout(later, wait); | |
| 561 | }; | |
| 562 | }; | |
| 563 | ||
| 564 | // Returns a function that will be executed at most one time, no matter how | |
| 565 | // often you call it. Useful for lazy initialization. | |
| 566 | _.once = function(func) { | |
| 567 | var ran = false, memo; | |
| 568 | return function() { | |
| 569 | if (ran) return memo; | |
| 570 | ran = true; | |
| 571 | return memo = func.apply(this, arguments); | |
| 572 | }; | |
| 573 | }; | |
| 574 | ||
| 575 | // Returns the first function passed as an argument to the second, | |
| 576 | // allowing you to adjust arguments, run code before and after, and | |
| 577 | // conditionally execute the original function. | |
| 578 | _.wrap = function(func, wrapper) { | |
| 579 | return function() { | |
| 580 | var args = [func].concat(slice.call(arguments, 0)); | |
| 581 | return wrapper.apply(this, args); | |
| 582 | }; | |
| 583 | }; | |
| 584 | ||
| 585 | // Returns a function that is the composition of a list of functions, each | |
| 586 | // consuming the return value of the function that follows. | |
| 587 | _.compose = function() { | |
| 588 | var funcs = arguments; | |
| 589 | return function() { | |
| 590 | var args = arguments; | |
| 591 | for (var i = funcs.length - 1; i >= 0; i--) { | |
| 592 | args = [funcs[i].apply(this, args)]; | |
| 593 | } | |
| 594 | return args[0]; | |
| 595 | }; | |
| 596 | }; | |
| 597 | ||
| 598 | // Returns a function that will only be executed after being called N times. | |
| 599 | _.after = function(times, func) { | |
| 600 | if (times <= 0) return func(); | |
| 601 | return function() { | |
| 602 | if (--times < 1) { return func.apply(this, arguments); } | |
| 603 | }; | |
| 604 | }; | |
| 605 | ||
| 606 | // Object Functions | |
| 607 | // ---------------- | |
| 608 | ||
| 609 | // Retrieve the names of an object's properties. | |
| 610 | // Delegates to **ECMAScript 5**'s native `Object.keys` | |
| 611 | _.keys = nativeKeys || function(obj) { | |
| 612 | if (obj !== Object(obj)) throw new TypeError('Invalid object'); | |
| 613 | var keys = []; | |
| 614 | for (var key in obj) if (_.has(obj, key)) keys[keys.length] = key; | |
| 615 | return keys; | |
| 616 | }; | |
| 617 | ||
| 618 | // Retrieve the values of an object's properties. | |
| 619 | _.values = function(obj) { | |
| 620 | return _.map(obj, _.identity); | |
| 621 | }; | |
| 622 | ||
| 623 | // Return a sorted list of the function names available on the object. | |
| 624 | // Aliased as `methods` | |
| 625 | _.functions = _.methods = function(obj) { | |
| 626 | var names = []; | |
| 627 | for (var key in obj) { | |
| 628 | if (_.isFunction(obj[key])) names.push(key); | |
| 629 | } | |
| 630 | return names.sort(); | |
| 631 | }; | |
| 632 | ||
| 633 | // Extend a given object with all the properties in passed-in object(s). | |
| 634 | _.extend = function(obj) { | |
| 635 | each(slice.call(arguments, 1), function(source) { | |
| 636 | for (var prop in source) { | |
| 637 | obj[prop] = source[prop]; | |
| 638 | } | |
| 639 | }); | |
| 640 | return obj; | |
| 641 | }; | |
| 642 | ||
| 643 | // Fill in a given object with default properties. | |
| 644 | _.defaults = function(obj) { | |
| 645 | each(slice.call(arguments, 1), function(source) { | |
| 646 | for (var prop in source) { | |
| 647 | if (obj[prop] == null) obj[prop] = source[prop]; | |
| 648 | } | |
| 649 | }); | |
| 650 | return obj; | |
| 651 | }; | |
| 652 | ||
| 653 | // Create a (shallow-cloned) duplicate of an object. | |
| 654 | _.clone = function(obj) { | |
| 655 | if (!_.isObject(obj)) return obj; | |
| 656 | return _.isArray(obj) ? obj.slice() : _.extend({}, obj); | |
| 657 | }; | |
| 658 | ||
| 659 | // Invokes interceptor with the obj, and then returns obj. | |
| 660 | // The primary purpose of this method is to "tap into" a method chain, in | |
| 661 | // order to perform operations on intermediate results within the chain. | |
| 662 | _.tap = function(obj, interceptor) { | |
| 663 | interceptor(obj); | |
| 664 | return obj; | |
| 665 | }; | |
| 666 | ||
| 667 | // Internal recursive comparison function. | |
| 668 | function eq(a, b, stack) { | |
| 669 | // Identical objects are equal. `0 === -0`, but they aren't identical. | |
| 670 | // See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal. | |
| 671 | if (a === b) return a !== 0 || 1 / a == 1 / b; | |
| 672 | // A strict comparison is necessary because `null == undefined`. | |
| 673 | if (a == null || b == null) return a === b; | |
| 674 | // Unwrap any wrapped objects. | |
| 675 | if (a._chain) a = a._wrapped; | |
| 676 | if (b._chain) b = b._wrapped; | |
| 677 | // Invoke a custom `isEqual` method if one is provided. | |
| 678 | if (a.isEqual && _.isFunction(a.isEqual)) return a.isEqual(b); | |
| 679 | if (b.isEqual && _.isFunction(b.isEqual)) return b.isEqual(a); | |
| 680 | // Compare `[[Class]]` names. | |
| 681 | var className = toString.call(a); | |
| 682 | if (className != toString.call(b)) return false; | |
| 683 | switch (className) { | |
| 684 | // Strings, numbers, dates, and booleans are compared by value. | |
| 685 | case '[object String]': | |
| 686 | // Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is | |
| 687 | // equivalent to `new String("5")`. | |
| 688 | return a == String(b); | |
| 689 | case '[object Number]': | |
| 690 | // `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for | |
| 691 | // other numeric values. | |
| 692 | return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b); | |
| 693 | case '[object Date]': | |
| 694 | case '[object Boolean]': | |
| 695 | // Coerce dates and booleans to numeric primitive values. Dates are compared by their | |
| 696 | // millisecond representations. Note that invalid dates with millisecond representations | |
| 697 | // of `NaN` are not equivalent. | |
| 698 | return +a == +b; | |
| 699 | // RegExps are compared by their source patterns and flags. | |
| 700 | case '[object RegExp]': | |
| 701 | return a.source == b.source && | |
| 702 | a.global == b.global && | |
| 703 | a.multiline == b.multiline && | |
| 704 | a.ignoreCase == b.ignoreCase; | |
| 705 | } | |
| 706 | if (typeof a != 'object' || typeof b != 'object') return false; | |
| 707 | // Assume equality for cyclic structures. The algorithm for detecting cyclic | |
| 708 | // structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`. | |
| 709 | var length = stack.length; | |
| 710 | while (length--) { | |
| 711 | // Linear search. Performance is inversely proportional to the number of | |
| 712 | // unique nested structures. | |
| 713 | if (stack[length] == a) return true; | |
| 714 | } | |
| 715 | // Add the first object to the stack of traversed objects. | |
| 716 | stack.push(a); | |
| 717 | var size = 0, result = true; | |
| 718 | // Recursively compare objects and arrays. | |
| 719 | if (className == '[object Array]') { | |
| 720 | // Compare array lengths to determine if a deep comparison is necessary. | |
| 721 | size = a.length; | |
| 722 | result = size == b.length; | |
| 723 | if (result) { | |
| 724 | // Deep compare the contents, ignoring non-numeric properties. | |
| 725 | while (size--) { | |
| 726 | // Ensure commutative equality for sparse arrays. | |
| 727 | if (!(result = size in a == size in b && eq(a[size], b[size], stack))) break; | |
| 728 | } | |
| 729 | } | |
| 730 | } else { | |
| 731 | // Objects with different constructors are not equivalent. | |
| 732 | if ('constructor' in a != 'constructor' in b || a.constructor != b.constructor) return false; | |
| 733 | // Deep compare objects. | |
| 734 | for (var key in a) { | |
| 735 | if (_.has(a, key)) { | |
| 736 | // Count the expected number of properties. | |
| 737 | size++; | |
| 738 | // Deep compare each member. | |
| 739 | if (!(result = _.has(b, key) && eq(a[key], b[key], stack))) break; | |
| 740 | } | |
| 741 | } | |
| 742 | // Ensure that both objects contain the same number of properties. | |
| 743 | if (result) { | |
| 744 | for (key in b) { | |
| 745 | if (_.has(b, key) && !(size--)) break; | |
| 746 | } | |
| 747 | result = !size; | |
| 748 | } | |
| 749 | } | |
| 750 | // Remove the first object from the stack of traversed objects. | |
| 751 | stack.pop(); | |
| 752 | return result; | |
| 753 | } | |
| 754 | ||
| 755 | // Perform a deep comparison to check if two objects are equal. | |
| 756 | _.isEqual = function(a, b) { | |
| 757 | return eq(a, b, []); | |
| 758 | }; | |
| 759 | ||
| 760 | // Is a given array, string, or object empty? | |
| 761 | // An "empty" object has no enumerable own-properties. | |
| 762 | _.isEmpty = function(obj) { | |
| 763 | if (_.isArray(obj) || _.isString(obj)) return obj.length === 0; | |
| 764 | for (var key in obj) if (_.has(obj, key)) return false; | |
| 765 | return true; | |
| 766 | }; | |
| 767 | ||
| 768 | // Is a given value a DOM element? | |
| 769 | _.isElement = function(obj) { | |
| 770 | return !!(obj && obj.nodeType == 1); | |
| 771 | }; | |
| 772 | ||
| 773 | // Is a given value an array? | |
| 774 | // Delegates to ECMA5's native Array.isArray | |
| 775 | _.isArray = nativeIsArray || function(obj) { | |
| 776 | return toString.call(obj) == '[object Array]'; | |
| 777 | }; | |
| 778 | ||
| 779 | // Is a given variable an object? | |
| 780 | _.isObject = function(obj) { | |
| 781 | return obj === Object(obj); | |
| 782 | }; | |
| 783 | ||
| 784 | // Is a given variable an arguments object? | |
| 785 | _.isArguments = function(obj) { | |
| 786 | return toString.call(obj) == '[object Arguments]'; | |
| 787 | }; | |
| 788 | if (!_.isArguments(arguments)) { | |
| 789 | _.isArguments = function(obj) { | |
| 790 | return !!(obj && _.has(obj, 'callee')); | |
| 791 | }; | |
| 792 | } | |
| 793 | ||
| 794 | // Is a given value a function? | |
| 795 | _.isFunction = function(obj) { | |
| 796 | return toString.call(obj) == '[object Function]'; | |
| 797 | }; | |
| 798 | ||
| 799 | // Is a given value a string? | |
| 800 | _.isString = function(obj) { | |
| 801 | return toString.call(obj) == '[object String]'; | |
| 802 | }; | |
| 803 | ||
| 804 | // Is a given value a number? | |
| 805 | _.isNumber = function(obj) { | |
| 806 | return toString.call(obj) == '[object Number]'; | |
| 807 | }; | |
| 808 | ||
| 809 | // Is the given value `NaN`? | |
| 810 | _.isNaN = function(obj) { | |
| 811 | // `NaN` is the only value for which `===` is not reflexive. | |
| 812 | return obj !== obj; | |
| 813 | }; | |
| 814 | ||
| 815 | // Is a given value a boolean? | |
| 816 | _.isBoolean = function(obj) { | |
| 817 | return obj === true || obj === false || toString.call(obj) == '[object Boolean]'; | |
| 818 | }; | |
| 819 | ||
| 820 | // Is a given value a date? | |
| 821 | _.isDate = function(obj) { | |
| 822 | return toString.call(obj) == '[object Date]'; | |
| 823 | }; | |
| 824 | ||
| 825 | // Is the given value a regular expression? | |
| 826 | _.isRegExp = function(obj) { | |
| 827 | return toString.call(obj) == '[object RegExp]'; | |
| 828 | }; | |
| 829 | ||
| 830 | // Is a given value equal to null? | |
| 831 | _.isNull = function(obj) { | |
| 832 | return obj === null; | |
| 833 | }; | |
| 834 | ||
| 835 | // Is a given variable undefined? | |
| 836 | _.isUndefined = function(obj) { | |
| 837 | return obj === void 0; | |
| 838 | }; | |
| 839 | ||
| 840 | // Has own property? | |
| 841 | _.has = function(obj, key) { | |
| 842 | return hasOwnProperty.call(obj, key); | |
| 843 | }; | |
| 844 | ||
| 845 | // Utility Functions | |
| 846 | // ----------------- | |
| 847 | ||
| 848 | // Run Underscore.js in *noConflict* mode, returning the `_` variable to its | |
| 849 | // previous owner. Returns a reference to the Underscore object. | |
| 850 | _.noConflict = function() { | |
| 851 | root._ = previousUnderscore; | |
| 852 | return this; | |
| 853 | }; | |
| 854 | ||
| 855 | // Keep the identity function around for default iterators. | |
| 856 | _.identity = function(value) { | |
| 857 | return value; | |
| 858 | }; | |
| 859 | ||
| 860 | // Run a function **n** times. | |
| 861 | _.times = function (n, iterator, context) { | |
| 862 | for (var i = 0; i < n; i++) iterator.call(context, i); | |
| 863 | }; | |
| 864 | ||
| 865 | // Escape a string for HTML interpolation. | |
| 866 | _.escape = function(string) { | |
| 867 | return (''+string).replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"').replace(/'/g, ''').replace(/\//g,'/'); | |
| 868 | }; | |
| 869 | ||
| 870 | // Add your own custom functions to the Underscore object, ensuring that | |
| 871 | // they're correctly added to the OOP wrapper as well. | |
| 872 | _.mixin = function(obj) { | |
| 873 | each(_.functions(obj), function(name){ | |
| 874 | addToWrapper(name, _[name] = obj[name]); | |
| 875 | }); | |
| 876 | }; | |
| 877 | ||
| 878 | // Generate a unique integer id (unique within the entire client session). | |
| 879 | // Useful for temporary DOM ids. | |
| 880 | var idCounter = 0; | |
| 881 | _.uniqueId = function(prefix) { | |
| 882 | var id = idCounter++; | |
| 883 | return prefix ? prefix + id : id; | |
| 884 | }; | |
| 885 | ||
| 886 | // By default, Underscore uses ERB-style template delimiters, change the | |
| 887 | // following template settings to use alternative delimiters. | |
| 888 | _.templateSettings = { | |
| 889 | evaluate : /<%([\s\S]+?)%>/g, | |
| 890 | interpolate : /<%=([\s\S]+?)%>/g, | |
| 891 | escape : /<%-([\s\S]+?)%>/g | |
| 892 | }; | |
| 893 | ||
| 894 | // When customizing `templateSettings`, if you don't want to define an | |
| 895 | // interpolation, evaluation or escaping regex, we need one that is | |
| 896 | // guaranteed not to match. | |
| 897 | var noMatch = /.^/; | |
| 898 | ||
| 899 | // Within an interpolation, evaluation, or escaping, remove HTML escaping | |
| 900 | // that had been previously added. | |
| 901 | var unescape = function(code) { | |
| 902 | return code.replace(/\\\\/g, '\\').replace(/\\'/g, "'"); | |
| 903 | }; | |
| 904 | ||
| 905 | // JavaScript micro-templating, similar to John Resig's implementation. | |
| 906 | // Underscore templating handles arbitrary delimiters, preserves whitespace, | |
| 907 | // and correctly escapes quotes within interpolated code. | |
| 908 | _.template = function(str, data) { | |
| 909 | var c = _.templateSettings; | |
| 910 | var tmpl = 'var __p=[],print=function(){__p.push.apply(__p,arguments);};' + | |
| 911 | 'with(obj||{}){__p.push(\'' + | |
| 912 | str.replace(/\\/g, '\\\\') | |
| 913 | .replace(/'/g, "\\'") | |
| 914 | .replace(c.escape || noMatch, function(match, code) { | |
| 915 | return "',_.escape(" + unescape(code) + "),'"; | |
| 916 | }) | |
| 917 | .replace(c.interpolate || noMatch, function(match, code) { | |
| 918 | return "'," + unescape(code) + ",'"; | |
| 919 | }) | |
| 920 | .replace(c.evaluate || noMatch, function(match, code) { | |
| 921 | return "');" + unescape(code).replace(/[\r\n\t]/g, ' ') + ";__p.push('"; | |
| 922 | }) | |
| 923 | .replace(/\r/g, '\\r') | |
| 924 | .replace(/\n/g, '\\n') | |
| 925 | .replace(/\t/g, '\\t') | |
| 926 | + "');}return __p.join('');"; | |
| 927 | var func = new Function('obj', '_', tmpl); | |
| 928 | if (data) return func(data, _); | |
| 929 | return function(data) { | |
| 930 | return func.call(this, data, _); | |
| 931 | }; | |
| 932 | }; | |
| 933 | ||
| 934 | // Add a "chain" function, which will delegate to the wrapper. | |
| 935 | _.chain = function(obj) { | |
| 936 | return _(obj).chain(); | |
| 937 | }; | |
| 938 | ||
| 939 | // The OOP Wrapper | |
| 940 | // --------------- | |
| 941 | ||
| 942 | // If Underscore is called as a function, it returns a wrapped object that | |
| 943 | // can be used OO-style. This wrapper holds altered versions of all the | |
| 944 | // underscore functions. Wrapped objects may be chained. | |
| 945 | var wrapper = function(obj) { this._wrapped = obj; }; | |
| 946 | ||
| 947 | // Expose `wrapper.prototype` as `_.prototype` | |
| 948 | _.prototype = wrapper.prototype; | |
| 949 | ||
| 950 | // Helper function to continue chaining intermediate results. | |
| 951 | var result = function(obj, chain) { | |
| 952 | return chain ? _(obj).chain() : obj; | |
| 953 | }; | |
| 954 | ||
| 955 | // A method to easily add functions to the OOP wrapper. | |
| 956 | var addToWrapper = function(name, func) { | |
| 957 | wrapper.prototype[name] = function() { | |
| 958 | var args = slice.call(arguments); | |
| 959 | unshift.call(args, this._wrapped); | |
| 960 | return result(func.apply(_, args), this._chain); | |
| 961 | }; | |
| 962 | }; | |
| 963 | ||
| 964 | // Add all of the Underscore functions to the wrapper object. | |
| 965 | _.mixin(_); | |
| 966 | ||
| 967 | // Add all mutator Array functions to the wrapper. | |
| 968 | each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) { | |
| 969 | var method = ArrayProto[name]; | |
| 970 | wrapper.prototype[name] = function() { | |
| 971 | var wrapped = this._wrapped; | |
| 972 | method.apply(wrapped, arguments); | |
| 973 | var length = wrapped.length; | |
| 974 | if ((name == 'shift' || name == 'splice') && length === 0) delete wrapped[0]; | |
| 975 | return result(wrapped, this._chain); | |
| 976 | }; | |
| 977 | }); | |
| 978 | ||
| 979 | // Add all accessor Array functions to the wrapper. | |
| 980 | each(['concat', 'join', 'slice'], function(name) { | |
| 981 | var method = ArrayProto[name]; | |
| 982 | wrapper.prototype[name] = function() { | |
| 983 | return result(method.apply(this._wrapped, arguments), this._chain); | |
| 984 | }; | |
| 985 | }); | |
| 986 | ||
| 987 | // Start chaining a wrapped Underscore object. | |
| 988 | wrapper.prototype.chain = function() { | |
| 989 | this._chain = true; | |
| 990 | return this; | |
| 991 | }; | |
| 992 | ||
| 993 | // Extracts the result from a wrapped and chained object. | |
| 994 | wrapper.prototype.value = function() { | |
| 995 | return this._wrapped; | |
| 996 | }; | |
| 997 | ||
| 998 | }).call(this); |
| 0 | // Underscore.js 1.7.0 | |
| 1 | // http://underscorejs.org | |
| 2 | // (c) 2009-2014 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors | |
| 3 | // Underscore may be freely distributed under the MIT license. | |
| 4 | ||
| 5 | (function() { | |
| 6 | ||
| 7 | // Baseline setup | |
| 8 | // -------------- | |
| 9 | ||
| 10 | // Establish the root object, `window` in the browser, or `exports` on the server. | |
| 11 | var root = this; | |
| 12 | ||
| 13 | // Save the previous value of the `_` variable. | |
| 14 | var previousUnderscore = root._; | |
| 15 | ||
| 16 | // Save bytes in the minified (but not gzipped) version: | |
| 17 | var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype; | |
| 18 | ||
| 19 | // Create quick reference variables for speed access to core prototypes. | |
| 20 | var | |
| 21 | push = ArrayProto.push, | |
| 22 | slice = ArrayProto.slice, | |
| 23 | concat = ArrayProto.concat, | |
| 24 | toString = ObjProto.toString, | |
| 25 | hasOwnProperty = ObjProto.hasOwnProperty; | |
| 26 | ||
| 27 | // All **ECMAScript 5** native function implementations that we hope to use | |
| 28 | // are declared here. | |
| 29 | var | |
| 30 | nativeIsArray = Array.isArray, | |
| 31 | nativeKeys = Object.keys, | |
| 32 | nativeBind = FuncProto.bind; | |
| 33 | ||
| 34 | // Create a safe reference to the Underscore object for use below. | |
| 35 | var _ = function(obj) { | |
| 36 | if (obj instanceof _) return obj; | |
| 37 | if (!(this instanceof _)) return new _(obj); | |
| 38 | this._wrapped = obj; | |
| 39 | }; | |
| 40 | ||
| 41 | // Export the Underscore object for **Node.js**, with | |
| 42 | // backwards-compatibility for the old `require()` API. If we're in | |
| 43 | // the browser, add `_` as a global object. | |
| 44 | if (typeof exports !== 'undefined') { | |
| 45 | if (typeof module !== 'undefined' && module.exports) { | |
| 46 | exports = module.exports = _; | |
| 47 | } | |
| 48 | exports._ = _; | |
| 49 | } else { | |
| 50 | root._ = _; | |
| 51 | } | |
| 52 | ||
| 53 | // Current version. | |
| 54 | _.VERSION = '1.7.0'; | |
| 55 | ||
| 56 | // Internal function that returns an efficient (for current engines) version | |
| 57 | // of the passed-in callback, to be repeatedly applied in other Underscore | |
| 58 | // functions. | |
| 59 | var createCallback = function(func, context, argCount) { | |
| 60 | if (context === void 0) return func; | |
| 61 | switch (argCount == null ? 3 : argCount) { | |
| 62 | case 1: return function(value) { | |
| 63 | return func.call(context, value); | |
| 64 | }; | |
| 65 | case 2: return function(value, other) { | |
| 66 | return func.call(context, value, other); | |
| 67 | }; | |
| 68 | case 3: return function(value, index, collection) { | |
| 69 | return func.call(context, value, index, collection); | |
| 70 | }; | |
| 71 | case 4: return function(accumulator, value, index, collection) { | |
| 72 | return func.call(context, accumulator, value, index, collection); | |
| 73 | }; | |
| 74 | } | |
| 75 | return function() { | |
| 76 | return func.apply(context, arguments); | |
| 77 | }; | |
| 78 | }; | |
| 79 | ||
| 80 | // A mostly-internal function to generate callbacks that can be applied | |
| 81 | // to each element in a collection, returning the desired result — either | |
| 82 | // identity, an arbitrary callback, a property matcher, or a property accessor. | |
| 83 | _.iteratee = function(value, context, argCount) { | |
| 84 | if (value == null) return _.identity; | |
| 85 | if (_.isFunction(value)) return createCallback(value, context, argCount); | |
| 86 | if (_.isObject(value)) return _.matches(value); | |
| 87 | return _.property(value); | |
| 88 | }; | |
| 89 | ||
| 90 | // Collection Functions | |
| 91 | // -------------------- | |
| 92 | ||
| 93 | // The cornerstone, an `each` implementation, aka `forEach`. | |
| 94 | // Handles raw objects in addition to array-likes. Treats all | |
| 95 | // sparse array-likes as if they were dense. | |
| 96 | _.each = _.forEach = function(obj, iteratee, context) { | |
| 97 | if (obj == null) return obj; | |
| 98 | iteratee = createCallback(iteratee, context); | |
| 99 | var i, length = obj.length; | |
| 100 | if (length === +length) { | |
| 101 | for (i = 0; i < length; i++) { | |
| 102 | iteratee(obj[i], i, obj); | |
| 103 | } | |
| 104 | } else { | |
| 105 | var keys = _.keys(obj); | |
| 106 | for (i = 0, length = keys.length; i < length; i++) { | |
| 107 | iteratee(obj[keys[i]], keys[i], obj); | |
| 108 | } | |
| 109 | } | |
| 110 | return obj; | |
| 111 | }; | |
| 112 | ||
| 113 | // Return the results of applying the iteratee to each element. | |
| 114 | _.map = _.collect = function(obj, iteratee, context) { | |
| 115 | if (obj == null) return []; | |
| 116 | iteratee = _.iteratee(iteratee, context); | |
| 117 | var keys = obj.length !== +obj.length && _.keys(obj), | |
| 118 | length = (keys || obj).length, | |
| 119 | results = Array(length), | |
| 120 | currentKey; | |
| 121 | for (var index = 0; index < length; index++) { | |
| 122 | currentKey = keys ? keys[index] : index; | |
| 123 | results[index] = iteratee(obj[currentKey], currentKey, obj); | |
| 124 | } | |
| 125 | return results; | |
| 126 | }; | |
| 127 | ||
| 128 | var reduceError = 'Reduce of empty array with no initial value'; | |
| 129 | ||
| 130 | // **Reduce** builds up a single result from a list of values, aka `inject`, | |
| 131 | // or `foldl`. | |
| 132 | _.reduce = _.foldl = _.inject = function(obj, iteratee, memo, context) { | |
| 133 | if (obj == null) obj = []; | |
| 134 | iteratee = createCallback(iteratee, context, 4); | |
| 135 | var keys = obj.length !== +obj.length && _.keys(obj), | |
| 136 | length = (keys || obj).length, | |
| 137 | index = 0, currentKey; | |
| 138 | if (arguments.length < 3) { | |
| 139 | if (!length) throw new TypeError(reduceError); | |
| 140 | memo = obj[keys ? keys[index++] : index++]; | |
| 141 | } | |
| 142 | for (; index < length; index++) { | |
| 143 | currentKey = keys ? keys[index] : index; | |
| 144 | memo = iteratee(memo, obj[currentKey], currentKey, obj); | |
| 145 | } | |
| 146 | return memo; | |
| 147 | }; | |
| 148 | ||
| 149 | // The right-associative version of reduce, also known as `foldr`. | |
| 150 | _.reduceRight = _.foldr = function(obj, iteratee, memo, context) { | |
| 151 | if (obj == null) obj = []; | |
| 152 | iteratee = createCallback(iteratee, context, 4); | |
| 153 | var keys = obj.length !== + obj.length && _.keys(obj), | |
| 154 | index = (keys || obj).length, | |
| 155 | currentKey; | |
| 156 | if (arguments.length < 3) { | |
| 157 | if (!index) throw new TypeError(reduceError); | |
| 158 | memo = obj[keys ? keys[--index] : --index]; | |
| 159 | } | |
| 160 | while (index--) { | |
| 161 | currentKey = keys ? keys[index] : index; | |
| 162 | memo = iteratee(memo, obj[currentKey], currentKey, obj); | |
| 163 | } | |
| 164 | return memo; | |
| 165 | }; | |
| 166 | ||
| 167 | // Return the first value which passes a truth test. Aliased as `detect`. | |
| 168 | _.find = _.detect = function(obj, predicate, context) { | |
| 169 | var result; | |
| 170 | predicate = _.iteratee(predicate, context); | |
| 171 | _.some(obj, function(value, index, list) { | |
| 172 | if (predicate(value, index, list)) { | |
| 173 | result = value; | |
| 174 | return true; | |
| 175 | } | |
| 176 | }); | |
| 177 | return result; | |
| 178 | }; | |
| 179 | ||
| 180 | // Return all the elements that pass a truth test. | |
| 181 | // Aliased as `select`. | |
| 182 | _.filter = _.select = function(obj, predicate, context) { | |
| 183 | var results = []; | |
| 184 | if (obj == null) return results; | |
| 185 | predicate = _.iteratee(predicate, context); | |
| 186 | _.each(obj, function(value, index, list) { | |
| 187 | if (predicate(value, index, list)) results.push(value); | |
| 188 | }); | |
| 189 | return results; | |
| 190 | }; | |
| 191 | ||
| 192 | // Return all the elements for which a truth test fails. | |
| 193 | _.reject = function(obj, predicate, context) { | |
| 194 | return _.filter(obj, _.negate(_.iteratee(predicate)), context); | |
| 195 | }; | |
| 196 | ||
| 197 | // Determine whether all of the elements match a truth test. | |
| 198 | // Aliased as `all`. | |
| 199 | _.every = _.all = function(obj, predicate, context) { | |
| 200 | if (obj == null) return true; | |
| 201 | predicate = _.iteratee(predicate, context); | |
| 202 | var keys = obj.length !== +obj.length && _.keys(obj), | |
| 203 | length = (keys || obj).length, | |
| 204 | index, currentKey; | |
| 205 | for (index = 0; index < length; index++) { | |
| 206 | currentKey = keys ? keys[index] : index; | |
| 207 | if (!predicate(obj[currentKey], currentKey, obj)) return false; | |
| 208 | } | |
| 209 | return true; | |
| 210 | }; | |
| 211 | ||
| 212 | // Determine if at least one element in the object matches a truth test. | |
| 213 | // Aliased as `any`. | |
| 214 | _.some = _.any = function(obj, predicate, context) { | |
| 215 | if (obj == null) return false; | |
| 216 | predicate = _.iteratee(predicate, context); | |
| 217 | var keys = obj.length !== +obj.length && _.keys(obj), | |
| 218 | length = (keys || obj).length, | |
| 219 | index, currentKey; | |
| 220 | for (index = 0; index < length; index++) { | |
| 221 | currentKey = keys ? keys[index] : index; | |
| 222 | if (predicate(obj[currentKey], currentKey, obj)) return true; | |
| 223 | } | |
| 224 | return false; | |
| 225 | }; | |
| 226 | ||
| 227 | // Determine if the array or object contains a given value (using `===`). | |
| 228 | // Aliased as `include`. | |
| 229 | _.contains = _.include = function(obj, target) { | |
| 230 | if (obj == null) return false; | |
| 231 | if (obj.length !== +obj.length) obj = _.values(obj); | |
| 232 | return _.indexOf(obj, target) >= 0; | |
| 233 | }; | |
| 234 | ||
| 235 | // Invoke a method (with arguments) on every item in a collection. | |
| 236 | _.invoke = function(obj, method) { | |
| 237 | var args = slice.call(arguments, 2); | |
| 238 | var isFunc = _.isFunction(method); | |
| 239 | return _.map(obj, function(value) { | |
| 240 | return (isFunc ? method : value[method]).apply(value, args); | |
| 241 | }); | |
| 242 | }; | |
| 243 | ||
| 244 | // Convenience version of a common use case of `map`: fetching a property. | |
| 245 | _.pluck = function(obj, key) { | |
| 246 | return _.map(obj, _.property(key)); | |
| 247 | }; | |
| 248 | ||
| 249 | // Convenience version of a common use case of `filter`: selecting only objects | |
| 250 | // containing specific `key:value` pairs. | |
| 251 | _.where = function(obj, attrs) { | |
| 252 | return _.filter(obj, _.matches(attrs)); | |
| 253 | }; | |
| 254 | ||
| 255 | // Convenience version of a common use case of `find`: getting the first object | |
| 256 | // containing specific `key:value` pairs. | |
| 257 | _.findWhere = function(obj, attrs) { | |
| 258 | return _.find(obj, _.matches(attrs)); | |
| 259 | }; | |
| 260 | ||
| 261 | // Return the maximum element (or element-based computation). | |
| 262 | _.max = function(obj, iteratee, context) { | |
| 263 | var result = -Infinity, lastComputed = -Infinity, | |
| 264 | value, computed; | |
| 265 | if (iteratee == null && obj != null) { | |
| 266 | obj = obj.length === +obj.length ? obj : _.values(obj); | |
| 267 | for (var i = 0, length = obj.length; i < length; i++) { | |
| 268 | value = obj[i]; | |
| 269 | if (value > result) { | |
| 270 | result = value; | |
| 271 | } | |
| 272 | } | |
| 273 | } else { | |
| 274 | iteratee = _.iteratee(iteratee, context); | |
| 275 | _.each(obj, function(value, index, list) { | |
| 276 | computed = iteratee(value, index, list); | |
| 277 | if (computed > lastComputed || computed === -Infinity && result === -Infinity) { | |
| 278 | result = value; | |
| 279 | lastComputed = computed; | |
| 280 | } | |
| 281 | }); | |
| 282 | } | |
| 283 | return result; | |
| 284 | }; | |
| 285 | ||
| 286 | // Return the minimum element (or element-based computation). | |
| 287 | _.min = function(obj, iteratee, context) { | |
| 288 | var result = Infinity, lastComputed = Infinity, | |
| 289 | value, computed; | |
| 290 | if (iteratee == null && obj != null) { | |
| 291 | obj = obj.length === +obj.length ? obj : _.values(obj); | |
| 292 | for (var i = 0, length = obj.length; i < length; i++) { | |
| 293 | value = obj[i]; | |
| 294 | if (value < result) { | |
| 295 | result = value; | |
| 296 | } | |
| 297 | } | |
| 298 | } else { | |
| 299 | iteratee = _.iteratee(iteratee, context); | |
| 300 | _.each(obj, function(value, index, list) { | |
| 301 | computed = iteratee(value, index, list); | |
| 302 | if (computed < lastComputed || computed === Infinity && result === Infinity) { | |
| 303 | result = value; | |
| 304 | lastComputed = computed; | |
| 305 | } | |
| 306 | }); | |
| 307 | } | |
| 308 | return result; | |
| 309 | }; | |
| 310 | ||
| 311 | // Shuffle a collection, using the modern version of the | |
| 312 | // [Fisher-Yates shuffle](http://en.wikipedia.org/wiki/Fisher–Yates_shuffle). | |
| 313 | _.shuffle = function(obj) { | |
| 314 | var set = obj && obj.length === +obj.length ? obj : _.values(obj); | |
| 315 | var length = set.length; | |
| 316 | var shuffled = Array(length); | |
| 317 | for (var index = 0, rand; index < length; index++) { | |
| 318 | rand = _.random(0, index); | |
| 319 | if (rand !== index) shuffled[index] = shuffled[rand]; | |
| 320 | shuffled[rand] = set[index]; | |
| 321 | } | |
| 322 | return shuffled; | |
| 323 | }; | |
| 324 | ||
| 325 | // Sample **n** random values from a collection. | |
| 326 | // If **n** is not specified, returns a single random element. | |
| 327 | // The internal `guard` argument allows it to work with `map`. | |
| 328 | _.sample = function(obj, n, guard) { | |
| 329 | if (n == null || guard) { | |
| 330 | if (obj.length !== +obj.length) obj = _.values(obj); | |
| 331 | return obj[_.random(obj.length - 1)]; | |
| 332 | } | |
| 333 | return _.shuffle(obj).slice(0, Math.max(0, n)); | |
| 334 | }; | |
| 335 | ||
| 336 | // Sort the object's values by a criterion produced by an iteratee. | |
| 337 | _.sortBy = function(obj, iteratee, context) { | |
| 338 | iteratee = _.iteratee(iteratee, context); | |
| 339 | return _.pluck(_.map(obj, function(value, index, list) { | |
| 340 | return { | |
| 341 | value: value, | |
| 342 | index: index, | |
| 343 | criteria: iteratee(value, index, list) | |
| 344 | }; | |
| 345 | }).sort(function(left, right) { | |
| 346 | var a = left.criteria; | |
| 347 | var b = right.criteria; | |
| 348 | if (a !== b) { | |
| 349 | if (a > b || a === void 0) return 1; | |
| 350 | if (a < b || b === void 0) return -1; | |
| 351 | } | |
| 352 | return left.index - right.index; | |
| 353 | }), 'value'); | |
| 354 | }; | |
| 355 | ||
| 356 | // An internal function used for aggregate "group by" operations. | |
| 357 | var group = function(behavior) { | |
| 358 | return function(obj, iteratee, context) { | |
| 359 | var result = {}; | |
| 360 | iteratee = _.iteratee(iteratee, context); | |
| 361 | _.each(obj, function(value, index) { | |
| 362 | var key = iteratee(value, index, obj); | |
| 363 | behavior(result, value, key); | |
| 364 | }); | |
| 365 | return result; | |
| 366 | }; | |
| 367 | }; | |
| 368 | ||
| 369 | // Groups the object's values by a criterion. Pass either a string attribute | |
| 370 | // to group by, or a function that returns the criterion. | |
| 371 | _.groupBy = group(function(result, value, key) { | |
| 372 | if (_.has(result, key)) result[key].push(value); else result[key] = [value]; | |
| 373 | }); | |
| 374 | ||
| 375 | // Indexes the object's values by a criterion, similar to `groupBy`, but for | |
| 376 | // when you know that your index values will be unique. | |
| 377 | _.indexBy = group(function(result, value, key) { | |
| 378 | result[key] = value; | |
| 379 | }); | |
| 380 | ||
| 381 | // Counts instances of an object that group by a certain criterion. Pass | |
| 382 | // either a string attribute to count by, or a function that returns the | |
| 383 | // criterion. | |
| 384 | _.countBy = group(function(result, value, key) { | |
| 385 | if (_.has(result, key)) result[key]++; else result[key] = 1; | |
| 386 | }); | |
| 387 | ||
| 388 | // Use a comparator function to figure out the smallest index at which | |
| 389 | // an object should be inserted so as to maintain order. Uses binary search. | |
| 390 | _.sortedIndex = function(array, obj, iteratee, context) { | |
| 391 | iteratee = _.iteratee(iteratee, context, 1); | |
| 392 | var value = iteratee(obj); | |
| 393 | var low = 0, high = array.length; | |
| 394 | while (low < high) { | |
| 395 | var mid = low + high >>> 1; | |
| 396 | if (iteratee(array[mid]) < value) low = mid + 1; else high = mid; | |
| 397 | } | |
| 398 | return low; | |
| 399 | }; | |
| 400 | ||
| 401 | // Safely create a real, live array from anything iterable. | |
| 402 | _.toArray = function(obj) { | |
| 403 | if (!obj) return []; | |
| 404 | if (_.isArray(obj)) return slice.call(obj); | |
| 405 | if (obj.length === +obj.length) return _.map(obj, _.identity); | |
| 406 | return _.values(obj); | |
| 407 | }; | |
| 408 | ||
| 409 | // Return the number of elements in an object. | |
| 410 | _.size = function(obj) { | |
| 411 | if (obj == null) return 0; | |
| 412 | return obj.length === +obj.length ? obj.length : _.keys(obj).length; | |
| 413 | }; | |
| 414 | ||
| 415 | // Split a collection into two arrays: one whose elements all satisfy the given | |
| 416 | // predicate, and one whose elements all do not satisfy the predicate. | |
| 417 | _.partition = function(obj, predicate, context) { | |
| 418 | predicate = _.iteratee(predicate, context); | |
| 419 | var pass = [], fail = []; | |
| 420 | _.each(obj, function(value, key, obj) { | |
| 421 | (predicate(value, key, obj) ? pass : fail).push(value); | |
| 422 | }); | |
| 423 | return [pass, fail]; | |
| 424 | }; | |
| 425 | ||
| 426 | // Array Functions | |
| 427 | // --------------- | |
| 428 | ||
| 429 | // Get the first element of an array. Passing **n** will return the first N | |
| 430 | // values in the array. Aliased as `head` and `take`. The **guard** check | |
| 431 | // allows it to work with `_.map`. | |
| 432 | _.first = _.head = _.take = function(array, n, guard) { | |
| 433 | if (array == null) return void 0; | |
| 434 | if (n == null || guard) return array[0]; | |
| 435 | if (n < 0) return []; | |
| 436 | return slice.call(array, 0, n); | |
| 437 | }; | |
| 438 | ||
| 439 | // Returns everything but the last entry of the array. Especially useful on | |
| 440 | // the arguments object. Passing **n** will return all the values in | |
| 441 | // the array, excluding the last N. The **guard** check allows it to work with | |
| 442 | // `_.map`. | |
| 443 | _.initial = function(array, n, guard) { | |
| 444 | return slice.call(array, 0, Math.max(0, array.length - (n == null || guard ? 1 : n))); | |
| 445 | }; | |
| 446 | ||
| 447 | // Get the last element of an array. Passing **n** will return the last N | |
| 448 | // values in the array. The **guard** check allows it to work with `_.map`. | |
| 449 | _.last = function(array, n, guard) { | |
| 450 | if (array == null) return void 0; | |
| 451 | if (n == null || guard) return array[array.length - 1]; | |
| 452 | return slice.call(array, Math.max(array.length - n, 0)); | |
| 453 | }; | |
| 454 | ||
| 455 | // Returns everything but the first entry of the array. Aliased as `tail` and `drop`. | |
| 456 | // Especially useful on the arguments object. Passing an **n** will return | |
| 457 | // the rest N values in the array. The **guard** | |
| 458 | // check allows it to work with `_.map`. | |
| 459 | _.rest = _.tail = _.drop = function(array, n, guard) { | |
| 460 | return slice.call(array, n == null || guard ? 1 : n); | |
| 461 | }; | |
| 462 | ||
| 463 | // Trim out all falsy values from an array. | |
| 464 | _.compact = function(array) { | |
| 465 | return _.filter(array, _.identity); | |
| 466 | }; | |
| 467 | ||
| 468 | // Internal implementation of a recursive `flatten` function. | |
| 469 | var flatten = function(input, shallow, strict, output) { | |
| 470 | if (shallow && _.every(input, _.isArray)) { | |
| 471 | return concat.apply(output, input); | |
| 472 | } | |
| 473 | for (var i = 0, length = input.length; i < length; i++) { | |
| 474 | var value = input[i]; | |
| 475 | if (!_.isArray(value) && !_.isArguments(value)) { | |
| 476 | if (!strict) output.push(value); | |
| 477 | } else if (shallow) { | |
| 478 | push.apply(output, value); | |
| 479 | } else { | |
| 480 | flatten(value, shallow, strict, output); | |
| 481 | } | |
| 482 | } | |
| 483 | return output; | |
| 484 | }; | |
| 485 | ||
| 486 | // Flatten out an array, either recursively (by default), or just one level. | |
| 487 | _.flatten = function(array, shallow) { | |
| 488 | return flatten(array, shallow, false, []); | |
| 489 | }; | |
| 490 | ||
| 491 | // Return a version of the array that does not contain the specified value(s). | |
| 492 | _.without = function(array) { | |
| 493 | return _.difference(array, slice.call(arguments, 1)); | |
| 494 | }; | |
| 495 | ||
| 496 | // Produce a duplicate-free version of the array. If the array has already | |
| 497 | // been sorted, you have the option of using a faster algorithm. | |
| 498 | // Aliased as `unique`. | |
| 499 | _.uniq = _.unique = function(array, isSorted, iteratee, context) { | |
| 500 | if (array == null) return []; | |
| 501 | if (!_.isBoolean(isSorted)) { | |
| 502 | context = iteratee; | |
| 503 | iteratee = isSorted; | |
| 504 | isSorted = false; | |
| 505 | } | |
| 506 | if (iteratee != null) iteratee = _.iteratee(iteratee, context); | |
| 507 | var result = []; | |
| 508 | var seen = []; | |
| 509 | for (var i = 0, length = array.length; i < length; i++) { | |
| 510 | var value = array[i]; | |
| 511 | if (isSorted) { | |
| 512 | if (!i || seen !== value) result.push(value); | |
| 513 | seen = value; | |
| 514 | } else if (iteratee) { | |
| 515 | var computed = iteratee(value, i, array); | |
| 516 | if (_.indexOf(seen, computed) < 0) { | |
| 517 | seen.push(computed); | |
| 518 | result.push(value); | |
| 519 | } | |
| 520 | } else if (_.indexOf(result, value) < 0) { | |
| 521 | result.push(value); | |
| 522 | } | |
| 523 | } | |
| 524 | return result; | |
| 525 | }; | |
| 526 | ||
| 527 | // Produce an array that contains the union: each distinct element from all of | |
| 528 | // the passed-in arrays. | |
| 529 | _.union = function() { | |
| 530 | return _.uniq(flatten(arguments, true, true, [])); | |
| 531 | }; | |
| 532 | ||
| 533 | // Produce an array that contains every item shared between all the | |
| 534 | // passed-in arrays. | |
| 535 | _.intersection = function(array) { | |
| 536 | if (array == null) return []; | |
| 537 | var result = []; | |
| 538 | var argsLength = arguments.length; | |
| 539 | for (var i = 0, length = array.length; i < length; i++) { | |
| 540 | var item = array[i]; | |
| 541 | if (_.contains(result, item)) continue; | |
| 542 | for (var j = 1; j < argsLength; j++) { | |
| 543 | if (!_.contains(arguments[j], item)) break; | |
| 544 | } | |
| 545 | if (j === argsLength) result.push(item); | |
| 546 | } | |
| 547 | return result; | |
| 548 | }; | |
| 549 | ||
| 550 | // Take the difference between one array and a number of other arrays. | |
| 551 | // Only the elements present in just the first array will remain. | |
| 552 | _.difference = function(array) { | |
| 553 | var rest = flatten(slice.call(arguments, 1), true, true, []); | |
| 554 | return _.filter(array, function(value){ | |
| 555 | return !_.contains(rest, value); | |
| 556 | }); | |
| 557 | }; | |
| 558 | ||
| 559 | // Zip together multiple lists into a single array -- elements that share | |
| 560 | // an index go together. | |
| 561 | _.zip = function(array) { | |
| 562 | if (array == null) return []; | |
| 563 | var length = _.max(arguments, 'length').length; | |
| 564 | var results = Array(length); | |
| 565 | for (var i = 0; i < length; i++) { | |
| 566 | results[i] = _.pluck(arguments, i); | |
| 567 | } | |
| 568 | return results; | |
| 569 | }; | |
| 570 | ||
| 571 | // Converts lists into objects. Pass either a single array of `[key, value]` | |
| 572 | // pairs, or two parallel arrays of the same length -- one of keys, and one of | |
| 573 | // the corresponding values. | |
| 574 | _.object = function(list, values) { | |
| 575 | if (list == null) return {}; | |
| 576 | var result = {}; | |
| 577 | for (var i = 0, length = list.length; i < length; i++) { | |
| 578 | if (values) { | |
| 579 | result[list[i]] = values[i]; | |
| 580 | } else { | |
| 581 | result[list[i][0]] = list[i][1]; | |
| 582 | } | |
| 583 | } | |
| 584 | return result; | |
| 585 | }; | |
| 586 | ||
| 587 | // Return the position of the first occurrence of an item in an array, | |
| 588 | // or -1 if the item is not included in the array. | |
| 589 | // If the array is large and already in sort order, pass `true` | |
| 590 | // for **isSorted** to use binary search. | |
| 591 | _.indexOf = function(array, item, isSorted) { | |
| 592 | if (array == null) return -1; | |
| 593 | var i = 0, length = array.length; | |
| 594 | if (isSorted) { | |
| 595 | if (typeof isSorted == 'number') { | |
| 596 | i = isSorted < 0 ? Math.max(0, length + isSorted) : isSorted; | |
| 597 | } else { | |
| 598 | i = _.sortedIndex(array, item); | |
| 599 | return array[i] === item ? i : -1; | |
| 600 | } | |
| 601 | } | |
| 602 | for (; i < length; i++) if (array[i] === item) return i; | |
| 603 | return -1; | |
| 604 | }; | |
| 605 | ||
| 606 | _.lastIndexOf = function(array, item, from) { | |
| 607 | if (array == null) return -1; | |
| 608 | var idx = array.length; | |
| 609 | if (typeof from == 'number') { | |
| 610 | idx = from < 0 ? idx + from + 1 : Math.min(idx, from + 1); | |
| 611 | } | |
| 612 | while (--idx >= 0) if (array[idx] === item) return idx; | |
| 613 | return -1; | |
| 614 | }; | |
| 615 | ||
| 616 | // Generate an integer Array containing an arithmetic progression. A port of | |
| 617 | // the native Python `range()` function. See | |
| 618 | // [the Python documentation](http://docs.python.org/library/functions.html#range). | |
| 619 | _.range = function(start, stop, step) { | |
| 620 | if (arguments.length <= 1) { | |
| 621 | stop = start || 0; | |
| 622 | start = 0; | |
| 623 | } | |
| 624 | step = step || 1; | |
| 625 | ||
| 626 | var length = Math.max(Math.ceil((stop - start) / step), 0); | |
| 627 | var range = Array(length); | |
| 628 | ||
| 629 | for (var idx = 0; idx < length; idx++, start += step) { | |
| 630 | range[idx] = start; | |
| 631 | } | |
| 632 | ||
| 633 | return range; | |
| 634 | }; | |
| 635 | ||
| 636 | // Function (ahem) Functions | |
| 637 | // ------------------ | |
| 638 | ||
| 639 | // Reusable constructor function for prototype setting. | |
| 640 | var Ctor = function(){}; | |
| 641 | ||
| 642 | // Create a function bound to a given object (assigning `this`, and arguments, | |
| 643 | // optionally). Delegates to **ECMAScript 5**'s native `Function.bind` if | |
| 644 | // available. | |
| 645 | _.bind = function(func, context) { | |
| 646 | var args, bound; | |
| 647 | if (nativeBind && func.bind === nativeBind) return nativeBind.apply(func, slice.call(arguments, 1)); | |
| 648 | if (!_.isFunction(func)) throw new TypeError('Bind must be called on a function'); | |
| 649 | args = slice.call(arguments, 2); | |
| 650 | bound = function() { | |
| 651 | if (!(this instanceof bound)) return func.apply(context, args.concat(slice.call(arguments))); | |
| 652 | Ctor.prototype = func.prototype; | |
| 653 | var self = new Ctor; | |
| 654 | Ctor.prototype = null; | |
| 655 | var result = func.apply(self, args.concat(slice.call(arguments))); | |
| 656 | if (_.isObject(result)) return result; | |
| 657 | return self; | |
| 658 | }; | |
| 659 | return bound; | |
| 660 | }; | |
| 661 | ||
| 662 | // Partially apply a function by creating a version that has had some of its | |
| 663 | // arguments pre-filled, without changing its dynamic `this` context. _ acts | |
| 664 | // as a placeholder, allowing any combination of arguments to be pre-filled. | |
| 665 | _.partial = function(func) { | |
| 666 | var boundArgs = slice.call(arguments, 1); | |
| 667 | return function() { | |
| 668 | var position = 0; | |
| 669 | var args = boundArgs.slice(); | |
| 670 | for (var i = 0, length = args.length; i < length; i++) { | |
| 671 | if (args[i] === _) args[i] = arguments[position++]; | |
| 672 | } | |
| 673 | while (position < arguments.length) args.push(arguments[position++]); | |
| 674 | return func.apply(this, args); | |
| 675 | }; | |
| 676 | }; | |
| 677 | ||
| 678 | // Bind a number of an object's methods to that object. Remaining arguments | |
| 679 | // are the method names to be bound. Useful for ensuring that all callbacks | |
| 680 | // defined on an object belong to it. | |
| 681 | _.bindAll = function(obj) { | |
| 682 | var i, length = arguments.length, key; | |
| 683 | if (length <= 1) throw new Error('bindAll must be passed function names'); | |
| 684 | for (i = 1; i < length; i++) { | |
| 685 | key = arguments[i]; | |
| 686 | obj[key] = _.bind(obj[key], obj); | |
| 687 | } | |
| 688 | return obj; | |
| 689 | }; | |
| 690 | ||
| 691 | // Memoize an expensive function by storing its results. | |
| 692 | _.memoize = function(func, hasher) { | |
| 693 | var memoize = function(key) { | |
| 694 | var cache = memoize.cache; | |
| 695 | var address = hasher ? hasher.apply(this, arguments) : key; | |
| 696 | if (!_.has(cache, address)) cache[address] = func.apply(this, arguments); | |
| 697 | return cache[address]; | |
| 698 | }; | |
| 699 | memoize.cache = {}; | |
| 700 | return memoize; | |
| 701 | }; | |
| 702 | ||
| 703 | // Delays a function for the given number of milliseconds, and then calls | |
| 704 | // it with the arguments supplied. | |
| 705 | _.delay = function(func, wait) { | |
| 706 | var args = slice.call(arguments, 2); | |
| 707 | return setTimeout(function(){ | |
| 708 | return func.apply(null, args); | |
| 709 | }, wait); | |
| 710 | }; | |
| 711 | ||
| 712 | // Defers a function, scheduling it to run after the current call stack has | |
| 713 | // cleared. | |
| 714 | _.defer = function(func) { | |
| 715 | return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1))); | |
| 716 | }; | |
| 717 | ||
| 718 | // Returns a function, that, when invoked, will only be triggered at most once | |
| 719 | // during a given window of time. Normally, the throttled function will run | |
| 720 | // as much as it can, without ever going more than once per `wait` duration; | |
| 721 | // but if you'd like to disable the execution on the leading edge, pass | |
| 722 | // `{leading: false}`. To disable execution on the trailing edge, ditto. | |
| 723 | _.throttle = function(func, wait, options) { | |
| 724 | var context, args, result; | |
| 725 | var timeout = null; | |
| 726 | var previous = 0; | |
| 727 | if (!options) options = {}; | |
| 728 | var later = function() { | |
| 729 | previous = options.leading === false ? 0 : _.now(); | |
| 730 | timeout = null; | |
| 731 | result = func.apply(context, args); | |
| 732 | if (!timeout) context = args = null; | |
| 733 | }; | |
| 734 | return function() { | |
| 735 | var now = _.now(); | |
| 736 | if (!previous && options.leading === false) previous = now; | |
| 737 | var remaining = wait - (now - previous); | |
| 738 | context = this; | |
| 739 | args = arguments; | |
| 740 | if (remaining <= 0 || remaining > wait) { | |
| 741 | clearTimeout(timeout); | |
| 742 | timeout = null; | |
| 743 | previous = now; | |
| 744 | result = func.apply(context, args); | |
| 745 | if (!timeout) context = args = null; | |
| 746 | } else if (!timeout && options.trailing !== false) { | |
| 747 | timeout = setTimeout(later, remaining); | |
| 748 | } | |
| 749 | return result; | |
| 750 | }; | |
| 751 | }; | |
| 752 | ||
| 753 | // Returns a function, that, as long as it continues to be invoked, will not | |
| 754 | // be triggered. The function will be called after it stops being called for | |
| 755 | // N milliseconds. If `immediate` is passed, trigger the function on the | |
| 756 | // leading edge, instead of the trailing. | |
| 757 | _.debounce = function(func, wait, immediate) { | |
| 758 | var timeout, args, context, timestamp, result; | |
| 759 | ||
| 760 | var later = function() { | |
| 761 | var last = _.now() - timestamp; | |
| 762 | ||
| 763 | if (last < wait && last > 0) { | |
| 764 | timeout = setTimeout(later, wait - last); | |
| 765 | } else { | |
| 766 | timeout = null; | |
| 767 | if (!immediate) { | |
| 768 | result = func.apply(context, args); | |
| 769 | if (!timeout) context = args = null; | |
| 770 | } | |
| 771 | } | |
| 772 | }; | |
| 773 | ||
| 774 | return function() { | |
| 775 | context = this; | |
| 776 | args = arguments; | |
| 777 | timestamp = _.now(); | |
| 778 | var callNow = immediate && !timeout; | |
| 779 | if (!timeout) timeout = setTimeout(later, wait); | |
| 780 | if (callNow) { | |
| 781 | result = func.apply(context, args); | |
| 782 | context = args = null; | |
| 783 | } | |
| 784 | ||
| 785 | return result; | |
| 786 | }; | |
| 787 | }; | |
| 788 | ||
| 789 | // Returns the first function passed as an argument to the second, | |
| 790 | // allowing you to adjust arguments, run code before and after, and | |
| 791 | // conditionally execute the original function. | |
| 792 | _.wrap = function(func, wrapper) { | |
| 793 | return _.partial(wrapper, func); | |
| 794 | }; | |
| 795 | ||
| 796 | // Returns a negated version of the passed-in predicate. | |
| 797 | _.negate = function(predicate) { | |
| 798 | return function() { | |
| 799 | return !predicate.apply(this, arguments); | |
| 800 | }; | |
| 801 | }; | |
| 802 | ||
| 803 | // Returns a function that is the composition of a list of functions, each | |
| 804 | // consuming the return value of the function that follows. | |
| 805 | _.compose = function() { | |
| 806 | var args = arguments; | |
| 807 | var start = args.length - 1; | |
| 808 | return function() { | |
| 809 | var i = start; | |
| 810 | var result = args[start].apply(this, arguments); | |
| 811 | while (i--) result = args[i].call(this, result); | |
| 812 | return result; | |
| 813 | }; | |
| 814 | }; | |
| 815 | ||
| 816 | // Returns a function that will only be executed after being called N times. | |
| 817 | _.after = function(times, func) { | |
| 818 | return function() { | |
| 819 | if (--times < 1) { | |
| 820 | return func.apply(this, arguments); | |
| 821 | } | |
| 822 | }; | |
| 823 | }; | |
| 824 | ||
| 825 | // Returns a function that will only be executed before being called N times. | |
| 826 | _.before = function(times, func) { | |
| 827 | var memo; | |
| 828 | return function() { | |
| 829 | if (--times > 0) { | |
| 830 | memo = func.apply(this, arguments); | |
| 831 | } else { | |
| 832 | func = null; | |
| 833 | } | |
| 834 | return memo; | |
| 835 | }; | |
| 836 | }; | |
| 837 | ||
| 838 | // Returns a function that will be executed at most one time, no matter how | |
| 839 | // often you call it. Useful for lazy initialization. | |
| 840 | _.once = _.partial(_.before, 2); | |
| 841 | ||
| 842 | // Object Functions | |
| 843 | // ---------------- | |
| 844 | ||
| 845 | // Retrieve the names of an object's properties. | |
| 846 | // Delegates to **ECMAScript 5**'s native `Object.keys` | |
| 847 | _.keys = function(obj) { | |
| 848 | if (!_.isObject(obj)) return []; | |
| 849 | if (nativeKeys) return nativeKeys(obj); | |
| 850 | var keys = []; | |
| 851 | for (var key in obj) if (_.has(obj, key)) keys.push(key); | |
| 852 | return keys; | |
| 853 | }; | |
| 854 | ||
| 855 | // Retrieve the values of an object's properties. | |
| 856 | _.values = function(obj) { | |
| 857 | var keys = _.keys(obj); | |
| 858 | var length = keys.length; | |
| 859 | var values = Array(length); | |
| 860 | for (var i = 0; i < length; i++) { | |
| 861 | values[i] = obj[keys[i]]; | |
| 862 | } | |
| 863 | return values; | |
| 864 | }; | |
| 865 | ||
| 866 | // Convert an object into a list of `[key, value]` pairs. | |
| 867 | _.pairs = function(obj) { | |
| 868 | var keys = _.keys(obj); | |
| 869 | var length = keys.length; | |
| 870 | var pairs = Array(length); | |
| 871 | for (var i = 0; i < length; i++) { | |
| 872 | pairs[i] = [keys[i], obj[keys[i]]]; | |
| 873 | } | |
| 874 | return pairs; | |
| 875 | }; | |
| 876 | ||
| 877 | // Invert the keys and values of an object. The values must be serializable. | |
| 878 | _.invert = function(obj) { | |
| 879 | var result = {}; | |
| 880 | var keys = _.keys(obj); | |
| 881 | for (var i = 0, length = keys.length; i < length; i++) { | |
| 882 | result[obj[keys[i]]] = keys[i]; | |
| 883 | } | |
| 884 | return result; | |
| 885 | }; | |
| 886 | ||
| 887 | // Return a sorted list of the function names available on the object. | |
| 888 | // Aliased as `methods` | |
| 889 | _.functions = _.methods = function(obj) { | |
| 890 | var names = []; | |
| 891 | for (var key in obj) { | |
| 892 | if (_.isFunction(obj[key])) names.push(key); | |
| 893 | } | |
| 894 | return names.sort(); | |
| 895 | }; | |
| 896 | ||
| 897 | // Extend a given object with all the properties in passed-in object(s). | |
| 898 | _.extend = function(obj) { | |
| 899 | if (!_.isObject(obj)) return obj; | |
| 900 | var source, prop; | |
| 901 | for (var i = 1, length = arguments.length; i < length; i++) { | |
| 902 | source = arguments[i]; | |
| 903 | for (prop in source) { | |
| 904 | if (hasOwnProperty.call(source, prop)) { | |
| 905 | obj[prop] = source[prop]; | |
| 906 | } | |
| 907 | } | |
| 908 | } | |
| 909 | return obj; | |
| 910 | }; | |
| 911 | ||
| 912 | // Return a copy of the object only containing the whitelisted properties. | |
| 913 | _.pick = function(obj, iteratee, context) { | |
| 914 | var result = {}, key; | |
| 915 | if (obj == null) return result; | |
| 916 | if (_.isFunction(iteratee)) { | |
| 917 | iteratee = createCallback(iteratee, context); | |
| 918 | for (key in obj) { | |
| 919 | var value = obj[key]; | |
| 920 | if (iteratee(value, key, obj)) result[key] = value; | |
| 921 | } | |
| 922 | } else { | |
| 923 | var keys = concat.apply([], slice.call(arguments, 1)); | |
| 924 | obj = new Object(obj); | |
| 925 | for (var i = 0, length = keys.length; i < length; i++) { | |
| 926 | key = keys[i]; | |
| 927 | if (key in obj) result[key] = obj[key]; | |
| 928 | } | |
| 929 | } | |
| 930 | return result; | |
| 931 | }; | |
| 932 | ||
| 933 | // Return a copy of the object without the blacklisted properties. | |
| 934 | _.omit = function(obj, iteratee, context) { | |
| 935 | if (_.isFunction(iteratee)) { | |
| 936 | iteratee = _.negate(iteratee); | |
| 937 | } else { | |
| 938 | var keys = _.map(concat.apply([], slice.call(arguments, 1)), String); | |
| 939 | iteratee = function(value, key) { | |
| 940 | return !_.contains(keys, key); | |
| 941 | }; | |
| 942 | } | |
| 943 | return _.pick(obj, iteratee, context); | |
| 944 | }; | |
| 945 | ||
| 946 | // Fill in a given object with default properties. | |
| 947 | _.defaults = function(obj) { | |
| 948 | if (!_.isObject(obj)) return obj; | |
| 949 | for (var i = 1, length = arguments.length; i < length; i++) { | |
| 950 | var source = arguments[i]; | |
| 951 | for (var prop in source) { | |
| 952 | if (obj[prop] === void 0) obj[prop] = source[prop]; | |
| 953 | } | |
| 954 | } | |
| 955 | return obj; | |
| 956 | }; | |
| 957 | ||
| 958 | // Create a (shallow-cloned) duplicate of an object. | |
| 959 | _.clone = function(obj) { | |
| 960 | if (!_.isObject(obj)) return obj; | |
| 961 | return _.isArray(obj) ? obj.slice() : _.extend({}, obj); | |
| 962 | }; | |
| 963 | ||
| 964 | // Invokes interceptor with the obj, and then returns obj. | |
| 965 | // The primary purpose of this method is to "tap into" a method chain, in | |
| 966 | // order to perform operations on intermediate results within the chain. | |
| 967 | _.tap = function(obj, interceptor) { | |
| 968 | interceptor(obj); | |
| 969 | return obj; | |
| 970 | }; | |
| 971 | ||
| 972 | // Internal recursive comparison function for `isEqual`. | |
| 973 | var eq = function(a, b, aStack, bStack) { | |
| 974 | // Identical objects are equal. `0 === -0`, but they aren't identical. | |
| 975 | // See the [Harmony `egal` proposal](http://wiki.ecmascript.org/doku.php?id=harmony:egal). | |
| 976 | if (a === b) return a !== 0 || 1 / a === 1 / b; | |
| 977 | // A strict comparison is necessary because `null == undefined`. | |
| 978 | if (a == null || b == null) return a === b; | |
| 979 | // Unwrap any wrapped objects. | |
| 980 | if (a instanceof _) a = a._wrapped; | |
| 981 | if (b instanceof _) b = b._wrapped; | |
| 982 | // Compare `[[Class]]` names. | |
| 983 | var className = toString.call(a); | |
| 984 | if (className !== toString.call(b)) return false; | |
| 985 | switch (className) { | |
| 986 | // Strings, numbers, regular expressions, dates, and booleans are compared by value. | |
| 987 | case '[object RegExp]': | |
| 988 | // RegExps are coerced to strings for comparison (Note: '' + /a/i === '/a/i') | |
| 989 | case '[object String]': | |
| 990 | // Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is | |
| 991 | // equivalent to `new String("5")`. | |
| 992 | return '' + a === '' + b; | |
| 993 | case '[object Number]': | |
| 994 | // `NaN`s are equivalent, but non-reflexive. | |
| 995 | // Object(NaN) is equivalent to NaN | |
| 996 | if (+a !== +a) return +b !== +b; | |
| 997 | // An `egal` comparison is performed for other numeric values. | |
| 998 | return +a === 0 ? 1 / +a === 1 / b : +a === +b; | |
| 999 | case '[object Date]': | |
| 1000 | case '[object Boolean]': | |
| 1001 | // Coerce dates and booleans to numeric primitive values. Dates are compared by their | |
| 1002 | // millisecond representations. Note that invalid dates with millisecond representations | |
| 1003 | // of `NaN` are not equivalent. | |
| 1004 | return +a === +b; | |
| 1005 | } | |
| 1006 | if (typeof a != 'object' || typeof b != 'object') return false; | |
| 1007 | // Assume equality for cyclic structures. The algorithm for detecting cyclic | |
| 1008 | // structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`. | |
| 1009 | var length = aStack.length; | |
| 1010 | while (length--) { | |
| 1011 | // Linear search. Performance is inversely proportional to the number of | |
| 1012 | // unique nested structures. | |
| 1013 | if (aStack[length] === a) return bStack[length] === b; | |
| 1014 | } | |
| 1015 | // Objects with different constructors are not equivalent, but `Object`s | |
| 1016 | // from different frames are. | |
| 1017 | var aCtor = a.constructor, bCtor = b.constructor; | |
| 1018 | if ( | |
| 1019 | aCtor !== bCtor && | |
| 1020 | // Handle Object.create(x) cases | |
| 1021 | 'constructor' in a && 'constructor' in b && | |
| 1022 | !(_.isFunction(aCtor) && aCtor instanceof aCtor && | |
| 1023 | _.isFunction(bCtor) && bCtor instanceof bCtor) | |
| 1024 | ) { | |
| 1025 | return false; | |
| 1026 | } | |
| 1027 | // Add the first object to the stack of traversed objects. | |
| 1028 | aStack.push(a); | |
| 1029 | bStack.push(b); | |
| 1030 | var size, result; | |
| 1031 | // Recursively compare objects and arrays. | |
| 1032 | if (className === '[object Array]') { | |
| 1033 | // Compare array lengths to determine if a deep comparison is necessary. | |
| 1034 | size = a.length; | |
| 1035 | result = size === b.length; | |
| 1036 | if (result) { | |
| 1037 | // Deep compare the contents, ignoring non-numeric properties. | |
| 1038 | while (size--) { | |
| 1039 | if (!(result = eq(a[size], b[size], aStack, bStack))) break; | |
| 1040 | } | |
| 1041 | } | |
| 1042 | } else { | |
| 1043 | // Deep compare objects. | |
| 1044 | var keys = _.keys(a), key; | |
| 1045 | size = keys.length; | |
| 1046 | // Ensure that both objects contain the same number of properties before comparing deep equality. | |
| 1047 | result = _.keys(b).length === size; | |
| 1048 | if (result) { | |
| 1049 | while (size--) { | |
| 1050 | // Deep compare each member | |
| 1051 | key = keys[size]; | |
| 1052 | if (!(result = _.has(b, key) && eq(a[key], b[key], aStack, bStack))) break; | |
| 1053 | } | |
| 1054 | } | |
| 1055 | } | |
| 1056 | // Remove the first object from the stack of traversed objects. | |
| 1057 | aStack.pop(); | |
| 1058 | bStack.pop(); | |
| 1059 | return result; | |
| 1060 | }; | |
| 1061 | ||
| 1062 | // Perform a deep comparison to check if two objects are equal. | |
| 1063 | _.isEqual = function(a, b) { | |
| 1064 | return eq(a, b, [], []); | |
| 1065 | }; | |
| 1066 | ||
| 1067 | // Is a given array, string, or object empty? | |
| 1068 | // An "empty" object has no enumerable own-properties. | |
| 1069 | _.isEmpty = function(obj) { | |
| 1070 | if (obj == null) return true; | |
| 1071 | if (_.isArray(obj) || _.isString(obj) || _.isArguments(obj)) return obj.length === 0; | |
| 1072 | for (var key in obj) if (_.has(obj, key)) return false; | |
| 1073 | return true; | |
| 1074 | }; | |
| 1075 | ||
| 1076 | // Is a given value a DOM element? | |
| 1077 | _.isElement = function(obj) { | |
| 1078 | return !!(obj && obj.nodeType === 1); | |
| 1079 | }; | |
| 1080 | ||
| 1081 | // Is a given value an array? | |
| 1082 | // Delegates to ECMA5's native Array.isArray | |
| 1083 | _.isArray = nativeIsArray || function(obj) { | |
| 1084 | return toString.call(obj) === '[object Array]'; | |
| 1085 | }; | |
| 1086 | ||
| 1087 | // Is a given variable an object? | |
| 1088 | _.isObject = function(obj) { | |
| 1089 | var type = typeof obj; | |
| 1090 | return type === 'function' || type === 'object' && !!obj; | |
| 1091 | }; | |
| 1092 | ||
| 1093 | // Add some isType methods: isArguments, isFunction, isString, isNumber, isDate, isRegExp. | |
| 1094 | _.each(['Arguments', 'Function', 'String', 'Number', 'Date', 'RegExp'], function(name) { | |
| 1095 | _['is' + name] = function(obj) { | |
| 1096 | return toString.call(obj) === '[object ' + name + ']'; | |
| 1097 | }; | |
| 1098 | }); | |
| 1099 | ||
| 1100 | // Define a fallback version of the method in browsers (ahem, IE), where | |
| 1101 | // there isn't any inspectable "Arguments" type. | |
| 1102 | if (!_.isArguments(arguments)) { | |
| 1103 | _.isArguments = function(obj) { | |
| 1104 | return _.has(obj, 'callee'); | |
| 1105 | }; | |
| 1106 | } | |
| 1107 | ||
| 1108 | // Optimize `isFunction` if appropriate. Work around an IE 11 bug. | |
| 1109 | if (typeof /./ !== 'function') { | |
| 1110 | _.isFunction = function(obj) { | |
| 1111 | return typeof obj == 'function' || false; | |
| 1112 | }; | |
| 1113 | } | |
| 1114 | ||
| 1115 | // Is a given object a finite number? | |
| 1116 | _.isFinite = function(obj) { | |
| 1117 | return isFinite(obj) && !isNaN(parseFloat(obj)); | |
| 1118 | }; | |
| 1119 | ||
| 1120 | // Is the given value `NaN`? (NaN is the only number which does not equal itself). | |
| 1121 | _.isNaN = function(obj) { | |
| 1122 | return _.isNumber(obj) && obj !== +obj; | |
| 1123 | }; | |
| 1124 | ||
| 1125 | // Is a given value a boolean? | |
| 1126 | _.isBoolean = function(obj) { | |
| 1127 | return obj === true || obj === false || toString.call(obj) === '[object Boolean]'; | |
| 1128 | }; | |
| 1129 | ||
| 1130 | // Is a given value equal to null? | |
| 1131 | _.isNull = function(obj) { | |
| 1132 | return obj === null; | |
| 1133 | }; | |
| 1134 | ||
| 1135 | // Is a given variable undefined? | |
| 1136 | _.isUndefined = function(obj) { | |
| 1137 | return obj === void 0; | |
| 1138 | }; | |
| 1139 | ||
| 1140 | // Shortcut function for checking if an object has a given property directly | |
| 1141 | // on itself (in other words, not on a prototype). | |
| 1142 | _.has = function(obj, key) { | |
| 1143 | return obj != null && hasOwnProperty.call(obj, key); | |
| 1144 | }; | |
| 1145 | ||
| 1146 | // Utility Functions | |
| 1147 | // ----------------- | |
| 1148 | ||
| 1149 | // Run Underscore.js in *noConflict* mode, returning the `_` variable to its | |
| 1150 | // previous owner. Returns a reference to the Underscore object. | |
| 1151 | _.noConflict = function() { | |
| 1152 | root._ = previousUnderscore; | |
| 1153 | return this; | |
| 1154 | }; | |
| 1155 | ||
| 1156 | // Keep the identity function around for default iteratees. | |
| 1157 | _.identity = function(value) { | |
| 1158 | return value; | |
| 1159 | }; | |
| 1160 | ||
| 1161 | _.constant = function(value) { | |
| 1162 | return function() { | |
| 1163 | return value; | |
| 1164 | }; | |
| 1165 | }; | |
| 1166 | ||
| 1167 | _.noop = function(){}; | |
| 1168 | ||
| 1169 | _.property = function(key) { | |
| 1170 | return function(obj) { | |
| 1171 | return obj[key]; | |
| 1172 | }; | |
| 1173 | }; | |
| 1174 | ||
| 1175 | // Returns a predicate for checking whether an object has a given set of `key:value` pairs. | |
| 1176 | _.matches = function(attrs) { | |
| 1177 | var pairs = _.pairs(attrs), length = pairs.length; | |
| 1178 | return function(obj) { | |
| 1179 | if (obj == null) return !length; | |
| 1180 | obj = new Object(obj); | |
| 1181 | for (var i = 0; i < length; i++) { | |
| 1182 | var pair = pairs[i], key = pair[0]; | |
| 1183 | if (pair[1] !== obj[key] || !(key in obj)) return false; | |
| 1184 | } | |
| 1185 | return true; | |
| 1186 | }; | |
| 1187 | }; | |
| 1188 | ||
| 1189 | // Run a function **n** times. | |
| 1190 | _.times = function(n, iteratee, context) { | |
| 1191 | var accum = Array(Math.max(0, n)); | |
| 1192 | iteratee = createCallback(iteratee, context, 1); | |
| 1193 | for (var i = 0; i < n; i++) accum[i] = iteratee(i); | |
| 1194 | return accum; | |
| 1195 | }; | |
| 1196 | ||
| 1197 | // Return a random integer between min and max (inclusive). | |
| 1198 | _.random = function(min, max) { | |
| 1199 | if (max == null) { | |
| 1200 | max = min; | |
| 1201 | min = 0; | |
| 1202 | } | |
| 1203 | return min + Math.floor(Math.random() * (max - min + 1)); | |
| 1204 | }; | |
| 1205 | ||
| 1206 | // A (possibly faster) way to get the current timestamp as an integer. | |
| 1207 | _.now = Date.now || function() { | |
| 1208 | return new Date().getTime(); | |
| 1209 | }; | |
| 1210 | ||
| 1211 | // List of HTML entities for escaping. | |
| 1212 | var escapeMap = { | |
| 1213 | '&': '&', | |
| 1214 | '<': '<', | |
| 1215 | '>': '>', | |
| 1216 | '"': '"', | |
| 1217 | "'": ''', | |
| 1218 | '`': '`' | |
| 1219 | }; | |
| 1220 | var unescapeMap = _.invert(escapeMap); | |
| 1221 | ||
| 1222 | // Functions for escaping and unescaping strings to/from HTML interpolation. | |
| 1223 | var createEscaper = function(map) { | |
| 1224 | var escaper = function(match) { | |
| 1225 | return map[match]; | |
| 1226 | }; | |
| 1227 | // Regexes for identifying a key that needs to be escaped | |
| 1228 | var source = '(?:' + _.keys(map).join('|') + ')'; | |
| 1229 | var testRegexp = RegExp(source); | |
| 1230 | var replaceRegexp = RegExp(source, 'g'); | |
| 1231 | return function(string) { | |
| 1232 | string = string == null ? '' : '' + string; | |
| 1233 | return testRegexp.test(string) ? string.replace(replaceRegexp, escaper) : string; | |
| 1234 | }; | |
| 1235 | }; | |
| 1236 | _.escape = createEscaper(escapeMap); | |
| 1237 | _.unescape = createEscaper(unescapeMap); | |
| 1238 | ||
| 1239 | // If the value of the named `property` is a function then invoke it with the | |
| 1240 | // `object` as context; otherwise, return it. | |
| 1241 | _.result = function(object, property) { | |
| 1242 | if (object == null) return void 0; | |
| 1243 | var value = object[property]; | |
| 1244 | return _.isFunction(value) ? object[property]() : value; | |
| 1245 | }; | |
| 1246 | ||
| 1247 | // Generate a unique integer id (unique within the entire client session). | |
| 1248 | // Useful for temporary DOM ids. | |
| 1249 | var idCounter = 0; | |
| 1250 | _.uniqueId = function(prefix) { | |
| 1251 | var id = ++idCounter + ''; | |
| 1252 | return prefix ? prefix + id : id; | |
| 1253 | }; | |
| 1254 | ||
| 1255 | // By default, Underscore uses ERB-style template delimiters, change the | |
| 1256 | // following template settings to use alternative delimiters. | |
| 1257 | _.templateSettings = { | |
| 1258 | evaluate : /<%([\s\S]+?)%>/g, | |
| 1259 | interpolate : /<%=([\s\S]+?)%>/g, | |
| 1260 | escape : /<%-([\s\S]+?)%>/g | |
| 1261 | }; | |
| 1262 | ||
| 1263 | // When customizing `templateSettings`, if you don't want to define an | |
| 1264 | // interpolation, evaluation or escaping regex, we need one that is | |
| 1265 | // guaranteed not to match. | |
| 1266 | var noMatch = /(.)^/; | |
| 1267 | ||
| 1268 | // Certain characters need to be escaped so that they can be put into a | |
| 1269 | // string literal. | |
| 1270 | var escapes = { | |
| 1271 | "'": "'", | |
| 1272 | '\\': '\\', | |
| 1273 | '\r': 'r', | |
| 1274 | '\n': 'n', | |
| 1275 | '\u2028': 'u2028', | |
| 1276 | '\u2029': 'u2029' | |
| 1277 | }; | |
| 1278 | ||
| 1279 | var escaper = /\\|'|\r|\n|\u2028|\u2029/g; | |
| 1280 | ||
| 1281 | var escapeChar = function(match) { | |
| 1282 | return '\\' + escapes[match]; | |
| 1283 | }; | |
| 1284 | ||
| 1285 | // JavaScript micro-templating, similar to John Resig's implementation. | |
| 1286 | // Underscore templating handles arbitrary delimiters, preserves whitespace, | |
| 1287 | // and correctly escapes quotes within interpolated code. | |
| 1288 | // NB: `oldSettings` only exists for backwards compatibility. | |
| 1289 | _.template = function(text, settings, oldSettings) { | |
| 1290 | if (!settings && oldSettings) settings = oldSettings; | |
| 1291 | settings = _.defaults({}, settings, _.templateSettings); | |
| 1292 | ||
| 1293 | // Combine delimiters into one regular expression via alternation. | |
| 1294 | var matcher = RegExp([ | |
| 1295 | (settings.escape || noMatch).source, | |
| 1296 | (settings.interpolate || noMatch).source, | |
| 1297 | (settings.evaluate || noMatch).source | |
| 1298 | ].join('|') + '|$', 'g'); | |
| 1299 | ||
| 1300 | // Compile the template source, escaping string literals appropriately. | |
| 1301 | var index = 0; | |
| 1302 | var source = "__p+='"; | |
| 1303 | text.replace(matcher, function(match, escape, interpolate, evaluate, offset) { | |
| 1304 | source += text.slice(index, offset).replace(escaper, escapeChar); | |
| 1305 | index = offset + match.length; | |
| 1306 | ||
| 1307 | if (escape) { | |
| 1308 | source += "'+\n((__t=(" + escape + "))==null?'':_.escape(__t))+\n'"; | |
| 1309 | } else if (interpolate) { | |
| 1310 | source += "'+\n((__t=(" + interpolate + "))==null?'':__t)+\n'"; | |
| 1311 | } else if (evaluate) { | |
| 1312 | source += "';\n" + evaluate + "\n__p+='"; | |
| 1313 | } | |
| 1314 | ||
| 1315 | // Adobe VMs need the match returned to produce the correct offest. | |
| 1316 | return match; | |
| 1317 | }); | |
| 1318 | source += "';\n"; | |
| 1319 | ||
| 1320 | // If a variable is not specified, place data values in local scope. | |
| 1321 | if (!settings.variable) source = 'with(obj||{}){\n' + source + '}\n'; | |
| 1322 | ||
| 1323 | source = "var __t,__p='',__j=Array.prototype.join," + | |
| 1324 | "print=function(){__p+=__j.call(arguments,'');};\n" + | |
| 1325 | source + 'return __p;\n'; | |
| 1326 | ||
| 1327 | try { | |
| 1328 | var render = new Function(settings.variable || 'obj', '_', source); | |
| 1329 | } catch (e) { | |
| 1330 | e.source = source; | |
| 1331 | throw e; | |
| 1332 | } | |
| 1333 | ||
| 1334 | var template = function(data) { | |
| 1335 | return render.call(this, data, _); | |
| 1336 | }; | |
| 1337 | ||
| 1338 | // Provide the compiled source as a convenience for precompilation. | |
| 1339 | var argument = settings.variable || 'obj'; | |
| 1340 | template.source = 'function(' + argument + '){\n' + source + '}'; | |
| 1341 | ||
| 1342 | return template; | |
| 1343 | }; | |
| 1344 | ||
| 1345 | // Add a "chain" function. Start chaining a wrapped Underscore object. | |
| 1346 | _.chain = function(obj) { | |
| 1347 | var instance = _(obj); | |
| 1348 | instance._chain = true; | |
| 1349 | return instance; | |
| 1350 | }; | |
| 1351 | ||
| 1352 | // OOP | |
| 1353 | // --------------- | |
| 1354 | // If Underscore is called as a function, it returns a wrapped object that | |
| 1355 | // can be used OO-style. This wrapper holds altered versions of all the | |
| 1356 | // underscore functions. Wrapped objects may be chained. | |
| 1357 | ||
| 1358 | // Helper function to continue chaining intermediate results. | |
| 1359 | var result = function(obj) { | |
| 1360 | return this._chain ? _(obj).chain() : obj; | |
| 1361 | }; | |
| 1362 | ||
| 1363 | // Add your own custom functions to the Underscore object. | |
| 1364 | _.mixin = function(obj) { | |
| 1365 | _.each(_.functions(obj), function(name) { | |
| 1366 | var func = _[name] = obj[name]; | |
| 1367 | _.prototype[name] = function() { | |
| 1368 | var args = [this._wrapped]; | |
| 1369 | push.apply(args, arguments); | |
| 1370 | return result.call(this, func.apply(_, args)); | |
| 1371 | }; | |
| 1372 | }); | |
| 1373 | }; | |
| 1374 | ||
| 1375 | // Add all of the Underscore functions to the wrapper object. | |
| 1376 | _.mixin(_); | |
| 1377 | ||
| 1378 | // Add all mutator Array functions to the wrapper. | |
| 1379 | _.each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) { | |
| 1380 | var method = ArrayProto[name]; | |
| 1381 | _.prototype[name] = function() { | |
| 1382 | var obj = this._wrapped; | |
| 1383 | method.apply(obj, arguments); | |
| 1384 | if ((name === 'shift' || name === 'splice') && obj.length === 0) delete obj[0]; | |
| 1385 | return result.call(this, obj); | |
| 1386 | }; | |
| 1387 | }); | |
| 1388 | ||
| 1389 | // Add all accessor Array functions to the wrapper. | |
| 1390 | _.each(['concat', 'join', 'slice'], function(name) { | |
| 1391 | var method = ArrayProto[name]; | |
| 1392 | _.prototype[name] = function() { | |
| 1393 | return result.call(this, method.apply(this._wrapped, arguments)); | |
| 1394 | }; | |
| 1395 | }); | |
| 1396 | ||
| 1397 | // Extracts the result from a wrapped and chained object. | |
| 1398 | _.prototype.value = function() { | |
| 1399 | return this._wrapped; | |
| 1400 | }; | |
| 1401 | ||
| 1402 | // AMD registration happens at the end for compatibility with AMD loaders | |
| 1403 | // that may not enforce next-turn semantics on modules. Even though general | |
| 1404 | // practice for AMD registration is to be anonymous, underscore registers | |
| 1405 | // as a named module because, like jQuery, it is a base library that is | |
| 1406 | // popular enough to be bundled in a third party lib, but not be part of | |
| 1407 | // an AMD load request. Those cases could generate an error when an | |
| 1408 | // anonymous define() is called outside of a loader request. | |
| 1409 | if (typeof define === 'function' && define.amd) { | |
| 1410 | define('underscore', [], function() { | |
| 1411 | return _; | |
| 1412 | }); | |
| 1413 | } | |
| 1414 | }.call(this)); | |
| 0 | // Underscore.js 1.3.1 | |
| 1 | // (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc. | |
| 2 | // Underscore is freely distributable under the MIT license. | |
| 3 | // Portions of Underscore are inspired or borrowed from Prototype, | |
| 4 | // Oliver Steele's Functional, and John Resig's Micro-Templating. | |
| 5 | // For all details and documentation: | |
| 6 | // http://documentcloud.github.com/underscore | |
| 7 | (function(){function q(a,c,d){if(a===c)return a!==0||1/a==1/c;if(a==null||c==null)return a===c;if(a._chain)a=a._wrapped;if(c._chain)c=c._wrapped;if(a.isEqual&&b.isFunction(a.isEqual))return a.isEqual(c);if(c.isEqual&&b.isFunction(c.isEqual))return c.isEqual(a);var e=l.call(a);if(e!=l.call(c))return false;switch(e){case "[object String]":return a==String(c);case "[object Number]":return a!=+a?c!=+c:a==0?1/a==1/c:a==+c;case "[object Date]":case "[object Boolean]":return+a==+c;case "[object RegExp]":return a.source== | |
| 8 | c.source&&a.global==c.global&&a.multiline==c.multiline&&a.ignoreCase==c.ignoreCase}if(typeof a!="object"||typeof c!="object")return false;for(var f=d.length;f--;)if(d[f]==a)return true;d.push(a);var f=0,g=true;if(e=="[object Array]"){if(f=a.length,g=f==c.length)for(;f--;)if(!(g=f in a==f in c&&q(a[f],c[f],d)))break}else{if("constructor"in a!="constructor"in c||a.constructor!=c.constructor)return false;for(var h in a)if(b.has(a,h)&&(f++,!(g=b.has(c,h)&&q(a[h],c[h],d))))break;if(g){for(h in c)if(b.has(c, | |
| 9 | h)&&!f--)break;g=!f}}d.pop();return g}var r=this,G=r._,n={},k=Array.prototype,o=Object.prototype,i=k.slice,H=k.unshift,l=o.toString,I=o.hasOwnProperty,w=k.forEach,x=k.map,y=k.reduce,z=k.reduceRight,A=k.filter,B=k.every,C=k.some,p=k.indexOf,D=k.lastIndexOf,o=Array.isArray,J=Object.keys,s=Function.prototype.bind,b=function(a){return new m(a)};if(typeof exports!=="undefined"){if(typeof module!=="undefined"&&module.exports)exports=module.exports=b;exports._=b}else r._=b;b.VERSION="1.3.1";var j=b.each= | |
| 10 | b.forEach=function(a,c,d){if(a!=null)if(w&&a.forEach===w)a.forEach(c,d);else if(a.length===+a.length)for(var e=0,f=a.length;e<f;e++){if(e in a&&c.call(d,a[e],e,a)===n)break}else for(e in a)if(b.has(a,e)&&c.call(d,a[e],e,a)===n)break};b.map=b.collect=function(a,c,b){var e=[];if(a==null)return e;if(x&&a.map===x)return a.map(c,b);j(a,function(a,g,h){e[e.length]=c.call(b,a,g,h)});if(a.length===+a.length)e.length=a.length;return e};b.reduce=b.foldl=b.inject=function(a,c,d,e){var f=arguments.length>2;a== | |
| 11 | null&&(a=[]);if(y&&a.reduce===y)return e&&(c=b.bind(c,e)),f?a.reduce(c,d):a.reduce(c);j(a,function(a,b,i){f?d=c.call(e,d,a,b,i):(d=a,f=true)});if(!f)throw new TypeError("Reduce of empty array with no initial value");return d};b.reduceRight=b.foldr=function(a,c,d,e){var f=arguments.length>2;a==null&&(a=[]);if(z&&a.reduceRight===z)return e&&(c=b.bind(c,e)),f?a.reduceRight(c,d):a.reduceRight(c);var g=b.toArray(a).reverse();e&&!f&&(c=b.bind(c,e));return f?b.reduce(g,c,d,e):b.reduce(g,c)};b.find=b.detect= | |
| 12 | function(a,c,b){var e;E(a,function(a,g,h){if(c.call(b,a,g,h))return e=a,true});return e};b.filter=b.select=function(a,c,b){var e=[];if(a==null)return e;if(A&&a.filter===A)return a.filter(c,b);j(a,function(a,g,h){c.call(b,a,g,h)&&(e[e.length]=a)});return e};b.reject=function(a,c,b){var e=[];if(a==null)return e;j(a,function(a,g,h){c.call(b,a,g,h)||(e[e.length]=a)});return e};b.every=b.all=function(a,c,b){var e=true;if(a==null)return e;if(B&&a.every===B)return a.every(c,b);j(a,function(a,g,h){if(!(e= | |
| 13 | e&&c.call(b,a,g,h)))return n});return e};var E=b.some=b.any=function(a,c,d){c||(c=b.identity);var e=false;if(a==null)return e;if(C&&a.some===C)return a.some(c,d);j(a,function(a,b,h){if(e||(e=c.call(d,a,b,h)))return n});return!!e};b.include=b.contains=function(a,c){var b=false;if(a==null)return b;return p&&a.indexOf===p?a.indexOf(c)!=-1:b=E(a,function(a){return a===c})};b.invoke=function(a,c){var d=i.call(arguments,2);return b.map(a,function(a){return(b.isFunction(c)?c||a:a[c]).apply(a,d)})};b.pluck= | |
| 14 | function(a,c){return b.map(a,function(a){return a[c]})};b.max=function(a,c,d){if(!c&&b.isArray(a))return Math.max.apply(Math,a);if(!c&&b.isEmpty(a))return-Infinity;var e={computed:-Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b>=e.computed&&(e={value:a,computed:b})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);if(!c&&b.isEmpty(a))return Infinity;var e={computed:Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b<e.computed&&(e={value:a,computed:b})}); | |
| 15 | return e.value};b.shuffle=function(a){var b=[],d;j(a,function(a,f){f==0?b[0]=a:(d=Math.floor(Math.random()*(f+1)),b[f]=b[d],b[d]=a)});return b};b.sortBy=function(a,c,d){return b.pluck(b.map(a,function(a,b,g){return{value:a,criteria:c.call(d,a,b,g)}}).sort(function(a,b){var c=a.criteria,d=b.criteria;return c<d?-1:c>d?1:0}),"value")};b.groupBy=function(a,c){var d={},e=b.isFunction(c)?c:function(a){return a[c]};j(a,function(a,b){var c=e(a,b);(d[c]||(d[c]=[])).push(a)});return d};b.sortedIndex=function(a, | |
| 16 | c,d){d||(d=b.identity);for(var e=0,f=a.length;e<f;){var g=e+f>>1;d(a[g])<d(c)?e=g+1:f=g}return e};b.toArray=function(a){return!a?[]:a.toArray?a.toArray():b.isArray(a)?i.call(a):b.isArguments(a)?i.call(a):b.values(a)};b.size=function(a){return b.toArray(a).length};b.first=b.head=function(a,b,d){return b!=null&&!d?i.call(a,0,b):a[0]};b.initial=function(a,b,d){return i.call(a,0,a.length-(b==null||d?1:b))};b.last=function(a,b,d){return b!=null&&!d?i.call(a,Math.max(a.length-b,0)):a[a.length-1]};b.rest= | |
| 17 | b.tail=function(a,b,d){return i.call(a,b==null||d?1:b)};b.compact=function(a){return b.filter(a,function(a){return!!a})};b.flatten=function(a,c){return b.reduce(a,function(a,e){if(b.isArray(e))return a.concat(c?e:b.flatten(e));a[a.length]=e;return a},[])};b.without=function(a){return b.difference(a,i.call(arguments,1))};b.uniq=b.unique=function(a,c,d){var d=d?b.map(a,d):a,e=[];b.reduce(d,function(d,g,h){if(0==h||(c===true?b.last(d)!=g:!b.include(d,g)))d[d.length]=g,e[e.length]=a[h];return d},[]); | |
| 18 | return e};b.union=function(){return b.uniq(b.flatten(arguments,true))};b.intersection=b.intersect=function(a){var c=i.call(arguments,1);return b.filter(b.uniq(a),function(a){return b.every(c,function(c){return b.indexOf(c,a)>=0})})};b.difference=function(a){var c=b.flatten(i.call(arguments,1));return b.filter(a,function(a){return!b.include(c,a)})};b.zip=function(){for(var a=i.call(arguments),c=b.max(b.pluck(a,"length")),d=Array(c),e=0;e<c;e++)d[e]=b.pluck(a,""+e);return d};b.indexOf=function(a,c, | |
| 19 | d){if(a==null)return-1;var e;if(d)return d=b.sortedIndex(a,c),a[d]===c?d:-1;if(p&&a.indexOf===p)return a.indexOf(c);for(d=0,e=a.length;d<e;d++)if(d in a&&a[d]===c)return d;return-1};b.lastIndexOf=function(a,b){if(a==null)return-1;if(D&&a.lastIndexOf===D)return a.lastIndexOf(b);for(var d=a.length;d--;)if(d in a&&a[d]===b)return d;return-1};b.range=function(a,b,d){arguments.length<=1&&(b=a||0,a=0);for(var d=arguments[2]||1,e=Math.max(Math.ceil((b-a)/d),0),f=0,g=Array(e);f<e;)g[f++]=a,a+=d;return g}; | |
| 20 | var F=function(){};b.bind=function(a,c){var d,e;if(a.bind===s&&s)return s.apply(a,i.call(arguments,1));if(!b.isFunction(a))throw new TypeError;e=i.call(arguments,2);return d=function(){if(!(this instanceof d))return a.apply(c,e.concat(i.call(arguments)));F.prototype=a.prototype;var b=new F,g=a.apply(b,e.concat(i.call(arguments)));return Object(g)===g?g:b}};b.bindAll=function(a){var c=i.call(arguments,1);c.length==0&&(c=b.functions(a));j(c,function(c){a[c]=b.bind(a[c],a)});return a};b.memoize=function(a, | |
| 21 | c){var d={};c||(c=b.identity);return function(){var e=c.apply(this,arguments);return b.has(d,e)?d[e]:d[e]=a.apply(this,arguments)}};b.delay=function(a,b){var d=i.call(arguments,2);return setTimeout(function(){return a.apply(a,d)},b)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(i.call(arguments,1)))};b.throttle=function(a,c){var d,e,f,g,h,i=b.debounce(function(){h=g=false},c);return function(){d=this;e=arguments;var b;f||(f=setTimeout(function(){f=null;h&&a.apply(d,e);i()},c));g?h=true: | |
| 22 | a.apply(d,e);i();g=true}};b.debounce=function(a,b){var d;return function(){var e=this,f=arguments;clearTimeout(d);d=setTimeout(function(){d=null;a.apply(e,f)},b)}};b.once=function(a){var b=false,d;return function(){if(b)return d;b=true;return d=a.apply(this,arguments)}};b.wrap=function(a,b){return function(){var d=[a].concat(i.call(arguments,0));return b.apply(this,d)}};b.compose=function(){var a=arguments;return function(){for(var b=arguments,d=a.length-1;d>=0;d--)b=[a[d].apply(this,b)];return b[0]}}; | |
| 23 | b.after=function(a,b){return a<=0?b():function(){if(--a<1)return b.apply(this,arguments)}};b.keys=J||function(a){if(a!==Object(a))throw new TypeError("Invalid object");var c=[],d;for(d in a)b.has(a,d)&&(c[c.length]=d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=b.methods=function(a){var c=[],d;for(d in a)b.isFunction(a[d])&&c.push(d);return c.sort()};b.extend=function(a){j(i.call(arguments,1),function(b){for(var d in b)a[d]=b[d]});return a};b.defaults=function(a){j(i.call(arguments, | |
| 24 | 1),function(b){for(var d in b)a[d]==null&&(a[d]=b[d])});return a};b.clone=function(a){return!b.isObject(a)?a:b.isArray(a)?a.slice():b.extend({},a)};b.tap=function(a,b){b(a);return a};b.isEqual=function(a,b){return q(a,b,[])};b.isEmpty=function(a){if(b.isArray(a)||b.isString(a))return a.length===0;for(var c in a)if(b.has(a,c))return false;return true};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=o||function(a){return l.call(a)=="[object Array]"};b.isObject=function(a){return a===Object(a)}; | |
| 25 | b.isArguments=function(a){return l.call(a)=="[object Arguments]"};if(!b.isArguments(arguments))b.isArguments=function(a){return!(!a||!b.has(a,"callee"))};b.isFunction=function(a){return l.call(a)=="[object Function]"};b.isString=function(a){return l.call(a)=="[object String]"};b.isNumber=function(a){return l.call(a)=="[object Number]"};b.isNaN=function(a){return a!==a};b.isBoolean=function(a){return a===true||a===false||l.call(a)=="[object Boolean]"};b.isDate=function(a){return l.call(a)=="[object Date]"}; | |
| 26 | b.isRegExp=function(a){return l.call(a)=="[object RegExp]"};b.isNull=function(a){return a===null};b.isUndefined=function(a){return a===void 0};b.has=function(a,b){return I.call(a,b)};b.noConflict=function(){r._=G;return this};b.identity=function(a){return a};b.times=function(a,b,d){for(var e=0;e<a;e++)b.call(d,e)};b.escape=function(a){return(""+a).replace(/&/g,"&").replace(/</g,"<").replace(/>/g,">").replace(/"/g,""").replace(/'/g,"'").replace(/\//g,"/")};b.mixin=function(a){j(b.functions(a), | |
| 27 | function(c){K(c,b[c]=a[c])})};var L=0;b.uniqueId=function(a){var b=L++;return a?a+b:b};b.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g};var t=/.^/,u=function(a){return a.replace(/\\\\/g,"\\").replace(/\\'/g,"'")};b.template=function(a,c){var d=b.templateSettings,d="var __p=[],print=function(){__p.push.apply(__p,arguments);};with(obj||{}){__p.push('"+a.replace(/\\/g,"\\\\").replace(/'/g,"\\'").replace(d.escape||t,function(a,b){return"',_.escape("+ | |
| 28 | u(b)+"),'"}).replace(d.interpolate||t,function(a,b){return"',"+u(b)+",'"}).replace(d.evaluate||t,function(a,b){return"');"+u(b).replace(/[\r\n\t]/g," ")+";__p.push('"}).replace(/\r/g,"\\r").replace(/\n/g,"\\n").replace(/\t/g,"\\t")+"');}return __p.join('');",e=new Function("obj","_",d);return c?e(c,b):function(a){return e.call(this,a,b)}};b.chain=function(a){return b(a).chain()};var m=function(a){this._wrapped=a};b.prototype=m.prototype;var v=function(a,c){return c?b(a).chain():a},K=function(a,c){m.prototype[a]= | |
| 29 | function(){var a=i.call(arguments);H.call(a,this._wrapped);return v(c.apply(b,a),this._chain)}};b.mixin(b);j("pop,push,reverse,shift,sort,splice,unshift".split(","),function(a){var b=k[a];m.prototype[a]=function(){var d=this._wrapped;b.apply(d,arguments);var e=d.length;(a=="shift"||a=="splice")&&e===0&&delete d[0];return v(d,this._chain)}});j(["concat","join","slice"],function(a){var b=k[a];m.prototype[a]=function(){return v(b.apply(this._wrapped,arguments),this._chain)}});m.prototype.chain=function(){this._chain= | |
| 30 | true;return this};m.prototype.value=function(){return this._wrapped}}).call(this); |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | 0 | |
| 1 | <!DOCTYPE html> | |
| 3 | 2 | |
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>NBNSProtocol Class — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>NBNSProtocol Class — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../index.html" /> | |
| 10 | <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> | |
| 11 | <script src="../_static/jquery.js"></script> | |
| 12 | <script src="../_static/underscore.js"></script> | |
| 13 | <script src="../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../search.html" /> | |
| 26 | 16 | <link rel="next" title="NetBIOS class" href="nmb_NetBIOS.html" /> |
| 27 | 17 | <link rel="prev" title="Welcome to pysmb’s documentation!" href="../index.html" /> |
| 28 | </head> | |
| 29 | <body role="document"> | |
| 18 | </head><body> | |
| 30 | 19 | <div class="related" role="navigation" aria-label="related navigation"> |
| 31 | 20 | <h3>Navigation</h3> |
| 32 | 21 | <ul> |
| 34 | 23 | <a href="../genindex.html" title="General Index" |
| 35 | 24 | accesskey="I">index</a></li> |
| 36 | 25 | <li class="right" > |
| 26 | <a href="../py-modindex.html" title="Python Module Index" | |
| 27 | >modules</a> |</li> | |
| 28 | <li class="right" > | |
| 37 | 29 | <a href="nmb_NetBIOS.html" title="NetBIOS class" |
| 38 | 30 | accesskey="N">next</a> |</li> |
| 39 | 31 | <li class="right" > |
| 40 | 32 | <a href="../index.html" title="Welcome to pysmb’s documentation!" |
| 41 | 33 | accesskey="P">previous</a> |</li> |
| 42 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 34 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 35 | <li class="nav-item nav-item-this"><a href="">NBNSProtocol Class</a></li> | |
| 43 | 36 | </ul> |
| 44 | </div> | |
| 45 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 46 | <div class="sphinxsidebarwrapper"> | |
| 47 | <h4>Previous topic</h4> | |
| 48 | <p class="topless"><a href="../index.html" | |
| 49 | title="previous chapter">Welcome to pysmb’s documentation!</a></p> | |
| 50 | <h4>Next topic</h4> | |
| 51 | <p class="topless"><a href="nmb_NetBIOS.html" | |
| 52 | title="next chapter">NetBIOS class</a></p> | |
| 53 | <div role="note" aria-label="source link"> | |
| 54 | <h3>This Page</h3> | |
| 55 | <ul class="this-page-menu"> | |
| 56 | <li><a href="../_sources/api/nmb_NBNSProtocol.txt" | |
| 57 | rel="nofollow">Show Source</a></li> | |
| 58 | </ul> | |
| 59 | </div> | |
| 60 | <div id="searchbox" style="display: none" role="search"> | |
| 61 | <h3>Quick search</h3> | |
| 62 | <form class="search" action="../search.html" method="get"> | |
| 63 | <input type="text" name="q" /> | |
| 64 | <input type="submit" value="Go" /> | |
| 65 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 66 | <input type="hidden" name="area" value="default" /> | |
| 67 | </form> | |
| 68 | <p class="searchtip" style="font-size: 90%"> | |
| 69 | Enter search terms or a module, class or function name. | |
| 70 | </p> | |
| 71 | </div> | |
| 72 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 73 | </div> | |
| 74 | </div> | |
| 37 | </div> | |
| 75 | 38 | |
| 76 | 39 | <div class="document"> |
| 77 | 40 | <div class="documentwrapper"> |
| 82 | 45 | <h1>NBNSProtocol Class<a class="headerlink" href="#nbnsprotocol-class" title="Permalink to this headline">¶</a></h1> |
| 83 | 46 | <p>pysmb has a <em>NBNSProtocol</em> implementation for Twisted framework. |
| 84 | 47 | This allows you to perform name query asynchronously without having your application to block and wait for the results.</p> |
| 85 | <dl class="docutils"> | |
| 86 | <dt>In your project,</dt> | |
| 87 | <dd><ol class="first last arabic simple"> | |
| 88 | <li>Create a NBNSProtocol instance.</li> | |
| 89 | <li>Just call <em>queryName</em> method which will return a <em>Deferred</em> instance. Add your callback function to the <em>Deferred</em> instance via <em>addCallback</em> method to receive the results of the name query.</li> | |
| 90 | <li>When you are done with the NBNSProtocol instance, call its <NBNSProtocol instance>.transport.stopListening method to remove this instance from the reactor.</li> | |
| 48 | <dl class="simple"> | |
| 49 | <dt>In your project,</dt><dd><ol class="arabic simple"> | |
| 50 | <li><p>Create a NBNSProtocol instance.</p></li> | |
| 51 | <li><p>Just call <em>queryName</em> method which will return a <em>Deferred</em> instance. Add your callback function to the <em>Deferred</em> instance via <em>addCallback</em> method to receive the results of the name query.</p></li> | |
| 52 | <li><p>When you are done with the NBNSProtocol instance, call its <NBNSProtocol instance>.transport.stopListening method to remove this instance from the reactor.</p></li> | |
| 91 | 53 | </ol> |
| 92 | 54 | </dd> |
| 93 | 55 | </dl> |
| 94 | <dl class="class"> | |
| 56 | <dl class="py class"> | |
| 95 | 57 | <dt id="nmb.NetBIOSProtocol.NBNSProtocol"> |
| 96 | <em class="property">class </em><code class="descclassname">nmb.NetBIOSProtocol.</code><code class="descname">NBNSProtocol</code><span class="sig-paren">(</span><em>broadcast=True</em>, <em>listen_port=0</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOSProtocol.html#NBNSProtocol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOSProtocol.NBNSProtocol" title="Permalink to this definition">¶</a></dt> | |
| 97 | <dd><dl class="method"> | |
| 58 | <em class="property">class </em><code class="sig-prename descclassname">nmb.NetBIOSProtocol.</code><code class="sig-name descname">NBNSProtocol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">broadcast</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">listen_port</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOSProtocol.html#NBNSProtocol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOSProtocol.NBNSProtocol" title="Permalink to this definition">¶</a></dt> | |
| 59 | <dd><dl class="py method"> | |
| 98 | 60 | <dt id="nmb.NetBIOSProtocol.NBNSProtocol.__init__"> |
| 99 | <code class="descname">__init__</code><span class="sig-paren">(</span><em>broadcast=True</em>, <em>listen_port=0</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOSProtocol.html#NBNSProtocol.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOSProtocol.NBNSProtocol.__init__" title="Permalink to this definition">¶</a></dt> | |
| 61 | <code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">broadcast</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">listen_port</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOSProtocol.html#NBNSProtocol.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOSProtocol.NBNSProtocol.__init__" title="Permalink to this definition">¶</a></dt> | |
| 100 | 62 | <dd><p>Instantiate a NBNSProtocol instance.</p> |
| 101 | 63 | <p>This automatically calls reactor.listenUDP method to start listening for incoming packets, so you <strong>must not</strong> call the listenUDP method again.</p> |
| 102 | <table class="docutils field-list" frame="void" rules="none"> | |
| 103 | <col class="field-name" /> | |
| 104 | <col class="field-body" /> | |
| 105 | <tbody valign="top"> | |
| 106 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | |
| 107 | <li><strong>broadcast</strong> (<em>boolean</em>) – A boolean flag to indicate if we should setup the listening UDP port in broadcast mode</li> | |
| 108 | <li><strong>listen_port</strong> (<em>integer</em>) – Specifies the UDP port number to bind to for listening. If zero, OS will automatically select a free port number.</li> | |
| 64 | <dl class="field-list simple"> | |
| 65 | <dt class="field-odd">Parameters</dt> | |
| 66 | <dd class="field-odd"><ul class="simple"> | |
| 67 | <li><p><strong>broadcast</strong> (<em>boolean</em>) – A boolean flag to indicate if we should setup the listening UDP port in broadcast mode</p></li> | |
| 68 | <li><p><strong>listen_port</strong> (<em>integer</em>) – Specifies the UDP port number to bind to for listening. If zero, OS will automatically select a free port number.</p></li> | |
| 109 | 69 | </ul> |
| 110 | </td> | |
| 111 | </tr> | |
| 112 | </tbody> | |
| 113 | </table> | |
| 70 | </dd> | |
| 71 | </dl> | |
| 114 | 72 | </dd></dl> |
| 115 | 73 | |
| 116 | <dl class="method"> | |
| 74 | <dl class="py method"> | |
| 75 | <dt id="nmb.NetBIOSProtocol.NBNSProtocol.datagramReceived"> | |
| 76 | <code class="sig-name descname">datagramReceived</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">from_info</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOSProtocol.html#NBNSProtocol.datagramReceived"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOSProtocol.NBNSProtocol.datagramReceived" title="Permalink to this definition">¶</a></dt> | |
| 77 | <dd><p>Called when a datagram is received.</p> | |
| 78 | <p>@param datagram: the string received from the transport. | |
| 79 | @param addr: tuple of source of datagram.</p> | |
| 80 | </dd></dl> | |
| 81 | ||
| 82 | <dl class="py method"> | |
| 117 | 83 | <dt id="nmb.NetBIOSProtocol.NBNSProtocol.queryIPForName"> |
| 118 | <code class="descname">queryIPForName</code><span class="sig-paren">(</span><em>ip</em>, <em>port=137</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOSProtocol.html#NBNSProtocol.queryIPForName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOSProtocol.NBNSProtocol.queryIPForName" title="Permalink to this definition">¶</a></dt> | |
| 84 | <code class="sig-name descname">queryIPForName</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ip</span></em>, <em class="sig-param"><span class="n">port</span><span class="o">=</span><span class="default_value">137</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOSProtocol.html#NBNSProtocol.queryIPForName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOSProtocol.NBNSProtocol.queryIPForName" title="Permalink to this definition">¶</a></dt> | |
| 119 | 85 | <dd><p>Send a query to the machine with <em>ip</em> and hopes that the machine will reply back with its name.</p> |
| 120 | 86 | <p>The implementation of this function is contributed by Jason Anderson.</p> |
| 121 | <table class="docutils field-list" frame="void" rules="none"> | |
| 122 | <col class="field-name" /> | |
| 123 | <col class="field-body" /> | |
| 124 | <tbody valign="top"> | |
| 125 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 126 | <li><strong>ip</strong> (<em>string</em>) – 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. | |
| 127 | If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.</li> | |
| 128 | <li><strong>port</strong> (<em>integer</em>) – 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.</li> | |
| 129 | <li><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds to wait for a reply, after which the method will return None</li> | |
| 87 | <dl class="field-list simple"> | |
| 88 | <dt class="field-odd">Parameters</dt> | |
| 89 | <dd class="field-odd"><ul class="simple"> | |
| 90 | <li><p><strong>ip</strong> (<em>string</em>) – 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. | |
| 91 | If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.</p></li> | |
| 92 | <li><p><strong>port</strong> (<em>integer</em>) – 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.</p></li> | |
| 93 | <li><p><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds to wait for a reply, after which the method will return None</p></li> | |
| 130 | 94 | </ul> |
| 131 | </td> | |
| 132 | </tr> | |
| 133 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a list of names of the machine at <em>ip</em>. | |
| 95 | </dd> | |
| 96 | <dt class="field-even">Returns</dt> | |
| 97 | <dd class="field-even"><p>A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a list of names of the machine at <em>ip</em>. | |
| 134 | 98 | On timeout, the errback function will be called with a Failure instance wrapping around a NetBIOSTimeout exception</p> |
| 135 | </td> | |
| 136 | </tr> | |
| 137 | </tbody> | |
| 138 | </table> | |
| 99 | </dd> | |
| 100 | </dl> | |
| 139 | 101 | </dd></dl> |
| 140 | 102 | |
| 141 | <dl class="method"> | |
| 103 | <dl class="py method"> | |
| 142 | 104 | <dt id="nmb.NetBIOSProtocol.NBNSProtocol.queryName"> |
| 143 | <code class="descname">queryName</code><span class="sig-paren">(</span><em>name</em>, <em>ip=''</em>, <em>port=137</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOSProtocol.html#NBNSProtocol.queryName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOSProtocol.NBNSProtocol.queryName" title="Permalink to this definition">¶</a></dt> | |
| 105 | <code class="sig-name descname">queryName</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">ip</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">port</span><span class="o">=</span><span class="default_value">137</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOSProtocol.html#NBNSProtocol.queryName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOSProtocol.NBNSProtocol.queryName" title="Permalink to this definition">¶</a></dt> | |
| 144 | 106 | <dd><p>Send a query on the network and hopes that if machine matching the <em>name</em> will reply with its IP address.</p> |
| 145 | <table class="docutils field-list" frame="void" rules="none"> | |
| 146 | <col class="field-name" /> | |
| 147 | <col class="field-body" /> | |
| 148 | <tbody valign="top"> | |
| 149 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 150 | <li><strong>ip</strong> (<em>string</em>) – 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. | |
| 151 | If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.</li> | |
| 152 | <li><strong>port</strong> (<em>integer</em>) – 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.</li> | |
| 153 | <li><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds to wait for a reply, after which the returned Deferred instance will be called with a NetBIOSTimeout exception.</li> | |
| 107 | <dl class="field-list simple"> | |
| 108 | <dt class="field-odd">Parameters</dt> | |
| 109 | <dd class="field-odd"><ul class="simple"> | |
| 110 | <li><p><strong>ip</strong> (<em>string</em>) – 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. | |
| 111 | If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.</p></li> | |
| 112 | <li><p><strong>port</strong> (<em>integer</em>) – 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.</p></li> | |
| 113 | <li><p><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds to wait for a reply, after which the returned Deferred instance will be called with a NetBIOSTimeout exception.</p></li> | |
| 154 | 114 | </ul> |
| 155 | </td> | |
| 156 | </tr> | |
| 157 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a list of IP addresses in dotted notation (aaa.bbb.ccc.ddd). | |
| 115 | </dd> | |
| 116 | <dt class="field-even">Returns</dt> | |
| 117 | <dd class="field-even"><p>A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a list of IP addresses in dotted notation (aaa.bbb.ccc.ddd). | |
| 158 | 118 | On timeout, the errback function will be called with a Failure instance wrapping around a NetBIOSTimeout exception</p> |
| 159 | </td> | |
| 160 | </tr> | |
| 161 | </tbody> | |
| 162 | </table> | |
| 119 | </dd> | |
| 120 | </dl> | |
| 121 | </dd></dl> | |
| 122 | ||
| 123 | <dl class="py method"> | |
| 124 | <dt id="nmb.NetBIOSProtocol.NBNSProtocol.stopProtocol"> | |
| 125 | <code class="sig-name descname">stopProtocol</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOSProtocol.html#NBNSProtocol.stopProtocol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOSProtocol.NBNSProtocol.stopProtocol" title="Permalink to this definition">¶</a></dt> | |
| 126 | <dd><p>Called when the transport is disconnected.</p> | |
| 127 | <p>Will only be called once, after all ports are disconnected.</p> | |
| 163 | 128 | </dd></dl> |
| 164 | 129 | |
| 165 | 130 | </dd></dl> |
| 166 | 131 | |
| 167 | <dl class="class"> | |
| 132 | <dl class="py class"> | |
| 168 | 133 | <dt id="nmb.NetBIOSProtocol.NetBIOSTimeout"> |
| 169 | <em class="property">class </em><code class="descclassname">nmb.NetBIOSProtocol.</code><code class="descname">NetBIOSTimeout</code><a class="reference internal" href="../_modules/nmb/NetBIOSProtocol.html#NetBIOSTimeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOSProtocol.NetBIOSTimeout" title="Permalink to this definition">¶</a></dt> | |
| 134 | <em class="property">class </em><code class="sig-prename descclassname">nmb.NetBIOSProtocol.</code><code class="sig-name descname">NetBIOSTimeout</code><a class="reference internal" href="../_modules/nmb/NetBIOSProtocol.html#NetBIOSTimeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOSProtocol.NetBIOSTimeout" title="Permalink to this definition">¶</a></dt> | |
| 170 | 135 | <dd><p>Raised in NBNSProtocol via Deferred.errback method when queryName method has timeout waiting for reply</p> |
| 171 | 136 | </dd></dl> |
| 172 | 137 | |
| 173 | 138 | </div> |
| 174 | 139 | |
| 175 | 140 | |
| 141 | <div class="clearer"></div> | |
| 176 | 142 | </div> |
| 143 | </div> | |
| 144 | </div> | |
| 145 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 146 | <div class="sphinxsidebarwrapper"> | |
| 147 | <h4>Previous topic</h4> | |
| 148 | <p class="topless"><a href="../index.html" | |
| 149 | title="previous chapter">Welcome to pysmb’s documentation!</a></p> | |
| 150 | <h4>Next topic</h4> | |
| 151 | <p class="topless"><a href="nmb_NetBIOS.html" | |
| 152 | title="next chapter">NetBIOS class</a></p> | |
| 153 | <div role="note" aria-label="source link"> | |
| 154 | <h3>This Page</h3> | |
| 155 | <ul class="this-page-menu"> | |
| 156 | <li><a href="../_sources/api/nmb_NBNSProtocol.rst.txt" | |
| 157 | rel="nofollow">Show Source</a></li> | |
| 158 | </ul> | |
| 159 | </div> | |
| 160 | <div id="searchbox" style="display: none" role="search"> | |
| 161 | <h3 id="searchlabel">Quick search</h3> | |
| 162 | <div class="searchformwrapper"> | |
| 163 | <form class="search" action="../search.html" method="get"> | |
| 164 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 165 | <input type="submit" value="Go" /> | |
| 166 | </form> | |
| 167 | </div> | |
| 168 | </div> | |
| 169 | <script>$('#searchbox').show(0);</script> | |
| 177 | 170 | </div> |
| 178 | 171 | </div> |
| 179 | 172 | <div class="clearer"></div> |
| 185 | 178 | <a href="../genindex.html" title="General Index" |
| 186 | 179 | >index</a></li> |
| 187 | 180 | <li class="right" > |
| 181 | <a href="../py-modindex.html" title="Python Module Index" | |
| 182 | >modules</a> |</li> | |
| 183 | <li class="right" > | |
| 188 | 184 | <a href="nmb_NetBIOS.html" title="NetBIOS class" |
| 189 | 185 | >next</a> |</li> |
| 190 | 186 | <li class="right" > |
| 191 | 187 | <a href="../index.html" title="Welcome to pysmb’s documentation!" |
| 192 | 188 | >previous</a> |</li> |
| 193 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 189 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 190 | <li class="nav-item nav-item-this"><a href="">NBNSProtocol Class</a></li> | |
| 194 | 191 | </ul> |
| 195 | 192 | </div> |
| 196 | 193 | <div class="footer" role="contentinfo"> |
| 197 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 198 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 194 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 195 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 199 | 196 | </div> |
| 200 | 197 | </body> |
| 201 | 198 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | 0 | |
| 1 | <!DOCTYPE html> | |
| 3 | 2 | |
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>NetBIOS class — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>NetBIOS class — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../index.html" /> | |
| 10 | <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> | |
| 11 | <script src="../_static/jquery.js"></script> | |
| 12 | <script src="../_static/underscore.js"></script> | |
| 13 | <script src="../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../search.html" /> | |
| 26 | 16 | <link rel="next" title="SMBConnection Class" href="smb_SMBConnection.html" /> |
| 27 | 17 | <link rel="prev" title="NBNSProtocol Class" href="nmb_NBNSProtocol.html" /> |
| 28 | </head> | |
| 29 | <body role="document"> | |
| 18 | </head><body> | |
| 30 | 19 | <div class="related" role="navigation" aria-label="related navigation"> |
| 31 | 20 | <h3>Navigation</h3> |
| 32 | 21 | <ul> |
| 34 | 23 | <a href="../genindex.html" title="General Index" |
| 35 | 24 | accesskey="I">index</a></li> |
| 36 | 25 | <li class="right" > |
| 26 | <a href="../py-modindex.html" title="Python Module Index" | |
| 27 | >modules</a> |</li> | |
| 28 | <li class="right" > | |
| 37 | 29 | <a href="smb_SMBConnection.html" title="SMBConnection Class" |
| 38 | 30 | accesskey="N">next</a> |</li> |
| 39 | 31 | <li class="right" > |
| 40 | 32 | <a href="nmb_NBNSProtocol.html" title="NBNSProtocol Class" |
| 41 | 33 | accesskey="P">previous</a> |</li> |
| 42 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 34 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 35 | <li class="nav-item nav-item-this"><a href="">NetBIOS class</a></li> | |
| 43 | 36 | </ul> |
| 44 | </div> | |
| 37 | </div> | |
| 38 | ||
| 39 | <div class="document"> | |
| 40 | <div class="documentwrapper"> | |
| 41 | <div class="bodywrapper"> | |
| 42 | <div class="body" role="main"> | |
| 43 | ||
| 44 | <div class="section" id="netbios-class"> | |
| 45 | <h1>NetBIOS class<a class="headerlink" href="#netbios-class" title="Permalink to this headline">¶</a></h1> | |
| 46 | <dl class="simple"> | |
| 47 | <dt>To use the NetBIOS class in your application,</dt><dd><ol class="arabic simple"> | |
| 48 | <li><p>Create a new NetBIOS instance</p></li> | |
| 49 | <li><p>Call <em>queryName</em> 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.</p></li> | |
| 50 | <li><p>When you are done, call <em>close</em> method to release the underlying resources.</p></li> | |
| 51 | </ol> | |
| 52 | </dd> | |
| 53 | </dl> | |
| 54 | <dl class="py class"> | |
| 55 | <dt id="nmb.NetBIOS.NetBIOS"> | |
| 56 | <em class="property">class </em><code class="sig-prename descclassname">nmb.NetBIOS.</code><code class="sig-name descname">NetBIOS</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">broadcast</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">listen_port</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOS.html#NetBIOS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOS.NetBIOS" title="Permalink to this definition">¶</a></dt> | |
| 57 | <dd><dl class="py method"> | |
| 58 | <dt id="nmb.NetBIOS.NetBIOS.__init__"> | |
| 59 | <code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">broadcast</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">listen_port</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOS.html#NetBIOS.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOS.NetBIOS.__init__" title="Permalink to this definition">¶</a></dt> | |
| 60 | <dd><p>Instantiate a NetBIOS instance, and creates a IPv4 UDP socket to listen/send NBNS packets.</p> | |
| 61 | <dl class="field-list simple"> | |
| 62 | <dt class="field-odd">Parameters</dt> | |
| 63 | <dd class="field-odd"><ul class="simple"> | |
| 64 | <li><p><strong>broadcast</strong> (<em>boolean</em>) – A boolean flag to indicate if we should setup the listening UDP port in broadcast mode</p></li> | |
| 65 | <li><p><strong>listen_port</strong> (<em>integer</em>) – Specifies the UDP port number to bind to for listening. If zero, OS will automatically select a free port number.</p></li> | |
| 66 | </ul> | |
| 67 | </dd> | |
| 68 | </dl> | |
| 69 | </dd></dl> | |
| 70 | ||
| 71 | <dl class="py method"> | |
| 72 | <dt id="nmb.NetBIOS.NetBIOS.close"> | |
| 73 | <code class="sig-name descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOS.html#NetBIOS.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOS.NetBIOS.close" title="Permalink to this definition">¶</a></dt> | |
| 74 | <dd><p>Close the underlying and free resources.</p> | |
| 75 | <p>The NetBIOS instance should not be used to perform any operations after this method returns.</p> | |
| 76 | <dl class="field-list simple"> | |
| 77 | <dt class="field-odd">Returns</dt> | |
| 78 | <dd class="field-odd"><p>None</p> | |
| 79 | </dd> | |
| 80 | </dl> | |
| 81 | </dd></dl> | |
| 82 | ||
| 83 | <dl class="py method"> | |
| 84 | <dt id="nmb.NetBIOS.NetBIOS.queryIPForName"> | |
| 85 | <code class="sig-name descname">queryIPForName</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ip</span></em>, <em class="sig-param"><span class="n">port</span><span class="o">=</span><span class="default_value">137</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOS.html#NetBIOS.queryIPForName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOS.NetBIOS.queryIPForName" title="Permalink to this definition">¶</a></dt> | |
| 86 | <dd><p>Send a query to the machine with <em>ip</em> and hopes that the machine will reply back with its name.</p> | |
| 87 | <p>The implementation of this function is contributed by Jason Anderson.</p> | |
| 88 | <dl class="field-list simple"> | |
| 89 | <dt class="field-odd">Parameters</dt> | |
| 90 | <dd class="field-odd"><ul class="simple"> | |
| 91 | <li><p><strong>ip</strong> (<em>string</em>) – 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. | |
| 92 | If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.</p></li> | |
| 93 | <li><p><strong>port</strong> (<em>integer</em>) – 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.</p></li> | |
| 94 | <li><p><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds to wait for a reply, after which the method will return None</p></li> | |
| 95 | </ul> | |
| 96 | </dd> | |
| 97 | <dt class="field-even">Returns</dt> | |
| 98 | <dd class="field-even"><p>A list of string containing the names of the machine at <em>ip</em>. On timeout, returns None.</p> | |
| 99 | </dd> | |
| 100 | </dl> | |
| 101 | </dd></dl> | |
| 102 | ||
| 103 | <dl class="py method"> | |
| 104 | <dt id="nmb.NetBIOS.NetBIOS.queryName"> | |
| 105 | <code class="sig-name descname">queryName</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">ip</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">port</span><span class="o">=</span><span class="default_value">137</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOS.html#NetBIOS.queryName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOS.NetBIOS.queryName" title="Permalink to this definition">¶</a></dt> | |
| 106 | <dd><p>Send a query on the network and hopes that if machine matching the <em>name</em> will reply with its IP address.</p> | |
| 107 | <dl class="field-list simple"> | |
| 108 | <dt class="field-odd">Parameters</dt> | |
| 109 | <dd class="field-odd"><ul class="simple"> | |
| 110 | <li><p><strong>ip</strong> (<em>string</em>) – 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. | |
| 111 | If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.</p></li> | |
| 112 | <li><p><strong>port</strong> (<em>integer</em>) – 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.</p></li> | |
| 113 | <li><p><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds to wait for a reply, after which the method will return None</p></li> | |
| 114 | </ul> | |
| 115 | </dd> | |
| 116 | <dt class="field-even">Returns</dt> | |
| 117 | <dd class="field-even"><p>A list of IP addresses in dotted notation (aaa.bbb.ccc.ddd). On timeout, returns None.</p> | |
| 118 | </dd> | |
| 119 | </dl> | |
| 120 | </dd></dl> | |
| 121 | ||
| 122 | </dd></dl> | |
| 123 | ||
| 124 | </div> | |
| 125 | ||
| 126 | ||
| 127 | <div class="clearer"></div> | |
| 128 | </div> | |
| 129 | </div> | |
| 130 | </div> | |
| 45 | 131 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
| 46 | 132 | <div class="sphinxsidebarwrapper"> |
| 47 | 133 | <h4>Previous topic</h4> |
| 53 | 139 | <div role="note" aria-label="source link"> |
| 54 | 140 | <h3>This Page</h3> |
| 55 | 141 | <ul class="this-page-menu"> |
| 56 | <li><a href="../_sources/api/nmb_NetBIOS.txt" | |
| 142 | <li><a href="../_sources/api/nmb_NetBIOS.rst.txt" | |
| 57 | 143 | rel="nofollow">Show Source</a></li> |
| 58 | 144 | </ul> |
| 59 | 145 | </div> |
| 60 | 146 | <div id="searchbox" style="display: none" role="search"> |
| 61 | <h3>Quick search</h3> | |
| 147 | <h3 id="searchlabel">Quick search</h3> | |
| 148 | <div class="searchformwrapper"> | |
| 62 | 149 | <form class="search" action="../search.html" method="get"> |
| 63 | <input type="text" name="q" /> | |
| 150 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 64 | 151 | <input type="submit" value="Go" /> |
| 65 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 66 | <input type="hidden" name="area" value="default" /> | |
| 67 | 152 | </form> |
| 68 | <p class="searchtip" style="font-size: 90%"> | |
| 69 | Enter search terms or a module, class or function name. | |
| 70 | </p> | |
| 153 | </div> | |
| 71 | 154 | </div> |
| 72 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 73 | </div> | |
| 74 | </div> | |
| 75 | ||
| 76 | <div class="document"> | |
| 77 | <div class="documentwrapper"> | |
| 78 | <div class="bodywrapper"> | |
| 79 | <div class="body" role="main"> | |
| 80 | ||
| 81 | <div class="section" id="netbios-class"> | |
| 82 | <h1>NetBIOS class<a class="headerlink" href="#netbios-class" title="Permalink to this headline">¶</a></h1> | |
| 83 | <dl class="docutils"> | |
| 84 | <dt>To use the NetBIOS class in your application,</dt> | |
| 85 | <dd><ol class="first last arabic simple"> | |
| 86 | <li>Create a new NetBIOS instance</li> | |
| 87 | <li>Call <em>queryName</em> 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.</li> | |
| 88 | <li>When you are done, call <em>close</em> method to release the underlying resources.</li> | |
| 89 | </ol> | |
| 90 | </dd> | |
| 91 | </dl> | |
| 92 | <dl class="class"> | |
| 93 | <dt id="nmb.NetBIOS.NetBIOS"> | |
| 94 | <em class="property">class </em><code class="descclassname">nmb.NetBIOS.</code><code class="descname">NetBIOS</code><span class="sig-paren">(</span><em>broadcast=True</em>, <em>listen_port=0</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOS.html#NetBIOS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOS.NetBIOS" title="Permalink to this definition">¶</a></dt> | |
| 95 | <dd><dl class="method"> | |
| 96 | <dt id="nmb.NetBIOS.NetBIOS.__init__"> | |
| 97 | <code class="descname">__init__</code><span class="sig-paren">(</span><em>broadcast=True</em>, <em>listen_port=0</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOS.html#NetBIOS.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOS.NetBIOS.__init__" title="Permalink to this definition">¶</a></dt> | |
| 98 | <dd><p>Instantiate a NetBIOS instance, and creates a IPv4 UDP socket to listen/send NBNS packets.</p> | |
| 99 | <table class="docutils field-list" frame="void" rules="none"> | |
| 100 | <col class="field-name" /> | |
| 101 | <col class="field-body" /> | |
| 102 | <tbody valign="top"> | |
| 103 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | |
| 104 | <li><strong>broadcast</strong> (<em>boolean</em>) – A boolean flag to indicate if we should setup the listening UDP port in broadcast mode</li> | |
| 105 | <li><strong>listen_port</strong> (<em>integer</em>) – Specifies the UDP port number to bind to for listening. If zero, OS will automatically select a free port number.</li> | |
| 106 | </ul> | |
| 107 | </td> | |
| 108 | </tr> | |
| 109 | </tbody> | |
| 110 | </table> | |
| 111 | </dd></dl> | |
| 112 | ||
| 113 | <dl class="method"> | |
| 114 | <dt id="nmb.NetBIOS.NetBIOS.close"> | |
| 115 | <code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOS.html#NetBIOS.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOS.NetBIOS.close" title="Permalink to this definition">¶</a></dt> | |
| 116 | <dd><p>Close the underlying and free resources.</p> | |
| 117 | <p>The NetBIOS instance should not be used to perform any operations after this method returns.</p> | |
| 118 | <table class="docutils field-list" frame="void" rules="none"> | |
| 119 | <col class="field-name" /> | |
| 120 | <col class="field-body" /> | |
| 121 | <tbody valign="top"> | |
| 122 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td> | |
| 123 | </tr> | |
| 124 | </tbody> | |
| 125 | </table> | |
| 126 | </dd></dl> | |
| 127 | ||
| 128 | <dl class="method"> | |
| 129 | <dt id="nmb.NetBIOS.NetBIOS.queryIPForName"> | |
| 130 | <code class="descname">queryIPForName</code><span class="sig-paren">(</span><em>ip</em>, <em>port=137</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOS.html#NetBIOS.queryIPForName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOS.NetBIOS.queryIPForName" title="Permalink to this definition">¶</a></dt> | |
| 131 | <dd><p>Send a query to the machine with <em>ip</em> and hopes that the machine will reply back with its name.</p> | |
| 132 | <p>The implementation of this function is contributed by Jason Anderson.</p> | |
| 133 | <table class="docutils field-list" frame="void" rules="none"> | |
| 134 | <col class="field-name" /> | |
| 135 | <col class="field-body" /> | |
| 136 | <tbody valign="top"> | |
| 137 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 138 | <li><strong>ip</strong> (<em>string</em>) – 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. | |
| 139 | If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.</li> | |
| 140 | <li><strong>port</strong> (<em>integer</em>) – 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.</li> | |
| 141 | <li><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds to wait for a reply, after which the method will return None</li> | |
| 142 | </ul> | |
| 143 | </td> | |
| 144 | </tr> | |
| 145 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A list of string containing the names of the machine at <em>ip</em>. On timeout, returns None.</p> | |
| 146 | </td> | |
| 147 | </tr> | |
| 148 | </tbody> | |
| 149 | </table> | |
| 150 | </dd></dl> | |
| 151 | ||
| 152 | <dl class="method"> | |
| 153 | <dt id="nmb.NetBIOS.NetBIOS.queryName"> | |
| 154 | <code class="descname">queryName</code><span class="sig-paren">(</span><em>name</em>, <em>ip=''</em>, <em>port=137</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nmb/NetBIOS.html#NetBIOS.queryName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nmb.NetBIOS.NetBIOS.queryName" title="Permalink to this definition">¶</a></dt> | |
| 155 | <dd><p>Send a query on the network and hopes that if machine matching the <em>name</em> will reply with its IP address.</p> | |
| 156 | <table class="docutils field-list" frame="void" rules="none"> | |
| 157 | <col class="field-name" /> | |
| 158 | <col class="field-body" /> | |
| 159 | <tbody valign="top"> | |
| 160 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 161 | <li><strong>ip</strong> (<em>string</em>) – 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. | |
| 162 | If the NBNSProtocol instance was instianted with broadcast=False, then you should provide a target IP to send the query.</li> | |
| 163 | <li><strong>port</strong> (<em>integer</em>) – 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.</li> | |
| 164 | <li><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds to wait for a reply, after which the method will return None</li> | |
| 165 | </ul> | |
| 166 | </td> | |
| 167 | </tr> | |
| 168 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A list of IP addresses in dotted notation (aaa.bbb.ccc.ddd). On timeout, returns None.</p> | |
| 169 | </td> | |
| 170 | </tr> | |
| 171 | </tbody> | |
| 172 | </table> | |
| 173 | </dd></dl> | |
| 174 | ||
| 175 | </dd></dl> | |
| 176 | ||
| 177 | </div> | |
| 178 | ||
| 179 | ||
| 180 | </div> | |
| 155 | <script>$('#searchbox').show(0);</script> | |
| 181 | 156 | </div> |
| 182 | 157 | </div> |
| 183 | 158 | <div class="clearer"></div> |
| 189 | 164 | <a href="../genindex.html" title="General Index" |
| 190 | 165 | >index</a></li> |
| 191 | 166 | <li class="right" > |
| 167 | <a href="../py-modindex.html" title="Python Module Index" | |
| 168 | >modules</a> |</li> | |
| 169 | <li class="right" > | |
| 192 | 170 | <a href="smb_SMBConnection.html" title="SMBConnection Class" |
| 193 | 171 | >next</a> |</li> |
| 194 | 172 | <li class="right" > |
| 195 | 173 | <a href="nmb_NBNSProtocol.html" title="NBNSProtocol Class" |
| 196 | 174 | >previous</a> |</li> |
| 197 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 175 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 176 | <li class="nav-item nav-item-this"><a href="">NetBIOS class</a></li> | |
| 198 | 177 | </ul> |
| 199 | 178 | </div> |
| 200 | 179 | <div class="footer" role="contentinfo"> |
| 201 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 202 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 180 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 181 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 203 | 182 | </div> |
| 204 | 183 | </body> |
| 205 | 184 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | ||
| 3 | ||
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 0 | ||
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>SMBConnection Class — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>SMBConnection Class — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../index.html" /> | |
| 10 | <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> | |
| 11 | <script src="../_static/jquery.js"></script> | |
| 12 | <script src="../_static/underscore.js"></script> | |
| 13 | <script src="../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../search.html" /> | |
| 26 | 16 | <link rel="next" title="SMbHandler Class" href="smb_SMBHandler.html" /> |
| 27 | 17 | <link rel="prev" title="NetBIOS class" href="nmb_NetBIOS.html" /> |
| 28 | </head> | |
| 29 | <body role="document"> | |
| 18 | </head><body> | |
| 30 | 19 | <div class="related" role="navigation" aria-label="related navigation"> |
| 31 | 20 | <h3>Navigation</h3> |
| 32 | 21 | <ul> |
| 34 | 23 | <a href="../genindex.html" title="General Index" |
| 35 | 24 | accesskey="I">index</a></li> |
| 36 | 25 | <li class="right" > |
| 26 | <a href="../py-modindex.html" title="Python Module Index" | |
| 27 | >modules</a> |</li> | |
| 28 | <li class="right" > | |
| 37 | 29 | <a href="smb_SMBHandler.html" title="SMbHandler Class" |
| 38 | 30 | accesskey="N">next</a> |</li> |
| 39 | 31 | <li class="right" > |
| 40 | 32 | <a href="nmb_NetBIOS.html" title="NetBIOS class" |
| 41 | 33 | accesskey="P">previous</a> |</li> |
| 42 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 34 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 35 | <li class="nav-item nav-item-this"><a href="">SMBConnection Class</a></li> | |
| 43 | 36 | </ul> |
| 44 | </div> | |
| 45 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 46 | <div class="sphinxsidebarwrapper"> | |
| 47 | <h3><a href="../index.html">Table Of Contents</a></h3> | |
| 48 | <ul> | |
| 49 | <li><a class="reference internal" href="#">SMBConnection Class</a><ul> | |
| 50 | <li><a class="reference internal" href="#example">Example</a></li> | |
| 51 | <li><a class="reference internal" href="#smb2-support">SMB2 Support</a></li> | |
| 52 | <li><a class="reference internal" href="#caveats">Caveats</a></li> | |
| 53 | </ul> | |
| 54 | </li> | |
| 55 | </ul> | |
| 56 | ||
| 57 | <h4>Previous topic</h4> | |
| 58 | <p class="topless"><a href="nmb_NetBIOS.html" | |
| 59 | title="previous chapter">NetBIOS class</a></p> | |
| 60 | <h4>Next topic</h4> | |
| 61 | <p class="topless"><a href="smb_SMBHandler.html" | |
| 62 | title="next chapter">SMbHandler Class</a></p> | |
| 63 | <div role="note" aria-label="source link"> | |
| 64 | <h3>This Page</h3> | |
| 65 | <ul class="this-page-menu"> | |
| 66 | <li><a href="../_sources/api/smb_SMBConnection.txt" | |
| 67 | rel="nofollow">Show Source</a></li> | |
| 68 | </ul> | |
| 69 | </div> | |
| 70 | <div id="searchbox" style="display: none" role="search"> | |
| 71 | <h3>Quick search</h3> | |
| 72 | <form class="search" action="../search.html" method="get"> | |
| 73 | <input type="text" name="q" /> | |
| 74 | <input type="submit" value="Go" /> | |
| 75 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 76 | <input type="hidden" name="area" value="default" /> | |
| 77 | </form> | |
| 78 | <p class="searchtip" style="font-size: 90%"> | |
| 79 | Enter search terms or a module, class or function name. | |
| 80 | </p> | |
| 81 | </div> | |
| 82 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 83 | </div> | |
| 84 | </div> | |
| 37 | </div> | |
| 85 | 38 | |
| 86 | 39 | <div class="document"> |
| 87 | 40 | <div class="documentwrapper"> |
| 95 | 48 | <div class="section" id="example"> |
| 96 | 49 | <h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2> |
| 97 | 50 | <p>The following illustrates a simple file retrieving implementation.:</p> |
| 98 | <div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">tempfile</span> | |
| 51 | <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tempfile</span> | |
| 99 | 52 | <span class="kn">from</span> <span class="nn">smb.SMBConnection</span> <span class="kn">import</span> <span class="n">SMBConnection</span> |
| 100 | 53 | |
| 101 | 54 | <span class="c1"># There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip</span> |
| 102 | 55 | <span class="c1"># client_machine_name can be an arbitary ASCII string</span> |
| 103 | 56 | <span class="c1"># server_name should match the remote machine name, or else the connection will be rejected</span> |
| 104 | <span class="n">conn</span> <span class="o">=</span> <span class="n">SMBConnection</span><span class="p">(</span><span class="n">userID</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">client_machine_name</span><span class="p">,</span> <span class="n">server_name</span><span class="p">,</span> <span class="n">use_ntlm_v2</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span> | |
| 57 | <span class="n">conn</span> <span class="o">=</span> <span class="n">SMBConnection</span><span class="p">(</span><span class="n">userID</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">client_machine_name</span><span class="p">,</span> <span class="n">server_name</span><span class="p">,</span> <span class="n">use_ntlm_v2</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> | |
| 105 | 58 | <span class="k">assert</span> <span class="n">conn</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">server_ip</span><span class="p">,</span> <span class="mi">139</span><span class="p">)</span> |
| 106 | 59 | |
| 107 | 60 | <span class="n">file_obj</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">NamedTemporaryFile</span><span class="p">()</span> |
| 121 | 74 | <p>Starting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2. |
| 122 | 75 | Otherwise, it will fallback automatically back to using SMB1 protocol.</p> |
| 123 | 76 | <p>To disable SMB2 protocol in pysmb, set the <em>SUPPORT_SMB2</em> flag in the <em>smb_structs</em> module to <em>False</em> before creating the <em>SMBConnection</em> instance.:</p> |
| 124 | <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">smb</span> <span class="kn">import</span> <span class="n">smb_structs</span> | |
| 125 | <span class="n">smb_structs</span><span class="o">.</span><span class="n">SUPPORT_SMB2</span> <span class="o">=</span> <span class="bp">False</span> | |
| 77 | <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">smb</span> <span class="kn">import</span> <span class="n">smb_structs</span> | |
| 78 | <span class="n">smb_structs</span><span class="o">.</span><span class="n">SUPPORT_SMB2</span> <span class="o">=</span> <span class="kc">False</span> | |
| 126 | 79 | </pre></div> |
| 127 | 80 | </div> |
| 128 | 81 | </div> |
| 129 | 82 | <div class="section" id="caveats"> |
| 130 | 83 | <h2>Caveats<a class="headerlink" href="#caveats" title="Permalink to this headline">¶</a></h2> |
| 131 | 84 | <ul class="simple"> |
| 132 | <li>It is not meant to be used asynchronously.</li> | |
| 133 | <li>A single <em>SMBConnection</em> instance should not be used to perform more than one operation concurrently at the same time.</li> | |
| 134 | <li>Do not keep a <em>SMBConnection</em> instance “idle” for too long, i.e. keeping a <em>SMBConnection</em> instance but not using it. | |
| 85 | <li><p>It is not meant to be used asynchronously.</p></li> | |
| 86 | <li><p>A single <em>SMBConnection</em> instance should not be used to perform more than one operation concurrently at the same time.</p></li> | |
| 87 | <li><p>Do not keep a <em>SMBConnection</em> instance “idle” for too long, i.e. keeping a <em>SMBConnection</em> instance but not using it. | |
| 135 | 88 | Most SMB/CIFS servers have some sort of keepalive mechanism and impose a timeout limit. |
| 136 | If the clients fail to respond within the timeout limit, the SMB/CIFS server may disconnect the client.</li> | |
| 137 | </ul> | |
| 138 | <dl class="class"> | |
| 89 | If the clients fail to respond within the timeout limit, the SMB/CIFS server may disconnect the client.</p></li> | |
| 90 | </ul> | |
| 91 | <dl class="py class"> | |
| 139 | 92 | <dt id="smb.SMBConnection.SMBConnection"> |
| 140 | <em class="property">class </em><code class="descclassname">smb.SMBConnection.</code><code class="descname">SMBConnection</code><span class="sig-paren">(</span><em>username</em>, <em>password</em>, <em>my_name</em>, <em>remote_name</em>, <em>domain=''</em>, <em>use_ntlm_v2=True</em>, <em>sign_options=2</em>, <em>is_direct_tcp=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection" title="Permalink to this definition">¶</a></dt> | |
| 141 | <dd><dl class="method"> | |
| 93 | <em class="property">class </em><code class="sig-prename descclassname">smb.SMBConnection.</code><code class="sig-name descname">SMBConnection</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">username</span></em>, <em class="sig-param"><span class="n">password</span></em>, <em class="sig-param"><span class="n">my_name</span></em>, <em class="sig-param"><span class="n">remote_name</span></em>, <em class="sig-param"><span class="n">domain</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">use_ntlm_v2</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">sign_options</span><span class="o">=</span><span class="default_value">2</span></em>, <em class="sig-param"><span class="n">is_direct_tcp</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection" title="Permalink to this definition">¶</a></dt> | |
| 94 | <dd><dl class="py method"> | |
| 142 | 95 | <dt id="smb.SMBConnection.SMBConnection.__init__"> |
| 143 | <code class="descname">__init__</code><span class="sig-paren">(</span><em>username</em>, <em>password</em>, <em>my_name</em>, <em>remote_name</em>, <em>domain=''</em>, <em>use_ntlm_v2=True</em>, <em>sign_options=2</em>, <em>is_direct_tcp=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.__init__" title="Permalink to this definition">¶</a></dt> | |
| 96 | <code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">username</span></em>, <em class="sig-param"><span class="n">password</span></em>, <em class="sig-param"><span class="n">my_name</span></em>, <em class="sig-param"><span class="n">remote_name</span></em>, <em class="sig-param"><span class="n">domain</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">use_ntlm_v2</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">sign_options</span><span class="o">=</span><span class="default_value">2</span></em>, <em class="sig-param"><span class="n">is_direct_tcp</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.__init__" title="Permalink to this definition">¶</a></dt> | |
| 144 | 97 | <dd><p>Create a new SMBConnection instance.</p> |
| 145 | 98 | <p><em>username</em> and <em>password</em> are the user credentials required to authenticate the underlying SMB connection with the remote server. |
| 99 | <em>password</em> can be a string or a callable returning a string. | |
| 146 | 100 | File operations can only be proceeded after the connection has been authenticated successfully.</p> |
| 147 | 101 | <p>Note that you need to call <em>connect</em> method to actually establish the SMB connection to the remote server and perform authentication.</p> |
| 148 | 102 | <p>The default TCP port for most SMB/CIFS servers using NetBIOS over TCP/IP is 139. |
| 149 | 103 | Some newer server installations might also support Direct hosting of SMB over TCP/IP; for these servers, the default TCP port is 445.</p> |
| 150 | <table class="docutils field-list" frame="void" rules="none"> | |
| 151 | <col class="field-name" /> | |
| 152 | <col class="field-body" /> | |
| 153 | <tbody valign="top"> | |
| 154 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | |
| 155 | <li><strong>my_name</strong> (<em>string</em>) – The local NetBIOS machine name that will identify where this connection is originating from. | |
| 156 | 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 <code class="docutils literal"><span class="pre">\/:*?";|+</span></code></li> | |
| 157 | <li><strong>remote_name</strong> (<em>string</em>) – The NetBIOS machine name of the remote server. | |
| 158 | On windows, you can find out the machine name by right-clicking on the “My Computer” and selecting “Properties”. | |
| 159 | This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected.</li> | |
| 160 | <li><strong>domain</strong> (<em>string</em>) – The network domain. On windows, it is known as the workgroup. Usually, it is safe to leave this parameter as an empty string.</li> | |
| 161 | <li><strong>use_ntlm_v2</strong> (<em>boolean</em>) – Indicates whether pysmb should be NTLMv1 or NTLMv2 authentication algorithm for authentication. | |
| 104 | <dl class="field-list simple"> | |
| 105 | <dt class="field-odd">Parameters</dt> | |
| 106 | <dd class="field-odd"><ul class="simple"> | |
| 107 | <li><p><strong>my_name</strong> (<em>string</em>) – The local NetBIOS machine name that will identify where this connection is originating from. | |
| 108 | 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 <code class="docutils literal notranslate"><span class="pre">\/:*?";|+</span></code></p></li> | |
| 109 | <li><p><strong>remote_name</strong> (<em>string</em>) – The NetBIOS machine name of the remote server. | |
| 110 | On windows, you can find out the machine name by right-clicking on the “My Computer” and selecting “Properties”. | |
| 111 | This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected.</p></li> | |
| 112 | <li><p><strong>domain</strong> (<em>string</em>) – The network domain. On windows, it is known as the workgroup. Usually, it is safe to leave this parameter as an empty string.</p></li> | |
| 113 | <li><p><strong>use_ntlm_v2</strong> (<em>boolean</em>) – Indicates whether pysmb should be NTLMv1 or NTLMv2 authentication algorithm for authentication. | |
| 162 | 114 | 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. |
| 163 | Hence, we can only “guess” or try both algorithms. | |
| 164 | On Sambda, Windows Vista and Windows 7, NTLMv2 is enabled by default. On Windows XP, we can use NTLMv1 before NTLMv2.</li> | |
| 165 | <li><strong>sign_options</strong> (<em>int</em>) – Determines whether SMB messages will be signed. Default is <em>SIGN_WHEN_REQUIRED</em>. | |
| 115 | Hence, we can only “guess” or try both algorithms. | |
| 116 | On Sambda, Windows Vista and Windows 7, NTLMv2 is enabled by default. On Windows XP, we can use NTLMv1 before NTLMv2.</p></li> | |
| 117 | <li><p><strong>sign_options</strong> (<em>int</em>) – Determines whether SMB messages will be signed. Default is <em>SIGN_WHEN_REQUIRED</em>. | |
| 166 | 118 | If <em>SIGN_WHEN_REQUIRED</em> (value=2), SMB messages will only be signed when remote server requires signing. |
| 167 | 119 | If <em>SIGN_WHEN_SUPPORTED</em> (value=1), SMB messages will be signed when remote server supports signing but not requires signing. |
| 168 | If <em>SIGN_NEVER</em> (value=0), SMB messages will never be signed regardless of remote server’s configurations; access errors will occur if the remote server requires signing.</li> | |
| 169 | <li><strong>is_direct_tcp</strong> (<em>boolean</em>) – 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. | |
| 170 | The default parameter is False which will use NetBIOS over TCP/IP for wider compatibility (TCP port: 139).</li> | |
| 171 | </ul> | |
| 172 | </td> | |
| 173 | </tr> | |
| 174 | </tbody> | |
| 175 | </table> | |
| 176 | </dd></dl> | |
| 177 | ||
| 178 | <dl class="method"> | |
| 120 | If <em>SIGN_NEVER</em> (value=0), SMB messages will never be signed regardless of remote server’s configurations; access errors will occur if the remote server requires signing.</p></li> | |
| 121 | <li><p><strong>is_direct_tcp</strong> (<em>boolean</em>) – 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. | |
| 122 | The default parameter is False which will use NetBIOS over TCP/IP for wider compatibility (TCP port: 139).</p></li> | |
| 123 | </ul> | |
| 124 | </dd> | |
| 125 | </dl> | |
| 126 | </dd></dl> | |
| 127 | ||
| 128 | <dl class="py method"> | |
| 179 | 129 | <dt id="smb.SMBConnection.SMBConnection.close"> |
| 180 | <code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.close" title="Permalink to this definition">¶</a></dt> | |
| 130 | <code class="sig-name descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.close" title="Permalink to this definition">¶</a></dt> | |
| 181 | 131 | <dd><p>Terminate the SMB connection (if it has been started) and release any sources held by the underlying socket.</p> |
| 182 | 132 | </dd></dl> |
| 183 | 133 | |
| 184 | <dl class="method"> | |
| 134 | <dl class="py method"> | |
| 185 | 135 | <dt id="smb.SMBConnection.SMBConnection.connect"> |
| 186 | <code class="descname">connect</code><span class="sig-paren">(</span><em>ip</em>, <em>port=139</em>, <em>sock_family=2</em>, <em>timeout=60</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.connect" title="Permalink to this definition">¶</a></dt> | |
| 136 | <code class="sig-name descname">connect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ip</span></em>, <em class="sig-param"><span class="n">port</span><span class="o">=</span><span class="default_value">139</span></em>, <em class="sig-param"><span class="n">sock_family</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">60</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.connect" title="Permalink to this definition">¶</a></dt> | |
| 187 | 137 | <dd><p>Establish the SMB connection to the remote SMB/CIFS server.</p> |
| 188 | 138 | <p>You must call this method before attempting any of the file operations with the remote server. |
| 189 | 139 | This method will block until the SMB connection has attempted at least one authentication.</p> |
| 190 | <table class="docutils field-list" frame="void" rules="none"> | |
| 191 | <col class="field-name" /> | |
| 192 | <col class="field-body" /> | |
| 193 | <tbody valign="top"> | |
| 194 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A boolean value indicating the result of the authentication atttempt: True if authentication is successful; False, if otherwise.</td> | |
| 195 | </tr> | |
| 196 | </tbody> | |
| 197 | </table> | |
| 198 | </dd></dl> | |
| 199 | ||
| 200 | <dl class="method"> | |
| 140 | <dl class="field-list simple"> | |
| 141 | <dt class="field-odd">Parameters</dt> | |
| 142 | <dd class="field-odd"><ul class="simple"> | |
| 143 | <li><p><strong>port</strong> – Defaults to 139. If you are using direct TCP mode (is_direct_tcp=true when creating this SMBConnection instance), use 445.</p></li> | |
| 144 | <li><p><strong>sock_family</strong> – In Python 3.x, use <em>None</em> as we can infer the socket family from the provided <em>ip</em>. In Python 2.x, it must be either <em>socket.AF_INET</em> or <em>socket.AF_INET6</em>.</p></li> | |
| 145 | </ul> | |
| 146 | </dd> | |
| 147 | <dt class="field-even">Returns</dt> | |
| 148 | <dd class="field-even"><p>A boolean value indicating the result of the authentication atttempt: True if authentication is successful; False, if otherwise.</p> | |
| 149 | </dd> | |
| 150 | </dl> | |
| 151 | </dd></dl> | |
| 152 | ||
| 153 | <dl class="py method"> | |
| 201 | 154 | <dt id="smb.SMBConnection.SMBConnection.createDirectory"> |
| 202 | <code class="descname">createDirectory</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.createDirectory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.createDirectory" title="Permalink to this definition">¶</a></dt> | |
| 155 | <code class="sig-name descname">createDirectory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.createDirectory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.createDirectory" title="Permalink to this definition">¶</a></dt> | |
| 203 | 156 | <dd><p>Creates a new directory <em>path</em> on the <em>service_name</em>.</p> |
| 204 | <table class="docutils field-list" frame="void" rules="none"> | |
| 205 | <col class="field-name" /> | |
| 206 | <col class="field-body" /> | |
| 207 | <tbody valign="top"> | |
| 208 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 209 | <li><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</li> | |
| 210 | <li><strong>path</strong> (<em>string/unicode</em>) – The path of the new folder (relative to) the shared folder. | |
| 211 | If the path contains non-English characters, an unicode string must be used to pass in the path.</li> | |
| 212 | </ul> | |
| 213 | </td> | |
| 214 | </tr> | |
| 215 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p> | |
| 216 | </td> | |
| 217 | </tr> | |
| 218 | </tbody> | |
| 219 | </table> | |
| 220 | </dd></dl> | |
| 221 | ||
| 222 | <dl class="method"> | |
| 157 | <dl class="field-list simple"> | |
| 158 | <dt class="field-odd">Parameters</dt> | |
| 159 | <dd class="field-odd"><ul class="simple"> | |
| 160 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</p></li> | |
| 161 | <li><p><strong>path</strong> (<em>string/unicode</em>) – The path of the new folder (relative to) the shared folder. | |
| 162 | If the path contains non-English characters, an unicode string must be used to pass in the path.</p></li> | |
| 163 | </ul> | |
| 164 | </dd> | |
| 165 | <dt class="field-even">Returns</dt> | |
| 166 | <dd class="field-even"><p>None</p> | |
| 167 | </dd> | |
| 168 | </dl> | |
| 169 | </dd></dl> | |
| 170 | ||
| 171 | <dl class="py method"> | |
| 223 | 172 | <dt id="smb.SMBConnection.SMBConnection.deleteDirectory"> |
| 224 | <code class="descname">deleteDirectory</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.deleteDirectory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.deleteDirectory" title="Permalink to this definition">¶</a></dt> | |
| 173 | <code class="sig-name descname">deleteDirectory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.deleteDirectory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.deleteDirectory" title="Permalink to this definition">¶</a></dt> | |
| 225 | 174 | <dd><p>Delete the empty folder at <em>path</em> on <em>service_name</em></p> |
| 226 | <table class="docutils field-list" frame="void" rules="none"> | |
| 227 | <col class="field-name" /> | |
| 228 | <col class="field-body" /> | |
| 229 | <tbody valign="top"> | |
| 230 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 231 | <li><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</li> | |
| 232 | <li><strong>path</strong> (<em>string/unicode</em>) – The path of the to-be-deleted folder (relative to) the shared folder. | |
| 233 | If the path contains non-English characters, an unicode string must be used to pass in the path.</li> | |
| 234 | </ul> | |
| 235 | </td> | |
| 236 | </tr> | |
| 237 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p> | |
| 238 | </td> | |
| 239 | </tr> | |
| 240 | </tbody> | |
| 241 | </table> | |
| 242 | </dd></dl> | |
| 243 | ||
| 244 | <dl class="method"> | |
| 175 | <dl class="field-list simple"> | |
| 176 | <dt class="field-odd">Parameters</dt> | |
| 177 | <dd class="field-odd"><ul class="simple"> | |
| 178 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</p></li> | |
| 179 | <li><p><strong>path</strong> (<em>string/unicode</em>) – The path of the to-be-deleted folder (relative to) the shared folder. | |
| 180 | If the path contains non-English characters, an unicode string must be used to pass in the path.</p></li> | |
| 181 | </ul> | |
| 182 | </dd> | |
| 183 | <dt class="field-even">Returns</dt> | |
| 184 | <dd class="field-even"><p>None</p> | |
| 185 | </dd> | |
| 186 | </dl> | |
| 187 | </dd></dl> | |
| 188 | ||
| 189 | <dl class="py method"> | |
| 245 | 190 | <dt id="smb.SMBConnection.SMBConnection.deleteFiles"> |
| 246 | <code class="descname">deleteFiles</code><span class="sig-paren">(</span><em>service_name</em>, <em>path_file_pattern</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.deleteFiles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.deleteFiles" title="Permalink to this definition">¶</a></dt> | |
| 191 | <code class="sig-name descname">deleteFiles</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path_file_pattern</span></em>, <em class="sig-param"><span class="n">delete_matching_folders</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.deleteFiles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.deleteFiles" title="Permalink to this definition">¶</a></dt> | |
| 247 | 192 | <dd><p>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.</p> |
| 248 | <table class="docutils field-list" frame="void" rules="none"> | |
| 249 | <col class="field-name" /> | |
| 250 | <col class="field-body" /> | |
| 251 | <tbody valign="top"> | |
| 252 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 253 | <li><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</li> | |
| 254 | <li><strong>path_file_pattern</strong> (<em>string/unicode</em>) – The pathname of the file(s) to be deleted, relative to the service_name. | |
| 193 | <p>If delete_matching_folders is True, immediate sub-folders that match the path_file_pattern will be deleted recursively.</p> | |
| 194 | <dl class="field-list simple"> | |
| 195 | <dt class="field-odd">Parameters</dt> | |
| 196 | <dd class="field-odd"><ul class="simple"> | |
| 197 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</p></li> | |
| 198 | <li><p><strong>path_file_pattern</strong> (<em>string/unicode</em>) – The pathname of the file(s) to be deleted, relative to the service_name. | |
| 255 | 199 | Wildcards may be used in th filename component of the path. |
| 256 | If your path/filename contains non-English characters, you must pass in an unicode string.</li> | |
| 257 | </ul> | |
| 258 | </td> | |
| 259 | </tr> | |
| 260 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p> | |
| 261 | </td> | |
| 262 | </tr> | |
| 263 | </tbody> | |
| 264 | </table> | |
| 265 | </dd></dl> | |
| 266 | ||
| 267 | <dl class="method"> | |
| 200 | If your path/filename contains non-English characters, you must pass in an unicode string.</p></li> | |
| 201 | </ul> | |
| 202 | </dd> | |
| 203 | <dt class="field-even">Returns</dt> | |
| 204 | <dd class="field-even"><p>None</p> | |
| 205 | </dd> | |
| 206 | </dl> | |
| 207 | </dd></dl> | |
| 208 | ||
| 209 | <dl class="py method"> | |
| 268 | 210 | <dt id="smb.SMBConnection.SMBConnection.echo"> |
| 269 | <code class="descname">echo</code><span class="sig-paren">(</span><em>data</em>, <em>timeout=10</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.echo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.echo" title="Permalink to this definition">¶</a></dt> | |
| 211 | <code class="sig-name descname">echo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">10</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.echo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.echo" title="Permalink to this definition">¶</a></dt> | |
| 270 | 212 | <dd><p>Send an echo command containing <em>data</em> to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same <em>data</em>.</p> |
| 271 | <table class="docutils field-list" frame="void" rules="none"> | |
| 272 | <col class="field-name" /> | |
| 273 | <col class="field-body" /> | |
| 274 | <tbody valign="top"> | |
| 275 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<em>string</em>) – Data to send to the remote server.</td> | |
| 276 | </tr> | |
| 277 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The <em>data</em> parameter</td> | |
| 278 | </tr> | |
| 279 | </tbody> | |
| 280 | </table> | |
| 281 | </dd></dl> | |
| 282 | ||
| 283 | <dl class="method"> | |
| 213 | <dl class="field-list simple"> | |
| 214 | <dt class="field-odd">Parameters</dt> | |
| 215 | <dd class="field-odd"><p><strong>data</strong> (<em>bytes</em>) – Data to send to the remote server. Must be a bytes object.</p> | |
| 216 | </dd> | |
| 217 | <dt class="field-even">Returns</dt> | |
| 218 | <dd class="field-even"><p>The <em>data</em> parameter</p> | |
| 219 | </dd> | |
| 220 | </dl> | |
| 221 | </dd></dl> | |
| 222 | ||
| 223 | <dl class="py method"> | |
| 284 | 224 | <dt id="smb.SMBConnection.SMBConnection.getAttributes"> |
| 285 | <code class="descname">getAttributes</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.getAttributes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.getAttributes" title="Permalink to this definition">¶</a></dt> | |
| 225 | <code class="sig-name descname">getAttributes</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.getAttributes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.getAttributes" title="Permalink to this definition">¶</a></dt> | |
| 286 | 226 | <dd><p>Retrieve information about the file at <em>path</em> on the <em>service_name</em>.</p> |
| 287 | <table class="docutils field-list" frame="void" rules="none"> | |
| 288 | <col class="field-name" /> | |
| 289 | <col class="field-body" /> | |
| 290 | <tbody valign="top"> | |
| 291 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 292 | <li><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></li> | |
| 293 | <li><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file cannot be opened for reading, an <a class="reference internal" href="smb_exceptions.html"><em>OperationFailure</em></a> will be raised.</li> | |
| 294 | </ul> | |
| 295 | </td> | |
| 296 | </tr> | |
| 297 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <a class="reference internal" href="smb_SharedFile.html"><em>smb.base.SharedFile</em></a> instance containing the attributes of the file.</p> | |
| 298 | </td> | |
| 299 | </tr> | |
| 300 | </tbody> | |
| 301 | </table> | |
| 302 | </dd></dl> | |
| 303 | ||
| 304 | <dl class="method"> | |
| 227 | <dl class="field-list simple"> | |
| 228 | <dt class="field-odd">Parameters</dt> | |
| 229 | <dd class="field-odd"><ul class="simple"> | |
| 230 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></p></li> | |
| 231 | <li><p><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file cannot be opened for reading, an <a class="reference internal" href="smb_exceptions.html"><span class="doc">OperationFailure</span></a> will be raised.</p></li> | |
| 232 | </ul> | |
| 233 | </dd> | |
| 234 | <dt class="field-even">Returns</dt> | |
| 235 | <dd class="field-even"><p>A <a class="reference internal" href="smb_SharedFile.html"><span class="doc">smb.base.SharedFile</span></a> instance containing the attributes of the file.</p> | |
| 236 | </dd> | |
| 237 | </dl> | |
| 238 | </dd></dl> | |
| 239 | ||
| 240 | <dl class="py method"> | |
| 241 | <dt id="smb.SMBConnection.SMBConnection.getSecurity"> | |
| 242 | <code class="sig-name descname">getSecurity</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.getSecurity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.getSecurity" title="Permalink to this definition">¶</a></dt> | |
| 243 | <dd><p>Retrieve the security descriptor of the file at <em>path</em> on the <em>service_name</em>.</p> | |
| 244 | <dl class="field-list simple"> | |
| 245 | <dt class="field-odd">Parameters</dt> | |
| 246 | <dd class="field-odd"><ul class="simple"> | |
| 247 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></p></li> | |
| 248 | <li><p><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file cannot be opened for reading, an <a class="reference internal" href="smb_exceptions.html"><span class="doc">OperationFailure</span></a> will be raised.</p></li> | |
| 249 | </ul> | |
| 250 | </dd> | |
| 251 | <dt class="field-even">Returns</dt> | |
| 252 | <dd class="field-even"><p>A <a class="reference internal" href="smb_security_descriptors.html#smb.security_descriptors.SecurityDescriptor" title="smb.security_descriptors.SecurityDescriptor"><code class="xref py py-class docutils literal notranslate"><span class="pre">smb.security_descriptors.SecurityDescriptor</span></code></a> instance containing the security information of the file.</p> | |
| 253 | </dd> | |
| 254 | </dl> | |
| 255 | </dd></dl> | |
| 256 | ||
| 257 | <dl class="py method"> | |
| 305 | 258 | <dt id="smb.SMBConnection.SMBConnection.listPath"> |
| 306 | <code class="descname">listPath</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>search=55</em>, <em>pattern='*'</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.listPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.listPath" title="Permalink to this definition">¶</a></dt> | |
| 259 | <code class="sig-name descname">listPath</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">search</span><span class="o">=</span><span class="default_value">65591</span></em>, <em class="sig-param"><span class="n">pattern</span><span class="o">=</span><span class="default_value">'*'</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.listPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.listPath" title="Permalink to this definition">¶</a></dt> | |
| 307 | 260 | <dd><p>Retrieve a directory listing of files/folders at <em>path</em></p> |
| 308 | <table class="docutils field-list" frame="void" rules="none"> | |
| 309 | <col class="field-name" /> | |
| 310 | <col class="field-body" /> | |
| 311 | <tbody valign="top"> | |
| 312 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 313 | <li><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></li> | |
| 314 | <li><strong>path</strong> (<em>string/unicode</em>) – path relative to the <em>service_name</em> where we are interested to learn about its files/sub-folders.</li> | |
| 315 | <li><strong>search</strong> (<em>integer</em>) – integer value made up from a bitwise-OR of <em>SMB_FILE_ATTRIBUTE_xxx</em> bits (see smb_constants.py). | |
| 316 | The default <em>search</em> value will query for all read-only, hidden, system, archive files and directories.</li> | |
| 317 | <li><strong>pattern</strong> (<em>string/unicode</em>) – the filter to apply to the results before returning to the client.</li> | |
| 318 | </ul> | |
| 319 | </td> | |
| 320 | </tr> | |
| 321 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A list of <a class="reference internal" href="smb_SharedFile.html"><em>smb.base.SharedFile</em></a> instances.</p> | |
| 322 | </td> | |
| 323 | </tr> | |
| 324 | </tbody> | |
| 325 | </table> | |
| 326 | </dd></dl> | |
| 327 | ||
| 328 | <dl class="method"> | |
| 261 | <p>For simplicity, pysmb defines a “normal” file as a file entry that is not read-only, not hidden, not system, not archive and not a directory. | |
| 262 | It ignores other attributes like compression, indexed, sparse, temporary and encryption.</p> | |
| 263 | <p>Note that the default search parameter will query for all read-only (SMB_FILE_ATTRIBUTE_READONLY), hidden (SMB_FILE_ATTRIBUTE_HIDDEN), | |
| 264 | system (SMB_FILE_ATTRIBUTE_SYSTEM), archive (SMB_FILE_ATTRIBUTE_ARCHIVE), normal (SMB_FILE_ATTRIBUTE_INCL_NORMAL) files | |
| 265 | and directories (SMB_FILE_ATTRIBUTE_DIRECTORY). | |
| 266 | If you do not need to include “normal” files in the result, define your own search parameter without the SMB_FILE_ATTRIBUTE_INCL_NORMAL constant. | |
| 267 | SMB_FILE_ATTRIBUTE_NORMAL should be used by itself and not be used with other bit constants.</p> | |
| 268 | <dl class="field-list simple"> | |
| 269 | <dt class="field-odd">Parameters</dt> | |
| 270 | <dd class="field-odd"><ul class="simple"> | |
| 271 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></p></li> | |
| 272 | <li><p><strong>path</strong> (<em>string/unicode</em>) – path relative to the <em>service_name</em> where we are interested to learn about its files/sub-folders.</p></li> | |
| 273 | <li><p><strong>search</strong> (<em>integer</em>) – integer value made up from a bitwise-OR of <em>SMB_FILE_ATTRIBUTE_xxx</em> bits (see smb_constants.py).</p></li> | |
| 274 | <li><p><strong>pattern</strong> (<em>string/unicode</em>) – the filter to apply to the results before returning to the client.</p></li> | |
| 275 | </ul> | |
| 276 | </dd> | |
| 277 | <dt class="field-even">Returns</dt> | |
| 278 | <dd class="field-even"><p>A list of <a class="reference internal" href="smb_SharedFile.html"><span class="doc">smb.base.SharedFile</span></a> instances.</p> | |
| 279 | </dd> | |
| 280 | </dl> | |
| 281 | </dd></dl> | |
| 282 | ||
| 283 | <dl class="py method"> | |
| 329 | 284 | <dt id="smb.SMBConnection.SMBConnection.listShares"> |
| 330 | <code class="descname">listShares</code><span class="sig-paren">(</span><em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.listShares"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.listShares" title="Permalink to this definition">¶</a></dt> | |
| 285 | <code class="sig-name descname">listShares</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.listShares"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.listShares" title="Permalink to this definition">¶</a></dt> | |
| 331 | 286 | <dd><p>Retrieve a list of shared resources on remote server.</p> |
| 332 | <table class="docutils field-list" frame="void" rules="none"> | |
| 333 | <col class="field-name" /> | |
| 334 | <col class="field-body" /> | |
| 335 | <tbody valign="top"> | |
| 336 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A list of <a class="reference internal" href="smb_SharedDevice.html"><em>smb.base.SharedDevice</em></a> instances describing the shared resource</td> | |
| 337 | </tr> | |
| 338 | </tbody> | |
| 339 | </table> | |
| 340 | </dd></dl> | |
| 341 | ||
| 342 | <dl class="method"> | |
| 287 | <dl class="field-list simple"> | |
| 288 | <dt class="field-odd">Returns</dt> | |
| 289 | <dd class="field-odd"><p>A list of <a class="reference internal" href="smb_SharedDevice.html"><span class="doc">smb.base.SharedDevice</span></a> instances describing the shared resource</p> | |
| 290 | </dd> | |
| 291 | </dl> | |
| 292 | </dd></dl> | |
| 293 | ||
| 294 | <dl class="py method"> | |
| 343 | 295 | <dt id="smb.SMBConnection.SMBConnection.listSnapshots"> |
| 344 | <code class="descname">listSnapshots</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.listSnapshots"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.listSnapshots" title="Permalink to this definition">¶</a></dt> | |
| 296 | <code class="sig-name descname">listSnapshots</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.listSnapshots"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.listSnapshots" title="Permalink to this definition">¶</a></dt> | |
| 345 | 297 | <dd><p>Retrieve a list of available snapshots (shadow copies) for <em>path</em>.</p> |
| 346 | 298 | <p>Note that snapshot features are only supported on Windows Vista Business, Enterprise and Ultimate, and on all Windows 7 editions.</p> |
| 347 | <table class="docutils field-list" frame="void" rules="none"> | |
| 348 | <col class="field-name" /> | |
| 349 | <col class="field-body" /> | |
| 350 | <tbody valign="top"> | |
| 351 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 352 | <li><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></li> | |
| 353 | <li><strong>path</strong> (<em>string/unicode</em>) – path relative to the <em>service_name</em> where we are interested in the list of available snapshots</li> | |
| 354 | </ul> | |
| 355 | </td> | |
| 356 | </tr> | |
| 357 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A list of python <em>datetime.DateTime</em> instances in GMT/UTC time zone</p> | |
| 358 | </td> | |
| 359 | </tr> | |
| 360 | </tbody> | |
| 361 | </table> | |
| 362 | </dd></dl> | |
| 363 | ||
| 364 | <dl class="method"> | |
| 299 | <dl class="field-list simple"> | |
| 300 | <dt class="field-odd">Parameters</dt> | |
| 301 | <dd class="field-odd"><ul class="simple"> | |
| 302 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></p></li> | |
| 303 | <li><p><strong>path</strong> (<em>string/unicode</em>) – path relative to the <em>service_name</em> where we are interested in the list of available snapshots</p></li> | |
| 304 | </ul> | |
| 305 | </dd> | |
| 306 | <dt class="field-even">Returns</dt> | |
| 307 | <dd class="field-even"><p>A list of python <em>datetime.DateTime</em> instances in GMT/UTC time zone</p> | |
| 308 | </dd> | |
| 309 | </dl> | |
| 310 | </dd></dl> | |
| 311 | ||
| 312 | <dl class="py method"> | |
| 365 | 313 | <dt id="smb.SMBConnection.SMBConnection.rename"> |
| 366 | <code class="descname">rename</code><span class="sig-paren">(</span><em>service_name</em>, <em>old_path</em>, <em>new_path</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.rename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.rename" title="Permalink to this definition">¶</a></dt> | |
| 314 | <code class="sig-name descname">rename</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">old_path</span></em>, <em class="sig-param"><span class="n">new_path</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.rename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.rename" title="Permalink to this definition">¶</a></dt> | |
| 367 | 315 | <dd><p>Rename a file or folder at <em>old_path</em> to <em>new_path</em> shared at <em>service_name</em>. Note that this method cannot be used to rename file/folder across different shared folders</p> |
| 368 | 316 | <p><em>old_path</em> and <em>new_path</em> are string/unicode referring to the old and new path of the renamed resources (relative to) the shared folder. |
| 369 | 317 | If the path contains non-English characters, an unicode string must be used to pass in the path.</p> |
| 370 | <table class="docutils field-list" frame="void" rules="none"> | |
| 371 | <col class="field-name" /> | |
| 372 | <col class="field-body" /> | |
| 373 | <tbody valign="top"> | |
| 374 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</td> | |
| 375 | </tr> | |
| 376 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td> | |
| 377 | </tr> | |
| 378 | </tbody> | |
| 379 | </table> | |
| 380 | </dd></dl> | |
| 381 | ||
| 382 | <dl class="method"> | |
| 318 | <dl class="field-list simple"> | |
| 319 | <dt class="field-odd">Parameters</dt> | |
| 320 | <dd class="field-odd"><p><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</p> | |
| 321 | </dd> | |
| 322 | <dt class="field-even">Returns</dt> | |
| 323 | <dd class="field-even"><p>None</p> | |
| 324 | </dd> | |
| 325 | </dl> | |
| 326 | </dd></dl> | |
| 327 | ||
| 328 | <dl class="py method"> | |
| 383 | 329 | <dt id="smb.SMBConnection.SMBConnection.resetFileAttributes"> |
| 384 | <code class="descname">resetFileAttributes</code><span class="sig-paren">(</span><em>service_name</em>, <em>path_file_pattern</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.resetFileAttributes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.resetFileAttributes" title="Permalink to this definition">¶</a></dt> | |
| 330 | <code class="sig-name descname">resetFileAttributes</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path_file_pattern</span></em>, <em class="sig-param"><span class="n">file_attributes</span><span class="o">=</span><span class="default_value">128</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.resetFileAttributes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.resetFileAttributes" title="Permalink to this definition">¶</a></dt> | |
| 385 | 331 | <dd><p>Reset file attributes of one or more regular files or folders. |
| 386 | 332 | It supports the use of wildcards in file names, allowing for unlocking of multiple files/folders in a single request. |
| 387 | 333 | This function is very helpful when deleting files/folders that are read-only. |
| 388 | Note: this function is currently only implemented for SMB2! Technically, it sets the FILE_ATTRIBUTE_NORMAL flag, therefore clearing all other flags. (See <a class="reference external" href="https://msdn.microsoft.com/en-us/library/cc232110.aspx">https://msdn.microsoft.com/en-us/library/cc232110.aspx</a> for further information)</p> | |
| 389 | <table class="docutils field-list" frame="void" rules="none"> | |
| 390 | <col class="field-name" /> | |
| 391 | <col class="field-body" /> | |
| 392 | <tbody valign="top"> | |
| 393 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 394 | <li><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</li> | |
| 395 | <li><strong>path_file_pattern</strong> (<em>string/unicode</em>) – The pathname of the file(s) to be deleted, relative to the service_name. | |
| 334 | By default, it sets the ATTR_NORMAL flag, therefore clearing all other flags. | |
| 335 | (See <a class="reference external" href="https://msdn.microsoft.com/en-us/library/cc232110.aspx">https://msdn.microsoft.com/en-us/library/cc232110.aspx</a> for further information)</p> | |
| 336 | <p>Note: this function is currently only implemented for SMB2!</p> | |
| 337 | <dl class="field-list simple"> | |
| 338 | <dt class="field-odd">Parameters</dt> | |
| 339 | <dd class="field-odd"><ul class="simple"> | |
| 340 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</p></li> | |
| 341 | <li><p><strong>path_file_pattern</strong> (<em>string/unicode</em>) – The pathname of the file(s) to be deleted, relative to the service_name. | |
| 396 | 342 | Wildcards may be used in the filename component of the path. |
| 397 | If your path/filename contains non-English characters, you must pass in an unicode string.</li> | |
| 398 | </ul> | |
| 399 | </td> | |
| 400 | </tr> | |
| 401 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p> | |
| 402 | </td> | |
| 403 | </tr> | |
| 404 | </tbody> | |
| 405 | </table> | |
| 406 | </dd></dl> | |
| 407 | ||
| 408 | <dl class="method"> | |
| 343 | If your path/filename contains non-English characters, you must pass in an unicode string.</p></li> | |
| 344 | <li><p><strong>file_attributes</strong> (<em>int</em>) – The desired file attributes to set. Defaults to <cite>ATTR_NORMAL</cite>.</p></li> | |
| 345 | </ul> | |
| 346 | </dd> | |
| 347 | <dt class="field-even">Returns</dt> | |
| 348 | <dd class="field-even"><p>None</p> | |
| 349 | </dd> | |
| 350 | </dl> | |
| 351 | </dd></dl> | |
| 352 | ||
| 353 | <dl class="py method"> | |
| 409 | 354 | <dt id="smb.SMBConnection.SMBConnection.retrieveFile"> |
| 410 | <code class="descname">retrieveFile</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>file_obj</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.retrieveFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.retrieveFile" title="Permalink to this definition">¶</a></dt> | |
| 355 | <code class="sig-name descname">retrieveFile</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">file_obj</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.retrieveFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.retrieveFile" title="Permalink to this definition">¶</a></dt> | |
| 411 | 356 | <dd><p>Retrieve the contents of the file at <em>path</em> on the <em>service_name</em> and write these contents to the provided <em>file_obj</em>.</p> |
| 412 | 357 | <p>Use <em>retrieveFileFromOffset()</em> method if you wish to specify the offset to read from the remote <em>path</em> and/or the number of bytes to write to the <em>file_obj</em>.</p> |
| 413 | <table class="docutils field-list" frame="void" rules="none"> | |
| 414 | <col class="field-name" /> | |
| 415 | <col class="field-body" /> | |
| 416 | <tbody valign="top"> | |
| 417 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 418 | <li><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></li> | |
| 419 | <li><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file cannot be opened for reading, an <a class="reference internal" href="smb_exceptions.html"><em>OperationFailure</em></a> will be raised.</li> | |
| 420 | <li><strong>file_obj</strong> – A file-like object that has a <em>write</em> method. Data will be written continuously to <em>file_obj</em> until EOF is received from the remote service.</li> | |
| 421 | </ul> | |
| 422 | </td> | |
| 423 | </tr> | |
| 424 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A 2-element tuple of ( file attributes of the file on server, number of bytes written to <em>file_obj</em> ). | |
| 358 | <dl class="field-list simple"> | |
| 359 | <dt class="field-odd">Parameters</dt> | |
| 360 | <dd class="field-odd"><ul class="simple"> | |
| 361 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></p></li> | |
| 362 | <li><p><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file cannot be opened for reading, an <a class="reference internal" href="smb_exceptions.html"><span class="doc">OperationFailure</span></a> will be raised.</p></li> | |
| 363 | <li><p><strong>file_obj</strong> – A file-like object that has a <em>write</em> method. Data will be written continuously to <em>file_obj</em> until EOF is received from the remote service. In Python3, this file-like object must have a <em>write</em> method which accepts a bytes parameter.</p></li> | |
| 364 | </ul> | |
| 365 | </dd> | |
| 366 | <dt class="field-even">Returns</dt> | |
| 367 | <dd class="field-even"><p>A 2-element tuple of ( file attributes of the file on server, number of bytes written to <em>file_obj</em> ). | |
| 425 | 368 | The file attributes is an integer value made up from a bitwise-OR of <em>SMB_FILE_ATTRIBUTE_xxx</em> bits (see smb_constants.py)</p> |
| 426 | </td> | |
| 427 | </tr> | |
| 428 | </tbody> | |
| 429 | </table> | |
| 430 | </dd></dl> | |
| 431 | ||
| 432 | <dl class="method"> | |
| 369 | </dd> | |
| 370 | </dl> | |
| 371 | </dd></dl> | |
| 372 | ||
| 373 | <dl class="py method"> | |
| 433 | 374 | <dt id="smb.SMBConnection.SMBConnection.retrieveFileFromOffset"> |
| 434 | <code class="descname">retrieveFileFromOffset</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>file_obj</em>, <em>offset=0L</em>, <em>max_length=-1L</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.retrieveFileFromOffset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.retrieveFileFromOffset" title="Permalink to this definition">¶</a></dt> | |
| 375 | <code class="sig-name descname">retrieveFileFromOffset</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">file_obj</span></em>, <em class="sig-param"><span class="n">offset</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">max_length</span><span class="o">=</span><span class="default_value">- 1</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.retrieveFileFromOffset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.retrieveFileFromOffset" title="Permalink to this definition">¶</a></dt> | |
| 435 | 376 | <dd><p>Retrieve the contents of the file at <em>path</em> on the <em>service_name</em> and write these contents to the provided <em>file_obj</em>.</p> |
| 436 | <table class="docutils field-list" frame="void" rules="none"> | |
| 437 | <col class="field-name" /> | |
| 438 | <col class="field-body" /> | |
| 439 | <tbody valign="top"> | |
| 440 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 441 | <li><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></li> | |
| 442 | <li><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file cannot be opened for reading, an <a class="reference internal" href="smb_exceptions.html"><em>OperationFailure</em></a> will be raised.</li> | |
| 443 | <li><strong>file_obj</strong> – A file-like object that has a <em>write</em> method. Data will be written continuously to <em>file_obj</em> up to <em>max_length</em> number of bytes.</li> | |
| 444 | <li><strong>offset</strong> (<em>integer/long</em>) – the offset in the remote <em>path</em> where the first byte will be read and written to <em>file_obj</em>. Must be either zero or a positive integer/long value.</li> | |
| 445 | <li><strong>max_length</strong> (<em>integer/long</em>) – maximum number of bytes to read from the remote <em>path</em> and write to the <em>file_obj</em>. Specify a negative value to read from <em>offset</em> to the EOF. | |
| 446 | If zero, the method returns immediately after the file is opened successfully for reading.</li> | |
| 447 | </ul> | |
| 448 | </td> | |
| 449 | </tr> | |
| 450 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A 2-element tuple of ( file attributes of the file on server, number of bytes written to <em>file_obj</em> ). | |
| 377 | <dl class="field-list simple"> | |
| 378 | <dt class="field-odd">Parameters</dt> | |
| 379 | <dd class="field-odd"><ul class="simple"> | |
| 380 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></p></li> | |
| 381 | <li><p><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file cannot be opened for reading, an <a class="reference internal" href="smb_exceptions.html"><span class="doc">OperationFailure</span></a> will be raised.</p></li> | |
| 382 | <li><p><strong>file_obj</strong> – A file-like object that has a <em>write</em> method. Data will be written continuously to <em>file_obj</em> up to <em>max_length</em> number of bytes. In Python3, this file-like object must have a <em>write</em> method which accepts a bytes parameter.</p></li> | |
| 383 | <li><p><strong>offset</strong> (<em>integer/long</em>) – the offset in the remote <em>path</em> where the first byte will be read and written to <em>file_obj</em>. Must be either zero or a positive integer/long value.</p></li> | |
| 384 | <li><p><strong>max_length</strong> (<em>integer/long</em>) – maximum number of bytes to read from the remote <em>path</em> and write to the <em>file_obj</em>. Specify a negative value to read from <em>offset</em> to the EOF. | |
| 385 | If zero, the method returns immediately after the file is opened successfully for reading.</p></li> | |
| 386 | </ul> | |
| 387 | </dd> | |
| 388 | <dt class="field-even">Returns</dt> | |
| 389 | <dd class="field-even"><p>A 2-element tuple of ( file attributes of the file on server, number of bytes written to <em>file_obj</em> ). | |
| 451 | 390 | The file attributes is an integer value made up from a bitwise-OR of <em>SMB_FILE_ATTRIBUTE_xxx</em> bits (see smb_constants.py)</p> |
| 452 | </td> | |
| 453 | </tr> | |
| 454 | </tbody> | |
| 455 | </table> | |
| 456 | </dd></dl> | |
| 457 | ||
| 458 | <dl class="method"> | |
| 391 | </dd> | |
| 392 | </dl> | |
| 393 | </dd></dl> | |
| 394 | ||
| 395 | <dl class="py method"> | |
| 459 | 396 | <dt id="smb.SMBConnection.SMBConnection.storeFile"> |
| 460 | <code class="descname">storeFile</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>file_obj</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.storeFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.storeFile" title="Permalink to this definition">¶</a></dt> | |
| 397 | <code class="sig-name descname">storeFile</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">file_obj</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.storeFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.storeFile" title="Permalink to this definition">¶</a></dt> | |
| 461 | 398 | <dd><p>Store the contents of the <em>file_obj</em> at <em>path</em> on the <em>service_name</em>. |
| 462 | 399 | If the file already exists on the remote server, it will be truncated and overwritten.</p> |
| 463 | <table class="docutils field-list" frame="void" rules="none"> | |
| 464 | <col class="field-name" /> | |
| 465 | <col class="field-body" /> | |
| 466 | <tbody valign="top"> | |
| 467 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 468 | <li><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></li> | |
| 469 | <li><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file at <em>path</em> does not exist, it will be created. Otherwise, it will be overwritten. | |
| 470 | If the <em>path</em> refers to a folder or the file cannot be opened for writing, an <a class="reference internal" href="smb_exceptions.html"><em>OperationFailure</em></a> will be raised.</li> | |
| 471 | <li><strong>file_obj</strong> – A file-like object that has a <em>read</em> method. Data will read continuously from <em>file_obj</em> until EOF.</li> | |
| 472 | </ul> | |
| 473 | </td> | |
| 474 | </tr> | |
| 475 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Number of bytes uploaded</p> | |
| 476 | </td> | |
| 477 | </tr> | |
| 478 | </tbody> | |
| 479 | </table> | |
| 480 | </dd></dl> | |
| 481 | ||
| 482 | <dl class="method"> | |
| 400 | <dl class="field-list simple"> | |
| 401 | <dt class="field-odd">Parameters</dt> | |
| 402 | <dd class="field-odd"><ul class="simple"> | |
| 403 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></p></li> | |
| 404 | <li><p><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file at <em>path</em> does not exist, it will be created. Otherwise, it will be overwritten. | |
| 405 | If the <em>path</em> refers to a folder or the file cannot be opened for writing, an <a class="reference internal" href="smb_exceptions.html"><span class="doc">OperationFailure</span></a> will be raised.</p></li> | |
| 406 | <li><p><strong>file_obj</strong> – A file-like object that has a <em>read</em> method. Data will read continuously from <em>file_obj</em> until EOF. In Python3, this file-like object must have a <em>read</em> method which returns a bytes parameter.</p></li> | |
| 407 | </ul> | |
| 408 | </dd> | |
| 409 | <dt class="field-even">Returns</dt> | |
| 410 | <dd class="field-even"><p>Number of bytes uploaded</p> | |
| 411 | </dd> | |
| 412 | </dl> | |
| 413 | </dd></dl> | |
| 414 | ||
| 415 | <dl class="py method"> | |
| 483 | 416 | <dt id="smb.SMBConnection.SMBConnection.storeFileFromOffset"> |
| 484 | <code class="descname">storeFileFromOffset</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>file_obj</em>, <em>offset=0L</em>, <em>truncate=False</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.storeFileFromOffset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.storeFileFromOffset" title="Permalink to this definition">¶</a></dt> | |
| 417 | <code class="sig-name descname">storeFileFromOffset</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">file_obj</span></em>, <em class="sig-param"><span class="n">offset</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">truncate</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBConnection.html#SMBConnection.storeFileFromOffset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBConnection.SMBConnection.storeFileFromOffset" title="Permalink to this definition">¶</a></dt> | |
| 485 | 418 | <dd><p>Store the contents of the <em>file_obj</em> at <em>path</em> on the <em>service_name</em>.</p> |
| 486 | <table class="docutils field-list" frame="void" rules="none"> | |
| 487 | <col class="field-name" /> | |
| 488 | <col class="field-body" /> | |
| 489 | <tbody valign="top"> | |
| 490 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 491 | <li><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></li> | |
| 492 | <li><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file at <em>path</em> does not exist, it will be created. | |
| 493 | If the <em>path</em> refers to a folder or the file cannot be opened for writing, an <a class="reference internal" href="smb_exceptions.html"><em>OperationFailure</em></a> will be raised.</li> | |
| 494 | <li><strong>file_obj</strong> – A file-like object that has a <em>read</em> method. Data will read continuously from <em>file_obj</em> until EOF.</li> | |
| 495 | <li><strong>offset</strong> – Long integer value which specifies the offset in the remote server to start writing. First byte of the file is 0.</li> | |
| 496 | <li><strong>truncate</strong> – Boolean value. If True and the file exists on the remote server, it will be truncated first before writing. Default is False.</li> | |
| 497 | </ul> | |
| 498 | </td> | |
| 499 | </tr> | |
| 500 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the file position where the next byte will be written.</p> | |
| 501 | </td> | |
| 502 | </tr> | |
| 503 | </tbody> | |
| 504 | </table> | |
| 505 | </dd></dl> | |
| 506 | ||
| 507 | <dl class="attribute"> | |
| 419 | <dl class="field-list simple"> | |
| 420 | <dt class="field-odd">Parameters</dt> | |
| 421 | <dd class="field-odd"><ul class="simple"> | |
| 422 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></p></li> | |
| 423 | <li><p><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file at <em>path</em> does not exist, it will be created. | |
| 424 | If the <em>path</em> refers to a folder or the file cannot be opened for writing, an <a class="reference internal" href="smb_exceptions.html"><span class="doc">OperationFailure</span></a> will be raised.</p></li> | |
| 425 | <li><p><strong>file_obj</strong> – A file-like object that has a <em>read</em> method. Data will read continuously from <em>file_obj</em> until EOF.</p></li> | |
| 426 | <li><p><strong>offset</strong> – Long integer value which specifies the offset in the remote server to start writing. First byte of the file is 0.</p></li> | |
| 427 | <li><p><strong>truncate</strong> – Boolean value. If True and the file exists on the remote server, it will be truncated first before writing. Default is False.</p></li> | |
| 428 | </ul> | |
| 429 | </dd> | |
| 430 | <dt class="field-even">Returns</dt> | |
| 431 | <dd class="field-even"><p>the file position where the next byte will be written.</p> | |
| 432 | </dd> | |
| 433 | </dl> | |
| 434 | </dd></dl> | |
| 435 | ||
| 436 | <dl class="py attribute"> | |
| 508 | 437 | <dt id="smb.SMBConnection.SMBConnection.SIGN_NEVER"> |
| 509 | <code class="descname">SIGN_NEVER</code><em class="property"> = 0</em><a class="headerlink" href="#smb.SMBConnection.SMBConnection.SIGN_NEVER" title="Permalink to this definition">¶</a></dt> | |
| 510 | <dd><p>SMB messages will never be signed regardless of remote server’s configurations; access errors will occur if the remote server requires signing.</p> | |
| 511 | </dd></dl> | |
| 512 | ||
| 513 | <dl class="attribute"> | |
| 438 | <code class="sig-name descname">SIGN_NEVER</code><em class="property"> = 0</em><a class="headerlink" href="#smb.SMBConnection.SMBConnection.SIGN_NEVER" title="Permalink to this definition">¶</a></dt> | |
| 439 | <dd><p>SMB messages will never be signed regardless of remote server’s configurations; access errors will occur if the remote server requires signing.</p> | |
| 440 | </dd></dl> | |
| 441 | ||
| 442 | <dl class="py attribute"> | |
| 514 | 443 | <dt id="smb.SMBConnection.SMBConnection.SIGN_WHEN_REQUIRED"> |
| 515 | <code class="descname">SIGN_WHEN_REQUIRED</code><em class="property"> = 2</em><a class="headerlink" href="#smb.SMBConnection.SMBConnection.SIGN_WHEN_REQUIRED" title="Permalink to this definition">¶</a></dt> | |
| 444 | <code class="sig-name descname">SIGN_WHEN_REQUIRED</code><em class="property"> = 2</em><a class="headerlink" href="#smb.SMBConnection.SMBConnection.SIGN_WHEN_REQUIRED" title="Permalink to this definition">¶</a></dt> | |
| 516 | 445 | <dd><p>SMB messages will only be signed when remote server requires signing.</p> |
| 517 | 446 | </dd></dl> |
| 518 | 447 | |
| 519 | <dl class="attribute"> | |
| 448 | <dl class="py attribute"> | |
| 520 | 449 | <dt id="smb.SMBConnection.SMBConnection.SIGN_WHEN_SUPPORTED"> |
| 521 | <code class="descname">SIGN_WHEN_SUPPORTED</code><em class="property"> = 1</em><a class="headerlink" href="#smb.SMBConnection.SMBConnection.SIGN_WHEN_SUPPORTED" title="Permalink to this definition">¶</a></dt> | |
| 450 | <code class="sig-name descname">SIGN_WHEN_SUPPORTED</code><em class="property"> = 1</em><a class="headerlink" href="#smb.SMBConnection.SMBConnection.SIGN_WHEN_SUPPORTED" title="Permalink to this definition">¶</a></dt> | |
| 522 | 451 | <dd><p>SMB messages will be signed when remote server supports signing but not requires signing.</p> |
| 523 | 452 | </dd></dl> |
| 524 | 453 | |
| 525 | <dl class="attribute"> | |
| 454 | <dl class="py method"> | |
| 526 | 455 | <dt id="smb.SMBConnection.SMBConnection.isUsingSMB2"> |
| 527 | <code class="descname">isUsingSMB2</code><a class="headerlink" href="#smb.SMBConnection.SMBConnection.isUsingSMB2" title="Permalink to this definition">¶</a></dt> | |
| 456 | <em class="property">property </em><code class="sig-name descname">isUsingSMB2</code><a class="headerlink" href="#smb.SMBConnection.SMBConnection.isUsingSMB2" title="Permalink to this definition">¶</a></dt> | |
| 528 | 457 | <dd><p>A convenient property to return True if the underlying SMB connection is using SMB2 protocol.</p> |
| 529 | 458 | </dd></dl> |
| 530 | 459 | |
| 534 | 463 | </div> |
| 535 | 464 | |
| 536 | 465 | |
| 466 | <div class="clearer"></div> | |
| 537 | 467 | </div> |
| 468 | </div> | |
| 469 | </div> | |
| 470 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 471 | <div class="sphinxsidebarwrapper"> | |
| 472 | <h3><a href="../index.html">Table of Contents</a></h3> | |
| 473 | <ul> | |
| 474 | <li><a class="reference internal" href="#">SMBConnection Class</a><ul> | |
| 475 | <li><a class="reference internal" href="#example">Example</a></li> | |
| 476 | <li><a class="reference internal" href="#smb2-support">SMB2 Support</a></li> | |
| 477 | <li><a class="reference internal" href="#caveats">Caveats</a></li> | |
| 478 | </ul> | |
| 479 | </li> | |
| 480 | </ul> | |
| 481 | ||
| 482 | <h4>Previous topic</h4> | |
| 483 | <p class="topless"><a href="nmb_NetBIOS.html" | |
| 484 | title="previous chapter">NetBIOS class</a></p> | |
| 485 | <h4>Next topic</h4> | |
| 486 | <p class="topless"><a href="smb_SMBHandler.html" | |
| 487 | title="next chapter">SMbHandler Class</a></p> | |
| 488 | <div role="note" aria-label="source link"> | |
| 489 | <h3>This Page</h3> | |
| 490 | <ul class="this-page-menu"> | |
| 491 | <li><a href="../_sources/api/smb_SMBConnection.rst.txt" | |
| 492 | rel="nofollow">Show Source</a></li> | |
| 493 | </ul> | |
| 494 | </div> | |
| 495 | <div id="searchbox" style="display: none" role="search"> | |
| 496 | <h3 id="searchlabel">Quick search</h3> | |
| 497 | <div class="searchformwrapper"> | |
| 498 | <form class="search" action="../search.html" method="get"> | |
| 499 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 500 | <input type="submit" value="Go" /> | |
| 501 | </form> | |
| 502 | </div> | |
| 503 | </div> | |
| 504 | <script>$('#searchbox').show(0);</script> | |
| 538 | 505 | </div> |
| 539 | 506 | </div> |
| 540 | 507 | <div class="clearer"></div> |
| 546 | 513 | <a href="../genindex.html" title="General Index" |
| 547 | 514 | >index</a></li> |
| 548 | 515 | <li class="right" > |
| 516 | <a href="../py-modindex.html" title="Python Module Index" | |
| 517 | >modules</a> |</li> | |
| 518 | <li class="right" > | |
| 549 | 519 | <a href="smb_SMBHandler.html" title="SMbHandler Class" |
| 550 | 520 | >next</a> |</li> |
| 551 | 521 | <li class="right" > |
| 552 | 522 | <a href="nmb_NetBIOS.html" title="NetBIOS class" |
| 553 | 523 | >previous</a> |</li> |
| 554 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 524 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 525 | <li class="nav-item nav-item-this"><a href="">SMBConnection Class</a></li> | |
| 555 | 526 | </ul> |
| 556 | 527 | </div> |
| 557 | 528 | <div class="footer" role="contentinfo"> |
| 558 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 559 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 529 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 530 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 560 | 531 | </div> |
| 561 | 532 | </body> |
| 562 | 533 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | 0 | |
| 1 | <!DOCTYPE html> | |
| 3 | 2 | |
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>SMbHandler Class — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>SMbHandler Class — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../index.html" /> | |
| 10 | <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> | |
| 11 | <script src="../_static/jquery.js"></script> | |
| 12 | <script src="../_static/underscore.js"></script> | |
| 13 | <script src="../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../search.html" /> | |
| 26 | 16 | <link rel="next" title="SMBProtocolFactory Class" href="smb_SMBProtocolFactory.html" /> |
| 27 | 17 | <link rel="prev" title="SMBConnection Class" href="smb_SMBConnection.html" /> |
| 28 | </head> | |
| 29 | <body role="document"> | |
| 18 | </head><body> | |
| 30 | 19 | <div class="related" role="navigation" aria-label="related navigation"> |
| 31 | 20 | <h3>Navigation</h3> |
| 32 | 21 | <ul> |
| 34 | 23 | <a href="../genindex.html" title="General Index" |
| 35 | 24 | accesskey="I">index</a></li> |
| 36 | 25 | <li class="right" > |
| 26 | <a href="../py-modindex.html" title="Python Module Index" | |
| 27 | >modules</a> |</li> | |
| 28 | <li class="right" > | |
| 37 | 29 | <a href="smb_SMBProtocolFactory.html" title="SMBProtocolFactory Class" |
| 38 | 30 | accesskey="N">next</a> |</li> |
| 39 | 31 | <li class="right" > |
| 40 | 32 | <a href="smb_SMBConnection.html" title="SMBConnection Class" |
| 41 | 33 | accesskey="P">previous</a> |</li> |
| 42 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 34 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 35 | <li class="nav-item nav-item-this"><a href="">SMbHandler Class</a></li> | |
| 43 | 36 | </ul> |
| 44 | </div> | |
| 37 | </div> | |
| 38 | ||
| 39 | <div class="document"> | |
| 40 | <div class="documentwrapper"> | |
| 41 | <div class="bodywrapper"> | |
| 42 | <div class="body" role="main"> | |
| 43 | ||
| 44 | <div class="section" id="smbhandler-class"> | |
| 45 | <h1>SMbHandler Class<a class="headerlink" href="#smbhandler-class" title="Permalink to this headline">¶</a></h1> | |
| 46 | <p>The SMBHandler class provides support for “<a class="reference external" href="smb://">smb://</a>” URLs in the <a class="reference external" href="http://docs.python.org/library/urllib2.html">urllib2</a> python package.</p> | |
| 47 | <div class="section" id="notes"> | |
| 48 | <h2>Notes<a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h2> | |
| 49 | <ul class="simple"> | |
| 50 | <li><p>The host component of the URL must be one of the following:</p> | |
| 51 | <ul> | |
| 52 | <li><p>A fully-qualified hostname that can be resolved by your local DNS service. Example: myserver.test.com</p></li> | |
| 53 | <li><p>An IP address. Example: 192.168.1.1</p></li> | |
| 54 | <li><p>A comma-separated string “<NBName>,<IP>” where <em><NBName></em> is the Windows/NetBIOS machine name for remote SMB service, and <em><IP></em> is the service’s IP address. Example: MYSERVER,192.168.1.1</p></li> | |
| 55 | </ul> | |
| 56 | </li> | |
| 57 | <li><p>The first component of the path in the URL points to the name of the shared folder. | |
| 58 | Subsequent path components will point to the directory/folder of the file.</p></li> | |
| 59 | <li><p>You can retrieve and upload files, but you cannot delete files/folders or create folders. | |
| 60 | In uploads, if the parent folders do not exist, an <em>urllib2.URLError</em> will be raised.</p></li> | |
| 61 | </ul> | |
| 62 | </div> | |
| 63 | <div class="section" id="example"> | |
| 64 | <h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2> | |
| 65 | <p>The following code snippet illustrates file retrieval with Python 2.:</p> | |
| 66 | <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># -*- coding: utf-8 -*-</span> | |
| 67 | <span class="kn">import</span> <span class="nn">urllib2</span> | |
| 68 | <span class="kn">from</span> <span class="nn">smb.SMBHandler</span> <span class="kn">import</span> <span class="n">SMBHandler</span> | |
| 69 | ||
| 70 | <span class="n">director</span> <span class="o">=</span> <span class="n">urllib2</span><span class="o">.</span><span class="n">build_opener</span><span class="p">(</span><span class="n">SMBHandler</span><span class="p">)</span> | |
| 71 | <span class="n">fh</span> <span class="o">=</span> <span class="n">director</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">'smb://myuserID:[email protected]/sharedfolder/rfc1001.txt'</span><span class="p">)</span> | |
| 72 | ||
| 73 | <span class="c1"># Process fh like a file-like object and then close it.</span> | |
| 74 | <span class="n">fh</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> | |
| 75 | ||
| 76 | <span class="c1"># For paths/files with unicode characters, simply pass in the URL as an unicode string</span> | |
| 77 | <span class="n">fh2</span> <span class="o">=</span> <span class="n">director</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="sa">u</span><span class="s1">'smb://myuserID:[email protected]/sharedfolder/测试文件夹/垃圾文件.dat'</span><span class="p">)</span> | |
| 78 | ||
| 79 | <span class="c1"># Process fh2 like a file-like object and then close it.</span> | |
| 80 | <span class="n">fh2</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> | |
| 81 | </pre></div> | |
| 82 | </div> | |
| 83 | <p>The following code snippet illustrates file upload with Python 2. You need to provide a file-like object for the <em>data</em> parameter in the <em>open()</em> method:</p> | |
| 84 | <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">urllib2</span> | |
| 85 | <span class="kn">from</span> <span class="nn">smb.SMBHandler</span> <span class="kn">import</span> <span class="n">SMBHandler</span> | |
| 86 | ||
| 87 | <span class="n">file_fh</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'local_file.dat'</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> | |
| 88 | ||
| 89 | <span class="n">director</span> <span class="o">=</span> <span class="n">urllib2</span><span class="o">.</span><span class="n">build_opener</span><span class="p">(</span><span class="n">SMBHandler</span><span class="p">)</span> | |
| 90 | <span class="n">fh</span> <span class="o">=</span> <span class="n">director</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">'smb://myuserID:[email protected]/sharedfolder/upload_file.dat'</span><span class="p">,</span> <span class="n">data</span> <span class="o">=</span> <span class="n">file_fh</span><span class="p">)</span> | |
| 91 | ||
| 92 | <span class="c1"># Reading from fh will only return an empty string</span> | |
| 93 | <span class="n">fh</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> | |
| 94 | </pre></div> | |
| 95 | </div> | |
| 96 | <p>The following code snippet illustrates file retrieval with Python 3.:</p> | |
| 97 | <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">urllib</span> | |
| 98 | <span class="kn">from</span> <span class="nn">smb.SMBHandler</span> <span class="kn">import</span> <span class="n">SMBHandler</span> | |
| 99 | ||
| 100 | <span class="n">director</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">build_opener</span><span class="p">(</span><span class="n">SMBHandler</span><span class="p">)</span> | |
| 101 | <span class="n">fh</span> <span class="o">=</span> <span class="n">director</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">'smb://myuserID:[email protected]/sharedfolder/rfc1001.txt'</span><span class="p">)</span> | |
| 102 | ||
| 103 | <span class="c1"># Process fh like a file-like object and then close it.</span> | |
| 104 | <span class="n">fh</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> | |
| 105 | ||
| 106 | <span class="c1"># For paths/files with unicode characters, simply pass in the URL as an unicode string</span> | |
| 107 | <span class="n">fh2</span> <span class="o">=</span> <span class="n">director</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="sa">u</span><span class="s1">'smb://myuserID:[email protected]/sharedfolder/测试文件夹/垃圾文件.dat'</span><span class="p">)</span> | |
| 108 | ||
| 109 | <span class="c1"># Process fh2 like a file-like object and then close it.</span> | |
| 110 | <span class="n">fh2</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> | |
| 111 | </pre></div> | |
| 112 | </div> | |
| 113 | <p>The following code snippet illustrates file upload with Python 3. You need to provide a file-like object for the <em>data</em> parameter in the <em>open()</em> method:</p> | |
| 114 | <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">urllib</span> | |
| 115 | <span class="kn">from</span> <span class="nn">smb.SMBHandler</span> <span class="kn">import</span> <span class="n">SMBHandler</span> | |
| 116 | ||
| 117 | <span class="n">file_fh</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'local_file.dat'</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> | |
| 118 | ||
| 119 | <span class="n">director</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">build_opener</span><span class="p">(</span><span class="n">SMBHandler</span><span class="p">)</span> | |
| 120 | <span class="n">fh</span> <span class="o">=</span> <span class="n">director</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">'smb://myuserID:[email protected]/sharedfolder/upload_file.dat'</span><span class="p">,</span> <span class="n">data</span> <span class="o">=</span> <span class="n">file_fh</span><span class="p">)</span> | |
| 121 | ||
| 122 | <span class="c1"># Reading from fh will only return an empty string</span> | |
| 123 | <span class="n">fh</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> | |
| 124 | </pre></div> | |
| 125 | </div> | |
| 126 | </div> | |
| 127 | </div> | |
| 128 | ||
| 129 | ||
| 130 | <div class="clearer"></div> | |
| 131 | </div> | |
| 132 | </div> | |
| 133 | </div> | |
| 45 | 134 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
| 46 | 135 | <div class="sphinxsidebarwrapper"> |
| 47 | <h3><a href="../index.html">Table Of Contents</a></h3> | |
| 136 | <h3><a href="../index.html">Table of Contents</a></h3> | |
| 48 | 137 | <ul> |
| 49 | 138 | <li><a class="reference internal" href="#">SMbHandler Class</a><ul> |
| 50 | 139 | <li><a class="reference internal" href="#notes">Notes</a></li> |
| 62 | 151 | <div role="note" aria-label="source link"> |
| 63 | 152 | <h3>This Page</h3> |
| 64 | 153 | <ul class="this-page-menu"> |
| 65 | <li><a href="../_sources/api/smb_SMBHandler.txt" | |
| 154 | <li><a href="../_sources/api/smb_SMBHandler.rst.txt" | |
| 66 | 155 | rel="nofollow">Show Source</a></li> |
| 67 | 156 | </ul> |
| 68 | 157 | </div> |
| 69 | 158 | <div id="searchbox" style="display: none" role="search"> |
| 70 | <h3>Quick search</h3> | |
| 159 | <h3 id="searchlabel">Quick search</h3> | |
| 160 | <div class="searchformwrapper"> | |
| 71 | 161 | <form class="search" action="../search.html" method="get"> |
| 72 | <input type="text" name="q" /> | |
| 162 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 73 | 163 | <input type="submit" value="Go" /> |
| 74 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 75 | <input type="hidden" name="area" value="default" /> | |
| 76 | 164 | </form> |
| 77 | <p class="searchtip" style="font-size: 90%"> | |
| 78 | Enter search terms or a module, class or function name. | |
| 79 | </p> | |
| 165 | </div> | |
| 80 | 166 | </div> |
| 81 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 82 | </div> | |
| 83 | </div> | |
| 84 | ||
| 85 | <div class="document"> | |
| 86 | <div class="documentwrapper"> | |
| 87 | <div class="bodywrapper"> | |
| 88 | <div class="body" role="main"> | |
| 89 | ||
| 90 | <div class="section" id="smbhandler-class"> | |
| 91 | <h1>SMbHandler Class<a class="headerlink" href="#smbhandler-class" title="Permalink to this headline">¶</a></h1> | |
| 92 | <p>The SMBHandler class provides support for “<a class="reference external" href="smb://">smb://</a>” URLs in the <a class="reference external" href="http://docs.python.org/library/urllib2.html">urllib2</a> python package.</p> | |
| 93 | <div class="section" id="notes"> | |
| 94 | <h2>Notes<a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h2> | |
| 95 | <ul class="simple"> | |
| 96 | <li>Note that you need to pass in a valid hostname or IP address for the host component of the URL. | |
| 97 | Do not use the Windows/NetBIOS machine name for the host component.</li> | |
| 98 | <li>The first component of the path in the URL points to the name of the shared folder. | |
| 99 | Subsequent path components will point to the directory/folder of the file.</li> | |
| 100 | <li>You can retrieve and upload files, but you cannot delete files/folders or create folders. | |
| 101 | In uploads, if the parent folders do not exist, an <em>urllib2.URLError</em> will be raised.</li> | |
| 102 | </ul> | |
| 103 | </div> | |
| 104 | <div class="section" id="example"> | |
| 105 | <h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2> | |
| 106 | <p>The following code snippet illustrates file retrieval.:</p> | |
| 107 | <div class="highlight-python"><div class="highlight"><pre><span class="c1"># -*- coding: utf-8 -*-</span> | |
| 108 | <span class="kn">import</span> <span class="nn">urllib2</span> | |
| 109 | <span class="kn">from</span> <span class="nn">smb.SMBHandler</span> <span class="kn">import</span> <span class="n">SMBHandler</span> | |
| 110 | ||
| 111 | <span class="n">director</span> <span class="o">=</span> <span class="n">urllib2</span><span class="o">.</span><span class="n">build_opener</span><span class="p">(</span><span class="n">SMBHandler</span><span class="p">)</span> | |
| 112 | <span class="n">fh</span> <span class="o">=</span> <span class="n">director</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">'smb://myuserID:[email protected]/sharedfolder/rfc1001.txt'</span><span class="p">)</span> | |
| 113 | ||
| 114 | <span class="c1"># Process fh like a file-like object and then close it.</span> | |
| 115 | <span class="n">fh</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> | |
| 116 | ||
| 117 | <span class="c1"># For paths/files with unicode characters, simply pass in the URL as an unicode string</span> | |
| 118 | <span class="n">fh2</span> <span class="o">=</span> <span class="n">director</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">u'smb://myuserID:[email protected]/sharedfolder/测试文件夹/垃圾文件.dat'</span><span class="p">)</span> | |
| 119 | ||
| 120 | <span class="c1"># Process fh2 like a file-like object and then close it.</span> | |
| 121 | <span class="n">fh2</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> | |
| 122 | </pre></div> | |
| 123 | </div> | |
| 124 | <p>The following code snippet illustrates file upload. You need to provide a file-like object for the <em>data</em> parameter in the <em>open()</em> method:</p> | |
| 125 | <div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">urllib2</span> | |
| 126 | <span class="kn">from</span> <span class="nn">smb.SMBHandler</span> <span class="kn">import</span> <span class="n">SMBHandler</span> | |
| 127 | ||
| 128 | <span class="n">file_fh</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'local_file.dat'</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> | |
| 129 | ||
| 130 | <span class="n">director</span> <span class="o">=</span> <span class="n">urllib2</span><span class="o">.</span><span class="n">build_opener</span><span class="p">(</span><span class="n">SMBHandler</span><span class="p">)</span> | |
| 131 | <span class="n">fh</span> <span class="o">=</span> <span class="n">director</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">'smb://myuserID:[email protected]/sharedfolder/upload_file.dat'</span><span class="p">,</span> <span class="n">data</span> <span class="o">=</span> <span class="n">file_fh</span><span class="p">)</span> | |
| 132 | ||
| 133 | <span class="c1"># Reading from fh will only return an empty string</span> | |
| 134 | <span class="n">fh</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> | |
| 135 | </pre></div> | |
| 136 | </div> | |
| 137 | </div> | |
| 138 | </div> | |
| 139 | ||
| 140 | ||
| 141 | </div> | |
| 167 | <script>$('#searchbox').show(0);</script> | |
| 142 | 168 | </div> |
| 143 | 169 | </div> |
| 144 | 170 | <div class="clearer"></div> |
| 150 | 176 | <a href="../genindex.html" title="General Index" |
| 151 | 177 | >index</a></li> |
| 152 | 178 | <li class="right" > |
| 179 | <a href="../py-modindex.html" title="Python Module Index" | |
| 180 | >modules</a> |</li> | |
| 181 | <li class="right" > | |
| 153 | 182 | <a href="smb_SMBProtocolFactory.html" title="SMBProtocolFactory Class" |
| 154 | 183 | >next</a> |</li> |
| 155 | 184 | <li class="right" > |
| 156 | 185 | <a href="smb_SMBConnection.html" title="SMBConnection Class" |
| 157 | 186 | >previous</a> |</li> |
| 158 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 187 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 188 | <li class="nav-item nav-item-this"><a href="">SMbHandler Class</a></li> | |
| 159 | 189 | </ul> |
| 160 | 190 | </div> |
| 161 | 191 | <div class="footer" role="contentinfo"> |
| 162 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 163 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 192 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 193 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 164 | 194 | </div> |
| 165 | 195 | </body> |
| 166 | 196 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | ||
| 3 | ||
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 0 | ||
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>SMBProtocolFactory Class — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>SMBProtocolFactory Class — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../index.html" /> | |
| 10 | <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> | |
| 11 | <script src="../_static/jquery.js"></script> | |
| 12 | <script src="../_static/underscore.js"></script> | |
| 13 | <script src="../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../search.html" /> | |
| 26 | 16 | <link rel="next" title="SharedDevice Class" href="smb_SharedDevice.html" /> |
| 27 | 17 | <link rel="prev" title="SMbHandler Class" href="smb_SMBHandler.html" /> |
| 28 | </head> | |
| 29 | <body role="document"> | |
| 18 | </head><body> | |
| 30 | 19 | <div class="related" role="navigation" aria-label="related navigation"> |
| 31 | 20 | <h3>Navigation</h3> |
| 32 | 21 | <ul> |
| 34 | 23 | <a href="../genindex.html" title="General Index" |
| 35 | 24 | accesskey="I">index</a></li> |
| 36 | 25 | <li class="right" > |
| 26 | <a href="../py-modindex.html" title="Python Module Index" | |
| 27 | >modules</a> |</li> | |
| 28 | <li class="right" > | |
| 37 | 29 | <a href="smb_SharedDevice.html" title="SharedDevice Class" |
| 38 | 30 | accesskey="N">next</a> |</li> |
| 39 | 31 | <li class="right" > |
| 40 | 32 | <a href="smb_SMBHandler.html" title="SMbHandler Class" |
| 41 | 33 | accesskey="P">previous</a> |</li> |
| 42 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 34 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 35 | <li class="nav-item nav-item-this"><a href="">SMBProtocolFactory Class</a></li> | |
| 43 | 36 | </ul> |
| 44 | </div> | |
| 37 | </div> | |
| 38 | ||
| 39 | <div class="document"> | |
| 40 | <div class="documentwrapper"> | |
| 41 | <div class="bodywrapper"> | |
| 42 | <div class="body" role="main"> | |
| 43 | ||
| 44 | <div class="section" id="smbprotocolfactory-class"> | |
| 45 | <h1>SMBProtocolFactory Class<a class="headerlink" href="#smbprotocolfactory-class" title="Permalink to this headline">¶</a></h1> | |
| 46 | <p>For those who want to utilize pysmb in Twisted framework, pysmb has a <em>smb.SMBProtocol.SMBProtocol</em> implementation. | |
| 47 | In most cases, you do not need to touch or import the <em>SMBProtocol</em> directly. All the SMB functionalities are exposed in the <em>SMBProtocolFactory</em>.</p> | |
| 48 | <dl class="simple"> | |
| 49 | <dt>In your project,</dt><dd><ol class="arabic simple"> | |
| 50 | <li><p>Create a new class and subclass <em>SMBProtocolFactory</em>.</p></li> | |
| 51 | <li><p>Override the <em>SMBProtocolFactory.onAuthOK</em> and <em>SMBProtocolFactory.onAuthFailed</em> instance methods to provide your own post-authenthentication handling. | |
| 52 | Once <em>SMBProtocolFactory.onAuthOK</em> has been called by pymsb internals, your application is ready to communicate with the remote SMB/CIFS service through | |
| 53 | the <em>SMBProtocolFactory</em> public methods such as <em>SMBProtocolFactory.storeFile</em>, <em>SMBProtocolFactory.retrieveFile</em>, etc.</p></li> | |
| 54 | <li><p>When you want to disconnect from the remote SMB/CIFS server, just call <em>SMBProtocolFactory.closeConnection</em> method.</p></li> | |
| 55 | </ol> | |
| 56 | </dd> | |
| 57 | </dl> | |
| 58 | <p>All the <em>SMBProtocolFactory</em> public methods that provide file functionlities will return a <em>twisted.internet.defer.Deferred</em> instance. | |
| 59 | A <a class="reference internal" href="smb_exceptions.html"><span class="doc">NotReadyError</span></a> exception is raised when the underlying SMB is not authenticated. | |
| 60 | If the underlying SMB connection has been terminated, a <a class="reference internal" href="smb_exceptions.html"><span class="doc">NotConnectedError</span></a> exception is raised.</p> | |
| 61 | <p>All the file operation methods in <em>SMBProtocolFactory</em> class accept a <em>timeout</em> parameter. This parameter specifies the time limit where pysmb will wait for the | |
| 62 | entire file operation (except <em>storeFile</em> and <em>retrieveFile</em> methods) to complete. If the file operation fails to complete within the timeout period, the returned | |
| 63 | <em>Deferred</em> instance’s <em>errback</em> method will be called with a <em>SMBTimeout</em> exception.</p> | |
| 64 | <p>If you are interested in learning the results of the operation or to know when the operation has completed, you should | |
| 65 | add a handling method to the returned <em>Deferred</em> instance via <em>Deferred.addCallback</em>. If the file operation fails, the <em>Deferred.errback</em> function will be called | |
| 66 | with an <a class="reference internal" href="smb_exceptions.html"><span class="doc">OperationFailure</span></a>; on timeout, it will be called with a <a class="reference internal" href="smb_exceptions.html"><span class="doc">SMBTimeout</span></a>.</p> | |
| 67 | <div class="section" id="example"> | |
| 68 | <h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2> | |
| 69 | <p>The following illustrates a simple file retrieving implementation.:</p> | |
| 70 | <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tempfile</span> | |
| 71 | <span class="kn">from</span> <span class="nn">twisted.internet</span> <span class="kn">import</span> <span class="n">reactor</span> | |
| 72 | <span class="kn">from</span> <span class="nn">smb.SMBProtocol</span> <span class="kn">import</span> <span class="n">SMBProtocolFactory</span> | |
| 73 | ||
| 74 | <span class="k">class</span> <span class="nc">RetrieveFileFactory</span><span class="p">(</span><span class="n">SMBProtocolFactory</span><span class="p">):</span> | |
| 75 | ||
| 76 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 77 | <span class="n">SMBProtocolFactory</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> | |
| 78 | ||
| 79 | <span class="k">def</span> <span class="nf">fileRetrieved</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">write_result</span><span class="p">):</span> | |
| 80 | <span class="n">file_obj</span><span class="p">,</span> <span class="n">file_attributes</span><span class="p">,</span> <span class="n">file_size</span> <span class="o">=</span> <span class="n">write_result</span> | |
| 81 | ||
| 82 | <span class="c1"># Retrieved file contents are inside file_obj</span> | |
| 83 | <span class="c1"># Do what you need with the file_obj and then close it</span> | |
| 84 | <span class="c1"># Note that the file obj is positioned at the end-of-file,</span> | |
| 85 | <span class="c1"># so you might need to perform a file_obj.seek() to if you</span> | |
| 86 | <span class="c1"># need to read from the beginning</span> | |
| 87 | <span class="n">file_obj</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> | |
| 88 | ||
| 89 | <span class="bp">self</span><span class="o">.</span><span class="n">transport</span><span class="o">.</span><span class="n">loseConnection</span><span class="p">()</span> | |
| 90 | ||
| 91 | <span class="k">def</span> <span class="nf">onAuthOK</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 92 | <span class="n">d</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">retrieveFile</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">NamedTemporaryFile</span><span class="p">())</span> | |
| 93 | <span class="n">d</span><span class="o">.</span><span class="n">addCallback</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fileRetrieved</span><span class="p">)</span> | |
| 94 | <span class="n">d</span><span class="o">.</span><span class="n">addErrback</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">d</span><span class="o">.</span><span class="n">errback</span><span class="p">)</span> | |
| 95 | ||
| 96 | <span class="k">def</span> <span class="nf">onAuthFailed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 97 | <span class="nb">print</span> <span class="s1">'Auth failed'</span> | |
| 98 | ||
| 99 | <span class="c1"># There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip</span> | |
| 100 | <span class="c1"># client_machine_name can be an arbitary ASCII string</span> | |
| 101 | <span class="c1"># server_name should match the remote machine name, or else the connection will be rejected</span> | |
| 102 | <span class="n">factory</span> <span class="o">=</span> <span class="n">RetrieveFileFactory</span><span class="p">(</span><span class="n">userID</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">client_machine_name</span><span class="p">,</span> <span class="n">server_name</span><span class="p">,</span> <span class="n">use_ntlm_v2</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> | |
| 103 | <span class="n">factory</span><span class="o">.</span><span class="n">service</span> <span class="o">=</span> <span class="s1">'smbtest'</span> | |
| 104 | <span class="n">factory</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="s1">'/rfc1001.txt'</span> | |
| 105 | <span class="n">reactor</span><span class="o">.</span><span class="n">connectTCP</span><span class="p">(</span><span class="n">server_ip</span><span class="p">,</span> <span class="mi">139</span><span class="p">,</span> <span class="n">factory</span><span class="p">)</span> | |
| 106 | </pre></div> | |
| 107 | </div> | |
| 108 | </div> | |
| 109 | <div class="section" id="smb2-support"> | |
| 110 | <h2>SMB2 Support<a class="headerlink" href="#smb2-support" title="Permalink to this headline">¶</a></h2> | |
| 111 | <p>Starting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2. | |
| 112 | Otherwise, it will fallback automatically back to using SMB1 protocol.</p> | |
| 113 | <p>To disable SMB2 protocol in pysmb, set the <em>SUPPORT_SMB2</em> flag in the <em>smb_structs</em> module to <em>False</em> before creating the <em>SMBProtocolFactory</em> instance.:</p> | |
| 114 | <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">smb</span> <span class="kn">import</span> <span class="n">smb_structs</span> | |
| 115 | <span class="n">smb_structs</span><span class="o">.</span><span class="n">SUPPORT_SMB2</span> <span class="o">=</span> <span class="kc">False</span> | |
| 116 | </pre></div> | |
| 117 | </div> | |
| 118 | </div> | |
| 119 | <div class="section" id="caveats"> | |
| 120 | <h2>Caveats<a class="headerlink" href="#caveats" title="Permalink to this headline">¶</a></h2> | |
| 121 | <ul class="simple"> | |
| 122 | <li><p>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.</p></li> | |
| 123 | <li><p>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 <em>storeFile</em> or <em>retrieveFile</em> in batches.</p></li> | |
| 124 | <li><p>The <em>timeout</em> 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 | |
| 125 | <em>SMBTimeout</em> exception after 1.5 sec.</p></li> | |
| 126 | </ul> | |
| 127 | <dl class="py class"> | |
| 128 | <dt id="smb.SMBProtocol.SMBProtocolFactory"> | |
| 129 | <em class="property">class </em><code class="sig-prename descclassname">smb.SMBProtocol.</code><code class="sig-name descname">SMBProtocolFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">username</span></em>, <em class="sig-param"><span class="n">password</span></em>, <em class="sig-param"><span class="n">my_name</span></em>, <em class="sig-param"><span class="n">remote_name</span></em>, <em class="sig-param"><span class="n">domain</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">use_ntlm_v2</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">sign_options</span><span class="o">=</span><span class="default_value">2</span></em>, <em class="sig-param"><span class="n">is_direct_tcp</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory" title="Permalink to this definition">¶</a></dt> | |
| 130 | <dd><dl class="py attribute"> | |
| 131 | <dt id="smb.SMBProtocol.SMBProtocolFactory.protocol"> | |
| 132 | <code class="sig-name descname">protocol</code><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.protocol" title="Permalink to this definition">¶</a></dt> | |
| 133 | <dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">smb.SMBProtocol.SMBProtocol</span></code></p> | |
| 134 | </dd></dl> | |
| 135 | ||
| 136 | <dl class="py method"> | |
| 137 | <dt id="smb.SMBProtocol.SMBProtocolFactory.__init__"> | |
| 138 | <code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">username</span></em>, <em class="sig-param"><span class="n">password</span></em>, <em class="sig-param"><span class="n">my_name</span></em>, <em class="sig-param"><span class="n">remote_name</span></em>, <em class="sig-param"><span class="n">domain</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">use_ntlm_v2</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">sign_options</span><span class="o">=</span><span class="default_value">2</span></em>, <em class="sig-param"><span class="n">is_direct_tcp</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.__init__" title="Permalink to this definition">¶</a></dt> | |
| 139 | <dd><p>Create a new SMBProtocolFactory instance. You will pass this instance to <em>reactor.connectTCP()</em> which will then instantiate the TCP connection to the remote SMB/CIFS server. | |
| 140 | Note that the default TCP port for most SMB/CIFS servers using NetBIOS over TCP/IP is 139. | |
| 141 | Some newer server installations might also support Direct hosting of SMB over TCP/IP; for these servers, the default TCP port is 445.</p> | |
| 142 | <p><em>username</em> and <em>password</em> are the user credentials required to authenticate the underlying SMB connection with the remote server. | |
| 143 | File operations can only be proceeded after the connection has been authenticated successfully.</p> | |
| 144 | <dl class="field-list simple"> | |
| 145 | <dt class="field-odd">Parameters</dt> | |
| 146 | <dd class="field-odd"><ul class="simple"> | |
| 147 | <li><p><strong>my_name</strong> (<em>string</em>) – The local NetBIOS machine name that will identify where this connection is originating from. | |
| 148 | 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 <code class="docutils literal notranslate"><span class="pre">\/:*?";|+</span></code></p></li> | |
| 149 | <li><p><strong>remote_name</strong> (<em>string</em>) – The NetBIOS machine name of the remote server. | |
| 150 | On windows, you can find out the machine name by right-clicking on the “My Computer” and selecting “Properties”. | |
| 151 | This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected.</p></li> | |
| 152 | <li><p><strong>domain</strong> (<em>string</em>) – The network domain. On windows, it is known as the workgroup. Usually, it is safe to leave this parameter as an empty string.</p></li> | |
| 153 | <li><p><strong>use_ntlm_v2</strong> (<em>boolean</em>) – Indicates whether pysmb should be NTLMv1 or NTLMv2 authentication algorithm for authentication. | |
| 154 | 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. | |
| 155 | Hence, we can only “guess” or try both algorithms. | |
| 156 | On Sambda, Windows Vista and Windows 7, NTLMv2 is enabled by default. On Windows XP, we can use NTLMv1 before NTLMv2.</p></li> | |
| 157 | <li><p><strong>sign_options</strong> (<em>int</em>) – Determines whether SMB messages will be signed. Default is <em>SIGN_WHEN_REQUIRED</em>. | |
| 158 | If <em>SIGN_WHEN_REQUIRED</em> (value=2), SMB messages will only be signed when remote server requires signing. | |
| 159 | If <em>SIGN_WHEN_SUPPORTED</em> (value=1), SMB messages will be signed when remote server supports signing but not requires signing. | |
| 160 | If <em>SIGN_NEVER</em> (value=0), SMB messages will never be signed regardless of remote server’s configurations; access errors will occur if the remote server requires signing.</p></li> | |
| 161 | <li><p><strong>is_direct_tcp</strong> (<em>boolean</em>) – 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. | |
| 162 | The default parameter is False which will use NetBIOS over TCP/IP for wider compatibility (TCP port: 139).</p></li> | |
| 163 | </ul> | |
| 164 | </dd> | |
| 165 | </dl> | |
| 166 | </dd></dl> | |
| 167 | ||
| 168 | <dl class="py method"> | |
| 169 | <dt id="smb.SMBProtocol.SMBProtocolFactory.buildProtocol"> | |
| 170 | <code class="sig-name descname">buildProtocol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">addr</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.buildProtocol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.buildProtocol" title="Permalink to this definition">¶</a></dt> | |
| 171 | <dd><p>Create an instance of a subclass of Protocol.</p> | |
| 172 | <p>The returned instance will handle input on an incoming server | |
| 173 | connection, and an attribute “factory” pointing to the creating | |
| 174 | factory.</p> | |
| 175 | <p>Alternatively, L{None} may be returned to immediately close the | |
| 176 | new connection.</p> | |
| 177 | <p>Override this method to alter how Protocol instances get created.</p> | |
| 178 | <p>@param addr: an object implementing L{twisted.internet.interfaces.IAddress}</p> | |
| 179 | </dd></dl> | |
| 180 | ||
| 181 | <dl class="py method"> | |
| 182 | <dt id="smb.SMBProtocol.SMBProtocolFactory.closeConnection"> | |
| 183 | <code class="sig-name descname">closeConnection</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.closeConnection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.closeConnection" title="Permalink to this definition">¶</a></dt> | |
| 184 | <dd><p>Disconnect from the remote SMB/CIFS server. The TCP connection will be closed at the earliest opportunity after this method returns.</p> | |
| 185 | <dl class="field-list simple"> | |
| 186 | <dt class="field-odd">Returns</dt> | |
| 187 | <dd class="field-odd"><p>None</p> | |
| 188 | </dd> | |
| 189 | </dl> | |
| 190 | </dd></dl> | |
| 191 | ||
| 192 | <dl class="py method"> | |
| 193 | <dt id="smb.SMBProtocol.SMBProtocolFactory.createDirectory"> | |
| 194 | <code class="sig-name descname">createDirectory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.createDirectory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.createDirectory" title="Permalink to this definition">¶</a></dt> | |
| 195 | <dd><p>Creates a new directory <em>path</em> on the <em>service_name</em>.</p> | |
| 196 | <dl class="field-list simple"> | |
| 197 | <dt class="field-odd">Parameters</dt> | |
| 198 | <dd class="field-odd"><ul class="simple"> | |
| 199 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</p></li> | |
| 200 | <li><p><strong>path</strong> (<em>string/unicode</em>) – The path of the new folder (relative to) the shared folder. | |
| 201 | If the path contains non-English characters, an unicode string must be used to pass in the path.</p></li> | |
| 202 | <li><p><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds that pysmb will wait before raising <em>SMBTimeout</em> via the returned <em>Deferred</em> instance’s <em>errback</em> method.</p></li> | |
| 203 | </ul> | |
| 204 | </dd> | |
| 205 | <dt class="field-even">Returns</dt> | |
| 206 | <dd class="field-even"><p>A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with the <em>path</em> parameter.</p> | |
| 207 | </dd> | |
| 208 | </dl> | |
| 209 | </dd></dl> | |
| 210 | ||
| 211 | <dl class="py method"> | |
| 212 | <dt id="smb.SMBProtocol.SMBProtocolFactory.deleteDirectory"> | |
| 213 | <code class="sig-name descname">deleteDirectory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.deleteDirectory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.deleteDirectory" title="Permalink to this definition">¶</a></dt> | |
| 214 | <dd><p>Delete the empty folder at <em>path</em> on <em>service_name</em></p> | |
| 215 | <dl class="field-list simple"> | |
| 216 | <dt class="field-odd">Parameters</dt> | |
| 217 | <dd class="field-odd"><ul class="simple"> | |
| 218 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</p></li> | |
| 219 | <li><p><strong>path</strong> (<em>string/unicode</em>) – The path of the to-be-deleted folder (relative to) the shared folder. | |
| 220 | If the path contains non-English characters, an unicode string must be used to pass in the path.</p></li> | |
| 221 | <li><p><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds that pysmb will wait before raising <em>SMBTimeout</em> via the returned <em>Deferred</em> instance’s <em>errback</em> method.</p></li> | |
| 222 | </ul> | |
| 223 | </dd> | |
| 224 | <dt class="field-even">Returns</dt> | |
| 225 | <dd class="field-even"><p>A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with the <em>path</em> parameter.</p> | |
| 226 | </dd> | |
| 227 | </dl> | |
| 228 | </dd></dl> | |
| 229 | ||
| 230 | <dl class="py method"> | |
| 231 | <dt id="smb.SMBProtocol.SMBProtocolFactory.deleteFiles"> | |
| 232 | <code class="sig-name descname">deleteFiles</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path_file_pattern</span></em>, <em class="sig-param"><span class="n">delete_matching_folders</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.deleteFiles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.deleteFiles" title="Permalink to this definition">¶</a></dt> | |
| 233 | <dd><p>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.</p> | |
| 234 | <p>If delete_matching_folders is True, immediate sub-folders that match the path_file_pattern will be deleted recursively.</p> | |
| 235 | <dl class="field-list simple"> | |
| 236 | <dt class="field-odd">Parameters</dt> | |
| 237 | <dd class="field-odd"><ul class="simple"> | |
| 238 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</p></li> | |
| 239 | <li><p><strong>path_file_pattern</strong> (<em>string/unicode</em>) – The pathname of the file(s) to be deleted, relative to the service_name. | |
| 240 | Wildcards may be used in th filename component of the path. | |
| 241 | If your path/filename contains non-English characters, you must pass in an unicode string.</p></li> | |
| 242 | <li><p><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds that pysmb will wait before raising <em>SMBTimeout</em> via the returned <em>Deferred</em> instance’s <em>errback</em> method.</p></li> | |
| 243 | </ul> | |
| 244 | </dd> | |
| 245 | <dt class="field-even">Returns</dt> | |
| 246 | <dd class="field-even"><p>A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with the <em>path_file_pattern</em> parameter.</p> | |
| 247 | </dd> | |
| 248 | </dl> | |
| 249 | </dd></dl> | |
| 250 | ||
| 251 | <dl class="py method"> | |
| 252 | <dt id="smb.SMBProtocol.SMBProtocolFactory.echo"> | |
| 253 | <code class="sig-name descname">echo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">10</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.echo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.echo" title="Permalink to this definition">¶</a></dt> | |
| 254 | <dd><p>Send an echo command containing <em>data</em> to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same <em>data</em>.</p> | |
| 255 | <dl class="field-list simple"> | |
| 256 | <dt class="field-odd">Parameters</dt> | |
| 257 | <dd class="field-odd"><ul class="simple"> | |
| 258 | <li><p><strong>data</strong> (<em>bytes</em>) – Data to send to the remote server. Must be a bytes object.</p></li> | |
| 259 | <li><p><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds that pysmb will wait before raising <em>SMBTimeout</em> via the returned <em>Deferred</em> instance’s <em>errback</em> method.</p></li> | |
| 260 | </ul> | |
| 261 | </dd> | |
| 262 | <dt class="field-even">Returns</dt> | |
| 263 | <dd class="field-even"><p>A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with the <em>data</em> parameter.</p> | |
| 264 | </dd> | |
| 265 | </dl> | |
| 266 | </dd></dl> | |
| 267 | ||
| 268 | <dl class="py method"> | |
| 269 | <dt id="smb.SMBProtocol.SMBProtocolFactory.getAttributes"> | |
| 270 | <code class="sig-name descname">getAttributes</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.getAttributes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.getAttributes" title="Permalink to this definition">¶</a></dt> | |
| 271 | <dd><p>Retrieve information about the file at <em>path</em> on the <em>service_name</em>.</p> | |
| 272 | <dl class="field-list simple"> | |
| 273 | <dt class="field-odd">Parameters</dt> | |
| 274 | <dd class="field-odd"><ul class="simple"> | |
| 275 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></p></li> | |
| 276 | <li><p><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file cannot be opened for reading, an <a class="reference internal" href="smb_exceptions.html"><span class="doc">OperationFailure</span></a> will be raised.</p></li> | |
| 277 | </ul> | |
| 278 | </dd> | |
| 279 | <dt class="field-even">Returns</dt> | |
| 280 | <dd class="field-even"><p>A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a <a class="reference internal" href="smb_SharedFile.html"><span class="doc">smb.base.SharedFile</span></a> instance containing the attributes of the file.</p> | |
| 281 | </dd> | |
| 282 | </dl> | |
| 283 | </dd></dl> | |
| 284 | ||
| 285 | <dl class="py method"> | |
| 286 | <dt id="smb.SMBProtocol.SMBProtocolFactory.listPath"> | |
| 287 | <code class="sig-name descname">listPath</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">search</span><span class="o">=</span><span class="default_value">65591</span></em>, <em class="sig-param"><span class="n">pattern</span><span class="o">=</span><span class="default_value">'*'</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.listPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.listPath" title="Permalink to this definition">¶</a></dt> | |
| 288 | <dd><p>Retrieve a directory listing of files/folders at <em>path</em></p> | |
| 289 | <p>For simplicity, pysmb defines a “normal” file as a file entry that is not read-only, not hidden, not system, not archive and not a directory. | |
| 290 | It ignores other attributes like compression, indexed, sparse, temporary and encryption.</p> | |
| 291 | <p>Note that the default search parameter will query for all read-only (SMB_FILE_ATTRIBUTE_READONLY), hidden (SMB_FILE_ATTRIBUTE_HIDDEN), | |
| 292 | system (SMB_FILE_ATTRIBUTE_SYSTEM), archive (SMB_FILE_ATTRIBUTE_ARCHIVE), normal (SMB_FILE_ATTRIBUTE_INCL_NORMAL) files | |
| 293 | and directories (SMB_FILE_ATTRIBUTE_DIRECTORY). | |
| 294 | If you do not need to include “normal” files in the result, define your own search parameter without the SMB_FILE_ATTRIBUTE_INCL_NORMAL constant. | |
| 295 | SMB_FILE_ATTRIBUTE_NORMAL should be used by itself and not be used with other bit constants.</p> | |
| 296 | <dl class="field-list simple"> | |
| 297 | <dt class="field-odd">Parameters</dt> | |
| 298 | <dd class="field-odd"><ul class="simple"> | |
| 299 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></p></li> | |
| 300 | <li><p><strong>path</strong> (<em>string/unicode</em>) – path relative to the <em>service_name</em> where we are interested to learn about its files/sub-folders.</p></li> | |
| 301 | <li><p><strong>search</strong> (<em>integer</em>) – integer value made up from a bitwise-OR of <em>SMB_FILE_ATTRIBUTE_xxx</em> bits (see smb_constants.py).</p></li> | |
| 302 | <li><p><strong>pattern</strong> (<em>string/unicode</em>) – the filter to apply to the results before returning to the client.</p></li> | |
| 303 | <li><p><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds that pysmb will wait before raising <em>SMBTimeout</em> via the returned <em>Deferred</em> instance’s <em>errback</em> method.</p></li> | |
| 304 | </ul> | |
| 305 | </dd> | |
| 306 | <dt class="field-even">Returns</dt> | |
| 307 | <dd class="field-even"><p>A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a list of <a class="reference internal" href="smb_SharedFile.html"><span class="doc">smb.base.SharedFile</span></a> instances.</p> | |
| 308 | </dd> | |
| 309 | </dl> | |
| 310 | </dd></dl> | |
| 311 | ||
| 312 | <dl class="py method"> | |
| 313 | <dt id="smb.SMBProtocol.SMBProtocolFactory.listShares"> | |
| 314 | <code class="sig-name descname">listShares</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.listShares"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.listShares" title="Permalink to this definition">¶</a></dt> | |
| 315 | <dd><p>Retrieve a list of shared resources on remote server.</p> | |
| 316 | <dl class="field-list simple"> | |
| 317 | <dt class="field-odd">Parameters</dt> | |
| 318 | <dd class="field-odd"><p><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds that pysmb will wait before raising <em>SMBTimeout</em> via the returned <em>Deferred</em> instance’s <em>errback</em> method.</p> | |
| 319 | </dd> | |
| 320 | <dt class="field-even">Returns</dt> | |
| 321 | <dd class="field-even"><p>A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a list of <a class="reference internal" href="smb_SharedDevice.html"><span class="doc">smb.base.SharedDevice</span></a> instances.</p> | |
| 322 | </dd> | |
| 323 | </dl> | |
| 324 | </dd></dl> | |
| 325 | ||
| 326 | <dl class="py method"> | |
| 327 | <dt id="smb.SMBProtocol.SMBProtocolFactory.listSnapshots"> | |
| 328 | <code class="sig-name descname">listSnapshots</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.listSnapshots"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.listSnapshots" title="Permalink to this definition">¶</a></dt> | |
| 329 | <dd><p>Retrieve a list of available snapshots (a.k.a. shadow copies) for <em>path</em>.</p> | |
| 330 | <p>Note that snapshot features are only supported on Windows Vista Business, Enterprise and Ultimate, and on all Windows 7 editions.</p> | |
| 331 | <dl class="field-list simple"> | |
| 332 | <dt class="field-odd">Parameters</dt> | |
| 333 | <dd class="field-odd"><ul class="simple"> | |
| 334 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></p></li> | |
| 335 | <li><p><strong>path</strong> (<em>string/unicode</em>) – path relative to the <em>service_name</em> where we are interested in the list of available snapshots</p></li> | |
| 336 | </ul> | |
| 337 | </dd> | |
| 338 | <dt class="field-even">Returns</dt> | |
| 339 | <dd class="field-even"><p>A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a list of python <em>datetime.DateTime</em> | |
| 340 | instances in GMT/UTC time zone</p> | |
| 341 | </dd> | |
| 342 | </dl> | |
| 343 | </dd></dl> | |
| 344 | ||
| 345 | <dl class="py method"> | |
| 346 | <dt id="smb.SMBProtocol.SMBProtocolFactory.onAuthFailed"> | |
| 347 | <code class="sig-name descname">onAuthFailed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.onAuthFailed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.onAuthFailed" title="Permalink to this definition">¶</a></dt> | |
| 348 | <dd><p>Override this method in your <em>SMBProtocolFactory</em> subclass to add in post-authentication handling. | |
| 349 | This method will be called when the server has replied that the SMB connection has been successfully authenticated.</p> | |
| 350 | <dl class="simple"> | |
| 351 | <dt>If you want to retry authenticating from this method,</dt><dd><ol class="arabic simple"> | |
| 352 | <li><p>Disconnect the underlying SMB connection (call <code class="docutils literal notranslate"><span class="pre">self.instance.transport.loseConnection()</span></code>)</p></li> | |
| 353 | <li><p>Create a new SMBProtocolFactory subclass instance with different user credientials or different NTLM algorithm flag.</p></li> | |
| 354 | <li><p>Call <code class="docutils literal notranslate"><span class="pre">reactor.connectTCP</span></code> with the new instance to re-establish the SMB connection</p></li> | |
| 355 | </ol> | |
| 356 | </dd> | |
| 357 | </dl> | |
| 358 | </dd></dl> | |
| 359 | ||
| 360 | <dl class="py method"> | |
| 361 | <dt id="smb.SMBProtocol.SMBProtocolFactory.onAuthOK"> | |
| 362 | <code class="sig-name descname">onAuthOK</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.onAuthOK"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.onAuthOK" title="Permalink to this definition">¶</a></dt> | |
| 363 | <dd><p>Override this method in your <em>SMBProtocolFactory</em> subclass to add in post-authentication handling. | |
| 364 | This method will be called when the server has replied that the SMB connection has been successfully authenticated. | |
| 365 | File operations can proceed when this method has been called.</p> | |
| 366 | </dd></dl> | |
| 367 | ||
| 368 | <dl class="py method"> | |
| 369 | <dt id="smb.SMBProtocol.SMBProtocolFactory.rename"> | |
| 370 | <code class="sig-name descname">rename</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">old_path</span></em>, <em class="sig-param"><span class="n">new_path</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.rename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.rename" title="Permalink to this definition">¶</a></dt> | |
| 371 | <dd><p>Rename a file or folder at <em>old_path</em> to <em>new_path</em> shared at <em>service_name</em>. Note that this method cannot be used to rename file/folder across different shared folders</p> | |
| 372 | <p><em>old_path</em> and <em>new_path</em> are string/unicode referring to the old and new path of the renamed resources (relative to) the shared folder. | |
| 373 | If the path contains non-English characters, an unicode string must be used to pass in the path.</p> | |
| 374 | <dl class="field-list simple"> | |
| 375 | <dt class="field-odd">Parameters</dt> | |
| 376 | <dd class="field-odd"><ul class="simple"> | |
| 377 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</p></li> | |
| 378 | <li><p><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds that pysmb will wait before raising <em>SMBTimeout</em> via the returned <em>Deferred</em> instance’s <em>errback</em> method.</p></li> | |
| 379 | </ul> | |
| 380 | </dd> | |
| 381 | <dt class="field-even">Returns</dt> | |
| 382 | <dd class="field-even"><p>A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a 2-element tuple of ( <em>old_path</em>, <em>new_path</em> ).</p> | |
| 383 | </dd> | |
| 384 | </dl> | |
| 385 | </dd></dl> | |
| 386 | ||
| 387 | <dl class="py method"> | |
| 388 | <dt id="smb.SMBProtocol.SMBProtocolFactory.retrieveFile"> | |
| 389 | <code class="sig-name descname">retrieveFile</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">file_obj</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.retrieveFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.retrieveFile" title="Permalink to this definition">¶</a></dt> | |
| 390 | <dd><p>Retrieve the contents of the file at <em>path</em> on the <em>service_name</em> and write these contents to the provided <em>file_obj</em>.</p> | |
| 391 | <p>Use <em>retrieveFileFromOffset()</em> method if you need to specify the offset to read from the remote <em>path</em> and/or the maximum number of bytes to write to the <em>file_obj</em>.</p> | |
| 392 | <p>The meaning of the <em>timeout</em> parameter will be different from other file operation methods. As the downloaded file usually exceeeds the maximum size | |
| 393 | of each SMB/CIFS data message, it will be packetized into a series of request messages (each message will request about about 60kBytes). | |
| 394 | The <em>timeout</em> 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.</p> | |
| 395 | <dl class="field-list simple"> | |
| 396 | <dt class="field-odd">Parameters</dt> | |
| 397 | <dd class="field-odd"><ul class="simple"> | |
| 398 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></p></li> | |
| 399 | <li><p><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file cannot be opened for reading, an <a class="reference internal" href="smb_exceptions.html"><span class="doc">OperationFailure</span></a> will be called in the returned <em>Deferred</em> errback.</p></li> | |
| 400 | <li><p><strong>file_obj</strong> – A file-like object that has a <em>write</em> method. Data will be written continuously to <em>file_obj</em> until EOF is received from the remote service. In Python3, this file-like object must have a <em>write</em> method which accepts a bytes parameter.</p></li> | |
| 401 | </ul> | |
| 402 | </dd> | |
| 403 | <dt class="field-even">Returns</dt> | |
| 404 | <dd class="field-even"><p>A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a 3-element tuple of ( <em>file_obj</em>, file attributes of the file on server, number of bytes written to <em>file_obj</em> ). | |
| 405 | The file attributes is an integer value made up from a bitwise-OR of <em>SMB_FILE_ATTRIBUTE_xxx</em> bits (see smb_constants.py)</p> | |
| 406 | </dd> | |
| 407 | </dl> | |
| 408 | </dd></dl> | |
| 409 | ||
| 410 | <dl class="py method"> | |
| 411 | <dt id="smb.SMBProtocol.SMBProtocolFactory.retrieveFileFromOffset"> | |
| 412 | <code class="sig-name descname">retrieveFileFromOffset</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">file_obj</span></em>, <em class="sig-param"><span class="n">offset</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">max_length</span><span class="o">=</span><span class="default_value">- 1</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.retrieveFileFromOffset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.retrieveFileFromOffset" title="Permalink to this definition">¶</a></dt> | |
| 413 | <dd><p>Retrieve the contents of the file at <em>path</em> on the <em>service_name</em> and write these contents to the provided <em>file_obj</em>.</p> | |
| 414 | <p>The meaning of the <em>timeout</em> parameter will be different from other file operation methods. As the downloaded file usually exceeeds the maximum size | |
| 415 | of each SMB/CIFS data message, it will be packetized into a series of request messages (each message will request about about 60kBytes). | |
| 416 | The <em>timeout</em> 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.</p> | |
| 417 | <dl class="field-list simple"> | |
| 418 | <dt class="field-odd">Parameters</dt> | |
| 419 | <dd class="field-odd"><ul class="simple"> | |
| 420 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></p></li> | |
| 421 | <li><p><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file cannot be opened for reading, an <a class="reference internal" href="smb_exceptions.html"><span class="doc">OperationFailure</span></a> will be called in the returned <em>Deferred</em> errback.</p></li> | |
| 422 | <li><p><strong>file_obj</strong> – A file-like object that has a <em>write</em> method. Data will be written continuously to <em>file_obj</em> until EOF is received from the remote service. In Python3, this file-like object must have a <em>write</em> method which accepts a bytes parameter.</p></li> | |
| 423 | <li><p><strong>offset</strong> (<em>integer/long</em>) – the offset in the remote <em>path</em> where the first byte will be read and written to <em>file_obj</em>. Must be either zero or a positive integer/long value.</p></li> | |
| 424 | <li><p><strong>max_length</strong> (<em>integer/long</em>) – maximum number of bytes to read from the remote <em>path</em> and write to the <em>file_obj</em>. Specify a negative value to read from <em>offset</em> to the EOF. | |
| 425 | If zero, the <em>Deferred</em> callback is invoked immediately after the file is opened successfully for reading.</p></li> | |
| 426 | </ul> | |
| 427 | </dd> | |
| 428 | <dt class="field-even">Returns</dt> | |
| 429 | <dd class="field-even"><p>A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a 3-element tuple of ( <em>file_obj</em>, file attributes of the file on server, number of bytes written to <em>file_obj</em> ). | |
| 430 | The file attributes is an integer value made up from a bitwise-OR of <em>SMB_FILE_ATTRIBUTE_xxx</em> bits (see smb_constants.py)</p> | |
| 431 | </dd> | |
| 432 | </dl> | |
| 433 | </dd></dl> | |
| 434 | ||
| 435 | <dl class="py method"> | |
| 436 | <dt id="smb.SMBProtocol.SMBProtocolFactory.storeFile"> | |
| 437 | <code class="sig-name descname">storeFile</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_name</span></em>, <em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">file_obj</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">30</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.storeFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.storeFile" title="Permalink to this definition">¶</a></dt> | |
| 438 | <dd><p>Store the contents of the <em>file_obj</em> at <em>path</em> on the <em>service_name</em>.</p> | |
| 439 | <p>The meaning of the <em>timeout</em> parameter will be different from other file operation methods. As the uploaded file usually exceeeds the maximum size | |
| 440 | of each SMB/CIFS data message, it will be packetized into a series of messages (usually about 60kBytes). | |
| 441 | The <em>timeout</em> parameter is an integer/float value that specifies the timeout interval for these individual SMB/CIFS message to be transmitted and acknowledged | |
| 442 | by the remote SMB/CIFS server.</p> | |
| 443 | <dl class="field-list simple"> | |
| 444 | <dt class="field-odd">Parameters</dt> | |
| 445 | <dd class="field-odd"><ul class="simple"> | |
| 446 | <li><p><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></p></li> | |
| 447 | <li><p><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file at <em>path</em> does not exist, it will be created. Otherwise, it will be overwritten. | |
| 448 | If the <em>path</em> refers to a folder or the file cannot be opened for writing, an <a class="reference internal" href="smb_exceptions.html"><span class="doc">OperationFailure</span></a> will be called in the returned <em>Deferred</em> errback.</p></li> | |
| 449 | <li><p><strong>file_obj</strong> – A file-like object that has a <em>read</em> method. Data will read continuously from <em>file_obj</em> until EOF. In Python3, this file-like object must have a <em>read</em> method which returns a bytes parameter.</p></li> | |
| 450 | </ul> | |
| 451 | </dd> | |
| 452 | <dt class="field-even">Returns</dt> | |
| 453 | <dd class="field-even"><p>A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a 2-element tuple of ( <em>file_obj</em>, number of bytes uploaded ).</p> | |
| 454 | </dd> | |
| 455 | </dl> | |
| 456 | </dd></dl> | |
| 457 | ||
| 458 | <dl class="py attribute"> | |
| 459 | <dt id="smb.SMBProtocol.SMBProtocolFactory.SIGN_NEVER"> | |
| 460 | <code class="sig-name descname">SIGN_NEVER</code><em class="property"> = 0</em><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.SIGN_NEVER" title="Permalink to this definition">¶</a></dt> | |
| 461 | <dd><p>SMB messages will never be signed regardless of remote server’s configurations; access errors will occur if the remote server requires signing.</p> | |
| 462 | </dd></dl> | |
| 463 | ||
| 464 | <dl class="py attribute"> | |
| 465 | <dt id="smb.SMBProtocol.SMBProtocolFactory.SIGN_WHEN_REQUIRED"> | |
| 466 | <code class="sig-name descname">SIGN_WHEN_REQUIRED</code><em class="property"> = 2</em><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.SIGN_WHEN_REQUIRED" title="Permalink to this definition">¶</a></dt> | |
| 467 | <dd><p>SMB messages will only be signed when remote server requires signing.</p> | |
| 468 | </dd></dl> | |
| 469 | ||
| 470 | <dl class="py attribute"> | |
| 471 | <dt id="smb.SMBProtocol.SMBProtocolFactory.SIGN_WHEN_SUPPORTED"> | |
| 472 | <code class="sig-name descname">SIGN_WHEN_SUPPORTED</code><em class="property"> = 1</em><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.SIGN_WHEN_SUPPORTED" title="Permalink to this definition">¶</a></dt> | |
| 473 | <dd><p>SMB messages will be signed when remote server supports signing but not requires signing.</p> | |
| 474 | </dd></dl> | |
| 475 | ||
| 476 | <dl class="py attribute"> | |
| 477 | <dt id="smb.SMBProtocol.SMBProtocolFactory.instance"> | |
| 478 | <code class="sig-name descname">instance</code><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.instance" title="Permalink to this definition">¶</a></dt> | |
| 479 | <dd><p>The single SMBProtocol instance for each SMBProtocolFactory instance. Usually, you should not need to touch this attribute directly.</p> | |
| 480 | </dd></dl> | |
| 481 | ||
| 482 | <dl class="py method"> | |
| 483 | <dt id="smb.SMBProtocol.SMBProtocolFactory.isReady"> | |
| 484 | <em class="property">property </em><code class="sig-name descname">isReady</code><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.isReady" title="Permalink to this definition">¶</a></dt> | |
| 485 | <dd><p>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.</p> | |
| 486 | </dd></dl> | |
| 487 | ||
| 488 | <dl class="py method"> | |
| 489 | <dt id="smb.SMBProtocol.SMBProtocolFactory.isUsingSMB2"> | |
| 490 | <em class="property">property </em><code class="sig-name descname">isUsingSMB2</code><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.isUsingSMB2" title="Permalink to this definition">¶</a></dt> | |
| 491 | <dd><p>A convenient property to return True if the underlying SMB connection is using SMB2 protocol.</p> | |
| 492 | </dd></dl> | |
| 493 | ||
| 494 | </dd></dl> | |
| 495 | ||
| 496 | </div> | |
| 497 | </div> | |
| 498 | ||
| 499 | ||
| 500 | <div class="clearer"></div> | |
| 501 | </div> | |
| 502 | </div> | |
| 503 | </div> | |
| 45 | 504 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
| 46 | 505 | <div class="sphinxsidebarwrapper"> |
| 47 | <h3><a href="../index.html">Table Of Contents</a></h3> | |
| 506 | <h3><a href="../index.html">Table of Contents</a></h3> | |
| 48 | 507 | <ul> |
| 49 | 508 | <li><a class="reference internal" href="#">SMBProtocolFactory Class</a><ul> |
| 50 | 509 | <li><a class="reference internal" href="#example">Example</a></li> |
| 63 | 522 | <div role="note" aria-label="source link"> |
| 64 | 523 | <h3>This Page</h3> |
| 65 | 524 | <ul class="this-page-menu"> |
| 66 | <li><a href="../_sources/api/smb_SMBProtocolFactory.txt" | |
| 525 | <li><a href="../_sources/api/smb_SMBProtocolFactory.rst.txt" | |
| 67 | 526 | rel="nofollow">Show Source</a></li> |
| 68 | 527 | </ul> |
| 69 | 528 | </div> |
| 70 | 529 | <div id="searchbox" style="display: none" role="search"> |
| 71 | <h3>Quick search</h3> | |
| 530 | <h3 id="searchlabel">Quick search</h3> | |
| 531 | <div class="searchformwrapper"> | |
| 72 | 532 | <form class="search" action="../search.html" method="get"> |
| 73 | <input type="text" name="q" /> | |
| 533 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 74 | 534 | <input type="submit" value="Go" /> |
| 75 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 76 | <input type="hidden" name="area" value="default" /> | |
| 77 | 535 | </form> |
| 78 | <p class="searchtip" style="font-size: 90%"> | |
| 79 | Enter search terms or a module, class or function name. | |
| 80 | </p> | |
| 81 | </div> | |
| 82 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 83 | </div> | |
| 84 | </div> | |
| 85 | ||
| 86 | <div class="document"> | |
| 87 | <div class="documentwrapper"> | |
| 88 | <div class="bodywrapper"> | |
| 89 | <div class="body" role="main"> | |
| 90 | ||
| 91 | <div class="section" id="smbprotocolfactory-class"> | |
| 92 | <h1>SMBProtocolFactory Class<a class="headerlink" href="#smbprotocolfactory-class" title="Permalink to this headline">¶</a></h1> | |
| 93 | <p>For those who want to utilize pysmb in Twisted framework, pysmb has a <em>smb.SMBProtocol.SMBProtocol</em> implementation. | |
| 94 | In most cases, you do not need to touch or import the <em>SMBProtocol</em> directly. All the SMB functionalities are exposed in the <em>SMBProtocolFactory</em>.</p> | |
| 95 | <dl class="docutils"> | |
| 96 | <dt>In your project,</dt> | |
| 97 | <dd><ol class="first last arabic simple"> | |
| 98 | <li>Create a new class and subclass <em>SMBProtocolFactory</em>.</li> | |
| 99 | <li>Override the <em>SMBProtocolFactory.onAuthOK</em> and <em>SMBProtocolFactory.onAuthFailed</em> instance methods to provide your own post-authenthentication handling. | |
| 100 | Once <em>SMBProtocolFactory.onAuthOK</em> has been called by pymsb internals, your application is ready to communicate with the remote SMB/CIFS service through | |
| 101 | the <em>SMBProtocolFactory</em> public methods such as <em>SMBProtocolFactory.storeFile</em>, <em>SMBProtocolFactory.retrieveFile</em>, etc.</li> | |
| 102 | <li>When you want to disconnect from the remote SMB/CIFS server, just call <em>SMBProtocolFactory.closeConnection</em> method.</li> | |
| 103 | </ol> | |
| 104 | </dd> | |
| 105 | </dl> | |
| 106 | <p>All the <em>SMBProtocolFactory</em> public methods that provide file functionlities will return a <em>twisted.internet.defer.Deferred</em> instance. | |
| 107 | A <a class="reference internal" href="smb_exceptions.html"><em>NotReadyError</em></a> exception is raised when the underlying SMB is not authenticated. | |
| 108 | If the underlying SMB connection has been terminated, a <a class="reference internal" href="smb_exceptions.html"><em>NotConnectedError</em></a> exception is raised.</p> | |
| 109 | <p>All the file operation methods in <em>SMBProtocolFactory</em> class accept a <em>timeout</em> parameter. This parameter specifies the time limit where pysmb will wait for the | |
| 110 | entire file operation (except <em>storeFile</em> and <em>retrieveFile</em> methods) to complete. If the file operation fails to complete within the timeout period, the returned | |
| 111 | <em>Deferred</em> instance’s <em>errback</em> method will be called with a <em>SMBTimeout</em> exception.</p> | |
| 112 | <p>If you are interested in learning the results of the operation or to know when the operation has completed, you should | |
| 113 | add a handling method to the returned <em>Deferred</em> instance via <em>Deferred.addCallback</em>. If the file operation fails, the <em>Deferred.errback</em> function will be called | |
| 114 | with an <a class="reference internal" href="smb_exceptions.html"><em>OperationFailure</em></a>; on timeout, it will be called with a <a class="reference internal" href="smb_exceptions.html"><em>SMBTimeout</em></a>.</p> | |
| 115 | <div class="section" id="example"> | |
| 116 | <h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2> | |
| 117 | <p>The following illustrates a simple file retrieving implementation.:</p> | |
| 118 | <div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">tempfile</span> | |
| 119 | <span class="kn">from</span> <span class="nn">twisted.internet</span> <span class="kn">import</span> <span class="n">reactor</span> | |
| 120 | <span class="kn">from</span> <span class="nn">smb.SMBProtocol</span> <span class="kn">import</span> <span class="n">SMBProtocolFactory</span> | |
| 121 | ||
| 122 | <span class="k">class</span> <span class="nc">RetrieveFileFactory</span><span class="p">(</span><span class="n">SMBProtocolFactory</span><span class="p">):</span> | |
| 123 | ||
| 124 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | |
| 125 | <span class="n">SMBProtocolFactory</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> | |
| 126 | ||
| 127 | <span class="k">def</span> <span class="nf">fileRetrieved</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">write_result</span><span class="p">):</span> | |
| 128 | <span class="n">file_obj</span><span class="p">,</span> <span class="n">file_attributes</span><span class="p">,</span> <span class="n">file_size</span> <span class="o">=</span> <span class="n">write_result</span> | |
| 129 | ||
| 130 | <span class="c1"># Retrieved file contents are inside file_obj</span> | |
| 131 | <span class="c1"># Do what you need with the file_obj and then close it</span> | |
| 132 | <span class="c1"># Note that the file obj is positioned at the end-of-file,</span> | |
| 133 | <span class="c1"># so you might need to perform a file_obj.seek() to if you</span> | |
| 134 | <span class="c1"># need to read from the beginning</span> | |
| 135 | <span class="n">file_obj</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> | |
| 136 | ||
| 137 | <span class="bp">self</span><span class="o">.</span><span class="n">transport</span><span class="o">.</span><span class="n">loseConnection</span><span class="p">()</span> | |
| 138 | ||
| 139 | <span class="k">def</span> <span class="nf">onAuthOK</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 140 | <span class="n">d</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">retrieveFile</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">NamedTemporaryFile</span><span class="p">())</span> | |
| 141 | <span class="n">d</span><span class="o">.</span><span class="n">addCallback</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fileRetrieved</span><span class="p">)</span> | |
| 142 | <span class="n">d</span><span class="o">.</span><span class="n">addErrback</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">d</span><span class="o">.</span><span class="n">errback</span><span class="p">)</span> | |
| 143 | ||
| 144 | <span class="k">def</span> <span class="nf">onAuthFailed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | |
| 145 | <span class="k">print</span> <span class="s1">'Auth failed'</span> | |
| 146 | ||
| 147 | <span class="c1"># There will be some mechanism to capture userID, password, client_machine_name, server_name and server_ip</span> | |
| 148 | <span class="c1"># client_machine_name can be an arbitary ASCII string</span> | |
| 149 | <span class="c1"># server_name should match the remote machine name, or else the connection will be rejected</span> | |
| 150 | <span class="n">factory</span> <span class="o">=</span> <span class="n">RetrieveFileFactory</span><span class="p">(</span><span class="n">userID</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">client_machine_name</span><span class="p">,</span> <span class="n">server_name</span><span class="p">,</span> <span class="n">use_ntlm_v2</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span> | |
| 151 | <span class="n">factory</span><span class="o">.</span><span class="n">service</span> <span class="o">=</span> <span class="s1">'smbtest'</span> | |
| 152 | <span class="n">factory</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="s1">'/rfc1001.txt'</span> | |
| 153 | <span class="n">reactor</span><span class="o">.</span><span class="n">connectTCP</span><span class="p">(</span><span class="n">server_ip</span><span class="p">,</span> <span class="mi">139</span><span class="p">,</span> <span class="n">factory</span><span class="p">)</span> | |
| 154 | </pre></div> | |
| 155 | </div> | |
| 156 | </div> | |
| 157 | <div class="section" id="smb2-support"> | |
| 158 | <h2>SMB2 Support<a class="headerlink" href="#smb2-support" title="Permalink to this headline">¶</a></h2> | |
| 159 | <p>Starting from pysmb 1.1.0, pysmb will utilize SMB2 protocol for communication if the remote SMB/CIFS service supports SMB2. | |
| 160 | Otherwise, it will fallback automatically back to using SMB1 protocol.</p> | |
| 161 | <p>To disable SMB2 protocol in pysmb, set the <em>SUPPORT_SMB2</em> flag in the <em>smb_structs</em> module to <em>False</em> before creating the <em>SMBProtocolFactory</em> instance.:</p> | |
| 162 | <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">smb</span> <span class="kn">import</span> <span class="n">smb_structs</span> | |
| 163 | <span class="n">smb_structs</span><span class="o">.</span><span class="n">SUPPORT_SMB2</span> <span class="o">=</span> <span class="bp">False</span> | |
| 164 | </pre></div> | |
| 165 | </div> | |
| 166 | </div> | |
| 167 | <div class="section" id="caveats"> | |
| 168 | <h2>Caveats<a class="headerlink" href="#caveats" title="Permalink to this headline">¶</a></h2> | |
| 169 | <ul class="simple"> | |
| 170 | <li>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.</li> | |
| 171 | <li>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 <em>storeFile</em> or <em>retrieveFile</em> in batches.</li> | |
| 172 | <li>The <em>timeout</em> 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 | |
| 173 | <em>SMBTimeout</em> exception after 1.5 sec.</li> | |
| 174 | </ul> | |
| 175 | <dl class="class"> | |
| 176 | <dt id="smb.SMBProtocol.SMBProtocolFactory"> | |
| 177 | <em class="property">class </em><code class="descclassname">smb.SMBProtocol.</code><code class="descname">SMBProtocolFactory</code><span class="sig-paren">(</span><em>username</em>, <em>password</em>, <em>my_name</em>, <em>remote_name</em>, <em>domain=''</em>, <em>use_ntlm_v2=True</em>, <em>sign_options=2</em>, <em>is_direct_tcp=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory" title="Permalink to this definition">¶</a></dt> | |
| 178 | <dd><dl class="method"> | |
| 179 | <dt id="smb.SMBProtocol.SMBProtocolFactory.__init__"> | |
| 180 | <code class="descname">__init__</code><span class="sig-paren">(</span><em>username</em>, <em>password</em>, <em>my_name</em>, <em>remote_name</em>, <em>domain=''</em>, <em>use_ntlm_v2=True</em>, <em>sign_options=2</em>, <em>is_direct_tcp=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.__init__" title="Permalink to this definition">¶</a></dt> | |
| 181 | <dd><p>Create a new SMBProtocolFactory instance. You will pass this instance to <em>reactor.connectTCP()</em> which will then instantiate the TCP connection to the remote SMB/CIFS server. | |
| 182 | Note that the default TCP port for most SMB/CIFS servers using NetBIOS over TCP/IP is 139. | |
| 183 | Some newer server installations might also support Direct hosting of SMB over TCP/IP; for these servers, the default TCP port is 445.</p> | |
| 184 | <p><em>username</em> and <em>password</em> are the user credentials required to authenticate the underlying SMB connection with the remote server. | |
| 185 | File operations can only be proceeded after the connection has been authenticated successfully.</p> | |
| 186 | <table class="docutils field-list" frame="void" rules="none"> | |
| 187 | <col class="field-name" /> | |
| 188 | <col class="field-body" /> | |
| 189 | <tbody valign="top"> | |
| 190 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | |
| 191 | <li><strong>my_name</strong> (<em>string</em>) – The local NetBIOS machine name that will identify where this connection is originating from. | |
| 192 | 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 <code class="docutils literal"><span class="pre">\/:*?";|+</span></code>.</li> | |
| 193 | <li><strong>remote_name</strong> (<em>string</em>) – The NetBIOS machine name of the remote server. | |
| 194 | On windows, you can find out the machine name by right-clicking on the “My Computer” and selecting “Properties”. | |
| 195 | This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected.</li> | |
| 196 | <li><strong>domain</strong> (<em>string</em>) – The network domain. On windows, it is known as the workgroup. Usually, it is safe to leave this parameter as an empty string.</li> | |
| 197 | <li><strong>use_ntlm_v2</strong> (<em>boolean</em>) – Indicates whether pysmb should be NTLMv1 or NTLMv2 authentication algorithm for authentication. | |
| 198 | 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. | |
| 199 | Hence, we can only “guess” or try both algorithms. | |
| 200 | On Sambda, Windows Vista and Windows 7, NTLMv2 is enabled by default. On Windows XP, we can use NTLMv1 before NTLMv2.</li> | |
| 201 | <li><strong>sign_options</strong> (<em>int</em>) – Determines whether SMB messages will be signed. Default is <em>SIGN_WHEN_REQUIRED</em>. | |
| 202 | If <em>SIGN_WHEN_REQUIRED</em> (value=2), SMB messages will only be signed when remote server requires signing. | |
| 203 | If <em>SIGN_WHEN_SUPPORTED</em> (value=1), SMB messages will be signed when remote server supports signing but not requires signing. | |
| 204 | If <em>SIGN_NEVER</em> (value=0), SMB messages will never be signed regardless of remote server’s configurations; access errors will occur if the remote server requires signing.</li> | |
| 205 | <li><strong>is_direct_tcp</strong> (<em>boolean</em>) – 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. | |
| 206 | The default parameter is False which will use NetBIOS over TCP/IP for wider compatibility (TCP port: 139).</li> | |
| 207 | </ul> | |
| 208 | </td> | |
| 209 | </tr> | |
| 210 | </tbody> | |
| 211 | </table> | |
| 212 | </dd></dl> | |
| 213 | ||
| 214 | <dl class="method"> | |
| 215 | <dt id="smb.SMBProtocol.SMBProtocolFactory.closeConnection"> | |
| 216 | <code class="descname">closeConnection</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.closeConnection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.closeConnection" title="Permalink to this definition">¶</a></dt> | |
| 217 | <dd><p>Disconnect from the remote SMB/CIFS server. The TCP connection will be closed at the earliest opportunity after this method returns.</p> | |
| 218 | <table class="docutils field-list" frame="void" rules="none"> | |
| 219 | <col class="field-name" /> | |
| 220 | <col class="field-body" /> | |
| 221 | <tbody valign="top"> | |
| 222 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td> | |
| 223 | </tr> | |
| 224 | </tbody> | |
| 225 | </table> | |
| 226 | </dd></dl> | |
| 227 | ||
| 228 | <dl class="method"> | |
| 229 | <dt id="smb.SMBProtocol.SMBProtocolFactory.createDirectory"> | |
| 230 | <code class="descname">createDirectory</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.createDirectory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.createDirectory" title="Permalink to this definition">¶</a></dt> | |
| 231 | <dd><p>Creates a new directory <em>path</em> on the <em>service_name</em>.</p> | |
| 232 | <table class="docutils field-list" frame="void" rules="none"> | |
| 233 | <col class="field-name" /> | |
| 234 | <col class="field-body" /> | |
| 235 | <tbody valign="top"> | |
| 236 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 237 | <li><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</li> | |
| 238 | <li><strong>path</strong> (<em>string/unicode</em>) – The path of the new folder (relative to) the shared folder. | |
| 239 | If the path contains non-English characters, an unicode string must be used to pass in the path.</li> | |
| 240 | <li><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds that pysmb will wait before raising <em>SMBTimeout</em> via the returned <em>Deferred</em> instance’s <em>errback</em> method.</li> | |
| 241 | </ul> | |
| 242 | </td> | |
| 243 | </tr> | |
| 244 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with the <em>path</em> parameter.</p> | |
| 245 | </td> | |
| 246 | </tr> | |
| 247 | </tbody> | |
| 248 | </table> | |
| 249 | </dd></dl> | |
| 250 | ||
| 251 | <dl class="method"> | |
| 252 | <dt id="smb.SMBProtocol.SMBProtocolFactory.deleteDirectory"> | |
| 253 | <code class="descname">deleteDirectory</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.deleteDirectory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.deleteDirectory" title="Permalink to this definition">¶</a></dt> | |
| 254 | <dd><p>Delete the empty folder at <em>path</em> on <em>service_name</em></p> | |
| 255 | <table class="docutils field-list" frame="void" rules="none"> | |
| 256 | <col class="field-name" /> | |
| 257 | <col class="field-body" /> | |
| 258 | <tbody valign="top"> | |
| 259 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 260 | <li><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</li> | |
| 261 | <li><strong>path</strong> (<em>string/unicode</em>) – The path of the to-be-deleted folder (relative to) the shared folder. | |
| 262 | If the path contains non-English characters, an unicode string must be used to pass in the path.</li> | |
| 263 | <li><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds that pysmb will wait before raising <em>SMBTimeout</em> via the returned <em>Deferred</em> instance’s <em>errback</em> method.</li> | |
| 264 | </ul> | |
| 265 | </td> | |
| 266 | </tr> | |
| 267 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with the <em>path</em> parameter.</p> | |
| 268 | </td> | |
| 269 | </tr> | |
| 270 | </tbody> | |
| 271 | </table> | |
| 272 | </dd></dl> | |
| 273 | ||
| 274 | <dl class="method"> | |
| 275 | <dt id="smb.SMBProtocol.SMBProtocolFactory.deleteFiles"> | |
| 276 | <code class="descname">deleteFiles</code><span class="sig-paren">(</span><em>service_name</em>, <em>path_file_pattern</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.deleteFiles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.deleteFiles" title="Permalink to this definition">¶</a></dt> | |
| 277 | <dd><p>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.</p> | |
| 278 | <table class="docutils field-list" frame="void" rules="none"> | |
| 279 | <col class="field-name" /> | |
| 280 | <col class="field-body" /> | |
| 281 | <tbody valign="top"> | |
| 282 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 283 | <li><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</li> | |
| 284 | <li><strong>path_file_pattern</strong> (<em>string/unicode</em>) – The pathname of the file(s) to be deleted, relative to the service_name. | |
| 285 | Wildcards may be used in th filename component of the path. | |
| 286 | If your path/filename contains non-English characters, you must pass in an unicode string.</li> | |
| 287 | <li><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds that pysmb will wait before raising <em>SMBTimeout</em> via the returned <em>Deferred</em> instance’s <em>errback</em> method.</li> | |
| 288 | </ul> | |
| 289 | </td> | |
| 290 | </tr> | |
| 291 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with the <em>path_file_pattern</em> parameter.</p> | |
| 292 | </td> | |
| 293 | </tr> | |
| 294 | </tbody> | |
| 295 | </table> | |
| 296 | </dd></dl> | |
| 297 | ||
| 298 | <dl class="method"> | |
| 299 | <dt id="smb.SMBProtocol.SMBProtocolFactory.echo"> | |
| 300 | <code class="descname">echo</code><span class="sig-paren">(</span><em>data</em>, <em>timeout=10</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.echo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.echo" title="Permalink to this definition">¶</a></dt> | |
| 301 | <dd><p>Send an echo command containing <em>data</em> to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same <em>data</em>.</p> | |
| 302 | <table class="docutils field-list" frame="void" rules="none"> | |
| 303 | <col class="field-name" /> | |
| 304 | <col class="field-body" /> | |
| 305 | <tbody valign="top"> | |
| 306 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 307 | <li><strong>data</strong> (<em>string</em>) – Data to send to the remote server.</li> | |
| 308 | <li><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds that pysmb will wait before raising <em>SMBTimeout</em> via the returned <em>Deferred</em> instance’s <em>errback</em> method.</li> | |
| 309 | </ul> | |
| 310 | </td> | |
| 311 | </tr> | |
| 312 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with the <em>data</em> parameter.</p> | |
| 313 | </td> | |
| 314 | </tr> | |
| 315 | </tbody> | |
| 316 | </table> | |
| 317 | </dd></dl> | |
| 318 | ||
| 319 | <dl class="method"> | |
| 320 | <dt id="smb.SMBProtocol.SMBProtocolFactory.getAttributes"> | |
| 321 | <code class="descname">getAttributes</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.getAttributes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.getAttributes" title="Permalink to this definition">¶</a></dt> | |
| 322 | <dd><p>Retrieve information about the file at <em>path</em> on the <em>service_name</em>.</p> | |
| 323 | <table class="docutils field-list" frame="void" rules="none"> | |
| 324 | <col class="field-name" /> | |
| 325 | <col class="field-body" /> | |
| 326 | <tbody valign="top"> | |
| 327 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 328 | <li><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></li> | |
| 329 | <li><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file cannot be opened for reading, an <a class="reference internal" href="smb_exceptions.html"><em>OperationFailure</em></a> will be raised.</li> | |
| 330 | </ul> | |
| 331 | </td> | |
| 332 | </tr> | |
| 333 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a <a class="reference internal" href="smb_SharedFile.html"><em>smb.base.SharedFile</em></a> instance containing the attributes of the file.</p> | |
| 334 | </td> | |
| 335 | </tr> | |
| 336 | </tbody> | |
| 337 | </table> | |
| 338 | </dd></dl> | |
| 339 | ||
| 340 | <dl class="method"> | |
| 341 | <dt id="smb.SMBProtocol.SMBProtocolFactory.listPath"> | |
| 342 | <code class="descname">listPath</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>search=55</em>, <em>pattern='*'</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.listPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.listPath" title="Permalink to this definition">¶</a></dt> | |
| 343 | <dd><p>Retrieve a directory listing of files/folders at <em>path</em></p> | |
| 344 | <table class="docutils field-list" frame="void" rules="none"> | |
| 345 | <col class="field-name" /> | |
| 346 | <col class="field-body" /> | |
| 347 | <tbody valign="top"> | |
| 348 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 349 | <li><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></li> | |
| 350 | <li><strong>path</strong> (<em>string/unicode</em>) – path relative to the <em>service_name</em> where we are interested to learn about its files/sub-folders.</li> | |
| 351 | <li><strong>search</strong> (<em>integer</em>) – integer value made up from a bitwise-OR of <em>SMB_FILE_ATTRIBUTE_xxx</em> bits (see smb_constants.py). | |
| 352 | The default <em>search</em> value will query for all read-only, hidden, system, archive files and directories.</li> | |
| 353 | <li><strong>pattern</strong> (<em>string/unicode</em>) – the filter to apply to the results before returning to the client.</li> | |
| 354 | <li><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds that pysmb will wait before raising <em>SMBTimeout</em> via the returned <em>Deferred</em> instance’s <em>errback</em> method.</li> | |
| 355 | </ul> | |
| 356 | </td> | |
| 357 | </tr> | |
| 358 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a list of <a class="reference internal" href="smb_SharedFile.html"><em>smb.base.SharedFile</em></a> instances.</p> | |
| 359 | </td> | |
| 360 | </tr> | |
| 361 | </tbody> | |
| 362 | </table> | |
| 363 | </dd></dl> | |
| 364 | ||
| 365 | <dl class="method"> | |
| 366 | <dt id="smb.SMBProtocol.SMBProtocolFactory.listShares"> | |
| 367 | <code class="descname">listShares</code><span class="sig-paren">(</span><em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.listShares"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.listShares" title="Permalink to this definition">¶</a></dt> | |
| 368 | <dd><p>Retrieve a list of shared resources on remote server.</p> | |
| 369 | <table class="docutils field-list" frame="void" rules="none"> | |
| 370 | <col class="field-name" /> | |
| 371 | <col class="field-body" /> | |
| 372 | <tbody valign="top"> | |
| 373 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds that pysmb will wait before raising <em>SMBTimeout</em> via the returned <em>Deferred</em> instance’s <em>errback</em> method.</td> | |
| 374 | </tr> | |
| 375 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a list of <a class="reference internal" href="smb_SharedDevice.html"><em>smb.base.SharedDevice</em></a> instances.</td> | |
| 376 | </tr> | |
| 377 | </tbody> | |
| 378 | </table> | |
| 379 | </dd></dl> | |
| 380 | ||
| 381 | <dl class="method"> | |
| 382 | <dt id="smb.SMBProtocol.SMBProtocolFactory.listSnapshots"> | |
| 383 | <code class="descname">listSnapshots</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.listSnapshots"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.listSnapshots" title="Permalink to this definition">¶</a></dt> | |
| 384 | <dd><p>Retrieve a list of available snapshots (a.k.a. shadow copies) for <em>path</em>.</p> | |
| 385 | <p>Note that snapshot features are only supported on Windows Vista Business, Enterprise and Ultimate, and on all Windows 7 editions.</p> | |
| 386 | <table class="docutils field-list" frame="void" rules="none"> | |
| 387 | <col class="field-name" /> | |
| 388 | <col class="field-body" /> | |
| 389 | <tbody valign="top"> | |
| 390 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 391 | <li><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></li> | |
| 392 | <li><strong>path</strong> (<em>string/unicode</em>) – path relative to the <em>service_name</em> where we are interested in the list of available snapshots</li> | |
| 393 | </ul> | |
| 394 | </td> | |
| 395 | </tr> | |
| 396 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a list of python <em>datetime.DateTime</em> | |
| 397 | instances in GMT/UTC time zone</p> | |
| 398 | </td> | |
| 399 | </tr> | |
| 400 | </tbody> | |
| 401 | </table> | |
| 402 | </dd></dl> | |
| 403 | ||
| 404 | <dl class="method"> | |
| 405 | <dt id="smb.SMBProtocol.SMBProtocolFactory.onAuthFailed"> | |
| 406 | <code class="descname">onAuthFailed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.onAuthFailed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.onAuthFailed" title="Permalink to this definition">¶</a></dt> | |
| 407 | <dd><p>Override this method in your <em>SMBProtocolFactory</em> subclass to add in post-authentication handling. | |
| 408 | This method will be called when the server has replied that the SMB connection has been successfully authenticated.</p> | |
| 409 | <dl class="docutils"> | |
| 410 | <dt>If you want to retry authenticating from this method,</dt> | |
| 411 | <dd><ol class="first last arabic simple"> | |
| 412 | <li>Disconnect the underlying SMB connection (call <code class="docutils literal"><span class="pre">self.instance.transport.loseConnection()</span></code>)</li> | |
| 413 | <li>Create a new SMBProtocolFactory subclass instance with different user credientials or different NTLM algorithm flag.</li> | |
| 414 | <li>Call <code class="docutils literal"><span class="pre">reactor.connectTCP</span></code> with the new instance to re-establish the SMB connection</li> | |
| 415 | </ol> | |
| 416 | </dd> | |
| 417 | </dl> | |
| 418 | </dd></dl> | |
| 419 | ||
| 420 | <dl class="method"> | |
| 421 | <dt id="smb.SMBProtocol.SMBProtocolFactory.onAuthOK"> | |
| 422 | <code class="descname">onAuthOK</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.onAuthOK"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.onAuthOK" title="Permalink to this definition">¶</a></dt> | |
| 423 | <dd><p>Override this method in your <em>SMBProtocolFactory</em> subclass to add in post-authentication handling. | |
| 424 | This method will be called when the server has replied that the SMB connection has been successfully authenticated. | |
| 425 | File operations can proceed when this method has been called.</p> | |
| 426 | </dd></dl> | |
| 427 | ||
| 428 | <dl class="method"> | |
| 429 | <dt id="smb.SMBProtocol.SMBProtocolFactory.rename"> | |
| 430 | <code class="descname">rename</code><span class="sig-paren">(</span><em>service_name</em>, <em>old_path</em>, <em>new_path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.rename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.rename" title="Permalink to this definition">¶</a></dt> | |
| 431 | <dd><p>Rename a file or folder at <em>old_path</em> to <em>new_path</em> shared at <em>service_name</em>. Note that this method cannot be used to rename file/folder across different shared folders</p> | |
| 432 | <p><em>old_path</em> and <em>new_path</em> are string/unicode referring to the old and new path of the renamed resources (relative to) the shared folder. | |
| 433 | If the path contains non-English characters, an unicode string must be used to pass in the path.</p> | |
| 434 | <table class="docutils field-list" frame="void" rules="none"> | |
| 435 | <col class="field-name" /> | |
| 436 | <col class="field-body" /> | |
| 437 | <tbody valign="top"> | |
| 438 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 439 | <li><strong>service_name</strong> (<em>string/unicode</em>) – Contains the name of the shared folder.</li> | |
| 440 | <li><strong>timeout</strong> (<em>integer/float</em>) – Number of seconds that pysmb will wait before raising <em>SMBTimeout</em> via the returned <em>Deferred</em> instance’s <em>errback</em> method.</li> | |
| 441 | </ul> | |
| 442 | </td> | |
| 443 | </tr> | |
| 444 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a 2-element tuple of ( <em>old_path</em>, <em>new_path</em> ).</p> | |
| 445 | </td> | |
| 446 | </tr> | |
| 447 | </tbody> | |
| 448 | </table> | |
| 449 | </dd></dl> | |
| 450 | ||
| 451 | <dl class="method"> | |
| 452 | <dt id="smb.SMBProtocol.SMBProtocolFactory.retrieveFile"> | |
| 453 | <code class="descname">retrieveFile</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>file_obj</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.retrieveFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.retrieveFile" title="Permalink to this definition">¶</a></dt> | |
| 454 | <dd><p>Retrieve the contents of the file at <em>path</em> on the <em>service_name</em> and write these contents to the provided <em>file_obj</em>.</p> | |
| 455 | <p>Use <em>retrieveFileFromOffset()</em> method if you need to specify the offset to read from the remote <em>path</em> and/or the maximum number of bytes to write to the <em>file_obj</em>.</p> | |
| 456 | <p>The meaning of the <em>timeout</em> parameter will be different from other file operation methods. As the downloaded file usually exceeeds the maximum size | |
| 457 | of each SMB/CIFS data message, it will be packetized into a series of request messages (each message will request about about 60kBytes). | |
| 458 | The <em>timeout</em> 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.</p> | |
| 459 | <table class="docutils field-list" frame="void" rules="none"> | |
| 460 | <col class="field-name" /> | |
| 461 | <col class="field-body" /> | |
| 462 | <tbody valign="top"> | |
| 463 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 464 | <li><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></li> | |
| 465 | <li><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file cannot be opened for reading, an <a class="reference internal" href="smb_exceptions.html"><em>OperationFailure</em></a> will be called in the returned <em>Deferred</em> errback.</li> | |
| 466 | <li><strong>file_obj</strong> – A file-like object that has a <em>write</em> method. Data will be written continuously to <em>file_obj</em> until EOF is received from the remote service.</li> | |
| 467 | </ul> | |
| 468 | </td> | |
| 469 | </tr> | |
| 470 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a 3-element tuple of ( <em>file_obj</em>, file attributes of the file on server, number of bytes written to <em>file_obj</em> ). | |
| 471 | The file attributes is an integer value made up from a bitwise-OR of <em>SMB_FILE_ATTRIBUTE_xxx</em> bits (see smb_constants.py)</p> | |
| 472 | </td> | |
| 473 | </tr> | |
| 474 | </tbody> | |
| 475 | </table> | |
| 476 | </dd></dl> | |
| 477 | ||
| 478 | <dl class="method"> | |
| 479 | <dt id="smb.SMBProtocol.SMBProtocolFactory.retrieveFileFromOffset"> | |
| 480 | <code class="descname">retrieveFileFromOffset</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>file_obj</em>, <em>offset=0L</em>, <em>max_length=-1L</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.retrieveFileFromOffset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.retrieveFileFromOffset" title="Permalink to this definition">¶</a></dt> | |
| 481 | <dd><p>Retrieve the contents of the file at <em>path</em> on the <em>service_name</em> and write these contents to the provided <em>file_obj</em>.</p> | |
| 482 | <p>The meaning of the <em>timeout</em> parameter will be different from other file operation methods. As the downloaded file usually exceeeds the maximum size | |
| 483 | of each SMB/CIFS data message, it will be packetized into a series of request messages (each message will request about about 60kBytes). | |
| 484 | The <em>timeout</em> 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.</p> | |
| 485 | <table class="docutils field-list" frame="void" rules="none"> | |
| 486 | <col class="field-name" /> | |
| 487 | <col class="field-body" /> | |
| 488 | <tbody valign="top"> | |
| 489 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 490 | <li><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></li> | |
| 491 | <li><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file cannot be opened for reading, an <a class="reference internal" href="smb_exceptions.html"><em>OperationFailure</em></a> will be called in the returned <em>Deferred</em> errback.</li> | |
| 492 | <li><strong>file_obj</strong> – A file-like object that has a <em>write</em> method. Data will be written continuously to <em>file_obj</em> until EOF is received from the remote service.</li> | |
| 493 | <li><strong>offset</strong> (<em>integer/long</em>) – the offset in the remote <em>path</em> where the first byte will be read and written to <em>file_obj</em>. Must be either zero or a positive integer/long value.</li> | |
| 494 | <li><strong>max_length</strong> (<em>integer/long</em>) – maximum number of bytes to read from the remote <em>path</em> and write to the <em>file_obj</em>. Specify a negative value to read from <em>offset</em> to the EOF. | |
| 495 | If zero, the <em>Deferred</em> callback is invoked immediately after the file is opened successfully for reading.</li> | |
| 496 | </ul> | |
| 497 | </td> | |
| 498 | </tr> | |
| 499 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a 3-element tuple of ( <em>file_obj</em>, file attributes of the file on server, number of bytes written to <em>file_obj</em> ). | |
| 500 | The file attributes is an integer value made up from a bitwise-OR of <em>SMB_FILE_ATTRIBUTE_xxx</em> bits (see smb_constants.py)</p> | |
| 501 | </td> | |
| 502 | </tr> | |
| 503 | </tbody> | |
| 504 | </table> | |
| 505 | </dd></dl> | |
| 506 | ||
| 507 | <dl class="method"> | |
| 508 | <dt id="smb.SMBProtocol.SMBProtocolFactory.storeFile"> | |
| 509 | <code class="descname">storeFile</code><span class="sig-paren">(</span><em>service_name</em>, <em>path</em>, <em>file_obj</em>, <em>timeout=30</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/SMBProtocol.html#SMBProtocolFactory.storeFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.storeFile" title="Permalink to this definition">¶</a></dt> | |
| 510 | <dd><p>Store the contents of the <em>file_obj</em> at <em>path</em> on the <em>service_name</em>.</p> | |
| 511 | <p>The meaning of the <em>timeout</em> parameter will be different from other file operation methods. As the uploaded file usually exceeeds the maximum size | |
| 512 | of each SMB/CIFS data message, it will be packetized into a series of messages (usually about 60kBytes). | |
| 513 | The <em>timeout</em> parameter is an integer/float value that specifies the timeout interval for these individual SMB/CIFS message to be transmitted and acknowledged | |
| 514 | by the remote SMB/CIFS server.</p> | |
| 515 | <table class="docutils field-list" frame="void" rules="none"> | |
| 516 | <col class="field-name" /> | |
| 517 | <col class="field-body" /> | |
| 518 | <tbody valign="top"> | |
| 519 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | |
| 520 | <li><strong>service_name</strong> (<em>string/unicode</em>) – the name of the shared folder for the <em>path</em></li> | |
| 521 | <li><strong>path</strong> (<em>string/unicode</em>) – Path of the file on the remote server. If the file at <em>path</em> does not exist, it will be created. Otherwise, it will be overwritten. | |
| 522 | If the <em>path</em> refers to a folder or the file cannot be opened for writing, an <a class="reference internal" href="smb_exceptions.html"><em>OperationFailure</em></a> will be called in the returned <em>Deferred</em> errback.</li> | |
| 523 | <li><strong>file_obj</strong> – A file-like object that has a <em>read</em> method. Data will read continuously from <em>file_obj</em> until EOF.</li> | |
| 524 | </ul> | |
| 525 | </td> | |
| 526 | </tr> | |
| 527 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A <em>twisted.internet.defer.Deferred</em> instance. The callback function will be called with a 2-element tuple of ( <em>file_obj</em>, number of bytes uploaded ).</p> | |
| 528 | </td> | |
| 529 | </tr> | |
| 530 | </tbody> | |
| 531 | </table> | |
| 532 | </dd></dl> | |
| 533 | ||
| 534 | <dl class="attribute"> | |
| 535 | <dt id="smb.SMBProtocol.SMBProtocolFactory.SIGN_NEVER"> | |
| 536 | <code class="descname">SIGN_NEVER</code><em class="property"> = 0</em><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.SIGN_NEVER" title="Permalink to this definition">¶</a></dt> | |
| 537 | <dd><p>SMB messages will never be signed regardless of remote server’s configurations; access errors will occur if the remote server requires signing.</p> | |
| 538 | </dd></dl> | |
| 539 | ||
| 540 | <dl class="attribute"> | |
| 541 | <dt id="smb.SMBProtocol.SMBProtocolFactory.SIGN_WHEN_REQUIRED"> | |
| 542 | <code class="descname">SIGN_WHEN_REQUIRED</code><em class="property"> = 2</em><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.SIGN_WHEN_REQUIRED" title="Permalink to this definition">¶</a></dt> | |
| 543 | <dd><p>SMB messages will only be signed when remote server requires signing.</p> | |
| 544 | </dd></dl> | |
| 545 | ||
| 546 | <dl class="attribute"> | |
| 547 | <dt id="smb.SMBProtocol.SMBProtocolFactory.SIGN_WHEN_SUPPORTED"> | |
| 548 | <code class="descname">SIGN_WHEN_SUPPORTED</code><em class="property"> = 1</em><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.SIGN_WHEN_SUPPORTED" title="Permalink to this definition">¶</a></dt> | |
| 549 | <dd><p>SMB messages will be signed when remote server supports signing but not requires signing.</p> | |
| 550 | </dd></dl> | |
| 551 | ||
| 552 | <dl class="attribute"> | |
| 553 | <dt id="smb.SMBProtocol.SMBProtocolFactory.instance"> | |
| 554 | <code class="descname">instance</code><em class="property"> = None</em><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.instance" title="Permalink to this definition">¶</a></dt> | |
| 555 | <dd><p>The single SMBProtocol instance for each SMBProtocolFactory instance. Usually, you should not need to touch this attribute directly.</p> | |
| 556 | </dd></dl> | |
| 557 | ||
| 558 | <dl class="attribute"> | |
| 559 | <dt id="smb.SMBProtocol.SMBProtocolFactory.isReady"> | |
| 560 | <code class="descname">isReady</code><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.isReady" title="Permalink to this definition">¶</a></dt> | |
| 561 | <dd><p>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.</p> | |
| 562 | </dd></dl> | |
| 563 | ||
| 564 | <dl class="attribute"> | |
| 565 | <dt id="smb.SMBProtocol.SMBProtocolFactory.isUsingSMB2"> | |
| 566 | <code class="descname">isUsingSMB2</code><a class="headerlink" href="#smb.SMBProtocol.SMBProtocolFactory.isUsingSMB2" title="Permalink to this definition">¶</a></dt> | |
| 567 | <dd><p>A convenient property to return True if the underlying SMB connection is using SMB2 protocol.</p> | |
| 568 | </dd></dl> | |
| 569 | ||
| 570 | </dd></dl> | |
| 571 | ||
| 572 | </div> | |
| 573 | </div> | |
| 574 | ||
| 575 | ||
| 576 | </div> | |
| 536 | </div> | |
| 537 | </div> | |
| 538 | <script>$('#searchbox').show(0);</script> | |
| 577 | 539 | </div> |
| 578 | 540 | </div> |
| 579 | 541 | <div class="clearer"></div> |
| 585 | 547 | <a href="../genindex.html" title="General Index" |
| 586 | 548 | >index</a></li> |
| 587 | 549 | <li class="right" > |
| 550 | <a href="../py-modindex.html" title="Python Module Index" | |
| 551 | >modules</a> |</li> | |
| 552 | <li class="right" > | |
| 588 | 553 | <a href="smb_SharedDevice.html" title="SharedDevice Class" |
| 589 | 554 | >next</a> |</li> |
| 590 | 555 | <li class="right" > |
| 591 | 556 | <a href="smb_SMBHandler.html" title="SMbHandler Class" |
| 592 | 557 | >previous</a> |</li> |
| 593 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 558 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 559 | <li class="nav-item nav-item-this"><a href="">SMBProtocolFactory Class</a></li> | |
| 594 | 560 | </ul> |
| 595 | 561 | </div> |
| 596 | 562 | <div class="footer" role="contentinfo"> |
| 597 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 598 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 563 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 564 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 599 | 565 | </div> |
| 600 | 566 | </body> |
| 601 | 567 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | 0 | |
| 1 | <!DOCTYPE html> | |
| 3 | 2 | |
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>SharedDevice Class — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>SharedDevice Class — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../index.html" /> | |
| 10 | <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> | |
| 11 | <script src="../_static/jquery.js"></script> | |
| 12 | <script src="../_static/underscore.js"></script> | |
| 13 | <script src="../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../search.html" /> | |
| 26 | 16 | <link rel="next" title="SharedFile Class" href="smb_SharedFile.html" /> |
| 27 | 17 | <link rel="prev" title="SMBProtocolFactory Class" href="smb_SMBProtocolFactory.html" /> |
| 28 | </head> | |
| 29 | <body role="document"> | |
| 18 | </head><body> | |
| 30 | 19 | <div class="related" role="navigation" aria-label="related navigation"> |
| 31 | 20 | <h3>Navigation</h3> |
| 32 | 21 | <ul> |
| 34 | 23 | <a href="../genindex.html" title="General Index" |
| 35 | 24 | accesskey="I">index</a></li> |
| 36 | 25 | <li class="right" > |
| 26 | <a href="../py-modindex.html" title="Python Module Index" | |
| 27 | >modules</a> |</li> | |
| 28 | <li class="right" > | |
| 37 | 29 | <a href="smb_SharedFile.html" title="SharedFile Class" |
| 38 | 30 | accesskey="N">next</a> |</li> |
| 39 | 31 | <li class="right" > |
| 40 | 32 | <a href="smb_SMBProtocolFactory.html" title="SMBProtocolFactory Class" |
| 41 | 33 | accesskey="P">previous</a> |</li> |
| 42 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 34 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 35 | <li class="nav-item nav-item-this"><a href="">SharedDevice Class</a></li> | |
| 43 | 36 | </ul> |
| 44 | </div> | |
| 37 | </div> | |
| 38 | ||
| 39 | <div class="document"> | |
| 40 | <div class="documentwrapper"> | |
| 41 | <div class="bodywrapper"> | |
| 42 | <div class="body" role="main"> | |
| 43 | ||
| 44 | <div class="section" id="shareddevice-class"> | |
| 45 | <h1>SharedDevice Class<a class="headerlink" href="#shareddevice-class" title="Permalink to this headline">¶</a></h1> | |
| 46 | <dl class="py class"> | |
| 47 | <dt id="smb.base.SharedDevice"> | |
| 48 | <em class="property">class </em><code class="sig-prename descclassname">smb.base.</code><code class="sig-name descname">SharedDevice</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">comments</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/base.html#SharedDevice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.base.SharedDevice" title="Permalink to this definition">¶</a></dt> | |
| 49 | <dd><p>Contains information about a single shared device on the remote server.</p> | |
| 50 | <p>The following attributes are available:</p> | |
| 51 | <ul class="simple"> | |
| 52 | <li><p>name : An unicode string containing the name of the shared device</p></li> | |
| 53 | <li><p>comments : An unicode string containing the user description of the shared device</p></li> | |
| 54 | </ul> | |
| 55 | <dl class="py attribute"> | |
| 56 | <dt id="smb.base.SharedDevice.comments"> | |
| 57 | <code class="sig-name descname">comments</code><a class="headerlink" href="#smb.base.SharedDevice.comments" title="Permalink to this definition">¶</a></dt> | |
| 58 | <dd><p>An unicode string containing the user description of the shared device</p> | |
| 59 | </dd></dl> | |
| 60 | ||
| 61 | <dl class="py method"> | |
| 62 | <dt id="smb.base.SharedDevice.isSpecial"> | |
| 63 | <em class="property">property </em><code class="sig-name descname">isSpecial</code><a class="headerlink" href="#smb.base.SharedDevice.isSpecial" title="Permalink to this definition">¶</a></dt> | |
| 64 | <dd><p>Returns True if this shared device is a special share reserved for interprocess communication (IPC$) | |
| 65 | or remote administration of the server (ADMIN$). Can also refer to administrative shares such as | |
| 66 | C$, D$, E$, and so forth</p> | |
| 67 | </dd></dl> | |
| 68 | ||
| 69 | <dl class="py method"> | |
| 70 | <dt id="smb.base.SharedDevice.isTemporary"> | |
| 71 | <em class="property">property </em><code class="sig-name descname">isTemporary</code><a class="headerlink" href="#smb.base.SharedDevice.isTemporary" title="Permalink to this definition">¶</a></dt> | |
| 72 | <dd><p>Returns True if this is a temporary share that is not persisted for creation each time the file server initializes.</p> | |
| 73 | </dd></dl> | |
| 74 | ||
| 75 | <dl class="py attribute"> | |
| 76 | <dt id="smb.base.SharedDevice.name"> | |
| 77 | <code class="sig-name descname">name</code><a class="headerlink" href="#smb.base.SharedDevice.name" title="Permalink to this definition">¶</a></dt> | |
| 78 | <dd><p>An unicode string containing the name of the shared device</p> | |
| 79 | </dd></dl> | |
| 80 | ||
| 81 | <dl class="py method"> | |
| 82 | <dt id="smb.base.SharedDevice.type"> | |
| 83 | <em class="property">property </em><code class="sig-name descname">type</code><a class="headerlink" href="#smb.base.SharedDevice.type" title="Permalink to this definition">¶</a></dt> | |
| 84 | <dd><dl class="simple"> | |
| 85 | <dt>Returns one of the following integral constants.</dt><dd><ul class="simple"> | |
| 86 | <li><p>SharedDevice.DISK_TREE</p></li> | |
| 87 | <li><p>SharedDevice.PRINT_QUEUE</p></li> | |
| 88 | <li><p>SharedDevice.COMM_DEVICE</p></li> | |
| 89 | <li><p>SharedDevice.IPC</p></li> | |
| 90 | </ul> | |
| 91 | </dd> | |
| 92 | </dl> | |
| 93 | </dd></dl> | |
| 94 | ||
| 95 | </dd></dl> | |
| 96 | ||
| 97 | </div> | |
| 98 | ||
| 99 | ||
| 100 | <div class="clearer"></div> | |
| 101 | </div> | |
| 102 | </div> | |
| 103 | </div> | |
| 45 | 104 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
| 46 | 105 | <div class="sphinxsidebarwrapper"> |
| 47 | 106 | <h4>Previous topic</h4> |
| 53 | 112 | <div role="note" aria-label="source link"> |
| 54 | 113 | <h3>This Page</h3> |
| 55 | 114 | <ul class="this-page-menu"> |
| 56 | <li><a href="../_sources/api/smb_SharedDevice.txt" | |
| 115 | <li><a href="../_sources/api/smb_SharedDevice.rst.txt" | |
| 57 | 116 | rel="nofollow">Show Source</a></li> |
| 58 | 117 | </ul> |
| 59 | 118 | </div> |
| 60 | 119 | <div id="searchbox" style="display: none" role="search"> |
| 61 | <h3>Quick search</h3> | |
| 120 | <h3 id="searchlabel">Quick search</h3> | |
| 121 | <div class="searchformwrapper"> | |
| 62 | 122 | <form class="search" action="../search.html" method="get"> |
| 63 | <input type="text" name="q" /> | |
| 123 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 64 | 124 | <input type="submit" value="Go" /> |
| 65 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 66 | <input type="hidden" name="area" value="default" /> | |
| 67 | 125 | </form> |
| 68 | <p class="searchtip" style="font-size: 90%"> | |
| 69 | Enter search terms or a module, class or function name. | |
| 70 | </p> | |
| 126 | </div> | |
| 71 | 127 | </div> |
| 72 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 73 | </div> | |
| 74 | </div> | |
| 75 | ||
| 76 | <div class="document"> | |
| 77 | <div class="documentwrapper"> | |
| 78 | <div class="bodywrapper"> | |
| 79 | <div class="body" role="main"> | |
| 80 | ||
| 81 | <div class="section" id="shareddevice-class"> | |
| 82 | <h1>SharedDevice Class<a class="headerlink" href="#shareddevice-class" title="Permalink to this headline">¶</a></h1> | |
| 83 | <dl class="class"> | |
| 84 | <dt id="smb.base.SharedDevice"> | |
| 85 | <em class="property">class </em><code class="descclassname">smb.base.</code><code class="descname">SharedDevice</code><span class="sig-paren">(</span><em>type</em>, <em>name</em>, <em>comments</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/base.html#SharedDevice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.base.SharedDevice" title="Permalink to this definition">¶</a></dt> | |
| 86 | <dd><p>Contains information about a single shared device on the remote server.</p> | |
| 87 | <dl class="attribute"> | |
| 88 | <dt id="smb.base.SharedDevice.comments"> | |
| 89 | <code class="descname">comments</code><em class="property"> = None</em><a class="headerlink" href="#smb.base.SharedDevice.comments" title="Permalink to this definition">¶</a></dt> | |
| 90 | <dd><p>An unicode string containing the user description of the shared device</p> | |
| 91 | </dd></dl> | |
| 92 | ||
| 93 | <dl class="attribute"> | |
| 94 | <dt id="smb.base.SharedDevice.isSpecial"> | |
| 95 | <code class="descname">isSpecial</code><a class="headerlink" href="#smb.base.SharedDevice.isSpecial" title="Permalink to this definition">¶</a></dt> | |
| 96 | <dd><p>Returns True if this shared device is a special share reserved for interprocess communication (IPC$) | |
| 97 | or remote administration of the server (ADMIN$). Can also refer to administrative shares such as | |
| 98 | C$, D$, E$, and so forth</p> | |
| 99 | </dd></dl> | |
| 100 | ||
| 101 | <dl class="attribute"> | |
| 102 | <dt id="smb.base.SharedDevice.isTemporary"> | |
| 103 | <code class="descname">isTemporary</code><a class="headerlink" href="#smb.base.SharedDevice.isTemporary" title="Permalink to this definition">¶</a></dt> | |
| 104 | <dd><p>Returns True if this is a temporary share that is not persisted for creation each time the file server initializes.</p> | |
| 105 | </dd></dl> | |
| 106 | ||
| 107 | <dl class="attribute"> | |
| 108 | <dt id="smb.base.SharedDevice.name"> | |
| 109 | <code class="descname">name</code><em class="property"> = None</em><a class="headerlink" href="#smb.base.SharedDevice.name" title="Permalink to this definition">¶</a></dt> | |
| 110 | <dd><p>An unicode string containing the name of the shared device</p> | |
| 111 | </dd></dl> | |
| 112 | ||
| 113 | <dl class="attribute"> | |
| 114 | <dt id="smb.base.SharedDevice.type"> | |
| 115 | <code class="descname">type</code><a class="headerlink" href="#smb.base.SharedDevice.type" title="Permalink to this definition">¶</a></dt> | |
| 116 | <dd><dl class="docutils"> | |
| 117 | <dt>Returns one of the following integral constants.</dt> | |
| 118 | <dd><ul class="first last simple"> | |
| 119 | <li>SharedDevice.DISK_TREE</li> | |
| 120 | <li>SharedDevice.PRINT_QUEUE</li> | |
| 121 | <li>SharedDevice.COMM_DEVICE</li> | |
| 122 | <li>SharedDevice.IPC</li> | |
| 123 | </ul> | |
| 124 | </dd> | |
| 125 | </dl> | |
| 126 | </dd></dl> | |
| 127 | ||
| 128 | </dd></dl> | |
| 129 | ||
| 130 | </div> | |
| 131 | ||
| 132 | ||
| 133 | </div> | |
| 128 | <script>$('#searchbox').show(0);</script> | |
| 134 | 129 | </div> |
| 135 | 130 | </div> |
| 136 | 131 | <div class="clearer"></div> |
| 142 | 137 | <a href="../genindex.html" title="General Index" |
| 143 | 138 | >index</a></li> |
| 144 | 139 | <li class="right" > |
| 140 | <a href="../py-modindex.html" title="Python Module Index" | |
| 141 | >modules</a> |</li> | |
| 142 | <li class="right" > | |
| 145 | 143 | <a href="smb_SharedFile.html" title="SharedFile Class" |
| 146 | 144 | >next</a> |</li> |
| 147 | 145 | <li class="right" > |
| 148 | 146 | <a href="smb_SMBProtocolFactory.html" title="SMBProtocolFactory Class" |
| 149 | 147 | >previous</a> |</li> |
| 150 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 148 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 149 | <li class="nav-item nav-item-this"><a href="">SharedDevice Class</a></li> | |
| 151 | 150 | </ul> |
| 152 | 151 | </div> |
| 153 | 152 | <div class="footer" role="contentinfo"> |
| 154 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 155 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 153 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 154 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 156 | 155 | </div> |
| 157 | 156 | </body> |
| 158 | 157 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | ||
| 3 | ||
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 0 | ||
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>SharedFile Class — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>SharedFile Class — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../index.html" /> | |
| 10 | <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> | |
| 11 | <script src="../_static/jquery.js"></script> | |
| 12 | <script src="../_static/underscore.js"></script> | |
| 13 | <script src="../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../search.html" /> | |
| 26 | 16 | <link rel="next" title="SMB Exceptions" href="smb_exceptions.html" /> |
| 27 | 17 | <link rel="prev" title="SharedDevice Class" href="smb_SharedDevice.html" /> |
| 28 | </head> | |
| 29 | <body role="document"> | |
| 18 | </head><body> | |
| 30 | 19 | <div class="related" role="navigation" aria-label="related navigation"> |
| 31 | 20 | <h3>Navigation</h3> |
| 32 | 21 | <ul> |
| 34 | 23 | <a href="../genindex.html" title="General Index" |
| 35 | 24 | accesskey="I">index</a></li> |
| 36 | 25 | <li class="right" > |
| 26 | <a href="../py-modindex.html" title="Python Module Index" | |
| 27 | >modules</a> |</li> | |
| 28 | <li class="right" > | |
| 37 | 29 | <a href="smb_exceptions.html" title="SMB Exceptions" |
| 38 | 30 | accesskey="N">next</a> |</li> |
| 39 | 31 | <li class="right" > |
| 40 | 32 | <a href="smb_SharedDevice.html" title="SharedDevice Class" |
| 41 | 33 | accesskey="P">previous</a> |</li> |
| 42 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 34 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 35 | <li class="nav-item nav-item-this"><a href="">SharedFile Class</a></li> | |
| 43 | 36 | </ul> |
| 44 | </div> | |
| 37 | </div> | |
| 38 | ||
| 39 | <div class="document"> | |
| 40 | <div class="documentwrapper"> | |
| 41 | <div class="bodywrapper"> | |
| 42 | <div class="body" role="main"> | |
| 43 | ||
| 44 | <div class="section" id="sharedfile-class"> | |
| 45 | <h1>SharedFile Class<a class="headerlink" href="#sharedfile-class" title="Permalink to this headline">¶</a></h1> | |
| 46 | <dl class="py class"> | |
| 47 | <dt id="smb.base.SharedFile"> | |
| 48 | <em class="property">class </em><code class="sig-prename descclassname">smb.base.</code><code class="sig-name descname">SharedFile</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">create_time</span></em>, <em class="sig-param"><span class="n">last_access_time</span></em>, <em class="sig-param"><span class="n">last_write_time</span></em>, <em class="sig-param"><span class="n">last_attr_change_time</span></em>, <em class="sig-param"><span class="n">file_size</span></em>, <em class="sig-param"><span class="n">alloc_size</span></em>, <em class="sig-param"><span class="n">file_attributes</span></em>, <em class="sig-param"><span class="n">short_name</span></em>, <em class="sig-param"><span class="n">filename</span></em>, <em class="sig-param"><span class="n">file_id</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/base.html#SharedFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.base.SharedFile" title="Permalink to this definition">¶</a></dt> | |
| 49 | <dd><p>Contain information about a file/folder entry that is shared on the shared device.</p> | |
| 50 | <p>As an application developer, you should not need to instantiate a <em>SharedFile</em> instance directly in your application. | |
| 51 | These <em>SharedFile</em> instances are usually returned via a call to <em>listPath</em> method in <a class="reference internal" href="smb_SMBProtocolFactory.html"><span class="doc">smb.SMBProtocol.SMBProtocolFactory</span></a>.</p> | |
| 52 | <p>If you encounter <em>SharedFile</em> instance where its short_name attribute is empty but the filename attribute contains a short name which does not correspond | |
| 53 | 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 | |
| 54 | one of these prohibited characters: “/[]:+|<>=;?,* (see [MS-CIFS]: 2.2.1.1.1 for more details).</p> | |
| 55 | <p>The following attributes are available:</p> | |
| 56 | <ul class="simple"> | |
| 57 | <li><p>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</p></li> | |
| 58 | <li><p>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</p></li> | |
| 59 | <li><p>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</p></li> | |
| 60 | <li><p>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</p></li> | |
| 61 | <li><p>file_size : File size in number of bytes</p></li> | |
| 62 | <li><p>alloc_size : Total number of bytes allocated to store this file</p></li> | |
| 63 | <li><p>file_attributes : A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3. You can perform bit-wise tests to determine the status of the file using the ATTR_xxx constants in smb_constants.py.</p></li> | |
| 64 | <li><p>short_name : Unicode string containing the short name of this file (usually in 8.3 notation)</p></li> | |
| 65 | <li><p>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.</p></li> | |
| 66 | <li><p>file_id : Long value representing the file reference number for the file. If the remote system does not support this field, this field will be None or 0. See [MS-FSCC]: 2.4.17</p></li> | |
| 67 | </ul> | |
| 68 | <dl class="py attribute"> | |
| 69 | <dt id="smb.base.SharedFile.alloc_size"> | |
| 70 | <code class="sig-name descname">alloc_size</code><a class="headerlink" href="#smb.base.SharedFile.alloc_size" title="Permalink to this definition">¶</a></dt> | |
| 71 | <dd><p>Total number of bytes allocated to store this file</p> | |
| 72 | </dd></dl> | |
| 73 | ||
| 74 | <dl class="py attribute"> | |
| 75 | <dt id="smb.base.SharedFile.create_time"> | |
| 76 | <code class="sig-name descname">create_time</code><a class="headerlink" href="#smb.base.SharedFile.create_time" title="Permalink to this definition">¶</a></dt> | |
| 77 | <dd><p>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</p> | |
| 78 | </dd></dl> | |
| 79 | ||
| 80 | <dl class="py attribute"> | |
| 81 | <dt id="smb.base.SharedFile.file_attributes"> | |
| 82 | <code class="sig-name descname">file_attributes</code><a class="headerlink" href="#smb.base.SharedFile.file_attributes" title="Permalink to this definition">¶</a></dt> | |
| 83 | <dd><p>A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3. You can perform bit-wise tests to determine the status of the file using the ATTR_xxx constants in smb_constants.py.</p> | |
| 84 | </dd></dl> | |
| 85 | ||
| 86 | <dl class="py attribute"> | |
| 87 | <dt id="smb.base.SharedFile.file_id"> | |
| 88 | <code class="sig-name descname">file_id</code><a class="headerlink" href="#smb.base.SharedFile.file_id" title="Permalink to this definition">¶</a></dt> | |
| 89 | <dd><p>Long value representing the file reference number for the file. If the remote system does not support this field, this field will be None or 0. See [MS-FSCC]: 2.4.17</p> | |
| 90 | </dd></dl> | |
| 91 | ||
| 92 | <dl class="py attribute"> | |
| 93 | <dt id="smb.base.SharedFile.file_size"> | |
| 94 | <code class="sig-name descname">file_size</code><a class="headerlink" href="#smb.base.SharedFile.file_size" title="Permalink to this definition">¶</a></dt> | |
| 95 | <dd><p>File size in number of bytes</p> | |
| 96 | </dd></dl> | |
| 97 | ||
| 98 | <dl class="py attribute"> | |
| 99 | <dt id="smb.base.SharedFile.filename"> | |
| 100 | <code class="sig-name descname">filename</code><a class="headerlink" href="#smb.base.SharedFile.filename" title="Permalink to this definition">¶</a></dt> | |
| 101 | <dd><p>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.</p> | |
| 102 | </dd></dl> | |
| 103 | ||
| 104 | <dl class="py method"> | |
| 105 | <dt id="smb.base.SharedFile.isDirectory"> | |
| 106 | <em class="property">property </em><code class="sig-name descname">isDirectory</code><a class="headerlink" href="#smb.base.SharedFile.isDirectory" title="Permalink to this definition">¶</a></dt> | |
| 107 | <dd><p>A convenience property to return True if this file resource is a directory on the remote server</p> | |
| 108 | </dd></dl> | |
| 109 | ||
| 110 | <dl class="py method"> | |
| 111 | <dt id="smb.base.SharedFile.isNormal"> | |
| 112 | <em class="property">property </em><code class="sig-name descname">isNormal</code><a class="headerlink" href="#smb.base.SharedFile.isNormal" title="Permalink to this definition">¶</a></dt> | |
| 113 | <dd><p>A convenient property to return True if this is a normal file.</p> | |
| 114 | <p>Note that pysmb defines a normal file as a file entry that is not read-only, not hidden, not system, not archive and not a directory. | |
| 115 | It ignores other attributes like compression, indexed, sparse, temporary and encryption.</p> | |
| 116 | </dd></dl> | |
| 117 | ||
| 118 | <dl class="py method"> | |
| 119 | <dt id="smb.base.SharedFile.isReadOnly"> | |
| 120 | <em class="property">property </em><code class="sig-name descname">isReadOnly</code><a class="headerlink" href="#smb.base.SharedFile.isReadOnly" title="Permalink to this definition">¶</a></dt> | |
| 121 | <dd><p>A convenient property to return True if this file resource is read-only on the remote server</p> | |
| 122 | </dd></dl> | |
| 123 | ||
| 124 | <dl class="py attribute"> | |
| 125 | <dt id="smb.base.SharedFile.last_access_time"> | |
| 126 | <code class="sig-name descname">last_access_time</code><a class="headerlink" href="#smb.base.SharedFile.last_access_time" title="Permalink to this definition">¶</a></dt> | |
| 127 | <dd><p>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</p> | |
| 128 | </dd></dl> | |
| 129 | ||
| 130 | <dl class="py attribute"> | |
| 131 | <dt id="smb.base.SharedFile.last_attr_change_time"> | |
| 132 | <code class="sig-name descname">last_attr_change_time</code><a class="headerlink" href="#smb.base.SharedFile.last_attr_change_time" title="Permalink to this definition">¶</a></dt> | |
| 133 | <dd><p>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</p> | |
| 134 | </dd></dl> | |
| 135 | ||
| 136 | <dl class="py attribute"> | |
| 137 | <dt id="smb.base.SharedFile.last_write_time"> | |
| 138 | <code class="sig-name descname">last_write_time</code><a class="headerlink" href="#smb.base.SharedFile.last_write_time" title="Permalink to this definition">¶</a></dt> | |
| 139 | <dd><p>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</p> | |
| 140 | </dd></dl> | |
| 141 | ||
| 142 | <dl class="py attribute"> | |
| 143 | <dt id="smb.base.SharedFile.short_name"> | |
| 144 | <code class="sig-name descname">short_name</code><a class="headerlink" href="#smb.base.SharedFile.short_name" title="Permalink to this definition">¶</a></dt> | |
| 145 | <dd><p>Unicode string containing the short name of this file (usually in 8.3 notation)</p> | |
| 146 | </dd></dl> | |
| 147 | ||
| 148 | </dd></dl> | |
| 149 | ||
| 150 | </div> | |
| 151 | ||
| 152 | ||
| 153 | <div class="clearer"></div> | |
| 154 | </div> | |
| 155 | </div> | |
| 156 | </div> | |
| 45 | 157 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
| 46 | 158 | <div class="sphinxsidebarwrapper"> |
| 47 | 159 | <h4>Previous topic</h4> |
| 53 | 165 | <div role="note" aria-label="source link"> |
| 54 | 166 | <h3>This Page</h3> |
| 55 | 167 | <ul class="this-page-menu"> |
| 56 | <li><a href="../_sources/api/smb_SharedFile.txt" | |
| 168 | <li><a href="../_sources/api/smb_SharedFile.rst.txt" | |
| 57 | 169 | rel="nofollow">Show Source</a></li> |
| 58 | 170 | </ul> |
| 59 | 171 | </div> |
| 60 | 172 | <div id="searchbox" style="display: none" role="search"> |
| 61 | <h3>Quick search</h3> | |
| 173 | <h3 id="searchlabel">Quick search</h3> | |
| 174 | <div class="searchformwrapper"> | |
| 62 | 175 | <form class="search" action="../search.html" method="get"> |
| 63 | <input type="text" name="q" /> | |
| 176 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 64 | 177 | <input type="submit" value="Go" /> |
| 65 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 66 | <input type="hidden" name="area" value="default" /> | |
| 67 | 178 | </form> |
| 68 | <p class="searchtip" style="font-size: 90%"> | |
| 69 | Enter search terms or a module, class or function name. | |
| 70 | </p> | |
| 179 | </div> | |
| 71 | 180 | </div> |
| 72 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 73 | </div> | |
| 74 | </div> | |
| 75 | ||
| 76 | <div class="document"> | |
| 77 | <div class="documentwrapper"> | |
| 78 | <div class="bodywrapper"> | |
| 79 | <div class="body" role="main"> | |
| 80 | ||
| 81 | <div class="section" id="sharedfile-class"> | |
| 82 | <h1>SharedFile Class<a class="headerlink" href="#sharedfile-class" title="Permalink to this headline">¶</a></h1> | |
| 83 | <dl class="class"> | |
| 84 | <dt id="smb.base.SharedFile"> | |
| 85 | <em class="property">class </em><code class="descclassname">smb.base.</code><code class="descname">SharedFile</code><span class="sig-paren">(</span><em>create_time</em>, <em>last_access_time</em>, <em>last_write_time</em>, <em>last_attr_change_time</em>, <em>file_size</em>, <em>alloc_size</em>, <em>file_attributes</em>, <em>short_name</em>, <em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/base.html#SharedFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.base.SharedFile" title="Permalink to this definition">¶</a></dt> | |
| 86 | <dd><p>Contain information about a file/folder entry that is shared on the shared device.</p> | |
| 87 | <p>As an application developer, you should not need to instantiate a <em>SharedFile</em> instance directly in your application. | |
| 88 | These <em>SharedFile</em> instances are usually returned via a call to <em>listPath</em> method in <a class="reference internal" href="smb_SMBProtocolFactory.html"><em>smb.SMBProtocol.SMBProtocolFactory</em></a>.</p> | |
| 89 | <p>If you encounter <em>SharedFile</em> instance where its short_name attribute is empty but the filename attribute contains a short name which does not correspond | |
| 90 | 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 | |
| 91 | one of these prohibited characters: “/[]:+|<>=;?,* (see [MS-CIFS]: 2.2.1.1.1 for more details).</p> | |
| 92 | <dl class="attribute"> | |
| 93 | <dt id="smb.base.SharedFile.alloc_size"> | |
| 94 | <code class="descname">alloc_size</code><em class="property"> = None</em><a class="headerlink" href="#smb.base.SharedFile.alloc_size" title="Permalink to this definition">¶</a></dt> | |
| 95 | <dd><p>Total number of bytes allocated to store this file</p> | |
| 96 | </dd></dl> | |
| 97 | ||
| 98 | <dl class="attribute"> | |
| 99 | <dt id="smb.base.SharedFile.create_time"> | |
| 100 | <code class="descname">create_time</code><em class="property"> = None</em><a class="headerlink" href="#smb.base.SharedFile.create_time" title="Permalink to this definition">¶</a></dt> | |
| 101 | <dd><p>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</p> | |
| 102 | </dd></dl> | |
| 103 | ||
| 104 | <dl class="attribute"> | |
| 105 | <dt id="smb.base.SharedFile.file_attributes"> | |
| 106 | <code class="descname">file_attributes</code><em class="property"> = None</em><a class="headerlink" href="#smb.base.SharedFile.file_attributes" title="Permalink to this definition">¶</a></dt> | |
| 107 | <dd><p>A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3</p> | |
| 108 | </dd></dl> | |
| 109 | ||
| 110 | <dl class="attribute"> | |
| 111 | <dt id="smb.base.SharedFile.file_size"> | |
| 112 | <code class="descname">file_size</code><em class="property"> = None</em><a class="headerlink" href="#smb.base.SharedFile.file_size" title="Permalink to this definition">¶</a></dt> | |
| 113 | <dd><p>File size in number of bytes</p> | |
| 114 | </dd></dl> | |
| 115 | ||
| 116 | <dl class="attribute"> | |
| 117 | <dt id="smb.base.SharedFile.filename"> | |
| 118 | <code class="descname">filename</code><em class="property"> = None</em><a class="headerlink" href="#smb.base.SharedFile.filename" title="Permalink to this definition">¶</a></dt> | |
| 119 | <dd><p>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.</p> | |
| 120 | </dd></dl> | |
| 121 | ||
| 122 | <dl class="attribute"> | |
| 123 | <dt id="smb.base.SharedFile.isDirectory"> | |
| 124 | <code class="descname">isDirectory</code><a class="headerlink" href="#smb.base.SharedFile.isDirectory" title="Permalink to this definition">¶</a></dt> | |
| 125 | <dd><p>A convenient property to return True if this file resource is a directory on the remote server</p> | |
| 126 | </dd></dl> | |
| 127 | ||
| 128 | <dl class="attribute"> | |
| 129 | <dt id="smb.base.SharedFile.isReadOnly"> | |
| 130 | <code class="descname">isReadOnly</code><a class="headerlink" href="#smb.base.SharedFile.isReadOnly" title="Permalink to this definition">¶</a></dt> | |
| 131 | <dd><p>A convenient property to return True if this file resource is read-only on the remote server</p> | |
| 132 | </dd></dl> | |
| 133 | ||
| 134 | <dl class="attribute"> | |
| 135 | <dt id="smb.base.SharedFile.last_access_time"> | |
| 136 | <code class="descname">last_access_time</code><em class="property"> = None</em><a class="headerlink" href="#smb.base.SharedFile.last_access_time" title="Permalink to this definition">¶</a></dt> | |
| 137 | <dd><p>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</p> | |
| 138 | </dd></dl> | |
| 139 | ||
| 140 | <dl class="attribute"> | |
| 141 | <dt id="smb.base.SharedFile.last_attr_change_time"> | |
| 142 | <code class="descname">last_attr_change_time</code><em class="property"> = None</em><a class="headerlink" href="#smb.base.SharedFile.last_attr_change_time" title="Permalink to this definition">¶</a></dt> | |
| 143 | <dd><p>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</p> | |
| 144 | </dd></dl> | |
| 145 | ||
| 146 | <dl class="attribute"> | |
| 147 | <dt id="smb.base.SharedFile.last_write_time"> | |
| 148 | <code class="descname">last_write_time</code><em class="property"> = None</em><a class="headerlink" href="#smb.base.SharedFile.last_write_time" title="Permalink to this definition">¶</a></dt> | |
| 149 | <dd><p>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</p> | |
| 150 | </dd></dl> | |
| 151 | ||
| 152 | <dl class="attribute"> | |
| 153 | <dt id="smb.base.SharedFile.short_name"> | |
| 154 | <code class="descname">short_name</code><em class="property"> = None</em><a class="headerlink" href="#smb.base.SharedFile.short_name" title="Permalink to this definition">¶</a></dt> | |
| 155 | <dd><p>Unicode string containing the short name of this file (usually in 8.3 notation)</p> | |
| 156 | </dd></dl> | |
| 157 | ||
| 158 | </dd></dl> | |
| 159 | ||
| 160 | </div> | |
| 161 | ||
| 162 | ||
| 163 | </div> | |
| 181 | <script>$('#searchbox').show(0);</script> | |
| 164 | 182 | </div> |
| 165 | 183 | </div> |
| 166 | 184 | <div class="clearer"></div> |
| 172 | 190 | <a href="../genindex.html" title="General Index" |
| 173 | 191 | >index</a></li> |
| 174 | 192 | <li class="right" > |
| 193 | <a href="../py-modindex.html" title="Python Module Index" | |
| 194 | >modules</a> |</li> | |
| 195 | <li class="right" > | |
| 175 | 196 | <a href="smb_exceptions.html" title="SMB Exceptions" |
| 176 | 197 | >next</a> |</li> |
| 177 | 198 | <li class="right" > |
| 178 | 199 | <a href="smb_SharedDevice.html" title="SharedDevice Class" |
| 179 | 200 | >previous</a> |</li> |
| 180 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 201 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 202 | <li class="nav-item nav-item-this"><a href="">SharedFile Class</a></li> | |
| 181 | 203 | </ul> |
| 182 | 204 | </div> |
| 183 | 205 | <div class="footer" role="contentinfo"> |
| 184 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 185 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 206 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 207 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 186 | 208 | </div> |
| 187 | 209 | </body> |
| 188 | 210 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | 0 | |
| 1 | <!DOCTYPE html> | |
| 3 | 2 | |
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>SMB Exceptions — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>SMB Exceptions — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: '../', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="../_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="../_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="../_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="../index.html" /> | |
| 26 | <link rel="next" title="Extending pysmb For Other Frameworks" href="../extending.html" /> | |
| 10 | <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> | |
| 11 | <script src="../_static/jquery.js"></script> | |
| 12 | <script src="../_static/underscore.js"></script> | |
| 13 | <script src="../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../search.html" /> | |
| 16 | <link rel="next" title="Security Descriptors" href="smb_security_descriptors.html" /> | |
| 27 | 17 | <link rel="prev" title="SharedFile Class" href="smb_SharedFile.html" /> |
| 28 | </head> | |
| 29 | <body role="document"> | |
| 18 | </head><body> | |
| 30 | 19 | <div class="related" role="navigation" aria-label="related navigation"> |
| 31 | 20 | <h3>Navigation</h3> |
| 32 | 21 | <ul> |
| 34 | 23 | <a href="../genindex.html" title="General Index" |
| 35 | 24 | accesskey="I">index</a></li> |
| 36 | 25 | <li class="right" > |
| 37 | <a href="../extending.html" title="Extending pysmb For Other Frameworks" | |
| 26 | <a href="../py-modindex.html" title="Python Module Index" | |
| 27 | >modules</a> |</li> | |
| 28 | <li class="right" > | |
| 29 | <a href="smb_security_descriptors.html" title="Security Descriptors" | |
| 38 | 30 | accesskey="N">next</a> |</li> |
| 39 | 31 | <li class="right" > |
| 40 | 32 | <a href="smb_SharedFile.html" title="SharedFile Class" |
| 41 | 33 | accesskey="P">previous</a> |</li> |
| 42 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 34 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 35 | <li class="nav-item nav-item-this"><a href="">SMB Exceptions</a></li> | |
| 43 | 36 | </ul> |
| 44 | </div> | |
| 45 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 46 | <div class="sphinxsidebarwrapper"> | |
| 47 | <h4>Previous topic</h4> | |
| 48 | <p class="topless"><a href="smb_SharedFile.html" | |
| 49 | title="previous chapter">SharedFile Class</a></p> | |
| 50 | <h4>Next topic</h4> | |
| 51 | <p class="topless"><a href="../extending.html" | |
| 52 | title="next chapter">Extending pysmb For Other Frameworks</a></p> | |
| 53 | <div role="note" aria-label="source link"> | |
| 54 | <h3>This Page</h3> | |
| 55 | <ul class="this-page-menu"> | |
| 56 | <li><a href="../_sources/api/smb_exceptions.txt" | |
| 57 | rel="nofollow">Show Source</a></li> | |
| 58 | </ul> | |
| 59 | </div> | |
| 60 | <div id="searchbox" style="display: none" role="search"> | |
| 61 | <h3>Quick search</h3> | |
| 62 | <form class="search" action="../search.html" method="get"> | |
| 63 | <input type="text" name="q" /> | |
| 64 | <input type="submit" value="Go" /> | |
| 65 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 66 | <input type="hidden" name="area" value="default" /> | |
| 67 | </form> | |
| 68 | <p class="searchtip" style="font-size: 90%"> | |
| 69 | Enter search terms or a module, class or function name. | |
| 70 | </p> | |
| 71 | </div> | |
| 72 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 73 | </div> | |
| 74 | </div> | |
| 37 | </div> | |
| 75 | 38 | |
| 76 | 39 | <div class="document"> |
| 77 | 40 | <div class="documentwrapper"> |
| 80 | 43 | |
| 81 | 44 | <div class="section" id="smb-exceptions"> |
| 82 | 45 | <h1>SMB Exceptions<a class="headerlink" href="#smb-exceptions" title="Permalink to this headline">¶</a></h1> |
| 83 | <dl class="class"> | |
| 46 | <dl class="py class"> | |
| 84 | 47 | <dt id="smb.base.SMBTimeout"> |
| 85 | <em class="property">class </em><code class="descclassname">smb.base.</code><code class="descname">SMBTimeout</code><a class="reference internal" href="../_modules/smb/base.html#SMBTimeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.base.SMBTimeout" title="Permalink to this definition">¶</a></dt> | |
| 48 | <em class="property">class </em><code class="sig-prename descclassname">smb.base.</code><code class="sig-name descname">SMBTimeout</code><a class="reference internal" href="../_modules/smb/base.html#SMBTimeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.base.SMBTimeout" title="Permalink to this definition">¶</a></dt> | |
| 86 | 49 | <dd><p>Raised when a timeout has occurred while waiting for a response or for a SMB/CIFS operation to complete.</p> |
| 87 | 50 | </dd></dl> |
| 88 | 51 | |
| 89 | <dl class="class"> | |
| 52 | <dl class="py class"> | |
| 90 | 53 | <dt id="smb.base.NotReadyError"> |
| 91 | <em class="property">class </em><code class="descclassname">smb.base.</code><code class="descname">NotReadyError</code><a class="reference internal" href="../_modules/smb/base.html#NotReadyError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.base.NotReadyError" title="Permalink to this definition">¶</a></dt> | |
| 54 | <em class="property">class </em><code class="sig-prename descclassname">smb.base.</code><code class="sig-name descname">NotReadyError</code><a class="reference internal" href="../_modules/smb/base.html#NotReadyError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.base.NotReadyError" title="Permalink to this definition">¶</a></dt> | |
| 92 | 55 | <dd><p>Raised when SMB connection is not ready (i.e. not authenticated or authentication failed)</p> |
| 93 | 56 | </dd></dl> |
| 94 | 57 | |
| 95 | <dl class="class"> | |
| 58 | <dl class="py class"> | |
| 96 | 59 | <dt id="smb.base.NotConnectedError"> |
| 97 | <em class="property">class </em><code class="descclassname">smb.base.</code><code class="descname">NotConnectedError</code><a class="reference internal" href="../_modules/smb/base.html#NotConnectedError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.base.NotConnectedError" title="Permalink to this definition">¶</a></dt> | |
| 60 | <em class="property">class </em><code class="sig-prename descclassname">smb.base.</code><code class="sig-name descname">NotConnectedError</code><a class="reference internal" href="../_modules/smb/base.html#NotConnectedError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.base.NotConnectedError" title="Permalink to this definition">¶</a></dt> | |
| 98 | 61 | <dd><p>Raised when underlying SMB connection has been disconnected or not connected yet</p> |
| 99 | 62 | </dd></dl> |
| 100 | 63 | |
| 101 | <dl class="class"> | |
| 64 | <dl class="py class"> | |
| 102 | 65 | <dt id="smb.smb_structs.UnsupportedFeature"> |
| 103 | <em class="property">class </em><code class="descclassname">smb.smb_structs.</code><code class="descname">UnsupportedFeature</code><a class="reference internal" href="../_modules/smb/smb_structs.html#UnsupportedFeature"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.smb_structs.UnsupportedFeature" title="Permalink to this definition">¶</a></dt> | |
| 66 | <em class="property">class </em><code class="sig-prename descclassname">smb.smb_structs.</code><code class="sig-name descname">UnsupportedFeature</code><a class="reference internal" href="../_modules/smb/smb_structs.html#UnsupportedFeature"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.smb_structs.UnsupportedFeature" title="Permalink to this definition">¶</a></dt> | |
| 104 | 67 | <dd><p>Raised when an supported feature is present/required in the protocol but is not |
| 105 | 68 | currently supported by pysmb</p> |
| 106 | 69 | </dd></dl> |
| 107 | 70 | |
| 108 | <dl class="class"> | |
| 71 | <dl class="py class"> | |
| 109 | 72 | <dt id="smb.smb_structs.ProtocolError"> |
| 110 | <em class="property">class </em><code class="descclassname">smb.smb_structs.</code><code class="descname">ProtocolError</code><span class="sig-paren">(</span><em>message</em>, <em>data_buf=None</em>, <em>smb_message=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/smb_structs.html#ProtocolError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.smb_structs.ProtocolError" title="Permalink to this definition">¶</a></dt> | |
| 73 | <em class="property">class </em><code class="sig-prename descclassname">smb.smb_structs.</code><code class="sig-name descname">ProtocolError</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="n">data_buf</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">smb_message</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/smb_structs.html#ProtocolError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.smb_structs.ProtocolError" title="Permalink to this definition">¶</a></dt> | |
| 111 | 74 | <dd></dd></dl> |
| 112 | 75 | |
| 113 | <dl class="class"> | |
| 76 | <dl class="py class"> | |
| 114 | 77 | <dt id="smb.smb_structs.OperationFailure"> |
| 115 | <em class="property">class </em><code class="descclassname">smb.smb_structs.</code><code class="descname">OperationFailure</code><span class="sig-paren">(</span><em>message</em>, <em>smb_messages</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/smb_structs.html#OperationFailure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.smb_structs.OperationFailure" title="Permalink to this definition">¶</a></dt> | |
| 78 | <em class="property">class </em><code class="sig-prename descclassname">smb.smb_structs.</code><code class="sig-name descname">OperationFailure</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="n">smb_messages</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/smb_structs.html#OperationFailure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.smb_structs.OperationFailure" title="Permalink to this definition">¶</a></dt> | |
| 116 | 79 | <dd></dd></dl> |
| 117 | 80 | |
| 118 | 81 | </div> |
| 119 | 82 | |
| 120 | 83 | |
| 84 | <div class="clearer"></div> | |
| 121 | 85 | </div> |
| 86 | </div> | |
| 87 | </div> | |
| 88 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 89 | <div class="sphinxsidebarwrapper"> | |
| 90 | <h4>Previous topic</h4> | |
| 91 | <p class="topless"><a href="smb_SharedFile.html" | |
| 92 | title="previous chapter">SharedFile Class</a></p> | |
| 93 | <h4>Next topic</h4> | |
| 94 | <p class="topless"><a href="smb_security_descriptors.html" | |
| 95 | title="next chapter">Security Descriptors</a></p> | |
| 96 | <div role="note" aria-label="source link"> | |
| 97 | <h3>This Page</h3> | |
| 98 | <ul class="this-page-menu"> | |
| 99 | <li><a href="../_sources/api/smb_exceptions.rst.txt" | |
| 100 | rel="nofollow">Show Source</a></li> | |
| 101 | </ul> | |
| 102 | </div> | |
| 103 | <div id="searchbox" style="display: none" role="search"> | |
| 104 | <h3 id="searchlabel">Quick search</h3> | |
| 105 | <div class="searchformwrapper"> | |
| 106 | <form class="search" action="../search.html" method="get"> | |
| 107 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 108 | <input type="submit" value="Go" /> | |
| 109 | </form> | |
| 110 | </div> | |
| 111 | </div> | |
| 112 | <script>$('#searchbox').show(0);</script> | |
| 122 | 113 | </div> |
| 123 | 114 | </div> |
| 124 | 115 | <div class="clearer"></div> |
| 130 | 121 | <a href="../genindex.html" title="General Index" |
| 131 | 122 | >index</a></li> |
| 132 | 123 | <li class="right" > |
| 133 | <a href="../extending.html" title="Extending pysmb For Other Frameworks" | |
| 124 | <a href="../py-modindex.html" title="Python Module Index" | |
| 125 | >modules</a> |</li> | |
| 126 | <li class="right" > | |
| 127 | <a href="smb_security_descriptors.html" title="Security Descriptors" | |
| 134 | 128 | >next</a> |</li> |
| 135 | 129 | <li class="right" > |
| 136 | 130 | <a href="smb_SharedFile.html" title="SharedFile Class" |
| 137 | 131 | >previous</a> |</li> |
| 138 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 132 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 133 | <li class="nav-item nav-item-this"><a href="">SMB Exceptions</a></li> | |
| 139 | 134 | </ul> |
| 140 | 135 | </div> |
| 141 | 136 | <div class="footer" role="contentinfo"> |
| 142 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 143 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 137 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 138 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 144 | 139 | </div> |
| 145 | 140 | </body> |
| 146 | 141 | </html>⏎ |
| 0 | ||
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 4 | <head> | |
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>Security Descriptors — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | |
| 9 | <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" /> | |
| 10 | <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> | |
| 11 | <script src="../_static/jquery.js"></script> | |
| 12 | <script src="../_static/underscore.js"></script> | |
| 13 | <script src="../_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="../genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="../search.html" /> | |
| 16 | <link rel="next" title="Extending pysmb For Other Frameworks" href="../extending.html" /> | |
| 17 | <link rel="prev" title="SMB Exceptions" href="smb_exceptions.html" /> | |
| 18 | </head><body> | |
| 19 | <div class="related" role="navigation" aria-label="related navigation"> | |
| 20 | <h3>Navigation</h3> | |
| 21 | <ul> | |
| 22 | <li class="right" style="margin-right: 10px"> | |
| 23 | <a href="../genindex.html" title="General Index" | |
| 24 | accesskey="I">index</a></li> | |
| 25 | <li class="right" > | |
| 26 | <a href="../py-modindex.html" title="Python Module Index" | |
| 27 | >modules</a> |</li> | |
| 28 | <li class="right" > | |
| 29 | <a href="../extending.html" title="Extending pysmb For Other Frameworks" | |
| 30 | accesskey="N">next</a> |</li> | |
| 31 | <li class="right" > | |
| 32 | <a href="smb_exceptions.html" title="SMB Exceptions" | |
| 33 | accesskey="P">previous</a> |</li> | |
| 34 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 35 | <li class="nav-item nav-item-this"><a href="">Security Descriptors</a></li> | |
| 36 | </ul> | |
| 37 | </div> | |
| 38 | ||
| 39 | <div class="document"> | |
| 40 | <div class="documentwrapper"> | |
| 41 | <div class="bodywrapper"> | |
| 42 | <div class="body" role="main"> | |
| 43 | ||
| 44 | <div class="section" id="module-smb.security_descriptors"> | |
| 45 | <span id="security-descriptors"></span><h1>Security Descriptors<a class="headerlink" href="#module-smb.security_descriptors" title="Permalink to this headline">¶</a></h1> | |
| 46 | <p>This module implements security descriptors, and associated data | |
| 47 | structures, as specified in <a class="reference external" href="https://msdn.microsoft.com/en-us/library/cc230273.aspx">[MS-DTYP]</a>.</p> | |
| 48 | <dl class="py class"> | |
| 49 | <dt id="smb.security_descriptors.SID"> | |
| 50 | <em class="property">class </em><code class="sig-prename descclassname">smb.security_descriptors.</code><code class="sig-name descname">SID</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">revision</span></em>, <em class="sig-param"><span class="n">identifier_authority</span></em>, <em class="sig-param"><span class="n">subauthorities</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/security_descriptors.html#SID"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.security_descriptors.SID" title="Permalink to this definition">¶</a></dt> | |
| 51 | <dd><p>A Windows security identifier. Represents a single principal, such a | |
| 52 | user or a group, as a sequence of numbers consisting of the revision, | |
| 53 | identifier authority, and a variable-length list of subauthorities.</p> | |
| 54 | <p>See [MS-DTYP]: 2.4.2</p> | |
| 55 | <dl class="py attribute"> | |
| 56 | <dt id="smb.security_descriptors.SID.identifier_authority"> | |
| 57 | <code class="sig-name descname">identifier_authority</code><a class="headerlink" href="#smb.security_descriptors.SID.identifier_authority" title="Permalink to this definition">¶</a></dt> | |
| 58 | <dd><p>An integer representing the identifier authority.</p> | |
| 59 | </dd></dl> | |
| 60 | ||
| 61 | <dl class="py attribute"> | |
| 62 | <dt id="smb.security_descriptors.SID.revision"> | |
| 63 | <code class="sig-name descname">revision</code><a class="headerlink" href="#smb.security_descriptors.SID.revision" title="Permalink to this definition">¶</a></dt> | |
| 64 | <dd><p>Revision, should always be 1.</p> | |
| 65 | </dd></dl> | |
| 66 | ||
| 67 | <dl class="py attribute"> | |
| 68 | <dt id="smb.security_descriptors.SID.subauthorities"> | |
| 69 | <code class="sig-name descname">subauthorities</code><a class="headerlink" href="#smb.security_descriptors.SID.subauthorities" title="Permalink to this definition">¶</a></dt> | |
| 70 | <dd><p>A list of integers representing all subauthorities.</p> | |
| 71 | </dd></dl> | |
| 72 | ||
| 73 | </dd></dl> | |
| 74 | ||
| 75 | <dl class="py class"> | |
| 76 | <dt id="smb.security_descriptors.ACE"> | |
| 77 | <em class="property">class </em><code class="sig-prename descclassname">smb.security_descriptors.</code><code class="sig-name descname">ACE</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type_</span></em>, <em class="sig-param"><span class="n">flags</span></em>, <em class="sig-param"><span class="n">mask</span></em>, <em class="sig-param"><span class="n">sid</span></em>, <em class="sig-param"><span class="n">additional_data</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/security_descriptors.html#ACE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.security_descriptors.ACE" title="Permalink to this definition">¶</a></dt> | |
| 78 | <dd><p>Represents a single access control entry.</p> | |
| 79 | <p>See [MS-DTYP]: 2.4.4</p> | |
| 80 | <dl class="py attribute"> | |
| 81 | <dt id="smb.security_descriptors.ACE.additional_data"> | |
| 82 | <code class="sig-name descname">additional_data</code><a class="headerlink" href="#smb.security_descriptors.ACE.additional_data" title="Permalink to this definition">¶</a></dt> | |
| 83 | <dd><p>A dictionary of additional fields present in the ACE, depending | |
| 84 | on the type. The following fields can be present:</p> | |
| 85 | <ul class="simple"> | |
| 86 | <li><p><code class="docutils literal notranslate"><span class="pre">flags</span></code></p></li> | |
| 87 | <li><p><code class="docutils literal notranslate"><span class="pre">object_type</span></code></p></li> | |
| 88 | <li><p><code class="docutils literal notranslate"><span class="pre">inherited_object_type</span></code></p></li> | |
| 89 | <li><p><code class="docutils literal notranslate"><span class="pre">application_data</span></code></p></li> | |
| 90 | <li><p><code class="docutils literal notranslate"><span class="pre">attribute_data</span></code></p></li> | |
| 91 | </ul> | |
| 92 | </dd></dl> | |
| 93 | ||
| 94 | <dl class="py attribute"> | |
| 95 | <dt id="smb.security_descriptors.ACE.flags"> | |
| 96 | <code class="sig-name descname">flags</code><a class="headerlink" href="#smb.security_descriptors.ACE.flags" title="Permalink to this definition">¶</a></dt> | |
| 97 | <dd><p>An integer bitmask with ACE flags, corresponds to the | |
| 98 | <code class="docutils literal notranslate"><span class="pre">AceFlags</span></code> field.</p> | |
| 99 | </dd></dl> | |
| 100 | ||
| 101 | <dl class="py method"> | |
| 102 | <dt id="smb.security_descriptors.ACE.isInheritOnly"> | |
| 103 | <em class="property">property </em><code class="sig-name descname">isInheritOnly</code><a class="headerlink" href="#smb.security_descriptors.ACE.isInheritOnly" title="Permalink to this definition">¶</a></dt> | |
| 104 | <dd><p>Convenience property which indicates if this ACE is inherit | |
| 105 | only, meaning that it doesn’t apply to the object itself.</p> | |
| 106 | </dd></dl> | |
| 107 | ||
| 108 | <dl class="py attribute"> | |
| 109 | <dt id="smb.security_descriptors.ACE.mask"> | |
| 110 | <code class="sig-name descname">mask</code><a class="headerlink" href="#smb.security_descriptors.ACE.mask" title="Permalink to this definition">¶</a></dt> | |
| 111 | <dd><p>An integer representing the <code class="docutils literal notranslate"><span class="pre">ACCESS_MASK</span></code> as specified in | |
| 112 | [MS-DTYP] 2.4.3.</p> | |
| 113 | </dd></dl> | |
| 114 | ||
| 115 | <dl class="py attribute"> | |
| 116 | <dt id="smb.security_descriptors.ACE.sid"> | |
| 117 | <code class="sig-name descname">sid</code><a class="headerlink" href="#smb.security_descriptors.ACE.sid" title="Permalink to this definition">¶</a></dt> | |
| 118 | <dd><p>The <a class="reference internal" href="#smb.security_descriptors.SID" title="smb.security_descriptors.SID"><code class="xref py py-class docutils literal notranslate"><span class="pre">SID</span></code></a> of a trustee.</p> | |
| 119 | </dd></dl> | |
| 120 | ||
| 121 | <dl class="py attribute"> | |
| 122 | <dt id="smb.security_descriptors.ACE.type"> | |
| 123 | <code class="sig-name descname">type</code><a class="headerlink" href="#smb.security_descriptors.ACE.type" title="Permalink to this definition">¶</a></dt> | |
| 124 | <dd><p>An integer representing the type of the ACE. One of the | |
| 125 | <code class="docutils literal notranslate"><span class="pre">ACE_TYPE_*</span></code> constants. Corresponds to the <code class="docutils literal notranslate"><span class="pre">AceType</span></code> field | |
| 126 | from [MS-DTYP] 2.4.4.1.</p> | |
| 127 | </dd></dl> | |
| 128 | ||
| 129 | </dd></dl> | |
| 130 | ||
| 131 | <dl class="py class"> | |
| 132 | <dt id="smb.security_descriptors.ACL"> | |
| 133 | <em class="property">class </em><code class="sig-prename descclassname">smb.security_descriptors.</code><code class="sig-name descname">ACL</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">revision</span></em>, <em class="sig-param"><span class="n">aces</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/security_descriptors.html#ACL"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.security_descriptors.ACL" title="Permalink to this definition">¶</a></dt> | |
| 134 | <dd><p>Access control list, encapsulating a sequence of access control | |
| 135 | entries.</p> | |
| 136 | <p>See [MS-DTYP]: 2.4.5</p> | |
| 137 | <dl class="py attribute"> | |
| 138 | <dt id="smb.security_descriptors.ACL.aces"> | |
| 139 | <code class="sig-name descname">aces</code><a class="headerlink" href="#smb.security_descriptors.ACL.aces" title="Permalink to this definition">¶</a></dt> | |
| 140 | <dd><p>List of <a class="reference internal" href="#smb.security_descriptors.ACE" title="smb.security_descriptors.ACE"><code class="xref py py-class docutils literal notranslate"><span class="pre">ACE</span></code></a> instances.</p> | |
| 141 | </dd></dl> | |
| 142 | ||
| 143 | <dl class="py attribute"> | |
| 144 | <dt id="smb.security_descriptors.ACL.revision"> | |
| 145 | <code class="sig-name descname">revision</code><a class="headerlink" href="#smb.security_descriptors.ACL.revision" title="Permalink to this definition">¶</a></dt> | |
| 146 | <dd><p>Integer value of the revision.</p> | |
| 147 | </dd></dl> | |
| 148 | ||
| 149 | </dd></dl> | |
| 150 | ||
| 151 | <dl class="py class"> | |
| 152 | <dt id="smb.security_descriptors.SecurityDescriptor"> | |
| 153 | <em class="property">class </em><code class="sig-prename descclassname">smb.security_descriptors.</code><code class="sig-name descname">SecurityDescriptor</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flags</span></em>, <em class="sig-param"><span class="n">owner</span></em>, <em class="sig-param"><span class="n">group</span></em>, <em class="sig-param"><span class="n">dacl</span></em>, <em class="sig-param"><span class="n">sacl</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/smb/security_descriptors.html#SecurityDescriptor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#smb.security_descriptors.SecurityDescriptor" title="Permalink to this definition">¶</a></dt> | |
| 154 | <dd><p>Represents a security descriptor.</p> | |
| 155 | <p>See [MS-DTYP]: 2.4.6</p> | |
| 156 | <dl class="py attribute"> | |
| 157 | <dt id="smb.security_descriptors.SecurityDescriptor.dacl"> | |
| 158 | <code class="sig-name descname">dacl</code><a class="headerlink" href="#smb.security_descriptors.SecurityDescriptor.dacl" title="Permalink to this definition">¶</a></dt> | |
| 159 | <dd><p>Instance of <a class="reference internal" href="#smb.security_descriptors.ACL" title="smb.security_descriptors.ACL"><code class="xref py py-class docutils literal notranslate"><span class="pre">ACL</span></code></a> representing the discretionary access | |
| 160 | control list, which specifies access restrictions of an object.</p> | |
| 161 | </dd></dl> | |
| 162 | ||
| 163 | <dl class="py attribute"> | |
| 164 | <dt id="smb.security_descriptors.SecurityDescriptor.flags"> | |
| 165 | <code class="sig-name descname">flags</code><a class="headerlink" href="#smb.security_descriptors.SecurityDescriptor.flags" title="Permalink to this definition">¶</a></dt> | |
| 166 | <dd><p>Integer bitmask of control flags. Corresponds to the | |
| 167 | <code class="docutils literal notranslate"><span class="pre">Control</span></code> field in [MS-DTYP] 2.4.6.</p> | |
| 168 | </dd></dl> | |
| 169 | ||
| 170 | <dl class="py attribute"> | |
| 171 | <dt id="smb.security_descriptors.SecurityDescriptor.group"> | |
| 172 | <code class="sig-name descname">group</code><a class="headerlink" href="#smb.security_descriptors.SecurityDescriptor.group" title="Permalink to this definition">¶</a></dt> | |
| 173 | <dd><p>Instance of <a class="reference internal" href="#smb.security_descriptors.SID" title="smb.security_descriptors.SID"><code class="xref py py-class docutils literal notranslate"><span class="pre">SID</span></code></a> representing the owner group.</p> | |
| 174 | </dd></dl> | |
| 175 | ||
| 176 | <dl class="py attribute"> | |
| 177 | <dt id="smb.security_descriptors.SecurityDescriptor.owner"> | |
| 178 | <code class="sig-name descname">owner</code><a class="headerlink" href="#smb.security_descriptors.SecurityDescriptor.owner" title="Permalink to this definition">¶</a></dt> | |
| 179 | <dd><p>Instance of <a class="reference internal" href="#smb.security_descriptors.SID" title="smb.security_descriptors.SID"><code class="xref py py-class docutils literal notranslate"><span class="pre">SID</span></code></a> representing the owner user.</p> | |
| 180 | </dd></dl> | |
| 181 | ||
| 182 | <dl class="py attribute"> | |
| 183 | <dt id="smb.security_descriptors.SecurityDescriptor.sacl"> | |
| 184 | <code class="sig-name descname">sacl</code><a class="headerlink" href="#smb.security_descriptors.SecurityDescriptor.sacl" title="Permalink to this definition">¶</a></dt> | |
| 185 | <dd><p>Instance of <a class="reference internal" href="#smb.security_descriptors.ACL" title="smb.security_descriptors.ACL"><code class="xref py py-class docutils literal notranslate"><span class="pre">ACL</span></code></a> representing the system access control | |
| 186 | list, which specifies audit logging of an object.</p> | |
| 187 | </dd></dl> | |
| 188 | ||
| 189 | </dd></dl> | |
| 190 | ||
| 191 | </div> | |
| 192 | ||
| 193 | ||
| 194 | <div class="clearer"></div> | |
| 195 | </div> | |
| 196 | </div> | |
| 197 | </div> | |
| 198 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 199 | <div class="sphinxsidebarwrapper"> | |
| 200 | <h4>Previous topic</h4> | |
| 201 | <p class="topless"><a href="smb_exceptions.html" | |
| 202 | title="previous chapter">SMB Exceptions</a></p> | |
| 203 | <h4>Next topic</h4> | |
| 204 | <p class="topless"><a href="../extending.html" | |
| 205 | title="next chapter">Extending pysmb For Other Frameworks</a></p> | |
| 206 | <div role="note" aria-label="source link"> | |
| 207 | <h3>This Page</h3> | |
| 208 | <ul class="this-page-menu"> | |
| 209 | <li><a href="../_sources/api/smb_security_descriptors.rst.txt" | |
| 210 | rel="nofollow">Show Source</a></li> | |
| 211 | </ul> | |
| 212 | </div> | |
| 213 | <div id="searchbox" style="display: none" role="search"> | |
| 214 | <h3 id="searchlabel">Quick search</h3> | |
| 215 | <div class="searchformwrapper"> | |
| 216 | <form class="search" action="../search.html" method="get"> | |
| 217 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 218 | <input type="submit" value="Go" /> | |
| 219 | </form> | |
| 220 | </div> | |
| 221 | </div> | |
| 222 | <script>$('#searchbox').show(0);</script> | |
| 223 | </div> | |
| 224 | </div> | |
| 225 | <div class="clearer"></div> | |
| 226 | </div> | |
| 227 | <div class="related" role="navigation" aria-label="related navigation"> | |
| 228 | <h3>Navigation</h3> | |
| 229 | <ul> | |
| 230 | <li class="right" style="margin-right: 10px"> | |
| 231 | <a href="../genindex.html" title="General Index" | |
| 232 | >index</a></li> | |
| 233 | <li class="right" > | |
| 234 | <a href="../py-modindex.html" title="Python Module Index" | |
| 235 | >modules</a> |</li> | |
| 236 | <li class="right" > | |
| 237 | <a href="../extending.html" title="Extending pysmb For Other Frameworks" | |
| 238 | >next</a> |</li> | |
| 239 | <li class="right" > | |
| 240 | <a href="smb_exceptions.html" title="SMB Exceptions" | |
| 241 | >previous</a> |</li> | |
| 242 | <li class="nav-item nav-item-0"><a href="../index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 243 | <li class="nav-item nav-item-this"><a href="">Security Descriptors</a></li> | |
| 244 | </ul> | |
| 245 | </div> | |
| 246 | <div class="footer" role="contentinfo"> | |
| 247 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 248 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 249 | </div> | |
| 250 | </body> | |
| 251 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | 0 | |
| 1 | <!DOCTYPE html> | |
| 3 | 2 | |
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>Extending pysmb For Other Frameworks — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>Extending pysmb For Other Frameworks — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: './', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="index.html" /> | |
| 26 | <link rel="prev" title="SMB Exceptions" href="api/smb_exceptions.html" /> | |
| 27 | </head> | |
| 28 | <body role="document"> | |
| 10 | <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> | |
| 11 | <script src="_static/jquery.js"></script> | |
| 12 | <script src="_static/underscore.js"></script> | |
| 13 | <script src="_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="search.html" /> | |
| 16 | <link rel="next" title="Upgrading from older pysmb versions" href="upgrading.html" /> | |
| 17 | <link rel="prev" title="Security Descriptors" href="api/smb_security_descriptors.html" /> | |
| 18 | </head><body> | |
| 29 | 19 | <div class="related" role="navigation" aria-label="related navigation"> |
| 30 | 20 | <h3>Navigation</h3> |
| 31 | 21 | <ul> |
| 33 | 23 | <a href="genindex.html" title="General Index" |
| 34 | 24 | accesskey="I">index</a></li> |
| 35 | 25 | <li class="right" > |
| 36 | <a href="api/smb_exceptions.html" title="SMB Exceptions" | |
| 26 | <a href="py-modindex.html" title="Python Module Index" | |
| 27 | >modules</a> |</li> | |
| 28 | <li class="right" > | |
| 29 | <a href="upgrading.html" title="Upgrading from older pysmb versions" | |
| 30 | accesskey="N">next</a> |</li> | |
| 31 | <li class="right" > | |
| 32 | <a href="api/smb_security_descriptors.html" title="Security Descriptors" | |
| 37 | 33 | accesskey="P">previous</a> |</li> |
| 38 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 34 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 35 | <li class="nav-item nav-item-this"><a href="">Extending pysmb For Other Frameworks</a></li> | |
| 39 | 36 | </ul> |
| 40 | </div> | |
| 41 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 42 | <div class="sphinxsidebarwrapper"> | |
| 43 | <h4>Previous topic</h4> | |
| 44 | <p class="topless"><a href="api/smb_exceptions.html" | |
| 45 | title="previous chapter">SMB Exceptions</a></p> | |
| 46 | <div role="note" aria-label="source link"> | |
| 47 | <h3>This Page</h3> | |
| 48 | <ul class="this-page-menu"> | |
| 49 | <li><a href="_sources/extending.txt" | |
| 50 | rel="nofollow">Show Source</a></li> | |
| 51 | </ul> | |
| 52 | </div> | |
| 53 | <div id="searchbox" style="display: none" role="search"> | |
| 54 | <h3>Quick search</h3> | |
| 55 | <form class="search" action="search.html" method="get"> | |
| 56 | <input type="text" name="q" /> | |
| 57 | <input type="submit" value="Go" /> | |
| 58 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 59 | <input type="hidden" name="area" value="default" /> | |
| 60 | </form> | |
| 61 | <p class="searchtip" style="font-size: 90%"> | |
| 62 | Enter search terms or a module, class or function name. | |
| 63 | </p> | |
| 64 | </div> | |
| 65 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 66 | </div> | |
| 67 | </div> | |
| 37 | </div> | |
| 68 | 38 | |
| 69 | 39 | <div class="document"> |
| 70 | 40 | <div class="documentwrapper"> |
| 77 | 47 | <p>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. |
| 78 | 48 | 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, |
| 79 | 49 | initiate file operations with the remote SMB/CIFS server.</p> |
| 80 | <dl class="docutils"> | |
| 81 | <dt>Now the above steps in more technical details:</dt> | |
| 82 | <dd><ol class="first arabic simple"> | |
| 83 | <li>Create a new class which subclasses the <em>smb.base.SMB</em> class. Most often, the connection setup will be part of the <em>__init__</em> method.</li> | |
| 84 | <li>Override the <em>write(self, data)</em> method to provide an implementation which will write <em>data</em> to the socket.</li> | |
| 85 | <li>Write your own loop handling method to read data from the socket. Once data have been read, call <em>feedData</em> method with the parameter. | |
| 86 | The <em>feedData</em> method has its own internal buffer, so it can accept incomplete NetBIOS session packet data.</li> | |
| 87 | <li>Override</li> | |
| 50 | <dl> | |
| 51 | <dt>Now the above steps in more technical details:</dt><dd><ol class="arabic simple"> | |
| 52 | <li><p>Create a new class which subclasses the <em>smb.base.SMB</em> class. Most often, the connection setup will be part of the <em>__init__</em> method.</p></li> | |
| 53 | <li><p>Override the <em>write(self, data)</em> method to provide an implementation which will write <em>data</em> to the socket.</p></li> | |
| 54 | <li><p>Write your own loop handling method to read data from the socket. Once data have been read, call <em>feedData</em> method with the parameter. | |
| 55 | The <em>feedData</em> method has its own internal buffer, so it can accept incomplete NetBIOS session packet data.</p></li> | |
| 56 | <li><p>Override</p></li> | |
| 88 | 57 | </ol> |
| 89 | <blockquote class="last"> | |
| 58 | <blockquote> | |
| 90 | 59 | <div><ul class="simple"> |
| 91 | <li><em>onAuthOK</em> method to include your own operations to perform when authentication is successful. You can initiate file operations in this method.</li> | |
| 92 | <li><em>onAuthFailed</em> 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 (<em>use_ntlm_v2</em> parameter in the constructor).</li> | |
| 93 | <li><em>onNMBSessionFailed</em> 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 <em>remote_name</em> parameter in the constructor.</li> | |
| 60 | <li><p><em>onAuthOK</em> method to include your own operations to perform when authentication is successful. You can initiate file operations in this method.</p></li> | |
| 61 | <li><p><em>onAuthFailed</em> 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 (<em>use_ntlm_v2</em> parameter in the constructor).</p></li> | |
| 62 | <li><p><em>onNMBSessionFailed</em> 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 <em>remote_name</em> parameter in the constructor.</p></li> | |
| 94 | 63 | </ul> |
| 95 | 64 | </div></blockquote> |
| 96 | 65 | </dd> |
| 98 | 67 | </div> |
| 99 | 68 | |
| 100 | 69 | |
| 70 | <div class="clearer"></div> | |
| 101 | 71 | </div> |
| 72 | </div> | |
| 73 | </div> | |
| 74 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 75 | <div class="sphinxsidebarwrapper"> | |
| 76 | <h4>Previous topic</h4> | |
| 77 | <p class="topless"><a href="api/smb_security_descriptors.html" | |
| 78 | title="previous chapter">Security Descriptors</a></p> | |
| 79 | <h4>Next topic</h4> | |
| 80 | <p class="topless"><a href="upgrading.html" | |
| 81 | title="next chapter">Upgrading from older pysmb versions</a></p> | |
| 82 | <div role="note" aria-label="source link"> | |
| 83 | <h3>This Page</h3> | |
| 84 | <ul class="this-page-menu"> | |
| 85 | <li><a href="_sources/extending.rst.txt" | |
| 86 | rel="nofollow">Show Source</a></li> | |
| 87 | </ul> | |
| 88 | </div> | |
| 89 | <div id="searchbox" style="display: none" role="search"> | |
| 90 | <h3 id="searchlabel">Quick search</h3> | |
| 91 | <div class="searchformwrapper"> | |
| 92 | <form class="search" action="search.html" method="get"> | |
| 93 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 94 | <input type="submit" value="Go" /> | |
| 95 | </form> | |
| 96 | </div> | |
| 97 | </div> | |
| 98 | <script>$('#searchbox').show(0);</script> | |
| 102 | 99 | </div> |
| 103 | 100 | </div> |
| 104 | 101 | <div class="clearer"></div> |
| 110 | 107 | <a href="genindex.html" title="General Index" |
| 111 | 108 | >index</a></li> |
| 112 | 109 | <li class="right" > |
| 113 | <a href="api/smb_exceptions.html" title="SMB Exceptions" | |
| 110 | <a href="py-modindex.html" title="Python Module Index" | |
| 111 | >modules</a> |</li> | |
| 112 | <li class="right" > | |
| 113 | <a href="upgrading.html" title="Upgrading from older pysmb versions" | |
| 114 | >next</a> |</li> | |
| 115 | <li class="right" > | |
| 116 | <a href="api/smb_security_descriptors.html" title="Security Descriptors" | |
| 114 | 117 | >previous</a> |</li> |
| 115 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 118 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 119 | <li class="nav-item nav-item-this"><a href="">Extending pysmb For Other Frameworks</a></li> | |
| 116 | 120 | </ul> |
| 117 | 121 | </div> |
| 118 | 122 | <div class="footer" role="contentinfo"> |
| 119 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 120 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 123 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 124 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 121 | 125 | </div> |
| 122 | 126 | </body> |
| 123 | 127 | </html>⏎ |
| 0 | 0 | |
| 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 3 | ||
| 4 | ||
| 5 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 6 | 4 | <head> |
| 7 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 8 | ||
| 9 | <title>Index — pysmb 1.1.18 documentation</title> | |
| 10 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>Index — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | |
| 11 | 9 | <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" /> |
| 12 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | |
| 13 | ||
| 14 | <script type="text/javascript"> | |
| 15 | var DOCUMENTATION_OPTIONS = { | |
| 16 | URL_ROOT: './', | |
| 17 | VERSION: '1.1.18', | |
| 18 | COLLAPSE_INDEX: false, | |
| 19 | FILE_SUFFIX: '.html', | |
| 20 | HAS_SOURCE: true | |
| 21 | }; | |
| 22 | </script> | |
| 23 | <script type="text/javascript" src="_static/jquery.js"></script> | |
| 24 | <script type="text/javascript" src="_static/underscore.js"></script> | |
| 25 | <script type="text/javascript" src="_static/doctools.js"></script> | |
| 26 | <link rel="top" title="pysmb 1.1.18 documentation" href="index.html" /> | |
| 27 | </head> | |
| 28 | <body role="document"> | |
| 10 | <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> | |
| 11 | <script src="_static/jquery.js"></script> | |
| 12 | <script src="_static/underscore.js"></script> | |
| 13 | <script src="_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="#" /> | |
| 15 | <link rel="search" title="Search" href="search.html" /> | |
| 16 | </head><body> | |
| 29 | 17 | <div class="related" role="navigation" aria-label="related navigation"> |
| 30 | 18 | <h3>Navigation</h3> |
| 31 | 19 | <ul> |
| 32 | 20 | <li class="right" style="margin-right: 10px"> |
| 33 | 21 | <a href="#" title="General Index" |
| 34 | 22 | accesskey="I">index</a></li> |
| 35 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 23 | <li class="right" > | |
| 24 | <a href="py-modindex.html" title="Python Module Index" | |
| 25 | >modules</a> |</li> | |
| 26 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 27 | <li class="nav-item nav-item-this"><a href="">Index</a></li> | |
| 36 | 28 | </ul> |
| 37 | </div> | |
| 38 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 39 | <div class="sphinxsidebarwrapper"> | |
| 40 | ||
| 41 | ||
| 42 | ||
| 43 | <div id="searchbox" style="display: none" role="search"> | |
| 44 | <h3>Quick search</h3> | |
| 45 | <form class="search" action="search.html" method="get"> | |
| 46 | <input type="text" name="q" /> | |
| 47 | <input type="submit" value="Go" /> | |
| 48 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 49 | <input type="hidden" name="area" value="default" /> | |
| 50 | </form> | |
| 51 | <p class="searchtip" style="font-size: 90%"> | |
| 52 | Enter search terms or a module, class or function name. | |
| 53 | </p> | |
| 54 | </div> | |
| 55 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 56 | </div> | |
| 57 | </div> | |
| 29 | </div> | |
| 58 | 30 | |
| 59 | 31 | <div class="document"> |
| 60 | 32 | <div class="documentwrapper"> |
| 67 | 39 | <div class="genindex-jumpbox"> |
| 68 | 40 | <a href="#_"><strong>_</strong></a> |
| 69 | 41 | | <a href="#A"><strong>A</strong></a> |
| 42 | | <a href="#B"><strong>B</strong></a> | |
| 70 | 43 | | <a href="#C"><strong>C</strong></a> |
| 71 | 44 | | <a href="#D"><strong>D</strong></a> |
| 72 | 45 | | <a href="#E"><strong>E</strong></a> |
| 74 | 47 | | <a href="#G"><strong>G</strong></a> |
| 75 | 48 | | <a href="#I"><strong>I</strong></a> |
| 76 | 49 | | <a href="#L"><strong>L</strong></a> |
| 50 | | <a href="#M"><strong>M</strong></a> | |
| 77 | 51 | | <a href="#N"><strong>N</strong></a> |
| 78 | 52 | | <a href="#O"><strong>O</strong></a> |
| 79 | 53 | | <a href="#P"><strong>P</strong></a> |
| 86 | 60 | </div> |
| 87 | 61 | <h2 id="_">_</h2> |
| 88 | 62 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 89 | <td style="width: 33%" valign="top"><dl> | |
| 90 | ||
| 91 | <dt><a href="api/nmb_NetBIOS.html#nmb.NetBIOS.NetBIOS.__init__">__init__() (nmb.NetBIOS.NetBIOS method)</a> | |
| 92 | </dt> | |
| 93 | ||
| 94 | <dd><dl> | |
| 95 | ||
| 96 | <dt><a href="api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NBNSProtocol.__init__">(nmb.NetBIOSProtocol.NBNSProtocol method)</a> | |
| 97 | </dt> | |
| 98 | ||
| 99 | ||
| 100 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.__init__">(smb.SMBConnection.SMBConnection method)</a> | |
| 101 | </dt> | |
| 102 | ||
| 103 | ||
| 104 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.__init__">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 105 | </dt> | |
| 106 | ||
| 107 | </dl></dd> | |
| 108 | </dl></td> | |
| 63 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 64 | <li><a href="api/nmb_NetBIOS.html#nmb.NetBIOS.NetBIOS.__init__">__init__() (nmb.NetBIOS.NetBIOS method)</a> | |
| 65 | ||
| 66 | <ul> | |
| 67 | <li><a href="api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NBNSProtocol.__init__">(nmb.NetBIOSProtocol.NBNSProtocol method)</a> | |
| 68 | </li> | |
| 69 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.__init__">(smb.SMBConnection.SMBConnection method)</a> | |
| 70 | </li> | |
| 71 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.__init__">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 72 | </li> | |
| 73 | </ul></li> | |
| 74 | </ul></td> | |
| 109 | 75 | </tr></table> |
| 110 | 76 | |
| 111 | 77 | <h2 id="A">A</h2> |
| 112 | 78 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 113 | <td style="width: 33%" valign="top"><dl> | |
| 114 | ||
| 115 | <dt><a href="api/smb_SharedFile.html#smb.base.SharedFile.alloc_size">alloc_size (smb.base.SharedFile attribute)</a> | |
| 116 | </dt> | |
| 117 | ||
| 118 | </dl></td> | |
| 79 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 80 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.ACE">ACE (class in smb.security_descriptors)</a> | |
| 81 | </li> | |
| 82 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.ACL.aces">aces (smb.security_descriptors.ACL attribute)</a> | |
| 83 | </li> | |
| 84 | </ul></td> | |
| 85 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 86 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.ACL">ACL (class in smb.security_descriptors)</a> | |
| 87 | </li> | |
| 88 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.ACE.additional_data">additional_data (smb.security_descriptors.ACE attribute)</a> | |
| 89 | </li> | |
| 90 | <li><a href="api/smb_SharedFile.html#smb.base.SharedFile.alloc_size">alloc_size (smb.base.SharedFile attribute)</a> | |
| 91 | </li> | |
| 92 | </ul></td> | |
| 93 | </tr></table> | |
| 94 | ||
| 95 | <h2 id="B">B</h2> | |
| 96 | <table style="width: 100%" class="indextable genindextable"><tr> | |
| 97 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 98 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.buildProtocol">buildProtocol() (smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 99 | </li> | |
| 100 | </ul></td> | |
| 119 | 101 | </tr></table> |
| 120 | 102 | |
| 121 | 103 | <h2 id="C">C</h2> |
| 122 | 104 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 123 | <td style="width: 33%" valign="top"><dl> | |
| 124 | ||
| 125 | <dt><a href="api/nmb_NetBIOS.html#nmb.NetBIOS.NetBIOS.close">close() (nmb.NetBIOS.NetBIOS method)</a> | |
| 126 | </dt> | |
| 127 | ||
| 128 | <dd><dl> | |
| 129 | ||
| 130 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.close">(smb.SMBConnection.SMBConnection method)</a> | |
| 131 | </dt> | |
| 132 | ||
| 133 | </dl></dd> | |
| 134 | ||
| 135 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.closeConnection">closeConnection() (smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 136 | </dt> | |
| 137 | ||
| 138 | ||
| 139 | <dt><a href="api/smb_SharedDevice.html#smb.base.SharedDevice.comments">comments (smb.base.SharedDevice attribute)</a> | |
| 140 | </dt> | |
| 141 | ||
| 142 | </dl></td> | |
| 143 | <td style="width: 33%" valign="top"><dl> | |
| 144 | ||
| 145 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.connect">connect() (smb.SMBConnection.SMBConnection method)</a> | |
| 146 | </dt> | |
| 147 | ||
| 148 | ||
| 149 | <dt><a href="api/smb_SharedFile.html#smb.base.SharedFile.create_time">create_time (smb.base.SharedFile attribute)</a> | |
| 150 | </dt> | |
| 151 | ||
| 152 | ||
| 153 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.createDirectory">createDirectory() (smb.SMBConnection.SMBConnection method)</a> | |
| 154 | </dt> | |
| 155 | ||
| 156 | <dd><dl> | |
| 157 | ||
| 158 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.createDirectory">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 159 | </dt> | |
| 160 | ||
| 161 | </dl></dd> | |
| 162 | </dl></td> | |
| 105 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 106 | <li><a href="api/nmb_NetBIOS.html#nmb.NetBIOS.NetBIOS.close">close() (nmb.NetBIOS.NetBIOS method)</a> | |
| 107 | ||
| 108 | <ul> | |
| 109 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.close">(smb.SMBConnection.SMBConnection method)</a> | |
| 110 | </li> | |
| 111 | </ul></li> | |
| 112 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.closeConnection">closeConnection() (smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 113 | </li> | |
| 114 | <li><a href="api/smb_SharedDevice.html#smb.base.SharedDevice.comments">comments (smb.base.SharedDevice attribute)</a> | |
| 115 | </li> | |
| 116 | </ul></td> | |
| 117 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 118 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.connect">connect() (smb.SMBConnection.SMBConnection method)</a> | |
| 119 | </li> | |
| 120 | <li><a href="api/smb_SharedFile.html#smb.base.SharedFile.create_time">create_time (smb.base.SharedFile attribute)</a> | |
| 121 | </li> | |
| 122 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.createDirectory">createDirectory() (smb.SMBConnection.SMBConnection method)</a> | |
| 123 | ||
| 124 | <ul> | |
| 125 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.createDirectory">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 126 | </li> | |
| 127 | </ul></li> | |
| 128 | </ul></td> | |
| 163 | 129 | </tr></table> |
| 164 | 130 | |
| 165 | 131 | <h2 id="D">D</h2> |
| 166 | 132 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 167 | <td style="width: 33%" valign="top"><dl> | |
| 168 | ||
| 169 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.deleteDirectory">deleteDirectory() (smb.SMBConnection.SMBConnection method)</a> | |
| 170 | </dt> | |
| 171 | ||
| 172 | <dd><dl> | |
| 173 | ||
| 174 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.deleteDirectory">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 175 | </dt> | |
| 176 | ||
| 177 | </dl></dd> | |
| 178 | </dl></td> | |
| 179 | <td style="width: 33%" valign="top"><dl> | |
| 180 | ||
| 181 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.deleteFiles">deleteFiles() (smb.SMBConnection.SMBConnection method)</a> | |
| 182 | </dt> | |
| 183 | ||
| 184 | <dd><dl> | |
| 185 | ||
| 186 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.deleteFiles">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 187 | </dt> | |
| 188 | ||
| 189 | </dl></dd> | |
| 190 | </dl></td> | |
| 133 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 134 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.SecurityDescriptor.dacl">dacl (smb.security_descriptors.SecurityDescriptor attribute)</a> | |
| 135 | </li> | |
| 136 | <li><a href="api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NBNSProtocol.datagramReceived">datagramReceived() (nmb.NetBIOSProtocol.NBNSProtocol method)</a> | |
| 137 | </li> | |
| 138 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.deleteDirectory">deleteDirectory() (smb.SMBConnection.SMBConnection method)</a> | |
| 139 | ||
| 140 | <ul> | |
| 141 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.deleteDirectory">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 142 | </li> | |
| 143 | </ul></li> | |
| 144 | </ul></td> | |
| 145 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 146 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.deleteFiles">deleteFiles() (smb.SMBConnection.SMBConnection method)</a> | |
| 147 | ||
| 148 | <ul> | |
| 149 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.deleteFiles">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 150 | </li> | |
| 151 | </ul></li> | |
| 152 | </ul></td> | |
| 191 | 153 | </tr></table> |
| 192 | 154 | |
| 193 | 155 | <h2 id="E">E</h2> |
| 194 | 156 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 195 | <td style="width: 33%" valign="top"><dl> | |
| 196 | ||
| 197 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.echo">echo() (smb.SMBConnection.SMBConnection method)</a> | |
| 198 | </dt> | |
| 199 | ||
| 200 | <dd><dl> | |
| 201 | ||
| 202 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.echo">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 203 | </dt> | |
| 204 | ||
| 205 | </dl></dd> | |
| 206 | </dl></td> | |
| 157 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 158 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.echo">echo() (smb.SMBConnection.SMBConnection method)</a> | |
| 159 | ||
| 160 | <ul> | |
| 161 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.echo">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 162 | </li> | |
| 163 | </ul></li> | |
| 164 | </ul></td> | |
| 207 | 165 | </tr></table> |
| 208 | 166 | |
| 209 | 167 | <h2 id="F">F</h2> |
| 210 | 168 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 211 | <td style="width: 33%" valign="top"><dl> | |
| 212 | ||
| 213 | <dt><a href="api/smb_SharedFile.html#smb.base.SharedFile.file_attributes">file_attributes (smb.base.SharedFile attribute)</a> | |
| 214 | </dt> | |
| 215 | ||
| 216 | ||
| 217 | <dt><a href="api/smb_SharedFile.html#smb.base.SharedFile.file_size">file_size (smb.base.SharedFile attribute)</a> | |
| 218 | </dt> | |
| 219 | ||
| 220 | </dl></td> | |
| 221 | <td style="width: 33%" valign="top"><dl> | |
| 222 | ||
| 223 | <dt><a href="api/smb_SharedFile.html#smb.base.SharedFile.filename">filename (smb.base.SharedFile attribute)</a> | |
| 224 | </dt> | |
| 225 | ||
| 226 | </dl></td> | |
| 169 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 170 | <li><a href="api/smb_SharedFile.html#smb.base.SharedFile.file_attributes">file_attributes (smb.base.SharedFile attribute)</a> | |
| 171 | </li> | |
| 172 | <li><a href="api/smb_SharedFile.html#smb.base.SharedFile.file_id">file_id (smb.base.SharedFile attribute)</a> | |
| 173 | </li> | |
| 174 | <li><a href="api/smb_SharedFile.html#smb.base.SharedFile.file_size">file_size (smb.base.SharedFile attribute)</a> | |
| 175 | </li> | |
| 176 | </ul></td> | |
| 177 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 178 | <li><a href="api/smb_SharedFile.html#smb.base.SharedFile.filename">filename (smb.base.SharedFile attribute)</a> | |
| 179 | </li> | |
| 180 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.ACE.flags">flags (smb.security_descriptors.ACE attribute)</a> | |
| 181 | ||
| 182 | <ul> | |
| 183 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.SecurityDescriptor.flags">(smb.security_descriptors.SecurityDescriptor attribute)</a> | |
| 184 | </li> | |
| 185 | </ul></li> | |
| 186 | </ul></td> | |
| 227 | 187 | </tr></table> |
| 228 | 188 | |
| 229 | 189 | <h2 id="G">G</h2> |
| 230 | 190 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 231 | <td style="width: 33%" valign="top"><dl> | |
| 232 | ||
| 233 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.getAttributes">getAttributes() (smb.SMBConnection.SMBConnection method)</a> | |
| 234 | </dt> | |
| 235 | ||
| 236 | <dd><dl> | |
| 237 | ||
| 238 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.getAttributes">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 239 | </dt> | |
| 240 | ||
| 241 | </dl></dd> | |
| 242 | </dl></td> | |
| 191 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 192 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.getAttributes">getAttributes() (smb.SMBConnection.SMBConnection method)</a> | |
| 193 | ||
| 194 | <ul> | |
| 195 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.getAttributes">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 196 | </li> | |
| 197 | </ul></li> | |
| 198 | </ul></td> | |
| 199 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 200 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.getSecurity">getSecurity() (smb.SMBConnection.SMBConnection method)</a> | |
| 201 | </li> | |
| 202 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.SecurityDescriptor.group">group (smb.security_descriptors.SecurityDescriptor attribute)</a> | |
| 203 | </li> | |
| 204 | </ul></td> | |
| 243 | 205 | </tr></table> |
| 244 | 206 | |
| 245 | 207 | <h2 id="I">I</h2> |
| 246 | 208 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 247 | <td style="width: 33%" valign="top"><dl> | |
| 248 | ||
| 249 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.instance">instance (smb.SMBProtocol.SMBProtocolFactory attribute)</a> | |
| 250 | </dt> | |
| 251 | ||
| 252 | ||
| 253 | <dt><a href="api/smb_SharedFile.html#smb.base.SharedFile.isDirectory">isDirectory (smb.base.SharedFile attribute)</a> | |
| 254 | </dt> | |
| 255 | ||
| 256 | ||
| 257 | <dt><a href="api/smb_SharedFile.html#smb.base.SharedFile.isReadOnly">isReadOnly (smb.base.SharedFile attribute)</a> | |
| 258 | </dt> | |
| 259 | ||
| 260 | ||
| 261 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.isReady">isReady (smb.SMBProtocol.SMBProtocolFactory attribute)</a> | |
| 262 | </dt> | |
| 263 | ||
| 264 | </dl></td> | |
| 265 | <td style="width: 33%" valign="top"><dl> | |
| 266 | ||
| 267 | <dt><a href="api/smb_SharedDevice.html#smb.base.SharedDevice.isSpecial">isSpecial (smb.base.SharedDevice attribute)</a> | |
| 268 | </dt> | |
| 269 | ||
| 270 | ||
| 271 | <dt><a href="api/smb_SharedDevice.html#smb.base.SharedDevice.isTemporary">isTemporary (smb.base.SharedDevice attribute)</a> | |
| 272 | </dt> | |
| 273 | ||
| 274 | ||
| 275 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.isUsingSMB2">isUsingSMB2 (smb.SMBConnection.SMBConnection attribute)</a> | |
| 276 | </dt> | |
| 277 | ||
| 278 | <dd><dl> | |
| 279 | ||
| 280 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.isUsingSMB2">(smb.SMBProtocol.SMBProtocolFactory attribute)</a> | |
| 281 | </dt> | |
| 282 | ||
| 283 | </dl></dd> | |
| 284 | </dl></td> | |
| 209 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 210 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.SID.identifier_authority">identifier_authority (smb.security_descriptors.SID attribute)</a> | |
| 211 | </li> | |
| 212 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.instance">instance (smb.SMBProtocol.SMBProtocolFactory attribute)</a> | |
| 213 | </li> | |
| 214 | <li><a href="api/smb_SharedFile.html#smb.base.SharedFile.isDirectory">isDirectory() (smb.base.SharedFile property)</a> | |
| 215 | </li> | |
| 216 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.ACE.isInheritOnly">isInheritOnly() (smb.security_descriptors.ACE property)</a> | |
| 217 | </li> | |
| 218 | <li><a href="api/smb_SharedFile.html#smb.base.SharedFile.isNormal">isNormal() (smb.base.SharedFile property)</a> | |
| 219 | </li> | |
| 220 | </ul></td> | |
| 221 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 222 | <li><a href="api/smb_SharedFile.html#smb.base.SharedFile.isReadOnly">isReadOnly() (smb.base.SharedFile property)</a> | |
| 223 | </li> | |
| 224 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.isReady">isReady() (smb.SMBProtocol.SMBProtocolFactory property)</a> | |
| 225 | </li> | |
| 226 | <li><a href="api/smb_SharedDevice.html#smb.base.SharedDevice.isSpecial">isSpecial() (smb.base.SharedDevice property)</a> | |
| 227 | </li> | |
| 228 | <li><a href="api/smb_SharedDevice.html#smb.base.SharedDevice.isTemporary">isTemporary() (smb.base.SharedDevice property)</a> | |
| 229 | </li> | |
| 230 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.isUsingSMB2">isUsingSMB2() (smb.SMBConnection.SMBConnection property)</a> | |
| 231 | ||
| 232 | <ul> | |
| 233 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.isUsingSMB2">(smb.SMBProtocol.SMBProtocolFactory property)</a> | |
| 234 | </li> | |
| 235 | </ul></li> | |
| 236 | </ul></td> | |
| 285 | 237 | </tr></table> |
| 286 | 238 | |
| 287 | 239 | <h2 id="L">L</h2> |
| 288 | 240 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 289 | <td style="width: 33%" valign="top"><dl> | |
| 290 | ||
| 291 | <dt><a href="api/smb_SharedFile.html#smb.base.SharedFile.last_access_time">last_access_time (smb.base.SharedFile attribute)</a> | |
| 292 | </dt> | |
| 293 | ||
| 294 | ||
| 295 | <dt><a href="api/smb_SharedFile.html#smb.base.SharedFile.last_attr_change_time">last_attr_change_time (smb.base.SharedFile attribute)</a> | |
| 296 | </dt> | |
| 297 | ||
| 298 | ||
| 299 | <dt><a href="api/smb_SharedFile.html#smb.base.SharedFile.last_write_time">last_write_time (smb.base.SharedFile attribute)</a> | |
| 300 | </dt> | |
| 301 | ||
| 302 | </dl></td> | |
| 303 | <td style="width: 33%" valign="top"><dl> | |
| 304 | ||
| 305 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.listPath">listPath() (smb.SMBConnection.SMBConnection method)</a> | |
| 306 | </dt> | |
| 307 | ||
| 308 | <dd><dl> | |
| 309 | ||
| 310 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.listPath">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 311 | </dt> | |
| 312 | ||
| 313 | </dl></dd> | |
| 314 | ||
| 315 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.listShares">listShares() (smb.SMBConnection.SMBConnection method)</a> | |
| 316 | </dt> | |
| 317 | ||
| 318 | <dd><dl> | |
| 319 | ||
| 320 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.listShares">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 321 | </dt> | |
| 322 | ||
| 323 | </dl></dd> | |
| 324 | ||
| 325 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.listSnapshots">listSnapshots() (smb.SMBConnection.SMBConnection method)</a> | |
| 326 | </dt> | |
| 327 | ||
| 328 | <dd><dl> | |
| 329 | ||
| 330 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.listSnapshots">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 331 | </dt> | |
| 332 | ||
| 333 | </dl></dd> | |
| 334 | </dl></td> | |
| 241 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 242 | <li><a href="api/smb_SharedFile.html#smb.base.SharedFile.last_access_time">last_access_time (smb.base.SharedFile attribute)</a> | |
| 243 | </li> | |
| 244 | <li><a href="api/smb_SharedFile.html#smb.base.SharedFile.last_attr_change_time">last_attr_change_time (smb.base.SharedFile attribute)</a> | |
| 245 | </li> | |
| 246 | <li><a href="api/smb_SharedFile.html#smb.base.SharedFile.last_write_time">last_write_time (smb.base.SharedFile attribute)</a> | |
| 247 | </li> | |
| 248 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.listPath">listPath() (smb.SMBConnection.SMBConnection method)</a> | |
| 249 | ||
| 250 | <ul> | |
| 251 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.listPath">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 252 | </li> | |
| 253 | </ul></li> | |
| 254 | </ul></td> | |
| 255 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 256 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.listShares">listShares() (smb.SMBConnection.SMBConnection method)</a> | |
| 257 | ||
| 258 | <ul> | |
| 259 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.listShares">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 260 | </li> | |
| 261 | </ul></li> | |
| 262 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.listSnapshots">listSnapshots() (smb.SMBConnection.SMBConnection method)</a> | |
| 263 | ||
| 264 | <ul> | |
| 265 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.listSnapshots">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 266 | </li> | |
| 267 | </ul></li> | |
| 268 | </ul></td> | |
| 269 | </tr></table> | |
| 270 | ||
| 271 | <h2 id="M">M</h2> | |
| 272 | <table style="width: 100%" class="indextable genindextable"><tr> | |
| 273 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 274 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.ACE.mask">mask (smb.security_descriptors.ACE attribute)</a> | |
| 275 | </li> | |
| 276 | </ul></td> | |
| 277 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 278 | <li> | |
| 279 | module | |
| 280 | ||
| 281 | <ul> | |
| 282 | <li><a href="api/smb_security_descriptors.html#module-smb.security_descriptors">smb.security_descriptors</a> | |
| 283 | </li> | |
| 284 | </ul></li> | |
| 285 | </ul></td> | |
| 335 | 286 | </tr></table> |
| 336 | 287 | |
| 337 | 288 | <h2 id="N">N</h2> |
| 338 | 289 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 339 | <td style="width: 33%" valign="top"><dl> | |
| 340 | ||
| 341 | <dt><a href="api/smb_SharedDevice.html#smb.base.SharedDevice.name">name (smb.base.SharedDevice attribute)</a> | |
| 342 | </dt> | |
| 343 | ||
| 344 | ||
| 345 | <dt><a href="api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NBNSProtocol">NBNSProtocol (class in nmb.NetBIOSProtocol)</a> | |
| 346 | </dt> | |
| 347 | ||
| 348 | ||
| 349 | <dt><a href="api/nmb_NetBIOS.html#nmb.NetBIOS.NetBIOS">NetBIOS (class in nmb.NetBIOS)</a> | |
| 350 | </dt> | |
| 351 | ||
| 352 | </dl></td> | |
| 353 | <td style="width: 33%" valign="top"><dl> | |
| 354 | ||
| 355 | <dt><a href="api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NetBIOSTimeout">NetBIOSTimeout (class in nmb.NetBIOSProtocol)</a> | |
| 356 | </dt> | |
| 357 | ||
| 358 | ||
| 359 | <dt><a href="api/smb_exceptions.html#smb.base.NotConnectedError">NotConnectedError (class in smb.base)</a> | |
| 360 | </dt> | |
| 361 | ||
| 362 | ||
| 363 | <dt><a href="api/smb_exceptions.html#smb.base.NotReadyError">NotReadyError (class in smb.base)</a> | |
| 364 | </dt> | |
| 365 | ||
| 366 | </dl></td> | |
| 290 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 291 | <li><a href="api/smb_SharedDevice.html#smb.base.SharedDevice.name">name (smb.base.SharedDevice attribute)</a> | |
| 292 | </li> | |
| 293 | <li><a href="api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NBNSProtocol">NBNSProtocol (class in nmb.NetBIOSProtocol)</a> | |
| 294 | </li> | |
| 295 | <li><a href="api/nmb_NetBIOS.html#nmb.NetBIOS.NetBIOS">NetBIOS (class in nmb.NetBIOS)</a> | |
| 296 | </li> | |
| 297 | </ul></td> | |
| 298 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 299 | <li><a href="api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NetBIOSTimeout">NetBIOSTimeout (class in nmb.NetBIOSProtocol)</a> | |
| 300 | </li> | |
| 301 | <li><a href="api/smb_exceptions.html#smb.base.NotConnectedError">NotConnectedError (class in smb.base)</a> | |
| 302 | </li> | |
| 303 | <li><a href="api/smb_exceptions.html#smb.base.NotReadyError">NotReadyError (class in smb.base)</a> | |
| 304 | </li> | |
| 305 | </ul></td> | |
| 367 | 306 | </tr></table> |
| 368 | 307 | |
| 369 | 308 | <h2 id="O">O</h2> |
| 370 | 309 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 371 | <td style="width: 33%" valign="top"><dl> | |
| 372 | ||
| 373 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.onAuthFailed">onAuthFailed() (smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 374 | </dt> | |
| 375 | ||
| 376 | ||
| 377 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.onAuthOK">onAuthOK() (smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 378 | </dt> | |
| 379 | ||
| 380 | </dl></td> | |
| 381 | <td style="width: 33%" valign="top"><dl> | |
| 382 | ||
| 383 | <dt><a href="api/smb_exceptions.html#smb.smb_structs.OperationFailure">OperationFailure (class in smb.smb_structs)</a> | |
| 384 | </dt> | |
| 385 | ||
| 386 | </dl></td> | |
| 310 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 311 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.onAuthFailed">onAuthFailed() (smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 312 | </li> | |
| 313 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.onAuthOK">onAuthOK() (smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 314 | </li> | |
| 315 | </ul></td> | |
| 316 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 317 | <li><a href="api/smb_exceptions.html#smb.smb_structs.OperationFailure">OperationFailure (class in smb.smb_structs)</a> | |
| 318 | </li> | |
| 319 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.SecurityDescriptor.owner">owner (smb.security_descriptors.SecurityDescriptor attribute)</a> | |
| 320 | </li> | |
| 321 | </ul></td> | |
| 387 | 322 | </tr></table> |
| 388 | 323 | |
| 389 | 324 | <h2 id="P">P</h2> |
| 390 | 325 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 391 | <td style="width: 33%" valign="top"><dl> | |
| 392 | ||
| 393 | <dt><a href="api/smb_exceptions.html#smb.smb_structs.ProtocolError">ProtocolError (class in smb.smb_structs)</a> | |
| 394 | </dt> | |
| 395 | ||
| 396 | </dl></td> | |
| 326 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 327 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.protocol">protocol (smb.SMBProtocol.SMBProtocolFactory attribute)</a> | |
| 328 | </li> | |
| 329 | </ul></td> | |
| 330 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 331 | <li><a href="api/smb_exceptions.html#smb.smb_structs.ProtocolError">ProtocolError (class in smb.smb_structs)</a> | |
| 332 | </li> | |
| 333 | </ul></td> | |
| 397 | 334 | </tr></table> |
| 398 | 335 | |
| 399 | 336 | <h2 id="Q">Q</h2> |
| 400 | 337 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 401 | <td style="width: 33%" valign="top"><dl> | |
| 402 | ||
| 403 | <dt><a href="api/nmb_NetBIOS.html#nmb.NetBIOS.NetBIOS.queryIPForName">queryIPForName() (nmb.NetBIOS.NetBIOS method)</a> | |
| 404 | </dt> | |
| 405 | ||
| 406 | <dd><dl> | |
| 407 | ||
| 408 | <dt><a href="api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NBNSProtocol.queryIPForName">(nmb.NetBIOSProtocol.NBNSProtocol method)</a> | |
| 409 | </dt> | |
| 410 | ||
| 411 | </dl></dd> | |
| 412 | </dl></td> | |
| 413 | <td style="width: 33%" valign="top"><dl> | |
| 414 | ||
| 415 | <dt><a href="api/nmb_NetBIOS.html#nmb.NetBIOS.NetBIOS.queryName">queryName() (nmb.NetBIOS.NetBIOS method)</a> | |
| 416 | </dt> | |
| 417 | ||
| 418 | <dd><dl> | |
| 419 | ||
| 420 | <dt><a href="api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NBNSProtocol.queryName">(nmb.NetBIOSProtocol.NBNSProtocol method)</a> | |
| 421 | </dt> | |
| 422 | ||
| 423 | </dl></dd> | |
| 424 | </dl></td> | |
| 338 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 339 | <li><a href="api/nmb_NetBIOS.html#nmb.NetBIOS.NetBIOS.queryIPForName">queryIPForName() (nmb.NetBIOS.NetBIOS method)</a> | |
| 340 | ||
| 341 | <ul> | |
| 342 | <li><a href="api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NBNSProtocol.queryIPForName">(nmb.NetBIOSProtocol.NBNSProtocol method)</a> | |
| 343 | </li> | |
| 344 | </ul></li> | |
| 345 | </ul></td> | |
| 346 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 347 | <li><a href="api/nmb_NetBIOS.html#nmb.NetBIOS.NetBIOS.queryName">queryName() (nmb.NetBIOS.NetBIOS method)</a> | |
| 348 | ||
| 349 | <ul> | |
| 350 | <li><a href="api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NBNSProtocol.queryName">(nmb.NetBIOSProtocol.NBNSProtocol method)</a> | |
| 351 | </li> | |
| 352 | </ul></li> | |
| 353 | </ul></td> | |
| 425 | 354 | </tr></table> |
| 426 | 355 | |
| 427 | 356 | <h2 id="R">R</h2> |
| 428 | 357 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 429 | <td style="width: 33%" valign="top"><dl> | |
| 430 | ||
| 431 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.rename">rename() (smb.SMBConnection.SMBConnection method)</a> | |
| 432 | </dt> | |
| 433 | ||
| 434 | <dd><dl> | |
| 435 | ||
| 436 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.rename">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 437 | </dt> | |
| 438 | ||
| 439 | </dl></dd> | |
| 440 | ||
| 441 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.resetFileAttributes">resetFileAttributes() (smb.SMBConnection.SMBConnection method)</a> | |
| 442 | </dt> | |
| 443 | ||
| 444 | </dl></td> | |
| 445 | <td style="width: 33%" valign="top"><dl> | |
| 446 | ||
| 447 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.retrieveFile">retrieveFile() (smb.SMBConnection.SMBConnection method)</a> | |
| 448 | </dt> | |
| 449 | ||
| 450 | <dd><dl> | |
| 451 | ||
| 452 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.retrieveFile">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 453 | </dt> | |
| 454 | ||
| 455 | </dl></dd> | |
| 456 | ||
| 457 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.retrieveFileFromOffset">retrieveFileFromOffset() (smb.SMBConnection.SMBConnection method)</a> | |
| 458 | </dt> | |
| 459 | ||
| 460 | <dd><dl> | |
| 461 | ||
| 462 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.retrieveFileFromOffset">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 463 | </dt> | |
| 464 | ||
| 465 | </dl></dd> | |
| 466 | </dl></td> | |
| 358 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 359 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.rename">rename() (smb.SMBConnection.SMBConnection method)</a> | |
| 360 | ||
| 361 | <ul> | |
| 362 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.rename">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 363 | </li> | |
| 364 | </ul></li> | |
| 365 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.resetFileAttributes">resetFileAttributes() (smb.SMBConnection.SMBConnection method)</a> | |
| 366 | </li> | |
| 367 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.retrieveFile">retrieveFile() (smb.SMBConnection.SMBConnection method)</a> | |
| 368 | ||
| 369 | <ul> | |
| 370 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.retrieveFile">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 371 | </li> | |
| 372 | </ul></li> | |
| 373 | </ul></td> | |
| 374 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 375 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.retrieveFileFromOffset">retrieveFileFromOffset() (smb.SMBConnection.SMBConnection method)</a> | |
| 376 | ||
| 377 | <ul> | |
| 378 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.retrieveFileFromOffset">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 379 | </li> | |
| 380 | </ul></li> | |
| 381 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.ACL.revision">revision (smb.security_descriptors.ACL attribute)</a> | |
| 382 | ||
| 383 | <ul> | |
| 384 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.SID.revision">(smb.security_descriptors.SID attribute)</a> | |
| 385 | </li> | |
| 386 | </ul></li> | |
| 387 | </ul></td> | |
| 467 | 388 | </tr></table> |
| 468 | 389 | |
| 469 | 390 | <h2 id="S">S</h2> |
| 470 | 391 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 471 | <td style="width: 33%" valign="top"><dl> | |
| 472 | ||
| 473 | <dt><a href="api/smb_SharedDevice.html#smb.base.SharedDevice">SharedDevice (class in smb.base)</a> | |
| 474 | </dt> | |
| 475 | ||
| 476 | ||
| 477 | <dt><a href="api/smb_SharedFile.html#smb.base.SharedFile">SharedFile (class in smb.base)</a> | |
| 478 | </dt> | |
| 479 | ||
| 480 | ||
| 481 | <dt><a href="api/smb_SharedFile.html#smb.base.SharedFile.short_name">short_name (smb.base.SharedFile attribute)</a> | |
| 482 | </dt> | |
| 483 | ||
| 484 | ||
| 485 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.SIGN_NEVER">SIGN_NEVER (smb.SMBConnection.SMBConnection attribute)</a> | |
| 486 | </dt> | |
| 487 | ||
| 488 | <dd><dl> | |
| 489 | ||
| 490 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.SIGN_NEVER">(smb.SMBProtocol.SMBProtocolFactory attribute)</a> | |
| 491 | </dt> | |
| 492 | ||
| 493 | </dl></dd> | |
| 494 | ||
| 495 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.SIGN_WHEN_REQUIRED">SIGN_WHEN_REQUIRED (smb.SMBConnection.SMBConnection attribute)</a> | |
| 496 | </dt> | |
| 497 | ||
| 498 | <dd><dl> | |
| 499 | ||
| 500 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.SIGN_WHEN_REQUIRED">(smb.SMBProtocol.SMBProtocolFactory attribute)</a> | |
| 501 | </dt> | |
| 502 | ||
| 503 | </dl></dd> | |
| 504 | ||
| 505 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.SIGN_WHEN_SUPPORTED">SIGN_WHEN_SUPPORTED (smb.SMBConnection.SMBConnection attribute)</a> | |
| 506 | </dt> | |
| 507 | ||
| 508 | <dd><dl> | |
| 509 | ||
| 510 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.SIGN_WHEN_SUPPORTED">(smb.SMBProtocol.SMBProtocolFactory attribute)</a> | |
| 511 | </dt> | |
| 512 | ||
| 513 | </dl></dd> | |
| 514 | </dl></td> | |
| 515 | <td style="width: 33%" valign="top"><dl> | |
| 516 | ||
| 517 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection">SMBConnection (class in smb.SMBConnection)</a> | |
| 518 | </dt> | |
| 519 | ||
| 520 | ||
| 521 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory">SMBProtocolFactory (class in smb.SMBProtocol)</a> | |
| 522 | </dt> | |
| 523 | ||
| 524 | ||
| 525 | <dt><a href="api/smb_exceptions.html#smb.base.SMBTimeout">SMBTimeout (class in smb.base)</a> | |
| 526 | </dt> | |
| 527 | ||
| 528 | ||
| 529 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.storeFile">storeFile() (smb.SMBConnection.SMBConnection method)</a> | |
| 530 | </dt> | |
| 531 | ||
| 532 | <dd><dl> | |
| 533 | ||
| 534 | <dt><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.storeFile">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 535 | </dt> | |
| 536 | ||
| 537 | </dl></dd> | |
| 538 | ||
| 539 | <dt><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.storeFileFromOffset">storeFileFromOffset() (smb.SMBConnection.SMBConnection method)</a> | |
| 540 | </dt> | |
| 541 | ||
| 542 | </dl></td> | |
| 392 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 393 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.SecurityDescriptor.sacl">sacl (smb.security_descriptors.SecurityDescriptor attribute)</a> | |
| 394 | </li> | |
| 395 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.SecurityDescriptor">SecurityDescriptor (class in smb.security_descriptors)</a> | |
| 396 | </li> | |
| 397 | <li><a href="api/smb_SharedDevice.html#smb.base.SharedDevice">SharedDevice (class in smb.base)</a> | |
| 398 | </li> | |
| 399 | <li><a href="api/smb_SharedFile.html#smb.base.SharedFile">SharedFile (class in smb.base)</a> | |
| 400 | </li> | |
| 401 | <li><a href="api/smb_SharedFile.html#smb.base.SharedFile.short_name">short_name (smb.base.SharedFile attribute)</a> | |
| 402 | </li> | |
| 403 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.SID">SID (class in smb.security_descriptors)</a> | |
| 404 | </li> | |
| 405 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.ACE.sid">sid (smb.security_descriptors.ACE attribute)</a> | |
| 406 | </li> | |
| 407 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.SIGN_NEVER">SIGN_NEVER (smb.SMBConnection.SMBConnection attribute)</a> | |
| 408 | ||
| 409 | <ul> | |
| 410 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.SIGN_NEVER">(smb.SMBProtocol.SMBProtocolFactory attribute)</a> | |
| 411 | </li> | |
| 412 | </ul></li> | |
| 413 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.SIGN_WHEN_REQUIRED">SIGN_WHEN_REQUIRED (smb.SMBConnection.SMBConnection attribute)</a> | |
| 414 | ||
| 415 | <ul> | |
| 416 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.SIGN_WHEN_REQUIRED">(smb.SMBProtocol.SMBProtocolFactory attribute)</a> | |
| 417 | </li> | |
| 418 | </ul></li> | |
| 419 | </ul></td> | |
| 420 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 421 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.SIGN_WHEN_SUPPORTED">SIGN_WHEN_SUPPORTED (smb.SMBConnection.SMBConnection attribute)</a> | |
| 422 | ||
| 423 | <ul> | |
| 424 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.SIGN_WHEN_SUPPORTED">(smb.SMBProtocol.SMBProtocolFactory attribute)</a> | |
| 425 | </li> | |
| 426 | </ul></li> | |
| 427 | <li> | |
| 428 | smb.security_descriptors | |
| 429 | ||
| 430 | <ul> | |
| 431 | <li><a href="api/smb_security_descriptors.html#module-smb.security_descriptors">module</a> | |
| 432 | </li> | |
| 433 | </ul></li> | |
| 434 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection">SMBConnection (class in smb.SMBConnection)</a> | |
| 435 | </li> | |
| 436 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory">SMBProtocolFactory (class in smb.SMBProtocol)</a> | |
| 437 | </li> | |
| 438 | <li><a href="api/smb_exceptions.html#smb.base.SMBTimeout">SMBTimeout (class in smb.base)</a> | |
| 439 | </li> | |
| 440 | <li><a href="api/nmb_NBNSProtocol.html#nmb.NetBIOSProtocol.NBNSProtocol.stopProtocol">stopProtocol() (nmb.NetBIOSProtocol.NBNSProtocol method)</a> | |
| 441 | </li> | |
| 442 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.storeFile">storeFile() (smb.SMBConnection.SMBConnection method)</a> | |
| 443 | ||
| 444 | <ul> | |
| 445 | <li><a href="api/smb_SMBProtocolFactory.html#smb.SMBProtocol.SMBProtocolFactory.storeFile">(smb.SMBProtocol.SMBProtocolFactory method)</a> | |
| 446 | </li> | |
| 447 | </ul></li> | |
| 448 | <li><a href="api/smb_SMBConnection.html#smb.SMBConnection.SMBConnection.storeFileFromOffset">storeFileFromOffset() (smb.SMBConnection.SMBConnection method)</a> | |
| 449 | </li> | |
| 450 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.SID.subauthorities">subauthorities (smb.security_descriptors.SID attribute)</a> | |
| 451 | </li> | |
| 452 | </ul></td> | |
| 543 | 453 | </tr></table> |
| 544 | 454 | |
| 545 | 455 | <h2 id="T">T</h2> |
| 546 | 456 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 547 | <td style="width: 33%" valign="top"><dl> | |
| 548 | ||
| 549 | <dt><a href="api/smb_SharedDevice.html#smb.base.SharedDevice.type">type (smb.base.SharedDevice attribute)</a> | |
| 550 | </dt> | |
| 551 | ||
| 552 | </dl></td> | |
| 457 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 458 | <li><a href="api/smb_security_descriptors.html#smb.security_descriptors.ACE.type">type (smb.security_descriptors.ACE attribute)</a> | |
| 459 | </li> | |
| 460 | </ul></td> | |
| 461 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 462 | <li><a href="api/smb_SharedDevice.html#smb.base.SharedDevice.type">type() (smb.base.SharedDevice property)</a> | |
| 463 | </li> | |
| 464 | </ul></td> | |
| 553 | 465 | </tr></table> |
| 554 | 466 | |
| 555 | 467 | <h2 id="U">U</h2> |
| 556 | 468 | <table style="width: 100%" class="indextable genindextable"><tr> |
| 557 | <td style="width: 33%" valign="top"><dl> | |
| 558 | ||
| 559 | <dt><a href="api/smb_exceptions.html#smb.smb_structs.UnsupportedFeature">UnsupportedFeature (class in smb.smb_structs)</a> | |
| 560 | </dt> | |
| 561 | ||
| 562 | </dl></td> | |
| 563 | </tr></table> | |
| 564 | ||
| 565 | ||
| 566 | ||
| 469 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 470 | <li><a href="api/smb_exceptions.html#smb.smb_structs.UnsupportedFeature">UnsupportedFeature (class in smb.smb_structs)</a> | |
| 471 | </li> | |
| 472 | </ul></td> | |
| 473 | </tr></table> | |
| 474 | ||
| 475 | ||
| 476 | ||
| 477 | <div class="clearer"></div> | |
| 567 | 478 | </div> |
| 479 | </div> | |
| 480 | </div> | |
| 481 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 482 | <div class="sphinxsidebarwrapper"> | |
| 483 | <div id="searchbox" style="display: none" role="search"> | |
| 484 | <h3 id="searchlabel">Quick search</h3> | |
| 485 | <div class="searchformwrapper"> | |
| 486 | <form class="search" action="search.html" method="get"> | |
| 487 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 488 | <input type="submit" value="Go" /> | |
| 489 | </form> | |
| 490 | </div> | |
| 491 | </div> | |
| 492 | <script>$('#searchbox').show(0);</script> | |
| 568 | 493 | </div> |
| 569 | 494 | </div> |
| 570 | 495 | <div class="clearer"></div> |
| 575 | 500 | <li class="right" style="margin-right: 10px"> |
| 576 | 501 | <a href="#" title="General Index" |
| 577 | 502 | >index</a></li> |
| 578 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 503 | <li class="right" > | |
| 504 | <a href="py-modindex.html" title="Python Module Index" | |
| 505 | >modules</a> |</li> | |
| 506 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 507 | <li class="nav-item nav-item-this"><a href="">Index</a></li> | |
| 579 | 508 | </ul> |
| 580 | 509 | </div> |
| 581 | 510 | <div class="footer" role="contentinfo"> |
| 582 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 583 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 511 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 512 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 584 | 513 | </div> |
| 585 | 514 | </body> |
| 586 | 515 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | ||
| 3 | ||
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 0 | ||
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 7 | ||
| 8 | <title>Welcome to pysmb’s documentation! — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>Welcome to pysmb’s documentation! — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | |
| 10 | 9 | <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" /> |
| 11 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: './', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="_static/doctools.js"></script> | |
| 25 | <link rel="top" title="pysmb 1.1.18 documentation" href="#" /> | |
| 10 | <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> | |
| 11 | <script src="_static/jquery.js"></script> | |
| 12 | <script src="_static/underscore.js"></script> | |
| 13 | <script src="_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="search.html" /> | |
| 26 | 16 | <link rel="next" title="NBNSProtocol Class" href="api/nmb_NBNSProtocol.html" /> |
| 27 | </head> | |
| 28 | <body role="document"> | |
| 17 | </head><body> | |
| 29 | 18 | <div class="related" role="navigation" aria-label="related navigation"> |
| 30 | 19 | <h3>Navigation</h3> |
| 31 | 20 | <ul> |
| 33 | 22 | <a href="genindex.html" title="General Index" |
| 34 | 23 | accesskey="I">index</a></li> |
| 35 | 24 | <li class="right" > |
| 25 | <a href="py-modindex.html" title="Python Module Index" | |
| 26 | >modules</a> |</li> | |
| 27 | <li class="right" > | |
| 36 | 28 | <a href="api/nmb_NBNSProtocol.html" title="NBNSProtocol Class" |
| 37 | 29 | accesskey="N">next</a> |</li> |
| 38 | <li class="nav-item nav-item-0"><a href="#">pysmb 1.1.18 documentation</a> »</li> | |
| 30 | <li class="nav-item nav-item-0"><a href="#">pysmb 1.2.7 documentation</a> »</li> | |
| 31 | <li class="nav-item nav-item-this"><a href="">Welcome to pysmb’s documentation!</a></li> | |
| 39 | 32 | </ul> |
| 40 | </div> | |
| 41 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 42 | <div class="sphinxsidebarwrapper"> | |
| 43 | <h3><a href="#">Table Of Contents</a></h3> | |
| 44 | <ul> | |
| 45 | <li><a class="reference internal" href="#">Welcome to pysmb’s documentation!</a><ul> | |
| 46 | <li><a class="reference internal" href="#license">License</a></li> | |
| 47 | <li><a class="reference internal" href="#credits">Credits</a></li> | |
| 48 | </ul> | |
| 49 | </li> | |
| 50 | <li><a class="reference internal" href="#package-contents-and-description">Package Contents and Description</a></li> | |
| 51 | <li><a class="reference internal" href="#using-pysmb">Using pysmb</a></li> | |
| 52 | <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li> | |
| 53 | </ul> | |
| 54 | ||
| 55 | <h4>Next topic</h4> | |
| 56 | <p class="topless"><a href="api/nmb_NBNSProtocol.html" | |
| 57 | title="next chapter">NBNSProtocol Class</a></p> | |
| 58 | <div role="note" aria-label="source link"> | |
| 59 | <h3>This Page</h3> | |
| 60 | <ul class="this-page-menu"> | |
| 61 | <li><a href="_sources/index.txt" | |
| 62 | rel="nofollow">Show Source</a></li> | |
| 63 | </ul> | |
| 64 | </div> | |
| 65 | <div id="searchbox" style="display: none" role="search"> | |
| 66 | <h3>Quick search</h3> | |
| 67 | <form class="search" action="search.html" method="get"> | |
| 68 | <input type="text" name="q" /> | |
| 69 | <input type="submit" value="Go" /> | |
| 70 | <input type="hidden" name="check_keywords" value="yes" /> | |
| 71 | <input type="hidden" name="area" value="default" /> | |
| 72 | </form> | |
| 73 | <p class="searchtip" style="font-size: 90%"> | |
| 74 | Enter search terms or a module, class or function name. | |
| 75 | </p> | |
| 76 | </div> | |
| 77 | <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 78 | </div> | |
| 79 | </div> | |
| 33 | </div> | |
| 80 | 34 | |
| 81 | 35 | <div class="document"> |
| 82 | 36 | <div class="documentwrapper"> |
| 84 | 38 | <div class="body" role="main"> |
| 85 | 39 | |
| 86 | 40 | <div class="section" id="welcome-to-pysmb-s-documentation"> |
| 87 | <h1>Welcome to pysmb’s documentation!<a class="headerlink" href="#welcome-to-pysmb-s-documentation" title="Permalink to this headline">¶</a></h1> | |
| 41 | <h1>Welcome to pysmb’s documentation!<a class="headerlink" href="#welcome-to-pysmb-s-documentation" title="Permalink to this headline">¶</a></h1> | |
| 88 | 42 | <p>pysmb is a pure Python implementation of the client-side SMB/CIFS protocol (SMB1 and SMB2) which is the underlying protocol |
| 89 | 43 | that facilitates file sharing and printing between Windows machines, as well as with Linux machines via the Samba server application. |
| 90 | 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.</p> | |
| 91 | <p>The latest version of pysmb is always available at the pysmb project page at <a class="reference external" href="http://miketeo.net/wp/index.php/projects/pysmb">miketeo.net</a>.</p> | |
| 44 | pysmb is developed in Python 2.7.x and Python 3.8.x and has been tested against shared folders on Windows 7, Windows 10 and Samba 4.x.</p> | |
| 45 | <p>The latest version of pysmb is always available at the pysmb project page at <a class="reference external" href="http://miketeo.net/projects/pysmb">miketeo.net</a>.</p> | |
| 92 | 46 | <div class="section" id="license"> |
| 93 | 47 | <h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2> |
| 94 | 48 | <p>pysmb itself is licensed under an opensource license. |
| 102 | 56 | <h2>Credits<a class="headerlink" href="#credits" title="Permalink to this headline">¶</a></h2> |
| 103 | 57 | <p>pysmb is not alone. It is made possible with support from other modules.</p> |
| 104 | 58 | <ul class="simple"> |
| 105 | <li><strong>pyasn1</strong> : Pure Python implementation of ASN.1 parsing and encoding (not included together with pysmb; needs to be installed separately)</li> | |
| 106 | <li><strong>md4</strong> and <strong>U32</strong> : Pure Python implementation of MD4 hashing algorithm and 32-bit unsigned integer by Dmitry Rozmanov. Licensed under LGPL and included together with pysmb.</li> | |
| 107 | <li><strong>pyDes</strong> : Pure Python implementation of the DES encryption algorithm by Todd Whiteman. Free domain and included together with pysmb.</li> | |
| 108 | <li><strong>sha256</strong> : 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 | |
| 109 | the Python standard library (usually Python 2.4) does not provide the SHA-256 hash algorithm.</li> | |
| 59 | <li><p><strong>pyasn1</strong> : Pure Python implementation of ASN.1 parsing and encoding (not included together with pysmb; needs to be installed separately)</p></li> | |
| 60 | <li><p><strong>md4</strong> and <strong>U32</strong> : Pure Python implementation of MD4 hashing algorithm and 32-bit unsigned integer by Dmitry Rozmanov. Licensed under LGPL and included together with pysmb.</p></li> | |
| 61 | <li><p><strong>pyDes</strong> : Pure Python implementation of the DES encryption algorithm by Todd Whiteman. Free domain and included together with pysmb.</p></li> | |
| 62 | <li><p><strong>sha256</strong> : 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 | |
| 63 | the Python standard library (usually Python 2.4) does not provide the SHA-256 hash algorithm.</p></li> | |
| 110 | 64 | </ul> |
| 111 | 65 | <p>In various places, there are references to different specifications. Most of these referenced specifications |
| 112 | can be downloaded from Microsoft web site under Microsoft’s “Open Specification Promise”. If you need to download | |
| 113 | a copy of these specifications, please google for it. For example, google for “MS-CIFS” to download the CIFS specification for NT LM dialect.</p> | |
| 66 | can be downloaded from Microsoft web site under Microsoft’s “Open Specification Promise”. If you need to download | |
| 67 | a copy of these specifications, please google for it. For example, google for “MS-CIFS” to download the CIFS specification for NT LM dialect.</p> | |
| 114 | 68 | </div> |
| 115 | 69 | </div> |
| 116 | 70 | <div class="section" id="package-contents-and-description"> |
| 120 | 74 | As an application developer, you will be importing this module into your application. |
| 121 | 75 | Hence, please take some time to familiarize yourself with the smb package contents.</p> |
| 122 | 76 | <ul class="simple"> |
| 123 | <li><strong>nmb/base.py</strong> : | |
| 77 | <li><p><strong>nmb/base.py</strong> : | |
| 124 | 78 | Contains the NetBIOSSession and NBNS abstract class which implements NetBIOS session and NetBIOS Name Service communication |
| 125 | without any network transport specifics.</li> | |
| 126 | <li><strong>nmb/NetBIOS.py</strong>: | |
| 127 | Provides a NBNS implementation to query IP addresses for machine names. All operations are blocking I/O.</li> | |
| 128 | <li><strong>nmb/NetBIOSProtocol.py</strong> : | |
| 129 | Provides the NBNS protocol implementation for use in Twisted framework.</li> | |
| 130 | <li><strong>smb/base.py</strong> : | |
| 131 | Contains the SMB abstract class which implements the SMB communication without any network transport specifics.</li> | |
| 132 | <li><strong>smb/ntlm.py</strong> : | |
| 133 | Contains the NTLMv1 and NTLMv2 authentication routines and the decoding/encoding of NTLM authentication messages within SMB messages.</li> | |
| 134 | <li><strong>smb/securityblob.py</strong> : | |
| 135 | Provides routines to encode/decode the NTLMSSP security blob in the SMB messages.</li> | |
| 136 | <li><strong>smb/smb_constants.py</strong> : | |
| 137 | All the constants used in the smb package for SMB1 protocol</li> | |
| 138 | <li><strong>smb/smb_structs.py</strong> : | |
| 139 | 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.</li> | |
| 140 | <li><strong>smb/smb2_constants.py</strong> : | |
| 141 | All the constants used in the smb package for SMB2 protocol</li> | |
| 142 | <li><strong>smb/smb2_structs.py</strong> : | |
| 143 | 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.</li> | |
| 144 | <li><strong>smb/SMBConnection.py</strong> : | |
| 145 | Contains a SMB protocol implementation. All operations are blocking I/O.</li> | |
| 146 | <li><strong>smb/SMBProtocol.py</strong> : | |
| 147 | Contains the SMB protocol implementation for use in the Twisted framework.</li> | |
| 148 | <li><strong>smb/SMBHandler.py</strong> : | |
| 149 | Provides support for “<a class="reference external" href="smb://">smb://</a>” URL in the urllib2 python package.</li> | |
| 79 | without any network transport specifics.</p></li> | |
| 80 | <li><p><strong>nmb/NetBIOS.py</strong>: | |
| 81 | Provides a NBNS implementation to query IP addresses for machine names. All operations are blocking I/O.</p></li> | |
| 82 | <li><p><strong>nmb/NetBIOSProtocol.py</strong> : | |
| 83 | Provides the NBNS protocol implementation for use in Twisted framework.</p></li> | |
| 84 | <li><p><strong>smb/base.py</strong> : | |
| 85 | Contains the SMB abstract class which implements the SMB communication without any network transport specifics.</p></li> | |
| 86 | <li><p><strong>smb/ntlm.py</strong> : | |
| 87 | Contains the NTLMv1 and NTLMv2 authentication routines and the decoding/encoding of NTLM authentication messages within SMB messages.</p></li> | |
| 88 | <li><p><strong>smb/securityblob.py</strong> : | |
| 89 | Provides routines to encode/decode the NTLMSSP security blob in the SMB messages.</p></li> | |
| 90 | <li><p><strong>smb/smb_constants.py</strong> : | |
| 91 | All the constants used in the smb package for SMB1 protocol</p></li> | |
| 92 | <li><p><strong>smb/smb_structs.py</strong> : | |
| 93 | 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.</p></li> | |
| 94 | <li><p><strong>smb/smb2_constants.py</strong> : | |
| 95 | All the constants used in the smb package for SMB2 protocol</p></li> | |
| 96 | <li><p><strong>smb/smb2_structs.py</strong> : | |
| 97 | 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.</p></li> | |
| 98 | <li><p><strong>smb/SMBConnection.py</strong> : | |
| 99 | Contains a SMB protocol implementation. All operations are blocking I/O.</p></li> | |
| 100 | <li><p><strong>smb/SMBProtocol.py</strong> : | |
| 101 | Contains the SMB protocol implementation for use in the Twisted framework.</p></li> | |
| 102 | <li><p><strong>smb/SMBHandler.py</strong> : | |
| 103 | Provides support for “<a class="reference external" href="smb://">smb://</a>” URL in the urllib2 python package.</p></li> | |
| 150 | 104 | </ul> |
| 151 | 105 | </div> |
| 152 | 106 | <div class="section" id="using-pysmb"> |
| 153 | 107 | <h1>Using pysmb<a class="headerlink" href="#using-pysmb" title="Permalink to this headline">¶</a></h1> |
| 154 | <dl class="docutils"> | |
| 155 | <dt>As an application developer who is looking to use pysmb to translate NetBIOS names to IP addresses,</dt> | |
| 156 | <dd><ul class="first last simple"> | |
| 157 | <li>To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read | |
| 158 | <a class="reference internal" href="api/nmb_NetBIOS.html"><em>nmb.NetBIOS.NetBIOS</em></a> documentation.</li> | |
| 159 | <li>To use pysmb in Twisted, please read <a class="reference internal" href="api/nmb_NBNSProtocol.html"><em>nmb.NetBIOSProtocol.NBNSProtocol</em></a> documentation.</li> | |
| 160 | </ul> | |
| 161 | </dd> | |
| 162 | <dt>As an application developer who is looking to use pysmb to implement file transfer or authentication over SMB:</dt> | |
| 163 | <dd><ul class="first last simple"> | |
| 164 | <li>To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read | |
| 165 | <a class="reference internal" href="api/smb_SMBConnection.html"><em>smb.SMBConnection.SMBConnection</em></a> documentation.</li> | |
| 166 | <li>To use pysmb in Twisted, please read <a class="reference internal" href="api/smb_SMBProtocolFactory.html"><em>smb.SMBProtocol.SMBProtocolFactory</em></a> documentation.</li> | |
| 167 | <li>To support “<a class="reference external" href="smb://">smb://</a>” URL in urllib2 python package, read <a class="reference internal" href="api/smb_SMBHandler.html"><em>smb.SMBHandler.SMBHandler</em></a> documentation.</li> | |
| 168 | </ul> | |
| 169 | </dd> | |
| 170 | <dt>As a software developer who is looking to modify pysmb so that you can integrate it to other network frameworks:</dt> | |
| 171 | <dd><ul class="first last simple"> | |
| 172 | <li>Read <a class="reference internal" href="extending.html"><em>Extending pysmb For Other Frameworks</em></a></li> | |
| 108 | <dl class="simple"> | |
| 109 | <dt>As an application developer who is looking to use pysmb to translate NetBIOS names to IP addresses,</dt><dd><ul class="simple"> | |
| 110 | <li><p>To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read | |
| 111 | <a class="reference internal" href="api/nmb_NetBIOS.html"><span class="doc">nmb.NetBIOS.NetBIOS</span></a> documentation.</p></li> | |
| 112 | <li><p>To use pysmb in Twisted, please read <a class="reference internal" href="api/nmb_NBNSProtocol.html"><span class="doc">nmb.NetBIOSProtocol.NBNSProtocol</span></a> documentation.</p></li> | |
| 113 | </ul> | |
| 114 | </dd> | |
| 115 | <dt>As an application developer who is looking to use pysmb to implement file transfer or authentication over SMB:</dt><dd><ul class="simple"> | |
| 116 | <li><p>To use pysmb in applications where you want the file operations to return after they have completed (synchronous style), please read | |
| 117 | <a class="reference internal" href="api/smb_SMBConnection.html"><span class="doc">smb.SMBConnection.SMBConnection</span></a> documentation.</p></li> | |
| 118 | <li><p>To use pysmb in Twisted, please read <a class="reference internal" href="api/smb_SMBProtocolFactory.html"><span class="doc">smb.SMBProtocol.SMBProtocolFactory</span></a> documentation.</p></li> | |
| 119 | <li><p>To support “<a class="reference external" href="smb://">smb://</a>” URL in urllib2 python package, read <a class="reference internal" href="api/smb_SMBHandler.html"><span class="doc">smb.SMBHandler.SMBHandler</span></a> documentation.</p></li> | |
| 120 | </ul> | |
| 121 | </dd> | |
| 122 | <dt>As a software developer who is looking to modify pysmb so that you can integrate it to other network frameworks:</dt><dd><ul class="simple"> | |
| 123 | <li><p>Read <a class="reference internal" href="extending.html"><span class="doc">Extending pysmb For Other Frameworks</span></a></p></li> | |
| 124 | </ul> | |
| 125 | </dd> | |
| 126 | <dt>If you are upgrading from older pysmb versions:</dt><dd><ul class="simple"> | |
| 127 | <li><p>Read <a class="reference internal" href="upgrading.html"><span class="doc">Upgrading from older pysmb versions</span></a></p></li> | |
| 173 | 128 | </ul> |
| 174 | 129 | </dd> |
| 175 | 130 | </dl> |
| 186 | 141 | <li class="toctree-l1"><a class="reference internal" href="api/smb_SharedDevice.html">SharedDevice Class</a></li> |
| 187 | 142 | <li class="toctree-l1"><a class="reference internal" href="api/smb_SharedFile.html">SharedFile Class</a></li> |
| 188 | 143 | <li class="toctree-l1"><a class="reference internal" href="api/smb_exceptions.html">SMB Exceptions</a></li> |
| 144 | <li class="toctree-l1"><a class="reference internal" href="api/smb_security_descriptors.html">Security Descriptors</a></li> | |
| 189 | 145 | <li class="toctree-l1"><a class="reference internal" href="extending.html">Extending pysmb For Other Frameworks</a></li> |
| 146 | <li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading from older pysmb versions</a></li> | |
| 190 | 147 | </ul> |
| 191 | 148 | </div> |
| 192 | 149 | <ul class="simple"> |
| 193 | <li><a class="reference internal" href="genindex.html"><span>Index</span></a></li> | |
| 194 | <li><a class="reference internal" href="search.html"><span>Search Page</span></a></li> | |
| 195 | </ul> | |
| 196 | </div> | |
| 197 | ||
| 198 | ||
| 150 | <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> | |
| 151 | <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> | |
| 152 | </ul> | |
| 153 | </div> | |
| 154 | ||
| 155 | ||
| 156 | <div class="clearer"></div> | |
| 199 | 157 | </div> |
| 158 | </div> | |
| 159 | </div> | |
| 160 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 161 | <div class="sphinxsidebarwrapper"> | |
| 162 | <h3><a href="#">Table of Contents</a></h3> | |
| 163 | <ul> | |
| 164 | <li><a class="reference internal" href="#">Welcome to pysmb’s documentation!</a><ul> | |
| 165 | <li><a class="reference internal" href="#license">License</a></li> | |
| 166 | <li><a class="reference internal" href="#credits">Credits</a></li> | |
| 167 | </ul> | |
| 168 | </li> | |
| 169 | <li><a class="reference internal" href="#package-contents-and-description">Package Contents and Description</a></li> | |
| 170 | <li><a class="reference internal" href="#using-pysmb">Using pysmb</a></li> | |
| 171 | <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li> | |
| 172 | </ul> | |
| 173 | ||
| 174 | <h4>Next topic</h4> | |
| 175 | <p class="topless"><a href="api/nmb_NBNSProtocol.html" | |
| 176 | title="next chapter">NBNSProtocol Class</a></p> | |
| 177 | <div role="note" aria-label="source link"> | |
| 178 | <h3>This Page</h3> | |
| 179 | <ul class="this-page-menu"> | |
| 180 | <li><a href="_sources/index.rst.txt" | |
| 181 | rel="nofollow">Show Source</a></li> | |
| 182 | </ul> | |
| 183 | </div> | |
| 184 | <div id="searchbox" style="display: none" role="search"> | |
| 185 | <h3 id="searchlabel">Quick search</h3> | |
| 186 | <div class="searchformwrapper"> | |
| 187 | <form class="search" action="search.html" method="get"> | |
| 188 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 189 | <input type="submit" value="Go" /> | |
| 190 | </form> | |
| 191 | </div> | |
| 192 | </div> | |
| 193 | <script>$('#searchbox').show(0);</script> | |
| 200 | 194 | </div> |
| 201 | 195 | </div> |
| 202 | 196 | <div class="clearer"></div> |
| 208 | 202 | <a href="genindex.html" title="General Index" |
| 209 | 203 | >index</a></li> |
| 210 | 204 | <li class="right" > |
| 205 | <a href="py-modindex.html" title="Python Module Index" | |
| 206 | >modules</a> |</li> | |
| 207 | <li class="right" > | |
| 211 | 208 | <a href="api/nmb_NBNSProtocol.html" title="NBNSProtocol Class" |
| 212 | 209 | >next</a> |</li> |
| 213 | <li class="nav-item nav-item-0"><a href="#">pysmb 1.1.18 documentation</a> »</li> | |
| 210 | <li class="nav-item nav-item-0"><a href="#">pysmb 1.2.7 documentation</a> »</li> | |
| 211 | <li class="nav-item nav-item-this"><a href="">Welcome to pysmb’s documentation!</a></li> | |
| 214 | 212 | </ul> |
| 215 | 213 | </div> |
| 216 | 214 | <div class="footer" role="contentinfo"> |
| 217 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 218 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 215 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 216 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 219 | 217 | </div> |
| 220 | 218 | </body> |
| 221 | 219 | </html>⏎ |
Binary diff not shown
| 0 | ||
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 4 | <head> | |
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>Python Module Index — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | |
| 9 | <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" /> | |
| 10 | <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> | |
| 11 | <script src="_static/jquery.js"></script> | |
| 12 | <script src="_static/underscore.js"></script> | |
| 13 | <script src="_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="search.html" /> | |
| 16 | ||
| 17 | ||
| 18 | ||
| 19 | </head><body> | |
| 20 | <div class="related" role="navigation" aria-label="related navigation"> | |
| 21 | <h3>Navigation</h3> | |
| 22 | <ul> | |
| 23 | <li class="right" style="margin-right: 10px"> | |
| 24 | <a href="genindex.html" title="General Index" | |
| 25 | accesskey="I">index</a></li> | |
| 26 | <li class="right" > | |
| 27 | <a href="#" title="Python Module Index" | |
| 28 | >modules</a> |</li> | |
| 29 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 30 | <li class="nav-item nav-item-this"><a href="">Python Module Index</a></li> | |
| 31 | </ul> | |
| 32 | </div> | |
| 33 | ||
| 34 | <div class="document"> | |
| 35 | <div class="documentwrapper"> | |
| 36 | <div class="bodywrapper"> | |
| 37 | <div class="body" role="main"> | |
| 38 | ||
| 39 | ||
| 40 | <h1>Python Module Index</h1> | |
| 41 | ||
| 42 | <div class="modindex-jumpbox"> | |
| 43 | <a href="#cap-s"><strong>s</strong></a> | |
| 44 | </div> | |
| 45 | ||
| 46 | <table class="indextable modindextable"> | |
| 47 | <tr class="pcap"><td></td><td> </td><td></td></tr> | |
| 48 | <tr class="cap" id="cap-s"><td></td><td> | |
| 49 | <strong>s</strong></td><td></td></tr> | |
| 50 | <tr> | |
| 51 | <td><img src="_static/minus.png" class="toggler" | |
| 52 | id="toggle-1" style="display: none" alt="-" /></td> | |
| 53 | <td> | |
| 54 | <code class="xref">smb</code></td><td> | |
| 55 | <em></em></td></tr> | |
| 56 | <tr class="cg-1"> | |
| 57 | <td></td> | |
| 58 | <td>    | |
| 59 | <a href="api/smb_security_descriptors.html#module-smb.security_descriptors"><code class="xref">smb.security_descriptors</code></a></td><td> | |
| 60 | <em>Data structures used in Windows security descriptors.</em></td></tr> | |
| 61 | </table> | |
| 62 | ||
| 63 | ||
| 64 | <div class="clearer"></div> | |
| 65 | </div> | |
| 66 | </div> | |
| 67 | </div> | |
| 68 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 69 | <div class="sphinxsidebarwrapper"> | |
| 70 | <div id="searchbox" style="display: none" role="search"> | |
| 71 | <h3 id="searchlabel">Quick search</h3> | |
| 72 | <div class="searchformwrapper"> | |
| 73 | <form class="search" action="search.html" method="get"> | |
| 74 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 75 | <input type="submit" value="Go" /> | |
| 76 | </form> | |
| 77 | </div> | |
| 78 | </div> | |
| 79 | <script>$('#searchbox').show(0);</script> | |
| 80 | </div> | |
| 81 | </div> | |
| 82 | <div class="clearer"></div> | |
| 83 | </div> | |
| 84 | <div class="related" role="navigation" aria-label="related navigation"> | |
| 85 | <h3>Navigation</h3> | |
| 86 | <ul> | |
| 87 | <li class="right" style="margin-right: 10px"> | |
| 88 | <a href="genindex.html" title="General Index" | |
| 89 | >index</a></li> | |
| 90 | <li class="right" > | |
| 91 | <a href="#" title="Python Module Index" | |
| 92 | >modules</a> |</li> | |
| 93 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 94 | <li class="nav-item nav-item-this"><a href="">Python Module Index</a></li> | |
| 95 | </ul> | |
| 96 | </div> | |
| 97 | <div class="footer" role="contentinfo"> | |
| 98 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 99 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 100 | </div> | |
| 101 | </body> | |
| 102 | </html>⏎ |
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 2 | 0 | |
| 1 | <!DOCTYPE html> | |
| 3 | 2 | |
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 3 | <html> | |
| 5 | 4 | <head> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>Search — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | |
| 9 | <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" /> | |
| 7 | 10 | |
| 8 | <title>Search — pysmb 1.1.18 documentation</title> | |
| 9 | ||
| 10 | <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" /> | |
| 11 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | |
| 12 | ||
| 13 | <script type="text/javascript"> | |
| 14 | var DOCUMENTATION_OPTIONS = { | |
| 15 | URL_ROOT: './', | |
| 16 | VERSION: '1.1.18', | |
| 17 | COLLAPSE_INDEX: false, | |
| 18 | FILE_SUFFIX: '.html', | |
| 19 | HAS_SOURCE: true | |
| 20 | }; | |
| 21 | </script> | |
| 22 | <script type="text/javascript" src="_static/jquery.js"></script> | |
| 23 | <script type="text/javascript" src="_static/underscore.js"></script> | |
| 24 | <script type="text/javascript" src="_static/doctools.js"></script> | |
| 25 | <script type="text/javascript" src="_static/searchtools.js"></script> | |
| 26 | <link rel="top" title="pysmb 1.1.18 documentation" href="index.html" /> | |
| 27 | <script type="text/javascript"> | |
| 28 | jQuery(function() { Search.loadIndex("searchindex.js"); }); | |
| 29 | </script> | |
| 30 | ||
| 31 | <script type="text/javascript" id="searchindexloader"></script> | |
| 11 | <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> | |
| 12 | <script src="_static/jquery.js"></script> | |
| 13 | <script src="_static/underscore.js"></script> | |
| 14 | <script src="_static/doctools.js"></script> | |
| 15 | <script src="_static/searchtools.js"></script> | |
| 16 | <script src="_static/language_data.js"></script> | |
| 17 | <link rel="index" title="Index" href="genindex.html" /> | |
| 18 | <link rel="search" title="Search" href="#" /> | |
| 19 | <script src="searchindex.js" defer></script> | |
| 32 | 20 | |
| 33 | 21 | |
| 34 | </head> | |
| 35 | <body role="document"> | |
| 22 | </head><body> | |
| 36 | 23 | <div class="related" role="navigation" aria-label="related navigation"> |
| 37 | 24 | <h3>Navigation</h3> |
| 38 | 25 | <ul> |
| 39 | 26 | <li class="right" style="margin-right: 10px"> |
| 40 | 27 | <a href="genindex.html" title="General Index" |
| 41 | 28 | accesskey="I">index</a></li> |
| 42 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 29 | <li class="right" > | |
| 30 | <a href="py-modindex.html" title="Python Module Index" | |
| 31 | >modules</a> |</li> | |
| 32 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 33 | <li class="nav-item nav-item-this"><a href="">Search</a></li> | |
| 43 | 34 | </ul> |
| 44 | </div> | |
| 45 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 46 | <div class="sphinxsidebarwrapper"> | |
| 47 | </div> | |
| 48 | </div> | |
| 35 | </div> | |
| 49 | 36 | |
| 50 | 37 | <div class="document"> |
| 51 | 38 | <div class="documentwrapper"> |
| 54 | 41 | |
| 55 | 42 | <h1 id="search-documentation">Search</h1> |
| 56 | 43 | <div id="fallback" class="admonition warning"> |
| 57 | <script type="text/javascript">$('#fallback').hide();</script> | |
| 44 | <script>$('#fallback').hide();</script> | |
| 58 | 45 | <p> |
| 59 | 46 | Please activate JavaScript to enable the search |
| 60 | 47 | functionality. |
| 61 | 48 | </p> |
| 62 | 49 | </div> |
| 63 | 50 | <p> |
| 64 | From here you can search these documents. Enter your search | |
| 65 | words into the box below and click "search". Note that the search | |
| 66 | function will automatically search for all of the words. Pages | |
| 67 | containing fewer words won't appear in the result list. | |
| 51 | Searching for multiple words only shows matches that contain | |
| 52 | all words. | |
| 68 | 53 | </p> |
| 69 | 54 | <form action="" method="get"> |
| 70 | <input type="text" name="q" value="" /> | |
| 55 | <input type="text" name="q" aria-labelledby="search-documentation" value="" /> | |
| 71 | 56 | <input type="submit" value="search" /> |
| 72 | 57 | <span id="search-progress" style="padding-left: 10px"></span> |
| 73 | 58 | </form> |
| 76 | 61 | |
| 77 | 62 | </div> |
| 78 | 63 | |
| 64 | <div class="clearer"></div> | |
| 79 | 65 | </div> |
| 66 | </div> | |
| 67 | </div> | |
| 68 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 69 | <div class="sphinxsidebarwrapper"> | |
| 80 | 70 | </div> |
| 81 | 71 | </div> |
| 82 | 72 | <div class="clearer"></div> |
| 87 | 77 | <li class="right" style="margin-right: 10px"> |
| 88 | 78 | <a href="genindex.html" title="General Index" |
| 89 | 79 | >index</a></li> |
| 90 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.1.18 documentation</a> »</li> | |
| 80 | <li class="right" > | |
| 81 | <a href="py-modindex.html" title="Python Module Index" | |
| 82 | >modules</a> |</li> | |
| 83 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 84 | <li class="nav-item nav-item-this"><a href="">Search</a></li> | |
| 91 | 85 | </ul> |
| 92 | 86 | </div> |
| 93 | 87 | <div class="footer" role="contentinfo"> |
| 94 | © Copyright 2001-2015, Michael Teo http://miketeo.net/. | |
| 95 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6. | |
| 88 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 89 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 96 | 90 | </div> |
| 97 | 91 | </body> |
| 98 | 92 | </html>⏎ |
| 0 | Search.setIndex({envversion:46,filenames:["api/nmb_NBNSProtocol","api/nmb_NetBIOS","api/smb_SMBConnection","api/smb_SMBHandler","api/smb_SMBProtocolFactory","api/smb_SharedDevice","api/smb_SharedFile","api/smb_exceptions","extending","index"],objects:{"nmb.NetBIOS":{NetBIOS:[1,0,1,""]},"nmb.NetBIOS.NetBIOS":{"__init__":[1,1,1,""],close:[1,1,1,""],queryIPForName:[1,1,1,""],queryName:[1,1,1,""]},"nmb.NetBIOSProtocol":{NBNSProtocol:[0,0,1,""],NetBIOSTimeout:[0,0,1,""]},"nmb.NetBIOSProtocol.NBNSProtocol":{"__init__":[0,1,1,""],queryIPForName:[0,1,1,""],queryName:[0,1,1,""]},"smb.SMBConnection":{SMBConnection:[2,0,1,""]},"smb.SMBConnection.SMBConnection":{"__init__":[2,1,1,""],SIGN_NEVER:[2,2,1,""],SIGN_WHEN_REQUIRED:[2,2,1,""],SIGN_WHEN_SUPPORTED:[2,2,1,""],close:[2,1,1,""],connect:[2,1,1,""],createDirectory:[2,1,1,""],deleteDirectory:[2,1,1,""],deleteFiles:[2,1,1,""],echo:[2,1,1,""],getAttributes:[2,1,1,""],isUsingSMB2:[2,2,1,""],listPath:[2,1,1,""],listShares:[2,1,1,""],listSnapshots:[2,1,1,""],rename:[2,1,1,""],resetFileAttributes:[2,1,1,""],retrieveFile:[2,1,1,""],retrieveFileFromOffset:[2,1,1,""],storeFile:[2,1,1,""],storeFileFromOffset:[2,1,1,""]},"smb.SMBProtocol":{SMBProtocolFactory:[4,0,1,""]},"smb.SMBProtocol.SMBProtocolFactory":{"__init__":[4,1,1,""],SIGN_NEVER:[4,2,1,""],SIGN_WHEN_REQUIRED:[4,2,1,""],SIGN_WHEN_SUPPORTED:[4,2,1,""],closeConnection:[4,1,1,""],createDirectory:[4,1,1,""],deleteDirectory:[4,1,1,""],deleteFiles:[4,1,1,""],echo:[4,1,1,""],getAttributes:[4,1,1,""],instance:[4,2,1,""],isReady:[4,2,1,""],isUsingSMB2:[4,2,1,""],listPath:[4,1,1,""],listShares:[4,1,1,""],listSnapshots:[4,1,1,""],onAuthFailed:[4,1,1,""],onAuthOK:[4,1,1,""],rename:[4,1,1,""],retrieveFile:[4,1,1,""],retrieveFileFromOffset:[4,1,1,""],storeFile:[4,1,1,""]},"smb.base":{NotConnectedError:[7,0,1,""],NotReadyError:[7,0,1,""],SMBTimeout:[7,0,1,""],SharedDevice:[5,0,1,""],SharedFile:[6,0,1,""]},"smb.base.SharedDevice":{comments:[5,2,1,""],isSpecial:[5,2,1,""],isTemporary:[5,2,1,""],name:[5,2,1,""],type:[5,2,1,""]},"smb.base.SharedFile":{alloc_size:[6,2,1,""],create_time:[6,2,1,""],file_attributes:[6,2,1,""],file_size:[6,2,1,""],filename:[6,2,1,""],isDirectory:[6,2,1,""],isReadOnly:[6,2,1,""],last_access_time:[6,2,1,""],last_attr_change_time:[6,2,1,""],last_write_time:[6,2,1,""],short_name:[6,2,1,""]},"smb.smb_structs":{OperationFailure:[7,0,1,""],ProtocolError:[7,0,1,""],UnsupportedFeature:[7,0,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","attribute","Python attribute"]},objtypes:{"0":"py:class","1":"py:method","2":"py:attribute"},terms:{"3rd":9,"60kbyte":4,"\u5783\u573e\u6587\u4ef6":3,"\u6d4b\u8bd5\u6587\u4ef6\u5939":3,"__init__":[0,1,2,4,8],"abstract":9,"boolean":[0,1,2,4],"byte":[2,4,6],"case":4,"default":[2,4],"float":[0,1,4,6],"function":[0,1,2,4,9],"import":[2,3,4,9],"int":[2,4],"long":[2,4,6],"new":[1,2,4,8],"public":4,"return":[0,1,2,3,4,5,6,9],"short":6,"true":[0,1,2,4,5,6],"try":[2,4,8],"while":7,aaa:[0,1],about:[2,4,5,6],abov:8,accept:[4,8],access:[2,4,6],accur:4,acknowledg:4,across:[2,4],actual:2,add:[0,4],addcallback:[0,4],adderrback:4,address:[0,1,3,8,9],admin:5,administr:5,after:[0,1,2,4,9],again:0,against:9,algorithm:[2,4,8,9],all:[2,4,9],alloc:6,alloc_s:6,allow:[0,2,4],alon:9,alphanumer:[2,4],alreadi:2,also:[2,4,5],alwai:9,anderson:[0,1],ani:[1,2,4,6,9],appli:[2,4],applic:[0,1,4,6,9],appropri:[0,1],arbitari:[2,4],archiv:[2,4],arg:4,around:0,ascii:[2,4],asn:9,aspx:2,assert:2,asynchron:[0,2,8],attempt:2,attribut:[2,4,6],atttempt:2,auth:4,authent:[2,4,7,8,9],authenthent:4,auto:[2,4],automat:[0,1,2,4],avail:[2,4,9],avoid:4,back:[0,1,2,4],base:[2,4,5,6,7,8,9],batch:4,bbb:[0,1],been:[2,4,7,8,9],befor:[2,4],begin:[2,4],between:9,bind:[0,1],bit:[2,4,9],bitwis:[2,4],blob:9,block:[0,1,2,9],both:[2,4],briefli:8,broadcast:[0,1],buffer:8,build_open:3,busi:[2,4],call:[0,1,2,4,6,8],callback:[0,4,8],can:[0,1,2,3,4,5,8,9],cannot:[2,3,4],captur:[2,4],care:8,cc232110:2,ccc:[0,1],chang:6,charact:[2,3,4,6],choic:[2,4],choos:[2,4],cif:[1,2,4,6,7,8,9],clear:2,click:[2,4],client:[2,4,9],client_machine_nam:[2,4],close:[1,2,3,4],closeconnect:4,code:3,com:2,come:9,comm_devic:5,command:[2,4],comment:5,commerci:9,commun:[2,4,5,9],compat:[2,4],complet:[2,4,7,9],compon:[2,3,4],comput:[2,4],concurr:[2,4],configur:[2,4],conflict:9,conn:2,connect:[2,4,7,8],connecttcp:4,constant:[5,9],constructor:8,contain:[1,2,4,5,6,9],content:[2,4],continu:[2,4],contribut:[0,1],control:[2,4],conveni:[2,4,6],copi:[2,4,9],correspond:6,could:[6,9],cover:9,creat:[0,1,2,3,4,8],create_tim:6,createdirectori:[2,4],creation:[5,6],credenti:[2,4],credienti:4,current:[2,7],dat:3,data:[2,3,4,8,9],data_buf:7,datetim:[2,4],ddd:[0,1],decod:9,def:4,defer:[0,4],defin:[0,1],delet:[2,3,4],deletedirectori:[2,4],deletefil:[2,4],depend:9,describ:[2,8],descript:5,detail:[6,8,9],detect:[2,4],determin:[0,1,2,4,9],develop:[2,6,9],devic:[5,6],dialect:9,differ:[2,4,8,9],digest:9,direct:[2,4],directli:[4,6],director:3,directori:[2,3,4,6],disabl:[2,4],disconnect:[2,4,7],discret:9,disk_tre:5,dixon:9,dmitri:9,doe:[2,4,6,9],domain:[2,4,9],done:[0,1],dot:[0,1],download:[4,9],due:8,each:[1,2,4,5,6],earliest:4,echo:[2,4],edit:[2,4],either:[2,4],element:[2,4],els:[2,4],empti:[0,1,2,3,4,6],enabl:[2,4],encod:9,encount:[2,6],encrypt:9,end:[2,4],english:[2,4],enterpris:[2,4],entir:4,entri:6,eof:[2,4],errback:[0,4],error:[2,4,8],establish:[2,4],etc:4,excee:4,except:[0,4],exercis:9,exist:[2,3,4],expos:4,facilit:9,factori:4,fail:[2,4,7,8],failur:0,fallback:[2,4],fals:[0,1,2,4],familiar:9,featur:[2,4,7],feeddata:8,fh2:3,file:[2,3,4,5,6,8,9],file_attribut:[2,4,6],file_attribute_norm:2,file_fh:3,file_obj:[2,4],file_s:[4,6],filenam:[2,4,6],fileretriev:4,files:2,filter:[2,4],find:[2,4,8],first:[2,3,4],flag:[0,1,2,4],folder:[2,3,4,6,9],follow:[2,3,4,5,9],forth:5,framework:[0,4],free:[0,1,9],freeli:[2,4],from:[0,1,2,3,4,8,9],functionl:4,further:2,gener:8,getattribut:[2,4],gmt:[2,4],googl:9,guess:[2,4],handl:[4,8],hash:9,have:[0,2,8,9],held:2,help:2,henc:[2,4,9],hidden:[2,4],hope:[0,1],host:[2,3,4],hostnam:3,http:2,iana:[0,1],identifi:[2,4],idl:2,illustr:[2,3,4],immedi:[2,4],implement:[0,1,2,4,8,9],impos:[2,4],includ:[8,9],incom:0,incomplet:8,index:9,indic:[0,1,2,4],individu:4,inform:[2,4,5,6],initi:[5,8],insid:[2,4],instal:[2,4,9],instanc:[0,1,2,4,6],instanti:[0,1,4,6],instiant:[0,1],integ:[0,1,2,4,6,9],integr:[5,9],interest:[2,4],intern:[4,8,9],internet:[0,4],interprocess:5,interv:4,invok:[2,4],involv:8,ipc:5,ipv4:1,is_direct_tcp:[2,4],isdirectori:6,isreadi:4,isreadonli:6,isspeci:5,istemporari:5,isusingsmb2:[2,4],itself:[4,9],jason:[0,1],just:[0,4],keep:2,keepal:2,know:[0,1,4],known:[2,4],kwarg:4,last:6,last_access_tim:6,last_attr_change_tim:6,last_write_tim:6,latest:9,learn:[2,4],least:2,leav:[0,1,2,4],length:6,lgpl:9,librari:[2,9],like:[2,3,4],limit:[2,4,6],linux:9,list:[0,1,2,4,9],listen:[0,1],listen_port:[0,1],listenudp:0,listpath:[2,4,6],listshar:[2,4],listsnapshot:[2,4],local:[2,4],local_fil:3,look:9,loop:8,loseconnect:4,machin:[0,1,2,3,4,9],made:[2,4,9],mai:[2,4],main:9,match:[0,1,2,4],max_length:[2,4],maximum:[2,4],md4:9,mean:4,meant:2,mechan:[2,4],messag:[2,4,7,9],method:[0,1,2,3,4,6,8],microsoft:[2,9],might:[2,4],miketeo:9,mit:9,mode:[0,1],modif:6,modifi:9,modul:[2,4,9],more:[2,4,6,8,9],most:[2,4,8,9],msdn:2,multipl:[2,4],must:[0,2,4],my_nam:[2,4],mypassword:3,myuserid:3,name:[0,1,2,3,4,5,6,9],namedtemporaryfil:[2,4],nbn:[1,9],need:[2,3,4,6,8,9],neg:[2,4],net:9,netbio:0,netbiosprotocol:[0,9],netbiossess:9,netbiostimeout:0,network:[0,1,2,4,9],never:[2,4],new_path:[2,4],newer:[2,4],next:2,nmb:[0,1,9],non:[2,4],none:[0,1,2,4,5,6,7],notat:[0,1,6],notconnectederror:[4,7],note:2,notreadyerror:[4,7],now:8,ntlm:[4,8,9],ntlmssp:9,ntlmv1:[2,4,9],ntlmv2:[2,4,9],number:[0,1,2,4,6],obj:[2,4],object:[2,3,4],occur:[2,4,7],offset:[2,4],often:8,old:[2,4],old_path:[2,4],onauthfail:[4,8],onauthok:[4,8],onc:[4,8],onli:[2,3,4,6,9],onnmbsessionfail:8,open:[2,3,4,9],opensourc:9,oper:[1,2,4,7,8,9],operationfailur:[2,4,7],opportun:4,organ:9,origin:[2,4,6],other:[2,4],otherwis:[2,4],out:[2,4],over:[2,4,9],overrid:[4,8],overwritten:[2,4],own:[4,8,9],packag:3,packet:[0,1,4,8],page:[8,9],paramet:[0,1,2,3,4,8,9],parent:3,pars:9,part:8,parti:9,pass:[2,3,4],password:[2,4],path:[2,3,4],path_file_pattern:[2,4],pathnam:[2,4],pattern:[2,4],perform:[0,1,2,4,8],period:4,persist:5,place:9,pleas:9,point:3,port:[0,1,2,4],posit:[2,4],possibl:9,post:[4,8],precis:4,present:7,print:[4,9],print_queu:5,proce:4,proceed:[2,4],process:[3,8],prohibit:6,project:[0,4,9],promis:9,properti:[2,4,6],protocol:[2,4,7,9],protocolerror:7,provid:[0,1,2,3,4,8,9],pure:9,purpos:9,pyasn1:9,pyde:9,pymsb:4,pysmb:[0,2,4,7],python:[2,3,4,9],queri:[0,1,2,4,9],queryipfornam:[0,1],querynam:[0,1],queue:4,rais:[0,2,3,4,7],reactor:[0,4],read:[2,3,4,6,8,9],readi:[4,7],receiv:[0,1,2,4],refer:[2,4,5,9],referenc:9,regardless:[2,4],regular:[2,4],reject:[2,4],rel:[2,4],relat:9,releas:[1,2],remot:[1,2,4,5,6,8],remote_nam:[2,4,8],remov:0,renam:[2,4],repli:[0,1,2,4],report:8,request:[2,4],requir:[2,4,7],reserv:5,reset:2,resetfileattribut:2,resourc:[1,2,4,6],respond:2,respons:7,result:[0,2,4],retri:4,retriev:[2,3,4],retrievefil:[2,4],retrievefilefactori:4,retrievefilefromoffset:[2,4],reus:4,rfc1001:[2,3,4],right:[2,4],routin:9,rozmanov:9,safe:[2,4],samba:9,sambda:[2,4],same:[2,4],search:[2,4,9],sec:4,second:[0,1,4,6],section:9,secur:9,securityblob:9,see:[2,4,6],seek:[2,4],select:[0,1,2,4],self:[4,8],send:[0,1,2,4],separ:9,sequenti:2,seri:4,server:[2,4,5,6,8,9],server_ip:[2,4],server_nam:[2,4],servic:[1,2,4,8,9],service_nam:[2,4],session:[8,9],set:[2,4],setup:[0,1,4,8],sha256:9,sha:9,shadow:[2,4],share:[2,3,4,5,6,9],shareddevic:[2,4],sharedfil:[2,4],sharedfold:3,short_nam:6,should:[0,1,2,4,6],side:9,sign:[2,4],sign_nev:[2,4],sign_opt:[2,4],sign_when_requir:[2,4],sign_when_support:[2,4],simpl:[2,4],simpli:3,sinc:6,singl:[2,4,5],site:9,size:[4,6],smb1:[2,4,9],smb2_constant:9,smb2_struct:9,smb:[1,2,3,4,5,6],smb_constant:[2,4,9],smb_ext_file_attr:6,smb_file_attribute_xxx:[2,4],smb_messag:7,smb_struct:[2,4,7,9],smbprotocol:[4,6,9],smbtest:[2,4],smbtimeout:[4,7],snapshot:[2,4],snippet:3,sock_famili:2,socket:[1,2,8],softwar:9,some:[2,4,9],sort:2,sourc:[0,1,2,4,5,6,7,9],sp3:9,space:[2,4],special:5,specif:9,specifi:[0,1,2,4],standard:[0,1,9],start:[0,2,4],step:8,stoplisten:0,store:[2,4,6],storefil:[2,4],storefilefromoffset:2,string:[0,1,2,3,4,5,6],style:9,sub:[2,4],subclass:[4,8],subsequ:3,success:[2,8],successfulli:[2,4],suitabl:[2,9],support_smb2:[2,4],synchron:[8,9],system:[2,4],take:[8,9],target:[0,1],tcp:[2,4,8],technic:[2,8],tempfil:[2,4],temporari:5,term:9,termin:[2,4],test:9,than:[2,4],thei:9,therefor:2,thi:[0,1,2,4,5,6,8,9],thoma:9,those:4,thousand:4,through:4,time:[2,4,5,6,9],timeout:[0,1,2,4,7],todd:9,togeth:9,too:2,total:6,touch:[0,1,4],transfer:[4,9],translat:9,transmit:4,transport:[0,4,9],truncat:2,tupl:[2,4],twist:[0,4,9],txt:[2,3,4],type:5,u32:9,udp:[0,1],ultim:[2,4],under:9,underli:[1,2,4,7,9],unicod:[2,3,4,5,6],unless:[0,1],unlock:2,unsign:9,unsupportedfeatur:7,until:[1,2,4],upload:[2,3,4],upload_fil:3,url:[3,9],urlerror:3,urllib2:[3,9],use_ntlm_v2:[2,4,8],user:[2,4,5],userid:[2,4],usernam:[2,4],usual:[2,4,6,8,9],utc:[2,4],utf:3,util:[2,4],valid:3,valu:[2,4,6],variou:9,veri:2,version:9,via:[0,4,6,9],vista:[2,4,9],wait:[0,1,4,7],want:[4,9],web:9,well:9,what:[0,1,2,4,8],when:[0,1,2,4,7,8,9],where:[2,4,6,9],whether:[2,4],which:[0,1,2,4,6,8,9],whiteman:9,who:[2,4,9],whose:9,wider:[2,4],wildcard:[2,4],window:[2,3,4,6,9],wish:[1,2],within:[2,4,9],without:[0,9],workgroup:[2,4],wrap:0,write:[2,4,8],write_result:4,written:[2,4],wrong:8,yet:7,you:[0,1,2,3,4,6,8,9],your:[0,1,2,4,6,8,9],yourself:9,zero:[0,1,2,4],zone:[2,4]},titles:["NBNSProtocol Class","NetBIOS class","SMBConnection Class","SMbHandler Class","SMBProtocolFactory Class","SharedDevice Class","SharedFile Class","SMB Exceptions","Extending pysmb For Other Frameworks","Welcome to pysmb’s documentation!"],titleterms:{"class":[0,1,2,3,4,5,6],caveat:[2,4],content:9,credit:9,descript:9,document:9,exampl:[2,3,4],except:7,extend:8,framework:8,indic:9,licens:9,nbnsprotocol:0,netbio:1,note:3,other:8,packag:9,pysmb:[8,9],shareddevic:5,sharedfil:6,smb2:[2,4],smb:7,smbconnect:2,smbhandler:3,smbprotocolfactori:4,support:[2,4],tabl:9,welcom:9}})⏎ | |
| 0 | Search.setIndex({docnames:["api/nmb_NBNSProtocol","api/nmb_NetBIOS","api/smb_SMBConnection","api/smb_SMBHandler","api/smb_SMBProtocolFactory","api/smb_SharedDevice","api/smb_SharedFile","api/smb_exceptions","api/smb_security_descriptors","extending","index","upgrading"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["api/nmb_NBNSProtocol.rst","api/nmb_NetBIOS.rst","api/smb_SMBConnection.rst","api/smb_SMBHandler.rst","api/smb_SMBProtocolFactory.rst","api/smb_SharedDevice.rst","api/smb_SharedFile.rst","api/smb_exceptions.rst","api/smb_security_descriptors.rst","extending.rst","index.rst","upgrading.rst"],objects:{"nmb.NetBIOS":{NetBIOS:[1,0,1,""]},"nmb.NetBIOS.NetBIOS":{__init__:[1,1,1,""],close:[1,1,1,""],queryIPForName:[1,1,1,""],queryName:[1,1,1,""]},"nmb.NetBIOSProtocol":{NBNSProtocol:[0,0,1,""],NetBIOSTimeout:[0,0,1,""]},"nmb.NetBIOSProtocol.NBNSProtocol":{__init__:[0,1,1,""],datagramReceived:[0,1,1,""],queryIPForName:[0,1,1,""],queryName:[0,1,1,""],stopProtocol:[0,1,1,""]},"smb.SMBConnection":{SMBConnection:[2,0,1,""]},"smb.SMBConnection.SMBConnection":{SIGN_NEVER:[2,2,1,""],SIGN_WHEN_REQUIRED:[2,2,1,""],SIGN_WHEN_SUPPORTED:[2,2,1,""],__init__:[2,1,1,""],close:[2,1,1,""],connect:[2,1,1,""],createDirectory:[2,1,1,""],deleteDirectory:[2,1,1,""],deleteFiles:[2,1,1,""],echo:[2,1,1,""],getAttributes:[2,1,1,""],getSecurity:[2,1,1,""],isUsingSMB2:[2,1,1,""],listPath:[2,1,1,""],listShares:[2,1,1,""],listSnapshots:[2,1,1,""],rename:[2,1,1,""],resetFileAttributes:[2,1,1,""],retrieveFile:[2,1,1,""],retrieveFileFromOffset:[2,1,1,""],storeFile:[2,1,1,""],storeFileFromOffset:[2,1,1,""]},"smb.SMBProtocol":{SMBProtocolFactory:[4,0,1,""]},"smb.SMBProtocol.SMBProtocolFactory":{SIGN_NEVER:[4,2,1,""],SIGN_WHEN_REQUIRED:[4,2,1,""],SIGN_WHEN_SUPPORTED:[4,2,1,""],__init__:[4,1,1,""],buildProtocol:[4,1,1,""],closeConnection:[4,1,1,""],createDirectory:[4,1,1,""],deleteDirectory:[4,1,1,""],deleteFiles:[4,1,1,""],echo:[4,1,1,""],getAttributes:[4,1,1,""],instance:[4,2,1,""],isReady:[4,1,1,""],isUsingSMB2:[4,1,1,""],listPath:[4,1,1,""],listShares:[4,1,1,""],listSnapshots:[4,1,1,""],onAuthFailed:[4,1,1,""],onAuthOK:[4,1,1,""],protocol:[4,2,1,""],rename:[4,1,1,""],retrieveFile:[4,1,1,""],retrieveFileFromOffset:[4,1,1,""],storeFile:[4,1,1,""]},"smb.base":{NotConnectedError:[7,0,1,""],NotReadyError:[7,0,1,""],SMBTimeout:[7,0,1,""],SharedDevice:[5,0,1,""],SharedFile:[6,0,1,""]},"smb.base.SharedDevice":{comments:[5,2,1,""],isSpecial:[5,1,1,""],isTemporary:[5,1,1,""],name:[5,2,1,""],type:[5,1,1,""]},"smb.base.SharedFile":{alloc_size:[6,2,1,""],create_time:[6,2,1,""],file_attributes:[6,2,1,""],file_id:[6,2,1,""],file_size:[6,2,1,""],filename:[6,2,1,""],isDirectory:[6,1,1,""],isNormal:[6,1,1,""],isReadOnly:[6,1,1,""],last_access_time:[6,2,1,""],last_attr_change_time:[6,2,1,""],last_write_time:[6,2,1,""],short_name:[6,2,1,""]},"smb.security_descriptors":{ACE:[8,0,1,""],ACL:[8,0,1,""],SID:[8,0,1,""],SecurityDescriptor:[8,0,1,""]},"smb.security_descriptors.ACE":{additional_data:[8,2,1,""],flags:[8,2,1,""],isInheritOnly:[8,1,1,""],mask:[8,2,1,""],sid:[8,2,1,""],type:[8,2,1,""]},"smb.security_descriptors.ACL":{aces:[8,2,1,""],revision:[8,2,1,""]},"smb.security_descriptors.SID":{identifier_authority:[8,2,1,""],revision:[8,2,1,""],subauthorities:[8,2,1,""]},"smb.security_descriptors.SecurityDescriptor":{dacl:[8,2,1,""],flags:[8,2,1,""],group:[8,2,1,""],owner:[8,2,1,""],sacl:[8,2,1,""]},"smb.smb_structs":{OperationFailure:[7,0,1,""],ProtocolError:[7,0,1,""],UnsupportedFeature:[7,0,1,""]},smb:{security_descriptors:[8,3,0,"-"]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","attribute","Python attribute"],"3":["py","module","Python module"]},objtypes:{"0":"py:class","1":"py:method","2":"py:attribute","3":"py:module"},terms:{"128":2,"137":[0,1],"139":[2,4],"168":3,"192":3,"1970":6,"256":[6,10],"3rd":10,"445":[2,4],"60kbyte":4,"65591":[2,4],"\u5783\u573e\u6587\u4ef6":3,"\u6d4b\u8bd5\u6587\u4ef6\u5939":3,"abstract":10,"boolean":[0,1,2,4],"byte":[2,4,6],"case":4,"class":[7,8,9,10,11],"default":[2,4,11],"float":[0,1,4,6],"function":[0,1,2,4,10],"import":[2,3,4,10],"int":[2,4],"long":[2,4,6],"new":[1,2,4,9,11],"public":4,"return":[0,1,2,3,4,5,6,10,11],"short":6,"switch":11,"true":[0,1,2,4,5,6,11],"try":[2,4,9],"while":7,ACE:8,And:9,DES:10,DNS:3,For:[2,3,4,10],One:8,The:[0,1,2,3,4,5,6,8,9,10],Then:9,There:[2,4],These:[6,10],Use:[2,4,10],Will:0,__init__:[0,1,2,4,9],aaa:[0,1],about:[2,4,5,6],abov:9,accept:[2,4,9],access:[2,4,6,8],access_mask:8,accur:4,ace_type_:8,aceflag:8,aces:8,acetyp:8,acknowledg:4,acl:8,across:[2,4],actual:2,add:[0,4,11],addcallback:[0,4],added:11,adderrback:4,addit:8,additional_data:8,addr:[0,4],address:[0,1,3,9,10,11],admin:5,administr:5,af_inet6:2,af_inet:2,after:[0,1,2,4,10],again:0,against:10,algorithm:[2,4,9,10],alia:4,all:[0,2,4,8,10],alloc:6,alloc_s:6,allow:[0,2,4],alon:10,alphanumer:[2,4],alreadi:2,also:[2,4,5],alter:4,altern:4,alwai:[8,10],anderson:[0,1],ani:[1,2,4,6,10],api:11,appli:[2,4,8],applic:[0,1,4,6,10,11],application_data:8,appropri:[0,1],arbitari:[2,4],archiv:[2,4,6,11],arg:4,around:0,ascii:[2,4],asn:10,aspx:2,assert:2,associ:8,asynchron:[0,2,9],attempt:2,attr_norm:2,attr_xxx:6,attribut:[2,4,5,6,11],attribute_data:8,atttempt:2,audit:8,auth:4,authent:[2,4,7,9,10],authenthent:4,author:8,auto:[2,4],automat:[0,1,2,4],avail:[2,4,5,6,10],avoid:4,back:[0,1,2,4],base:[2,4,5,6,7,9,10],batch:4,bbb:[0,1],been:[2,4,7,9,10],befor:[2,4,11],begin:[2,4],between:10,bind:[0,1],bit:[2,4,6,10],bitmask:8,bitwis:[2,4],blob:10,block:[0,1,2,10],both:[2,4],briefli:9,broadcast:[0,1],buffer:9,build_open:3,buildprotocol:4,busi:[2,4],call:[0,1,2,4,6,9],callabl:2,callback:[0,4,9],can:[0,1,2,3,4,5,6,8,9,10,11],cannot:[2,3,4],captur:[2,4],care:9,cc232110:2,ccc:[0,1],chang:[6,11],charact:[2,3,4,6],choic:[2,4],choos:[2,4],cif:[1,2,4,6,7,9,10],clear:2,click:[2,4],client:[2,4,10],client_machine_nam:[2,4],close:[1,2,3,4],closeconnect:4,code:3,com:[2,3],come:10,comm_devic:5,comma:3,command:[2,4],comment:5,commerci:10,commun:[2,4,5,10],compat:[2,4],complet:[2,4,7,10,11],compon:[2,3,4],compress:[2,4,6,11],comput:[2,4],concurr:[2,4],configur:[2,4],conflict:10,conn:2,connect:[2,4,7,9],connecttcp:4,consist:8,constant:[2,4,5,6,8,10],constructor:9,contain:[1,2,4,5,6,10],content:[2,4],context:11,continu:[2,4],contribut:[0,1],control:[2,4,8,11],conveni:[2,4,6,8],copi:[2,4,10],correspond:[6,8],could:[6,10,11],cover:10,creat:[0,1,2,3,4,9],create_tim:6,createdirectori:[2,4],creation:[5,6],credenti:[2,4],credienti:4,current:[2,7],dacl:8,dat:3,data:[0,2,3,4,8,9,10],data_buf:7,datagram:0,datagramreceiv:0,datetim:[2,4],ddd:[0,1],decod:10,def:4,defer:[0,4],defin:[0,1,2,4,6,11],delet:[2,3,4,11],delete_matching_fold:[2,4,11],deletedirectori:[2,4],deletefil:[2,4,11],depend:[8,10],describ:[2,9],descript:5,descriptor:[2,10],desir:2,detail:[6,9,10],detect:[2,4],determin:[0,1,2,4,6,10],develop:[2,6,10],devic:[5,6],dialect:10,dictionari:8,differ:[2,4,9,10],digest:10,direct:[2,4],directli:[4,6],director:3,directori:[2,3,4,6,11],disabl:[2,4],disconnect:[0,2,4,7],discret:10,discretionari:8,disk_tre:5,dixon:10,dmitri:10,document:11,doe:[2,4,6,10],doesn:8,doing:[0,1],domain:[2,4,10],done:[0,1],dot:[0,1],download:[4,10],dtyp:8,due:9,each:[1,2,4,5,6],earliest:4,echo:[2,4],edit:[2,4],either:[2,4],element:[2,4],els:[2,4],empti:[0,1,2,3,4,6],enabl:[2,4],encapsul:8,encod:10,encount:[2,6],encrypt:[2,4,6,10,11],end:[2,4],english:[2,4],enterpris:[2,4],entir:4,entri:[2,4,6,8,11],eof:[2,4],errback:[0,4],error:[2,4,9],establish:[2,4],etc:4,exampl:10,excee:4,except:[0,4,10],exercis:10,exist:[2,3,4],expos:4,extend:10,facilit:10,factori:4,fail:[2,4,7,9],failur:0,fallback:[2,4],fals:[0,1,2,4],famili:2,familiar:10,featur:[2,4,7],feeddata:9,fh2:3,field:[6,8],file:[2,3,4,5,6,9,10,11],file_attribut:[2,4,6],file_fh:3,file_id:[6,11],file_obj:[2,4],file_s:[4,6],filenam:[2,4,6],fileretriev:4,files:2,filesystem:11,filter:[2,4],find:[2,4,9],finer:11,first:[2,3,4],flag:[0,1,2,4,8],folder:[2,3,4,6,10,11],follow:[2,3,4,5,6,8,10],forth:5,framework:[0,4,10],free:[0,1,10],freeli:[2,4],from:[0,1,2,3,4,8,9,10],from_info:0,fscc:6,fulli:3,functionl:4,further:2,gener:9,get:4,getattribut:[2,4,11],getsecur:[2,11],given:11,gmt:[2,4],googl:10,group:8,guess:[2,4],handl:[4,9],has:[0,2,4,6,7,9,10,11],hash:10,have:[0,2,4,9,10,11],held:2,help:2,henc:[2,4,10],hidden:[2,4,6,11],hope:[0,1],host:[2,3,4],hostnam:3,how:4,http:2,iaddress:4,iana:[0,1],identifi:[2,4,8],identifier_author:8,idl:2,ignor:[2,4,6,11],illustr:[2,3,4],immedi:[2,4],implement:[0,1,2,4,8,9,10],impos:[2,4],improv:11,includ:[2,4,9,10,11],incom:[0,4],incompat:11,incomplet:9,index:[2,4,6,10,11],indic:[0,1,2,4,8,11],individu:4,infer:2,inform:[2,4,5,6],inherit:8,inherited_object_typ:8,initi:[5,9],input:4,insid:[2,4],instal:[2,4,10],instanc:[0,1,2,4,6,8,11],instanti:[0,1,4,6],instiant:[0,1],integ:[0,1,2,4,6,8,10],integr:[5,10],interest:[2,4],interfac:4,intern:[4,9,10],internet:[0,4],interprocess:5,interv:4,invok:[2,4],involv:9,ipc:5,ipv4:1,is_direct_tcp:[2,4],isdirectori:6,isinheritonli:8,isnorm:[6,11],isreadi:4,isreadonli:[6,11],isspeci:5,istemporari:5,isusingsmb2:[2,4],its:[0,1,2,4,6,9],itself:[2,4,8,10],jason:[0,1],just:[0,4],keep:2,keepal:2,know:[0,1,4],known:[2,4],kwarg:4,last:6,last_access_tim:6,last_attr_change_tim:6,last_write_tim:6,latest:10,learn:[2,4],least:2,leav:[0,1,2,4],length:[6,8],lgpl:10,librari:[2,10],like:[2,3,4,6,11],limit:[2,4,6],linux:10,list:[0,1,2,4,8,10],listen:[0,1],listen_port:[0,1],listenudp:0,listpath:[2,4,6,11],listshar:[2,4],listsnapshot:[2,4],local:[2,3,4],local_fil:3,log:8,look:10,loop:9,loseconnect:4,machin:[0,1,2,3,4,10,11],made:[2,4,10],mai:[2,4],main:10,manag:11,mask:8,match:[0,1,2,4],max_length:[2,4],maximum:[2,4],md4:10,mean:[4,8],meant:2,mechan:[2,4],messag:[2,4,7,10],method:[0,1,2,3,4,6,9,11],microsoft:[2,10],might:[2,4],miketeo:10,mit:10,mode:[0,1,2],modif:6,modifi:10,modul:[2,4,8,10],more:[2,4,6,9,10],most:[2,4,9,10,11],msdn:2,multipl:[2,4],must:[0,2,3,4],my_nam:[2,4],mypassword:3,myserv:3,myuserid:3,name:[0,1,2,3,4,5,6,10,11],namedtemporaryfil:[2,4],nbn:[1,10],nbname:3,nbnsprotocol:[1,10,11],need:[2,3,4,6,9,10],neg:[2,4],net:10,netbio:[0,2,3,4,9,10,11],netbiosprotocol:[0,10],netbiossess:10,netbiostimeout:0,network:[0,1,2,4,10],never:[2,4],new_path:[2,4],newer:[2,4],next:2,nmb:[0,1,10,11],non:[2,4],none:[0,1,2,4,6,7],normal:[2,4,6,11],notat:[0,1,6],notconnectederror:[4,7],note:[2,4,6],notreadyerror:[4,7],now:[9,11],ntlm:[4,9,10],ntlmssp:10,ntlmv1:[2,4,10],ntlmv2:[2,4,10],number:[0,1,2,4,6,8,11],obj:[2,4],object:[2,3,4,8],object_typ:8,occur:[2,4,7],offset:[2,4],often:9,old:[2,4],old_path:[2,4],older:10,onauthfail:[4,9],onauthok:[4,9],onc:[0,4,9],one:[2,3,4,5,6],onli:[0,2,3,4,6,8,10,11],onnmbsessionfail:9,open:[2,3,4,10],opensourc:10,oper:[1,2,4,7,9,10,11],operationfailur:[2,4,7],opportun:4,organ:10,origin:[2,4,6],other:[2,4,6,10,11],otherwis:[2,4],out:[2,4],over:[2,4,10],overrid:[4,9],overwritten:[2,4],own:[2,4,9,10],owner:8,packag:3,packet:[0,1,4,9],page:[9,10,11],param:[0,4],paramet:[0,1,2,3,4,9,10,11],parent:3,pars:10,part:9,parti:10,pass:[2,3,4,11],password:[2,4],path:[2,3,4],path_file_pattern:[2,4],pathnam:[2,4],pattern:[2,4],perform:[0,1,2,4,6,9],period:4,persist:5,place:10,pleas:[10,11],point:[3,4],port:[0,1,2,4],posit:[2,4],possibl:10,post:[4,9],precis:4,present:[7,8],previou:11,princip:8,print:[4,10],print_queu:5,proce:4,proceed:[2,4],process:[3,9],prohibit:6,project:[0,4,10],promis:10,properti:[2,4,5,6,8,11],protocol:[2,4,7,10],protocolerror:7,provid:[0,1,2,3,4,9,10],pure:10,purpos:10,pyasn1:10,pyde:10,pymsb:4,pysmb:[0,2,4,6,7],python3:[2,4],python:[2,3,4,10],qualifi:3,queri:[0,1,2,4,10,11],queryipfornam:[0,1,11],querynam:[0,1],queue:4,rais:[0,2,3,4,7],reactor:[0,4],read:[2,3,4,6,9,10,11],readi:[4,7],receiv:[0,1,2,4],recurs:[2,4],refer:[2,4,5,6,10,11],referenc:10,regardless:[2,4],regular:[2,4],reject:[2,4],rel:[2,4],relat:10,releas:[1,2,11],remot:[1,2,3,4,5,6,9,11],remote_nam:[2,4,9],remov:0,renam:[2,4],repli:[0,1,2,4],report:9,repres:[6,8,11],request:[2,3,4],requir:[2,4,7],reserv:5,reset:2,resetfileattribut:2,resolv:3,resourc:[1,2,4,6],respond:2,respons:7,restrict:8,result:[0,2,4],retri:4,retriev:[2,3,4,11],retrievefil:[2,4],retrievefilefactori:4,retrievefilefromoffset:[2,4,11],reus:4,revis:8,rewrit:11,rewritten:11,rfc1001:[2,3,4],right:[2,4],routin:10,rozmanov:10,sacl:8,safe:[2,4],samba:10,sambda:[2,4],same:[2,4],search:[2,4,10,11],sec:4,second:[0,1,4,6],section:10,secur:[2,10],security_descriptor:[2,8],securityblob:10,securitydescriptor:[2,8],see:[2,4,6,8],seek:[2,4],select:[0,1,2,4],self:[4,9],send:[0,1,2,4],separ:[3,10],sequenc:8,sequenti:2,seri:4,server:[2,4,5,6,9,10,11],server_ip:[2,4],server_nam:[2,4],servic:[1,2,3,4,9,10],service_nam:[2,4],session:[9,10],set:[2,4],setup:[0,1,4,9],sha256:10,sha:10,shadow:[2,4],share:[2,3,4,5,6,10],shareddevic:[2,4,10],sharedfil:[2,4,10,11],sharedfold:3,short_nam:6,should:[0,1,2,4,6,8],sid:8,side:10,sign:[2,4],sign_nev:[2,4],sign_opt:[2,4],sign_when_requir:[2,4],sign_when_support:[2,4],simpl:[2,4],simpli:3,simplic:[2,4],sinc:6,singl:[2,4,5,8],site:10,size:[4,6],smb1:[2,4,10],smb2:10,smb2_constant:10,smb2_struct:10,smb:[1,2,3,4,5,6,8,9,10,11],smb_constant:[2,4,6,10],smb_ext_file_attr:6,smb_file_attribute_arch:[2,4],smb_file_attribute_directori:[2,4],smb_file_attribute_hidden:[2,4],smb_file_attribute_incl_norm:[2,4],smb_file_attribute_norm:[2,4],smb_file_attribute_readonli:[2,4],smb_file_attribute_system:[2,4],smb_file_attribute_xxx:[2,4],smb_messag:7,smb_struct:[2,4,7,10],smbconnect:[10,11],smbhandler:10,smbprotocol:[4,6,10],smbprotocolfactori:[6,10,11],smbtest:[2,4],smbtimeout:[4,7],snapshot:[2,4],snippet:3,sock_famili:2,socket:[1,2,9],softwar:10,some:[2,4,10],sort:2,sourc:[0,1,2,4,5,6,7,8,10],space:[2,4],spars:[2,4,6,11],special:5,specif:10,specifi:[0,1,2,4,8,11],standard:[0,1,10],start:[0,2,4],statu:6,step:9,stoplisten:0,stopprotocol:0,store:[2,4,6],storefil:[2,4],storefilefromoffset:[2,11],string:[0,1,2,3,4,5,6],structur:8,style:10,sub:[2,4,11],subauthor:8,subclass:[4,9],subsequ:3,success:[2,9],successfulli:[2,4],suitabl:[2,10],support:[3,6,7,10,11],support_smb2:[2,4],synchron:[9,10],system:[2,4,6,8,11],take:[9,10],target:[0,1],tcp:[2,4,9],technic:9,tempfil:[2,4],temporari:[2,4,5,6,11],term:10,termin:[2,4],test:[3,6,10],than:[2,4],thei:10,therefor:2,thi:[0,1,2,4,5,6,8,9,10,11],thoma:10,those:4,thousand:4,through:4,time:[2,4,5,6,10],timeout:[0,1,2,4,7,11],todd:10,togeth:10,too:2,total:6,touch:[0,1,4],transfer:[4,10],translat:10,transmit:4,transport:[0,4,10],truncat:[2,11],truste:8,tupl:[0,2,4],twist:[0,4,10],two:11,txt:[2,3,4],type:[5,8],type_:8,u32:10,udp:[0,1],ultim:[2,4],under:10,underli:[1,2,4,7,10],unicod:[2,3,4,5,6],unless:[0,1],unlock:2,unsign:10,unsupportedfeatur:7,until:[1,2,4],upgrad:10,upload:[2,3,4],upload_fil:3,url:[3,10],urlerror:3,urllib2:[3,10],urllib:3,use:[1,2,4,10],use_ntlm_v2:[2,4,9],used:[1,2,4,10,11],user:[2,4,5,8],userid:[2,4],usernam:[2,4],using:[2,4,6,11],usual:[2,4,6,9,10],utc:[2,4],utf:3,util:[2,4],valu:[2,4,6,8],variabl:8,variou:10,veri:2,version:10,via:[0,4,6,10],vista:[2,4],wait:[0,1,4,7],want:[4,10],web:10,well:10,were:11,what:[0,1,2,4,9],when:[0,1,2,4,7,9,10],where:[2,3,4,6,10],whether:[2,4],which:[0,1,2,4,6,8,9,10,11],whiteman:10,who:[2,4,10],whose:10,wider:[2,4],wildcard:[2,4],window:[2,3,4,6,8,10],wise:6,wish:[1,2],within:[2,4,10],without:[0,2,4,10],workgroup:[2,4,11],wrap:0,write:[2,4,9,11],write_result:4,written:[2,4],wrong:9,yet:7,you:[0,1,2,3,4,6,9,10,11],your:[0,1,2,3,4,6,9,10,11],yourself:10,zero:[0,1,2,4],zone:[2,4]},titles:["NBNSProtocol Class","NetBIOS class","SMBConnection Class","SMbHandler Class","SMBProtocolFactory Class","SharedDevice Class","SharedFile Class","SMB Exceptions","Security Descriptors","Extending pysmb For Other Frameworks","Welcome to pysmb\u2019s documentation!","Upgrading from older pysmb versions"],titleterms:{"class":[0,1,2,3,4,5,6],For:9,Using:10,caveat:[2,4],content:10,credit:10,descript:10,descriptor:8,document:10,exampl:[2,3,4],except:7,extend:9,framework:9,from:11,indic:10,licens:10,nbnsprotocol:0,netbio:1,note:3,older:11,other:9,packag:10,pysmb:[9,10,11],secur:8,shareddevic:5,sharedfil:6,smb2:[2,4],smb:7,smbconnect:2,smbhandler:3,smbprotocolfactori:4,support:[2,4],tabl:10,upgrad:11,version:11,welcom:10}})⏎ |
| 0 | ||
| 1 | <!DOCTYPE html> | |
| 2 | ||
| 3 | <html> | |
| 4 | <head> | |
| 5 | <meta charset="utf-8" /> | |
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| 7 | <title>Upgrading from older pysmb versions — pysmb 1.2.7 documentation</title> | |
| 8 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | |
| 9 | <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" /> | |
| 10 | <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> | |
| 11 | <script src="_static/jquery.js"></script> | |
| 12 | <script src="_static/underscore.js"></script> | |
| 13 | <script src="_static/doctools.js"></script> | |
| 14 | <link rel="index" title="Index" href="genindex.html" /> | |
| 15 | <link rel="search" title="Search" href="search.html" /> | |
| 16 | <link rel="prev" title="Extending pysmb For Other Frameworks" href="extending.html" /> | |
| 17 | </head><body> | |
| 18 | <div class="related" role="navigation" aria-label="related navigation"> | |
| 19 | <h3>Navigation</h3> | |
| 20 | <ul> | |
| 21 | <li class="right" style="margin-right: 10px"> | |
| 22 | <a href="genindex.html" title="General Index" | |
| 23 | accesskey="I">index</a></li> | |
| 24 | <li class="right" > | |
| 25 | <a href="py-modindex.html" title="Python Module Index" | |
| 26 | >modules</a> |</li> | |
| 27 | <li class="right" > | |
| 28 | <a href="extending.html" title="Extending pysmb For Other Frameworks" | |
| 29 | accesskey="P">previous</a> |</li> | |
| 30 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 31 | <li class="nav-item nav-item-this"><a href="">Upgrading from older pysmb versions</a></li> | |
| 32 | </ul> | |
| 33 | </div> | |
| 34 | ||
| 35 | <div class="document"> | |
| 36 | <div class="documentwrapper"> | |
| 37 | <div class="bodywrapper"> | |
| 38 | <div class="body" role="main"> | |
| 39 | ||
| 40 | <div class="section" id="upgrading-from-older-pysmb-versions"> | |
| 41 | <h1>Upgrading from older pysmb versions<a class="headerlink" href="#upgrading-from-older-pysmb-versions" title="Permalink to this headline">¶</a></h1> | |
| 42 | <p>This page documents the improvements and changes to the API that could be incompatible with previous releases.</p> | |
| 43 | <div class="section" id="pysmb-1-2-0"> | |
| 44 | <h2>pysmb 1.2.0<a class="headerlink" href="#pysmb-1-2-0" title="Permalink to this headline">¶</a></h2> | |
| 45 | <ul class="simple"> | |
| 46 | <li><p>Add new <cite>delete_matching_folders</cite> parameter to <cite>deleteFiles()</cite> method in SMBProtocolFactory and SMBConnection | |
| 47 | class to support deletion of sub-folders. If you are passing timeout parameter to the <cite>deleteFiles()</cite> method | |
| 48 | in your application, please switch to using named parameter for timeout.</p></li> | |
| 49 | </ul> | |
| 50 | </div> | |
| 51 | <div class="section" id="pysmb-1-1-28"> | |
| 52 | <h2>pysmb 1.1.28<a class="headerlink" href="#pysmb-1-1-28" title="Permalink to this headline">¶</a></h2> | |
| 53 | <ul class="simple"> | |
| 54 | <li><p>SharedFile instances returned from the <cite>listPath()</cite> method now has a new property | |
| 55 | <cite>file_id</cite> attribute which represents the file reference number given by the remote SMB server.</p></li> | |
| 56 | </ul> | |
| 57 | </div> | |
| 58 | <div class="section" id="pysmb-1-1-26"> | |
| 59 | <h2>pysmb 1.1.26<a class="headerlink" href="#pysmb-1-1-26" title="Permalink to this headline">¶</a></h2> | |
| 60 | <ul class="simple"> | |
| 61 | <li><p>SMBConnection class can now be used as a context manager</p></li> | |
| 62 | </ul> | |
| 63 | </div> | |
| 64 | <div class="section" id="pysmb-1-1-25"> | |
| 65 | <h2>pysmb 1.1.25<a class="headerlink" href="#pysmb-1-1-25" title="Permalink to this headline">¶</a></h2> | |
| 66 | <ul class="simple"> | |
| 67 | <li><p>SharedFile class has a new property <cite>isNormal</cite> which will be True if the file is a | |
| 68 | ‘normal’ file. pysmb defines a ‘normal’ file as a file entry that is not | |
| 69 | read-only, not hidden, not system, not archive and not a directory; | |
| 70 | it ignores other attributes like compression, indexed, sparse, temporary and encryption.</p></li> | |
| 71 | <li><p><cite>listPath()</cite> method in SMBProtocolFactory and SMBConnection class will now include | |
| 72 | ‘normal’ files by default if you do not specify the <cite>search</cite> parameter.</p></li> | |
| 73 | </ul> | |
| 74 | </div> | |
| 75 | <div class="section" id="pysmb-1-1-20"> | |
| 76 | <h2>pysmb 1.1.20<a class="headerlink" href="#pysmb-1-1-20" title="Permalink to this headline">¶</a></h2> | |
| 77 | <ul class="simple"> | |
| 78 | <li><p>A new method <cite>getSecurity()</cite> was added to SMBConnection and SMBProtocolFactory class.</p></li> | |
| 79 | </ul> | |
| 80 | </div> | |
| 81 | <div class="section" id="pysmb-1-1-15"> | |
| 82 | <h2>pysmb 1.1.15<a class="headerlink" href="#pysmb-1-1-15" title="Permalink to this headline">¶</a></h2> | |
| 83 | <ul class="simple"> | |
| 84 | <li><p>Add new <cite>truncate</cite> parameter to <cite>storeFileFromOffset()</cite> in SMBProtocolFactory and SMBConnection | |
| 85 | class to support truncation of the file before writing. If you are passing timeout parameter | |
| 86 | to the <cite>storeFileFromOffset()</cite> method in your application, please switch to using named parameter for timeout.</p></li> | |
| 87 | </ul> | |
| 88 | </div> | |
| 89 | <div class="section" id="pysmb-1-1-11"> | |
| 90 | <h2>pysmb 1.1.11<a class="headerlink" href="#pysmb-1-1-11" title="Permalink to this headline">¶</a></h2> | |
| 91 | <ul class="simple"> | |
| 92 | <li><p>A new method <cite>storeFileFromOffset()</cite> was added to SMBConnection and SMBProtocolFactory class.</p></li> | |
| 93 | </ul> | |
| 94 | </div> | |
| 95 | <div class="section" id="pysmb-1-1-10"> | |
| 96 | <h2>pysmb 1.1.10<a class="headerlink" href="#pysmb-1-1-10" title="Permalink to this headline">¶</a></h2> | |
| 97 | <ul class="simple"> | |
| 98 | <li><p>A new method <cite>getAttributes()</cite> was added to SMBConnection and SMBProtocolFactory class</p></li> | |
| 99 | <li><p>SharedFile class has a new property <cite>isReadOnly</cite> to indicate the file is read-only on the remote filesystem.</p></li> | |
| 100 | </ul> | |
| 101 | </div> | |
| 102 | <div class="section" id="pysmb-1-1-2"> | |
| 103 | <h2>pysmb 1.1.2<a class="headerlink" href="#pysmb-1-1-2" title="Permalink to this headline">¶</a></h2> | |
| 104 | <ul class="simple"> | |
| 105 | <li><p><cite>queryIPForName()</cite> method in nmb.NetBIOS and nmb.NBNSProtocol class will now return only the server machine name and ignore workgroup names.</p></li> | |
| 106 | </ul> | |
| 107 | </div> | |
| 108 | <div class="section" id="pysmb-1-0-3"> | |
| 109 | <h2>pysmb 1.0.3<a class="headerlink" href="#pysmb-1-0-3" title="Permalink to this headline">¶</a></h2> | |
| 110 | <ul class="simple"> | |
| 111 | <li><p>Two new methods were added to NBNSProtocol class: <cite>queryIPForName()</cite> and <cite>NetBIOS.queryIPForName()</cite> | |
| 112 | to support querying for a machine’s NetBIOS name at the given IP address.</p></li> | |
| 113 | <li><p>A new method <cite>retrieveFileFromOffset()</cite> was added to SMBProtocolFactory and SMBConnection | |
| 114 | to support finer control of file retrieval operation.</p></li> | |
| 115 | </ul> | |
| 116 | </div> | |
| 117 | <div class="section" id="pysmb-1-0-0"> | |
| 118 | <h2>pysmb 1.0.0<a class="headerlink" href="#pysmb-1-0-0" title="Permalink to this headline">¶</a></h2> | |
| 119 | <p>pysmb was completely rewritten in version 1.0.0. | |
| 120 | If you are upgrading from pysmb 0.x, you most likely have to rewrite your application for the new 1.x API.</p> | |
| 121 | </div> | |
| 122 | </div> | |
| 123 | ||
| 124 | ||
| 125 | <div class="clearer"></div> | |
| 126 | </div> | |
| 127 | </div> | |
| 128 | </div> | |
| 129 | <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| 130 | <div class="sphinxsidebarwrapper"> | |
| 131 | <h3><a href="index.html">Table of Contents</a></h3> | |
| 132 | <ul> | |
| 133 | <li><a class="reference internal" href="#">Upgrading from older pysmb versions</a><ul> | |
| 134 | <li><a class="reference internal" href="#pysmb-1-2-0">pysmb 1.2.0</a></li> | |
| 135 | <li><a class="reference internal" href="#pysmb-1-1-28">pysmb 1.1.28</a></li> | |
| 136 | <li><a class="reference internal" href="#pysmb-1-1-26">pysmb 1.1.26</a></li> | |
| 137 | <li><a class="reference internal" href="#pysmb-1-1-25">pysmb 1.1.25</a></li> | |
| 138 | <li><a class="reference internal" href="#pysmb-1-1-20">pysmb 1.1.20</a></li> | |
| 139 | <li><a class="reference internal" href="#pysmb-1-1-15">pysmb 1.1.15</a></li> | |
| 140 | <li><a class="reference internal" href="#pysmb-1-1-11">pysmb 1.1.11</a></li> | |
| 141 | <li><a class="reference internal" href="#pysmb-1-1-10">pysmb 1.1.10</a></li> | |
| 142 | <li><a class="reference internal" href="#pysmb-1-1-2">pysmb 1.1.2</a></li> | |
| 143 | <li><a class="reference internal" href="#pysmb-1-0-3">pysmb 1.0.3</a></li> | |
| 144 | <li><a class="reference internal" href="#pysmb-1-0-0">pysmb 1.0.0</a></li> | |
| 145 | </ul> | |
| 146 | </li> | |
| 147 | </ul> | |
| 148 | ||
| 149 | <h4>Previous topic</h4> | |
| 150 | <p class="topless"><a href="extending.html" | |
| 151 | title="previous chapter">Extending pysmb For Other Frameworks</a></p> | |
| 152 | <div role="note" aria-label="source link"> | |
| 153 | <h3>This Page</h3> | |
| 154 | <ul class="this-page-menu"> | |
| 155 | <li><a href="_sources/upgrading.rst.txt" | |
| 156 | rel="nofollow">Show Source</a></li> | |
| 157 | </ul> | |
| 158 | </div> | |
| 159 | <div id="searchbox" style="display: none" role="search"> | |
| 160 | <h3 id="searchlabel">Quick search</h3> | |
| 161 | <div class="searchformwrapper"> | |
| 162 | <form class="search" action="search.html" method="get"> | |
| 163 | <input type="text" name="q" aria-labelledby="searchlabel" /> | |
| 164 | <input type="submit" value="Go" /> | |
| 165 | </form> | |
| 166 | </div> | |
| 167 | </div> | |
| 168 | <script>$('#searchbox').show(0);</script> | |
| 169 | </div> | |
| 170 | </div> | |
| 171 | <div class="clearer"></div> | |
| 172 | </div> | |
| 173 | <div class="related" role="navigation" aria-label="related navigation"> | |
| 174 | <h3>Navigation</h3> | |
| 175 | <ul> | |
| 176 | <li class="right" style="margin-right: 10px"> | |
| 177 | <a href="genindex.html" title="General Index" | |
| 178 | >index</a></li> | |
| 179 | <li class="right" > | |
| 180 | <a href="py-modindex.html" title="Python Module Index" | |
| 181 | >modules</a> |</li> | |
| 182 | <li class="right" > | |
| 183 | <a href="extending.html" title="Extending pysmb For Other Frameworks" | |
| 184 | >previous</a> |</li> | |
| 185 | <li class="nav-item nav-item-0"><a href="index.html">pysmb 1.2.7 documentation</a> »</li> | |
| 186 | <li class="nav-item nav-item-this"><a href="">Upgrading from older pysmb versions</a></li> | |
| 187 | </ul> | |
| 188 | </div> | |
| 189 | <div class="footer" role="contentinfo"> | |
| 190 | © Copyright 2001-2021, Michael Teo https://miketeo.net/. | |
| 191 | Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3. | |
| 192 | </div> | |
| 193 | </body> | |
| 194 | </html>⏎ |
| 76 | 76 | self.onNMBSessionOK() |
| 77 | 77 | elif packet.type == NEGATIVE_SESSION_RESPONSE: |
| 78 | 78 | self.onNMBSessionFailed() |
| 79 | elif packet.type == SESSION_KEEPALIVE: | |
| 80 | # Discard keepalive packets - [RFC1002]: 5.2.2.1 | |
| 81 | pass | |
| 79 | 82 | else: |
| 80 | 83 | self.log.warning('Unrecognized NMB session type: 0x%02x', packet.type) |
| 81 | 84 | |
| 150 | 153 | opcode = (code >> 11) & 0x0F |
| 151 | 154 | flags = (code >> 4) & 0x7F |
| 152 | 155 | rcode = code & 0x0F |
| 153 | numnames = struct.unpack('B', data[self.HEADER_STRUCT_SIZE + 44])[0] | |
| 154 | 156 | |
| 155 | if numnames > 0: | |
| 156 | ret = [ ] | |
| 157 | offset = self.HEADER_STRUCT_SIZE + 45 | |
| 157 | try: | |
| 158 | numnames = struct.unpack('B', data[self.HEADER_STRUCT_SIZE + 44])[0] | |
| 158 | 159 | |
| 159 | for i in range(0, numnames): | |
| 160 | mynme = data[offset:offset + 15] | |
| 161 | mynme = mynme.strip() | |
| 162 | ret.append(( mynme, ord(data[offset+15]) )) | |
| 163 | offset += 18 | |
| 160 | if numnames > 0: | |
| 161 | ret = [ ] | |
| 162 | offset = self.HEADER_STRUCT_SIZE + 45 | |
| 164 | 163 | |
| 165 | return trn_id, ret | |
| 166 | else: | |
| 167 | return trn_id, None | |
| 164 | for i in range(0, numnames): | |
| 165 | mynme = data[offset:offset + 15] | |
| 166 | mynme = mynme.strip() | |
| 167 | ret.append(( mynme, ord(data[offset+15]) )) | |
| 168 | offset += 18 | |
| 169 | ||
| 170 | return trn_id, ret | |
| 171 | except IndexError: | |
| 172 | pass | |
| 173 | ||
| 174 | return trn_id, None | |
| 168 | 175 | |
| 169 | 176 | # |
| 170 | 177 | # Contributed by Jason Anderson |
| 20 | 20 | Create a new SMBConnection instance. |
| 21 | 21 | |
| 22 | 22 | *username* and *password* are the user credentials required to authenticate the underlying SMB connection with the remote server. |
| 23 | *password* can be a string or a callable returning a string. | |
| 23 | 24 | File operations can only be proceeded after the connection has been authenticated successfully. |
| 24 | 25 | |
| 25 | 26 | Note that you need to call *connect* method to actually establish the SMB connection to the remote server and perform authentication. |
| 28 | 29 | Some newer server installations might also support Direct hosting of SMB over TCP/IP; for these servers, the default TCP port is 445. |
| 29 | 30 | |
| 30 | 31 | :param string my_name: The local NetBIOS machine name that will identify where this connection is originating from. |
| 31 | 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 ``\/:*?";|+`` | |
| 32 | 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 ``\\/:*?";|+`` | |
| 32 | 33 | :param string remote_name: The NetBIOS machine name of the remote server. |
| 33 | 34 | On windows, you can find out the machine name by right-clicking on the "My Computer" and selecting "Properties". |
| 34 | 35 | This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected. |
| 71 | 72 | total_sent = total_sent + sent |
| 72 | 73 | |
| 73 | 74 | # |
| 75 | # Support for "with" context | |
| 76 | # | |
| 77 | def __enter__(self): | |
| 78 | return self | |
| 79 | ||
| 80 | def __exit__(self, *args): | |
| 81 | self.close() | |
| 82 | ||
| 83 | # | |
| 74 | 84 | # Misc Properties |
| 75 | 85 | # |
| 76 | 86 | |
| 152 | 162 | return results |
| 153 | 163 | |
| 154 | 164 | def listPath(self, service_name, path, |
| 155 | search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE, | |
| 165 | search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL, | |
| 156 | 166 | pattern = '*', timeout = 30): |
| 157 | 167 | """ |
| 158 | 168 | Retrieve a directory listing of files/folders at *path* |
| 169 | ||
| 170 | For simplicity, pysmb defines a "normal" file as a file entry that is not read-only, not hidden, not system, not archive and not a directory. | |
| 171 | It ignores other attributes like compression, indexed, sparse, temporary and encryption. | |
| 172 | ||
| 173 | Note that the default search parameter will query for all read-only (SMB_FILE_ATTRIBUTE_READONLY), hidden (SMB_FILE_ATTRIBUTE_HIDDEN), | |
| 174 | system (SMB_FILE_ATTRIBUTE_SYSTEM), archive (SMB_FILE_ATTRIBUTE_ARCHIVE), normal (SMB_FILE_ATTRIBUTE_INCL_NORMAL) files | |
| 175 | and directories (SMB_FILE_ATTRIBUTE_DIRECTORY). | |
| 176 | If you do not need to include "normal" files in the result, define your own search parameter without the SMB_FILE_ATTRIBUTE_INCL_NORMAL constant. | |
| 177 | SMB_FILE_ATTRIBUTE_NORMAL should be used by itself and not be used with other bit constants. | |
| 159 | 178 | |
| 160 | 179 | :param string/unicode service_name: the name of the shared folder for the *path* |
| 161 | 180 | :param string/unicode path: path relative to the *service_name* where we are interested to learn about its files/sub-folders. |
| 162 | 181 | :param integer search: integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py). |
| 163 | The default *search* value will query for all read-only, hidden, system, archive files and directories. | |
| 164 | 182 | :param string/unicode pattern: the filter to apply to the results before returning to the client. |
| 165 | 183 | :return: A list of :doc:`smb.base.SharedFile<smb_SharedFile>` instances. |
| 166 | 184 | """ |
| 244 | 262 | self.is_busy = True |
| 245 | 263 | try: |
| 246 | 264 | self._getAttributes(service_name, path, cb, eb, timeout) |
| 265 | while self.is_busy: | |
| 266 | self._pollForNetBIOSPacket(timeout) | |
| 267 | finally: | |
| 268 | self.is_busy = False | |
| 269 | ||
| 270 | return results[0] | |
| 271 | ||
| 272 | def getSecurity(self, service_name, path, timeout = 30): | |
| 273 | """ | |
| 274 | Retrieve the security descriptor of the file at *path* on the *service_name*. | |
| 275 | ||
| 276 | :param string/unicode service_name: the name of the shared folder for the *path* | |
| 277 | :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. | |
| 278 | :return: A :class:`smb.security_descriptors.SecurityDescriptor` instance containing the security information of the file. | |
| 279 | """ | |
| 280 | if not self.sock: | |
| 281 | raise NotConnectedError('Not connected to server') | |
| 282 | ||
| 283 | results = [ ] | |
| 284 | ||
| 285 | def cb(info): | |
| 286 | self.is_busy = False | |
| 287 | results.append(info) | |
| 288 | ||
| 289 | def eb(failure): | |
| 290 | self.is_busy = False | |
| 291 | raise failure | |
| 292 | ||
| 293 | self.is_busy = True | |
| 294 | try: | |
| 295 | self._getSecurity(service_name, path, cb, eb, timeout) | |
| 247 | 296 | while self.is_busy: |
| 248 | 297 | self._pollForNetBIOSPacket(timeout) |
| 249 | 298 | finally: |
| 349 | 398 | |
| 350 | 399 | return results[0] |
| 351 | 400 | |
| 352 | def deleteFiles(self, service_name, path_file_pattern, timeout = 30): | |
| 401 | def deleteFiles(self, service_name, path_file_pattern, delete_matching_folders = False, timeout = 30): | |
| 353 | 402 | """ |
| 354 | 403 | 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. |
| 404 | ||
| 405 | If delete_matching_folders is True, immediate sub-folders that match the path_file_pattern will be deleted recursively. | |
| 355 | 406 | |
| 356 | 407 | :param string/unicode service_name: Contains the name of the shared folder. |
| 357 | 408 | :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name. |
| 371 | 422 | |
| 372 | 423 | self.is_busy = True |
| 373 | 424 | try: |
| 374 | self._deleteFiles(service_name, path_file_pattern, cb, eb, timeout = timeout) | |
| 375 | while self.is_busy: | |
| 376 | self._pollForNetBIOSPacket(timeout) | |
| 377 | finally: | |
| 378 | self.is_busy = False | |
| 379 | ||
| 380 | def resetFileAttributes(self, service_name, path_file_pattern, timeout = 30): | |
| 425 | self._deleteFiles(service_name, path_file_pattern, delete_matching_folders, cb, eb, timeout = timeout) | |
| 426 | while self.is_busy: | |
| 427 | self._pollForNetBIOSPacket(timeout) | |
| 428 | finally: | |
| 429 | self.is_busy = False | |
| 430 | ||
| 431 | def resetFileAttributes(self, service_name, path_file_pattern, file_attributes = ATTR_NORMAL, timeout = 30): | |
| 381 | 432 | """ |
| 382 | 433 | Reset file attributes of one or more regular files or folders. |
| 383 | 434 | It supports the use of wildcards in file names, allowing for unlocking of multiple files/folders in a single request. |
| 384 | 435 | This function is very helpful when deleting files/folders that are read-only. |
| 385 | 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) | |
| 386 | ||
| 436 | By default, it sets the ATTR_NORMAL flag, therefore clearing all other flags. | |
| 437 | (See https://msdn.microsoft.com/en-us/library/cc232110.aspx for further information) | |
| 438 | ||
| 439 | Note: this function is currently only implemented for SMB2! | |
| 440 | ||
| 387 | 441 | :param string/unicode service_name: Contains the name of the shared folder. |
| 388 | 442 | :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name. |
| 389 | 443 | Wildcards may be used in the filename component of the path. |
| 390 | 444 | If your path/filename contains non-English characters, you must pass in an unicode string. |
| 445 | :param int file_attributes: The desired file attributes to set. Defaults to `ATTR_NORMAL`. | |
| 391 | 446 | :return: None |
| 392 | 447 | """ |
| 393 | 448 | if not self.sock: |
| 402 | 457 | |
| 403 | 458 | self.is_busy = True |
| 404 | 459 | try: |
| 405 | self._resetFileAttributes(service_name, path_file_pattern, cb, eb, timeout = timeout) | |
| 460 | self._resetFileAttributes(service_name, path_file_pattern, cb, eb, file_attributes, timeout = timeout) | |
| 406 | 461 | while self.is_busy: |
| 407 | 462 | self._pollForNetBIOSPacket(timeout) |
| 408 | 463 | finally: |
| 494 | 549 | """ |
| 495 | 550 | Send an echo command containing *data* to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same *data*. |
| 496 | 551 | |
| 497 | :param string data: Data to send to the remote server. | |
| 552 | :param bytes data: Data to send to the remote server. Must be a bytes object. | |
| 498 | 553 | :return: The *data* parameter |
| 499 | 554 | """ |
| 500 | 555 | if not self.sock: |
| 43 | 43 | passwd = passwd or '' |
| 44 | 44 | myname = MACHINE_NAME or self.generateClientMachineName() |
| 45 | 45 | |
| 46 | n = NetBIOS() | |
| 47 | names = n.queryIPForName(host) | |
| 48 | if names: | |
| 49 | server_name = names[0] | |
| 50 | else: | |
| 51 | raise urllib2.URLError('SMB error: Hostname does not reply back with its machine name') | |
| 46 | server_name,host = host.split(',') if ',' in host else [None,host] | |
| 47 | ||
| 48 | if server_name is None: | |
| 49 | n = NetBIOS() | |
| 50 | names = n.queryIPForName(host) | |
| 51 | if names: | |
| 52 | server_name = names[0] | |
| 53 | else: | |
| 54 | raise urllib2.URLError('SMB error: Hostname does not reply back with its machine name') | |
| 52 | 55 | |
| 53 | 56 | path, attrs = splitattr(req.get_selector()) |
| 54 | 57 | if path.startswith('/'): |
| 176 | 176 | return d |
| 177 | 177 | |
| 178 | 178 | def listPath(self, service_name, path, |
| 179 | search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE, | |
| 179 | search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL, | |
| 180 | 180 | pattern = '*', timeout = 30): |
| 181 | 181 | """ |
| 182 | 182 | Retrieve a directory listing of files/folders at *path* |
| 183 | ||
| 184 | For simplicity, pysmb defines a "normal" file as a file entry that is not read-only, not hidden, not system, not archive and not a directory. | |
| 185 | It ignores other attributes like compression, indexed, sparse, temporary and encryption. | |
| 186 | ||
| 187 | Note that the default search parameter will query for all read-only (SMB_FILE_ATTRIBUTE_READONLY), hidden (SMB_FILE_ATTRIBUTE_HIDDEN), | |
| 188 | system (SMB_FILE_ATTRIBUTE_SYSTEM), archive (SMB_FILE_ATTRIBUTE_ARCHIVE), normal (SMB_FILE_ATTRIBUTE_INCL_NORMAL) files | |
| 189 | and directories (SMB_FILE_ATTRIBUTE_DIRECTORY). | |
| 190 | If you do not need to include "normal" files in the result, define your own search parameter without the SMB_FILE_ATTRIBUTE_INCL_NORMAL constant. | |
| 191 | SMB_FILE_ATTRIBUTE_NORMAL should be used by itself and not be used with other bit constants. | |
| 183 | 192 | |
| 184 | 193 | :param string/unicode service_name: the name of the shared folder for the *path* |
| 185 | 194 | :param string/unicode path: path relative to the *service_name* where we are interested to learn about its files/sub-folders. |
| 186 | 195 | :param integer search: integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py). |
| 187 | The default *search* value will query for all read-only, hidden, system, archive files and directories. | |
| 188 | 196 | :param string/unicode pattern: the filter to apply to the results before returning to the client. |
| 189 | 197 | :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method. |
| 190 | 198 | :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of :doc:`smb.base.SharedFile<smb_SharedFile>` instances. |
| 367 | 375 | """ |
| 368 | 376 | Send an echo command containing *data* to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same *data*. |
| 369 | 377 | |
| 370 | :param string data: Data to send to the remote server. | |
| 378 | :param bytes data: Data to send to the remote server. Must be a bytes object. | |
| 371 | 379 | :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method. |
| 372 | 380 | :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *data* parameter. |
| 373 | 381 | """ |
| 4 | 4 | from smb2_constants import * |
| 5 | 5 | from smb_structs import * |
| 6 | 6 | from smb2_structs import * |
| 7 | from .security_descriptors import SecurityDescriptor | |
| 7 | 8 | from nmb.base import NMBSession |
| 8 | 9 | from utils import convertFILETIMEtoEpoch |
| 9 | 10 | import ntlm, securityblob |
| 58 | 59 | def __init__(self, username, password, my_name, remote_name, domain = '', use_ntlm_v2 = True, sign_options = SIGN_WHEN_REQUIRED, is_direct_tcp = False): |
| 59 | 60 | NMBSession.__init__(self, my_name, remote_name, is_direct_tcp = is_direct_tcp) |
| 60 | 61 | self.username = _convert_to_unicode(username) |
| 61 | self.password = _convert_to_unicode(password) | |
| 62 | self._password = password | |
| 62 | 63 | self.domain = _convert_to_unicode(domain) |
| 63 | 64 | self.sign_options = sign_options |
| 64 | 65 | self.is_direct_tcp = is_direct_tcp |
| 65 | 66 | self.use_ntlm_v2 = use_ntlm_v2 #: Similar to LMAuthenticationPolicy and NTAuthenticationPolicy as described in [MS-CIFS] 3.2.1.1 |
| 66 | 67 | self.smb_message = SMBMessage() |
| 67 | 68 | self.is_using_smb2 = False #: Are we communicating using SMB2 protocol? self.smb_message will be a SMB2Message instance if this flag is True |
| 69 | self.async_requests = { } #: AsyncID mapped to _PendingRequest instance | |
| 68 | 70 | self.pending_requests = { } #: MID mapped to _PendingRequest instance |
| 69 | 71 | self.connected_trees = { } #: Share name mapped to TID |
| 70 | 72 | 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 |
| 103 | 105 | (self.use_ntlm_v2 and 'v2') or 'v1', |
| 104 | 106 | (SUPPORT_EXTENDED_SECURITY and 'with') or 'without') |
| 105 | 107 | |
| 108 | @property | |
| 109 | def password(self): | |
| 110 | password = self._password() if callable(self._password) else self._password | |
| 111 | return _convert_to_unicode(password) | |
| 106 | 112 | |
| 107 | 113 | # |
| 108 | 114 | # NMBSession Methods |
| 172 | 178 | self._listShares = self._listShares_SMB1 |
| 173 | 179 | self._listPath = self._listPath_SMB1 |
| 174 | 180 | self._listSnapshots = self._listSnapshots_SMB1 |
| 181 | self._getSecurity = self._getSecurity_SMB1 | |
| 175 | 182 | self._getAttributes = self._getAttributes_SMB1 |
| 176 | 183 | self._retrieveFile = self._retrieveFile_SMB1 |
| 177 | 184 | self._retrieveFileFromOffset = self._retrieveFileFromOffset_SMB1 |
| 195 | 202 | self._listPath = self._listPath_SMB2 |
| 196 | 203 | self._listSnapshots = self._listSnapshots_SMB2 |
| 197 | 204 | self._getAttributes = self._getAttributes_SMB2 |
| 205 | self._getSecurity = self._getSecurity_SMB2 | |
| 198 | 206 | self._retrieveFile = self._retrieveFile_SMB2 |
| 199 | 207 | self._retrieveFileFromOffset = self._retrieveFileFromOffset_SMB2 |
| 200 | 208 | self._storeFile = self._storeFile_SMB2 |
| 218 | 226 | if smb_message.mid == 0: |
| 219 | 227 | smb_message.mid = self._getNextMID_SMB2() |
| 220 | 228 | |
| 221 | if smb_message.command != SMB2_COM_NEGOTIATE and smb_message.command != SMB2_COM_ECHO: | |
| 229 | if smb_message.command != SMB2_COM_NEGOTIATE: | |
| 222 | 230 | smb_message.session_id = self.session_id |
| 223 | 231 | |
| 224 | 232 | if self.is_signing_active: |
| 255 | 263 | if result == securityblob.RESULT_ACCEPT_COMPLETED: |
| 256 | 264 | self.has_authenticated = True |
| 257 | 265 | self.log.info('Authentication (on SMB2) successful!') |
| 266 | ||
| 267 | # [MS-SMB2]: 3.2.5.3.1 | |
| 268 | # If the security subsystem indicates that the session was established by an anonymous user, | |
| 269 | # Session.SigningRequired MUST be set to FALSE. | |
| 270 | # If the SMB2_SESSION_FLAG_IS_GUEST bit is set in the SessionFlags field of the | |
| 271 | # SMB2 SESSION_SETUP Response and if Session.SigningRequired is TRUE, this indicates a SESSION_SETUP | |
| 272 | # failure and the connection MUST be terminated. If the SMB2_SESSION_FLAG_IS_GUEST bit is set in the SessionFlags | |
| 273 | # field of the SMB2 SESSION_SETUP Response and if RequireMessageSigning is FALSE, Session.SigningRequired | |
| 274 | # MUST be set to FALSE. | |
| 275 | if message.payload.isGuestSession or message.payload.isAnonymousSession: | |
| 276 | self.is_signing_active = False | |
| 277 | self.log.info('Signing disabled because session is guest/anonymous') | |
| 278 | ||
| 258 | 279 | self.onAuthOK() |
| 259 | 280 | else: |
| 260 | 281 | raise ProtocolError('SMB2_COM_SESSION_SETUP status is 0 but security blob negResult value is %d' % result, message.raw_data, message) |
| 268 | 289 | self._handleSessionChallenge(message, ntlm_token) |
| 269 | 290 | except ( securityblob.BadSecurityBlobError, securityblob.UnsupportedSecurityProvider ), ex: |
| 270 | 291 | raise ProtocolError(str(ex), message.raw_data, message) |
| 271 | elif message.status == 0xc000006d: # STATUS_LOGON_FAILURE | |
| 292 | elif (message.status == 0xc000006d # STATUS_LOGON_FAILURE | |
| 293 | or message.status == 0xc0000064 # STATUS_NO_SUCH_USER | |
| 294 | or message.status == 0xc000006a):# STATUS_WRONG_PASSWORD | |
| 272 | 295 | self.has_authenticated = False |
| 273 | 296 | self.log.info('Authentication (on SMB2) failed. Please check username and password.') |
| 274 | 297 | self.onAuthFailed() |
| 298 | elif (message.status == 0xc0000193 # STATUS_ACCOUNT_EXPIRED | |
| 299 | or message.status == 0xC0000071): # STATUS_PASSWORD_EXPIRED | |
| 300 | self.has_authenticated = False | |
| 301 | self.log.info('Authentication (on SMB2) failed. Account or password has expired.') | |
| 302 | self.onAuthFailed() | |
| 303 | elif message.status == 0xc0000234: # STATUS_ACCOUNT_LOCKED_OUT | |
| 304 | self.has_authenticated = False | |
| 305 | self.log.info('Authentication (on SMB2) failed. Account has been locked due to too many invalid logon attempts.') | |
| 306 | self.onAuthFailed() | |
| 307 | elif message.status == 0xc0000072: # STATUS_ACCOUNT_DISABLED | |
| 308 | self.has_authenticated = False | |
| 309 | self.log.info('Authentication (on SMB2) failed. Account has been disabled.') | |
| 310 | self.onAuthFailed() | |
| 311 | elif (message.status == 0xc000006f # STATUS_INVALID_LOGON_HOURS | |
| 312 | or message.status == 0xc000015b # STATUS_LOGON_TYPE_NOT_GRANTED | |
| 313 | or message.status == 0xc0000070): # STATUS_INVALID_WORKSTATION | |
| 314 | self.has_authenticated = False | |
| 315 | self.log.info('Authentication (on SMB2) failed. Not allowed.') | |
| 316 | self.onAuthFailed() | |
| 317 | elif message.status == 0xc000018c: # STATUS_TRUSTED_DOMAIN_FAILURE | |
| 318 | self.has_authenticated = False | |
| 319 | self.log.info('Authentication (on SMB2) failed. Domain not trusted.') | |
| 320 | self.onAuthFailed() | |
| 321 | elif message.status == 0xc000018d: # STATUS_TRUSTED_RELATIONSHIP_FAILURE | |
| 322 | self.has_authenticated = False | |
| 323 | self.log.info('Authentication (on SMB2) failed. Workstation not trusted.') | |
| 324 | self.onAuthFailed() | |
| 275 | 325 | else: |
| 276 | 326 | raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_SESSION_SETUP_ANDX (with extended security)' % message.status, |
| 277 | 327 | message.raw_data, message) |
| 278 | 328 | |
| 279 | req = self.pending_requests.pop(message.mid, None) | |
| 280 | if req: | |
| 281 | req.callback(message, **req.kwargs) | |
| 282 | return True | |
| 329 | if message.isAsync: | |
| 330 | if message.status == 0x00000103: # STATUS_PENDING | |
| 331 | req = self.pending_requests.pop(message.mid, None) | |
| 332 | if req: | |
| 333 | self.async_requests[message.async_id] = req | |
| 334 | else: # All other status including SUCCESS | |
| 335 | req = self.async_requests.pop(message.async_id, None) | |
| 336 | if req: | |
| 337 | req.callback(message, **req.kwargs) | |
| 338 | return True | |
| 339 | else: | |
| 340 | req = self.pending_requests.pop(message.mid, None) | |
| 341 | if req: | |
| 342 | req.callback(message, **req.kwargs) | |
| 343 | return True | |
| 283 | 344 | |
| 284 | 345 | |
| 285 | 346 | def _updateServerInfo_SMB2(self, payload): |
| 314 | 375 | self.log.info('Performing NTLMv1 authentication (on SMB2) with server challenge "%s"', binascii.hexlify(server_challenge)) |
| 315 | 376 | nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(self.password, server_challenge, True) |
| 316 | 377 | |
| 317 | ntlm_data = ntlm.generateAuthenticateMessage(server_flags, | |
| 318 | nt_challenge_response, | |
| 319 | lm_challenge_response, | |
| 320 | session_key, | |
| 321 | self.username, | |
| 322 | self.domain) | |
| 378 | ntlm_data, session_signing_key = ntlm.generateAuthenticateMessage(server_flags, | |
| 379 | nt_challenge_response, | |
| 380 | lm_challenge_response, | |
| 381 | session_key, | |
| 382 | self.username, | |
| 383 | self.domain, | |
| 384 | self.my_name) | |
| 323 | 385 | |
| 324 | 386 | if self.log.isEnabledFor(logging.DEBUG): |
| 325 | 387 | self.log.debug('NT challenge response is "%s" (%d bytes)', binascii.hexlify(nt_challenge_response), len(nt_challenge_response)) |
| 339 | 401 | |
| 340 | 402 | if self.is_signing_active: |
| 341 | 403 | self.log.info("SMB signing activated. All SMB messages will be signed.") |
| 342 | self.signing_session_key = (session_key + '\0'*16)[:16] | |
| 404 | self.signing_session_key = session_signing_key | |
| 405 | if self.log.isEnabledFor(logging.DEBUG): | |
| 406 | self.log.info("SMB signing key is %s", binascii.hexlify(self.signing_session_key)) | |
| 407 | ||
| 343 | 408 | if self.capabilities & CAP_EXTENDED_SECURITY: |
| 344 | 409 | self.signing_challenge_response = None |
| 345 | 410 | else: |
| 368 | 433 | |
| 369 | 434 | m.tid = tid |
| 370 | 435 | self._sendSMBMessage(m) |
| 371 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectSrvSvcCB, errback) | |
| 436 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectSrvSvcCB, errback, tid = tid) | |
| 372 | 437 | messages_history.append(m) |
| 373 | 438 | |
| 374 | 439 | def connectSrvSvcCB(create_message, **kwargs): |
| 390 | 455 | 01 00 00 00 |
| 391 | 456 | """.replace(' ', '').replace('\n', '')) |
| 392 | 457 | m = SMB2Message(SMB2WriteRequest(create_message.payload.fid, data_bytes, 0)) |
| 393 | m.tid = create_message.tid | |
| 458 | m.tid = kwargs['tid'] | |
| 394 | 459 | self._sendSMBMessage(m) |
| 395 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, rpcBindCB, errback, fid = create_message.payload.fid) | |
| 460 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, rpcBindCB, errback, tid = kwargs['tid'], fid = create_message.payload.fid) | |
| 396 | 461 | messages_history.append(m) |
| 397 | 462 | else: |
| 398 | 463 | errback(OperationFailure('Failed to list shares: Unable to locate Server Service RPC endpoint', messages_history)) |
| 401 | 466 | messages_history.append(trans_message) |
| 402 | 467 | if trans_message.status == 0: |
| 403 | 468 | m = SMB2Message(SMB2ReadRequest(kwargs['fid'], read_len = 1024, read_offset = 0)) |
| 404 | m.tid = trans_message.tid | |
| 469 | m.tid = kwargs['tid'] | |
| 405 | 470 | self._sendSMBMessage(m) |
| 406 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, rpcReadCB, errback, fid = kwargs['fid']) | |
| 471 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, rpcReadCB, errback, tid = kwargs['tid'], fid = kwargs['fid']) | |
| 407 | 472 | messages_history.append(m) |
| 408 | 473 | else: |
| 409 | closeFid(trans_message.tid, kwargs['fid'], error = 'Failed to list shares: Unable to read from Server Service RPC endpoint') | |
| 474 | closeFid(kwargs['tid'], kwargs['fid'], error = 'Failed to list shares: Unable to read from Server Service RPC endpoint') | |
| 410 | 475 | |
| 411 | 476 | def rpcReadCB(read_message, **kwargs): |
| 412 | 477 | messages_history.append(read_message) |
| 434 | 499 | 00 00 00 00 ff ff ff ff 08 00 02 00 00 00 00 00 |
| 435 | 500 | """.replace(' ', '').replace('\n', '')) |
| 436 | 501 | m = SMB2Message(SMB2IoctlRequest(kwargs['fid'], 0x0011C017, flags = 0x01, max_out_size = 8196, in_data = data_bytes)) |
| 437 | m.tid = read_message.tid | |
| 502 | m.tid = kwargs['tid'] | |
| 438 | 503 | self._sendSMBMessage(m) |
| 439 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, listShareResultsCB, errback, fid = kwargs['fid']) | |
| 504 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, listShareResultsCB, errback, tid = kwargs['tid'], fid = kwargs['fid']) | |
| 440 | 505 | messages_history.append(m) |
| 441 | 506 | else: |
| 442 | closeFid(read_message.tid, kwargs['fid'], error = 'Failed to list shares: Unable to bind to Server Service RPC endpoint') | |
| 507 | closeFid(kwargs['tid'], kwargs['fid'], error = 'Failed to list shares: Unable to bind to Server Service RPC endpoint') | |
| 443 | 508 | |
| 444 | 509 | def listShareResultsCB(result_message, **kwargs): |
| 445 | 510 | messages_history.append(result_message) |
| 448 | 513 | data_bytes = result_message.payload.out_data |
| 449 | 514 | |
| 450 | 515 | if ord(data_bytes[3]) & 0x02 == 0: |
| 451 | sendReadRequest(result_message.tid, kwargs['fid'], data_bytes) | |
| 452 | else: | |
| 453 | decodeResults(result_message.tid, kwargs['fid'], data_bytes) | |
| 454 | elif result_message.status == 0x0103: # STATUS_PENDING | |
| 455 | self.pending_requests[result_message.mid] = _PendingRequest(result_message.mid, expiry_time, listShareResultsCB, errback, fid = kwargs['fid']) | |
| 456 | else: | |
| 457 | closeFid(result_message.tid, kwargs['fid']) | |
| 516 | sendReadRequest(kwargs['tid'], kwargs['fid'], data_bytes) | |
| 517 | else: | |
| 518 | decodeResults(kwargs['tid'], kwargs['fid'], data_bytes) | |
| 519 | else: | |
| 520 | closeFid(kwargs['tid'], kwargs['fid']) | |
| 458 | 521 | errback(OperationFailure('Failed to list shares: Unable to retrieve shared device list', messages_history)) |
| 459 | 522 | |
| 460 | 523 | def decodeResults(tid, fid, data_bytes): |
| 493 | 556 | m.tid = tid |
| 494 | 557 | self._sendSMBMessage(m) |
| 495 | 558 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback, |
| 496 | fid = fid, data_bytes = data_bytes) | |
| 559 | tid = tid, fid = fid, data_bytes = data_bytes) | |
| 497 | 560 | |
| 498 | 561 | def readCB(read_message, **kwargs): |
| 499 | 562 | messages_history.append(read_message) |
| 500 | 563 | if read_message.status == 0: |
| 501 | data_len = read_message.payload.data_length | |
| 502 | 564 | data_bytes = read_message.payload.data |
| 503 | 565 | |
| 504 | 566 | if ord(data_bytes[3]) & 0x02 == 0: |
| 505 | sendReadRequest(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:data_len-24]) | |
| 506 | else: | |
| 507 | decodeResults(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:data_len-24]) | |
| 508 | else: | |
| 509 | closeFid(read_message.tid, kwargs['fid']) | |
| 567 | sendReadRequest(kwargs['tid'], kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:]) | |
| 568 | else: | |
| 569 | decodeResults(kwargs['tid'], kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:]) | |
| 570 | else: | |
| 571 | closeFid(kwargs['tid'], kwargs['fid']) | |
| 510 | 572 | errback(OperationFailure('Failed to list shares: Unable to retrieve shared device list', messages_history)) |
| 511 | 573 | |
| 512 | 574 | def closeFid(tid, fid, results = None, error = None): |
| 571 | 633 | create_context_data = create_context_data)) |
| 572 | 634 | m.tid = tid |
| 573 | 635 | self._sendSMBMessage(m) |
| 574 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback) | |
| 636 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid) | |
| 575 | 637 | messages_history.append(m) |
| 576 | 638 | |
| 577 | 639 | def createCB(create_message, **kwargs): |
| 578 | 640 | messages_history.append(create_message) |
| 579 | 641 | if create_message.status == 0: |
| 580 | sendQuery(create_message.tid, create_message.payload.fid, '') | |
| 642 | sendQuery(kwargs['tid'], create_message.payload.fid, '') | |
| 643 | elif create_message.status == 0xC0000034L: # [MS-ERREF]: STATUS_OBJECT_NAME_INVALID | |
| 644 | errback(OperationFailure('Failed to list %s on %s: Path not found' % ( path, service_name ), messages_history)) | |
| 581 | 645 | else: |
| 582 | 646 | errback(OperationFailure('Failed to list %s on %s: Unable to open directory' % ( path, service_name ), messages_history)) |
| 583 | 647 | |
| 584 | 648 | def sendQuery(tid, fid, data_buf): |
| 585 | 649 | m = SMB2Message(SMB2QueryDirectoryRequest(fid, pattern, |
| 586 | info_class = 0x03, # FileBothDirectoryInformation | |
| 650 | info_class = 0x25, # FileIdBothDirectoryInformation | |
| 587 | 651 | flags = 0, |
| 588 | 652 | output_buf_len = self.max_transact_size)) |
| 589 | 653 | m.tid = tid |
| 590 | 654 | self._sendSMBMessage(m) |
| 591 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, queryCB, errback, fid = fid, data_buf = data_buf) | |
| 655 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, queryCB, errback, tid = tid, fid = fid, data_buf = data_buf) | |
| 592 | 656 | messages_history.append(m) |
| 593 | 657 | |
| 594 | 658 | def queryCB(query_message, **kwargs): |
| 595 | 659 | messages_history.append(query_message) |
| 596 | 660 | if query_message.status == 0: |
| 597 | 661 | data_buf = decodeQueryStruct(kwargs['data_buf'] + query_message.payload.data) |
| 598 | sendQuery(query_message.tid, kwargs['fid'], data_buf) | |
| 662 | sendQuery(kwargs['tid'], kwargs['fid'], data_buf) | |
| 663 | elif query_message.status == 0xC000000FL: # [MS-ERREF]: STATUS_NO_SUCH_FILE | |
| 664 | # If there are no matching files, we just treat as success instead of failing | |
| 665 | closeFid(kwargs['tid'], kwargs['fid'], results = results) | |
| 599 | 666 | elif query_message.status == 0x80000006L: # STATUS_NO_MORE_FILES |
| 600 | closeFid(query_message.tid, kwargs['fid'], results = results) | |
| 601 | else: | |
| 602 | closeFid(query_message.tid, kwargs['fid'], error = query_message.status) | |
| 667 | closeFid(kwargs['tid'], kwargs['fid'], results = results) | |
| 668 | else: | |
| 669 | closeFid(kwargs['tid'], kwargs['fid'], error = query_message.status) | |
| 603 | 670 | |
| 604 | 671 | def decodeQueryStruct(data_bytes): |
| 605 | # SMB_FIND_FILE_BOTH_DIRECTORY_INFO structure. See [MS-CIFS]: 2.2.8.1.7 and [MS-SMB]: 2.2.8.1.1 | |
| 606 | info_format = '<IIQQQQQQIIIBB24s' | |
| 672 | # FileIdBothDirectoryInformation structure. See [MS-SMB]: 2.2.8.1.3 and [MS-FSCC]: 2.4.17 | |
| 673 | info_format = '<IIQQQQQQIIIBB24sHQ' | |
| 607 | 674 | info_size = struct.calcsize(info_format) |
| 608 | 675 | |
| 609 | 676 | data_length = len(data_bytes) |
| 615 | 682 | next_offset, _, \ |
| 616 | 683 | create_time, last_access_time, last_write_time, last_attr_change_time, \ |
| 617 | 684 | file_size, alloc_size, file_attributes, filename_length, ea_size, \ |
| 618 | short_name_length, _, short_name = struct.unpack(info_format, data_bytes[offset:offset+info_size]) | |
| 685 | short_name_length, _, short_name, _, file_id = struct.unpack(info_format, data_bytes[offset:offset+info_size]) | |
| 619 | 686 | |
| 620 | 687 | offset2 = offset + info_size |
| 621 | 688 | if offset2 + filename_length > data_length: |
| 622 | 689 | return data_bytes[offset:] |
| 623 | 690 | |
| 624 | 691 | filename = data_bytes[offset2:offset2+filename_length].decode('UTF-16LE') |
| 625 | short_name = short_name.decode('UTF-16LE') | |
| 626 | results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time), | |
| 627 | convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time), | |
| 628 | file_size, alloc_size, file_attributes, short_name, filename)) | |
| 692 | short_name = short_name[:short_name_length].decode('UTF-16LE') | |
| 693 | ||
| 694 | accept_result = False | |
| 695 | if (file_attributes & 0xff) in ( 0x00, ATTR_NORMAL ): # Only the first 8-bits are compared. We ignore other bits like temp, compressed, encryption, sparse, indexed, etc | |
| 696 | accept_result = (search == SMB_FILE_ATTRIBUTE_NORMAL) or (search & SMB_FILE_ATTRIBUTE_INCL_NORMAL) | |
| 697 | else: | |
| 698 | accept_result = (file_attributes & search) > 0 | |
| 699 | if accept_result: | |
| 700 | results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time), | |
| 701 | convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time), | |
| 702 | file_size, alloc_size, file_attributes, short_name, filename, file_id)) | |
| 629 | 703 | |
| 630 | 704 | if next_offset: |
| 631 | 705 | offset += next_offset |
| 644 | 718 | if kwargs['results'] is not None: |
| 645 | 719 | callback(kwargs['results']) |
| 646 | 720 | elif kwargs['error'] is not None: |
| 647 | errback(OperationFailure('Failed to list %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history)) | |
| 721 | if kwargs['error'] == 0xC000000F: # [MS-ERREF]: STATUS_NO_SUCH_FILE | |
| 722 | # Remote server returns STATUS_NO_SUCH_FILE error so we assume that the search returns no matching files | |
| 723 | callback([ ]) | |
| 724 | else: | |
| 725 | errback(OperationFailure('Failed to list %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history)) | |
| 648 | 726 | |
| 649 | 727 | if not self.connected_trees.has_key(service_name): |
| 650 | 728 | def connectCB(connect_message, **kwargs): |
| 694 | 772 | create_context_data = create_context_data)) |
| 695 | 773 | m.tid = tid |
| 696 | 774 | self._sendSMBMessage(m) |
| 697 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback) | |
| 775 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid) | |
| 698 | 776 | messages_history.append(m) |
| 699 | 777 | |
| 700 | 778 | def createCB(create_message, **kwargs): |
| 701 | 779 | messages_history.append(create_message) |
| 702 | 780 | if create_message.status == 0: |
| 703 | 781 | p = create_message.payload |
| 782 | filename = self._extractLastPathComponent(unicode(path)) | |
| 704 | 783 | info = SharedFile(p.create_time, p.lastaccess_time, p.lastwrite_time, p.change_time, |
| 705 | 784 | p.file_size, p.allocation_size, p.file_attributes, |
| 706 | unicode(path), unicode(path)) | |
| 707 | closeFid(create_message.tid, p.fid, info = info) | |
| 785 | filename, filename) | |
| 786 | closeFid(kwargs['tid'], p.fid, info = info) | |
| 708 | 787 | else: |
| 709 | 788 | errback(OperationFailure('Failed to get attributes for %s on %s: Unable to open remote file object' % ( path, service_name ), messages_history)) |
| 710 | 789 | |
| 729 | 808 | sendCreate(connect_message.tid) |
| 730 | 809 | else: |
| 731 | 810 | errback(OperationFailure('Failed to get attributes for %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) |
| 811 | ||
| 812 | m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ))) | |
| 813 | self._sendSMBMessage(m) | |
| 814 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name) | |
| 815 | messages_history.append(m) | |
| 816 | else: | |
| 817 | sendCreate(self.connected_trees[service_name]) | |
| 818 | ||
| 819 | def _getSecurity_SMB2(self, service_name, path, callback, errback, timeout = 30): | |
| 820 | if not self.has_authenticated: | |
| 821 | raise NotReadyError('SMB connection not authenticated') | |
| 822 | ||
| 823 | expiry_time = time.time() + timeout | |
| 824 | path = path.replace('/', '\\') | |
| 825 | if path.startswith('\\'): | |
| 826 | path = path[1:] | |
| 827 | if path.endswith('\\'): | |
| 828 | path = path[:-1] | |
| 829 | messages_history = [ ] | |
| 830 | results = [ ] | |
| 831 | ||
| 832 | def sendCreate(tid): | |
| 833 | m = SMB2Message(SMB2CreateRequest(path, | |
| 834 | file_attributes = 0, | |
| 835 | access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | READ_CONTROL | SYNCHRONIZE, | |
| 836 | share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE, | |
| 837 | oplock = SMB2_OPLOCK_LEVEL_NONE, | |
| 838 | impersonation = SEC_IMPERSONATE, | |
| 839 | create_options = 0, | |
| 840 | create_disp = FILE_OPEN)) | |
| 841 | m.tid = tid | |
| 842 | self._sendSMBMessage(m) | |
| 843 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid) | |
| 844 | messages_history.append(m) | |
| 845 | ||
| 846 | def createCB(create_message, **kwargs): | |
| 847 | messages_history.append(create_message) | |
| 848 | if create_message.status == 0: | |
| 849 | m = SMB2Message(SMB2QueryInfoRequest(create_message.payload.fid, | |
| 850 | flags = 0, | |
| 851 | additional_info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION | DACL_SECURITY_INFORMATION, | |
| 852 | info_type = SMB2_INFO_SECURITY, | |
| 853 | file_info_class = 0, # [MS-SMB2] 2.2.37, 3.2.4.12 | |
| 854 | input_buf = '', | |
| 855 | output_buf_len = self.max_transact_size)) | |
| 856 | m.tid = kwargs['tid'] | |
| 857 | self._sendSMBMessage(m) | |
| 858 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, queryCB, errback, tid = kwargs['tid'], fid = create_message.payload.fid) | |
| 859 | messages_history.append(m) | |
| 860 | else: | |
| 861 | errback(OperationFailure('Failed to get the security descriptor of %s on %s: Unable to open file or directory' % ( path, service_name ), messages_history)) | |
| 862 | ||
| 863 | def queryCB(query_message, **kwargs): | |
| 864 | messages_history.append(query_message) | |
| 865 | if query_message.status == 0: | |
| 866 | security = SecurityDescriptor.from_bytes(query_message.payload.data) | |
| 867 | closeFid(kwargs['tid'], kwargs['fid'], result = security) | |
| 868 | else: | |
| 869 | closeFid(kwargs['tid'], kwargs['fid'], error = query_message.status) | |
| 870 | ||
| 871 | def closeFid(tid, fid, result = None, error = None): | |
| 872 | m = SMB2Message(SMB2CloseRequest(fid)) | |
| 873 | m.tid = tid | |
| 874 | self._sendSMBMessage(m) | |
| 875 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, result = result, error = error) | |
| 876 | messages_history.append(m) | |
| 877 | ||
| 878 | def closeCB(close_message, **kwargs): | |
| 879 | if kwargs['result'] is not None: | |
| 880 | callback(kwargs['result']) | |
| 881 | elif kwargs['error'] is not None: | |
| 882 | errback(OperationFailure('Failed to get the security descriptor of %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history)) | |
| 883 | ||
| 884 | if not self.connected_trees.has_key(service_name): | |
| 885 | def connectCB(connect_message, **kwargs): | |
| 886 | messages_history.append(connect_message) | |
| 887 | if connect_message.status == 0: | |
| 888 | self.connected_trees[service_name] = connect_message.tid | |
| 889 | sendCreate(connect_message.tid) | |
| 890 | else: | |
| 891 | errback(OperationFailure('Failed to get the security descriptor of %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 732 | 892 | |
| 733 | 893 | m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ))) |
| 734 | 894 | self._sendSMBMessage(m) |
| 765 | 925 | m = SMB2Message(SMB2CreateRequest(path, |
| 766 | 926 | file_attributes = 0, |
| 767 | 927 | access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | READ_CONTROL | SYNCHRONIZE, |
| 768 | share_access = FILE_SHARE_READ, | |
| 928 | share_access = FILE_SHARE_READ | FILE_SHARE_WRITE, | |
| 769 | 929 | oplock = SMB2_OPLOCK_LEVEL_NONE, |
| 770 | 930 | impersonation = SEC_IMPERSONATE, |
| 771 | 931 | create_options = FILE_SEQUENTIAL_ONLY | FILE_NON_DIRECTORY_FILE, |
| 783 | 943 | flags = 0, |
| 784 | 944 | additional_info = 0, |
| 785 | 945 | info_type = SMB2_INFO_FILE, |
| 786 | file_info_class = 0x16, # FileStreamInformation [MS-FSCC] 2.4 | |
| 946 | file_info_class = 0x05, # FileStandardInformation [MS-FSCC] 2.4 | |
| 787 | 947 | input_buf = '', |
| 788 | 948 | output_buf_len = 4096)) |
| 789 | m.tid = create_message.tid | |
| 949 | m.tid = kwargs['tid'] | |
| 790 | 950 | self._sendSMBMessage(m) |
| 791 | 951 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, infoCB, errback, |
| 792 | fid = create_message.payload.fid, file_attributes = create_message.payload.file_attributes) | |
| 952 | tid = kwargs['tid'], | |
| 953 | fid = create_message.payload.fid, | |
| 954 | file_attributes = create_message.payload.file_attributes) | |
| 793 | 955 | messages_history.append(m) |
| 794 | 956 | else: |
| 795 | errback(OperationFailure('Failed to list %s on %s: Unable to open file' % ( path, service_name ), messages_history)) | |
| 957 | errback(OperationFailure('Failed to retrieve %s on %s: Unable to open file' % ( path, service_name ), messages_history)) | |
| 796 | 958 | |
| 797 | 959 | def infoCB(info_message, **kwargs): |
| 798 | 960 | messages_history.append(info_message) |
| 807 | 969 | remaining_len = file_len |
| 808 | 970 | if starting_offset + remaining_len > file_len: |
| 809 | 971 | remaining_len = file_len - starting_offset |
| 810 | sendRead(info_message.tid, kwargs['fid'], starting_offset, remaining_len, 0, kwargs['file_attributes']) | |
| 811 | else: | |
| 812 | errback(OperationFailure('Failed to list %s on %s: Unable to retrieve information on file' % ( path, service_name ), messages_history)) | |
| 972 | sendRead(kwargs['tid'], kwargs['fid'], starting_offset, remaining_len, 0, kwargs['file_attributes']) | |
| 973 | else: | |
| 974 | errback(OperationFailure('Failed to retrieve %s on %s: Unable to retrieve information on file' % ( path, service_name ), messages_history)) | |
| 813 | 975 | |
| 814 | 976 | def sendRead(tid, fid, offset, remaining_len, read_len, file_attributes): |
| 815 | 977 | read_count = min(self.max_read_size, remaining_len) |
| 817 | 979 | m.tid = tid |
| 818 | 980 | self._sendSMBMessage(m) |
| 819 | 981 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback, |
| 820 | fid = fid, offset = offset, | |
| 982 | tid = tid, fid = fid, offset = offset, | |
| 821 | 983 | remaining_len = remaining_len, |
| 822 | 984 | read_len = read_len, |
| 823 | 985 | file_attributes = file_attributes) |
| 831 | 993 | remaining_len = kwargs['remaining_len'] - data_len |
| 832 | 994 | |
| 833 | 995 | if remaining_len > 0: |
| 834 | sendRead(read_message.tid, kwargs['fid'], kwargs['offset'] + data_len, remaining_len, kwargs['read_len'] + data_len, kwargs['file_attributes']) | |
| 835 | else: | |
| 836 | closeFid(read_message.tid, kwargs['fid'], ret = ( file_obj, kwargs['file_attributes'], kwargs['read_len'] + data_len )) | |
| 996 | sendRead(kwargs['tid'], kwargs['fid'], kwargs['offset'] + data_len, remaining_len, kwargs['read_len'] + data_len, kwargs['file_attributes']) | |
| 997 | else: | |
| 998 | closeFid(kwargs['tid'], kwargs['fid'], ret = ( file_obj, kwargs['file_attributes'], kwargs['read_len'] + data_len )) | |
| 837 | 999 | else: |
| 838 | 1000 | messages_history.append(read_message) |
| 839 | closeFid(read_message.tid, kwargs['fid'], error = read_message.status) | |
| 1001 | closeFid(kwargs['tid'], kwargs['fid'], error = read_message.status) | |
| 840 | 1002 | |
| 841 | 1003 | def closeFid(tid, fid, ret = None, error = None): |
| 842 | 1004 | m = SMB2Message(SMB2CloseRequest(fid)) |
| 912 | 1074 | messages_history.append(create_message) |
| 913 | 1075 | if create_message.status == 0: |
| 914 | 1076 | sendWrite(create_message.tid, create_message.payload.fid, starting_offset) |
| 915 | elif create_message.status == 0x0103: # STATUS_PENDING | |
| 916 | self.pending_requests[create_message.mid] = _PendingRequest(create_message.mid, expiry_time, | |
| 917 | createCB, errback, | |
| 918 | tid=kwargs['tid']) | |
| 919 | 1077 | else: |
| 920 | 1078 | errback(OperationFailure('Failed to store %s on %s: Unable to open file' % ( path, service_name ), messages_history)) |
| 921 | 1079 | |
| 927 | 1085 | m = SMB2Message(SMB2WriteRequest(fid, data, offset)) |
| 928 | 1086 | m.tid = tid |
| 929 | 1087 | self._sendSMBMessage(m) |
| 930 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, writeCB, errback, fid = fid, offset = offset+data_len) | |
| 1088 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, writeCB, errback, tid = tid, fid = fid, offset = offset+data_len) | |
| 931 | 1089 | else: |
| 932 | 1090 | closeFid(tid, fid, offset = offset) |
| 933 | 1091 | |
| 934 | 1092 | def writeCB(write_message, **kwargs): |
| 935 | 1093 | # To avoid crazy memory usage when saving large files, we do not save every write_message in messages_history. |
| 936 | 1094 | if write_message.status == 0: |
| 937 | sendWrite(write_message.tid, kwargs['fid'], kwargs['offset']) | |
| 1095 | sendWrite(kwargs['tid'], kwargs['fid'], kwargs['offset']) | |
| 938 | 1096 | else: |
| 939 | 1097 | messages_history.append(write_message) |
| 940 | closeFid(write_message.tid, kwargs['fid']) | |
| 1098 | closeFid(kwargs['tid'], kwargs['fid']) | |
| 941 | 1099 | errback(OperationFailure('Failed to store %s on %s: Write failed' % ( path, service_name ), messages_history)) |
| 942 | 1100 | |
| 943 | 1101 | def closeFid(tid, fid, error = None, offset = None): |
| 970 | 1128 | sendCreate(self.connected_trees[service_name]) |
| 971 | 1129 | |
| 972 | 1130 | |
| 973 | def _deleteFiles_SMB2(self, service_name, path_file_pattern, callback, errback, timeout = 30): | |
| 1131 | def _deleteFiles_SMB2(self, service_name, path_file_pattern, delete_matching_folders, callback, errback, timeout = 30): | |
| 974 | 1132 | if not self.has_authenticated: |
| 975 | 1133 | raise NotReadyError('SMB connection not authenticated') |
| 976 | 1134 | |
| 977 | 1135 | expiry_time = time.time() + timeout |
| 1136 | pattern = None | |
| 978 | 1137 | path = path_file_pattern.replace('/', '\\') |
| 979 | 1138 | if path.startswith('\\'): |
| 980 | 1139 | path = path[1:] |
| 981 | 1140 | if path.endswith('\\'): |
| 982 | 1141 | path = path[:-1] |
| 1142 | else: | |
| 1143 | path_components = path.split('\\') | |
| 1144 | if path_components[-1].find('*') > -1 or path_components[-1].find('?') > -1: | |
| 1145 | path = '\\'.join(path_components[:-1]) | |
| 1146 | pattern = path_components[-1] | |
| 1147 | messages_history, files_queue = [ ], [ ] | |
| 1148 | ||
| 1149 | if pattern is None: | |
| 1150 | path_components = path.split('\\') | |
| 1151 | if len(path_components) > 1: | |
| 1152 | files_queue.append(( '\\'.join(path_components[:-1]), path_components[-1] )) | |
| 1153 | else: | |
| 1154 | files_queue.append(( '', path )) | |
| 1155 | ||
| 1156 | def deleteCB(path): | |
| 1157 | if files_queue: | |
| 1158 | p, filename = files_queue.pop(0) | |
| 1159 | if filename: | |
| 1160 | if p: | |
| 1161 | filename = p + '\\' + filename | |
| 1162 | self._deleteFiles_SMB2__del(service_name, self.connected_trees[service_name], filename, deleteCB, errback, timeout) | |
| 1163 | else: | |
| 1164 | self._deleteDirectory_SMB2(service_name, p, deleteCB, errback, timeout) | |
| 1165 | else: | |
| 1166 | callback(path_file_pattern) | |
| 1167 | ||
| 1168 | def listCB(files_list): | |
| 1169 | files_queue.extend(files_list) | |
| 1170 | deleteCB(None) | |
| 1171 | ||
| 1172 | if not self.connected_trees.has_key(service_name): | |
| 1173 | def connectCB(connect_message, **kwargs): | |
| 1174 | messages_history.append(connect_message) | |
| 1175 | if connect_message.status == 0: | |
| 1176 | self.connected_trees[service_name] = connect_message.tid | |
| 1177 | if files_queue: | |
| 1178 | deleteCB(None) | |
| 1179 | else: | |
| 1180 | self._deleteFiles_SMB2__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout) | |
| 1181 | else: | |
| 1182 | errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 1183 | ||
| 1184 | m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ))) | |
| 1185 | self._sendSMBMessage(m) | |
| 1186 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name) | |
| 1187 | messages_history.append(m) | |
| 1188 | else: | |
| 1189 | if files_queue: | |
| 1190 | deleteCB(None) | |
| 1191 | else: | |
| 1192 | self._deleteFiles_SMB2__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout) | |
| 1193 | ||
| 1194 | def _deleteFiles_SMB2__list(self, service_name, path, pattern, delete_matching_folders, callback, errback, timeout = 30): | |
| 1195 | folder_queue = [ ] | |
| 1196 | files_list = [ ] | |
| 1197 | current_path = [ path ] | |
| 1198 | search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL | |
| 1199 | ||
| 1200 | def listCB(results): | |
| 1201 | files = [ ] | |
| 1202 | for f in filter(lambda x: x.filename not in [ '.', '..' ], results): | |
| 1203 | if f.isDirectory: | |
| 1204 | if delete_matching_folders: | |
| 1205 | folder_queue.append(current_path[0]+'\\'+f.filename) | |
| 1206 | else: | |
| 1207 | files.append(( current_path[0], f.filename )) | |
| 1208 | if current_path[0]!=path and delete_matching_folders: | |
| 1209 | files.append(( current_path[0], None )) | |
| 1210 | ||
| 1211 | if files: | |
| 1212 | files_list[0:0] = files | |
| 1213 | ||
| 1214 | if folder_queue: | |
| 1215 | p = folder_queue.pop() | |
| 1216 | current_path[0] = p | |
| 1217 | self._listPath_SMB2(service_name, current_path[0], listCB, errback, search = search, pattern = '*', timeout = 30) | |
| 1218 | else: | |
| 1219 | callback(files_list) | |
| 1220 | ||
| 1221 | self._listPath_SMB2(service_name, path, listCB, errback, search = search, pattern = pattern, timeout = timeout) | |
| 1222 | ||
| 1223 | def _deleteFiles_SMB2__del(self, service_name, tid, path, callback, errback, timeout = 30): | |
| 983 | 1224 | messages_history = [ ] |
| 984 | 1225 | |
| 985 | 1226 | def sendCreate(tid): |
| 1010 | 1251 | messages_history.append(open_message) |
| 1011 | 1252 | if open_message.status == 0: |
| 1012 | 1253 | sendDelete(open_message.tid, open_message.payload.fid) |
| 1013 | elif open_message.status == 0x0103: # STATUS_PENDING | |
| 1014 | self.pending_requests[open_message.mid] = _PendingRequest(open_message.mid, expiry_time, | |
| 1015 | createCB, errback, | |
| 1016 | tid=kwargs['tid']) | |
| 1254 | elif open_message.status == 0xC0000034L: # [MS-ERREF]: STATUS_OBJECT_NAME_NOT_FOUND | |
| 1255 | callback(path) | |
| 1256 | elif open_message.status == 0xC00000BAL: # [MS-ERREF]: STATUS_FILE_IS_A_DIRECTORY | |
| 1257 | errback(OperationFailure('Failed to delete %s on %s: Cannot delete a folder. Please use deleteDirectory() method or append "/*" to your path if you wish to delete all files in the folder.' % ( path, service_name ), messages_history)) | |
| 1017 | 1258 | else: |
| 1018 | 1259 | errback(OperationFailure('Failed to delete %s on %s: Unable to open file' % ( path, service_name ), messages_history)) |
| 1019 | 1260 | |
| 1023 | 1264 | info_type = SMB2_INFO_FILE, |
| 1024 | 1265 | file_info_class = 0x0d, # SMB2_FILE_DISPOSITION_INFO |
| 1025 | 1266 | data = '\x01')) |
| 1026 | ''' | |
| 1027 | Resources: | |
| 1028 | https://msdn.microsoft.com/en-us/library/cc246560.aspx | |
| 1029 | https://msdn.microsoft.com/en-us/library/cc232098.aspx | |
| 1030 | ''' | |
| 1031 | m.tid = tid | |
| 1032 | self._sendSMBMessage(m) | |
| 1033 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, fid = fid) | |
| 1267 | # [MS-SMB2]: 2.2.39, [MS-FSCC]: 2.4.11 | |
| 1268 | m.tid = tid | |
| 1269 | self._sendSMBMessage(m) | |
| 1270 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, tid = tid, fid = fid) | |
| 1034 | 1271 | messages_history.append(m) |
| 1035 | 1272 | |
| 1036 | 1273 | def deleteCB(delete_message, **kwargs): |
| 1037 | 1274 | messages_history.append(delete_message) |
| 1038 | 1275 | if delete_message.status == 0: |
| 1039 | closeFid(delete_message.tid, kwargs['fid'], status = 0) | |
| 1040 | else: | |
| 1041 | closeFid(delete_message.tid, kwargs['fid'], status = delete_message.status) | |
| 1276 | closeFid(kwargs['tid'], kwargs['fid'], status = 0) | |
| 1277 | else: | |
| 1278 | closeFid(kwargs['tid'], kwargs['fid'], status = delete_message.status) | |
| 1042 | 1279 | |
| 1043 | 1280 | def closeFid(tid, fid, status = None): |
| 1044 | 1281 | m = SMB2Message(SMB2CloseRequest(fid)) |
| 1049 | 1286 | |
| 1050 | 1287 | def closeCB(close_message, **kwargs): |
| 1051 | 1288 | if kwargs['status'] == 0: |
| 1052 | callback(path_file_pattern) | |
| 1289 | callback(path) | |
| 1053 | 1290 | else: |
| 1054 | 1291 | errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history)) |
| 1055 | 1292 | |
| 1056 | if not self.connected_trees.has_key(service_name): | |
| 1057 | def connectCB(connect_message, **kwargs): | |
| 1058 | messages_history.append(connect_message) | |
| 1059 | if connect_message.status == 0: | |
| 1060 | self.connected_trees[service_name] = connect_message.tid | |
| 1061 | sendCreate(connect_message.tid) | |
| 1062 | else: | |
| 1063 | errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 1064 | ||
| 1065 | m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ))) | |
| 1066 | self._sendSMBMessage(m) | |
| 1067 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name) | |
| 1068 | messages_history.append(m) | |
| 1069 | else: | |
| 1070 | sendCreate(self.connected_trees[service_name]) | |
| 1071 | ||
| 1072 | def _resetFileAttributes_SMB2(self, service_name, path_file_pattern, callback, errback, timeout = 30): | |
| 1293 | sendCreate(tid) | |
| 1294 | ||
| 1295 | def _resetFileAttributes_SMB2(self, service_name, path_file_pattern, callback, errback, file_attributes = ATTR_NORMAL, timeout = 30): | |
| 1073 | 1296 | if not self.has_authenticated: |
| 1074 | 1297 | raise NotReadyError('SMB connection not authenticated') |
| 1075 | 1298 | |
| 1108 | 1331 | def createCB(open_message, **kwargs): |
| 1109 | 1332 | messages_history.append(open_message) |
| 1110 | 1333 | if open_message.status == 0: |
| 1111 | sendReset(open_message.tid, open_message.payload.fid) | |
| 1334 | sendReset(kwargs['tid'], open_message.payload.fid) | |
| 1112 | 1335 | else: |
| 1113 | 1336 | errback(OperationFailure('Failed to reset attributes of %s on %s: Unable to open file' % ( path, service_name ), messages_history)) |
| 1114 | 1337 | |
| 1117 | 1340 | additional_info = 0, |
| 1118 | 1341 | info_type = SMB2_INFO_FILE, |
| 1119 | 1342 | file_info_class = 4, # FileBasicInformation |
| 1120 | data = struct.pack('qqqqii',0,0,0,0,0x80,0))) # FILE_ATTRIBUTE_NORMAL | |
| 1121 | ''' | |
| 1122 | Resources: | |
| 1123 | https://msdn.microsoft.com/en-us/library/cc246560.aspx | |
| 1124 | https://msdn.microsoft.com/en-us/library/cc232064.aspx | |
| 1125 | https://msdn.microsoft.com/en-us/library/cc232094.aspx | |
| 1126 | https://msdn.microsoft.com/en-us/library/cc232110.aspx | |
| 1127 | ''' | |
| 1128 | m.tid = tid | |
| 1129 | self._sendSMBMessage(m) | |
| 1130 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, resetCB, errback, fid = fid) | |
| 1343 | data = struct.pack('qqqqii',0,0,0,0,file_attributes,0))) | |
| 1344 | # [MS-SMB2]: 2.2.39, [MS-FSCC]: 2.4, [MS-FSCC]: 2.4.7, [MS-FSCC]: 2.6 | |
| 1345 | m.tid = tid | |
| 1346 | self._sendSMBMessage(m) | |
| 1347 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, resetCB, errback, tid = tid, fid = fid) | |
| 1131 | 1348 | messages_history.append(m) |
| 1132 | 1349 | |
| 1133 | 1350 | def resetCB(reset_message, **kwargs): |
| 1134 | 1351 | messages_history.append(reset_message) |
| 1135 | 1352 | if reset_message.status == 0: |
| 1136 | closeFid(reset_message.tid, kwargs['fid'], status = 0) | |
| 1137 | else: | |
| 1138 | closeFid(reset_message.tid, kwargs['fid'], status = reset_message.status) | |
| 1353 | closeFid(kwargs['tid'], kwargs['fid'], status = 0) | |
| 1354 | else: | |
| 1355 | closeFid(kwargs['tid'], kwargs['fid'], status = reset_message.status) | |
| 1139 | 1356 | |
| 1140 | 1357 | def closeFid(tid, fid, status = None): |
| 1141 | 1358 | m = SMB2Message(SMB2CloseRequest(fid)) |
| 1198 | 1415 | create_context_data = create_context_data)) |
| 1199 | 1416 | m.tid = tid |
| 1200 | 1417 | self._sendSMBMessage(m) |
| 1201 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback) | |
| 1418 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid) | |
| 1202 | 1419 | messages_history.append(m) |
| 1203 | 1420 | |
| 1204 | 1421 | def createCB(create_message, **kwargs): |
| 1205 | 1422 | messages_history.append(create_message) |
| 1206 | 1423 | if create_message.status == 0: |
| 1207 | closeFid(create_message.tid, create_message.payload.fid) | |
| 1424 | closeFid(kwargs['tid'], create_message.payload.fid) | |
| 1208 | 1425 | else: |
| 1209 | 1426 | errback(OperationFailure('Failed to create directory %s on %s: Create failed' % ( path, service_name ), messages_history)) |
| 1210 | 1427 | |
| 1272 | 1489 | def createCB(open_message, **kwargs): |
| 1273 | 1490 | messages_history.append(open_message) |
| 1274 | 1491 | if open_message.status == 0: |
| 1275 | sendDelete(open_message.tid, open_message.payload.fid) | |
| 1492 | sendDelete(kwargs['tid'], open_message.payload.fid) | |
| 1276 | 1493 | else: |
| 1277 | 1494 | errback(OperationFailure('Failed to delete %s on %s: Unable to open directory' % ( path, service_name ), messages_history)) |
| 1278 | 1495 | |
| 1284 | 1501 | data = '\x01')) |
| 1285 | 1502 | m.tid = tid |
| 1286 | 1503 | self._sendSMBMessage(m) |
| 1287 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, fid = fid) | |
| 1504 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, tid = tid, fid = fid) | |
| 1288 | 1505 | messages_history.append(m) |
| 1289 | 1506 | |
| 1290 | 1507 | def deleteCB(delete_message, **kwargs): |
| 1291 | 1508 | messages_history.append(delete_message) |
| 1292 | 1509 | if delete_message.status == 0: |
| 1293 | closeFid(delete_message.tid, kwargs['fid'], status = 0) | |
| 1294 | else: | |
| 1295 | closeFid(delete_message.tid, kwargs['fid'], status = delete_message.status) | |
| 1510 | closeFid(kwargs['tid'], kwargs['fid'], status = 0) | |
| 1511 | else: | |
| 1512 | closeFid(kwargs['tid'], kwargs['fid'], status = delete_message.status) | |
| 1296 | 1513 | |
| 1297 | 1514 | def closeFid(tid, fid, status = None): |
| 1298 | 1515 | m = SMB2Message(SMB2CloseRequest(fid)) |
| 1368 | 1585 | def createCB(create_message, **kwargs): |
| 1369 | 1586 | messages_history.append(create_message) |
| 1370 | 1587 | if create_message.status == 0: |
| 1371 | sendRename(create_message.tid, create_message.payload.fid) | |
| 1588 | sendRename(kwargs['tid'], create_message.payload.fid) | |
| 1372 | 1589 | else: |
| 1373 | 1590 | errback(OperationFailure('Failed to rename %s on %s: Unable to open file/directory' % ( old_path, service_name ), messages_history)) |
| 1374 | 1591 | |
| 1381 | 1598 | data = data)) |
| 1382 | 1599 | m.tid = tid |
| 1383 | 1600 | self._sendSMBMessage(m) |
| 1384 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, renameCB, errback, fid = fid) | |
| 1601 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, renameCB, errback, tid = tid, fid = fid) | |
| 1385 | 1602 | messages_history.append(m) |
| 1386 | 1603 | |
| 1387 | 1604 | def renameCB(rename_message, **kwargs): |
| 1388 | 1605 | messages_history.append(rename_message) |
| 1389 | 1606 | if rename_message.status == 0: |
| 1390 | closeFid(rename_message.tid, kwargs['fid'], status = 0) | |
| 1391 | else: | |
| 1392 | closeFid(rename_message.tid, kwargs['fid'], status = rename_message.status) | |
| 1607 | closeFid(kwargs['tid'], kwargs['fid'], status = 0) | |
| 1608 | else: | |
| 1609 | closeFid(kwargs['tid'], kwargs['fid'], status = rename_message.status) | |
| 1393 | 1610 | |
| 1394 | 1611 | def closeFid(tid, fid, status = None): |
| 1395 | 1612 | m = SMB2Message(SMB2CloseRequest(fid)) |
| 1456 | 1673 | def createCB(create_message, **kwargs): |
| 1457 | 1674 | messages_history.append(create_message) |
| 1458 | 1675 | if create_message.status == 0: |
| 1459 | sendEnumSnapshots(create_message.tid, create_message.payload.fid) | |
| 1676 | sendEnumSnapshots(kwargs['tid'], create_message.payload.fid) | |
| 1460 | 1677 | else: |
| 1461 | 1678 | errback(OperationFailure('Failed to list snapshots %s on %s: Unable to open file/directory' % ( old_path, service_name ), messages_history)) |
| 1462 | 1679 | |
| 1597 | 1814 | self._handleSessionChallenge(message, ntlm_token) |
| 1598 | 1815 | except ( securityblob.BadSecurityBlobError, securityblob.UnsupportedSecurityProvider ), ex: |
| 1599 | 1816 | raise ProtocolError(str(ex), message.raw_data, message) |
| 1600 | elif message.status.internal_value == 0xc000006d: # STATUS_LOGON_FAILURE | |
| 1817 | elif (message.status.internal_value == 0xc000006d # STATUS_LOGON_FAILURE | |
| 1818 | or message.status.internal_value == 0xc0000064 # STATUS_NO_SUCH_USER | |
| 1819 | or message.status.internal_value == 0xc000006a): # STATUS_WRONG_PASSWORD | |
| 1601 | 1820 | self.has_authenticated = False |
| 1602 | self.log.info('Authentication (with extended security) failed. Please check username and password. You may need to enable/disable NTLMv2 authentication.') | |
| 1821 | self.log.info('Authentication (with extended security) failed. Please check username and password.') | |
| 1822 | self.onAuthFailed() | |
| 1823 | elif (message.status.internal_value == 0xc0000193 # STATUS_ACCOUNT_EXPIRED | |
| 1824 | or message.status.internal_value == 0xC0000071): # STATUS_PASSWORD_EXPIRED | |
| 1825 | self.has_authenticated = False | |
| 1826 | self.log.info('Authentication (with extended security) failed. Account or password has expired.') | |
| 1827 | self.onAuthFailed() | |
| 1828 | elif message.status.internal_value == 0xc0000234: # STATUS_ACCOUNT_LOCKED_OUT | |
| 1829 | self.has_authenticated = False | |
| 1830 | self.log.info('Authentication (with extended security) failed. Account has been locked due to too many invalid logon attempts.') | |
| 1831 | self.onAuthFailed() | |
| 1832 | elif message.status.internal_value == 0xc0000072: # STATUS_ACCOUNT_DISABLED | |
| 1833 | self.has_authenticated = False | |
| 1834 | self.log.info('Authentication (with extended security) failed. Account has been disabled.') | |
| 1835 | self.onAuthFailed() | |
| 1836 | elif (message.status.internal_value == 0xc000006f # STATUS_INVALID_LOGON_HOURS | |
| 1837 | or message.status.internal_value == 0xc000015b # STATUS_LOGON_TYPE_NOT_GRANTED | |
| 1838 | or message.status.internal_value == 0xc0000070): # STATUS_INVALID_WORKSTATION | |
| 1839 | self.has_authenticated = False | |
| 1840 | self.log.info('Authentication (with extended security) failed. Not allowed.') | |
| 1841 | self.onAuthFailed() | |
| 1842 | elif message.status.internal_value == 0xc000018c: # STATUS_TRUSTED_DOMAIN_FAILURE | |
| 1843 | self.has_authenticated = False | |
| 1844 | self.log.info('Authentication (with extended security) failed. Domain not trusted.') | |
| 1845 | self.onAuthFailed() | |
| 1846 | elif message.status.internal_value == 0xc000018d: # STATUS_TRUSTED_RELATIONSHIP_FAILURE | |
| 1847 | self.has_authenticated = False | |
| 1848 | self.log.info('Authentication (with extended security) failed. Workstation not trusted.') | |
| 1603 | 1849 | self.onAuthFailed() |
| 1604 | 1850 | else: |
| 1605 | 1851 | raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_SESSION_SETUP_ANDX (with extended security)' % message.status.internal_value, |
| 1661 | 1907 | self.log.info('Performing NTLMv1 authentication (with extended security) with server challenge "%s"', binascii.hexlify(server_challenge)) |
| 1662 | 1908 | nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(self.password, server_challenge, True) |
| 1663 | 1909 | |
| 1664 | ntlm_data = ntlm.generateAuthenticateMessage(server_flags, | |
| 1665 | nt_challenge_response, | |
| 1666 | lm_challenge_response, | |
| 1667 | session_key, | |
| 1668 | self.username, | |
| 1669 | self.domain) | |
| 1910 | ntlm_data, session_signing_key = ntlm.generateAuthenticateMessage(server_flags, | |
| 1911 | nt_challenge_response, | |
| 1912 | lm_challenge_response, | |
| 1913 | session_key, | |
| 1914 | self.username, | |
| 1915 | self.domain, | |
| 1916 | self.my_name) | |
| 1670 | 1917 | |
| 1671 | 1918 | if self.log.isEnabledFor(logging.DEBUG): |
| 1672 | 1919 | self.log.debug('NT challenge response is "%s" (%d bytes)', binascii.hexlify(nt_challenge_response), len(nt_challenge_response)) |
| 1686 | 1933 | |
| 1687 | 1934 | if self.is_signing_active: |
| 1688 | 1935 | self.log.info("SMB signing activated. All SMB messages will be signed.") |
| 1689 | self.signing_session_key = session_key | |
| 1936 | self.signing_session_key = session_signing_key | |
| 1690 | 1937 | if self.capabilities & CAP_EXTENDED_SECURITY: |
| 1691 | 1938 | self.signing_challenge_response = None |
| 1692 | 1939 | else: |
| 1860 | 2107 | def readCB(read_message, **kwargs): |
| 1861 | 2108 | messages_history.append(read_message) |
| 1862 | 2109 | if not read_message.status.hasError: |
| 1863 | data_len = read_message.payload.data_length | |
| 1864 | 2110 | data_bytes = read_message.payload.data |
| 1865 | 2111 | |
| 1866 | 2112 | if ord(data_bytes[3]) & 0x02 == 0: |
| 1867 | sendReadRequest(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:data_len-24]) | |
| 1868 | else: | |
| 1869 | decodeResults(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:data_len-24]) | |
| 2113 | sendReadRequest(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:]) | |
| 2114 | else: | |
| 2115 | decodeResults(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:]) | |
| 1870 | 2116 | else: |
| 1871 | 2117 | closeFid(read_message.tid, kwargs['fid']) |
| 1872 | 2118 | errback(OperationFailure('Failed to list shares: Unable to retrieve shared device list', messages_history)) |
| 1905 | 2151 | setup_bytes = struct.pack('<H', 0x0001) # TRANS2_FIND_FIRST2 sub-command. See [MS-CIFS]: 2.2.6.2.1 |
| 1906 | 2152 | params_bytes = \ |
| 1907 | 2153 | struct.pack('<HHHHI', |
| 1908 | search, # SearchAttributes | |
| 2154 | search & 0xFFFF, # SearchAttributes (need to restrict the values due to introduction of SMB_FILE_ATTRIBUTE_INCL_NORMAL) | |
| 1909 | 2155 | 100, # SearchCount |
| 1910 | 2156 | 0x0006, # Flags: SMB_FIND_CLOSE_AT_EOS | SMB_FIND_RETURN_RESUME_KEYS |
| 1911 | 2157 | 0x0104, # InfoLevel: SMB_FIND_FILE_BOTH_DIRECTORY_INFO |
| 1912 | 0x0000) # SearchStorageType | |
| 2158 | 0x0000) # SearchStorageType (seems to be ignored by Windows) | |
| 1913 | 2159 | if support_dfs: |
| 1914 | 2160 | params_bytes += ("\\" + self.remote_name + "\\" + service_name + path + pattern + '\0').encode('UTF-16LE') |
| 1915 | 2161 | else: |
| 1916 | params_bytes += (path + pattern).encode('UTF-16LE') | |
| 2162 | params_bytes += (path + pattern + '\0').encode('UTF-16LE') | |
| 1917 | 2163 | |
| 1918 | 2164 | m = SMBMessage(ComTransaction2Request(max_params_count = 10, |
| 1919 | 2165 | max_data_count = 16644, |
| 1949 | 2195 | |
| 1950 | 2196 | filename = data_bytes[offset2:offset2+filename_length].decode('UTF-16LE') |
| 1951 | 2197 | short_name = short_name.decode('UTF-16LE') |
| 1952 | results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time), | |
| 1953 | convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time), | |
| 1954 | file_size, alloc_size, file_attributes, short_name, filename)) | |
| 2198 | ||
| 2199 | accept_result = False | |
| 2200 | if (file_attributes & 0xff) in ( 0x00, ATTR_NORMAL ): # Only the first 8-bits are compared. We ignore other bits like temp, compressed, encryption, sparse, indexed, etc | |
| 2201 | accept_result = (search == SMB_FILE_ATTRIBUTE_NORMAL) or (search & SMB_FILE_ATTRIBUTE_INCL_NORMAL) | |
| 2202 | else: | |
| 2203 | accept_result = (file_attributes & search) > 0 | |
| 2204 | if accept_result: | |
| 2205 | results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time), | |
| 2206 | convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time), | |
| 2207 | file_size, alloc_size, file_attributes, short_name, filename)) | |
| 1955 | 2208 | |
| 1956 | 2209 | if next_offset: |
| 1957 | 2210 | offset += next_offset |
| 1991 | 2244 | elif end_of_search: |
| 1992 | 2245 | callback(results) |
| 1993 | 2246 | else: |
| 1994 | sendFindNext(find_message.tid, sid, last_name_offset, kwargs.get('support_dfs', False)) | |
| 1995 | else: | |
| 1996 | errback(OperationFailure('Failed to list %s on %s: Unable to retrieve file list' % ( path, service_name ), messages_history)) | |
| 1997 | ||
| 1998 | def sendFindNext(tid, sid, resume_key, support_dfs=False): | |
| 2247 | sendFindNext(find_message.tid, sid, 0, results[-1].filename, kwargs.get('support_dfs', False)) | |
| 2248 | else: | |
| 2249 | if find_message.status.internal_value == 0xC000000F: # [MS-ERREF]: STATUS_NO_SUCH_FILE | |
| 2250 | # Remote server returns STATUS_NO_SUCH_FILE error so we assume that the search returns no matching files | |
| 2251 | callback([ ]) | |
| 2252 | else: | |
| 2253 | errback(OperationFailure('Failed to list %s on %s: Unable to retrieve file list' % ( path, service_name ), messages_history)) | |
| 2254 | ||
| 2255 | def sendFindNext(tid, sid, resume_key, resume_file, support_dfs=False): | |
| 1999 | 2256 | setup_bytes = struct.pack('<H', 0x0002) # TRANS2_FIND_NEXT2 sub-command. See [MS-CIFS]: 2.2.6.3.1 |
| 2000 | 2257 | params_bytes = \ |
| 2001 | 2258 | struct.pack('<HHHIH', |
| 2003 | 2260 | 100, # SearchCount |
| 2004 | 2261 | 0x0104, # InfoLevel: SMB_FIND_FILE_BOTH_DIRECTORY_INFO |
| 2005 | 2262 | resume_key, # ResumeKey |
| 2006 | 0x000a) # Flags: SMB_FIND_RETURN_RESUME_KEYS | SMB_FIND_CLOSE_AT_EOS | SMB_FIND_RETURN_RESUME_KEYS | |
| 2007 | if support_dfs: | |
| 2008 | params_bytes += ("\\" + self.remote_name + "\\" + service_name + path + pattern + '\0').encode('UTF-16LE') | |
| 2009 | else: | |
| 2010 | params_bytes += (path + pattern).encode('UTF-16LE') | |
| 2263 | 0x0006) # Flags: SMB_FIND_RETURN_RESUME_KEYS | SMB_FIND_CLOSE_AT_EOS | |
| 2264 | params_bytes += (resume_file+'\0').encode('UTF-16LE') | |
| 2011 | 2265 | |
| 2012 | 2266 | m = SMBMessage(ComTransaction2Request(max_params_count = 10, |
| 2013 | 2267 | max_data_count = 16644, |
| 2053 | 2307 | elif end_of_search: |
| 2054 | 2308 | callback(results) |
| 2055 | 2309 | else: |
| 2056 | sendFindNext(find_message.tid, kwargs['sid'], last_name_offset, kwargs.get('support_dfs', False)) | |
| 2310 | sendFindNext(find_message.tid, kwargs['sid'], 0, results[-1].filename, kwargs.get('support_dfs', False)) | |
| 2057 | 2311 | else: |
| 2058 | 2312 | errback(OperationFailure('Failed to list %s on %s: Unable to retrieve file list' % ( path, service_name ), messages_history)) |
| 2059 | 2313 | |
| 2131 | 2385 | info_size = struct.calcsize(info_format) |
| 2132 | 2386 | create_time, last_access_time, last_write_time, last_attr_change_time, \ |
| 2133 | 2387 | file_attributes, _, alloc_size, file_size = struct.unpack(info_format, query_message.payload.data_bytes[:info_size]) |
| 2134 | ||
| 2135 | info = SharedFile(create_time, last_access_time, last_write_time, last_attr_change_time, | |
| 2136 | file_size, alloc_size, file_attributes, unicode(path), unicode(path)) | |
| 2388 | filename = self._extractLastPathComponent(unicode(path)) | |
| 2389 | ||
| 2390 | info = SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time), convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time), | |
| 2391 | file_size, alloc_size, file_attributes, filename, filename) | |
| 2137 | 2392 | callback(info) |
| 2138 | 2393 | else: |
| 2139 | 2394 | errback(OperationFailure('Failed to get attributes for %s on %s: Read failed' % ( path, service_name ), messages_history)) |
| 2153 | 2408 | messages_history.append(m) |
| 2154 | 2409 | else: |
| 2155 | 2410 | sendQuery(self.connected_trees[service_name]) |
| 2411 | ||
| 2412 | def _getSecurity_SMB1(self, service_name, path_file_pattern, callback, errback, timeout = 30): | |
| 2413 | raise NotReadyError('getSecurity is not yet implemented for SMB1') | |
| 2156 | 2414 | |
| 2157 | 2415 | def _retrieveFile_SMB1(self, service_name, path, file_obj, callback, errback, timeout = 30): |
| 2158 | 2416 | return self._retrieveFileFromOffset(service_name, path, file_obj, callback, errback, 0L, -1L, timeout) |
| 2277 | 2535 | errback(OperationFailure('Failed to store %s on %s: Unable to open file' % ( path, service_name ), messages_history)) |
| 2278 | 2536 | |
| 2279 | 2537 | def sendWrite(tid, fid, offset): |
| 2280 | # For message signing, the total SMB message size must be not exceed the max_buffer_size. Non-message signing does not have this limitation | |
| 2281 | 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 | |
| 2538 | # [MS-SMB] 2.2.4.5.2.2: The total SMB message size (inclusive of SMB header) must be not exceed the max_buffer_size. | |
| 2539 | write_count = min(self.max_buffer_size-64, 0xFFFF-64) # SMB header is 32-bytes. We factor in another 32-bytes for the message parameter block | |
| 2282 | 2540 | data_bytes = file_obj.read(write_count) |
| 2283 | 2541 | data_len = len(data_bytes) |
| 2284 | 2542 | if data_len > 0: |
| 2321 | 2579 | else: |
| 2322 | 2580 | sendOpen(self.connected_trees[service_name]) |
| 2323 | 2581 | |
| 2324 | def _deleteFiles_SMB1(self, service_name, path_file_pattern, callback, errback, timeout = 30): | |
| 2582 | def _deleteFiles_SMB1(self, service_name, path_file_pattern, delete_matching_folders, callback, errback, timeout = 30): | |
| 2325 | 2583 | if not self.has_authenticated: |
| 2326 | 2584 | raise NotReadyError('SMB connection not authenticated') |
| 2327 | 2585 | |
| 2586 | expiry_time = time.time() + timeout | |
| 2587 | pattern = None | |
| 2328 | 2588 | path = path_file_pattern.replace('/', '\\') |
| 2589 | if path.startswith('\\'): | |
| 2590 | path = path[1:] | |
| 2591 | if path.endswith('\\'): | |
| 2592 | path = path[:-1] | |
| 2593 | else: | |
| 2594 | path_components = path.split('\\') | |
| 2595 | if path_components[-1].find('*') > -1 or path_components[-1].find('?') > -1: | |
| 2596 | path = '\\'.join(path_components[:-1]) | |
| 2597 | pattern = path_components[-1] | |
| 2598 | messages_history, files_queue = [ ], [ ] | |
| 2599 | ||
| 2600 | if pattern is None: | |
| 2601 | path_components = path.split('\\') | |
| 2602 | if len(path_components) > 1: | |
| 2603 | files_queue.append(( '\\'.join(path_components[:-1]), path_components[-1] )) | |
| 2604 | else: | |
| 2605 | files_queue.append(( '', path )) | |
| 2606 | ||
| 2607 | def deleteCB(path): | |
| 2608 | if files_queue: | |
| 2609 | p, filename = files_queue.pop(0) | |
| 2610 | if filename: | |
| 2611 | if p: | |
| 2612 | filename = p + '\\' + filename | |
| 2613 | self._deleteFiles_SMB1__del(service_name, self.connected_trees[service_name], filename, deleteCB, errback, timeout) | |
| 2614 | else: | |
| 2615 | self._deleteDirectory_SMB1(service_name, p, deleteCB, errback, timeout = 30) | |
| 2616 | else: | |
| 2617 | callback(path_file_pattern) | |
| 2618 | ||
| 2619 | def listCB(files_list): | |
| 2620 | files_queue.extend(files_list) | |
| 2621 | deleteCB(None) | |
| 2622 | ||
| 2623 | if not self.connected_trees.has_key(service_name): | |
| 2624 | def connectCB(connect_message, **kwargs): | |
| 2625 | messages_history.append(connect_message) | |
| 2626 | if not connect_message.status.hasError: | |
| 2627 | self.connected_trees[service_name] = connect_message.tid | |
| 2628 | if files_queue: | |
| 2629 | deleteCB(None) | |
| 2630 | else: | |
| 2631 | self._deleteFiles_SMB1__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout) | |
| 2632 | else: | |
| 2633 | errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 2634 | ||
| 2635 | m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, '')) | |
| 2636 | self._sendSMBMessage(m) | |
| 2637 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name) | |
| 2638 | messages_history.append(m) | |
| 2639 | else: | |
| 2640 | if files_queue: | |
| 2641 | deleteCB(None) | |
| 2642 | else: | |
| 2643 | self._deleteFiles_SMB1__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout) | |
| 2644 | ||
| 2645 | def _deleteFiles_SMB1__list(self, service_name, path, pattern, delete_matching_folders, callback, errback, timeout = 30): | |
| 2646 | folder_queue = [ ] | |
| 2647 | files_list = [ ] | |
| 2648 | current_path = [ path ] | |
| 2649 | search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL | |
| 2650 | ||
| 2651 | def listCB(results): | |
| 2652 | files = [ ] | |
| 2653 | for f in filter(lambda x: x.filename not in [ '.', '..' ], results): | |
| 2654 | if f.isDirectory: | |
| 2655 | if delete_matching_folders: | |
| 2656 | folder_queue.append(current_path[0]+'\\'+f.filename) | |
| 2657 | else: | |
| 2658 | files.append(( current_path[0], f.filename )) | |
| 2659 | if current_path[0]!=path and delete_matching_folders: | |
| 2660 | files.append(( current_path[0], None )) | |
| 2661 | ||
| 2662 | if files: | |
| 2663 | files_list[0:0] = files | |
| 2664 | ||
| 2665 | if folder_queue: | |
| 2666 | p = folder_queue.pop() | |
| 2667 | current_path[0] = p | |
| 2668 | self._listPath_SMB1(service_name, current_path[0], listCB, errback, search = search, pattern = '*', timeout = 30) | |
| 2669 | else: | |
| 2670 | callback(files_list) | |
| 2671 | ||
| 2672 | self._listPath_SMB1(service_name, path, listCB, errback, search = search, pattern = pattern, timeout = timeout) | |
| 2673 | ||
| 2674 | ||
| 2675 | def _deleteFiles_SMB1__del(self, service_name, tid, path, callback, errback, timeout = 30): | |
| 2329 | 2676 | messages_history = [ ] |
| 2330 | 2677 | |
| 2331 | 2678 | def sendDelete(tid): |
| 2339 | 2686 | def deleteCB(delete_message, **kwargs): |
| 2340 | 2687 | messages_history.append(delete_message) |
| 2341 | 2688 | if not delete_message.status.hasError: |
| 2689 | callback(path) | |
| 2690 | elif delete_message.status.internal_value == 0xC000000FL: # [MS-ERREF]: STATUS_NO_SUCH_FILE | |
| 2691 | # If there are no matching files, we just treat as success instead of failing | |
| 2342 | 2692 | callback(path_file_pattern) |
| 2343 | else: | |
| 2344 | errback(OperationFailure('Failed to store %s on %s: Delete failed' % ( path, service_name ), messages_history)) | |
| 2693 | elif delete_message.status.internal_value == 0xC00000BAL: # [MS-ERREF]: STATUS_FILE_IS_A_DIRECTORY | |
| 2694 | errback(OperationFailure('Failed to delete %s on %s: Cannot delete a folder. Please use deleteDirectory() method or append "/*" to your path if you wish to delete all files in the folder.' % ( path, service_name ), messages_history)) | |
| 2695 | elif delete_message.status.internal_value == 0xC0000034L: # [MS-ERREF]: STATUS_OBJECT_NAME_INVALID | |
| 2696 | errback(OperationFailure('Failed to delete %s on %s: Path not found' % ( path, service_name ), messages_history)) | |
| 2697 | else: | |
| 2698 | errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history)) | |
| 2699 | ||
| 2700 | sendDelete(tid) | |
| 2701 | ||
| 2702 | def _resetFileAttributes_SMB1(self, service_name, path_file_pattern, callback, errback, file_attributes=ATTR_NORMAL, timeout = 30): | |
| 2703 | raise NotReadyError('resetFileAttributes is not yet implemented for SMB1') | |
| 2704 | ||
| 2705 | def _createDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30): | |
| 2706 | if not self.has_authenticated: | |
| 2707 | raise NotReadyError('SMB connection not authenticated') | |
| 2708 | ||
| 2709 | path = path.replace('/', '\\') | |
| 2710 | messages_history = [ ] | |
| 2711 | ||
| 2712 | def sendCreate(tid): | |
| 2713 | m = SMBMessage(ComCreateDirectoryRequest(path)) | |
| 2714 | m.tid = tid | |
| 2715 | self._sendSMBMessage(m) | |
| 2716 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback) | |
| 2717 | messages_history.append(m) | |
| 2718 | ||
| 2719 | def createCB(create_message, **kwargs): | |
| 2720 | messages_history.append(create_message) | |
| 2721 | if not create_message.status.hasError: | |
| 2722 | callback(path) | |
| 2723 | else: | |
| 2724 | errback(OperationFailure('Failed to create directory %s on %s: Create failed' % ( path, service_name ), messages_history)) | |
| 2725 | ||
| 2726 | if not self.connected_trees.has_key(service_name): | |
| 2727 | def connectCB(connect_message, **kwargs): | |
| 2728 | messages_history.append(connect_message) | |
| 2729 | if not connect_message.status.hasError: | |
| 2730 | self.connected_trees[service_name] = connect_message.tid | |
| 2731 | sendCreate(connect_message.tid) | |
| 2732 | else: | |
| 2733 | errback(OperationFailure('Failed to create directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 2734 | ||
| 2735 | m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, '')) | |
| 2736 | self._sendSMBMessage(m) | |
| 2737 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name) | |
| 2738 | messages_history.append(m) | |
| 2739 | else: | |
| 2740 | sendCreate(self.connected_trees[service_name]) | |
| 2741 | ||
| 2742 | def _deleteDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30): | |
| 2743 | if not self.has_authenticated: | |
| 2744 | raise NotReadyError('SMB connection not authenticated') | |
| 2745 | ||
| 2746 | path = path.replace('/', '\\') | |
| 2747 | messages_history = [ ] | |
| 2748 | ||
| 2749 | def sendDelete(tid): | |
| 2750 | m = SMBMessage(ComDeleteDirectoryRequest(path)) | |
| 2751 | m.tid = tid | |
| 2752 | self._sendSMBMessage(m) | |
| 2753 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback) | |
| 2754 | messages_history.append(m) | |
| 2755 | ||
| 2756 | def deleteCB(delete_message, **kwargs): | |
| 2757 | messages_history.append(delete_message) | |
| 2758 | if not delete_message.status.hasError: | |
| 2759 | callback(path) | |
| 2760 | else: | |
| 2761 | errback(OperationFailure('Failed to delete directory %s on %s: Delete failed' % ( path, service_name ), messages_history)) | |
| 2345 | 2762 | |
| 2346 | 2763 | if not self.connected_trees.has_key(service_name): |
| 2347 | 2764 | def connectCB(connect_message, **kwargs): |
| 2350 | 2767 | self.connected_trees[service_name] = connect_message.tid |
| 2351 | 2768 | sendDelete(connect_message.tid) |
| 2352 | 2769 | else: |
| 2353 | errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 2354 | ||
| 2355 | m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, '')) | |
| 2356 | self._sendSMBMessage(m) | |
| 2357 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name) | |
| 2358 | messages_history.append(m) | |
| 2359 | else: | |
| 2360 | sendDelete(self.connected_trees[service_name]) | |
| 2361 | ||
| 2362 | def _resetFileAttributes_SMB1(self, service_name, path_file_pattern, callback, errback, timeout = 30): | |
| 2363 | raise NotReadyError('resetFileAttributes is not yet implemented for SMB1') | |
| 2364 | ||
| 2365 | def _createDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30): | |
| 2366 | if not self.has_authenticated: | |
| 2367 | raise NotReadyError('SMB connection not authenticated') | |
| 2368 | ||
| 2369 | path = path.replace('/', '\\') | |
| 2370 | messages_history = [ ] | |
| 2371 | ||
| 2372 | def sendCreate(tid): | |
| 2373 | m = SMBMessage(ComCreateDirectoryRequest(path)) | |
| 2374 | m.tid = tid | |
| 2375 | self._sendSMBMessage(m) | |
| 2376 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback) | |
| 2377 | messages_history.append(m) | |
| 2378 | ||
| 2379 | def createCB(create_message, **kwargs): | |
| 2380 | messages_history.append(create_message) | |
| 2381 | if not create_message.status.hasError: | |
| 2382 | callback(path) | |
| 2383 | else: | |
| 2384 | errback(OperationFailure('Failed to create directory %s on %s: Create failed' % ( path, service_name ), messages_history)) | |
| 2385 | ||
| 2386 | if not self.connected_trees.has_key(service_name): | |
| 2387 | def connectCB(connect_message, **kwargs): | |
| 2388 | messages_history.append(connect_message) | |
| 2389 | if not connect_message.status.hasError: | |
| 2390 | self.connected_trees[service_name] = connect_message.tid | |
| 2391 | sendCreate(connect_message.tid) | |
| 2392 | else: | |
| 2393 | errback(OperationFailure('Failed to create directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 2394 | ||
| 2395 | m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, '')) | |
| 2396 | self._sendSMBMessage(m) | |
| 2397 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name) | |
| 2398 | messages_history.append(m) | |
| 2399 | else: | |
| 2400 | sendCreate(self.connected_trees[service_name]) | |
| 2401 | ||
| 2402 | def _deleteDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30): | |
| 2403 | if not self.has_authenticated: | |
| 2404 | raise NotReadyError('SMB connection not authenticated') | |
| 2405 | ||
| 2406 | path = path.replace('/', '\\') | |
| 2407 | messages_history = [ ] | |
| 2408 | ||
| 2409 | def sendDelete(tid): | |
| 2410 | m = SMBMessage(ComDeleteDirectoryRequest(path)) | |
| 2411 | m.tid = tid | |
| 2412 | self._sendSMBMessage(m) | |
| 2413 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback) | |
| 2414 | messages_history.append(m) | |
| 2415 | ||
| 2416 | def deleteCB(delete_message, **kwargs): | |
| 2417 | messages_history.append(delete_message) | |
| 2418 | if not delete_message.status.hasError: | |
| 2419 | callback(path) | |
| 2420 | else: | |
| 2421 | errback(OperationFailure('Failed to delete directory %s on %s: Delete failed' % ( path, service_name ), messages_history)) | |
| 2422 | ||
| 2423 | if not self.connected_trees.has_key(service_name): | |
| 2424 | def connectCB(connect_message, **kwargs): | |
| 2425 | messages_history.append(connect_message) | |
| 2426 | if not connect_message.status.hasError: | |
| 2427 | self.connected_trees[service_name] = connect_message.tid | |
| 2428 | sendDelete(connect_message.tid) | |
| 2429 | else: | |
| 2430 | errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 2770 | errback(OperationFailure('Failed to delete directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 2431 | 2771 | |
| 2432 | 2772 | m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, '')) |
| 2433 | 2773 | self._sendSMBMessage(m) |
| 2562 | 2902 | def _echo_SMB1(self, data, callback, errback, timeout = 30): |
| 2563 | 2903 | messages_history = [ ] |
| 2564 | 2904 | |
| 2905 | if not isinstance(data, type(b'')): | |
| 2906 | raise TypeError('Echo data must be %s not %s' % (type(b'').__name__, type(data).__name__)) | |
| 2907 | ||
| 2565 | 2908 | def echoCB(echo_message, **kwargs): |
| 2566 | 2909 | messages_history.append(echo_message) |
| 2567 | 2910 | if not echo_message.status.hasError: |
| 2574 | 2917 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, echoCB, errback) |
| 2575 | 2918 | messages_history.append(m) |
| 2576 | 2919 | |
| 2920 | def _extractLastPathComponent(self, path): | |
| 2921 | return path.replace('\\', '/').split('/')[-1] | |
| 2922 | ||
| 2577 | 2923 | |
| 2578 | 2924 | class SharedDevice: |
| 2579 | 2925 | """ |
| 2580 | 2926 | Contains information about a single shared device on the remote server. |
| 2927 | ||
| 2928 | The following attributes are available: | |
| 2929 | ||
| 2930 | * name : An unicode string containing the name of the shared device | |
| 2931 | * comments : An unicode string containing the user description of the shared device | |
| 2581 | 2932 | """ |
| 2582 | 2933 | |
| 2583 | 2934 | # The following constants are taken from [MS-SRVS]: 2.2.2.4 |
| 2632 | 2983 | |
| 2633 | 2984 | If you encounter *SharedFile* instance where its short_name attribute is empty but the filename attribute contains a short name which does not correspond |
| 2634 | 2985 | 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 |
| 2635 | one of these prohibited characters: "\/[]:+|<>=;?,* (see [MS-CIFS]: 2.2.1.1.1 for more details). | |
| 2986 | one of these prohibited characters: "\\/[]:+|<>=;?,* (see [MS-CIFS]: 2.2.1.1.1 for more details). | |
| 2987 | ||
| 2988 | The following attributes are available: | |
| 2989 | ||
| 2990 | * 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 | |
| 2991 | * 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 | |
| 2992 | * 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 | |
| 2993 | * 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 | |
| 2994 | * file_size : File size in number of bytes | |
| 2995 | * alloc_size : Total number of bytes allocated to store this file | |
| 2996 | * file_attributes : A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3. You can perform bit-wise tests to determine the status of the file using the ATTR_xxx constants in smb_constants.py. | |
| 2997 | * short_name : Unicode string containing the short name of this file (usually in 8.3 notation) | |
| 2998 | * 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. | |
| 2999 | * file_id : Long value representing the file reference number for the file. If the remote system does not support this field, this field will be None or 0. See [MS-FSCC]: 2.4.17 | |
| 2636 | 3000 | """ |
| 2637 | 3001 | |
| 2638 | def __init__(self, create_time, last_access_time, last_write_time, last_attr_change_time, file_size, alloc_size, file_attributes, short_name, filename): | |
| 3002 | def __init__(self, create_time, last_access_time, last_write_time, last_attr_change_time, file_size, alloc_size, file_attributes, short_name, filename, file_id=None): | |
| 2639 | 3003 | 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 |
| 2640 | 3004 | 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 |
| 2641 | 3005 | 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 |
| 2642 | 3006 | 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 |
| 2643 | 3007 | self.file_size = file_size #: File size in number of bytes |
| 2644 | 3008 | self.alloc_size = alloc_size #: Total number of bytes allocated to store this file |
| 2645 | self.file_attributes = file_attributes #: A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3 | |
| 3009 | self.file_attributes = file_attributes #: A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3. You can perform bit-wise tests to determine the status of the file using the ATTR_xxx constants in smb_constants.py. | |
| 2646 | 3010 | self.short_name = short_name #: Unicode string containing the short name of this file (usually in 8.3 notation) |
| 2647 | 3011 | 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. |
| 3012 | self.file_id = file_id #: Long value representing the file reference number for the file. If the remote system does not support this field, this field will be None or 0. See [MS-FSCC]: 2.4.17 | |
| 2648 | 3013 | |
| 2649 | 3014 | @property |
| 2650 | 3015 | def isDirectory(self): |
| 2655 | 3020 | def isReadOnly(self): |
| 2656 | 3021 | """A convenient property to return True if this file resource is read-only on the remote server""" |
| 2657 | 3022 | return bool(self.file_attributes & ATTR_READONLY) |
| 3023 | ||
| 3024 | @property | |
| 3025 | def isNormal(self): | |
| 3026 | """ | |
| 3027 | A convenient property to return True if this is a normal file. | |
| 3028 | ||
| 3029 | Note that pysmb defines a normal file as a file entry that is not read-only, not hidden, not system, not archive and not a directory. | |
| 3030 | It ignores other attributes like compression, indexed, sparse, temporary and encryption. | |
| 3031 | """ | |
| 3032 | return (self.file_attributes==ATTR_NORMAL) or ((self.file_attributes & 0xff)==0) | |
| 2658 | 3033 | |
| 2659 | 3034 | def __unicode__(self): |
| 2660 | 3035 | return u'Shared file: %s (FileSize:%d bytes, isDirectory:%s)' % ( self.filename, self.file_size, self.isDirectory ) |
| 0 | 0 | |
| 1 | import types, hmac, binascii, struct, random | |
| 1 | import types, hmac, binascii, struct, random, string | |
| 2 | from .utils.rc4 import RC4_encrypt | |
| 2 | 3 | from utils.pyDes import des |
| 3 | 4 | |
| 4 | 5 | try: |
| 57 | 58 | |
| 58 | 59 | NTLM_FLAGS = NTLM_NegotiateUnicode | \ |
| 59 | 60 | NTLM_RequestTarget | \ |
| 61 | NTLM_NegotiateSign | \ | |
| 60 | 62 | NTLM_NegotiateNTLM | \ |
| 61 | 63 | NTLM_NegotiateAlwaysSign | \ |
| 62 | 64 | NTLM_NegotiateExtendedSecurity | \ |
| 63 | 65 | NTLM_NegotiateTargetInfo | \ |
| 64 | 66 | NTLM_NegotiateVersion | \ |
| 65 | 67 | NTLM_Negotiate128 | \ |
| 66 | NTLM_NegotiateKeyExchange | \ | |
| 67 | NTLM_Negotiate56 | |
| 68 | NTLM_NegotiateKeyExchange | |
| 68 | 69 | |
| 69 | 70 | def generateNegotiateMessage(): |
| 70 | 71 | """ |
| 80 | 81 | return s |
| 81 | 82 | |
| 82 | 83 | |
| 83 | def generateAuthenticateMessage(challenge_flags, nt_response, lm_response, session_key, user, domain = 'WORKGROUP', workstation = 'LOCALHOST'): | |
| 84 | def generateAuthenticateMessage(challenge_flags, nt_response, lm_response, request_session_key, user, domain = 'WORKGROUP', workstation = 'LOCALHOST'): | |
| 84 | 85 | """ |
| 85 | 86 | References: |
| 86 | 87 | =========== |
| 88 | 89 | """ |
| 89 | 90 | FORMAT = '<8sIHHIHHIHHIHHIHHIHHII' |
| 90 | 91 | FORMAT_SIZE = struct.calcsize(FORMAT) |
| 92 | ||
| 93 | # [MS-NLMP]: 3.1.5.1.2 | |
| 94 | # http://grutz.jingojango.net/exploits/davenport-ntlm.html | |
| 95 | session_key = session_signing_key = request_session_key | |
| 96 | if challenge_flags & NTLM_NegotiateKeyExchange: | |
| 97 | session_signing_key = "".join([ random.choice(string.digits+string.ascii_letters) for _ in range(16) ]).encode('ascii') | |
| 98 | session_key = RC4_encrypt(request_session_key, session_signing_key) | |
| 91 | 99 | |
| 92 | 100 | lm_response_length = len(lm_response) |
| 93 | 101 | lm_response_offset = FORMAT_SIZE |
| 124 | 132 | session_key_length, session_key_length, session_key_offset, |
| 125 | 133 | auth_flags) |
| 126 | 134 | |
| 127 | return s + lm_response + nt_response + padding + domain_unicode + user_unicode + workstation_unicode + session_key | |
| 135 | return s + lm_response + nt_response + padding + domain_unicode + user_unicode + workstation_unicode + session_key, session_signing_key | |
| 128 | 136 | |
| 129 | 137 | |
| 130 | 138 | def decodeChallengeMessage(ntlm_data): |
| 0 | """ | |
| 1 | This module implements security descriptors, and the partial structures | |
| 2 | used in them, as specified in [MS-DTYP]. | |
| 3 | """ | |
| 4 | ||
| 5 | import struct | |
| 6 | ||
| 7 | ||
| 8 | # Security descriptor control flags | |
| 9 | # [MS-DTYP]: 2.4.6 | |
| 10 | SECURITY_DESCRIPTOR_OWNER_DEFAULTED = 0x0001 | |
| 11 | SECURITY_DESCRIPTOR_GROUP_DEFAULTED = 0x0002 | |
| 12 | SECURITY_DESCRIPTOR_DACL_PRESENT = 0x0004 | |
| 13 | SECURITY_DESCRIPTOR_DACL_DEFAULTED = 0x0008 | |
| 14 | SECURITY_DESCRIPTOR_SACL_PRESENT = 0x0010 | |
| 15 | SECURITY_DESCRIPTOR_SACL_DEFAULTED = 0x0020 | |
| 16 | SECURITY_DESCRIPTOR_SERVER_SECURITY = 0x0040 | |
| 17 | SECURITY_DESCRIPTOR_DACL_TRUSTED = 0x0080 | |
| 18 | SECURITY_DESCRIPTOR_DACL_COMPUTED_INHERITANCE_REQUIRED = 0x0100 | |
| 19 | SECURITY_DESCRIPTOR_SACL_COMPUTED_INHERITANCE_REQUIRED = 0x0200 | |
| 20 | SECURITY_DESCRIPTOR_DACL_AUTO_INHERITED = 0x0400 | |
| 21 | SECURITY_DESCRIPTOR_SACL_AUTO_INHERITED = 0x0800 | |
| 22 | SECURITY_DESCRIPTOR_DACL_PROTECTED = 0x1000 | |
| 23 | SECURITY_DESCRIPTOR_SACL_PROTECTED = 0x2000 | |
| 24 | SECURITY_DESCRIPTOR_RM_CONTROL_VALID = 0x4000 | |
| 25 | SECURITY_DESCRIPTOR_SELF_RELATIVE = 0x8000 | |
| 26 | ||
| 27 | # ACE types | |
| 28 | # [MS-DTYP]: 2.4.4.1 | |
| 29 | ACE_TYPE_ACCESS_ALLOWED = 0x00 | |
| 30 | ACE_TYPE_ACCESS_DENIED = 0x01 | |
| 31 | ACE_TYPE_SYSTEM_AUDIT = 0x02 | |
| 32 | ACE_TYPE_SYSTEM_ALARM = 0x03 | |
| 33 | ACE_TYPE_ACCESS_ALLOWED_COMPOUND = 0x04 | |
| 34 | ACE_TYPE_ACCESS_ALLOWED_OBJECT = 0x05 | |
| 35 | ACE_TYPE_ACCESS_DENIED_OBJECT = 0x06 | |
| 36 | ACE_TYPE_SYSTEM_AUDIT_OBJECT = 0x07 | |
| 37 | ACE_TYPE_SYSTEM_ALARM_OBJECT = 0x08 | |
| 38 | ACE_TYPE_ACCESS_ALLOWED_CALLBACK = 0x09 | |
| 39 | ACE_TYPE_ACCESS_DENIED_CALLBACK = 0x0A | |
| 40 | ACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT = 0x0B | |
| 41 | ACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT = 0x0C | |
| 42 | ACE_TYPE_SYSTEM_AUDIT_CALLBACK = 0x0D | |
| 43 | ACE_TYPE_SYSTEM_ALARM_CALLBACK = 0x0E | |
| 44 | ACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT = 0x0F | |
| 45 | ACE_TYPE_SYSTEM_ALARM_CALLBACK_OBJECT = 0x10 | |
| 46 | ACE_TYPE_SYSTEM_MANDATORY_LABEL = 0x11 | |
| 47 | ACE_TYPE_SYSTEM_RESOURCE_ATTRIBUTE = 0x12 | |
| 48 | ACE_TYPE_SYSTEM_SCOPED_POLICY_ID = 0x13 | |
| 49 | ||
| 50 | # ACE flags | |
| 51 | # [MS-DTYP]: 2.4.4.1 | |
| 52 | ACE_FLAG_OBJECT_INHERIT = 0x01 | |
| 53 | ACE_FLAG_CONTAINER_INHERIT = 0x02 | |
| 54 | ACE_FLAG_NO_PROPAGATE_INHERIT = 0x04 | |
| 55 | ACE_FLAG_INHERIT_ONLY = 0x08 | |
| 56 | ACE_FLAG_INHERITED = 0x10 | |
| 57 | ACE_FLAG_SUCCESSFUL_ACCESS = 0x40 | |
| 58 | ACE_FLAG_FAILED_ACCESS = 0x80 | |
| 59 | ||
| 60 | # Pre-defined well-known SIDs | |
| 61 | # [MS-DTYP]: 2.4.2.4 | |
| 62 | SID_NULL = "S-1-0-0" | |
| 63 | SID_EVERYONE = "S-1-1-0" | |
| 64 | SID_LOCAL = "S-1-2-0" | |
| 65 | SID_CONSOLE_LOGON = "S-1-2-1" | |
| 66 | SID_CREATOR_OWNER = "S-1-3-0" | |
| 67 | SID_CREATOR_GROUP = "S-1-3-1" | |
| 68 | SID_OWNER_SERVER = "S-1-3-2" | |
| 69 | SID_GROUP_SERVER = "S-1-3-3" | |
| 70 | SID_OWNER_RIGHTS = "S-1-3-4" | |
| 71 | SID_NT_AUTHORITY = "S-1-5" | |
| 72 | SID_DIALUP = "S-1-5-1" | |
| 73 | SID_NETWORK = "S-1-5-2" | |
| 74 | SID_BATCH = "S-1-5-3" | |
| 75 | SID_INTERACTIVE = "S-1-5-4" | |
| 76 | SID_SERVICE = "S-1-5-6" | |
| 77 | SID_ANONYMOUS = "S-1-5-7" | |
| 78 | SID_PROXY = "S-1-5-8" | |
| 79 | SID_ENTERPRISE_DOMAIN_CONTROLLERS = "S-1-5-9" | |
| 80 | SID_PRINCIPAL_SELF = "S-1-5-10" | |
| 81 | SID_AUTHENTICATED_USERS = "S-1-5-11" | |
| 82 | SID_RESTRICTED_CODE = "S-1-5-12" | |
| 83 | SID_TERMINAL_SERVER_USER = "S-1-5-13" | |
| 84 | SID_REMOTE_INTERACTIVE_LOGON = "S-1-5-14" | |
| 85 | SID_THIS_ORGANIZATION = "S-1-5-15" | |
| 86 | SID_IUSR = "S-1-5-17" | |
| 87 | SID_LOCAL_SYSTEM = "S-1-5-18" | |
| 88 | SID_LOCAL_SERVICE = "S-1-5-19" | |
| 89 | SID_NETWORK_SERVICE = "S-1-5-20" | |
| 90 | SID_COMPOUNDED_AUTHENTICATION = "S-1-5-21-0-0-0-496" | |
| 91 | SID_CLAIMS_VALID = "S-1-5-21-0-0-0-497" | |
| 92 | SID_BUILTIN_ADMINISTRATORS = "S-1-5-32-544" | |
| 93 | SID_BUILTIN_USERS = "S-1-5-32-545" | |
| 94 | SID_BUILTIN_GUESTS = "S-1-5-32-546" | |
| 95 | SID_POWER_USERS = "S-1-5-32-547" | |
| 96 | SID_ACCOUNT_OPERATORS = "S-1-5-32-548" | |
| 97 | SID_SERVER_OPERATORS = "S-1-5-32-549" | |
| 98 | SID_PRINTER_OPERATORS = "S-1-5-32-550" | |
| 99 | SID_BACKUP_OPERATORS = "S-1-5-32-551" | |
| 100 | SID_REPLICATOR = "S-1-5-32-552" | |
| 101 | SID_ALIAS_PREW2KCOMPACC = "S-1-5-32-554" | |
| 102 | SID_REMOTE_DESKTOP = "S-1-5-32-555" | |
| 103 | SID_NETWORK_CONFIGURATION_OPS = "S-1-5-32-556" | |
| 104 | SID_INCOMING_FOREST_TRUST_BUILDERS = "S-1-5-32-557" | |
| 105 | SID_PERFMON_USERS = "S-1-5-32-558" | |
| 106 | SID_PERFLOG_USERS = "S-1-5-32-559" | |
| 107 | SID_WINDOWS_AUTHORIZATION_ACCESS_GROUP = "S-1-5-32-560" | |
| 108 | SID_TERMINAL_SERVER_LICENSE_SERVERS = "S-1-5-32-561" | |
| 109 | SID_DISTRIBUTED_COM_USERS = "S-1-5-32-562" | |
| 110 | SID_IIS_IUSRS = "S-1-5-32-568" | |
| 111 | SID_CRYPTOGRAPHIC_OPERATORS = "S-1-5-32-569" | |
| 112 | SID_EVENT_LOG_READERS = "S-1-5-32-573" | |
| 113 | SID_CERTIFICATE_SERVICE_DCOM_ACCESS = "S-1-5-32-574" | |
| 114 | SID_RDS_REMOTE_ACCESS_SERVERS = "S-1-5-32-575" | |
| 115 | SID_RDS_ENDPOINT_SERVERS = "S-1-5-32-576" | |
| 116 | SID_RDS_MANAGEMENT_SERVERS = "S-1-5-32-577" | |
| 117 | SID_HYPER_V_ADMINS = "S-1-5-32-578" | |
| 118 | SID_ACCESS_CONTROL_ASSISTANCE_OPS = "S-1-5-32-579" | |
| 119 | SID_REMOTE_MANAGEMENT_USERS = "S-1-5-32-580" | |
| 120 | SID_WRITE_RESTRICTED_CODE = "S-1-5-33" | |
| 121 | SID_NTLM_AUTHENTICATION = "S-1-5-64-10" | |
| 122 | SID_SCHANNEL_AUTHENTICATION = "S-1-5-64-14" | |
| 123 | SID_DIGEST_AUTHENTICATION = "S-1-5-64-21" | |
| 124 | SID_THIS_ORGANIZATION_CERTIFICATE = "S-1-5-65-1" | |
| 125 | SID_NT_SERVICE = "S-1-5-80" | |
| 126 | SID_USER_MODE_DRIVERS = "S-1-5-84-0-0-0-0-0" | |
| 127 | SID_LOCAL_ACCOUNT = "S-1-5-113" | |
| 128 | SID_LOCAL_ACCOUNT_AND_MEMBER_OF_ADMINISTRATORS_GROUP = "S-1-5-114" | |
| 129 | SID_OTHER_ORGANIZATION = "S-1-5-1000" | |
| 130 | SID_ALL_APP_PACKAGES = "S-1-15-2-1" | |
| 131 | SID_ML_UNTRUSTED = "S-1-16-0" | |
| 132 | SID_ML_LOW = "S-1-16-4096" | |
| 133 | SID_ML_MEDIUM = "S-1-16-8192" | |
| 134 | SID_ML_MEDIUM_PLUS = "S-1-16-8448" | |
| 135 | SID_ML_HIGH = "S-1-16-12288" | |
| 136 | SID_ML_SYSTEM = "S-1-16-16384" | |
| 137 | SID_ML_PROTECTED_PROCESS = "S-1-16-20480" | |
| 138 | SID_AUTHENTICATION_AUTHORITY_ASSERTED_IDENTITY = "S-1-18-1" | |
| 139 | SID_SERVICE_ASSERTED_IDENTITY = "S-1-18-2" | |
| 140 | SID_FRESH_PUBLIC_KEY_IDENTITY = "S-1-18-3" | |
| 141 | SID_KEY_TRUST_IDENTITY = "S-1-18-4" | |
| 142 | SID_KEY_PROPERTY_MFA = "S-1-18-5" | |
| 143 | SID_KEY_PROPERTY_ATTESTATION = "S-1-18-6" | |
| 144 | ||
| 145 | ||
| 146 | class SID(object): | |
| 147 | """ | |
| 148 | A Windows security identifier. Represents a single principal, such a | |
| 149 | user or a group, as a sequence of numbers consisting of the revision, | |
| 150 | identifier authority, and a variable-length list of subauthorities. | |
| 151 | ||
| 152 | See [MS-DTYP]: 2.4.2 | |
| 153 | """ | |
| 154 | def __init__(self, revision, identifier_authority, subauthorities): | |
| 155 | #: Revision, should always be 1. | |
| 156 | self.revision = revision | |
| 157 | #: An integer representing the identifier authority. | |
| 158 | self.identifier_authority = identifier_authority | |
| 159 | #: A list of integers representing all subauthorities. | |
| 160 | self.subauthorities = subauthorities | |
| 161 | ||
| 162 | def __str__(self): | |
| 163 | """ | |
| 164 | String representation, as specified in [MS-DTYP]: 2.4.2.1 | |
| 165 | """ | |
| 166 | if self.identifier_authority >= 2**32: | |
| 167 | id_auth = '%#x' % (self.identifier_authority,) | |
| 168 | else: | |
| 169 | id_auth = self.identifier_authority | |
| 170 | auths = [self.revision, id_auth] + self.subauthorities | |
| 171 | return 'S-' + '-'.join(str(subauth) for subauth in auths) | |
| 172 | ||
| 173 | def __repr__(self): | |
| 174 | return 'SID(%r)' % (str(self),) | |
| 175 | ||
| 176 | @classmethod | |
| 177 | def from_bytes(cls, data, return_tail=False): | |
| 178 | revision, subauth_count = struct.unpack('<BB', data[:2]) | |
| 179 | identifier_authority = struct.unpack('>Q', '\x00\x00' + data[2:8])[0] | |
| 180 | subauth_data = data[8:] | |
| 181 | subauthorities = [struct.unpack('<L', subauth_data[4 * i : 4 * (i+1)])[0] | |
| 182 | for i in range(subauth_count)] | |
| 183 | sid = cls(revision, identifier_authority, subauthorities) | |
| 184 | if return_tail: | |
| 185 | return sid, subauth_data[4 * subauth_count :] | |
| 186 | return sid | |
| 187 | ||
| 188 | ||
| 189 | class ACE(object): | |
| 190 | """ | |
| 191 | Represents a single access control entry. | |
| 192 | ||
| 193 | See [MS-DTYP]: 2.4.4 | |
| 194 | """ | |
| 195 | HEADER_FORMAT = '<BBH' | |
| 196 | ||
| 197 | def __init__(self, type_, flags, mask, sid, additional_data): | |
| 198 | #: An integer representing the type of the ACE. One of the | |
| 199 | #: ``ACE_TYPE_*`` constants. Corresponds to the ``AceType`` field | |
| 200 | #: from [MS-DTYP] 2.4.4.1. | |
| 201 | self.type = type_ | |
| 202 | #: An integer bitmask with ACE flags, corresponds to the | |
| 203 | #: ``AceFlags`` field. | |
| 204 | self.flags = flags | |
| 205 | #: An integer representing the ``ACCESS_MASK`` as specified in | |
| 206 | #: [MS-DTYP] 2.4.3. | |
| 207 | self.mask = mask | |
| 208 | #: The :class:`SID` of a trustee. | |
| 209 | self.sid = sid | |
| 210 | #: A dictionary of additional fields present in the ACE, depending | |
| 211 | #: on the type. The following fields can be present: | |
| 212 | #: | |
| 213 | #: * ``flags`` | |
| 214 | #: * ``object_type`` | |
| 215 | #: * ``inherited_object_type`` | |
| 216 | #: * ``application_data`` | |
| 217 | #: * ``attribute_data`` | |
| 218 | self.additional_data = additional_data | |
| 219 | ||
| 220 | def __repr__(self): | |
| 221 | return "ACE(type=%#04x, flags=%#04x, mask=%#010x, sid=%s)" % ( | |
| 222 | self.type, self.flags, self.mask, self.sid, | |
| 223 | ) | |
| 224 | ||
| 225 | @property | |
| 226 | def isInheritOnly(self): | |
| 227 | """Convenience property which indicates if this ACE is inherit | |
| 228 | only, meaning that it doesn't apply to the object itself.""" | |
| 229 | return bool(self.flags & ACE_FLAG_INHERIT_ONLY) | |
| 230 | ||
| 231 | @classmethod | |
| 232 | def from_bytes(cls, data): | |
| 233 | header_size = struct.calcsize(cls.HEADER_FORMAT) | |
| 234 | header = data[:header_size] | |
| 235 | type_, flags, size = struct.unpack(cls.HEADER_FORMAT, header) | |
| 236 | ||
| 237 | assert len(data) >= size | |
| 238 | ||
| 239 | body = data[header_size:size] | |
| 240 | additional_data = {} | |
| 241 | ||
| 242 | # In all ACE types, the mask immediately follows the header. | |
| 243 | mask = struct.unpack('<I', body[:4])[0] | |
| 244 | body = body[4:] | |
| 245 | ||
| 246 | # All OBJECT-type ACEs contain additional flags, and two GUIDs as | |
| 247 | # the following fields. | |
| 248 | if type_ in (ACE_TYPE_ACCESS_ALLOWED_OBJECT, | |
| 249 | ACE_TYPE_ACCESS_DENIED_OBJECT, | |
| 250 | ACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT, | |
| 251 | ACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT, | |
| 252 | ACE_TYPE_SYSTEM_AUDIT_OBJECT, | |
| 253 | ACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT): | |
| 254 | additional_data['flags'] = struct.unpack('<I', body[:4])[0] | |
| 255 | additional_data['object_type'] = body[4:20] | |
| 256 | additional_data['inherited_object_type'] = body[20:36] | |
| 257 | body = body[36:] | |
| 258 | ||
| 259 | # Then the SID in all types. | |
| 260 | sid, body = SID.from_bytes(body, return_tail=True) | |
| 261 | ||
| 262 | # CALLBACK-type ACEs (and for some obscure reason, | |
| 263 | # SYSTEM_AUDIT_OBJECT) have a final tail of application data. | |
| 264 | if type_ in (ACE_TYPE_ACCESS_ALLOWED_CALLBACK, | |
| 265 | ACE_TYPE_ACCESS_DENIED_CALLBACK, | |
| 266 | ACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT, | |
| 267 | ACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT, | |
| 268 | ACE_TYPE_SYSTEM_AUDIT_OBJECT, | |
| 269 | ACE_TYPE_SYSTEM_AUDIT_CALLBACK, | |
| 270 | ACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT): | |
| 271 | additional_data['application_data'] = body | |
| 272 | ||
| 273 | # SYSTEM_RESOURCE_ATTRIBUTE ACEs have a tail of attribute data. | |
| 274 | if type_ == ACE_TYPE_SYSTEM_RESOURCE_ATTRIBUTE: | |
| 275 | additional_data['attribute_data'] = body | |
| 276 | ||
| 277 | return cls(type_, flags, mask, sid, additional_data) | |
| 278 | ||
| 279 | ||
| 280 | class ACL(object): | |
| 281 | """ | |
| 282 | Access control list, encapsulating a sequence of access control | |
| 283 | entries. | |
| 284 | ||
| 285 | See [MS-DTYP]: 2.4.5 | |
| 286 | """ | |
| 287 | HEADER_FORMAT = '<BBHHH' | |
| 288 | ||
| 289 | def __init__(self, revision, aces): | |
| 290 | #: Integer value of the revision. | |
| 291 | self.revision = revision | |
| 292 | #: List of :class:`ACE` instances. | |
| 293 | self.aces = aces | |
| 294 | ||
| 295 | def __repr__(self): | |
| 296 | return "ACL(%r)" % (self.aces,) | |
| 297 | ||
| 298 | @classmethod | |
| 299 | def from_bytes(cls, data): | |
| 300 | revision = None | |
| 301 | aces = [] | |
| 302 | ||
| 303 | header_size = struct.calcsize(cls.HEADER_FORMAT) | |
| 304 | header, remaining = data[:header_size], data[header_size:] | |
| 305 | revision, sbz1, size, count, sbz2 = struct.unpack(cls.HEADER_FORMAT, header) | |
| 306 | ||
| 307 | assert len(data) >= size | |
| 308 | ||
| 309 | for i in range(count): | |
| 310 | ace_size = struct.unpack('<H', remaining[2:4])[0] | |
| 311 | ace_data, remaining = remaining[:ace_size], remaining[ace_size:] | |
| 312 | aces.append(ACE.from_bytes(ace_data)) | |
| 313 | ||
| 314 | return cls(revision, aces) | |
| 315 | ||
| 316 | ||
| 317 | class SecurityDescriptor(object): | |
| 318 | """ | |
| 319 | Represents a security descriptor. | |
| 320 | ||
| 321 | See [MS-DTYP]: 2.4.6 | |
| 322 | """ | |
| 323 | ||
| 324 | HEADER_FORMAT = '<BBHIIII' | |
| 325 | ||
| 326 | def __init__(self, flags, owner, group, dacl, sacl): | |
| 327 | #: Integer bitmask of control flags. Corresponds to the | |
| 328 | #: ``Control`` field in [MS-DTYP] 2.4.6. | |
| 329 | self.flags = flags | |
| 330 | #: Instance of :class:`SID` representing the owner user. | |
| 331 | self.owner = owner | |
| 332 | #: Instance of :class:`SID` representing the owner group. | |
| 333 | self.group = group | |
| 334 | #: Instance of :class:`ACL` representing the discretionary access | |
| 335 | #: control list, which specifies access restrictions of an object. | |
| 336 | self.dacl = dacl | |
| 337 | #: Instance of :class:`ACL` representing the system access control | |
| 338 | #: list, which specifies audit logging of an object. | |
| 339 | self.sacl = sacl | |
| 340 | ||
| 341 | @classmethod | |
| 342 | def from_bytes(cls, data): | |
| 343 | owner = None | |
| 344 | group = None | |
| 345 | dacl = None | |
| 346 | sacl = None | |
| 347 | ||
| 348 | header = data[:struct.calcsize(cls.HEADER_FORMAT)] | |
| 349 | (revision, sbz1, flags, owner_offset, group_offset, sacl_offset, | |
| 350 | dacl_offset) = struct.unpack(cls.HEADER_FORMAT, header) | |
| 351 | ||
| 352 | assert revision == 1 | |
| 353 | assert flags & SECURITY_DESCRIPTOR_SELF_RELATIVE | |
| 354 | for offset in (owner_offset, group_offset, sacl_offset, dacl_offset): | |
| 355 | assert 0 <= offset < len(data) | |
| 356 | ||
| 357 | if owner_offset: | |
| 358 | owner = SID.from_bytes(data[owner_offset:]) | |
| 359 | if group_offset: | |
| 360 | group = SID.from_bytes(data[group_offset:]) | |
| 361 | if dacl_offset: | |
| 362 | dacl = ACL.from_bytes(data[dacl_offset:]) | |
| 363 | if sacl_offset: | |
| 364 | sacl = ACL.from_bytes(data[sacl_offset:]) | |
| 365 | ||
| 366 | return cls(flags, owner, group, dacl, sacl) |
| 269 | 269 | STRUCTURE_FORMAT = "<HHHH" |
| 270 | 270 | STRUCTURE_SIZE = struct.calcsize(STRUCTURE_FORMAT) |
| 271 | 271 | |
| 272 | @property | |
| 273 | def isGuestSession(self): | |
| 274 | return (self.session_flags & 0x0001) > 0 # SMB2_SESSION_FLAG_IS_GUEST | |
| 275 | ||
| 276 | @property | |
| 277 | def isAnonymousSession(self): | |
| 278 | return (self.session_flags & 0x0002) > 0 # SMB2_SESSION_FLAG_IS_NULL | |
| 279 | ||
| 272 | 280 | def decode(self, message): |
| 273 | 281 | assert message.command == SMB2_COM_SESSION_SETUP |
| 274 | 282 | |
| 361 | 369 | |
| 362 | 370 | def prepare(self, message): |
| 363 | 371 | buf = self.filename.encode('UTF-16LE') |
| 372 | filename_len = len(buf) | |
| 364 | 373 | if self.create_context_data: |
| 365 | 374 | n = SMB2Message.HEADER_SIZE + self.STRUCTURE_SIZE + len(buf) |
| 366 | 375 | if n % 8 != 0: |
| 388 | 397 | self.create_disp, |
| 389 | 398 | self.create_options, |
| 390 | 399 | SMB2Message.HEADER_SIZE + self.STRUCTURE_SIZE, # NameOffset |
| 391 | len(self.filename)*2, # NameLength in bytes | |
| 400 | filename_len, # Length of encoded filename in bytes | |
| 392 | 401 | create_context_offset, # CreateContextOffset |
| 393 | 402 | len(self.create_context_data) # CreateContextLength |
| 394 | 403 | ) + buf |
| 114 | 114 | FILE_READ_EA = 0x08 |
| 115 | 115 | FILE_WRITE_EA = 0x10 |
| 116 | 116 | FILE_EXECUTE = 0x20 |
| 117 | FILE_DELETE_CHILD = 0x40 | |
| 117 | 118 | FILE_READ_ATTRIBUTES = 0x80 |
| 118 | 119 | FILE_WRITE_ATTRIBUTES = 0x0100 |
| 119 | 120 | DELETE = 0x010000 |
| 224 | 225 | SMB_FILE_ATTRIBUTE_READONLY = 0x01 |
| 225 | 226 | SMB_FILE_ATTRIBUTE_HIDDEN = 0x02 |
| 226 | 227 | SMB_FILE_ATTRIBUTE_SYSTEM = 0x04 |
| 227 | SMB_FILE_ATTRIBUTE_VOLUME = 0x08 | |
| 228 | SMB_FILE_ATTRIBUTE_VOLUME = 0x08 # Unsupported for listPath() operations | |
| 228 | 229 | SMB_FILE_ATTRIBUTE_DIRECTORY = 0x10 |
| 229 | 230 | SMB_FILE_ATTRIBUTE_ARCHIVE = 0x20 |
| 231 | # SMB_FILE_ATTRIBUTE_INCL_NORMAL is a special placeholder to include normal files for | |
| 232 | # with other search attributes for listPath() operations. It is not defined in the MS-CIFS specs. | |
| 233 | SMB_FILE_ATTRIBUTE_INCL_NORMAL = 0x10000 | |
| 234 | # Do not use the following values for listPath() operations as they are not supported for SMB2 | |
| 230 | 235 | SMB_SEARCH_ATTRIBUTE_READONLY = 0x0100 |
| 231 | 236 | SMB_SEARCH_ATTRIBUTE_HIDDEN = 0x0200 |
| 232 | 237 | SMB_SEARCH_ATTRIBUTE_SYSTEM = 0x0400 |
| 236 | 241 | # Bitmask for OptionalSupport field in SMB_COM_TREE_CONNECT_ANDX response |
| 237 | 242 | SMB_TREE_CONNECTX_SUPPORT_SEARCH = 0x0001 |
| 238 | 243 | SMB_TREE_CONNECTX_SUPPORT_DFS = 0x0002 |
| 244 | ||
| 245 | # Bitmask for security information fields, specified as | |
| 246 | # AdditionalInformation in SMB2 | |
| 247 | # [MS-SMB]: 2.2.7.4 | |
| 248 | # [MS-SMB2]: 2.2.37 | |
| 249 | OWNER_SECURITY_INFORMATION = 0x00000001 | |
| 250 | GROUP_SECURITY_INFORMATION = 0x00000002 | |
| 251 | DACL_SECURITY_INFORMATION = 0x00000004 | |
| 252 | SACL_SECURITY_INFORMATION = 0x00000008 | |
| 253 | LABEL_SECURITY_INFORMATION = 0x00000010 | |
| 254 | ATTRIBUTE_SECURITY_INFORMATION = 0x00000020 | |
| 255 | SCOPE_SECURITY_INFORMATION = 0x00000040 | |
| 256 | BACKUP_SECURITY_INFORMATION = 0x00010000 | |
| 1279 | 1279 | - [MS-CIFS]: 2.2.4.39.1 |
| 1280 | 1280 | """ |
| 1281 | 1281 | |
| 1282 | def __init__(self, echo_data = '', echo_count = 1): | |
| 1282 | def __init__(self, echo_data = b'', echo_count = 1): | |
| 1283 | 1283 | self.echo_count = echo_count |
| 1284 | 1284 | self.echo_data = echo_data |
| 1285 | 1285 |
| 0 | ||
| 1 | def RC4_encrypt(key, data): | |
| 2 | S = list(range(256)) | |
| 3 | j = 0 | |
| 4 | ||
| 5 | key_len = len(key) | |
| 6 | for i in list(range(256)): | |
| 7 | j = (j + S[i] + ord(key[i % key_len])) % 256 | |
| 8 | S[i], S[j] = S[j], S[i] | |
| 9 | ||
| 10 | j = 0 | |
| 11 | y = 0 | |
| 12 | out = [] | |
| 13 | ||
| 14 | for char in data: | |
| 15 | j = (j + 1) % 256 | |
| 16 | y = (y + S[j]) % 256 | |
| 17 | S[j], S[y] = S[y], S[j] | |
| 18 | ||
| 19 | out.append(chr(ord(char) ^ S[(S[j] + S[y]) % 256])) | |
| 20 | ||
| 21 | return ''.join(out) |
| 3 | 3 | from nose.tools import with_setup |
| 4 | 4 | from smb import smb_structs |
| 5 | 5 | |
| 6 | conn = None | |
| 6 | conn, conn2, conn3 = None, None, None | |
| 7 | 7 | |
| 8 | 8 | def teardown_func(): |
| 9 | global conn | |
| 10 | conn.close() | |
| 9 | global conn, conn2, conn3 | |
| 10 | if conn: | |
| 11 | conn.close() | |
| 12 | if conn2: | |
| 13 | conn2.close() | |
| 14 | if conn3: | |
| 15 | conn3.close(); | |
| 11 | 16 | |
| 12 | 17 | @with_setup(teardown = teardown_func) |
| 13 | 18 | def test_NTLMv1_auth_SMB1(): |
| 14 | global conn | |
| 19 | global conn, conn2, conn3 | |
| 15 | 20 | smb_structs.SUPPORT_SMB2 = False |
| 16 | 21 | info = getConnectionInfo() |
| 17 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False) | |
| 22 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 18 | 23 | assert conn.connect(info['server_ip'], info['server_port']) |
| 24 | ||
| 25 | conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 26 | assert not conn2.connect(info['server_ip'], info['server_port']) | |
| 27 | ||
| 28 | conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 29 | assert not conn3.connect(info['server_ip'], info['server_port']) | |
| 30 | ||
| 31 | @with_setup(teardown = teardown_func) | |
| 32 | def test_NTLMv1_auth_SMB1_callable_password(): | |
| 33 | global conn, conn2, conn3 | |
| 34 | smb_structs.SUPPORT_SMB2 = False | |
| 35 | info = getConnectionInfo() | |
| 36 | conn = SMBConnection(info['user'], lambda: info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 37 | assert conn.connect(info['server_ip'], info['server_port']) | |
| 38 | ||
| 39 | conn2 = SMBConnection(info['user'], lambda: 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 40 | assert not conn2.connect(info['server_ip'], info['server_port']) | |
| 41 | ||
| 42 | conn3 = SMBConnection('INVALIDUSER', lambda: 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 43 | assert not conn3.connect(info['server_ip'], info['server_port']) | |
| 19 | 44 | |
| 20 | 45 | @with_setup(teardown = teardown_func) |
| 21 | 46 | def test_NTLMv2_auth_SMB1(): |
| 22 | global conn | |
| 47 | global conn, conn2, conn3 | |
| 23 | 48 | smb_structs.SUPPORT_SMB2 = False |
| 24 | 49 | info = getConnectionInfo() |
| 25 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 50 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 26 | 51 | assert conn.connect(info['server_ip'], info['server_port']) |
| 52 | ||
| 53 | conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 54 | assert not conn2.connect(info['server_ip'], info['server_port']) | |
| 55 | ||
| 56 | conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 57 | assert not conn3.connect(info['server_ip'], info['server_port']) | |
| 27 | 58 | |
| 28 | 59 | @with_setup(teardown = teardown_func) |
| 29 | 60 | def test_NTLMv1_auth_SMB2(): |
| 30 | global conn | |
| 61 | global conn, conn2, conn3 | |
| 31 | 62 | smb_structs.SUPPORT_SMB2 = True |
| 32 | 63 | info = getConnectionInfo() |
| 33 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False) | |
| 64 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 34 | 65 | assert conn.connect(info['server_ip'], info['server_port']) |
| 66 | ||
| 67 | conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 68 | assert not conn2.connect(info['server_ip'], info['server_port']) | |
| 69 | ||
| 70 | conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 71 | assert not conn3.connect(info['server_ip'], info['server_port']) | |
| 35 | 72 | |
| 36 | 73 | @with_setup(teardown = teardown_func) |
| 37 | 74 | def test_NTLMv2_auth_SMB2(): |
| 38 | global conn | |
| 75 | global conn, conn2, conn3 | |
| 39 | 76 | smb_structs.SUPPORT_SMB2 = True |
| 40 | 77 | info = getConnectionInfo() |
| 41 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 78 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 42 | 79 | assert conn.connect(info['server_ip'], info['server_port']) |
| 80 | ||
| 81 | conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 82 | assert not conn2.connect(info['server_ip'], info['server_port']) | |
| 83 | ||
| 84 | conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 85 | assert not conn3.connect(info['server_ip'], info['server_port']) |
| 12 | 12 | smb_structs.SUPPORT_SMB2 = False |
| 13 | 13 | |
| 14 | 14 | info = getConnectionInfo() |
| 15 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 15 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 16 | 16 | assert conn.connect(info['server_ip'], info['server_port']) |
| 17 | 17 | |
| 18 | 18 | def setup_func_SMB2(): |
| 20 | 20 | smb_structs.SUPPORT_SMB2 = True |
| 21 | 21 | |
| 22 | 22 | info = getConnectionInfo() |
| 23 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 23 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 24 | 24 | assert conn.connect(info['server_ip'], info['server_port']) |
| 25 | 25 | |
| 26 | 26 | def teardown_func(): |
| 8 | 8 | def setup_func(): |
| 9 | 9 | global conn |
| 10 | 10 | info = getConnectionInfo() |
| 11 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 11 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 12 | 12 | assert conn.connect(info['server_ip'], info['server_port']) |
| 13 | 13 | |
| 14 | 14 | def teardown_func(): |
| 21 | 21 | |
| 22 | 22 | data = '%d' % random.randint(1000, 9999) |
| 23 | 23 | assert conn.echo(data) == data |
| 24 | ||
| 0 | 0 | # -*- coding: utf-8 -*- |
| 1 | 1 | |
| 2 | 2 | from smb.SMBConnection import SMBConnection |
| 3 | from smb.smb_constants import * | |
| 3 | 4 | from util import getConnectionInfo |
| 4 | 5 | from nose.tools import with_setup |
| 5 | 6 | from smb import smb_structs |
| 10 | 11 | global conn |
| 11 | 12 | smb_structs.SUPPORT_SMB2 = False |
| 12 | 13 | info = getConnectionInfo() |
| 13 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 14 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 14 | 15 | assert conn.connect(info['server_ip'], info['server_port']) |
| 15 | 16 | |
| 16 | 17 | def setup_func_SMB2(): |
| 17 | 18 | global conn |
| 18 | 19 | smb_structs.SUPPORT_SMB2 = True |
| 19 | 20 | info = getConnectionInfo() |
| 20 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 21 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 21 | 22 | assert conn.connect(info['server_ip'], info['server_port']) |
| 22 | 23 | |
| 23 | 24 | def teardown_func(): |
| 44 | 45 | assert ( u'Test Folder', True ) in filenames |
| 45 | 46 | assert ( u'子文件夹', True ) in filenames |
| 46 | 47 | |
| 48 | @with_setup(setup_func_SMB1, teardown_func) | |
| 49 | def test_listPathWithManyFiles_SMB1(): | |
| 50 | global conn | |
| 51 | results = conn.listPath('smbtest', '/RFC Archive/') | |
| 52 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 53 | assert len(filenames)==999 | |
| 54 | ||
| 47 | 55 | @with_setup(setup_func_SMB2, teardown_func) |
| 48 | 56 | def test_listPath_SMB2(): |
| 49 | 57 | global conn |
| 63 | 71 | assert ( u'Test File.txt', False ) in filenames |
| 64 | 72 | assert ( u'Test Folder', True ) in filenames |
| 65 | 73 | assert ( u'子文件夹', True ) in filenames |
| 74 | ||
| 75 | @with_setup(setup_func_SMB2, teardown_func) | |
| 76 | def test_listPathWithManyFiles_SMB2(): | |
| 77 | global conn | |
| 78 | results = conn.listPath('smbtest', '/RFC Archive/') | |
| 79 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 80 | assert len(filenames)==999 | |
| 81 | ||
| 82 | @with_setup(setup_func_SMB1, teardown_func) | |
| 83 | def test_listPathFilterForDirectory_SMB1(): | |
| 84 | global conn | |
| 85 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY) | |
| 86 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 87 | assert len(filenames) > 0 | |
| 88 | for f, isDirectory in filenames: | |
| 89 | assert isDirectory | |
| 90 | ||
| 91 | @with_setup(setup_func_SMB2, teardown_func) | |
| 92 | def test_listPathFilterForDirectory_SMB2(): | |
| 93 | global conn | |
| 94 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY) | |
| 95 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 96 | assert len(filenames) > 0 | |
| 97 | for f, isDirectory in filenames: | |
| 98 | assert isDirectory | |
| 99 | ||
| 100 | @with_setup(setup_func_SMB1, teardown_func) | |
| 101 | def test_listPathFilterForFiles_SMB1(): | |
| 102 | global conn | |
| 103 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL) | |
| 104 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 105 | assert len(filenames) > 0 | |
| 106 | for f, isDirectory in filenames: | |
| 107 | assert not isDirectory | |
| 108 | ||
| 109 | @with_setup(setup_func_SMB2, teardown_func) | |
| 110 | def test_listPathFilterForFiles_SMB2(): | |
| 111 | global conn | |
| 112 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL) | |
| 113 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 114 | assert len(filenames) > 0 | |
| 115 | for f, isDirectory in filenames: | |
| 116 | assert not isDirectory | |
| 117 | ||
| 118 | @with_setup(setup_func_SMB1, teardown_func) | |
| 119 | def test_listPathFilterPattern_SMB1(): | |
| 120 | global conn | |
| 121 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*') | |
| 122 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 123 | assert len(filenames) == 2 | |
| 124 | assert ( u'Test File.txt', False ) in filenames | |
| 125 | assert ( u'Test Folder', True ) in filenames | |
| 126 | assert ( u'子文件夹', True ) not in filenames | |
| 127 | ||
| 128 | @with_setup(setup_func_SMB2, teardown_func) | |
| 129 | def test_listPathFilterPattern_SMB2(): | |
| 130 | global conn | |
| 131 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*') | |
| 132 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 133 | assert len(filenames) == 2 | |
| 134 | assert ( u'Test File.txt', False ) in filenames | |
| 135 | assert ( u'Test Folder', True ) in filenames | |
| 136 | assert ( u'子文件夹', True ) not in filenames | |
| 137 | ||
| 138 | @with_setup(setup_func_SMB1, teardown_func) | |
| 139 | def test_listPathFilterUnicodePattern_SMB1(): | |
| 140 | global conn | |
| 141 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹') | |
| 142 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 143 | assert len(filenames) == 1 | |
| 144 | assert ( u'Test File.txt', False ) not in filenames | |
| 145 | assert ( u'Test Folder', True ) not in filenames | |
| 146 | assert ( u'子文件夹', True ) in filenames | |
| 147 | ||
| 148 | @with_setup(setup_func_SMB2, teardown_func) | |
| 149 | def test_listPathFilterUnicodePattern_SMB2(): | |
| 150 | global conn | |
| 151 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹') | |
| 152 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 153 | assert len(filenames) == 1 | |
| 154 | assert ( u'Test File.txt', False ) not in filenames | |
| 155 | assert ( u'Test Folder', True ) not in filenames | |
| 156 | assert ( u'子文件夹', True ) in filenames | |
| 9 | 9 | global conn |
| 10 | 10 | smb_structs.SUPPORT_SMB2 = False |
| 11 | 11 | info = getConnectionInfo() |
| 12 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 12 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 13 | 13 | assert conn.connect(info['server_ip'], info['server_port']) |
| 14 | 14 | |
| 15 | 15 | def setup_func_SMB2(): |
| 16 | 16 | global conn |
| 17 | 17 | smb_structs.SUPPORT_SMB2 = True |
| 18 | 18 | info = getConnectionInfo() |
| 19 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 19 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 20 | 20 | assert conn.connect(info['server_ip'], info['server_port']) |
| 21 | 21 | |
| 22 | 22 | def teardown_func(): |
| 9 | 9 | global conn |
| 10 | 10 | smb_structs.SUPPORT_SMB2 = False |
| 11 | 11 | info = getConnectionInfo() |
| 12 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 12 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 13 | 13 | assert conn.connect(info['server_ip'], info['server_port']) |
| 14 | 14 | |
| 15 | 15 | def setup_func_SMB2(): |
| 16 | 16 | global conn |
| 17 | 17 | smb_structs.SUPPORT_SMB2 = True |
| 18 | 18 | info = getConnectionInfo() |
| 19 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 19 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 20 | 20 | assert conn.connect(info['server_ip'], info['server_port']) |
| 21 | 21 | |
| 22 | 22 | def teardown_func(): |
| 12 | 12 | global conn |
| 13 | 13 | smb_structs.SUPPORT_SMB2 = False |
| 14 | 14 | info = getConnectionInfo() |
| 15 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 15 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 16 | 16 | assert conn.connect(info['server_ip'], info['server_port']) |
| 17 | 17 | |
| 18 | 18 | def setup_func_SMB2(): |
| 19 | 19 | global conn |
| 20 | 20 | smb_structs.SUPPORT_SMB2 = True |
| 21 | 21 | info = getConnectionInfo() |
| 22 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 22 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 23 | 23 | assert conn.connect(info['server_ip'], info['server_port']) |
| 24 | 24 | |
| 25 | 25 | def teardown_func(): |
| 19 | 19 | global conn |
| 20 | 20 | smb_structs.SUPPORT_SMB2 = False |
| 21 | 21 | info = getConnectionInfo() |
| 22 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 22 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 23 | 23 | assert conn.connect(info['server_ip'], info['server_port']) |
| 24 | 24 | |
| 25 | 25 | def setup_func_SMB2(): |
| 26 | 26 | global conn |
| 27 | 27 | smb_structs.SUPPORT_SMB2 = True |
| 28 | 28 | info = getConnectionInfo() |
| 29 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 29 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 30 | 30 | assert conn.connect(info['server_ip'], info['server_port']) |
| 31 | 31 | |
| 32 | 32 | def teardown_func(): |
| 24 | 24 | smb_structs.SUPPORT_SMB2 = False |
| 25 | 25 | |
| 26 | 26 | info = getConnectionInfo() |
| 27 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 27 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 28 | 28 | assert conn.connect(info['server_ip'], info['server_port']) |
| 29 | 29 | |
| 30 | 30 | def setup_func_SMB2(): |
| 32 | 32 | smb_structs.SUPPORT_SMB2 = True |
| 33 | 33 | |
| 34 | 34 | info = getConnectionInfo() |
| 35 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 35 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 36 | 36 | assert conn.connect(info['server_ip'], info['server_port']) |
| 37 | 37 | |
| 38 | 38 | def teardown_func(): |
| 9 | 9 | info = { |
| 10 | 10 | 'server_name': cp.get('server', 'name'), |
| 11 | 11 | 'server_ip': cp.get('server', 'ip'), |
| 12 | 'server_port': cp.getint('server', 'port'), | |
| 12 | 'server_port': cp.getint('server', 'direct_port'), | |
| 13 | 13 | 'client_name': cp.get('client', 'name'), |
| 14 | 14 | 'user': cp.get('user', 'name'), |
| 15 | 15 | 'password': cp.get('user', 'password'), |
| 0 | ||
| 1 | Steps to Follow to Run the Unit Tests | |
| 2 | ===================================== | |
| 3 | ||
| 4 | ## Step 1: Install system dependencies ## | |
| 5 | ||
| 6 | If you are using Ubuntu 20.04 LTS, you can install the system dependencies with the following command | |
| 7 | ``` | |
| 8 | $> apt-get install virtualenv python-dev gcc g++ make automake autoconf | |
| 9 | ``` | |
| 10 | For other distributions, you can use their package managers and install the system dependencies (although the package names might differ slightly). | |
| 11 | ||
| 12 | ## Step 2: Setup python virtualenv ## | |
| 13 | ||
| 14 | We will create a python2 virtualenv and install the python dependencies for testing in the "venv2" folder. | |
| 15 | ||
| 16 | ``` | |
| 17 | $> cd <pysmb-home>/python2 | |
| 18 | $> virtualenv -p /usr/bin/python2 venv2 | |
| 19 | $> source venv2/bin/activate | |
| 20 | $venv2> pip install nose pyasn1 twisted | |
| 21 | ``` | |
| 22 | ||
| 23 | ## Step 3: Setup shared folder on your remote SMB server ## | |
| 24 | ||
| 25 | Prepare a shared folder called "smbtest" on your remote SMB server (Windows or Samba). | |
| 26 | ||
| 27 | Then, download [smbtest.zip](https://miketeo.net/files/Projects/pysmb/smbtest.zip) and unzip the contents of this zip file in the shared folder. | |
| 28 | ||
| 29 | You should also configure a user on the SMB server with read-write access to the "smbtest" folder. | |
| 30 | ||
| 31 | ## Step 4: Update connection details in connection.ini ## | |
| 32 | ||
| 33 | In the same folder where you are viewing this readme file, there should be an ini file called "connection.ini". Edit this file's connection details to match the shared folder's access information. | |
| 34 | ||
| 35 | ## Step 5: Run the unit tests in the python2 folder ## | |
| 36 | ||
| 37 | Before running the tests, the venv2 virtualenv must be activated. | |
| 38 | ``` | |
| 39 | $> cd <pysmb-home>/python2 | |
| 40 | $> source venv2/bin/activate | |
| 41 | ``` | |
| 42 | ||
| 43 | To run all the tests: | |
| 44 | ``` | |
| 45 | $venv2> nosetests -v tests | |
| 46 | ``` | |
| 47 | ||
| 48 | To selectively run some tests: | |
| 49 | ``` | |
| 50 | $venv2> nosetests -v tests/SMBConnectionTests | |
| 51 | $venv2> nosetests -v tests/SMBConnectionTests/test_rename.py | |
| 52 | $venv2> nosetests -v tests/SMBConnectionTests/test_rename.py:test_rename_english_file_SMB1 | |
| 53 | ``` | |
| 54 | ||
| 55 | For more information, please consult the [documentation for nose](https://nose.readthedocs.io/). | |
| 56 | ||
| 57 |
| 0 | ||
| 1 | Steps to Follow to Run the Unit Tests | |
| 2 | ===================================== | |
| 3 | ||
| 4 | 1a. Install Nose Testing Framework | |
| 5 | All the unit tests here are designed to be conducted with the nose testing framework. | |
| 6 | You can install the latest nose testing framework by running: easy_install nose | |
| 7 | For more information on nose testing, please visit http://readthedocs.org/docs/nose/en/latest/ | |
| 8 | ||
| 9 | 1b. Install the Twisted framework | |
| 10 | If you need to test the SMB/NetBIOS protocol implementations for Twisted framework, | |
| 11 | you should install the Twisted framework from http://twistedmatrix.com/ | |
| 12 | or by running: easy_install Twisted | |
| 13 | Without the Twisted framework, the Twisted tests will fail. | |
| 14 | ||
| 15 | 2. Prepare a Shared Folder "smbtest" on a Remote Server | |
| 16 | To run the unit tests here, besides installing the nose testing framework, you will | |
| 17 | also need to prepare a shared folder on a remote server. | |
| 18 | pysmb has been tested against Samba 3.x, Windows XP SP3 and Windows Vista. | |
| 19 | The shared folder must be named "smbtest". | |
| 20 | ||
| 21 | 3. Unzip smbtest.zip in the Shared Folder | |
| 22 | In the same folder where you are viewing this readme file, there should be a zip file | |
| 23 | called "smbtest.zip". Unzip the contents of this zip file in the shared folder. | |
| 24 | ||
| 25 | 4. Update Connection Details in connection.ini | |
| 26 | In the same folder where you are viewing this readme file, there should be an ini file | |
| 27 | called "connection.ini". Edit this file's connection details to match the shared folder's | |
| 28 | access information. | |
| 29 | ||
| 30 | 5. Run the Unit Tests | |
| 31 | Just run: nosetests |
| 3 | 3 | from nose.tools import with_setup |
| 4 | 4 | from smb import smb_structs |
| 5 | 5 | |
| 6 | conn = None | |
| 6 | conn, conn2, conn3 = None, None, None | |
| 7 | 7 | |
| 8 | 8 | def teardown_func(): |
| 9 | global conn | |
| 10 | conn.close() | |
| 9 | global conn, conn2, conn3 | |
| 10 | if conn: | |
| 11 | conn.close() | |
| 12 | if conn2: | |
| 13 | conn2.close() | |
| 14 | if conn3: | |
| 15 | conn3.close(); | |
| 11 | 16 | |
| 12 | 17 | @with_setup(teardown = teardown_func) |
| 13 | 18 | def test_NTLMv1_auth_SMB1(): |
| 17 | 22 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = False) |
| 18 | 23 | assert conn.connect(info['server_ip'], info['server_port']) |
| 19 | 24 | |
| 25 | conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False) | |
| 26 | assert not conn2.connect(info['server_ip'], info['server_port']) | |
| 27 | ||
| 28 | conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False) | |
| 29 | assert not conn3.connect(info['server_ip'], info['server_port']) | |
| 30 | ||
| 20 | 31 | @with_setup(teardown = teardown_func) |
| 21 | 32 | def test_NTLMv2_auth_SMB1(): |
| 22 | 33 | global conn |
| 24 | 35 | info = getConnectionInfo() |
| 25 | 36 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = True) |
| 26 | 37 | assert conn.connect(info['server_ip'], info['server_port']) |
| 38 | ||
| 39 | conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 40 | assert not conn2.connect(info['server_ip'], info['server_port']) | |
| 41 | ||
| 42 | conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 43 | assert not conn3.connect(info['server_ip'], info['server_port']) | |
| 27 | 44 | |
| 28 | 45 | @with_setup(teardown = teardown_func) |
| 29 | 46 | def test_NTLMv1_auth_SMB2(): |
| 33 | 50 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = False) |
| 34 | 51 | assert conn.connect(info['server_ip'], info['server_port']) |
| 35 | 52 | |
| 53 | conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False) | |
| 54 | assert not conn2.connect(info['server_ip'], info['server_port']) | |
| 55 | ||
| 56 | conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False) | |
| 57 | assert not conn3.connect(info['server_ip'], info['server_port']) | |
| 58 | ||
| 36 | 59 | @with_setup(teardown = teardown_func) |
| 37 | 60 | def test_NTLMv2_auth_SMB2(): |
| 38 | 61 | global conn |
| 40 | 63 | info = getConnectionInfo() |
| 41 | 64 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = True) |
| 42 | 65 | assert conn.connect(info['server_ip'], info['server_port']) |
| 66 | ||
| 67 | conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 68 | assert not conn2.connect(info['server_ip'], info['server_port']) | |
| 69 | ||
| 70 | conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 71 | assert not conn3.connect(info['server_ip'], info['server_port']) | |
| 29 | 29 | conn.close() |
| 30 | 30 | |
| 31 | 31 | @with_setup(setup_func_SMB1, teardown_func) |
| 32 | def test_delete_SMB1(): | |
| 33 | global conn | |
| 34 | ||
| 35 | path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 36 | conn.createDirectory('smbtest', path) | |
| 37 | ||
| 38 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 39 | conn.storeFile('smbtest', path+"/"+filename, StringIO("0123456789")) | |
| 40 | ||
| 41 | results = conn.listPath('smbtest', path) | |
| 42 | filenames = map(lambda r: r.filename, results) | |
| 32 | def test_delete_without_subfolder_SMB1(): | |
| 33 | global conn | |
| 34 | ||
| 35 | path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 36 | conn.createDirectory('smbtest', path) | |
| 37 | ||
| 38 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 39 | conn.storeFile('smbtest', path+"/"+filename, StringIO("0123456789")) | |
| 40 | ||
| 41 | for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]: | |
| 42 | conn.createDirectory('smbtest', path+"/"+p) | |
| 43 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 44 | conn.storeFile('smbtest', path+"/"+p+"/"+filename, StringIO("0123456789")) | |
| 45 | ||
| 46 | results = conn.listPath('smbtest', path) | |
| 47 | filenames = map(lambda r: r.filename, results) | |
| 48 | assert 'aaTest.Folder' in filenames | |
| 49 | assert 'bbTest.Folder' in filenames | |
| 43 | 50 | assert 'aaTest.txt' in filenames |
| 44 | 51 | assert 'aaBest.txt' in filenames |
| 45 | 52 | assert 'aaTest.bin' in filenames |
| 50 | 57 | |
| 51 | 58 | results = conn.listPath('smbtest', path) |
| 52 | 59 | filenames = map(lambda r: r.filename, results) |
| 60 | assert 'aaTest.Folder' in filenames | |
| 61 | assert 'bbTest.Folder' in filenames | |
| 53 | 62 | assert 'aaTest.txt' not in filenames |
| 54 | 63 | assert 'aaBest.txt' not in filenames |
| 55 | 64 | assert 'aaTest.bin' in filenames |
| 60 | 69 | |
| 61 | 70 | results = conn.listPath('smbtest', path) |
| 62 | 71 | filenames = map(lambda r: r.filename, results) |
| 63 | assert 'aaTest.bin' not in filenames | |
| 64 | assert 'aaBest.bin' in filenames | |
| 65 | assert 'random.txt' in filenames | |
| 66 | ||
| 67 | conn.deleteFiles('smbtest', path+'/*') | |
| 68 | conn.deleteDirectory('smbtest', path) | |
| 72 | assert 'aaTest.Folder' in filenames | |
| 73 | assert 'bbTest.Folder' in filenames | |
| 74 | assert 'aaTest.bin' not in filenames | |
| 75 | assert 'aaBest.bin' in filenames | |
| 76 | assert 'random.txt' in filenames | |
| 77 | ||
| 78 | ||
| 79 | @with_setup(setup_func_SMB1, teardown_func) | |
| 80 | def test_delete_with_subfolder_SMB1(): | |
| 81 | global conn | |
| 82 | ||
| 83 | path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 84 | conn.createDirectory('smbtest', path) | |
| 85 | ||
| 86 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 87 | conn.storeFile('smbtest', path+"/"+filename, StringIO("0123456789")) | |
| 88 | ||
| 89 | for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]: | |
| 90 | conn.createDirectory('smbtest', path+"/"+p) | |
| 91 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 92 | conn.storeFile('smbtest', path+"/"+p+"/"+filename, StringIO("0123456789")) | |
| 93 | ||
| 94 | results = conn.listPath('smbtest', path) | |
| 95 | filenames = map(lambda r: r.filename, results) | |
| 96 | assert 'aaTest.Folder' in filenames | |
| 97 | assert 'bbTest.Folder' in filenames | |
| 98 | assert 'aaTest.txt' in filenames | |
| 99 | assert 'aaBest.txt' in filenames | |
| 100 | assert 'aaTest.bin' in filenames | |
| 101 | assert 'aaBest.bin' in filenames | |
| 102 | assert 'random.txt' in filenames | |
| 103 | ||
| 104 | conn.deleteFiles('smbtest', path+'/aa*.txt', delete_matching_folders=True) | |
| 105 | ||
| 106 | results = conn.listPath('smbtest', path) | |
| 107 | filenames = map(lambda r: r.filename, results) | |
| 108 | assert 'aaTest.Folder' in filenames | |
| 109 | assert 'bbTest.Folder' in filenames | |
| 110 | assert 'aaTest.txt' not in filenames | |
| 111 | assert 'aaBest.txt' not in filenames | |
| 112 | assert 'aaTest.bin' in filenames | |
| 113 | assert 'aaBest.bin' in filenames | |
| 114 | assert 'random.txt' in filenames | |
| 115 | ||
| 116 | conn.deleteFiles('smbtest', path+'/aaTest.*', delete_matching_folders=True) | |
| 117 | ||
| 118 | results = conn.listPath('smbtest', path) | |
| 119 | filenames = map(lambda r: r.filename, results) | |
| 120 | assert 'aaTest.Folder' not in filenames | |
| 121 | assert 'bbTest.Folder' in filenames | |
| 122 | assert 'aaTest.bin' not in filenames | |
| 123 | assert 'aaBest.bin' in filenames | |
| 124 | assert 'random.txt' in filenames | |
| 125 | ||
| 69 | 126 | |
| 70 | 127 | @with_setup(setup_func_SMB2, teardown_func) |
| 71 | def test_delete_SMB2(): | |
| 72 | global conn | |
| 73 | ||
| 74 | path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 75 | conn.createDirectory('smbtest', path) | |
| 76 | ||
| 77 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 78 | conn.storeFile('smbtest', path+"/"+filename, StringIO("0123456789")) | |
| 79 | ||
| 80 | results = conn.listPath('smbtest', path) | |
| 81 | filenames = map(lambda r: r.filename, results) | |
| 128 | def test_delete_without_subfolder_SMB2(): | |
| 129 | global conn | |
| 130 | ||
| 131 | path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 132 | conn.createDirectory('smbtest', path) | |
| 133 | ||
| 134 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 135 | conn.storeFile('smbtest', path+"/"+filename, StringIO("0123456789")) | |
| 136 | ||
| 137 | for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]: | |
| 138 | conn.createDirectory('smbtest', path+"/"+p) | |
| 139 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 140 | conn.storeFile('smbtest', path+"/"+p+"/"+filename, StringIO("0123456789")) | |
| 141 | ||
| 142 | results = conn.listPath('smbtest', path) | |
| 143 | filenames = map(lambda r: r.filename, results) | |
| 144 | assert 'aaTest.Folder' in filenames | |
| 145 | assert 'bbTest.Folder' in filenames | |
| 82 | 146 | assert 'aaTest.txt' in filenames |
| 83 | 147 | assert 'aaBest.txt' in filenames |
| 84 | 148 | assert 'aaTest.bin' in filenames |
| 89 | 153 | |
| 90 | 154 | results = conn.listPath('smbtest', path) |
| 91 | 155 | filenames = map(lambda r: r.filename, results) |
| 156 | assert 'aaTest.Folder' in filenames | |
| 157 | assert 'bbTest.Folder' in filenames | |
| 92 | 158 | assert 'aaTest.txt' not in filenames |
| 93 | 159 | assert 'aaBest.txt' not in filenames |
| 94 | 160 | assert 'aaTest.bin' in filenames |
| 99 | 165 | |
| 100 | 166 | results = conn.listPath('smbtest', path) |
| 101 | 167 | filenames = map(lambda r: r.filename, results) |
| 102 | assert 'aaTest.bin' not in filenames | |
| 103 | assert 'aaBest.bin' in filenames | |
| 104 | assert 'random.txt' in filenames | |
| 168 | assert 'aaTest.Folder' in filenames | |
| 169 | assert 'bbTest.Folder' in filenames | |
| 170 | assert 'aaTest.bin' not in filenames | |
| 171 | assert 'aaBest.bin' in filenames | |
| 172 | assert 'random.txt' in filenames | |
| 173 | ||
| 174 | @with_setup(setup_func_SMB2, teardown_func) | |
| 175 | def test_delete_with_subfolder_SMB2(): | |
| 176 | global conn | |
| 177 | ||
| 178 | path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 179 | conn.createDirectory('smbtest', path) | |
| 180 | ||
| 181 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 182 | conn.storeFile('smbtest', path+"/"+filename, StringIO("0123456789")) | |
| 183 | ||
| 184 | for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]: | |
| 185 | conn.createDirectory('smbtest', path+"/"+p) | |
| 186 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 187 | conn.storeFile('smbtest', path+"/"+p+"/"+filename, StringIO("0123456789")) | |
| 188 | ||
| 189 | results = conn.listPath('smbtest', path) | |
| 190 | filenames = map(lambda r: r.filename, results) | |
| 191 | assert 'aaTest.Folder' in filenames | |
| 192 | assert 'bbTest.Folder' in filenames | |
| 193 | assert 'aaTest.txt' in filenames | |
| 194 | assert 'aaBest.txt' in filenames | |
| 195 | assert 'aaTest.bin' in filenames | |
| 196 | assert 'aaBest.bin' in filenames | |
| 197 | assert 'random.txt' in filenames | |
| 198 | ||
| 199 | conn.deleteFiles('smbtest', path+'/aa*.txt', delete_matching_folders=True) | |
| 200 | ||
| 201 | results = conn.listPath('smbtest', path) | |
| 202 | filenames = map(lambda r: r.filename, results) | |
| 203 | assert 'aaTest.Folder' in filenames | |
| 204 | assert 'bbTest.Folder' in filenames | |
| 205 | assert 'aaTest.txt' not in filenames | |
| 206 | assert 'aaBest.txt' not in filenames | |
| 207 | assert 'aaTest.bin' in filenames | |
| 208 | assert 'aaBest.bin' in filenames | |
| 209 | assert 'random.txt' in filenames | |
| 210 | ||
| 211 | conn.deleteFiles('smbtest', path+'/aaTest.*', delete_matching_folders=True) | |
| 212 | ||
| 213 | results = conn.listPath('smbtest', path) | |
| 214 | filenames = map(lambda r: r.filename, results) | |
| 215 | assert 'aaTest.Folder' not in filenames | |
| 216 | assert 'bbTest.Folder' in filenames | |
| 217 | assert 'aaTest.bin' not in filenames | |
| 218 | assert 'aaBest.bin' in filenames | |
| 219 | assert 'random.txt' in filenames | |
| 0 | 0 | # -*- coding: utf-8 -*- |
| 1 | 1 | |
| 2 | 2 | from smb.SMBConnection import SMBConnection |
| 3 | from smb.smb_constants import * | |
| 3 | 4 | from util import getConnectionInfo |
| 4 | 5 | from nose.tools import with_setup |
| 5 | 6 | from smb import smb_structs |
| 44 | 45 | assert ( u'Test Folder', True ) in filenames |
| 45 | 46 | assert ( u'子文件夹', True ) in filenames |
| 46 | 47 | |
| 48 | @with_setup(setup_func_SMB1, teardown_func) | |
| 49 | def test_listPathWithManyFiles_SMB1(): | |
| 50 | global conn | |
| 51 | results = conn.listPath('smbtest', '/RFC Archive/') | |
| 52 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 53 | assert len(filenames)==999 | |
| 54 | ||
| 47 | 55 | @with_setup(setup_func_SMB2, teardown_func) |
| 48 | 56 | def test_listPath_SMB2(): |
| 49 | 57 | global conn |
| 63 | 71 | assert ( u'Test File.txt', False ) in filenames |
| 64 | 72 | assert ( u'Test Folder', True ) in filenames |
| 65 | 73 | assert ( u'子文件夹', True ) in filenames |
| 74 | ||
| 75 | @with_setup(setup_func_SMB2, teardown_func) | |
| 76 | def test_listPathWithManyFiles_SMB2(): | |
| 77 | global conn | |
| 78 | results = conn.listPath('smbtest', '/RFC Archive/') | |
| 79 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 80 | assert len(filenames)==999 | |
| 81 | ||
| 82 | @with_setup(setup_func_SMB1, teardown_func) | |
| 83 | def test_listPathFilterForDirectory_SMB1(): | |
| 84 | global conn | |
| 85 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY) | |
| 86 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 87 | assert len(filenames) > 0 | |
| 88 | for f, isDirectory in filenames: | |
| 89 | assert isDirectory | |
| 90 | ||
| 91 | @with_setup(setup_func_SMB2, teardown_func) | |
| 92 | def test_listPathFilterForDirectory_SMB2(): | |
| 93 | global conn | |
| 94 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY) | |
| 95 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 96 | assert len(filenames) > 0 | |
| 97 | for f, isDirectory in filenames: | |
| 98 | assert isDirectory | |
| 99 | ||
| 100 | @with_setup(setup_func_SMB1, teardown_func) | |
| 101 | def test_listPathFilterForFiles_SMB1(): | |
| 102 | global conn | |
| 103 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL) | |
| 104 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 105 | assert len(filenames) > 0 | |
| 106 | for f, isDirectory in filenames: | |
| 107 | assert not isDirectory | |
| 108 | ||
| 109 | @with_setup(setup_func_SMB2, teardown_func) | |
| 110 | def test_listPathFilterForFiles_SMB2(): | |
| 111 | global conn | |
| 112 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL) | |
| 113 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 114 | assert len(filenames) > 0 | |
| 115 | for f, isDirectory in filenames: | |
| 116 | assert not isDirectory | |
| 117 | ||
| 118 | @with_setup(setup_func_SMB1, teardown_func) | |
| 119 | def test_listPathFilterPattern_SMB1(): | |
| 120 | global conn | |
| 121 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*') | |
| 122 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 123 | assert len(filenames) == 2 | |
| 124 | assert ( u'Test File.txt', False ) in filenames | |
| 125 | assert ( u'Test Folder', True ) in filenames | |
| 126 | assert ( u'子文件夹', True ) not in filenames | |
| 127 | ||
| 128 | @with_setup(setup_func_SMB2, teardown_func) | |
| 129 | def test_listPathFilterPattern_SMB2(): | |
| 130 | global conn | |
| 131 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*') | |
| 132 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 133 | assert len(filenames) == 2 | |
| 134 | assert ( u'Test File.txt', False ) in filenames | |
| 135 | assert ( u'Test Folder', True ) in filenames | |
| 136 | assert ( u'子文件夹', True ) not in filenames | |
| 137 | ||
| 138 | @with_setup(setup_func_SMB1, teardown_func) | |
| 139 | def test_listPathFilterUnicodePattern_SMB1(): | |
| 140 | global conn | |
| 141 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹') | |
| 142 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 143 | assert len(filenames) == 1 | |
| 144 | assert ( u'Test File.txt', False ) not in filenames | |
| 145 | assert ( u'Test Folder', True ) not in filenames | |
| 146 | assert ( u'子文件夹', True ) in filenames | |
| 147 | ||
| 148 | @with_setup(setup_func_SMB2, teardown_func) | |
| 149 | def test_listPathFilterUnicodePattern_SMB2(): | |
| 150 | global conn | |
| 151 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹') | |
| 152 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 153 | assert len(filenames) == 1 | |
| 154 | assert ( u'Test File.txt', False ) not in filenames | |
| 155 | assert ( u'Test Folder', True ) not in filenames | |
| 156 | assert ( u'子文件夹', True ) in filenames | |
| 157 | ||
| 158 | @with_setup(setup_func_SMB1, teardown_func) | |
| 159 | def test_listPathFilterEmptyList_SMB1(): | |
| 160 | global conn | |
| 161 | results = conn.listPath('smbtest', '/RFC Archive', pattern = '*.abc') | |
| 162 | filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results)) | |
| 163 | ||
| 164 | @with_setup(setup_func_SMB2, teardown_func) | |
| 165 | def test_listPathFilterEmptyList_SMB2(): | |
| 166 | global conn | |
| 167 | results = conn.listPath('smbtest', '/RFC Archive', pattern = '*.abc') | |
| 168 | filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results)) | |
| 0 | # -*- coding: utf-8 -*- | |
| 1 | ||
| 2 | import os, tempfile | |
| 3 | from StringIO import StringIO | |
| 4 | from smb.SMBConnection import SMBConnection | |
| 5 | from util import getConnectionInfo | |
| 6 | from nose.tools import with_setup | |
| 7 | from smb import smb_structs | |
| 8 | ||
| 9 | try: | |
| 10 | import hashlib | |
| 11 | def MD5(): return hashlib.md5() | |
| 12 | except ImportError: | |
| 13 | import md5 | |
| 14 | def MD5(): return md5.new() | |
| 15 | ||
| 16 | conn = None | |
| 17 | ||
| 18 | def setup_func_SMB2(): | |
| 19 | global conn | |
| 20 | smb_structs.SUPPORT_SMB2 = True | |
| 21 | info = getConnectionInfo() | |
| 22 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 23 | assert conn.connect(info['server_ip'], info['server_port']) | |
| 24 | ||
| 25 | def teardown_func(): | |
| 26 | global conn | |
| 27 | conn.close() | |
| 28 | ||
| 29 | @with_setup(setup_func_SMB2, teardown_func) | |
| 30 | def test_security_SMB2(): | |
| 31 | global conn | |
| 32 | # TODO: Need a way to setup the environment on the remote server and perform some verification on the returned results. | |
| 33 | attributes = conn.getSecurity('smbtest', '/rfc1001.txt') |
| 0 | # -*- coding: utf-8 -*- | |
| 1 | ||
| 2 | from smb.SMBConnection import SMBConnection | |
| 3 | from .util import getConnectionInfo | |
| 4 | ||
| 5 | def test_context(): | |
| 6 | info = getConnectionInfo() | |
| 7 | with SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) as conn: | |
| 8 | assert conn.connect(info['server_ip'], info['server_port']) | |
| 9 | ||
| 10 | assert conn.sock is None |
| 2 | 2 | name = SERVER |
| 3 | 3 | ip = 192.168.1.1 |
| 4 | 4 | port = 139 |
| 5 | direct_port = 445 | |
| 5 | 6 | |
| 6 | 7 | [client] |
| 7 | 8 | name = TESTCLIENT |
| 0 | import binascii | |
| 1 | ||
| 2 | from smb import security_descriptors as sd | |
| 3 | from smb import smb_constants as sc | |
| 4 | ||
| 5 | ||
| 6 | def test_sid_string_representation(): | |
| 7 | sid = sd.SID(1, 5, [2, 3, 4]) | |
| 8 | assert str(sid) == "S-1-5-2-3-4" | |
| 9 | sid = sd.SID(1, 2**32 + 3, []) | |
| 10 | assert str(sid) == "S-1-0x100000003" | |
| 11 | sid = sd.SID(1, 2**32, [3, 2, 1]) | |
| 12 | assert str(sid) == "S-1-0x100000000-3-2-1" | |
| 13 | ||
| 14 | ||
| 15 | def test_sid_binary_parsing(): | |
| 16 | raw_sid = binascii.unhexlify(""" | |
| 17 | 01 05 00 00 00 00 00 05 15 00 00 00 de 53 c1 2a | |
| 18 | 2a 4f da ca c1 79 a6 32 b1 04 00 00 | |
| 19 | """.translate(None, ' \n')) | |
| 20 | assert str(sd.SID.from_bytes(raw_sid)) == "S-1-5-21-717312990-3403304746-849770945-1201" | |
| 21 | raw_sid += "garbage" | |
| 22 | assert str(sd.SID.from_bytes(raw_sid)) == "S-1-5-21-717312990-3403304746-849770945-1201" | |
| 23 | sid, tail = sd.SID.from_bytes(raw_sid, return_tail=True) | |
| 24 | assert str(sid) == "S-1-5-21-717312990-3403304746-849770945-1201" | |
| 25 | assert tail == "garbage" | |
| 26 | ||
| 27 | ||
| 28 | def test_ace_binary_parsing(): | |
| 29 | raw_ace = binascii.unhexlify(""" | |
| 30 | 00 10 24 00 ff 01 1f 00 01 05 00 00 00 00 00 05 | |
| 31 | 15 00 00 00 de 53 c1 2a 2a 4f da ca c1 79 a6 32 | |
| 32 | 6e 04 00 00 | |
| 33 | """.translate(None, ' \n')) | |
| 34 | ace = sd.ACE.from_bytes(raw_ace) | |
| 35 | assert str(ace.sid) == "S-1-5-21-717312990-3403304746-849770945-1134" | |
| 36 | assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED | |
| 37 | assert ace.flags == sd.ACE_FLAG_INHERITED | |
| 38 | assert ace.mask == (sc.SYNCHRONIZE | sc.WRITE_OWNER | sc.WRITE_DAC | |
| 39 | | sc.READ_CONTROL | sc.DELETE | sc.FILE_READ_DATA | |
| 40 | | sc.FILE_WRITE_DATA | sc.FILE_APPEND_DATA | |
| 41 | | sc.FILE_READ_EA | sc.FILE_WRITE_EA | sc.FILE_EXECUTE | |
| 42 | | sc.FILE_DELETE_CHILD | sc.FILE_READ_ATTRIBUTES | |
| 43 | | sc.FILE_WRITE_ATTRIBUTES) | |
| 44 | assert not ace.additional_data | |
| 45 | ||
| 46 | raw_ace = binascii.unhexlify(""" | |
| 47 | 00 13 18 00 a9 00 12 00 01 02 00 00 00 00 00 05 | |
| 48 | 20 00 00 00 21 02 00 00 | |
| 49 | """.translate(None, ' \n')) | |
| 50 | ace = sd.ACE.from_bytes(raw_ace) | |
| 51 | assert str(ace.sid) == "S-1-5-32-545" | |
| 52 | assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED | |
| 53 | assert ace.flags == (sd.ACE_FLAG_INHERITED | sd.ACE_FLAG_CONTAINER_INHERIT | |
| 54 | | sd.ACE_FLAG_OBJECT_INHERIT) | |
| 55 | assert ace.mask == (sc.SYNCHRONIZE | sc.READ_CONTROL | sc.FILE_READ_DATA | |
| 56 | | sc.FILE_READ_EA | sc.FILE_EXECUTE | |
| 57 | | sc.FILE_READ_ATTRIBUTES) | |
| 58 | assert not ace.additional_data | |
| 59 | ||
| 60 | raw_ace = binascii.unhexlify(""" | |
| 61 | 01 03 24 00 a9 00 02 00 01 05 00 00 00 00 00 05 | |
| 62 | 15 00 00 00 de 53 c1 2a 2a 4f da ca c1 79 a6 32 | |
| 63 | 6c 04 00 00 | |
| 64 | """.translate(None, ' \n')) | |
| 65 | ace = sd.ACE.from_bytes(raw_ace) | |
| 66 | assert str(ace.sid) == "S-1-5-21-717312990-3403304746-849770945-1132" | |
| 67 | assert ace.type == sd.ACE_TYPE_ACCESS_DENIED | |
| 68 | assert ace.flags == (sd.ACE_FLAG_CONTAINER_INHERIT | |
| 69 | | sd.ACE_FLAG_OBJECT_INHERIT) | |
| 70 | assert ace.mask == (sc.READ_CONTROL | sc.FILE_READ_DATA | sc.FILE_READ_EA | |
| 71 | | sc.FILE_EXECUTE | sc.FILE_READ_ATTRIBUTES) | |
| 72 | assert not ace.additional_data | |
| 73 | ||
| 74 | ||
| 75 | def test_acl_binary_parsing(): | |
| 76 | raw_acl = binascii.unhexlify(""" | |
| 77 | 02 00 70 00 04 00 00 00 00 10 18 00 89 00 10 00 | |
| 78 | 01 02 00 00 00 00 00 05 20 00 00 00 21 02 00 00 | |
| 79 | 00 10 14 00 ff 01 1f 00 01 01 00 00 00 00 00 05 | |
| 80 | 12 00 00 00 00 10 18 00 ff 01 1f 00 01 02 00 00 | |
| 81 | 00 00 00 05 20 00 00 00 20 02 00 00 00 10 24 00 | |
| 82 | ff 01 1f 00 01 05 00 00 00 00 00 05 15 00 00 00 | |
| 83 | de 53 c1 2a 2a 4f da ca c1 79 a6 32 b1 04 00 00 | |
| 84 | """.translate(None, ' \n')) | |
| 85 | acl = sd.ACL.from_bytes(raw_acl) | |
| 86 | assert acl.revision == 2 | |
| 87 | assert len(acl.aces) == 4 | |
| 88 | ||
| 89 | ace = acl.aces[0] | |
| 90 | assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED | |
| 91 | assert str(ace.sid) == "S-1-5-32-545" | |
| 92 | assert ace.flags == sd.ACE_FLAG_INHERITED | |
| 93 | assert ace.mask == (sc.SYNCHRONIZE | sc.FILE_READ_DATA | sc.FILE_READ_EA | |
| 94 | | sc.FILE_READ_ATTRIBUTES) | |
| 95 | ||
| 96 | ace = acl.aces[3] | |
| 97 | assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED | |
| 98 | assert str(ace.sid) == "S-1-5-21-717312990-3403304746-849770945-1201" | |
| 99 | assert ace.flags == sd.ACE_FLAG_INHERITED | |
| 100 | assert ace.mask == (sc.SYNCHRONIZE | sc.WRITE_OWNER | sc.WRITE_DAC | |
| 101 | | sc.READ_CONTROL | sc.DELETE | sc.FILE_READ_DATA | |
| 102 | | sc.FILE_WRITE_DATA | sc.FILE_APPEND_DATA | |
| 103 | | sc.FILE_READ_EA | sc.FILE_WRITE_EA | sc.FILE_EXECUTE | |
| 104 | | sc.FILE_DELETE_CHILD | sc.FILE_READ_ATTRIBUTES | |
| 105 | | sc.FILE_WRITE_ATTRIBUTES) | |
| 106 | ||
| 107 | ||
| 108 | def test_descriptor_binary_parsing(): | |
| 109 | raw_descriptor = binascii.unhexlify(""" | |
| 110 | 01 00 04 84 14 00 00 00 30 00 00 00 00 00 00 00 | |
| 111 | 4c 00 00 00 01 05 00 00 00 00 00 05 15 00 00 00 | |
| 112 | de 53 c1 2a 2a 4f da ca c1 79 a6 32 b1 04 00 00 | |
| 113 | 01 05 00 00 00 00 00 05 15 00 00 00 de 53 c1 2a | |
| 114 | 2a 4f da ca c1 79 a6 32 01 02 00 00 02 00 70 00 | |
| 115 | 04 00 00 00 00 10 18 00 89 00 10 00 01 02 00 00 | |
| 116 | 00 00 00 05 20 00 00 00 21 02 00 00 00 10 14 00 | |
| 117 | ff 01 1f 00 01 01 00 00 00 00 00 05 12 00 00 00 | |
| 118 | 00 10 18 00 ff 01 1f 00 01 02 00 00 00 00 00 05 | |
| 119 | 20 00 00 00 20 02 00 00 00 10 24 00 ff 01 1f 00 | |
| 120 | 01 05 00 00 00 00 00 05 15 00 00 00 de 53 c1 2a | |
| 121 | 2a 4f da ca c1 79 a6 32 b1 04 00 00 | |
| 122 | """.translate(None, ' \n')) | |
| 123 | descriptor = sd.SecurityDescriptor.from_bytes(raw_descriptor) | |
| 124 | assert descriptor.flags == (sd.SECURITY_DESCRIPTOR_SELF_RELATIVE | |
| 125 | | sd.SECURITY_DESCRIPTOR_DACL_PRESENT | |
| 126 | | sd.SECURITY_DESCRIPTOR_DACL_AUTO_INHERITED) | |
| 127 | assert descriptor.dacl is not None | |
| 128 | assert descriptor.sacl is None | |
| 129 | assert str(descriptor.owner) == "S-1-5-21-717312990-3403304746-849770945-1201" | |
| 130 | assert str(descriptor.group) == "S-1-5-21-717312990-3403304746-849770945-513" | |
| 131 | ||
| 132 | acl = descriptor.dacl | |
| 133 | assert acl.revision == 2 | |
| 134 | assert len(acl.aces) == 4 | |
| 135 | assert str(acl.aces[0].sid) == sd.SID_BUILTIN_USERS | |
| 136 | assert str(acl.aces[1].sid) == sd.SID_LOCAL_SYSTEM | |
| 137 | assert str(acl.aces[2].sid) == sd.SID_BUILTIN_ADMINISTRATORS | |
| 138 | assert str(acl.aces[3].sid) == "S-1-5-21-717312990-3403304746-849770945-1201" |
| 76 | 76 | self.onNMBSessionOK() |
| 77 | 77 | elif packet.type == NEGATIVE_SESSION_RESPONSE: |
| 78 | 78 | self.onNMBSessionFailed() |
| 79 | elif packet.type == SESSION_KEEPALIVE: | |
| 80 | # Discard keepalive packets - [RFC1002]: 5.2.2.1 | |
| 81 | pass | |
| 79 | 82 | else: |
| 80 | 83 | self.log.warning('Unrecognized NMB session type: 0x%02x', packet.type) |
| 81 | 84 | |
| 152 | 155 | opcode = (code >> 11) & 0x0F |
| 153 | 156 | flags = (code >> 4) & 0x7F |
| 154 | 157 | rcode = code & 0x0F |
| 155 | numnames = data[self.HEADER_STRUCT_SIZE + 44] | |
| 156 | 158 | |
| 157 | if numnames > 0: | |
| 158 | ret = [ ] | |
| 159 | offset = self.HEADER_STRUCT_SIZE + 45 | |
| 159 | try: | |
| 160 | numnames = data[self.HEADER_STRUCT_SIZE + 44] | |
| 160 | 161 | |
| 161 | for i in range(0, numnames): | |
| 162 | mynme = data[offset:offset + 15] | |
| 163 | mynme = mynme.strip() | |
| 164 | ret.append(( str(mynme, 'ascii'), data[offset+15] )) | |
| 165 | offset += 18 | |
| 162 | if numnames > 0: | |
| 163 | ret = [ ] | |
| 164 | offset = self.HEADER_STRUCT_SIZE + 45 | |
| 166 | 165 | |
| 167 | return trn_id, ret | |
| 168 | else: | |
| 169 | return trn_id, None | |
| 166 | for i in range(0, numnames): | |
| 167 | mynme = data[offset:offset + 15] | |
| 168 | mynme = mynme.strip() | |
| 169 | ret.append(( str(mynme, 'ascii'), data[offset+15] )) | |
| 170 | offset += 18 | |
| 171 | ||
| 172 | return trn_id, ret | |
| 173 | except IndexError: | |
| 174 | pass | |
| 175 | ||
| 176 | return trn_id, None | |
| 170 | 177 | |
| 171 | 178 | # |
| 172 | 179 | # Contributed by Jason Anderson |
| 0 | Metadata-Version: 1.1 | |
| 1 | Name: pysmb | |
| 2 | Version: 1.2.7 | |
| 3 | Summary: pysmb is an experimental SMB/CIFS library written in Python to support file sharing between Windows and Linux machines | |
| 4 | Home-page: https://miketeo.net/projects/pysmb | |
| 5 | Author: Michael Teo | |
| 6 | Author-email: [email protected] | |
| 7 | License: zlib/libpng | |
| 8 | 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. | |
| 9 | Keywords: windows samba cifs sharing ftp smb linux | |
| 10 | Platform: UNKNOWN | |
| 11 | Classifier: Development Status :: 5 - Production/Stable | |
| 12 | Classifier: Environment :: Win32 (MS Windows) | |
| 13 | Classifier: Environment :: Console | |
| 14 | Classifier: License :: OSI Approved :: zlib/libpng License | |
| 15 | Classifier: Operating System :: Microsoft :: Windows | |
| 16 | Classifier: Operating System :: POSIX | |
| 17 | Classifier: Programming Language :: Python | |
| 18 | Classifier: Programming Language :: Python :: 2.4 | |
| 19 | Classifier: Programming Language :: Python :: 2.5 | |
| 20 | Classifier: Programming Language :: Python :: 2.6 | |
| 21 | Classifier: Programming Language :: Python :: 2.7 | |
| 22 | Classifier: Programming Language :: Python :: 3 | |
| 23 | Classifier: Topic :: Communications :: File Sharing | |
| 24 | Classifier: Topic :: Software Development :: Libraries :: Python Modules | |
| 25 | Classifier: Topic :: System :: Networking |
| 0 | CHANGELOG | |
| 1 | LICENSE | |
| 2 | MANIFEST.in | |
| 3 | README.txt | |
| 4 | setup.py | |
| 5 | docs/doctrees/environment.pickle | |
| 6 | docs/doctrees/extending.doctree | |
| 7 | docs/doctrees/index.doctree | |
| 8 | docs/doctrees/upgrading.doctree | |
| 9 | docs/doctrees/api/nmb_NBNSProtocol.doctree | |
| 10 | docs/doctrees/api/nmb_NetBIOS.doctree | |
| 11 | docs/doctrees/api/smb_SMBConnection.doctree | |
| 12 | docs/doctrees/api/smb_SMBHandler.doctree | |
| 13 | docs/doctrees/api/smb_SMBProtocolFactory.doctree | |
| 14 | docs/doctrees/api/smb_SharedDevice.doctree | |
| 15 | docs/doctrees/api/smb_SharedFile.doctree | |
| 16 | docs/doctrees/api/smb_exceptions.doctree | |
| 17 | docs/doctrees/api/smb_security_descriptors.doctree | |
| 18 | docs/html/.buildinfo | |
| 19 | docs/html/extending.html | |
| 20 | docs/html/genindex.html | |
| 21 | docs/html/index.html | |
| 22 | docs/html/objects.inv | |
| 23 | docs/html/py-modindex.html | |
| 24 | docs/html/search.html | |
| 25 | docs/html/searchindex.js | |
| 26 | docs/html/upgrading.html | |
| 27 | docs/html/_modules/index.html | |
| 28 | docs/html/_modules/nmb/NetBIOS.html | |
| 29 | docs/html/_modules/nmb/NetBIOSProtocol.html | |
| 30 | docs/html/_modules/smb/SMBConnection.html | |
| 31 | docs/html/_modules/smb/SMBProtocol.html | |
| 32 | docs/html/_modules/smb/base.html | |
| 33 | docs/html/_modules/smb/security_descriptors.html | |
| 34 | docs/html/_modules/smb/smb_structs.html | |
| 35 | docs/html/_sources/extending.rst.txt | |
| 36 | docs/html/_sources/extending.txt | |
| 37 | docs/html/_sources/index.rst.txt | |
| 38 | docs/html/_sources/index.txt | |
| 39 | docs/html/_sources/upgrading.rst.txt | |
| 40 | docs/html/_sources/upgrading.txt | |
| 41 | docs/html/_sources/api/nmb_NBNSProtocol.rst.txt | |
| 42 | docs/html/_sources/api/nmb_NBNSProtocol.txt | |
| 43 | docs/html/_sources/api/nmb_NetBIOS.rst.txt | |
| 44 | docs/html/_sources/api/nmb_NetBIOS.txt | |
| 45 | docs/html/_sources/api/smb_SMBConnection.rst.txt | |
| 46 | docs/html/_sources/api/smb_SMBConnection.txt | |
| 47 | docs/html/_sources/api/smb_SMBHandler.rst.txt | |
| 48 | docs/html/_sources/api/smb_SMBHandler.txt | |
| 49 | docs/html/_sources/api/smb_SMBProtocolFactory.rst.txt | |
| 50 | docs/html/_sources/api/smb_SMBProtocolFactory.txt | |
| 51 | docs/html/_sources/api/smb_SharedDevice.rst.txt | |
| 52 | docs/html/_sources/api/smb_SharedDevice.txt | |
| 53 | docs/html/_sources/api/smb_SharedFile.rst.txt | |
| 54 | docs/html/_sources/api/smb_SharedFile.txt | |
| 55 | docs/html/_sources/api/smb_exceptions.rst.txt | |
| 56 | docs/html/_sources/api/smb_exceptions.txt | |
| 57 | docs/html/_sources/api/smb_security_descriptors.rst.txt | |
| 58 | docs/html/_sources/api/smb_security_descriptors.txt | |
| 59 | docs/html/_static/ajax-loader.gif | |
| 60 | docs/html/_static/basic.css | |
| 61 | docs/html/_static/comment-bright.png | |
| 62 | docs/html/_static/comment-close.png | |
| 63 | docs/html/_static/comment.png | |
| 64 | docs/html/_static/contents.png | |
| 65 | docs/html/_static/doctools.js | |
| 66 | docs/html/_static/documentation_options.js | |
| 67 | docs/html/_static/down-pressed.png | |
| 68 | docs/html/_static/down.png | |
| 69 | docs/html/_static/file.png | |
| 70 | docs/html/_static/jquery-3.5.1.js | |
| 71 | docs/html/_static/jquery.js | |
| 72 | docs/html/_static/language_data.js | |
| 73 | docs/html/_static/minus.png | |
| 74 | docs/html/_static/navigation.png | |
| 75 | docs/html/_static/plus.png | |
| 76 | docs/html/_static/pygments.css | |
| 77 | docs/html/_static/searchtools.js | |
| 78 | docs/html/_static/sphinxdoc.css | |
| 79 | docs/html/_static/underscore-1.3.1.js | |
| 80 | docs/html/_static/underscore.js | |
| 81 | docs/html/_static/up-pressed.png | |
| 82 | docs/html/_static/up.png | |
| 83 | docs/html/_static/websupport.js | |
| 84 | docs/html/api/nmb_NBNSProtocol.html | |
| 85 | docs/html/api/nmb_NetBIOS.html | |
| 86 | docs/html/api/smb_SMBConnection.html | |
| 87 | docs/html/api/smb_SMBHandler.html | |
| 88 | docs/html/api/smb_SMBProtocolFactory.html | |
| 89 | docs/html/api/smb_SharedDevice.html | |
| 90 | docs/html/api/smb_SharedFile.html | |
| 91 | docs/html/api/smb_exceptions.html | |
| 92 | docs/html/api/smb_security_descriptors.html | |
| 93 | python2/nmb/NetBIOS.py | |
| 94 | python2/nmb/NetBIOSProtocol.py | |
| 95 | python2/nmb/__init__.py | |
| 96 | python2/nmb/base.py | |
| 97 | python2/nmb/nmb_constants.py | |
| 98 | python2/nmb/nmb_structs.py | |
| 99 | python2/nmb/utils.py | |
| 100 | python2/smb/SMBConnection.py | |
| 101 | python2/smb/SMBHandler.py | |
| 102 | python2/smb/SMBProtocol.py | |
| 103 | python2/smb/__init__.py | |
| 104 | python2/smb/base.py | |
| 105 | python2/smb/ntlm.py | |
| 106 | python2/smb/security_descriptors.py | |
| 107 | python2/smb/securityblob.py | |
| 108 | python2/smb/smb2_constants.py | |
| 109 | python2/smb/smb2_structs.py | |
| 110 | python2/smb/smb_constants.py | |
| 111 | python2/smb/smb_structs.py | |
| 112 | python2/smb/utils/README.txt | |
| 113 | python2/smb/utils/U32.py | |
| 114 | python2/smb/utils/__init__.py | |
| 115 | python2/smb/utils/md4.py | |
| 116 | python2/smb/utils/pyDes.py | |
| 117 | python2/smb/utils/rc4.py | |
| 118 | python2/smb/utils/sha256.py | |
| 119 | python2/tests/README.md | |
| 120 | python2/tests/__init__.py | |
| 121 | python2/tests/connection.ini | |
| 122 | python2/tests/test_ntlm.py | |
| 123 | python2/tests/test_security_descriptors.py | |
| 124 | python2/tests/test_securityblob.py | |
| 125 | python2/tests/DirectSMBConnectionTests/__init__.py | |
| 126 | python2/tests/DirectSMBConnectionTests/test_SMBHandler.py | |
| 127 | python2/tests/DirectSMBConnectionTests/test_auth.py | |
| 128 | python2/tests/DirectSMBConnectionTests/test_createdeletedirectory.py | |
| 129 | python2/tests/DirectSMBConnectionTests/test_echo.py | |
| 130 | python2/tests/DirectSMBConnectionTests/test_listpath.py | |
| 131 | python2/tests/DirectSMBConnectionTests/test_listshares.py | |
| 132 | python2/tests/DirectSMBConnectionTests/test_listsnapshots.py | |
| 133 | python2/tests/DirectSMBConnectionTests/test_rename.py | |
| 134 | python2/tests/DirectSMBConnectionTests/test_retrievefile.py | |
| 135 | python2/tests/DirectSMBConnectionTests/test_storefile.py | |
| 136 | python2/tests/DirectSMBConnectionTests/util.py | |
| 137 | python2/tests/DirectSMBTwistedTests/test_auth.py | |
| 138 | python2/tests/DirectSMBTwistedTests/test_createdeletedirectory.py | |
| 139 | python2/tests/DirectSMBTwistedTests/test_echo.py | |
| 140 | python2/tests/DirectSMBTwistedTests/test_listpath.py | |
| 141 | python2/tests/DirectSMBTwistedTests/test_listshares.py | |
| 142 | python2/tests/DirectSMBTwistedTests/test_listsnapshots.py | |
| 143 | python2/tests/DirectSMBTwistedTests/test_rename.py | |
| 144 | python2/tests/DirectSMBTwistedTests/test_retrievefile.py | |
| 145 | python2/tests/DirectSMBTwistedTests/test_storefile.py | |
| 146 | python2/tests/DirectSMBTwistedTests/util.py | |
| 147 | python2/tests/NetBIOSTests/__init__.py | |
| 148 | python2/tests/NetBIOSTests/test_queryname.py | |
| 149 | python2/tests/NetBIOSTwistedTests/__init__.py | |
| 150 | python2/tests/NetBIOSTwistedTests/test_queryname.py | |
| 151 | python2/tests/SMBConnectionTests/__init__.py | |
| 152 | python2/tests/SMBConnectionTests/test_SMBHandler.py | |
| 153 | python2/tests/SMBConnectionTests/test_auth.py | |
| 154 | python2/tests/SMBConnectionTests/test_createdeletedirectory.py | |
| 155 | python2/tests/SMBConnectionTests/test_deletepattern.py | |
| 156 | python2/tests/SMBConnectionTests/test_echo.py | |
| 157 | python2/tests/SMBConnectionTests/test_getattributes.py | |
| 158 | python2/tests/SMBConnectionTests/test_listpath.py | |
| 159 | python2/tests/SMBConnectionTests/test_listshares.py | |
| 160 | python2/tests/SMBConnectionTests/test_listsnapshots.py | |
| 161 | python2/tests/SMBConnectionTests/test_rename.py | |
| 162 | python2/tests/SMBConnectionTests/test_retrievefile.py | |
| 163 | python2/tests/SMBConnectionTests/test_security.py | |
| 164 | python2/tests/SMBConnectionTests/test_storefile.py | |
| 165 | python2/tests/SMBConnectionTests/test_with_context.py | |
| 166 | python2/tests/SMBConnectionTests/util.py | |
| 167 | python2/tests/SMBTwistedTests/__init__.py | |
| 168 | python2/tests/SMBTwistedTests/test_auth.py | |
| 169 | python2/tests/SMBTwistedTests/test_createdeletedirectory.py | |
| 170 | python2/tests/SMBTwistedTests/test_echo.py | |
| 171 | python2/tests/SMBTwistedTests/test_getattributes.py | |
| 172 | python2/tests/SMBTwistedTests/test_listpath.py | |
| 173 | python2/tests/SMBTwistedTests/test_listshares.py | |
| 174 | python2/tests/SMBTwistedTests/test_listsnapshots.py | |
| 175 | python2/tests/SMBTwistedTests/test_rename.py | |
| 176 | python2/tests/SMBTwistedTests/test_retrievefile.py | |
| 177 | python2/tests/SMBTwistedTests/test_storefile.py | |
| 178 | python2/tests/SMBTwistedTests/util.py | |
| 179 | python2/tests/SupportFiles/binary.dat | |
| 180 | python3/nmb/NetBIOS.py | |
| 181 | python3/nmb/NetBIOSProtocol.py | |
| 182 | python3/nmb/__init__.py | |
| 183 | python3/nmb/base.py | |
| 184 | python3/nmb/nmb_constants.py | |
| 185 | python3/nmb/nmb_structs.py | |
| 186 | python3/nmb/utils.py | |
| 187 | python3/pysmb.egg-info/PKG-INFO | |
| 188 | python3/pysmb.egg-info/SOURCES.txt | |
| 189 | python3/pysmb.egg-info/dependency_links.txt | |
| 190 | python3/pysmb.egg-info/requires.txt | |
| 191 | python3/pysmb.egg-info/top_level.txt | |
| 192 | python3/smb/SMBConnection.py | |
| 193 | python3/smb/SMBHandler.py | |
| 194 | python3/smb/SMBProtocol.py | |
| 195 | python3/smb/__init__.py | |
| 196 | python3/smb/base.py | |
| 197 | python3/smb/ntlm.py | |
| 198 | python3/smb/security_descriptors.py | |
| 199 | python3/smb/securityblob.py | |
| 200 | python3/smb/smb2_constants.py | |
| 201 | python3/smb/smb2_structs.py | |
| 202 | python3/smb/smb_constants.py | |
| 203 | python3/smb/smb_structs.py | |
| 204 | python3/smb/utils/U32.py | |
| 205 | python3/smb/utils/__init__.py | |
| 206 | python3/smb/utils/md4.py | |
| 207 | python3/smb/utils/pyDes.py | |
| 208 | python3/smb/utils/rc4.py | |
| 209 | python3/smb/utils/sha256.py | |
| 210 | python3/tests/README.md | |
| 211 | python3/tests/__init__.py | |
| 212 | python3/tests/connection.ini | |
| 213 | python3/tests/test_ntlm.py | |
| 214 | python3/tests/test_security_descriptors.py | |
| 215 | python3/tests/test_securityblob.py | |
| 216 | python3/tests/DirectSMBConnectionTests/__init__.py | |
| 217 | python3/tests/DirectSMBConnectionTests/test_auth.py | |
| 218 | python3/tests/DirectSMBConnectionTests/test_createdeletedirectory.py | |
| 219 | python3/tests/DirectSMBConnectionTests/test_echo.py | |
| 220 | python3/tests/DirectSMBConnectionTests/test_listpath.py | |
| 221 | python3/tests/DirectSMBConnectionTests/test_listshares.py | |
| 222 | python3/tests/DirectSMBConnectionTests/test_listsnapshots.py | |
| 223 | python3/tests/DirectSMBConnectionTests/test_rename.py | |
| 224 | python3/tests/DirectSMBConnectionTests/test_retrievefile.py | |
| 225 | python3/tests/DirectSMBConnectionTests/test_storefile.py | |
| 226 | python3/tests/DirectSMBConnectionTests/util.py | |
| 227 | python3/tests/NetBIOSTests/__init__.py | |
| 228 | python3/tests/NetBIOSTests/test_queryname.py | |
| 229 | python3/tests/SMBConnectionTests/__init__.py | |
| 230 | python3/tests/SMBConnectionTests/test_SMBHandler.py | |
| 231 | python3/tests/SMBConnectionTests/test_auth.py | |
| 232 | python3/tests/SMBConnectionTests/test_createdeletedirectory.py | |
| 233 | python3/tests/SMBConnectionTests/test_deletepattern.py | |
| 234 | python3/tests/SMBConnectionTests/test_echo.py | |
| 235 | python3/tests/SMBConnectionTests/test_getattributes.py | |
| 236 | python3/tests/SMBConnectionTests/test_listpath.py | |
| 237 | python3/tests/SMBConnectionTests/test_listshares.py | |
| 238 | python3/tests/SMBConnectionTests/test_listsnapshots.py | |
| 239 | python3/tests/SMBConnectionTests/test_rename.py | |
| 240 | python3/tests/SMBConnectionTests/test_retrievefile.py | |
| 241 | python3/tests/SMBConnectionTests/test_storefile.py | |
| 242 | python3/tests/SMBConnectionTests/test_with_context.py | |
| 243 | python3/tests/SMBConnectionTests/util.py | |
| 244 | python3/tests/SupportFiles/binary.dat | |
| 245 | sphinx/Makefile | |
| 246 | sphinx/make.bat | |
| 247 | sphinx/requirements.txt | |
| 248 | sphinx/source/conf.py | |
| 249 | sphinx/source/extending.rst | |
| 250 | sphinx/source/index.rst | |
| 251 | sphinx/source/upgrading.rst | |
| 252 | sphinx/source/api/nmb_NBNSProtocol.rst | |
| 253 | sphinx/source/api/nmb_NetBIOS.rst | |
| 254 | sphinx/source/api/smb_SMBConnection.rst | |
| 255 | sphinx/source/api/smb_SMBHandler.rst | |
| 256 | sphinx/source/api/smb_SMBProtocolFactory.rst | |
| 257 | sphinx/source/api/smb_SharedDevice.rst | |
| 258 | sphinx/source/api/smb_SharedFile.rst | |
| 259 | sphinx/source/api/smb_exceptions.rst | |
| 260 | sphinx/source/api/smb_security_descriptors.rst⏎ |
| 0 | pyasn1 |
| 20 | 20 | Create a new SMBConnection instance. |
| 21 | 21 | |
| 22 | 22 | *username* and *password* are the user credentials required to authenticate the underlying SMB connection with the remote server. |
| 23 | *password* can be a string or a callable returning a string. | |
| 23 | 24 | File operations can only be proceeded after the connection has been authenticated successfully. |
| 24 | 25 | |
| 25 | 26 | Note that you need to call *connect* method to actually establish the SMB connection to the remote server and perform authentication. |
| 28 | 29 | Some newer server installations might also support Direct hosting of SMB over TCP/IP; for these servers, the default TCP port is 445. |
| 29 | 30 | |
| 30 | 31 | :param string my_name: The local NetBIOS machine name that will identify where this connection is originating from. |
| 31 | 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 ``\/:*?";|+`` | |
| 32 | 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 ``\\/:*?";|+`` | |
| 32 | 33 | :param string remote_name: The NetBIOS machine name of the remote server. |
| 33 | 34 | On windows, you can find out the machine name by right-clicking on the "My Computer" and selecting "Properties". |
| 34 | 35 | This parameter must be the same as what has been configured on the remote server, or else the connection will be rejected. |
| 71 | 72 | total_sent = total_sent + sent |
| 72 | 73 | |
| 73 | 74 | # |
| 75 | # Support for "with" context | |
| 76 | # | |
| 77 | def __enter__(self): | |
| 78 | return self | |
| 79 | ||
| 80 | def __exit__(self, *args): | |
| 81 | self.close() | |
| 82 | ||
| 83 | # | |
| 74 | 84 | # Misc Properties |
| 75 | 85 | # |
| 76 | 86 | |
| 84 | 94 | # Public Methods |
| 85 | 95 | # |
| 86 | 96 | |
| 87 | def connect(self, ip, port = 139, sock_family = socket.AF_INET, timeout = 60): | |
| 97 | def connect(self, ip, port = 139, sock_family = None, timeout = 60): | |
| 88 | 98 | """ |
| 89 | 99 | Establish the SMB connection to the remote SMB/CIFS server. |
| 90 | 100 | |
| 91 | 101 | You must call this method before attempting any of the file operations with the remote server. |
| 92 | 102 | This method will block until the SMB connection has attempted at least one authentication. |
| 93 | 103 | |
| 104 | :param port: Defaults to 139. If you are using direct TCP mode (is_direct_tcp=true when creating this SMBConnection instance), use 445. | |
| 105 | :param sock_family: In Python 3.x, use *None* as we can infer the socket family from the provided *ip*. In Python 2.x, it must be either *socket.AF_INET* or *socket.AF_INET6*. | |
| 94 | 106 | :return: A boolean value indicating the result of the authentication atttempt: True if authentication is successful; False, if otherwise. |
| 95 | 107 | """ |
| 96 | 108 | if self.sock: |
| 97 | 109 | self.sock.close() |
| 98 | 110 | |
| 99 | 111 | self.auth_result = None |
| 100 | self.sock = socket.socket(sock_family) | |
| 101 | self.sock.settimeout(timeout) | |
| 102 | self.sock.connect(( ip, port )) | |
| 112 | if sock_family: | |
| 113 | self.sock = socket.socket(sock_family) | |
| 114 | self.sock.settimeout(timeout) | |
| 115 | self.sock.connect(( ip, port )) | |
| 116 | else: | |
| 117 | self.sock = socket.create_connection(( ip, port )) | |
| 103 | 118 | |
| 104 | 119 | self.is_busy = True |
| 105 | 120 | try: |
| 152 | 167 | return results |
| 153 | 168 | |
| 154 | 169 | def listPath(self, service_name, path, |
| 155 | search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE, | |
| 170 | search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL, | |
| 156 | 171 | pattern = '*', timeout = 30): |
| 157 | 172 | """ |
| 158 | 173 | Retrieve a directory listing of files/folders at *path* |
| 174 | ||
| 175 | For simplicity, pysmb defines a "normal" file as a file entry that is not read-only, not hidden, not system, not archive and not a directory. | |
| 176 | It ignores other attributes like compression, indexed, sparse, temporary and encryption. | |
| 177 | ||
| 178 | Note that the default search parameter will query for all read-only (SMB_FILE_ATTRIBUTE_READONLY), hidden (SMB_FILE_ATTRIBUTE_HIDDEN), | |
| 179 | system (SMB_FILE_ATTRIBUTE_SYSTEM), archive (SMB_FILE_ATTRIBUTE_ARCHIVE), normal (SMB_FILE_ATTRIBUTE_INCL_NORMAL) files | |
| 180 | and directories (SMB_FILE_ATTRIBUTE_DIRECTORY). | |
| 181 | If you do not need to include "normal" files in the result, define your own search parameter without the SMB_FILE_ATTRIBUTE_INCL_NORMAL constant. | |
| 182 | SMB_FILE_ATTRIBUTE_NORMAL should be used by itself and not be used with other bit constants. | |
| 159 | 183 | |
| 160 | 184 | :param string/unicode service_name: the name of the shared folder for the *path* |
| 161 | 185 | :param string/unicode path: path relative to the *service_name* where we are interested to learn about its files/sub-folders. |
| 162 | 186 | :param integer search: integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py). |
| 163 | The default *search* value will query for all read-only, hidden, system, archive files and directories. | |
| 164 | 187 | :param string/unicode pattern: the filter to apply to the results before returning to the client. |
| 165 | 188 | :return: A list of :doc:`smb.base.SharedFile<smb_SharedFile>` instances. |
| 166 | 189 | """ |
| 244 | 267 | self.is_busy = True |
| 245 | 268 | try: |
| 246 | 269 | self._getAttributes(service_name, path, cb, eb, timeout) |
| 270 | while self.is_busy: | |
| 271 | self._pollForNetBIOSPacket(timeout) | |
| 272 | finally: | |
| 273 | self.is_busy = False | |
| 274 | ||
| 275 | return results[0] | |
| 276 | ||
| 277 | def getSecurity(self, service_name, path, timeout = 30): | |
| 278 | """ | |
| 279 | Retrieve the security descriptor of the file at *path* on the *service_name*. | |
| 280 | ||
| 281 | :param string/unicode service_name: the name of the shared folder for the *path* | |
| 282 | :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. | |
| 283 | :return: A :class:`smb.security_descriptors.SecurityDescriptor` instance containing the security information of the file. | |
| 284 | """ | |
| 285 | if not self.sock: | |
| 286 | raise NotConnectedError('Not connected to server') | |
| 287 | ||
| 288 | results = [ ] | |
| 289 | ||
| 290 | def cb(info): | |
| 291 | self.is_busy = False | |
| 292 | results.append(info) | |
| 293 | ||
| 294 | def eb(failure): | |
| 295 | self.is_busy = False | |
| 296 | raise failure | |
| 297 | ||
| 298 | self.is_busy = True | |
| 299 | try: | |
| 300 | self._getSecurity(service_name, path, cb, eb, timeout) | |
| 247 | 301 | while self.is_busy: |
| 248 | 302 | self._pollForNetBIOSPacket(timeout) |
| 249 | 303 | finally: |
| 349 | 403 | |
| 350 | 404 | return results[0] |
| 351 | 405 | |
| 352 | def deleteFiles(self, service_name, path_file_pattern, timeout = 30): | |
| 406 | def deleteFiles(self, service_name, path_file_pattern, delete_matching_folders = False, timeout = 30): | |
| 353 | 407 | """ |
| 354 | 408 | 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. |
| 409 | ||
| 410 | If delete_matching_folders is True, immediate sub-folders that match the path_file_pattern will be deleted recursively. | |
| 355 | 411 | |
| 356 | 412 | :param string/unicode service_name: Contains the name of the shared folder. |
| 357 | 413 | :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name. |
| 371 | 427 | |
| 372 | 428 | self.is_busy = True |
| 373 | 429 | try: |
| 374 | self._deleteFiles(service_name, path_file_pattern, cb, eb, timeout = timeout) | |
| 375 | while self.is_busy: | |
| 376 | self._pollForNetBIOSPacket(timeout) | |
| 377 | finally: | |
| 378 | self.is_busy = False | |
| 379 | ||
| 380 | def resetFileAttributes(self, service_name, path_file_pattern, timeout = 30): | |
| 430 | self._deleteFiles(service_name, path_file_pattern, delete_matching_folders, cb, eb, timeout = timeout) | |
| 431 | while self.is_busy: | |
| 432 | self._pollForNetBIOSPacket(timeout) | |
| 433 | finally: | |
| 434 | self.is_busy = False | |
| 435 | ||
| 436 | def resetFileAttributes(self, service_name, path_file_pattern, file_attributes = ATTR_NORMAL, timeout = 30): | |
| 381 | 437 | """ |
| 382 | 438 | Reset file attributes of one or more regular files or folders. |
| 383 | 439 | It supports the use of wildcards in file names, allowing for unlocking of multiple files/folders in a single request. |
| 384 | 440 | This function is very helpful when deleting files/folders that are read-only. |
| 385 | 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) | |
| 386 | ||
| 441 | By default, it sets the ATTR_NORMAL flag, therefore clearing all other flags. | |
| 442 | (See https://msdn.microsoft.com/en-us/library/cc232110.aspx for further information) | |
| 443 | ||
| 444 | Note: this function is currently only implemented for SMB2! | |
| 445 | ||
| 387 | 446 | :param string/unicode service_name: Contains the name of the shared folder. |
| 388 | 447 | :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name. |
| 389 | 448 | Wildcards may be used in the filename component of the path. |
| 390 | 449 | If your path/filename contains non-English characters, you must pass in an unicode string. |
| 450 | :param int file_attributes: The desired file attributes to set. Defaults to `ATTR_NORMAL`. | |
| 391 | 451 | :return: None |
| 392 | 452 | """ |
| 393 | 453 | if not self.sock: |
| 402 | 462 | |
| 403 | 463 | self.is_busy = True |
| 404 | 464 | try: |
| 405 | self._resetFileAttributes(service_name, path_file_pattern, cb, eb, timeout = timeout) | |
| 406 | while self.is_busy: | |
| 407 | self._pollForNetBIOSPacket(timeout) | |
| 408 | finally: | |
| 409 | self.is_busy = False | |
| 410 | ||
| 465 | self._resetFileAttributes(service_name, path_file_pattern, cb, eb, file_attributes, timeout) | |
| 466 | while self.is_busy: | |
| 467 | self._pollForNetBIOSPacket(timeout) | |
| 468 | finally: | |
| 469 | self.is_busy = False | |
| 411 | 470 | |
| 412 | 471 | def createDirectory(self, service_name, path, timeout = 30): |
| 413 | 472 | """ |
| 495 | 554 | """ |
| 496 | 555 | Send an echo command containing *data* to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same *data*. |
| 497 | 556 | |
| 498 | :param string data: Data to send to the remote server. | |
| 557 | :param bytes data: Data to send to the remote server. Must be a bytes object. | |
| 499 | 558 | :return: The *data* parameter |
| 500 | 559 | """ |
| 501 | 560 | if not self.sock: |
| 0 | ||
| 1 | 0 | import os, sys, socket, urllib.request, urllib.error, urllib.parse, mimetypes, email, tempfile |
| 2 | 1 | from urllib.parse import (unwrap, unquote, splittype, splithost, quote, |
| 3 | 2 | splitport, splittag, splitattr, splituser, splitpasswd, splitvalue) |
| 25 | 24 | port = int(port) |
| 26 | 25 | |
| 27 | 26 | # username/password handling |
| 27 | ||
| 28 | 28 | user, host = splituser(host) |
| 29 | ||
| 29 | 30 | if user: |
| 30 | 31 | user, passwd = splitpasswd(user) |
| 31 | 32 | else: |
| 32 | 33 | passwd = None |
| 34 | ||
| 33 | 35 | host = unquote(host) |
| 34 | 36 | user = user or '' |
| 35 | 37 | |
| 40 | 42 | passwd = passwd or '' |
| 41 | 43 | myname = MACHINE_NAME or self.generateClientMachineName() |
| 42 | 44 | |
| 43 | n = NetBIOS() | |
| 44 | names = n.queryIPForName(host) | |
| 45 | if names: | |
| 46 | server_name = names[0] | |
| 47 | else: | |
| 48 | raise urllib.error.URLError('SMB error: Hostname does not reply back with its machine name') | |
| 45 | server_name,host = host.split(',') if ',' in host else [None,host] | |
| 46 | ||
| 47 | if server_name is None: | |
| 48 | n = NetBIOS() | |
| 49 | ||
| 50 | names = n.queryIPForName(host) | |
| 51 | if names: | |
| 52 | server_name = names[0] | |
| 53 | else: | |
| 54 | raise urllib.error.URLError('SMB error: Hostname does not reply back with its machine name') | |
| 49 | 55 | |
| 50 | 56 | path, attrs = splitattr(req.selector) |
| 51 | 57 | if path.startswith('/'): |
| 177 | 177 | return d |
| 178 | 178 | |
| 179 | 179 | def listPath(self, service_name, path, |
| 180 | search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE, | |
| 180 | search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL, | |
| 181 | 181 | pattern = '*', timeout = 30): |
| 182 | 182 | """ |
| 183 | 183 | Retrieve a directory listing of files/folders at *path* |
| 184 | ||
| 185 | For simplicity, pysmb defines a "normal" file as a file entry that is not read-only, not hidden, not system, not archive and not a directory. | |
| 186 | It ignores other attributes like compression, indexed, sparse, temporary and encryption. | |
| 187 | ||
| 188 | Note that the default search parameter will query for all read-only (SMB_FILE_ATTRIBUTE_READONLY), hidden (SMB_FILE_ATTRIBUTE_HIDDEN), | |
| 189 | system (SMB_FILE_ATTRIBUTE_SYSTEM), archive (SMB_FILE_ATTRIBUTE_ARCHIVE), normal (SMB_FILE_ATTRIBUTE_INCL_NORMAL) files | |
| 190 | and directories (SMB_FILE_ATTRIBUTE_DIRECTORY). | |
| 191 | If you do not need to include "normal" files in the result, define your own search parameter without the SMB_FILE_ATTRIBUTE_INCL_NORMAL constant. | |
| 192 | SMB_FILE_ATTRIBUTE_NORMAL should be used by itself and not be used with other bit constants. | |
| 184 | 193 | |
| 185 | 194 | :param string/unicode service_name: the name of the shared folder for the *path* |
| 186 | 195 | :param string/unicode path: path relative to the *service_name* where we are interested to learn about its files/sub-folders. |
| 187 | 196 | :param integer search: integer value made up from a bitwise-OR of *SMB_FILE_ATTRIBUTE_xxx* bits (see smb_constants.py). |
| 188 | The default *search* value will query for all read-only, hidden, system, archive files and directories. | |
| 189 | 197 | :param string/unicode pattern: the filter to apply to the results before returning to the client. |
| 190 | 198 | :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method. |
| 191 | 199 | :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with a list of :doc:`smb.base.SharedFile<smb_SharedFile>` instances. |
| 294 | 302 | self.instance._storeFile(service_name, path, file_obj, d.callback, d.errback, timeout = timeout) |
| 295 | 303 | return d |
| 296 | 304 | |
| 297 | def deleteFiles(self, service_name, path_file_pattern, timeout = 30): | |
| 305 | def deleteFiles(self, service_name, path_file_pattern, delete_matching_folders = False, timeout = 30): | |
| 298 | 306 | """ |
| 299 | 307 | 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. |
| 300 | 308 | |
| 309 | If delete_matching_folders is True, immediate sub-folders that match the path_file_pattern will be deleted recursively. | |
| 310 | ||
| 301 | 311 | :param string/unicode service_name: Contains the name of the shared folder. |
| 302 | 312 | :param string/unicode path_file_pattern: The pathname of the file(s) to be deleted, relative to the service_name. |
| 303 | 313 | Wildcards may be used in th filename component of the path. |
| 309 | 319 | raise NotConnectedError('Not connected to server') |
| 310 | 320 | |
| 311 | 321 | d = defer.Deferred() |
| 312 | self.instance._deleteFiles(service_name, path_file_pattern, d.callback, d.errback, timeout = timeout) | |
| 322 | self.instance._deleteFiles(service_name, path_file_pattern, delete_matching_folders, d.callback, d.errback, timeout = timeout) | |
| 313 | 323 | return d |
| 314 | 324 | |
| 315 | 325 | def createDirectory(self, service_name, path): |
| 368 | 378 | """ |
| 369 | 379 | Send an echo command containing *data* to the remote SMB/CIFS server. The remote SMB/CIFS will reply with the same *data*. |
| 370 | 380 | |
| 371 | :param string data: Data to send to the remote server. | |
| 381 | :param bytes data: Data to send to the remote server. Must be a bytes object. | |
| 372 | 382 | :param integer/float timeout: Number of seconds that pysmb will wait before raising *SMBTimeout* via the returned *Deferred* instance's *errback* method. |
| 373 | 383 | :return: A *twisted.internet.defer.Deferred* instance. The callback function will be called with the *data* parameter. |
| 374 | 384 | """ |
| 4 | 4 | from .smb2_constants import * |
| 5 | 5 | from .smb_structs import * |
| 6 | 6 | from .smb2_structs import * |
| 7 | from .security_descriptors import SecurityDescriptor | |
| 7 | 8 | from nmb.base import NMBSession |
| 8 | 9 | from .utils import convertFILETIMEtoEpoch |
| 9 | 10 | from . import ntlm, securityblob |
| 52 | 53 | def __init__(self, username, password, my_name, remote_name, domain = '', use_ntlm_v2 = True, sign_options = SIGN_WHEN_REQUIRED, is_direct_tcp = False): |
| 53 | 54 | NMBSession.__init__(self, my_name, remote_name, is_direct_tcp = is_direct_tcp) |
| 54 | 55 | self.username = username |
| 55 | self.password = password | |
| 56 | self._password = password | |
| 56 | 57 | self.domain = domain |
| 57 | 58 | self.sign_options = sign_options |
| 58 | 59 | self.is_direct_tcp = is_direct_tcp |
| 59 | 60 | self.use_ntlm_v2 = use_ntlm_v2 #: Similar to LMAuthenticationPolicy and NTAuthenticationPolicy as described in [MS-CIFS] 3.2.1.1 |
| 60 | 61 | self.smb_message = SMBMessage() |
| 61 | 62 | self.is_using_smb2 = False #: Are we communicating using SMB2 protocol? self.smb_message will be a SMB2Message instance if this flag is True |
| 63 | self.async_requests = { } #: AsyncID mapped to _PendingRequest instance | |
| 62 | 64 | self.pending_requests = { } #: MID mapped to _PendingRequest instance |
| 63 | 65 | self.connected_trees = { } #: Share name mapped to TID |
| 64 | 66 | 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 |
| 97 | 99 | (self.use_ntlm_v2 and 'v2') or 'v1', |
| 98 | 100 | (SUPPORT_EXTENDED_SECURITY and 'with') or 'without') |
| 99 | 101 | |
| 102 | @property | |
| 103 | def password(self): | |
| 104 | if callable(self._password): | |
| 105 | return self._password() | |
| 106 | return self._password | |
| 100 | 107 | |
| 101 | 108 | # |
| 102 | 109 | # NMBSession Methods |
| 166 | 173 | self._listShares = self._listShares_SMB1 |
| 167 | 174 | self._listPath = self._listPath_SMB1 |
| 168 | 175 | self._listSnapshots = self._listSnapshots_SMB1 |
| 176 | self._getSecurity = self._getSecurity_SMB1 | |
| 169 | 177 | self._getAttributes = self._getAttributes_SMB1 |
| 170 | 178 | self._retrieveFile = self._retrieveFile_SMB1 |
| 171 | 179 | self._retrieveFileFromOffset = self._retrieveFileFromOffset_SMB1 |
| 188 | 196 | self._listShares = self._listShares_SMB2 |
| 189 | 197 | self._listPath = self._listPath_SMB2 |
| 190 | 198 | self._listSnapshots = self._listSnapshots_SMB2 |
| 199 | self._getSecurity = self._getSecurity_SMB2 | |
| 191 | 200 | self._getAttributes = self._getAttributes_SMB2 |
| 192 | 201 | self._retrieveFile = self._retrieveFile_SMB2 |
| 193 | 202 | self._retrieveFileFromOffset = self._retrieveFileFromOffset_SMB2 |
| 212 | 221 | if smb_message.mid == 0: |
| 213 | 222 | smb_message.mid = self._getNextMID_SMB2() |
| 214 | 223 | |
| 215 | if smb_message.command != SMB2_COM_NEGOTIATE and smb_message.command != SMB2_COM_ECHO: | |
| 224 | if smb_message.command != SMB2_COM_NEGOTIATE: | |
| 216 | 225 | smb_message.session_id = self.session_id |
| 217 | 226 | |
| 218 | 227 | if self.is_signing_active: |
| 249 | 258 | if result == securityblob.RESULT_ACCEPT_COMPLETED: |
| 250 | 259 | self.has_authenticated = True |
| 251 | 260 | self.log.info('Authentication (on SMB2) successful!') |
| 261 | ||
| 262 | # [MS-SMB2]: 3.2.5.3.1 | |
| 263 | # If the security subsystem indicates that the session was established by an anonymous user, | |
| 264 | # Session.SigningRequired MUST be set to FALSE. | |
| 265 | # If the SMB2_SESSION_FLAG_IS_GUEST bit is set in the SessionFlags field of the | |
| 266 | # SMB2 SESSION_SETUP Response and if Session.SigningRequired is TRUE, this indicates a SESSION_SETUP | |
| 267 | # failure and the connection MUST be terminated. If the SMB2_SESSION_FLAG_IS_GUEST bit is set in the SessionFlags | |
| 268 | # field of the SMB2 SESSION_SETUP Response and if RequireMessageSigning is FALSE, Session.SigningRequired | |
| 269 | # MUST be set to FALSE. | |
| 270 | if message.payload.isGuestSession or message.payload.isAnonymousSession: | |
| 271 | self.is_signing_active = False | |
| 272 | self.log.info('Signing disabled because session is guest/anonymous') | |
| 273 | ||
| 252 | 274 | self.onAuthOK() |
| 253 | 275 | else: |
| 254 | 276 | raise ProtocolError('SMB2_COM_SESSION_SETUP status is 0 but security blob negResult value is %d' % result, message.raw_data, message) |
| 262 | 284 | self._handleSessionChallenge(message, ntlm_token) |
| 263 | 285 | except ( securityblob.BadSecurityBlobError, securityblob.UnsupportedSecurityProvider ) as ex: |
| 264 | 286 | raise ProtocolError(str(ex), message.raw_data, message) |
| 265 | elif message.status == 0xc000006d: # STATUS_LOGON_FAILURE | |
| 287 | elif (message.status == 0xc000006d # STATUS_LOGON_FAILURE | |
| 288 | or message.status == 0xc0000064 # STATUS_NO_SUCH_USER | |
| 289 | or message.status == 0xc000006a):# STATUS_WRONG_PASSWORD | |
| 266 | 290 | self.has_authenticated = False |
| 267 | 291 | self.log.info('Authentication (on SMB2) failed. Please check username and password.') |
| 268 | 292 | self.onAuthFailed() |
| 293 | elif (message.status == 0xc0000193 # STATUS_ACCOUNT_EXPIRED | |
| 294 | or message.status == 0xC0000071): # STATUS_PASSWORD_EXPIRED | |
| 295 | self.has_authenticated = False | |
| 296 | self.log.info('Authentication (on SMB2) failed. Account or password has expired.') | |
| 297 | self.onAuthFailed() | |
| 298 | elif message.status == 0xc0000234: # STATUS_ACCOUNT_LOCKED_OUT | |
| 299 | self.has_authenticated = False | |
| 300 | self.log.info('Authentication (on SMB2) failed. Account has been locked due to too many invalid logon attempts.') | |
| 301 | self.onAuthFailed() | |
| 302 | elif message.status == 0xc0000072: # STATUS_ACCOUNT_DISABLED | |
| 303 | self.has_authenticated = False | |
| 304 | self.log.info('Authentication (on SMB2) failed. Account has been disabled.') | |
| 305 | self.onAuthFailed() | |
| 306 | elif (message.status == 0xc000006f # STATUS_INVALID_LOGON_HOURS | |
| 307 | or message.status == 0xc000015b # STATUS_LOGON_TYPE_NOT_GRANTED | |
| 308 | or message.status == 0xc0000070): # STATUS_INVALID_WORKSTATION | |
| 309 | self.has_authenticated = False | |
| 310 | self.log.info('Authentication (on SMB2) failed. Not allowed.') | |
| 311 | self.onAuthFailed() | |
| 312 | elif message.status == 0xc000018c: # STATUS_TRUSTED_DOMAIN_FAILURE | |
| 313 | self.has_authenticated = False | |
| 314 | self.log.info('Authentication (on SMB2) failed. Domain not trusted.') | |
| 315 | self.onAuthFailed() | |
| 316 | elif message.status == 0xc000018d: # STATUS_TRUSTED_RELATIONSHIP_FAILURE | |
| 317 | self.has_authenticated = False | |
| 318 | self.log.info('Authentication (on SMB2) failed. Workstation not trusted.') | |
| 319 | self.onAuthFailed() | |
| 269 | 320 | else: |
| 270 | 321 | raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_SESSION_SETUP_ANDX (with extended security)' % message.status, |
| 271 | 322 | message.raw_data, message) |
| 272 | 323 | |
| 273 | req = self.pending_requests.pop(message.mid, None) | |
| 274 | if req: | |
| 275 | req.callback(message, **req.kwargs) | |
| 276 | return True | |
| 324 | if message.isAsync: | |
| 325 | if message.status == 0x00000103: # STATUS_PENDING | |
| 326 | req = self.pending_requests.pop(message.mid, None) | |
| 327 | if req: | |
| 328 | self.async_requests[message.async_id] = req | |
| 329 | else: # All other status including SUCCESS | |
| 330 | req = self.async_requests.pop(message.async_id, None) | |
| 331 | if req: | |
| 332 | req.callback(message, **req.kwargs) | |
| 333 | return True | |
| 334 | else: | |
| 335 | req = self.pending_requests.pop(message.mid, None) | |
| 336 | if req: | |
| 337 | req.callback(message, **req.kwargs) | |
| 338 | return True | |
| 277 | 339 | |
| 278 | 340 | |
| 279 | 341 | def _updateServerInfo_SMB2(self, payload): |
| 308 | 370 | self.log.info('Performing NTLMv1 authentication (on SMB2) with server challenge "%s"', binascii.hexlify(server_challenge)) |
| 309 | 371 | nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(self.password, server_challenge, True) |
| 310 | 372 | |
| 311 | ntlm_data = ntlm.generateAuthenticateMessage(server_flags, | |
| 312 | nt_challenge_response, | |
| 313 | lm_challenge_response, | |
| 314 | session_key, | |
| 315 | self.username, | |
| 316 | self.domain) | |
| 373 | ntlm_data, session_signing_key = ntlm.generateAuthenticateMessage(server_flags, | |
| 374 | nt_challenge_response, | |
| 375 | lm_challenge_response, | |
| 376 | session_key, | |
| 377 | self.username, | |
| 378 | self.domain, | |
| 379 | self.my_name) | |
| 317 | 380 | |
| 318 | 381 | if self.log.isEnabledFor(logging.DEBUG): |
| 319 | 382 | self.log.debug('NT challenge response is "%s" (%d bytes)', binascii.hexlify(nt_challenge_response), len(nt_challenge_response)) |
| 333 | 396 | |
| 334 | 397 | if self.is_signing_active: |
| 335 | 398 | self.log.info("SMB signing activated. All SMB messages will be signed.") |
| 336 | self.signing_session_key = (session_key + b'\0'*16)[:16] | |
| 399 | self.signing_session_key = session_signing_key | |
| 400 | if self.log.isEnabledFor(logging.DEBUG): | |
| 401 | self.log.info("SMB signing key is %s", binascii.hexlify(self.signing_session_key)) | |
| 402 | ||
| 337 | 403 | if self.capabilities & CAP_EXTENDED_SECURITY: |
| 338 | 404 | self.signing_challenge_response = None |
| 339 | 405 | else: |
| 362 | 428 | |
| 363 | 429 | m.tid = tid |
| 364 | 430 | self._sendSMBMessage(m) |
| 365 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectSrvSvcCB, errback) | |
| 431 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectSrvSvcCB, errback, tid = tid) | |
| 366 | 432 | messages_history.append(m) |
| 367 | 433 | |
| 368 | 434 | def connectSrvSvcCB(create_message, **kwargs): |
| 384 | 450 | 01 00 00 00 |
| 385 | 451 | """.replace(b' ', b'').replace(b'\n', b'')) |
| 386 | 452 | m = SMB2Message(SMB2WriteRequest(create_message.payload.fid, data_bytes, 0)) |
| 387 | m.tid = create_message.tid | |
| 453 | m.tid = kwargs['tid'] | |
| 388 | 454 | self._sendSMBMessage(m) |
| 389 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, rpcBindCB, errback, fid = create_message.payload.fid) | |
| 455 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, rpcBindCB, errback, tid = kwargs['tid'], fid = create_message.payload.fid) | |
| 390 | 456 | messages_history.append(m) |
| 391 | 457 | else: |
| 392 | 458 | errback(OperationFailure('Failed to list shares: Unable to locate Server Service RPC endpoint', messages_history)) |
| 395 | 461 | messages_history.append(trans_message) |
| 396 | 462 | if trans_message.status == 0: |
| 397 | 463 | m = SMB2Message(SMB2ReadRequest(kwargs['fid'], read_len = 1024, read_offset = 0)) |
| 398 | m.tid = trans_message.tid | |
| 464 | m.tid = kwargs['tid'] | |
| 399 | 465 | self._sendSMBMessage(m) |
| 400 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, rpcReadCB, errback, fid = kwargs['fid']) | |
| 466 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, rpcReadCB, errback, tid = kwargs['tid'], fid = kwargs['fid']) | |
| 401 | 467 | messages_history.append(m) |
| 402 | 468 | else: |
| 403 | closeFid(trans_message.tid, kwargs['fid'], error = 'Failed to list shares: Unable to read from Server Service RPC endpoint') | |
| 469 | closeFid(kwargs['tid'], kwargs['fid'], error = 'Failed to list shares: Unable to read from Server Service RPC endpoint') | |
| 404 | 470 | |
| 405 | 471 | def rpcReadCB(read_message, **kwargs): |
| 406 | 472 | messages_history.append(read_message) |
| 428 | 494 | 00 00 00 00 ff ff ff ff 08 00 02 00 00 00 00 00 |
| 429 | 495 | """.replace(b' ', b'').replace(b'\n', b'')) |
| 430 | 496 | m = SMB2Message(SMB2IoctlRequest(kwargs['fid'], 0x0011C017, flags = 0x01, max_out_size = 8196, in_data = data_bytes)) |
| 431 | m.tid = read_message.tid | |
| 497 | m.tid = kwargs['tid'] | |
| 432 | 498 | self._sendSMBMessage(m) |
| 433 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, listShareResultsCB, errback, fid = kwargs['fid']) | |
| 499 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, listShareResultsCB, errback, tid = kwargs['tid'], fid = kwargs['fid']) | |
| 434 | 500 | messages_history.append(m) |
| 435 | 501 | else: |
| 436 | closeFid(read_message.tid, kwargs['fid'], error = 'Failed to list shares: Unable to bind to Server Service RPC endpoint') | |
| 502 | closeFid(kwargs['tid'], kwargs['fid'], error = 'Failed to list shares: Unable to bind to Server Service RPC endpoint') | |
| 437 | 503 | |
| 438 | 504 | def listShareResultsCB(result_message, **kwargs): |
| 439 | 505 | messages_history.append(result_message) |
| 442 | 508 | data_bytes = result_message.payload.out_data |
| 443 | 509 | |
| 444 | 510 | if data_bytes[3] & 0x02 == 0: |
| 445 | sendReadRequest(result_message.tid, kwargs['fid'], data_bytes) | |
| 446 | else: | |
| 447 | decodeResults(result_message.tid, kwargs['fid'], data_bytes) | |
| 448 | elif result_message.status == 0x0103: # STATUS_PENDING | |
| 449 | self.pending_requests[result_message.mid] = _PendingRequest(result_message.mid, expiry_time, listShareResultsCB, errback, fid = kwargs['fid']) | |
| 450 | else: | |
| 451 | closeFid(result_message.tid, kwargs['fid']) | |
| 511 | sendReadRequest(kwargs['tid'], kwargs['fid'], data_bytes) | |
| 512 | else: | |
| 513 | decodeResults(kwargs['tid'], kwargs['fid'], data_bytes) | |
| 514 | else: | |
| 515 | closeFid(kwargs['tid'], kwargs['fid']) | |
| 452 | 516 | errback(OperationFailure('Failed to list shares: Unable to retrieve shared device list', messages_history)) |
| 453 | 517 | |
| 454 | 518 | def decodeResults(tid, fid, data_bytes): |
| 487 | 551 | m.tid = tid |
| 488 | 552 | self._sendSMBMessage(m) |
| 489 | 553 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback, |
| 490 | fid = fid, data_bytes = data_bytes) | |
| 554 | tid = tid, fid = fid, data_bytes = data_bytes) | |
| 491 | 555 | |
| 492 | 556 | def readCB(read_message, **kwargs): |
| 493 | 557 | messages_history.append(read_message) |
| 494 | 558 | if read_message.status == 0: |
| 495 | data_len = read_message.payload.data_length | |
| 496 | 559 | data_bytes = read_message.payload.data |
| 497 | 560 | |
| 498 | 561 | if data_bytes[3] & 0x02 == 0: |
| 499 | sendReadRequest(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:data_len-24]) | |
| 500 | else: | |
| 501 | decodeResults(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:data_len-24]) | |
| 502 | else: | |
| 503 | closeFid(read_message.tid, kwargs['fid']) | |
| 562 | sendReadRequest(kwargs['tid'], kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:]) | |
| 563 | else: | |
| 564 | decodeResults(kwargs['tid'], kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:]) | |
| 565 | else: | |
| 566 | closeFid(kwargs['tid'], kwargs['fid']) | |
| 504 | 567 | errback(OperationFailure('Failed to list shares: Unable to retrieve shared device list', messages_history)) |
| 505 | 568 | |
| 506 | 569 | def closeFid(tid, fid, results = None, error = None): |
| 565 | 628 | create_context_data = create_context_data)) |
| 566 | 629 | m.tid = tid |
| 567 | 630 | self._sendSMBMessage(m) |
| 568 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback) | |
| 631 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid) | |
| 569 | 632 | messages_history.append(m) |
| 570 | 633 | |
| 571 | 634 | def createCB(create_message, **kwargs): |
| 572 | 635 | messages_history.append(create_message) |
| 573 | 636 | if create_message.status == 0: |
| 574 | sendQuery(create_message.tid, create_message.payload.fid, b'') | |
| 637 | sendQuery(kwargs['tid'], create_message.payload.fid, b'') | |
| 638 | elif create_message.status == 0xC0000034: # [MS-ERREF]: STATUS_OBJECT_NAME_INVALID | |
| 639 | errback(OperationFailure('Failed to list %s on %s: Path not found' % ( path, service_name ), messages_history)) | |
| 575 | 640 | else: |
| 576 | 641 | errback(OperationFailure('Failed to list %s on %s: Unable to open directory' % ( path, service_name ), messages_history)) |
| 577 | 642 | |
| 578 | 643 | def sendQuery(tid, fid, data_buf): |
| 579 | 644 | m = SMB2Message(SMB2QueryDirectoryRequest(fid, pattern, |
| 580 | info_class = 0x03, # FileBothDirectoryInformation | |
| 645 | info_class = 0x25, # FileIdBothDirectoryInformation | |
| 581 | 646 | flags = 0, |
| 582 | 647 | output_buf_len = self.max_transact_size)) |
| 583 | 648 | m.tid = tid |
| 584 | 649 | self._sendSMBMessage(m) |
| 585 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, queryCB, errback, fid = fid, data_buf = data_buf) | |
| 650 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, queryCB, errback, tid = tid, fid = fid, data_buf = data_buf) | |
| 586 | 651 | messages_history.append(m) |
| 587 | 652 | |
| 588 | 653 | def queryCB(query_message, **kwargs): |
| 589 | 654 | messages_history.append(query_message) |
| 590 | 655 | if query_message.status == 0: |
| 591 | 656 | data_buf = decodeQueryStruct(kwargs['data_buf'] + query_message.payload.data) |
| 592 | sendQuery(query_message.tid, kwargs['fid'], data_buf) | |
| 657 | sendQuery(kwargs['tid'], kwargs['fid'], data_buf) | |
| 658 | elif query_message.status == 0xC000000F: # [MS-ERREF]: STATUS_NO_SUCH_FILE | |
| 659 | # If there are no matching files, we just treat as success instead of failing | |
| 660 | closeFid(kwargs['tid'], kwargs['fid'], results = results) | |
| 593 | 661 | elif query_message.status == 0x80000006: # STATUS_NO_MORE_FILES |
| 594 | closeFid(query_message.tid, kwargs['fid'], results = results) | |
| 595 | else: | |
| 596 | closeFid(query_message.tid, kwargs['fid'], error = query_message.status) | |
| 662 | closeFid(kwargs['tid'], kwargs['fid'], results = results) | |
| 663 | else: | |
| 664 | closeFid(kwargs['tid'], kwargs['fid'], error = query_message.status) | |
| 597 | 665 | |
| 598 | 666 | def decodeQueryStruct(data_bytes): |
| 599 | # SMB_FIND_FILE_BOTH_DIRECTORY_INFO structure. See [MS-CIFS]: 2.2.8.1.7 and [MS-SMB]: 2.2.8.1.1 | |
| 600 | info_format = '<IIQQQQQQIIIBB24s' | |
| 667 | # FileIdBothDirectoryInformation structure. See [MS-SMB]: 2.2.8.1.3 and [MS-FSCC]: 2.4.17 | |
| 668 | info_format = '<IIQQQQQQIIIBB24sHQ' | |
| 601 | 669 | info_size = struct.calcsize(info_format) |
| 602 | 670 | |
| 603 | 671 | data_length = len(data_bytes) |
| 609 | 677 | next_offset, _, \ |
| 610 | 678 | create_time, last_access_time, last_write_time, last_attr_change_time, \ |
| 611 | 679 | file_size, alloc_size, file_attributes, filename_length, ea_size, \ |
| 612 | short_name_length, _, short_name = struct.unpack(info_format, data_bytes[offset:offset+info_size]) | |
| 680 | short_name_length, _, short_name, _, file_id = struct.unpack(info_format, data_bytes[offset:offset+info_size]) | |
| 613 | 681 | |
| 614 | 682 | offset2 = offset + info_size |
| 615 | 683 | if offset2 + filename_length > data_length: |
| 616 | 684 | return data_bytes[offset:] |
| 617 | 685 | |
| 618 | 686 | filename = data_bytes[offset2:offset2+filename_length].decode('UTF-16LE') |
| 619 | short_name = short_name.decode('UTF-16LE') | |
| 620 | results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time), | |
| 621 | convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time), | |
| 622 | file_size, alloc_size, file_attributes, short_name, filename)) | |
| 687 | short_name = short_name[:short_name_length].decode('UTF-16LE') | |
| 688 | ||
| 689 | accept_result = False | |
| 690 | if (file_attributes & 0xff) in ( 0x00, ATTR_NORMAL ): # Only the first 8-bits are compared. We ignore other bits like temp, compressed, encryption, sparse, indexed, etc | |
| 691 | accept_result = (search == SMB_FILE_ATTRIBUTE_NORMAL) or (search & SMB_FILE_ATTRIBUTE_INCL_NORMAL) | |
| 692 | else: | |
| 693 | accept_result = (file_attributes & search) > 0 | |
| 694 | if accept_result: | |
| 695 | results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time), | |
| 696 | convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time), | |
| 697 | file_size, alloc_size, file_attributes, short_name, filename, file_id)) | |
| 623 | 698 | |
| 624 | 699 | if next_offset: |
| 625 | 700 | offset += next_offset |
| 638 | 713 | if kwargs['results'] is not None: |
| 639 | 714 | callback(kwargs['results']) |
| 640 | 715 | elif kwargs['error'] is not None: |
| 641 | errback(OperationFailure('Failed to list %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history)) | |
| 716 | if kwargs['error'] == 0xC000000F: # [MS-ERREF]: STATUS_NO_SUCH_FILE | |
| 717 | # Remote server returns STATUS_NO_SUCH_FILE error so we assume that the search returns no matching files | |
| 718 | callback([ ]) | |
| 719 | else: | |
| 720 | errback(OperationFailure('Failed to list %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history)) | |
| 642 | 721 | |
| 643 | 722 | if service_name not in self.connected_trees: |
| 644 | 723 | def connectCB(connect_message, **kwargs): |
| 688 | 767 | create_context_data = create_context_data)) |
| 689 | 768 | m.tid = tid |
| 690 | 769 | self._sendSMBMessage(m) |
| 691 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback) | |
| 770 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid) | |
| 692 | 771 | messages_history.append(m) |
| 693 | 772 | |
| 694 | 773 | def createCB(create_message, **kwargs): |
| 695 | 774 | messages_history.append(create_message) |
| 696 | 775 | if create_message.status == 0: |
| 697 | 776 | p = create_message.payload |
| 777 | filename = self._extractLastPathComponent(path) | |
| 698 | 778 | info = SharedFile(p.create_time, p.lastaccess_time, p.lastwrite_time, p.change_time, |
| 699 | 779 | p.file_size, p.allocation_size, p.file_attributes, |
| 700 | path, path) | |
| 701 | closeFid(create_message.tid, p.fid, info = info) | |
| 780 | filename, filename) | |
| 781 | closeFid(kwargs['tid'], p.fid, info = info) | |
| 702 | 782 | else: |
| 703 | 783 | errback(OperationFailure('Failed to get attributes for %s on %s: Unable to open remote file object' % ( path, service_name ), messages_history)) |
| 704 | 784 | |
| 723 | 803 | sendCreate(connect_message.tid) |
| 724 | 804 | else: |
| 725 | 805 | errback(OperationFailure('Failed to get attributes for %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) |
| 806 | ||
| 807 | m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ))) | |
| 808 | self._sendSMBMessage(m) | |
| 809 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name) | |
| 810 | messages_history.append(m) | |
| 811 | else: | |
| 812 | sendCreate(self.connected_trees[service_name]) | |
| 813 | ||
| 814 | def _getSecurity_SMB2(self, service_name, path, callback, errback, timeout = 30): | |
| 815 | if not self.has_authenticated: | |
| 816 | raise NotReadyError('SMB connection not authenticated') | |
| 817 | ||
| 818 | expiry_time = time.time() + timeout | |
| 819 | path = path.replace('/', '\\') | |
| 820 | if path.startswith('\\'): | |
| 821 | path = path[1:] | |
| 822 | if path.endswith('\\'): | |
| 823 | path = path[:-1] | |
| 824 | messages_history = [ ] | |
| 825 | results = [ ] | |
| 826 | ||
| 827 | def sendCreate(tid): | |
| 828 | m = SMB2Message(SMB2CreateRequest(path, | |
| 829 | file_attributes = 0, | |
| 830 | access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | READ_CONTROL | SYNCHRONIZE, | |
| 831 | share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE, | |
| 832 | oplock = SMB2_OPLOCK_LEVEL_NONE, | |
| 833 | impersonation = SEC_IMPERSONATE, | |
| 834 | create_options = 0, | |
| 835 | create_disp = FILE_OPEN)) | |
| 836 | m.tid = tid | |
| 837 | self._sendSMBMessage(m) | |
| 838 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, createCB, errback, tid = tid) | |
| 839 | messages_history.append(m) | |
| 840 | ||
| 841 | def createCB(create_message, **kwargs): | |
| 842 | messages_history.append(create_message) | |
| 843 | if create_message.status == 0: | |
| 844 | m = SMB2Message(SMB2QueryInfoRequest(create_message.payload.fid, | |
| 845 | flags = 0, | |
| 846 | additional_info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION | DACL_SECURITY_INFORMATION, | |
| 847 | info_type = SMB2_INFO_SECURITY, | |
| 848 | file_info_class = 0, # [MS-SMB2] 2.2.37, 3.2.4.12 | |
| 849 | input_buf = '', | |
| 850 | output_buf_len = self.max_transact_size)) | |
| 851 | m.tid = kwargs['tid'] | |
| 852 | self._sendSMBMessage(m) | |
| 853 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, queryCB, errback, tid = kwargs['tid'], fid = create_message.payload.fid) | |
| 854 | messages_history.append(m) | |
| 855 | else: | |
| 856 | errback(OperationFailure('Failed to get the security descriptor of %s on %s: Unable to open file or directory' % ( path, service_name ), messages_history)) | |
| 857 | ||
| 858 | def queryCB(query_message, **kwargs): | |
| 859 | messages_history.append(query_message) | |
| 860 | if query_message.status == 0: | |
| 861 | security = SecurityDescriptor.from_bytes(query_message.payload.data) | |
| 862 | closeFid(kwargs['tid'], kwargs['fid'], result = security) | |
| 863 | else: | |
| 864 | closeFid(kwargs['tid'], kwargs['fid'], error = query_message.status) | |
| 865 | ||
| 866 | def closeFid(tid, fid, result = None, error = None): | |
| 867 | m = SMB2Message(SMB2CloseRequest(fid)) | |
| 868 | m.tid = tid | |
| 869 | self._sendSMBMessage(m) | |
| 870 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, closeCB, errback, result = result, error = error) | |
| 871 | messages_history.append(m) | |
| 872 | ||
| 873 | def closeCB(close_message, **kwargs): | |
| 874 | if kwargs['result'] is not None: | |
| 875 | callback(kwargs['result']) | |
| 876 | elif kwargs['error'] is not None: | |
| 877 | errback(OperationFailure('Failed to get the security descriptor of %s on %s: Query failed with errorcode 0x%08x' % ( path, service_name, kwargs['error'] ), messages_history)) | |
| 878 | ||
| 879 | if service_name not in self.connected_trees: | |
| 880 | def connectCB(connect_message, **kwargs): | |
| 881 | messages_history.append(connect_message) | |
| 882 | if connect_message.status == 0: | |
| 883 | self.connected_trees[service_name] = connect_message.tid | |
| 884 | sendCreate(connect_message.tid) | |
| 885 | else: | |
| 886 | errback(OperationFailure('Failed to get the security descriptor of %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 726 | 887 | |
| 727 | 888 | m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ))) |
| 728 | 889 | self._sendSMBMessage(m) |
| 759 | 920 | m = SMB2Message(SMB2CreateRequest(path, |
| 760 | 921 | file_attributes = 0, |
| 761 | 922 | access_mask = FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES | READ_CONTROL | SYNCHRONIZE, |
| 762 | share_access = FILE_SHARE_READ, | |
| 923 | share_access = FILE_SHARE_READ | FILE_SHARE_WRITE, | |
| 763 | 924 | oplock = SMB2_OPLOCK_LEVEL_NONE, |
| 764 | 925 | impersonation = SEC_IMPERSONATE, |
| 765 | 926 | create_options = FILE_SEQUENTIAL_ONLY | FILE_NON_DIRECTORY_FILE, |
| 777 | 938 | flags = 0, |
| 778 | 939 | additional_info = 0, |
| 779 | 940 | info_type = SMB2_INFO_FILE, |
| 780 | file_info_class = 0x16, # FileStreamInformation [MS-FSCC] 2.4 | |
| 941 | file_info_class = 0x05, # FileStandardInformation [MS-FSCC] 2.4 | |
| 781 | 942 | input_buf = b'', |
| 782 | 943 | output_buf_len = 4096)) |
| 783 | m.tid = create_message.tid | |
| 944 | m.tid = kwargs['tid'] | |
| 784 | 945 | self._sendSMBMessage(m) |
| 785 | 946 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, infoCB, errback, |
| 786 | fid = create_message.payload.fid, file_attributes = create_message.payload.file_attributes) | |
| 947 | tid = kwargs['tid'], | |
| 948 | fid = create_message.payload.fid, | |
| 949 | file_attributes = create_message.payload.file_attributes) | |
| 787 | 950 | messages_history.append(m) |
| 788 | 951 | else: |
| 789 | errback(OperationFailure('Failed to list %s on %s: Unable to open file' % ( path, service_name ), messages_history)) | |
| 952 | errback(OperationFailure('Failed to retrieve %s on %s: Unable to open file' % ( path, service_name ), messages_history)) | |
| 790 | 953 | |
| 791 | 954 | def infoCB(info_message, **kwargs): |
| 792 | 955 | messages_history.append(info_message) |
| 801 | 964 | remaining_len = file_len |
| 802 | 965 | if starting_offset + remaining_len > file_len: |
| 803 | 966 | remaining_len = file_len - starting_offset |
| 804 | sendRead(info_message.tid, kwargs['fid'], starting_offset, remaining_len, 0, kwargs['file_attributes']) | |
| 805 | else: | |
| 806 | errback(OperationFailure('Failed to list %s on %s: Unable to retrieve information on file' % ( path, service_name ), messages_history)) | |
| 967 | sendRead(kwargs['tid'], kwargs['fid'], starting_offset, remaining_len, 0, kwargs['file_attributes']) | |
| 968 | else: | |
| 969 | errback(OperationFailure('Failed to retrieve %s on %s: Unable to retrieve information on file' % ( path, service_name ), messages_history)) | |
| 807 | 970 | |
| 808 | 971 | def sendRead(tid, fid, offset, remaining_len, read_len, file_attributes): |
| 809 | 972 | read_count = min(self.max_read_size, remaining_len) |
| 811 | 974 | m.tid = tid |
| 812 | 975 | self._sendSMBMessage(m) |
| 813 | 976 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, readCB, errback, |
| 814 | fid = fid, offset = offset, | |
| 977 | tid = tid, fid = fid, offset = offset, | |
| 815 | 978 | remaining_len = remaining_len, |
| 816 | 979 | read_len = read_len, |
| 817 | 980 | file_attributes = file_attributes) |
| 825 | 988 | remaining_len = kwargs['remaining_len'] - data_len |
| 826 | 989 | |
| 827 | 990 | if remaining_len > 0: |
| 828 | sendRead(read_message.tid, kwargs['fid'], kwargs['offset'] + data_len, remaining_len, kwargs['read_len'] + data_len, kwargs['file_attributes']) | |
| 829 | else: | |
| 830 | closeFid(read_message.tid, kwargs['fid'], ret = ( file_obj, kwargs['file_attributes'], kwargs['read_len'] + data_len )) | |
| 991 | sendRead(kwargs['tid'], kwargs['fid'], kwargs['offset'] + data_len, remaining_len, kwargs['read_len'] + data_len, kwargs['file_attributes']) | |
| 992 | else: | |
| 993 | closeFid(kwargs['tid'], kwargs['fid'], ret = ( file_obj, kwargs['file_attributes'], kwargs['read_len'] + data_len )) | |
| 831 | 994 | else: |
| 832 | 995 | messages_history.append(read_message) |
| 833 | closeFid(read_message.tid, kwargs['fid'], error = read_message.status) | |
| 996 | closeFid(kwargs['tid'], kwargs['fid'], error = read_message.status) | |
| 834 | 997 | |
| 835 | 998 | def closeFid(tid, fid, ret = None, error = None): |
| 836 | 999 | m = SMB2Message(SMB2CloseRequest(fid)) |
| 906 | 1069 | messages_history.append(create_message) |
| 907 | 1070 | if create_message.status == 0: |
| 908 | 1071 | sendWrite(create_message.tid, create_message.payload.fid, starting_offset) |
| 909 | elif create_message.status == 0x0103: # STATUS_PENDING | |
| 910 | self.pending_requests[create_message.mid] = _PendingRequest(create_message.mid, expiry_time, | |
| 911 | createCB, errback, | |
| 912 | tid=kwargs['tid']) | |
| 913 | 1072 | else: |
| 914 | 1073 | errback(OperationFailure('Failed to store %s on %s: Unable to open file' % ( path, service_name ), messages_history)) |
| 915 | 1074 | |
| 921 | 1080 | m = SMB2Message(SMB2WriteRequest(fid, data, offset)) |
| 922 | 1081 | m.tid = tid |
| 923 | 1082 | self._sendSMBMessage(m) |
| 924 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, writeCB, errback, fid = fid, offset = offset+data_len) | |
| 1083 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, writeCB, errback, tid = tid, fid = fid, offset = offset+data_len) | |
| 925 | 1084 | else: |
| 926 | 1085 | closeFid(tid, fid, offset = offset) |
| 927 | 1086 | |
| 928 | 1087 | def writeCB(write_message, **kwargs): |
| 929 | 1088 | # To avoid crazy memory usage when saving large files, we do not save every write_message in messages_history. |
| 930 | 1089 | if write_message.status == 0: |
| 931 | sendWrite(write_message.tid, kwargs['fid'], kwargs['offset']) | |
| 1090 | sendWrite(kwargs['tid'], kwargs['fid'], kwargs['offset']) | |
| 932 | 1091 | else: |
| 933 | 1092 | messages_history.append(write_message) |
| 934 | closeFid(write_message.tid, kwargs['fid']) | |
| 1093 | closeFid(kwargs['tid'], kwargs['fid']) | |
| 935 | 1094 | errback(OperationFailure('Failed to store %s on %s: Write failed' % ( path, service_name ), messages_history)) |
| 936 | 1095 | |
| 937 | 1096 | def closeFid(tid, fid, error = None, offset = None): |
| 964 | 1123 | sendCreate(self.connected_trees[service_name]) |
| 965 | 1124 | |
| 966 | 1125 | |
| 967 | def _deleteFiles_SMB2(self, service_name, path_file_pattern, callback, errback, timeout = 30): | |
| 1126 | def _deleteFiles_SMB2(self, service_name, path_file_pattern, delete_matching_folders, callback, errback, timeout = 30): | |
| 1127 | if not self.has_authenticated: | |
| 1128 | raise NotReadyError('SMB connection not authenticated') | |
| 1129 | ||
| 1130 | expiry_time = time.time() + timeout | |
| 1131 | pattern = None | |
| 1132 | path = path_file_pattern.replace('/', '\\') | |
| 1133 | if path.startswith('\\'): | |
| 1134 | path = path[1:] | |
| 1135 | if path.endswith('\\'): | |
| 1136 | path = path[:-1] | |
| 1137 | else: | |
| 1138 | path_components = path.split('\\') | |
| 1139 | if path_components[-1].find('*') > -1 or path_components[-1].find('?') > -1: | |
| 1140 | path = '\\'.join(path_components[:-1]) | |
| 1141 | pattern = path_components[-1] | |
| 1142 | messages_history, files_queue = [ ], [ ] | |
| 1143 | ||
| 1144 | if pattern is None: | |
| 1145 | path_components = path.split('\\') | |
| 1146 | if len(path_components) > 1: | |
| 1147 | files_queue.append(( '\\'.join(path_components[:-1]), path_components[-1] )) | |
| 1148 | else: | |
| 1149 | files_queue.append(( '', path )) | |
| 1150 | ||
| 1151 | def deleteCB(path): | |
| 1152 | if files_queue: | |
| 1153 | p, filename = files_queue.pop(0) | |
| 1154 | if filename: | |
| 1155 | if p: | |
| 1156 | filename = p + '\\' + filename | |
| 1157 | self._deleteFiles_SMB2__del(service_name, self.connected_trees[service_name], filename, deleteCB, errback, timeout) | |
| 1158 | else: | |
| 1159 | self._deleteDirectory_SMB2(service_name, p, deleteCB, errback, timeout) | |
| 1160 | else: | |
| 1161 | callback(path_file_pattern) | |
| 1162 | ||
| 1163 | def listCB(files_list): | |
| 1164 | files_queue.extend(files_list) | |
| 1165 | deleteCB(None) | |
| 1166 | ||
| 1167 | if service_name not in self.connected_trees: | |
| 1168 | def connectCB(connect_message, **kwargs): | |
| 1169 | messages_history.append(connect_message) | |
| 1170 | if connect_message.status == 0: | |
| 1171 | self.connected_trees[service_name] = connect_message.tid | |
| 1172 | if files_queue: | |
| 1173 | deleteCB(None) | |
| 1174 | else: | |
| 1175 | self._deleteFiles_SMB2__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout) | |
| 1176 | else: | |
| 1177 | errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 1178 | ||
| 1179 | m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ))) | |
| 1180 | self._sendSMBMessage(m) | |
| 1181 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name) | |
| 1182 | messages_history.append(m) | |
| 1183 | else: | |
| 1184 | if files_queue: | |
| 1185 | deleteCB(None) | |
| 1186 | else: | |
| 1187 | self._deleteFiles_SMB2__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout) | |
| 1188 | ||
| 1189 | def _deleteFiles_SMB2__list(self, service_name, path, pattern, delete_matching_folders, callback, errback, timeout = 30): | |
| 1190 | folder_queue = [ ] | |
| 1191 | files_list = [ ] | |
| 1192 | current_path = [ path ] | |
| 1193 | search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL | |
| 1194 | ||
| 1195 | def listCB(results): | |
| 1196 | files = [ ] | |
| 1197 | for f in filter(lambda x: x.filename not in [ '.', '..' ], results): | |
| 1198 | if f.isDirectory: | |
| 1199 | if delete_matching_folders: | |
| 1200 | folder_queue.append(current_path[0]+'\\'+f.filename) | |
| 1201 | else: | |
| 1202 | files.append(( current_path[0], f.filename )) | |
| 1203 | if current_path[0]!=path and delete_matching_folders: | |
| 1204 | files.append(( current_path[0], None )) | |
| 1205 | ||
| 1206 | if files: | |
| 1207 | files_list[0:0] = files | |
| 1208 | ||
| 1209 | if folder_queue: | |
| 1210 | p = folder_queue.pop() | |
| 1211 | current_path[0] = p | |
| 1212 | self._listPath_SMB2(service_name, current_path[0], listCB, errback, search = search, pattern = '*', timeout = 30) | |
| 1213 | else: | |
| 1214 | callback(files_list) | |
| 1215 | ||
| 1216 | self._listPath_SMB2(service_name, path, listCB, errback, search = search, pattern = pattern, timeout = timeout) | |
| 1217 | ||
| 1218 | def _deleteFiles_SMB2__del(self, service_name, tid, path, callback, errback, timeout = 30): | |
| 1219 | messages_history = [ ] | |
| 1220 | ||
| 1221 | def sendCreate(tid): | |
| 1222 | create_context_data = binascii.unhexlify(b""" | |
| 1223 | 28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00 | |
| 1224 | 44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00 | |
| 1225 | 00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00 | |
| 1226 | 00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00 | |
| 1227 | 00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00 | |
| 1228 | 51 46 69 64 00 00 00 00 | |
| 1229 | """.replace(b' ', b'').replace(b'\n', b'')) | |
| 1230 | m = SMB2Message(SMB2CreateRequest(path, | |
| 1231 | file_attributes = 0, | |
| 1232 | access_mask = DELETE | FILE_READ_ATTRIBUTES, | |
| 1233 | share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE, | |
| 1234 | oplock = SMB2_OPLOCK_LEVEL_NONE, | |
| 1235 | impersonation = SEC_IMPERSONATE, | |
| 1236 | create_options = FILE_NON_DIRECTORY_FILE, | |
| 1237 | create_disp = FILE_OPEN, | |
| 1238 | create_context_data = create_context_data)) | |
| 1239 | m.tid = tid | |
| 1240 | self._sendSMBMessage(m) | |
| 1241 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid) | |
| 1242 | messages_history.append(m) | |
| 1243 | ||
| 1244 | def createCB(open_message, **kwargs): | |
| 1245 | open_message.tid = kwargs['tid'] | |
| 1246 | messages_history.append(open_message) | |
| 1247 | if open_message.status == 0: | |
| 1248 | sendDelete(open_message.tid, open_message.payload.fid) | |
| 1249 | elif open_message.status == 0xc0000034: # STATUS_OBJECT_NAME_NOT_FOUND | |
| 1250 | callback(path) | |
| 1251 | elif open_message.status == 0xC00000BA: # [MS-ERREF]: STATUS_FILE_IS_A_DIRECTORY | |
| 1252 | errback(OperationFailure('Failed to delete %s on %s: Cannot delete a folder. Please use deleteDirectory() method or append "/*" to your path if you wish to delete all files in the folder.' % ( path, service_name ), messages_history)) | |
| 1253 | else: | |
| 1254 | errback(OperationFailure('Failed to delete %s on %s: Unable to open file' % ( path, service_name ), messages_history)) | |
| 1255 | ||
| 1256 | def sendDelete(tid, fid): | |
| 1257 | m = SMB2Message(SMB2SetInfoRequest(fid, | |
| 1258 | additional_info = 0, | |
| 1259 | info_type = SMB2_INFO_FILE, | |
| 1260 | file_info_class = 0x0d, # SMB2_FILE_DISPOSITION_INFO | |
| 1261 | data = b'\x01')) | |
| 1262 | # [MS-SMB2]: 2.2.39, [MS-FSCC]: 2.4.11 | |
| 1263 | m.tid = tid | |
| 1264 | self._sendSMBMessage(m) | |
| 1265 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, tid = tid, fid = fid) | |
| 1266 | messages_history.append(m) | |
| 1267 | ||
| 1268 | def deleteCB(delete_message, **kwargs): | |
| 1269 | messages_history.append(delete_message) | |
| 1270 | if delete_message.status == 0: | |
| 1271 | closeFid(kwargs['tid'], kwargs['fid'], status = 0) | |
| 1272 | else: | |
| 1273 | closeFid(kwargs['tid'], kwargs['fid'], status = delete_message.status) | |
| 1274 | ||
| 1275 | def closeFid(tid, fid, status = None): | |
| 1276 | m = SMB2Message(SMB2CloseRequest(fid)) | |
| 1277 | m.tid = tid | |
| 1278 | self._sendSMBMessage(m) | |
| 1279 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback, status = status) | |
| 1280 | messages_history.append(m) | |
| 1281 | ||
| 1282 | def closeCB(close_message, **kwargs): | |
| 1283 | if kwargs['status'] == 0: | |
| 1284 | callback(path) | |
| 1285 | else: | |
| 1286 | errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history)) | |
| 1287 | ||
| 1288 | sendCreate(tid) | |
| 1289 | ||
| 1290 | def _resetFileAttributes_SMB2(self, service_name, path_file_pattern, callback, errback, file_attributes = ATTR_NORMAL, timeout = 30): | |
| 968 | 1291 | if not self.has_authenticated: |
| 969 | 1292 | raise NotReadyError('SMB connection not authenticated') |
| 970 | 1293 | |
| 985 | 1308 | 00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00 |
| 986 | 1309 | 51 46 69 64 00 00 00 00 |
| 987 | 1310 | """.replace(b' ', b'').replace(b'\n', b'')) |
| 988 | m = SMB2Message(SMB2CreateRequest(path, | |
| 989 | file_attributes = 0, | |
| 990 | access_mask = DELETE | FILE_READ_ATTRIBUTES, | |
| 991 | share_access = FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE, | |
| 992 | oplock = SMB2_OPLOCK_LEVEL_NONE, | |
| 993 | impersonation = SEC_IMPERSONATE, | |
| 994 | create_options = FILE_NON_DIRECTORY_FILE, | |
| 995 | create_disp = FILE_OPEN, | |
| 996 | create_context_data = create_context_data)) | |
| 997 | m.tid = tid | |
| 998 | self._sendSMBMessage(m) | |
| 999 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid) | |
| 1000 | messages_history.append(m) | |
| 1001 | ||
| 1002 | def createCB(open_message, **kwargs): | |
| 1003 | open_message.tid = kwargs['tid'] | |
| 1004 | messages_history.append(open_message) | |
| 1005 | if open_message.status == 0: | |
| 1006 | sendDelete(open_message.tid, open_message.payload.fid) | |
| 1007 | elif open_message.status == 0x0103: # STATUS_PENDING | |
| 1008 | self.pending_requests[open_message.mid] = _PendingRequest(open_message.mid, expiry_time, | |
| 1009 | createCB, errback, | |
| 1010 | tid=kwargs['tid']) | |
| 1011 | else: | |
| 1012 | errback(OperationFailure('Failed to delete %s on %s: Unable to open file' % ( path, service_name ), messages_history)) | |
| 1013 | ||
| 1014 | def sendDelete(tid, fid): | |
| 1015 | m = SMB2Message(SMB2SetInfoRequest(fid, | |
| 1016 | additional_info = 0, | |
| 1017 | info_type = SMB2_INFO_FILE, | |
| 1018 | file_info_class = 0x0d, # SMB2_FILE_DISPOSITION_INFO | |
| 1019 | data = b'\x01')) | |
| 1020 | ''' | |
| 1021 | Resources: | |
| 1022 | https://msdn.microsoft.com/en-us/library/cc246560.aspx | |
| 1023 | https://msdn.microsoft.com/en-us/library/cc232098.aspx | |
| 1024 | ''' | |
| 1025 | m.tid = tid | |
| 1026 | self._sendSMBMessage(m) | |
| 1027 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, fid = fid) | |
| 1028 | messages_history.append(m) | |
| 1029 | ||
| 1030 | def deleteCB(delete_message, **kwargs): | |
| 1031 | messages_history.append(delete_message) | |
| 1032 | if delete_message.status == 0: | |
| 1033 | closeFid(delete_message.tid, kwargs['fid'], status = 0) | |
| 1034 | else: | |
| 1035 | closeFid(delete_message.tid, kwargs['fid'], status = delete_message.status) | |
| 1036 | ||
| 1037 | def closeFid(tid, fid, status = None): | |
| 1038 | m = SMB2Message(SMB2CloseRequest(fid)) | |
| 1039 | m.tid = tid | |
| 1040 | self._sendSMBMessage(m) | |
| 1041 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, closeCB, errback, status = status) | |
| 1042 | messages_history.append(m) | |
| 1043 | ||
| 1044 | def closeCB(close_message, **kwargs): | |
| 1045 | if kwargs['status'] == 0: | |
| 1046 | callback(path_file_pattern) | |
| 1047 | else: | |
| 1048 | errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history)) | |
| 1049 | ||
| 1050 | if service_name not in self.connected_trees: | |
| 1051 | def connectCB(connect_message, **kwargs): | |
| 1052 | messages_history.append(connect_message) | |
| 1053 | if connect_message.status == 0: | |
| 1054 | self.connected_trees[service_name] = connect_message.tid | |
| 1055 | sendCreate(connect_message.tid) | |
| 1056 | else: | |
| 1057 | errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 1058 | ||
| 1059 | m = SMB2Message(SMB2TreeConnectRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ))) | |
| 1060 | self._sendSMBMessage(m) | |
| 1061 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name) | |
| 1062 | messages_history.append(m) | |
| 1063 | else: | |
| 1064 | sendCreate(self.connected_trees[service_name]) | |
| 1065 | ||
| 1066 | def _resetFileAttributes_SMB2(self, service_name, path_file_pattern, callback, errback, timeout = 30): | |
| 1067 | if not self.has_authenticated: | |
| 1068 | raise NotReadyError('SMB connection not authenticated') | |
| 1069 | ||
| 1070 | expiry_time = time.time() + timeout | |
| 1071 | path = path_file_pattern.replace('/', '\\') | |
| 1072 | if path.startswith('\\'): | |
| 1073 | path = path[1:] | |
| 1074 | if path.endswith('\\'): | |
| 1075 | path = path[:-1] | |
| 1076 | messages_history = [ ] | |
| 1077 | ||
| 1078 | def sendCreate(tid): | |
| 1079 | create_context_data = binascii.unhexlify(""" | |
| 1080 | 28 00 00 00 10 00 04 00 00 00 18 00 10 00 00 00 | |
| 1081 | 44 48 6e 51 00 00 00 00 00 00 00 00 00 00 00 00 | |
| 1082 | 00 00 00 00 00 00 00 00 18 00 00 00 10 00 04 00 | |
| 1083 | 00 00 18 00 00 00 00 00 4d 78 41 63 00 00 00 00 | |
| 1084 | 00 00 00 00 10 00 04 00 00 00 18 00 00 00 00 00 | |
| 1085 | 51 46 69 64 00 00 00 00 | |
| 1086 | """.replace(' ', '').replace('\n', '')) | |
| 1087 | 1311 | |
| 1088 | 1312 | m = SMB2Message(SMB2CreateRequest(path, |
| 1089 | 1313 | file_attributes = 0, |
| 1102 | 1326 | def createCB(open_message, **kwargs): |
| 1103 | 1327 | messages_history.append(open_message) |
| 1104 | 1328 | if open_message.status == 0: |
| 1105 | sendReset(open_message.tid, open_message.payload.fid) | |
| 1329 | sendReset(kwargs['tid'], open_message.payload.fid) | |
| 1106 | 1330 | else: |
| 1107 | 1331 | errback(OperationFailure('Failed to reset attributes of %s on %s: Unable to open file' % ( path, service_name ), messages_history)) |
| 1108 | 1332 | |
| 1111 | 1335 | additional_info = 0, |
| 1112 | 1336 | info_type = SMB2_INFO_FILE, |
| 1113 | 1337 | file_info_class = 4, # FileBasicInformation |
| 1114 | data = struct.pack('qqqqii',0,0,0,0,0x80,0))) # FILE_ATTRIBUTE_NORMAL | |
| 1115 | ''' | |
| 1116 | Resources: | |
| 1117 | https://msdn.microsoft.com/en-us/library/cc246560.aspx | |
| 1118 | https://msdn.microsoft.com/en-us/library/cc232064.aspx | |
| 1119 | https://msdn.microsoft.com/en-us/library/cc232094.aspx | |
| 1120 | https://msdn.microsoft.com/en-us/library/cc232110.aspx | |
| 1121 | ''' | |
| 1122 | m.tid = tid | |
| 1123 | self._sendSMBMessage(m) | |
| 1124 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, resetCB, errback, fid = fid) | |
| 1338 | data = struct.pack('qqqqii', 0, 0, 0, 0, file_attributes, 0))) | |
| 1339 | # [MS-SMB2]: 2.2.39, [MS-FSCC]: 2.4, [MS-FSCC]: 2.4.7, [MS-FSCC]: 2.6 | |
| 1340 | m.tid = tid | |
| 1341 | self._sendSMBMessage(m) | |
| 1342 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, resetCB, errback, tid = tid, fid = fid) | |
| 1125 | 1343 | messages_history.append(m) |
| 1126 | 1344 | |
| 1127 | 1345 | def resetCB(reset_message, **kwargs): |
| 1128 | 1346 | messages_history.append(reset_message) |
| 1129 | 1347 | if reset_message.status == 0: |
| 1130 | closeFid(reset_message.tid, kwargs['fid'], status = 0) | |
| 1131 | else: | |
| 1132 | closeFid(reset_message.tid, kwargs['fid'], status = reset_message.status) | |
| 1348 | closeFid(kwargs['tid'], kwargs['fid'], status = 0) | |
| 1349 | else: | |
| 1350 | closeFid(kwargs['tid'], kwargs['fid'], status = reset_message.status) | |
| 1133 | 1351 | |
| 1134 | 1352 | def closeFid(tid, fid, status = None): |
| 1135 | 1353 | m = SMB2Message(SMB2CloseRequest(fid)) |
| 1159 | 1377 | messages_history.append(m) |
| 1160 | 1378 | else: |
| 1161 | 1379 | sendCreate(self.connected_trees[service_name]) |
| 1162 | ||
| 1163 | ||
| 1164 | 1380 | |
| 1165 | 1381 | def _createDirectory_SMB2(self, service_name, path, callback, errback, timeout = 30): |
| 1166 | 1382 | if not self.has_authenticated: |
| 1194 | 1410 | create_context_data = create_context_data)) |
| 1195 | 1411 | m.tid = tid |
| 1196 | 1412 | self._sendSMBMessage(m) |
| 1197 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback) | |
| 1413 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback, tid = tid) | |
| 1198 | 1414 | messages_history.append(m) |
| 1199 | 1415 | |
| 1200 | 1416 | def createCB(create_message, **kwargs): |
| 1201 | 1417 | messages_history.append(create_message) |
| 1202 | 1418 | if create_message.status == 0: |
| 1203 | closeFid(create_message.tid, create_message.payload.fid) | |
| 1419 | closeFid(kwargs['tid'], create_message.payload.fid) | |
| 1204 | 1420 | else: |
| 1205 | 1421 | errback(OperationFailure('Failed to create directory %s on %s: Create failed' % ( path, service_name ), messages_history)) |
| 1206 | 1422 | |
| 1268 | 1484 | def createCB(open_message, **kwargs): |
| 1269 | 1485 | messages_history.append(open_message) |
| 1270 | 1486 | if open_message.status == 0: |
| 1271 | sendDelete(open_message.tid, open_message.payload.fid) | |
| 1487 | sendDelete(kwargs['tid'], open_message.payload.fid) | |
| 1272 | 1488 | else: |
| 1273 | 1489 | errback(OperationFailure('Failed to delete %s on %s: Unable to open directory' % ( path, service_name ), messages_history)) |
| 1274 | 1490 | |
| 1280 | 1496 | data = b'\x01')) |
| 1281 | 1497 | m.tid = tid |
| 1282 | 1498 | self._sendSMBMessage(m) |
| 1283 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, fid = fid) | |
| 1499 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback, tid = tid, fid = fid) | |
| 1284 | 1500 | messages_history.append(m) |
| 1285 | 1501 | |
| 1286 | 1502 | def deleteCB(delete_message, **kwargs): |
| 1287 | 1503 | messages_history.append(delete_message) |
| 1288 | 1504 | if delete_message.status == 0: |
| 1289 | closeFid(delete_message.tid, kwargs['fid'], status = 0) | |
| 1290 | else: | |
| 1291 | closeFid(delete_message.tid, kwargs['fid'], status = delete_message.status) | |
| 1505 | closeFid(kwargs['tid'], kwargs['fid'], status = 0) | |
| 1506 | else: | |
| 1507 | closeFid(kwargs['tid'], kwargs['fid'], status = delete_message.status) | |
| 1292 | 1508 | |
| 1293 | 1509 | def closeFid(tid, fid, status = None): |
| 1294 | 1510 | m = SMB2Message(SMB2CloseRequest(fid)) |
| 1364 | 1580 | def createCB(create_message, **kwargs): |
| 1365 | 1581 | messages_history.append(create_message) |
| 1366 | 1582 | if create_message.status == 0: |
| 1367 | sendRename(create_message.tid, create_message.payload.fid) | |
| 1583 | sendRename(kwargs['tid'], create_message.payload.fid) | |
| 1368 | 1584 | else: |
| 1369 | 1585 | errback(OperationFailure('Failed to rename %s on %s: Unable to open file/directory' % ( old_path, service_name ), messages_history)) |
| 1370 | 1586 | |
| 1377 | 1593 | data = data)) |
| 1378 | 1594 | m.tid = tid |
| 1379 | 1595 | self._sendSMBMessage(m) |
| 1380 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, renameCB, errback, fid = fid) | |
| 1596 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, renameCB, errback, tid = tid, fid = fid) | |
| 1381 | 1597 | messages_history.append(m) |
| 1382 | 1598 | |
| 1383 | 1599 | def renameCB(rename_message, **kwargs): |
| 1384 | 1600 | messages_history.append(rename_message) |
| 1385 | 1601 | if rename_message.status == 0: |
| 1386 | closeFid(rename_message.tid, kwargs['fid'], status = 0) | |
| 1387 | else: | |
| 1388 | closeFid(rename_message.tid, kwargs['fid'], status = rename_message.status) | |
| 1602 | closeFid(kwargs['tid'], kwargs['fid'], status = 0) | |
| 1603 | else: | |
| 1604 | closeFid(kwargs['tid'], kwargs['fid'], status = rename_message.status) | |
| 1389 | 1605 | |
| 1390 | 1606 | def closeFid(tid, fid, status = None): |
| 1391 | 1607 | m = SMB2Message(SMB2CloseRequest(fid)) |
| 1452 | 1668 | def createCB(create_message, **kwargs): |
| 1453 | 1669 | messages_history.append(create_message) |
| 1454 | 1670 | if create_message.status == 0: |
| 1455 | sendEnumSnapshots(create_message.tid, create_message.payload.fid) | |
| 1671 | sendEnumSnapshots(kwargs['tid'], create_message.payload.fid) | |
| 1456 | 1672 | else: |
| 1457 | 1673 | errback(OperationFailure('Failed to list snapshots %s on %s: Unable to open file/directory' % ( old_path, service_name ), messages_history)) |
| 1458 | 1674 | |
| 1593 | 1809 | self._handleSessionChallenge(message, ntlm_token) |
| 1594 | 1810 | except ( securityblob.BadSecurityBlobError, securityblob.UnsupportedSecurityProvider ) as ex: |
| 1595 | 1811 | raise ProtocolError(str(ex), message.raw_data, message) |
| 1596 | elif message.status.internal_value == 0xc000006d: # STATUS_LOGON_FAILURE | |
| 1812 | elif (message.status.internal_value == 0xc000006d # STATUS_LOGON_FAILURE | |
| 1813 | or message.status.internal_value == 0xc0000064 # STATUS_NO_SUCH_USER | |
| 1814 | or message.status.internal_value == 0xc000006a): # STATUS_WRONG_PASSWORD | |
| 1597 | 1815 | self.has_authenticated = False |
| 1598 | self.log.info('Authentication (with extended security) failed. Please check username and password. You may need to enable/disable NTLMv2 authentication.') | |
| 1816 | self.log.info('Authentication (with extended security) failed. Please check username and password.') | |
| 1817 | self.onAuthFailed() | |
| 1818 | elif (message.status.internal_value == 0xc0000193 # STATUS_ACCOUNT_EXPIRED | |
| 1819 | or message.status.internal_value == 0xC0000071): # STATUS_PASSWORD_EXPIRED | |
| 1820 | self.has_authenticated = False | |
| 1821 | self.log.info('Authentication (with extended security) failed. Account or password has expired.') | |
| 1822 | self.onAuthFailed() | |
| 1823 | elif message.status.internal_value == 0xc0000234: # STATUS_ACCOUNT_LOCKED_OUT | |
| 1824 | self.has_authenticated = False | |
| 1825 | self.log.info('Authentication (with extended security) failed. Account has been locked due to too many invalid logon attempts.') | |
| 1826 | self.onAuthFailed() | |
| 1827 | elif message.status.internal_value == 0xc0000072: # STATUS_ACCOUNT_DISABLED | |
| 1828 | self.has_authenticated = False | |
| 1829 | self.log.info('Authentication (with extended security) failed. Account has been disabled.') | |
| 1830 | self.onAuthFailed() | |
| 1831 | elif (message.status.internal_value == 0xc000006f # STATUS_INVALID_LOGON_HOURS | |
| 1832 | or message.status.internal_value == 0xc000015b # STATUS_LOGON_TYPE_NOT_GRANTED | |
| 1833 | or message.status.internal_value == 0xc0000070): # STATUS_INVALID_WORKSTATION | |
| 1834 | self.has_authenticated = False | |
| 1835 | self.log.info('Authentication (with extended security) failed. Not allowed.') | |
| 1836 | self.onAuthFailed() | |
| 1837 | elif message.status.internal_value == 0xc000018c: # STATUS_TRUSTED_DOMAIN_FAILURE | |
| 1838 | self.has_authenticated = False | |
| 1839 | self.log.info('Authentication (with extended security) failed. Domain not trusted.') | |
| 1840 | self.onAuthFailed() | |
| 1841 | elif message.status.internal_value == 0xc000018d: # STATUS_TRUSTED_RELATIONSHIP_FAILURE | |
| 1842 | self.has_authenticated = False | |
| 1843 | self.log.info('Authentication (with extended security) failed. Workstation not trusted.') | |
| 1599 | 1844 | self.onAuthFailed() |
| 1600 | 1845 | else: |
| 1601 | 1846 | raise ProtocolError('Unknown status value (0x%08X) in SMB_COM_SESSION_SETUP_ANDX (with extended security)' % message.status.internal_value, |
| 1657 | 1902 | self.log.info('Performing NTLMv1 authentication (with extended security) with server challenge "%s"', binascii.hexlify(server_challenge)) |
| 1658 | 1903 | nt_challenge_response, lm_challenge_response, session_key = ntlm.generateChallengeResponseV1(self.password, server_challenge, True) |
| 1659 | 1904 | |
| 1660 | ntlm_data = ntlm.generateAuthenticateMessage(server_flags, | |
| 1661 | nt_challenge_response, | |
| 1662 | lm_challenge_response, | |
| 1663 | session_key, | |
| 1664 | self.username, | |
| 1665 | self.domain) | |
| 1905 | ntlm_data, signing_session_key = ntlm.generateAuthenticateMessage(server_flags, | |
| 1906 | nt_challenge_response, | |
| 1907 | lm_challenge_response, | |
| 1908 | session_key, | |
| 1909 | self.username, | |
| 1910 | self.domain, | |
| 1911 | self.my_name) | |
| 1666 | 1912 | |
| 1667 | 1913 | if self.log.isEnabledFor(logging.DEBUG): |
| 1668 | 1914 | self.log.debug('NT challenge response is "%s" (%d bytes)', binascii.hexlify(nt_challenge_response), len(nt_challenge_response)) |
| 1682 | 1928 | |
| 1683 | 1929 | if self.is_signing_active: |
| 1684 | 1930 | self.log.info("SMB signing activated. All SMB messages will be signed.") |
| 1685 | self.signing_session_key = session_key | |
| 1931 | self.signing_session_key = signing_session_key | |
| 1686 | 1932 | if self.capabilities & CAP_EXTENDED_SECURITY: |
| 1687 | 1933 | self.signing_challenge_response = None |
| 1688 | 1934 | else: |
| 1856 | 2102 | def readCB(read_message, **kwargs): |
| 1857 | 2103 | messages_history.append(read_message) |
| 1858 | 2104 | if not read_message.status.hasError: |
| 1859 | data_len = read_message.payload.data_length | |
| 1860 | 2105 | data_bytes = read_message.payload.data |
| 1861 | 2106 | |
| 1862 | 2107 | if data_bytes[3] & 0x02 == 0: |
| 1863 | sendReadRequest(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:data_len-24]) | |
| 1864 | else: | |
| 1865 | decodeResults(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:data_len-24]) | |
| 2108 | sendReadRequest(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:]) | |
| 2109 | else: | |
| 2110 | decodeResults(read_message.tid, kwargs['fid'], kwargs['data_bytes'] + data_bytes[24:]) | |
| 1866 | 2111 | else: |
| 1867 | 2112 | closeFid(read_message.tid, kwargs['fid']) |
| 1868 | 2113 | errback(OperationFailure('Failed to list shares: Unable to retrieve shared device list', messages_history)) |
| 1901 | 2146 | setup_bytes = struct.pack('<H', 0x0001) # TRANS2_FIND_FIRST2 sub-command. See [MS-CIFS]: 2.2.6.2.1 |
| 1902 | 2147 | params_bytes = \ |
| 1903 | 2148 | struct.pack('<HHHHI', |
| 1904 | search, # SearchAttributes | |
| 2149 | search & 0xFFFF, # SearchAttributes (need to restrict the values due to introduction of SMB_FILE_ATTRIBUTE_INCL_NORMAL) | |
| 1905 | 2150 | 100, # SearchCount |
| 1906 | 2151 | 0x0006, # Flags: SMB_FIND_CLOSE_AT_EOS | SMB_FIND_RETURN_RESUME_KEYS |
| 1907 | 2152 | 0x0104, # InfoLevel: SMB_FIND_FILE_BOTH_DIRECTORY_INFO |
| 1908 | 0x0000) # SearchStorageType | |
| 2153 | 0x0000) # SearchStorageType (seems to be ignored by Windows) | |
| 1909 | 2154 | if support_dfs: |
| 1910 | 2155 | params_bytes += ("\\" + self.remote_name + "\\" + service_name + path + pattern + '\0').encode('UTF-16LE') |
| 1911 | 2156 | else: |
| 1912 | params_bytes += (path + pattern).encode('UTF-16LE') | |
| 2157 | params_bytes += (path + pattern + '\0').encode('UTF-16LE') | |
| 1913 | 2158 | |
| 1914 | 2159 | m = SMBMessage(ComTransaction2Request(max_params_count = 10, |
| 1915 | 2160 | max_data_count = 16644, |
| 1945 | 2190 | |
| 1946 | 2191 | filename = data_bytes[offset2:offset2+filename_length].decode('UTF-16LE') |
| 1947 | 2192 | short_name = short_name.decode('UTF-16LE') |
| 1948 | results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time), | |
| 1949 | convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time), | |
| 1950 | file_size, alloc_size, file_attributes, short_name, filename)) | |
| 2193 | ||
| 2194 | accept_result = False | |
| 2195 | if (file_attributes & 0xff) in ( 0x00, ATTR_NORMAL ): # Only the first 8-bits are compared. We ignore other bits like temp, compressed, encryption, sparse, indexed, etc | |
| 2196 | accept_result = (search == SMB_FILE_ATTRIBUTE_NORMAL) or (search & SMB_FILE_ATTRIBUTE_INCL_NORMAL) | |
| 2197 | else: | |
| 2198 | accept_result = (file_attributes & search) > 0 | |
| 2199 | if accept_result: | |
| 2200 | results.append(SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time), | |
| 2201 | convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time), | |
| 2202 | file_size, alloc_size, file_attributes, short_name, filename)) | |
| 1951 | 2203 | |
| 1952 | 2204 | if next_offset: |
| 1953 | 2205 | offset += next_offset |
| 1987 | 2239 | elif end_of_search: |
| 1988 | 2240 | callback(results) |
| 1989 | 2241 | else: |
| 1990 | sendFindNext(find_message.tid, sid, last_name_offset, kwargs.get('support_dfs', False)) | |
| 1991 | else: | |
| 1992 | errback(OperationFailure('Failed to list %s on %s: Unable to retrieve file list' % ( path, service_name ), messages_history)) | |
| 1993 | ||
| 1994 | def sendFindNext(tid, sid, resume_key, support_dfs=False): | |
| 2242 | sendFindNext(find_message.tid, sid, 0, results[-1].filename, kwargs.get('support_dfs', False)) | |
| 2243 | else: | |
| 2244 | if find_message.status.internal_value == 0xC000000F: # [MS-ERREF]: STATUS_NO_SUCH_FILE | |
| 2245 | # Remote server returns STATUS_NO_SUCH_FILE error so we assume that the search returns no matching files | |
| 2246 | callback([ ]) | |
| 2247 | else: | |
| 2248 | errback(OperationFailure('Failed to list %s on %s: Unable to retrieve file list' % ( path, service_name ), messages_history)) | |
| 2249 | ||
| 2250 | def sendFindNext(tid, sid, resume_key, resume_file, support_dfs): | |
| 1995 | 2251 | setup_bytes = struct.pack('<H', 0x0002) # TRANS2_FIND_NEXT2 sub-command. See [MS-CIFS]: 2.2.6.3.1 |
| 1996 | 2252 | params_bytes = \ |
| 1997 | 2253 | struct.pack('<HHHIH', |
| 1999 | 2255 | 100, # SearchCount |
| 2000 | 2256 | 0x0104, # InfoLevel: SMB_FIND_FILE_BOTH_DIRECTORY_INFO |
| 2001 | 2257 | resume_key, # ResumeKey |
| 2002 | 0x000a) # Flags: SMB_FIND_RETURN_RESUME_KEYS | SMB_FIND_CLOSE_AT_EOS | SMB_FIND_RETURN_RESUME_KEYS | |
| 2003 | if support_dfs: | |
| 2004 | params_bytes += ("\\" + self.remote_name + "\\" + service_name + path + pattern + '\0').encode('UTF-16LE') | |
| 2005 | else: | |
| 2006 | params_bytes += (path + pattern).encode('UTF-16LE') | |
| 2258 | 0x0006) # Flags: SMB_FIND_RETURN_RESUME_KEYS | SMB_FIND_CLOSE_AT_EOS | |
| 2259 | params_bytes += (resume_file+'\0').encode('UTF-16LE') | |
| 2007 | 2260 | |
| 2008 | 2261 | m = SMBMessage(ComTransaction2Request(max_params_count = 10, |
| 2009 | 2262 | max_data_count = 16644, |
| 2049 | 2302 | elif end_of_search: |
| 2050 | 2303 | callback(results) |
| 2051 | 2304 | else: |
| 2052 | sendFindNext(find_message.tid, kwargs['sid'], last_name_offset, kwargs.get('support_dfs', False)) | |
| 2305 | sendFindNext(find_message.tid, kwargs['sid'], 0, results[-1].filename, kwargs.get('support_dfs', False)) | |
| 2053 | 2306 | else: |
| 2054 | 2307 | errback(OperationFailure('Failed to list %s on %s: Unable to retrieve file list' % ( path, service_name ), messages_history)) |
| 2055 | 2308 | |
| 2127 | 2380 | info_size = struct.calcsize(info_format) |
| 2128 | 2381 | create_time, last_access_time, last_write_time, last_attr_change_time, \ |
| 2129 | 2382 | file_attributes, _, alloc_size, file_size = struct.unpack(info_format, query_message.payload.data_bytes[:info_size]) |
| 2130 | ||
| 2131 | info = SharedFile(create_time, last_access_time, last_write_time, last_attr_change_time, | |
| 2132 | file_size, alloc_size, file_attributes, path, path) | |
| 2383 | filename = self._extractLastPathComponent(path) | |
| 2384 | ||
| 2385 | info = SharedFile(convertFILETIMEtoEpoch(create_time), convertFILETIMEtoEpoch(last_access_time), convertFILETIMEtoEpoch(last_write_time), convertFILETIMEtoEpoch(last_attr_change_time), | |
| 2386 | file_size, alloc_size, file_attributes, filename, filename) | |
| 2133 | 2387 | callback(info) |
| 2134 | 2388 | else: |
| 2135 | 2389 | errback(OperationFailure('Failed to get attributes for %s on %s: Read failed' % ( path, service_name ), messages_history)) |
| 2149 | 2403 | messages_history.append(m) |
| 2150 | 2404 | else: |
| 2151 | 2405 | sendQuery(self.connected_trees[service_name]) |
| 2406 | ||
| 2407 | def _getSecurity_SMB1(self, service_name, path_file_pattern, callback, errback, timeout = 30): | |
| 2408 | raise NotReadyError('getSecurity is not yet implemented for SMB1') | |
| 2152 | 2409 | |
| 2153 | 2410 | def _retrieveFile_SMB1(self, service_name, path, file_obj, callback, errback, timeout = 30): |
| 2154 | 2411 | return self._retrieveFileFromOffset(service_name, path, file_obj, callback, errback, 0, -1, timeout) |
| 2273 | 2530 | errback(OperationFailure('Failed to store %s on %s: Unable to open file' % ( path, service_name ), messages_history)) |
| 2274 | 2531 | |
| 2275 | 2532 | def sendWrite(tid, fid, offset): |
| 2276 | # For message signing, the total SMB message size must be not exceed the max_buffer_size. Non-message signing does not have this limitation | |
| 2277 | 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 | |
| 2533 | # [MS-SMB] 2.2.4.5.2.2: The total SMB message size (inclusive of SMB header) must be not exceed the max_buffer_size. | |
| 2534 | write_count = min(self.max_buffer_size-64, 0xFFFF-64) # SMB header is 32-bytes. We factor in another 32-bytes for the message parameter block | |
| 2278 | 2535 | data_bytes = file_obj.read(write_count) |
| 2279 | 2536 | data_len = len(data_bytes) |
| 2280 | 2537 | if data_len > 0: |
| 2317 | 2574 | else: |
| 2318 | 2575 | sendOpen(self.connected_trees[service_name]) |
| 2319 | 2576 | |
| 2320 | def _deleteFiles_SMB1(self, service_name, path_file_pattern, callback, errback, timeout = 30): | |
| 2577 | def _deleteFiles_SMB1(self, service_name, path_file_pattern, delete_matching_folders, callback, errback, timeout = 30): | |
| 2321 | 2578 | if not self.has_authenticated: |
| 2322 | 2579 | raise NotReadyError('SMB connection not authenticated') |
| 2323 | 2580 | |
| 2581 | expiry_time = time.time() + timeout | |
| 2582 | pattern = None | |
| 2324 | 2583 | path = path_file_pattern.replace('/', '\\') |
| 2584 | if path.startswith('\\'): | |
| 2585 | path = path[1:] | |
| 2586 | if path.endswith('\\'): | |
| 2587 | path = path[:-1] | |
| 2588 | else: | |
| 2589 | path_components = path.split('\\') | |
| 2590 | if path_components[-1].find('*') > -1 or path_components[-1].find('?') > -1: | |
| 2591 | path = '\\'.join(path_components[:-1]) | |
| 2592 | pattern = path_components[-1] | |
| 2593 | messages_history, files_queue = [ ], [ ] | |
| 2594 | ||
| 2595 | if pattern is None: | |
| 2596 | path_components = path.split('\\') | |
| 2597 | if len(path_components) > 1: | |
| 2598 | files_queue.append(( '\\'.join(path_components[:-1]), path_components[-1] )) | |
| 2599 | else: | |
| 2600 | files_queue.append(( '', path )) | |
| 2601 | ||
| 2602 | def deleteCB(path): | |
| 2603 | if files_queue: | |
| 2604 | p, filename = files_queue.pop(0) | |
| 2605 | if filename: | |
| 2606 | if p: | |
| 2607 | filename = p + '\\' + filename | |
| 2608 | self._deleteFiles_SMB1__del(service_name, self.connected_trees[service_name], filename, deleteCB, errback, timeout) | |
| 2609 | else: | |
| 2610 | self._deleteDirectory_SMB1(service_name, p, deleteCB, errback, timeout = 30) | |
| 2611 | else: | |
| 2612 | callback(path_file_pattern) | |
| 2613 | ||
| 2614 | def listCB(files_list): | |
| 2615 | files_queue.extend(files_list) | |
| 2616 | deleteCB(None) | |
| 2617 | ||
| 2618 | if service_name not in self.connected_trees: | |
| 2619 | def connectCB(connect_message, **kwargs): | |
| 2620 | messages_history.append(connect_message) | |
| 2621 | if not connect_message.status.hasError: | |
| 2622 | self.connected_trees[service_name] = connect_message.tid | |
| 2623 | if files_queue: | |
| 2624 | deleteCB(None) | |
| 2625 | else: | |
| 2626 | self._deleteFiles_SMB1__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout) | |
| 2627 | else: | |
| 2628 | errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 2629 | ||
| 2630 | m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, '')) | |
| 2631 | self._sendSMBMessage(m) | |
| 2632 | self.pending_requests[m.mid] = _PendingRequest(m.mid, expiry_time, connectCB, errback, path = service_name) | |
| 2633 | messages_history.append(m) | |
| 2634 | else: | |
| 2635 | if files_queue: | |
| 2636 | deleteCB(None) | |
| 2637 | else: | |
| 2638 | self._deleteFiles_SMB1__list(service_name, path, pattern, delete_matching_folders, listCB, errback, timeout) | |
| 2639 | ||
| 2640 | def _deleteFiles_SMB1__list(self, service_name, path, pattern, delete_matching_folders, callback, errback, timeout = 30): | |
| 2641 | folder_queue = [ ] | |
| 2642 | files_list = [ ] | |
| 2643 | current_path = [ path ] | |
| 2644 | search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_DIRECTORY | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL | |
| 2645 | ||
| 2646 | def listCB(results): | |
| 2647 | files = [ ] | |
| 2648 | for f in filter(lambda x: x.filename not in [ '.', '..' ], results): | |
| 2649 | if f.isDirectory: | |
| 2650 | if delete_matching_folders: | |
| 2651 | folder_queue.append(current_path[0]+'\\'+f.filename) | |
| 2652 | else: | |
| 2653 | files.append(( current_path[0], f.filename )) | |
| 2654 | if current_path[0]!=path and delete_matching_folders: | |
| 2655 | files.append(( current_path[0], None )) | |
| 2656 | ||
| 2657 | if files: | |
| 2658 | files_list[0:0] = files | |
| 2659 | ||
| 2660 | if folder_queue: | |
| 2661 | p = folder_queue.pop() | |
| 2662 | current_path[0] = p | |
| 2663 | self._listPath_SMB1(service_name, current_path[0], listCB, errback, search = search, pattern = '*', timeout = 30) | |
| 2664 | else: | |
| 2665 | callback(files_list) | |
| 2666 | ||
| 2667 | self._listPath_SMB1(service_name, path, listCB, errback, search = search, pattern = pattern, timeout = timeout) | |
| 2668 | ||
| 2669 | def _deleteFiles_SMB1__del(self, service_name, tid, path, callback, errback, timeout = 30): | |
| 2325 | 2670 | messages_history = [ ] |
| 2326 | 2671 | |
| 2327 | 2672 | def sendDelete(tid): |
| 2335 | 2680 | def deleteCB(delete_message, **kwargs): |
| 2336 | 2681 | messages_history.append(delete_message) |
| 2337 | 2682 | if not delete_message.status.hasError: |
| 2683 | callback(path) | |
| 2684 | elif delete_message.status.internal_value == 0xC000000F: # [MS-ERREF]: STATUS_NO_SUCH_FILE | |
| 2685 | # If there are no matching files, we just treat as success instead of failing | |
| 2338 | 2686 | callback(path_file_pattern) |
| 2339 | else: | |
| 2340 | errback(OperationFailure('Failed to store %s on %s: Delete failed' % ( path, service_name ), messages_history)) | |
| 2687 | elif delete_message.status.internal_value == 0xC00000BA: # [MS-ERREF]: STATUS_FILE_IS_A_DIRECTORY | |
| 2688 | errback(OperationFailure('Failed to delete %s on %s: Cannot delete a folder. Please use deleteDirectory() method or append "/*" to your path if you wish to delete all files in the folder.' % ( path, service_name ), messages_history)) | |
| 2689 | elif delete_message.status.internal_value == 0xC0000034: # [MS-ERREF]: STATUS_OBJECT_NAME_INVALID | |
| 2690 | errback(OperationFailure('Failed to delete %s on %s: Path not found' % ( path, service_name ), messages_history)) | |
| 2691 | else: | |
| 2692 | errback(OperationFailure('Failed to delete %s on %s: Delete failed' % ( path, service_name ), messages_history)) | |
| 2693 | ||
| 2694 | sendDelete(tid) | |
| 2695 | ||
| 2696 | def _resetFileAttributes_SMB1(self, service_name, path_file_pattern, callback, errback, file_attributes=ATTR_NORMAL, timeout = 30): | |
| 2697 | raise NotReadyError('resetFileAttributes is not yet implemented for SMB1') | |
| 2698 | ||
| 2699 | def _createDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30): | |
| 2700 | if not self.has_authenticated: | |
| 2701 | raise NotReadyError('SMB connection not authenticated') | |
| 2702 | ||
| 2703 | path = path.replace('/', '\\') | |
| 2704 | messages_history = [ ] | |
| 2705 | ||
| 2706 | def sendCreate(tid): | |
| 2707 | m = SMBMessage(ComCreateDirectoryRequest(path)) | |
| 2708 | m.tid = tid | |
| 2709 | self._sendSMBMessage(m) | |
| 2710 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback) | |
| 2711 | messages_history.append(m) | |
| 2712 | ||
| 2713 | def createCB(create_message, **kwargs): | |
| 2714 | messages_history.append(create_message) | |
| 2715 | if not create_message.status.hasError: | |
| 2716 | callback(path) | |
| 2717 | else: | |
| 2718 | errback(OperationFailure('Failed to create directory %s on %s: Create failed' % ( path, service_name ), messages_history)) | |
| 2719 | ||
| 2720 | if service_name not in self.connected_trees: | |
| 2721 | def connectCB(connect_message, **kwargs): | |
| 2722 | messages_history.append(connect_message) | |
| 2723 | if not connect_message.status.hasError: | |
| 2724 | self.connected_trees[service_name] = connect_message.tid | |
| 2725 | sendCreate(connect_message.tid) | |
| 2726 | else: | |
| 2727 | errback(OperationFailure('Failed to create directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 2728 | ||
| 2729 | m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, '')) | |
| 2730 | self._sendSMBMessage(m) | |
| 2731 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name) | |
| 2732 | messages_history.append(m) | |
| 2733 | else: | |
| 2734 | sendCreate(self.connected_trees[service_name]) | |
| 2735 | ||
| 2736 | def _deleteDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30): | |
| 2737 | if not self.has_authenticated: | |
| 2738 | raise NotReadyError('SMB connection not authenticated') | |
| 2739 | ||
| 2740 | path = path.replace('/', '\\') | |
| 2741 | messages_history = [ ] | |
| 2742 | ||
| 2743 | def sendDelete(tid): | |
| 2744 | m = SMBMessage(ComDeleteDirectoryRequest(path)) | |
| 2745 | m.tid = tid | |
| 2746 | self._sendSMBMessage(m) | |
| 2747 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback) | |
| 2748 | messages_history.append(m) | |
| 2749 | ||
| 2750 | def deleteCB(delete_message, **kwargs): | |
| 2751 | messages_history.append(delete_message) | |
| 2752 | if not delete_message.status.hasError: | |
| 2753 | callback(path) | |
| 2754 | else: | |
| 2755 | errback(OperationFailure('Failed to delete directory %s on %s: Delete failed' % ( path, service_name ), messages_history)) | |
| 2341 | 2756 | |
| 2342 | 2757 | if service_name not in self.connected_trees: |
| 2343 | 2758 | def connectCB(connect_message, **kwargs): |
| 2346 | 2761 | self.connected_trees[service_name] = connect_message.tid |
| 2347 | 2762 | sendDelete(connect_message.tid) |
| 2348 | 2763 | else: |
| 2349 | errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 2350 | ||
| 2351 | m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, '')) | |
| 2352 | self._sendSMBMessage(m) | |
| 2353 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name) | |
| 2354 | messages_history.append(m) | |
| 2355 | else: | |
| 2356 | sendDelete(self.connected_trees[service_name]) | |
| 2357 | ||
| 2358 | def _resetFileAttributes_SMB1(self, service_name, path_file_pattern, callback, errback, timeout = 30): | |
| 2359 | raise NotReadyError('resetFileAttributes is not yet implemented for SMB1') | |
| 2360 | ||
| 2361 | def _createDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30): | |
| 2362 | if not self.has_authenticated: | |
| 2363 | raise NotReadyError('SMB connection not authenticated') | |
| 2364 | ||
| 2365 | path = path.replace('/', '\\') | |
| 2366 | messages_history = [ ] | |
| 2367 | ||
| 2368 | def sendCreate(tid): | |
| 2369 | m = SMBMessage(ComCreateDirectoryRequest(path)) | |
| 2370 | m.tid = tid | |
| 2371 | self._sendSMBMessage(m) | |
| 2372 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, createCB, errback) | |
| 2373 | messages_history.append(m) | |
| 2374 | ||
| 2375 | def createCB(create_message, **kwargs): | |
| 2376 | messages_history.append(create_message) | |
| 2377 | if not create_message.status.hasError: | |
| 2378 | callback(path) | |
| 2379 | else: | |
| 2380 | errback(OperationFailure('Failed to create directory %s on %s: Create failed' % ( path, service_name ), messages_history)) | |
| 2381 | ||
| 2382 | if service_name not in self.connected_trees: | |
| 2383 | def connectCB(connect_message, **kwargs): | |
| 2384 | messages_history.append(connect_message) | |
| 2385 | if not connect_message.status.hasError: | |
| 2386 | self.connected_trees[service_name] = connect_message.tid | |
| 2387 | sendCreate(connect_message.tid) | |
| 2388 | else: | |
| 2389 | errback(OperationFailure('Failed to create directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 2390 | ||
| 2391 | m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, '')) | |
| 2392 | self._sendSMBMessage(m) | |
| 2393 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, connectCB, errback, path = service_name) | |
| 2394 | messages_history.append(m) | |
| 2395 | else: | |
| 2396 | sendCreate(self.connected_trees[service_name]) | |
| 2397 | ||
| 2398 | def _deleteDirectory_SMB1(self, service_name, path, callback, errback, timeout = 30): | |
| 2399 | if not self.has_authenticated: | |
| 2400 | raise NotReadyError('SMB connection not authenticated') | |
| 2401 | ||
| 2402 | path = path.replace('/', '\\') | |
| 2403 | messages_history = [ ] | |
| 2404 | ||
| 2405 | def sendDelete(tid): | |
| 2406 | m = SMBMessage(ComDeleteDirectoryRequest(path)) | |
| 2407 | m.tid = tid | |
| 2408 | self._sendSMBMessage(m) | |
| 2409 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, deleteCB, errback) | |
| 2410 | messages_history.append(m) | |
| 2411 | ||
| 2412 | def deleteCB(delete_message, **kwargs): | |
| 2413 | messages_history.append(delete_message) | |
| 2414 | if not delete_message.status.hasError: | |
| 2415 | callback(path) | |
| 2416 | else: | |
| 2417 | errback(OperationFailure('Failed to delete directory %s on %s: Delete failed' % ( path, service_name ), messages_history)) | |
| 2418 | ||
| 2419 | if service_name not in self.connected_trees: | |
| 2420 | def connectCB(connect_message, **kwargs): | |
| 2421 | messages_history.append(connect_message) | |
| 2422 | if not connect_message.status.hasError: | |
| 2423 | self.connected_trees[service_name] = connect_message.tid | |
| 2424 | sendDelete(connect_message.tid) | |
| 2425 | else: | |
| 2426 | errback(OperationFailure('Failed to delete %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 2764 | errback(OperationFailure('Failed to delete directory %s on %s: Unable to connect to shared device' % ( path, service_name ), messages_history)) | |
| 2427 | 2765 | |
| 2428 | 2766 | m = SMBMessage(ComTreeConnectAndxRequest(r'\\%s\%s' % ( self.remote_name.upper(), service_name ), SERVICE_ANY, '')) |
| 2429 | 2767 | self._sendSMBMessage(m) |
| 2558 | 2896 | def _echo_SMB1(self, data, callback, errback, timeout = 30): |
| 2559 | 2897 | messages_history = [ ] |
| 2560 | 2898 | |
| 2899 | if not isinstance(data, type(b'')): | |
| 2900 | raise TypeError('Echo data must be %s not %s' % (type(b'').__name__, type(data).__name__)) | |
| 2901 | ||
| 2561 | 2902 | def echoCB(echo_message, **kwargs): |
| 2562 | 2903 | messages_history.append(echo_message) |
| 2563 | 2904 | if not echo_message.status.hasError: |
| 2570 | 2911 | self.pending_requests[m.mid] = _PendingRequest(m.mid, int(time.time()) + timeout, echoCB, errback) |
| 2571 | 2912 | messages_history.append(m) |
| 2572 | 2913 | |
| 2914 | def _extractLastPathComponent(self, path): | |
| 2915 | return path.replace('\\', '/').split('/')[-1] | |
| 2916 | ||
| 2573 | 2917 | |
| 2574 | 2918 | class SharedDevice: |
| 2575 | 2919 | """ |
| 2576 | 2920 | Contains information about a single shared device on the remote server. |
| 2921 | ||
| 2922 | The following attributes are available: | |
| 2923 | ||
| 2924 | * name : An unicode string containing the name of the shared device | |
| 2925 | * comments : An unicode string containing the user description of the shared device | |
| 2577 | 2926 | """ |
| 2578 | 2927 | |
| 2579 | 2928 | # The following constants are taken from [MS-SRVS]: 2.2.2.4 |
| 2628 | 2977 | |
| 2629 | 2978 | If you encounter *SharedFile* instance where its short_name attribute is empty but the filename attribute contains a short name which does not correspond |
| 2630 | 2979 | 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 |
| 2631 | one of these prohibited characters: "\/[]:+|<>=;?,* (see [MS-CIFS]: 2.2.1.1.1 for more details). | |
| 2980 | one of these prohibited characters: "\\/[]:+|<>=;?,* (see [MS-CIFS]: 2.2.1.1.1 for more details). | |
| 2981 | ||
| 2982 | The following attributes are available: | |
| 2983 | ||
| 2984 | * 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 | |
| 2985 | * 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 | |
| 2986 | * 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 | |
| 2987 | * 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 | |
| 2988 | * file_size : File size in number of bytes | |
| 2989 | * alloc_size : Total number of bytes allocated to store this file | |
| 2990 | * file_attributes : A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3. You can perform bit-wise tests to determine the status of the file using the ATTR_xxx constants in smb_constants.py. | |
| 2991 | * short_name : Unicode string containing the short name of this file (usually in 8.3 notation) | |
| 2992 | * 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. | |
| 2993 | * file_id : Long value representing the file reference number for the file. If the remote system does not support this field, this field will be None or 0. See [MS-FSCC]: 2.4.17 | |
| 2632 | 2994 | """ |
| 2633 | 2995 | |
| 2634 | def __init__(self, create_time, last_access_time, last_write_time, last_attr_change_time, file_size, alloc_size, file_attributes, short_name, filename): | |
| 2996 | def __init__(self, create_time, last_access_time, last_write_time, last_attr_change_time, file_size, alloc_size, file_attributes, short_name, filename, file_id=None): | |
| 2635 | 2997 | 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 |
| 2636 | 2998 | 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 |
| 2637 | 2999 | 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 |
| 2638 | 3000 | 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 |
| 2639 | 3001 | self.file_size = file_size #: File size in number of bytes |
| 2640 | 3002 | self.alloc_size = alloc_size #: Total number of bytes allocated to store this file |
| 2641 | self.file_attributes = file_attributes #: A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3 | |
| 3003 | self.file_attributes = file_attributes #: A SMB_EXT_FILE_ATTR integer value. See [MS-CIFS]: 2.2.1.2.3. You can perform bit-wise tests to determine the status of the file using the ATTR_xxx constants in smb_constants.py. | |
| 2642 | 3004 | self.short_name = short_name #: Unicode string containing the short name of this file (usually in 8.3 notation) |
| 2643 | 3005 | 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. |
| 3006 | self.file_id = file_id #: Long value representing the file reference number for the file. If the remote system does not support this field, this field will be None or 0. See [MS-FSCC]: 2.4.17 | |
| 2644 | 3007 | |
| 2645 | 3008 | @property |
| 2646 | 3009 | def isDirectory(self): |
| 2651 | 3014 | def isReadOnly(self): |
| 2652 | 3015 | """A convenient property to return True if this file resource is read-only on the remote server""" |
| 2653 | 3016 | return bool(self.file_attributes & ATTR_READONLY) |
| 3017 | ||
| 3018 | @property | |
| 3019 | def isNormal(self): | |
| 3020 | """ | |
| 3021 | A convenient property to return True if this is a normal file. | |
| 3022 | ||
| 3023 | Note that pysmb defines a normal file as a file entry that is not read-only, not hidden, not system, not archive and not a directory. | |
| 3024 | It ignores other attributes like compression, indexed, sparse, temporary and encryption. | |
| 3025 | """ | |
| 3026 | return (self.file_attributes==ATTR_NORMAL) or ((self.file_attributes & 0xff)==0) | |
| 2654 | 3027 | |
| 2655 | 3028 | def __unicode__(self): |
| 2656 | 3029 | return 'Shared file: %s (FileSize:%d bytes, isDirectory:%s)' % ( self.filename, self.file_size, self.isDirectory ) |
| 0 | 0 | |
| 1 | import types, hmac, binascii, struct, random | |
| 1 | import types, hmac, binascii, struct, random, string | |
| 2 | from .utils.rc4 import RC4_encrypt | |
| 2 | 3 | from .utils.pyDes import des |
| 3 | 4 | |
| 4 | 5 | try: |
| 57 | 58 | |
| 58 | 59 | NTLM_FLAGS = NTLM_NegotiateUnicode | \ |
| 59 | 60 | NTLM_RequestTarget | \ |
| 61 | NTLM_NegotiateSign | \ | |
| 60 | 62 | NTLM_NegotiateNTLM | \ |
| 61 | 63 | NTLM_NegotiateAlwaysSign | \ |
| 62 | 64 | NTLM_NegotiateExtendedSecurity | \ |
| 63 | 65 | NTLM_NegotiateTargetInfo | \ |
| 64 | 66 | NTLM_NegotiateVersion | \ |
| 65 | 67 | NTLM_Negotiate128 | \ |
| 66 | NTLM_NegotiateKeyExchange | \ | |
| 67 | NTLM_Negotiate56 | |
| 68 | NTLM_NegotiateKeyExchange | |
| 68 | 69 | |
| 69 | 70 | def generateNegotiateMessage(): |
| 70 | 71 | """ |
| 80 | 81 | return s |
| 81 | 82 | |
| 82 | 83 | |
| 83 | def generateAuthenticateMessage(challenge_flags, nt_response, lm_response, session_key, user, domain = 'WORKGROUP', workstation = 'LOCALHOST'): | |
| 84 | def generateAuthenticateMessage(challenge_flags, nt_response, lm_response, request_session_key, user, domain = 'WORKGROUP', workstation = 'LOCALHOST'): | |
| 84 | 85 | """ |
| 85 | 86 | References: |
| 86 | 87 | =========== |
| 88 | 89 | """ |
| 89 | 90 | FORMAT = '<8sIHHIHHIHHIHHIHHIHHII' |
| 90 | 91 | FORMAT_SIZE = struct.calcsize(FORMAT) |
| 92 | ||
| 93 | # [MS-NLMP]: 3.1.5.1.2 | |
| 94 | # http://grutz.jingojango.net/exploits/davenport-ntlm.html | |
| 95 | session_key = session_signing_key = request_session_key | |
| 96 | if challenge_flags & NTLM_NegotiateKeyExchange: | |
| 97 | session_signing_key = "".join([ random.choice(string.digits+string.ascii_letters) for _ in range(16) ]).encode('ascii') | |
| 98 | session_key = RC4_encrypt(request_session_key, session_signing_key) | |
| 91 | 99 | |
| 92 | 100 | lm_response_length = len(lm_response) |
| 93 | 101 | lm_response_offset = FORMAT_SIZE |
| 124 | 132 | session_key_length, session_key_length, session_key_offset, |
| 125 | 133 | auth_flags) |
| 126 | 134 | |
| 127 | return s + lm_response + nt_response + padding + domain_unicode + user_unicode + workstation_unicode + session_key | |
| 135 | return s + lm_response + nt_response + padding + domain_unicode + user_unicode + workstation_unicode + session_key, session_signing_key | |
| 128 | 136 | |
| 129 | 137 | |
| 130 | 138 | def decodeChallengeMessage(ntlm_data): |
| 160 | 168 | d = MD4() |
| 161 | 169 | d.update(password.encode('UTF-16LE')) |
| 162 | 170 | ntlm_hash = d.digest() # The NT password hash |
| 163 | response_key = hmac.new(ntlm_hash, (user.upper() + domain).encode('UTF-16LE')).digest() # The NTLMv2 password hash. In [MS-NLMP], this is the result of NTOWFv2 and LMOWFv2 functions | |
| 171 | response_key = hmac.new(ntlm_hash, (user.upper() + domain).encode('UTF-16LE'), 'md5').digest() # The NTLMv2 password hash. In [MS-NLMP], this is the result of NTOWFv2 and LMOWFv2 functions | |
| 164 | 172 | temp = b'\x01\x01' + b'\0'*6 + client_timestamp + client_challenge + b'\0'*4 + server_info |
| 165 | ntproofstr = hmac.new(response_key, server_challenge + temp).digest() | |
| 173 | ntproofstr = hmac.new(response_key, server_challenge + temp, 'md5').digest() | |
| 166 | 174 | |
| 167 | 175 | nt_challenge_response = ntproofstr + temp |
| 168 | lm_challenge_response = hmac.new(response_key, server_challenge + client_challenge).digest() + client_challenge | |
| 169 | session_key = hmac.new(response_key, ntproofstr).digest() | |
| 176 | lm_challenge_response = hmac.new(response_key, server_challenge + client_challenge, 'md5').digest() + client_challenge | |
| 177 | session_key = hmac.new(response_key, ntproofstr, 'md5').digest() | |
| 170 | 178 | |
| 171 | 179 | return nt_challenge_response, lm_challenge_response, session_key |
| 172 | 180 | |
| 0 | """ | |
| 1 | This module implements security descriptors, and the partial structures | |
| 2 | used in them, as specified in [MS-DTYP]. | |
| 3 | """ | |
| 4 | ||
| 5 | import struct | |
| 6 | ||
| 7 | ||
| 8 | # Security descriptor control flags | |
| 9 | # [MS-DTYP]: 2.4.6 | |
| 10 | SECURITY_DESCRIPTOR_OWNER_DEFAULTED = 0x0001 | |
| 11 | SECURITY_DESCRIPTOR_GROUP_DEFAULTED = 0x0002 | |
| 12 | SECURITY_DESCRIPTOR_DACL_PRESENT = 0x0004 | |
| 13 | SECURITY_DESCRIPTOR_DACL_DEFAULTED = 0x0008 | |
| 14 | SECURITY_DESCRIPTOR_SACL_PRESENT = 0x0010 | |
| 15 | SECURITY_DESCRIPTOR_SACL_DEFAULTED = 0x0020 | |
| 16 | SECURITY_DESCRIPTOR_SERVER_SECURITY = 0x0040 | |
| 17 | SECURITY_DESCRIPTOR_DACL_TRUSTED = 0x0080 | |
| 18 | SECURITY_DESCRIPTOR_DACL_COMPUTED_INHERITANCE_REQUIRED = 0x0100 | |
| 19 | SECURITY_DESCRIPTOR_SACL_COMPUTED_INHERITANCE_REQUIRED = 0x0200 | |
| 20 | SECURITY_DESCRIPTOR_DACL_AUTO_INHERITED = 0x0400 | |
| 21 | SECURITY_DESCRIPTOR_SACL_AUTO_INHERITED = 0x0800 | |
| 22 | SECURITY_DESCRIPTOR_DACL_PROTECTED = 0x1000 | |
| 23 | SECURITY_DESCRIPTOR_SACL_PROTECTED = 0x2000 | |
| 24 | SECURITY_DESCRIPTOR_RM_CONTROL_VALID = 0x4000 | |
| 25 | SECURITY_DESCRIPTOR_SELF_RELATIVE = 0x8000 | |
| 26 | ||
| 27 | # ACE types | |
| 28 | # [MS-DTYP]: 2.4.4.1 | |
| 29 | ACE_TYPE_ACCESS_ALLOWED = 0x00 | |
| 30 | ACE_TYPE_ACCESS_DENIED = 0x01 | |
| 31 | ACE_TYPE_SYSTEM_AUDIT = 0x02 | |
| 32 | ACE_TYPE_SYSTEM_ALARM = 0x03 | |
| 33 | ACE_TYPE_ACCESS_ALLOWED_COMPOUND = 0x04 | |
| 34 | ACE_TYPE_ACCESS_ALLOWED_OBJECT = 0x05 | |
| 35 | ACE_TYPE_ACCESS_DENIED_OBJECT = 0x06 | |
| 36 | ACE_TYPE_SYSTEM_AUDIT_OBJECT = 0x07 | |
| 37 | ACE_TYPE_SYSTEM_ALARM_OBJECT = 0x08 | |
| 38 | ACE_TYPE_ACCESS_ALLOWED_CALLBACK = 0x09 | |
| 39 | ACE_TYPE_ACCESS_DENIED_CALLBACK = 0x0A | |
| 40 | ACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT = 0x0B | |
| 41 | ACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT = 0x0C | |
| 42 | ACE_TYPE_SYSTEM_AUDIT_CALLBACK = 0x0D | |
| 43 | ACE_TYPE_SYSTEM_ALARM_CALLBACK = 0x0E | |
| 44 | ACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT = 0x0F | |
| 45 | ACE_TYPE_SYSTEM_ALARM_CALLBACK_OBJECT = 0x10 | |
| 46 | ACE_TYPE_SYSTEM_MANDATORY_LABEL = 0x11 | |
| 47 | ACE_TYPE_SYSTEM_RESOURCE_ATTRIBUTE = 0x12 | |
| 48 | ACE_TYPE_SYSTEM_SCOPED_POLICY_ID = 0x13 | |
| 49 | ||
| 50 | # ACE flags | |
| 51 | # [MS-DTYP]: 2.4.4.1 | |
| 52 | ACE_FLAG_OBJECT_INHERIT = 0x01 | |
| 53 | ACE_FLAG_CONTAINER_INHERIT = 0x02 | |
| 54 | ACE_FLAG_NO_PROPAGATE_INHERIT = 0x04 | |
| 55 | ACE_FLAG_INHERIT_ONLY = 0x08 | |
| 56 | ACE_FLAG_INHERITED = 0x10 | |
| 57 | ACE_FLAG_SUCCESSFUL_ACCESS = 0x40 | |
| 58 | ACE_FLAG_FAILED_ACCESS = 0x80 | |
| 59 | ||
| 60 | # Pre-defined well-known SIDs | |
| 61 | # [MS-DTYP]: 2.4.2.4 | |
| 62 | SID_NULL = "S-1-0-0" | |
| 63 | SID_EVERYONE = "S-1-1-0" | |
| 64 | SID_LOCAL = "S-1-2-0" | |
| 65 | SID_CONSOLE_LOGON = "S-1-2-1" | |
| 66 | SID_CREATOR_OWNER = "S-1-3-0" | |
| 67 | SID_CREATOR_GROUP = "S-1-3-1" | |
| 68 | SID_OWNER_SERVER = "S-1-3-2" | |
| 69 | SID_GROUP_SERVER = "S-1-3-3" | |
| 70 | SID_OWNER_RIGHTS = "S-1-3-4" | |
| 71 | SID_NT_AUTHORITY = "S-1-5" | |
| 72 | SID_DIALUP = "S-1-5-1" | |
| 73 | SID_NETWORK = "S-1-5-2" | |
| 74 | SID_BATCH = "S-1-5-3" | |
| 75 | SID_INTERACTIVE = "S-1-5-4" | |
| 76 | SID_SERVICE = "S-1-5-6" | |
| 77 | SID_ANONYMOUS = "S-1-5-7" | |
| 78 | SID_PROXY = "S-1-5-8" | |
| 79 | SID_ENTERPRISE_DOMAIN_CONTROLLERS = "S-1-5-9" | |
| 80 | SID_PRINCIPAL_SELF = "S-1-5-10" | |
| 81 | SID_AUTHENTICATED_USERS = "S-1-5-11" | |
| 82 | SID_RESTRICTED_CODE = "S-1-5-12" | |
| 83 | SID_TERMINAL_SERVER_USER = "S-1-5-13" | |
| 84 | SID_REMOTE_INTERACTIVE_LOGON = "S-1-5-14" | |
| 85 | SID_THIS_ORGANIZATION = "S-1-5-15" | |
| 86 | SID_IUSR = "S-1-5-17" | |
| 87 | SID_LOCAL_SYSTEM = "S-1-5-18" | |
| 88 | SID_LOCAL_SERVICE = "S-1-5-19" | |
| 89 | SID_NETWORK_SERVICE = "S-1-5-20" | |
| 90 | SID_COMPOUNDED_AUTHENTICATION = "S-1-5-21-0-0-0-496" | |
| 91 | SID_CLAIMS_VALID = "S-1-5-21-0-0-0-497" | |
| 92 | SID_BUILTIN_ADMINISTRATORS = "S-1-5-32-544" | |
| 93 | SID_BUILTIN_USERS = "S-1-5-32-545" | |
| 94 | SID_BUILTIN_GUESTS = "S-1-5-32-546" | |
| 95 | SID_POWER_USERS = "S-1-5-32-547" | |
| 96 | SID_ACCOUNT_OPERATORS = "S-1-5-32-548" | |
| 97 | SID_SERVER_OPERATORS = "S-1-5-32-549" | |
| 98 | SID_PRINTER_OPERATORS = "S-1-5-32-550" | |
| 99 | SID_BACKUP_OPERATORS = "S-1-5-32-551" | |
| 100 | SID_REPLICATOR = "S-1-5-32-552" | |
| 101 | SID_ALIAS_PREW2KCOMPACC = "S-1-5-32-554" | |
| 102 | SID_REMOTE_DESKTOP = "S-1-5-32-555" | |
| 103 | SID_NETWORK_CONFIGURATION_OPS = "S-1-5-32-556" | |
| 104 | SID_INCOMING_FOREST_TRUST_BUILDERS = "S-1-5-32-557" | |
| 105 | SID_PERFMON_USERS = "S-1-5-32-558" | |
| 106 | SID_PERFLOG_USERS = "S-1-5-32-559" | |
| 107 | SID_WINDOWS_AUTHORIZATION_ACCESS_GROUP = "S-1-5-32-560" | |
| 108 | SID_TERMINAL_SERVER_LICENSE_SERVERS = "S-1-5-32-561" | |
| 109 | SID_DISTRIBUTED_COM_USERS = "S-1-5-32-562" | |
| 110 | SID_IIS_IUSRS = "S-1-5-32-568" | |
| 111 | SID_CRYPTOGRAPHIC_OPERATORS = "S-1-5-32-569" | |
| 112 | SID_EVENT_LOG_READERS = "S-1-5-32-573" | |
| 113 | SID_CERTIFICATE_SERVICE_DCOM_ACCESS = "S-1-5-32-574" | |
| 114 | SID_RDS_REMOTE_ACCESS_SERVERS = "S-1-5-32-575" | |
| 115 | SID_RDS_ENDPOINT_SERVERS = "S-1-5-32-576" | |
| 116 | SID_RDS_MANAGEMENT_SERVERS = "S-1-5-32-577" | |
| 117 | SID_HYPER_V_ADMINS = "S-1-5-32-578" | |
| 118 | SID_ACCESS_CONTROL_ASSISTANCE_OPS = "S-1-5-32-579" | |
| 119 | SID_REMOTE_MANAGEMENT_USERS = "S-1-5-32-580" | |
| 120 | SID_WRITE_RESTRICTED_CODE = "S-1-5-33" | |
| 121 | SID_NTLM_AUTHENTICATION = "S-1-5-64-10" | |
| 122 | SID_SCHANNEL_AUTHENTICATION = "S-1-5-64-14" | |
| 123 | SID_DIGEST_AUTHENTICATION = "S-1-5-64-21" | |
| 124 | SID_THIS_ORGANIZATION_CERTIFICATE = "S-1-5-65-1" | |
| 125 | SID_NT_SERVICE = "S-1-5-80" | |
| 126 | SID_USER_MODE_DRIVERS = "S-1-5-84-0-0-0-0-0" | |
| 127 | SID_LOCAL_ACCOUNT = "S-1-5-113" | |
| 128 | SID_LOCAL_ACCOUNT_AND_MEMBER_OF_ADMINISTRATORS_GROUP = "S-1-5-114" | |
| 129 | SID_OTHER_ORGANIZATION = "S-1-5-1000" | |
| 130 | SID_ALL_APP_PACKAGES = "S-1-15-2-1" | |
| 131 | SID_ML_UNTRUSTED = "S-1-16-0" | |
| 132 | SID_ML_LOW = "S-1-16-4096" | |
| 133 | SID_ML_MEDIUM = "S-1-16-8192" | |
| 134 | SID_ML_MEDIUM_PLUS = "S-1-16-8448" | |
| 135 | SID_ML_HIGH = "S-1-16-12288" | |
| 136 | SID_ML_SYSTEM = "S-1-16-16384" | |
| 137 | SID_ML_PROTECTED_PROCESS = "S-1-16-20480" | |
| 138 | SID_AUTHENTICATION_AUTHORITY_ASSERTED_IDENTITY = "S-1-18-1" | |
| 139 | SID_SERVICE_ASSERTED_IDENTITY = "S-1-18-2" | |
| 140 | SID_FRESH_PUBLIC_KEY_IDENTITY = "S-1-18-3" | |
| 141 | SID_KEY_TRUST_IDENTITY = "S-1-18-4" | |
| 142 | SID_KEY_PROPERTY_MFA = "S-1-18-5" | |
| 143 | SID_KEY_PROPERTY_ATTESTATION = "S-1-18-6" | |
| 144 | ||
| 145 | ||
| 146 | class SID(object): | |
| 147 | """ | |
| 148 | A Windows security identifier. Represents a single principal, such a | |
| 149 | user or a group, as a sequence of numbers consisting of the revision, | |
| 150 | identifier authority, and a variable-length list of subauthorities. | |
| 151 | ||
| 152 | See [MS-DTYP]: 2.4.2 | |
| 153 | """ | |
| 154 | def __init__(self, revision, identifier_authority, subauthorities): | |
| 155 | #: Revision, should always be 1. | |
| 156 | self.revision = revision | |
| 157 | #: An integer representing the identifier authority. | |
| 158 | self.identifier_authority = identifier_authority | |
| 159 | #: A list of integers representing all subauthorities. | |
| 160 | self.subauthorities = subauthorities | |
| 161 | ||
| 162 | def __str__(self): | |
| 163 | """ | |
| 164 | String representation, as specified in [MS-DTYP]: 2.4.2.1 | |
| 165 | """ | |
| 166 | if self.identifier_authority >= 2**32: | |
| 167 | id_auth = '%#x' % (self.identifier_authority,) | |
| 168 | else: | |
| 169 | id_auth = self.identifier_authority | |
| 170 | auths = [self.revision, id_auth] + self.subauthorities | |
| 171 | return 'S-' + '-'.join(str(subauth) for subauth in auths) | |
| 172 | ||
| 173 | def __repr__(self): | |
| 174 | return 'SID(%r)' % (str(self),) | |
| 175 | ||
| 176 | @classmethod | |
| 177 | def from_bytes(cls, data, return_tail=False): | |
| 178 | revision, subauth_count = struct.unpack('<BB', data[:2]) | |
| 179 | identifier_authority = struct.unpack('>Q', b'\x00\x00' + data[2:8])[0] | |
| 180 | subauth_data = data[8:] | |
| 181 | subauthorities = [struct.unpack('<L', subauth_data[4 * i : 4 * (i+1)])[0] | |
| 182 | for i in range(subauth_count)] | |
| 183 | sid = cls(revision, identifier_authority, subauthorities) | |
| 184 | if return_tail: | |
| 185 | return sid, subauth_data[4 * subauth_count :] | |
| 186 | return sid | |
| 187 | ||
| 188 | ||
| 189 | class ACE(object): | |
| 190 | """ | |
| 191 | Represents a single access control entry. | |
| 192 | ||
| 193 | See [MS-DTYP]: 2.4.4 | |
| 194 | """ | |
| 195 | HEADER_FORMAT = '<BBH' | |
| 196 | ||
| 197 | def __init__(self, type_, flags, mask, sid, additional_data): | |
| 198 | #: An integer representing the type of the ACE. One of the | |
| 199 | #: ``ACE_TYPE_*`` constants. Corresponds to the ``AceType`` field | |
| 200 | #: from [MS-DTYP] 2.4.4.1. | |
| 201 | self.type = type_ | |
| 202 | #: An integer bitmask with ACE flags, corresponds to the | |
| 203 | #: ``AceFlags`` field. | |
| 204 | self.flags = flags | |
| 205 | #: An integer representing the ``ACCESS_MASK`` as specified in | |
| 206 | #: [MS-DTYP] 2.4.3. | |
| 207 | self.mask = mask | |
| 208 | #: The :class:`SID` of a trustee. | |
| 209 | self.sid = sid | |
| 210 | #: A dictionary of additional fields present in the ACE, depending | |
| 211 | #: on the type. The following fields can be present: | |
| 212 | #: | |
| 213 | #: * ``flags`` | |
| 214 | #: * ``object_type`` | |
| 215 | #: * ``inherited_object_type`` | |
| 216 | #: * ``application_data`` | |
| 217 | #: * ``attribute_data`` | |
| 218 | self.additional_data = additional_data | |
| 219 | ||
| 220 | def __repr__(self): | |
| 221 | return "ACE(type=%#04x, flags=%#04x, mask=%#010x, sid=%s)" % ( | |
| 222 | self.type, self.flags, self.mask, self.sid, | |
| 223 | ) | |
| 224 | ||
| 225 | @property | |
| 226 | def isInheritOnly(self): | |
| 227 | """Convenience property which indicates if this ACE is inherit | |
| 228 | only, meaning that it doesn't apply to the object itself.""" | |
| 229 | return bool(self.flags & ACE_FLAG_INHERIT_ONLY) | |
| 230 | ||
| 231 | @classmethod | |
| 232 | def from_bytes(cls, data): | |
| 233 | header_size = struct.calcsize(cls.HEADER_FORMAT) | |
| 234 | header = data[:header_size] | |
| 235 | type_, flags, size = struct.unpack(cls.HEADER_FORMAT, header) | |
| 236 | ||
| 237 | assert len(data) >= size | |
| 238 | ||
| 239 | body = data[header_size:size] | |
| 240 | additional_data = {} | |
| 241 | ||
| 242 | # In all ACE types, the mask immediately follows the header. | |
| 243 | mask = struct.unpack('<I', body[:4])[0] | |
| 244 | body = body[4:] | |
| 245 | ||
| 246 | # All OBJECT-type ACEs contain additional flags, and two GUIDs as | |
| 247 | # the following fields. | |
| 248 | if type_ in (ACE_TYPE_ACCESS_ALLOWED_OBJECT, | |
| 249 | ACE_TYPE_ACCESS_DENIED_OBJECT, | |
| 250 | ACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT, | |
| 251 | ACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT, | |
| 252 | ACE_TYPE_SYSTEM_AUDIT_OBJECT, | |
| 253 | ACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT): | |
| 254 | additional_data['flags'] = struct.unpack('<I', body[:4])[0] | |
| 255 | additional_data['object_type'] = body[4:20] | |
| 256 | additional_data['inherited_object_type'] = body[20:36] | |
| 257 | body = body[36:] | |
| 258 | ||
| 259 | # Then the SID in all types. | |
| 260 | sid, body = SID.from_bytes(body, return_tail=True) | |
| 261 | ||
| 262 | # CALLBACK-type ACEs (and for some obscure reason, | |
| 263 | # SYSTEM_AUDIT_OBJECT) have a final tail of application data. | |
| 264 | if type_ in (ACE_TYPE_ACCESS_ALLOWED_CALLBACK, | |
| 265 | ACE_TYPE_ACCESS_DENIED_CALLBACK, | |
| 266 | ACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT, | |
| 267 | ACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT, | |
| 268 | ACE_TYPE_SYSTEM_AUDIT_OBJECT, | |
| 269 | ACE_TYPE_SYSTEM_AUDIT_CALLBACK, | |
| 270 | ACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT): | |
| 271 | additional_data['application_data'] = body | |
| 272 | ||
| 273 | # SYSTEM_RESOURCE_ATTRIBUTE ACEs have a tail of attribute data. | |
| 274 | if type_ == ACE_TYPE_SYSTEM_RESOURCE_ATTRIBUTE: | |
| 275 | additional_data['attribute_data'] = body | |
| 276 | ||
| 277 | return cls(type_, flags, mask, sid, additional_data) | |
| 278 | ||
| 279 | ||
| 280 | class ACL(object): | |
| 281 | """ | |
| 282 | Access control list, encapsulating a sequence of access control | |
| 283 | entries. | |
| 284 | ||
| 285 | See [MS-DTYP]: 2.4.5 | |
| 286 | """ | |
| 287 | HEADER_FORMAT = '<BBHHH' | |
| 288 | ||
| 289 | def __init__(self, revision, aces): | |
| 290 | #: Integer value of the revision. | |
| 291 | self.revision = revision | |
| 292 | #: List of :class:`ACE` instances. | |
| 293 | self.aces = aces | |
| 294 | ||
| 295 | def __repr__(self): | |
| 296 | return "ACL(%r)" % (self.aces,) | |
| 297 | ||
| 298 | @classmethod | |
| 299 | def from_bytes(cls, data): | |
| 300 | revision = None | |
| 301 | aces = [] | |
| 302 | ||
| 303 | header_size = struct.calcsize(cls.HEADER_FORMAT) | |
| 304 | header, remaining = data[:header_size], data[header_size:] | |
| 305 | revision, sbz1, size, count, sbz2 = struct.unpack(cls.HEADER_FORMAT, header) | |
| 306 | ||
| 307 | assert len(data) >= size | |
| 308 | ||
| 309 | for i in range(count): | |
| 310 | ace_size = struct.unpack('<H', remaining[2:4])[0] | |
| 311 | ace_data, remaining = remaining[:ace_size], remaining[ace_size:] | |
| 312 | aces.append(ACE.from_bytes(ace_data)) | |
| 313 | ||
| 314 | return cls(revision, aces) | |
| 315 | ||
| 316 | ||
| 317 | class SecurityDescriptor(object): | |
| 318 | """ | |
| 319 | Represents a security descriptor. | |
| 320 | ||
| 321 | See [MS-DTYP]: 2.4.6 | |
| 322 | """ | |
| 323 | ||
| 324 | HEADER_FORMAT = '<BBHIIII' | |
| 325 | ||
| 326 | def __init__(self, flags, owner, group, dacl, sacl): | |
| 327 | #: Integer bitmask of control flags. Corresponds to the | |
| 328 | #: ``Control`` field in [MS-DTYP] 2.4.6. | |
| 329 | self.flags = flags | |
| 330 | #: Instance of :class:`SID` representing the owner user. | |
| 331 | self.owner = owner | |
| 332 | #: Instance of :class:`SID` representing the owner group. | |
| 333 | self.group = group | |
| 334 | #: Instance of :class:`ACL` representing the discretionary access | |
| 335 | #: control list, which specifies access restrictions of an object. | |
| 336 | self.dacl = dacl | |
| 337 | #: Instance of :class:`ACL` representing the system access control | |
| 338 | #: list, which specifies audit logging of an object. | |
| 339 | self.sacl = sacl | |
| 340 | ||
| 341 | @classmethod | |
| 342 | def from_bytes(cls, data): | |
| 343 | owner = None | |
| 344 | group = None | |
| 345 | dacl = None | |
| 346 | sacl = None | |
| 347 | ||
| 348 | header = data[:struct.calcsize(cls.HEADER_FORMAT)] | |
| 349 | (revision, sbz1, flags, owner_offset, group_offset, sacl_offset, | |
| 350 | dacl_offset) = struct.unpack(cls.HEADER_FORMAT, header) | |
| 351 | ||
| 352 | assert revision == 1 | |
| 353 | assert flags & SECURITY_DESCRIPTOR_SELF_RELATIVE | |
| 354 | for offset in (owner_offset, group_offset, sacl_offset, dacl_offset): | |
| 355 | assert 0 <= offset < len(data) | |
| 356 | ||
| 357 | if owner_offset: | |
| 358 | owner = SID.from_bytes(data[owner_offset:]) | |
| 359 | if group_offset: | |
| 360 | group = SID.from_bytes(data[group_offset:]) | |
| 361 | if dacl_offset: | |
| 362 | dacl = ACL.from_bytes(data[dacl_offset:]) | |
| 363 | if sacl_offset: | |
| 364 | sacl = ACL.from_bytes(data[sacl_offset:]) | |
| 365 | ||
| 366 | return cls(flags, owner, group, dacl, sacl) |
| 269 | 269 | STRUCTURE_FORMAT = "<HHHH" |
| 270 | 270 | STRUCTURE_SIZE = struct.calcsize(STRUCTURE_FORMAT) |
| 271 | 271 | |
| 272 | @property | |
| 273 | def isGuestSession(self): | |
| 274 | return (self.session_flags & 0x0001) > 0 # SMB2_SESSION_FLAG_IS_GUEST | |
| 275 | ||
| 276 | @property | |
| 277 | def isAnonymousSession(self): | |
| 278 | return (self.session_flags & 0x0002) > 0 # SMB2_SESSION_FLAG_IS_NULL | |
| 279 | ||
| 272 | 280 | def decode(self, message): |
| 273 | 281 | assert message.command == SMB2_COM_SESSION_SETUP |
| 274 | 282 | |
| 361 | 369 | |
| 362 | 370 | def prepare(self, message): |
| 363 | 371 | buf = self.filename.encode('UTF-16LE') |
| 372 | filename_len = len(buf) | |
| 364 | 373 | if self.create_context_data: |
| 365 | 374 | n = SMB2Message.HEADER_SIZE + self.STRUCTURE_SIZE + len(buf) |
| 366 | 375 | if n % 8 != 0: |
| 388 | 397 | self.create_disp, |
| 389 | 398 | self.create_options, |
| 390 | 399 | SMB2Message.HEADER_SIZE + self.STRUCTURE_SIZE, # NameOffset |
| 391 | len(self.filename)*2, # NameLength in bytes | |
| 400 | filename_len, # Length of encoded filename in bytes | |
| 392 | 401 | create_context_offset, # CreateContextOffset |
| 393 | 402 | len(self.create_context_data) # CreateContextLength |
| 394 | 403 | ) + buf |
| 114 | 114 | FILE_READ_EA = 0x08 |
| 115 | 115 | FILE_WRITE_EA = 0x10 |
| 116 | 116 | FILE_EXECUTE = 0x20 |
| 117 | FILE_DELETE_CHILD = 0x40 | |
| 117 | 118 | FILE_READ_ATTRIBUTES = 0x80 |
| 118 | 119 | FILE_WRITE_ATTRIBUTES = 0x0100 |
| 119 | 120 | DELETE = 0x010000 |
| 224 | 225 | SMB_FILE_ATTRIBUTE_READONLY = 0x01 |
| 225 | 226 | SMB_FILE_ATTRIBUTE_HIDDEN = 0x02 |
| 226 | 227 | SMB_FILE_ATTRIBUTE_SYSTEM = 0x04 |
| 227 | SMB_FILE_ATTRIBUTE_VOLUME = 0x08 | |
| 228 | SMB_FILE_ATTRIBUTE_VOLUME = 0x08 # Unsupported for listPath() operations | |
| 228 | 229 | SMB_FILE_ATTRIBUTE_DIRECTORY = 0x10 |
| 229 | 230 | SMB_FILE_ATTRIBUTE_ARCHIVE = 0x20 |
| 231 | # SMB_FILE_ATTRIBUTE_INCL_NORMAL is a special placeholder to include normal files | |
| 232 | # with other search attributes for listPath() operations. It is not defined in the MS-CIFS specs. | |
| 233 | SMB_FILE_ATTRIBUTE_INCL_NORMAL = 0x10000 | |
| 234 | # Do not use the following values for listPath() operations as they are not supported for SMB2 | |
| 230 | 235 | SMB_SEARCH_ATTRIBUTE_READONLY = 0x0100 |
| 231 | 236 | SMB_SEARCH_ATTRIBUTE_HIDDEN = 0x0200 |
| 232 | 237 | SMB_SEARCH_ATTRIBUTE_SYSTEM = 0x0400 |
| 236 | 241 | # Bitmask for OptionalSupport field in SMB_COM_TREE_CONNECT_ANDX response |
| 237 | 242 | SMB_TREE_CONNECTX_SUPPORT_SEARCH = 0x0001 |
| 238 | 243 | SMB_TREE_CONNECTX_SUPPORT_DFS = 0x0002 |
| 244 | ||
| 245 | # Bitmask for security information fields, specified as | |
| 246 | # AdditionalInformation in SMB2 | |
| 247 | # [MS-SMB]: 2.2.7.4 | |
| 248 | # [MS-SMB2]: 2.2.37 | |
| 249 | OWNER_SECURITY_INFORMATION = 0x00000001 | |
| 250 | GROUP_SECURITY_INFORMATION = 0x00000002 | |
| 251 | DACL_SECURITY_INFORMATION = 0x00000004 | |
| 252 | SACL_SECURITY_INFORMATION = 0x00000008 | |
| 253 | LABEL_SECURITY_INFORMATION = 0x00000010 | |
| 254 | ATTRIBUTE_SECURITY_INFORMATION = 0x00000020 | |
| 255 | SCOPE_SECURITY_INFORMATION = 0x00000040 | |
| 256 | BACKUP_SECURITY_INFORMATION = 0x00010000 | |
| 141 | 141 | self.parameters_data = b'' |
| 142 | 142 | self.data = b'' |
| 143 | 143 | self.payload = None |
| 144 | ||
| 145 | @property | |
| 146 | def isAsync(self): | |
| 147 | return bool(self.flags & SMB2_FLAGS_ASYNC_COMMAND) | |
| 144 | 148 | |
| 145 | 149 | @property |
| 146 | 150 | def isReply(self): |
| 1278 | 1282 | - [MS-CIFS]: 2.2.4.39.1 |
| 1279 | 1283 | """ |
| 1280 | 1284 | |
| 1281 | def __init__(self, echo_data = '', echo_count = 1): | |
| 1285 | def __init__(self, echo_data = b'', echo_count = 1): | |
| 1282 | 1286 | self.echo_count = echo_count |
| 1283 | 1287 | self.echo_data = echo_data |
| 1284 | 1288 | |
| 81 | 81 | dest.C = self.C |
| 82 | 82 | dest.D = self.D |
| 83 | 83 | dest.count = self.count |
| 84 | for i in range(self.count): | |
| 84 | for i in range(int(self.count)): | |
| 85 | 85 | dest.buf[i] = self.buf[i] |
| 86 | 86 | |
| 87 | 87 | return dest |
| 88 | 88 | |
| 89 | 89 | #----------------------------------------------------- |
| 90 | 90 | def update(self, str): |
| 91 | ||
| 92 | buf = [] | |
| 93 | for i in str: buf.append(ord(i)) | |
| 91 | if isinstance(str, bytes): | |
| 92 | buf = list(str) | |
| 93 | else: | |
| 94 | buf = [ord(i) for i in str] | |
| 95 | ||
| 94 | 96 | ilen = U32(len(buf)) |
| 95 | 97 | |
| 96 | 98 | # check if the first length is out of range |
| 226 | 228 | res[14]=(temp.D >> 16) & U32(0xFF) |
| 227 | 229 | res[15]=(temp.D >> 24) & U32(0xFF) |
| 228 | 230 | |
| 229 | return int_array2str(res) | |
| 231 | return int_array2str(res).encode('UTF-16LE') | |
| 230 | 232 | |
| 231 | 233 | #==================================================================== |
| 232 | 234 | # helpers |
| 0 | ||
| 1 | def RC4_encrypt(key, data): | |
| 2 | S = list(range(256)) | |
| 3 | j = 0 | |
| 4 | ||
| 5 | key_len = len(key) | |
| 6 | for i in list(range(256)): | |
| 7 | j = (j + S[i] + key[i % key_len]) % 256 | |
| 8 | S[i], S[j] = S[j], S[i] | |
| 9 | ||
| 10 | j = 0 | |
| 11 | y = 0 | |
| 12 | out = [] | |
| 13 | ||
| 14 | for char in data: | |
| 15 | j = (j + 1) % 256 | |
| 16 | y = (y + S[j]) % 256 | |
| 17 | S[j], S[y] = S[y], S[j] | |
| 18 | ||
| 19 | out.append(char ^ S[(S[j] + S[y]) % 256]) | |
| 20 | ||
| 21 | return bytes(out) |
| 0 | 0 | |
| 1 | from nose2.tools.decorators import with_teardown | |
| 1 | 2 | from smb.SMBConnection import SMBConnection |
| 3 | from smb import smb_structs | |
| 2 | 4 | from .util import getConnectionInfo |
| 3 | from nose.tools import with_setup | |
| 4 | from smb import smb_structs | |
| 5 | 5 | |
| 6 | conn = None | |
| 6 | conn, conn2, conn3 = None, None, None | |
| 7 | 7 | |
| 8 | 8 | def teardown_func(): |
| 9 | global conn | |
| 10 | conn.close() | |
| 9 | global conn, conn2, conn3 | |
| 10 | if conn: | |
| 11 | conn.close() | |
| 12 | if conn2: | |
| 13 | conn2.close() | |
| 14 | if conn3: | |
| 15 | conn3.close(); | |
| 11 | 16 | |
| 12 | @with_setup(teardown = teardown_func) | |
| 17 | @with_teardown(teardown_func) | |
| 13 | 18 | def test_NTLMv1_auth_SMB1(): |
| 14 | global conn | |
| 19 | global conn, conn2, conn3 | |
| 15 | 20 | smb_structs.SUPPORT_SMB2 = False |
| 16 | 21 | info = getConnectionInfo() |
| 17 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False) | |
| 22 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 18 | 23 | assert conn.connect(info['server_ip'], info['server_port']) |
| 19 | 24 | |
| 20 | @with_setup(teardown = teardown_func) | |
| 21 | def test_NTLMv2_auth_SMB1(): | |
| 22 | global conn | |
| 25 | conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 26 | assert not conn2.connect(info['server_ip'], info['server_port']) | |
| 27 | ||
| 28 | conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 29 | assert not conn3.connect(info['server_ip'], info['server_port']) | |
| 30 | ||
| 31 | @with_teardown(teardown_func) | |
| 32 | def test_NTLMv1_auth_SMB1_callable_password(): | |
| 33 | global conn, conn2, conn3 | |
| 23 | 34 | smb_structs.SUPPORT_SMB2 = False |
| 24 | 35 | info = getConnectionInfo() |
| 25 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 36 | conn = SMBConnection(info['user'], lambda: info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 26 | 37 | assert conn.connect(info['server_ip'], info['server_port']) |
| 27 | 38 | |
| 28 | @with_setup(teardown = teardown_func) | |
| 39 | conn2 = SMBConnection(info['user'], lambda: 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 40 | assert not conn2.connect(info['server_ip'], info['server_port']) | |
| 41 | ||
| 42 | conn3 = SMBConnection('INVALIDUSER', lambda: 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 43 | assert not conn3.connect(info['server_ip'], info['server_port']) | |
| 44 | ||
| 45 | @with_teardown(teardown_func) | |
| 46 | def test_NTLMv2_auth_SMB1(): | |
| 47 | global conn, conn2, conn3 | |
| 48 | smb_structs.SUPPORT_SMB2 = False | |
| 49 | info = getConnectionInfo() | |
| 50 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 51 | assert conn.connect(info['server_ip'], info['server_port']) | |
| 52 | ||
| 53 | conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 54 | assert not conn2.connect(info['server_ip'], info['server_port']) | |
| 55 | ||
| 56 | conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 57 | assert not conn3.connect(info['server_ip'], info['server_port']) | |
| 58 | ||
| 59 | @with_teardown(teardown_func) | |
| 29 | 60 | def test_NTLMv1_auth_SMB2(): |
| 30 | global conn | |
| 61 | global conn, conn2, conn3 | |
| 31 | 62 | smb_structs.SUPPORT_SMB2 = True |
| 32 | 63 | info = getConnectionInfo() |
| 33 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False) | |
| 64 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 34 | 65 | assert conn.connect(info['server_ip'], info['server_port']) |
| 35 | 66 | |
| 36 | @with_setup(teardown = teardown_func) | |
| 67 | conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 68 | assert not conn2.connect(info['server_ip'], info['server_port']) | |
| 69 | ||
| 70 | conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = False, is_direct_tcp = True) | |
| 71 | assert not conn3.connect(info['server_ip'], info['server_port']) | |
| 72 | ||
| 73 | @with_teardown(teardown_func) | |
| 37 | 74 | def test_NTLMv2_auth_SMB2(): |
| 38 | global conn | |
| 75 | global conn, conn2, conn3 | |
| 39 | 76 | smb_structs.SUPPORT_SMB2 = True |
| 40 | 77 | info = getConnectionInfo() |
| 41 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 78 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 42 | 79 | assert conn.connect(info['server_ip'], info['server_port']) |
| 80 | ||
| 81 | conn2 = SMBConnection(info['user'], 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 82 | assert not conn2.connect(info['server_ip'], info['server_port']) | |
| 83 | ||
| 84 | conn3 = SMBConnection('INVALIDUSER', 'wrongPass', info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 85 | assert not conn3.connect(info['server_ip'], info['server_port']) |
| 0 | 0 | # -*- coding: utf-8 -*- |
| 1 | 1 | |
| 2 | 2 | import os, time, random |
| 3 | from nose2.tools.decorators import with_setup, with_teardown | |
| 3 | 4 | from smb.SMBConnection import SMBConnection |
| 5 | from smb import smb_structs | |
| 4 | 6 | from .util import getConnectionInfo |
| 5 | from nose.tools import with_setup | |
| 6 | from smb import smb_structs | |
| 7 | 7 | |
| 8 | 8 | conn = None |
| 9 | 9 | |
| 12 | 12 | smb_structs.SUPPORT_SMB2 = False |
| 13 | 13 | |
| 14 | 14 | info = getConnectionInfo() |
| 15 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 15 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 16 | 16 | assert conn.connect(info['server_ip'], info['server_port']) |
| 17 | 17 | |
| 18 | 18 | def setup_func_SMB2(): |
| 20 | 20 | smb_structs.SUPPORT_SMB2 = True |
| 21 | 21 | |
| 22 | 22 | info = getConnectionInfo() |
| 23 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 23 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 24 | 24 | assert conn.connect(info['server_ip'], info['server_port']) |
| 25 | 25 | |
| 26 | 26 | def teardown_func(): |
| 27 | 27 | global conn |
| 28 | 28 | conn.close() |
| 29 | 29 | |
| 30 | @with_setup(setup_func_SMB1, teardown_func) | |
| 30 | @with_setup(setup_func_SMB1) | |
| 31 | @with_teardown(teardown_func) | |
| 31 | 32 | def test_english_directory_SMB1(): |
| 32 | 33 | global conn |
| 33 | 34 | |
| 44 | 45 | names = [e.filename for e in entries] |
| 45 | 46 | assert os.path.basename(path.replace('/', os.sep)) not in names |
| 46 | 47 | |
| 47 | @with_setup(setup_func_SMB2, teardown_func) | |
| 48 | @with_setup(setup_func_SMB2) | |
| 49 | @with_teardown(teardown_func) | |
| 48 | 50 | def test_english_directory_SMB2(): |
| 49 | 51 | global conn |
| 50 | 52 | |
| 61 | 63 | names = [e.filename for e in entries] |
| 62 | 64 | assert os.path.basename(path.replace('/', os.sep)) not in names |
| 63 | 65 | |
| 64 | @with_setup(setup_func_SMB1, teardown_func) | |
| 66 | @with_setup(setup_func_SMB1) | |
| 67 | @with_teardown(teardown_func) | |
| 65 | 68 | def test_unicode_directory_SMB1(): |
| 66 | 69 | global conn |
| 67 | 70 | |
| 78 | 81 | names = [e.filename for e in entries] |
| 79 | 82 | assert os.path.basename(path.replace('/', os.sep)) not in names |
| 80 | 83 | |
| 81 | @with_setup(setup_func_SMB2, teardown_func) | |
| 84 | @with_setup(setup_func_SMB2) | |
| 85 | @with_teardown(teardown_func) | |
| 82 | 86 | def test_unicode_directory_SMB2(): |
| 83 | 87 | global conn |
| 84 | 88 | |
| 0 | 0 | |
| 1 | 1 | import random |
| 2 | from nose2.tools.decorators import with_setup, with_teardown | |
| 2 | 3 | from smb.SMBConnection import SMBConnection |
| 3 | 4 | from .util import getConnectionInfo |
| 4 | from nose.tools import with_setup | |
| 5 | 5 | |
| 6 | 6 | conn = None |
| 7 | 7 | |
| 8 | 8 | def setup_func(): |
| 9 | 9 | global conn |
| 10 | 10 | info = getConnectionInfo() |
| 11 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 11 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 12 | 12 | assert conn.connect(info['server_ip'], info['server_port']) |
| 13 | 13 | |
| 14 | 14 | def teardown_func(): |
| 15 | 15 | global conn |
| 16 | 16 | conn.close() |
| 17 | 17 | |
| 18 | @with_setup(setup_func, teardown_func) | |
| 18 | @with_setup(setup_func) | |
| 19 | @with_teardown(teardown_func) | |
| 19 | 20 | def test_echo(): |
| 20 | 21 | global conn |
| 21 | 22 |
| 0 | 0 | # -*- coding: utf-8 -*- |
| 1 | 1 | |
| 2 | from nose2.tools.decorators import with_setup, with_teardown | |
| 2 | 3 | from smb.SMBConnection import SMBConnection |
| 4 | from smb.smb_constants import * | |
| 5 | from smb import smb_structs | |
| 3 | 6 | from .util import getConnectionInfo |
| 4 | from nose.tools import with_setup | |
| 5 | from smb import smb_structs | |
| 6 | 7 | |
| 7 | 8 | conn = None |
| 8 | 9 | |
| 10 | 11 | global conn |
| 11 | 12 | smb_structs.SUPPORT_SMB2 = False |
| 12 | 13 | info = getConnectionInfo() |
| 13 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 14 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 14 | 15 | assert conn.connect(info['server_ip'], info['server_port']) |
| 15 | 16 | |
| 16 | 17 | def setup_func_SMB2(): |
| 17 | 18 | global conn |
| 18 | 19 | smb_structs.SUPPORT_SMB2 = True |
| 19 | 20 | info = getConnectionInfo() |
| 20 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 21 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 21 | 22 | assert conn.connect(info['server_ip'], info['server_port']) |
| 22 | 23 | |
| 23 | 24 | def teardown_func(): |
| 24 | 25 | global conn |
| 25 | 26 | conn.close() |
| 26 | 27 | |
| 27 | @with_setup(setup_func_SMB1, teardown_func) | |
| 28 | @with_setup(setup_func_SMB1) | |
| 29 | @with_teardown(teardown_func) | |
| 28 | 30 | def test_listPath_SMB1(): |
| 29 | 31 | global conn |
| 30 | 32 | results = conn.listPath('smbtest', '/') |
| 35 | 37 | assert ( 'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names |
| 36 | 38 | assert ( 'rfc1001.txt', False ) in filenames # Test short English file names |
| 37 | 39 | |
| 38 | @with_setup(setup_func_SMB1, teardown_func) | |
| 40 | @with_setup(setup_func_SMB1) | |
| 41 | @with_teardown(teardown_func) | |
| 39 | 42 | def test_listSubPath_SMB1(): |
| 40 | 43 | global conn |
| 41 | 44 | results = conn.listPath('smbtest', '/Test Folder with Long Name/') |
| 44 | 47 | assert ( 'Test Folder', True ) in filenames |
| 45 | 48 | assert ( '子文件夹', True ) in filenames |
| 46 | 49 | |
| 47 | @with_setup(setup_func_SMB2, teardown_func) | |
| 50 | @with_setup(setup_func_SMB1) | |
| 51 | @with_teardown(teardown_func) | |
| 52 | def test_listPathWithManyFiles_SMB1(): | |
| 53 | global conn | |
| 54 | results = conn.listPath('smbtest', '/RFC Archive/') | |
| 55 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 56 | assert len(list(filenames))==999 | |
| 57 | ||
| 58 | @with_setup(setup_func_SMB2) | |
| 59 | @with_teardown(teardown_func) | |
| 48 | 60 | def test_listPath_SMB2(): |
| 49 | 61 | global conn |
| 50 | 62 | results = conn.listPath('smbtest', '/') |
| 55 | 67 | assert ( 'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names |
| 56 | 68 | assert ( 'rfc1001.txt', False ) in filenames # Test short English file names |
| 57 | 69 | |
| 58 | @with_setup(setup_func_SMB2, teardown_func) | |
| 70 | @with_setup(setup_func_SMB2) | |
| 71 | @with_teardown(teardown_func) | |
| 59 | 72 | def test_listSubPath_SMB2(): |
| 60 | 73 | global conn |
| 61 | 74 | results = conn.listPath('smbtest', '/Test Folder with Long Name/') |
| 63 | 76 | assert ( 'Test File.txt', False ) in filenames |
| 64 | 77 | assert ( 'Test Folder', True ) in filenames |
| 65 | 78 | assert ( '子文件夹', True ) in filenames |
| 79 | ||
| 80 | @with_setup(setup_func_SMB2) | |
| 81 | @with_teardown(teardown_func) | |
| 82 | def test_listPathWithManyFiles_SMB2(): | |
| 83 | global conn | |
| 84 | results = conn.listPath('smbtest', '/RFC Archive/') | |
| 85 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 86 | assert len(list(filenames))==999 | |
| 87 | ||
| 88 | @with_setup(setup_func_SMB1) | |
| 89 | @with_teardown(teardown_func) | |
| 90 | def test_listPathFilterForDirectory_SMB1(): | |
| 91 | global conn | |
| 92 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY) | |
| 93 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 94 | assert len(list(filenames)) > 0 | |
| 95 | for f, isDirectory in filenames: | |
| 96 | assert isDirectory | |
| 97 | ||
| 98 | @with_setup(setup_func_SMB2) | |
| 99 | @with_teardown(teardown_func) | |
| 100 | def test_listPathFilterForDirectory_SMB2(): | |
| 101 | global conn | |
| 102 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY) | |
| 103 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 104 | assert len(list(filenames)) > 0 | |
| 105 | for f, isDirectory in filenames: | |
| 106 | assert isDirectory | |
| 107 | ||
| 108 | @with_setup(setup_func_SMB1) | |
| 109 | @with_teardown(teardown_func) | |
| 110 | def test_listPathFilterForFiles_SMB1(): | |
| 111 | global conn | |
| 112 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL) | |
| 113 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 114 | assert len(list(filenames)) > 0 | |
| 115 | for f, isDirectory in filenames: | |
| 116 | assert not isDirectory | |
| 117 | ||
| 118 | @with_setup(setup_func_SMB2) | |
| 119 | @with_teardown(teardown_func) | |
| 120 | def test_listPathFilterForFiles_SMB2(): | |
| 121 | global conn | |
| 122 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL) | |
| 123 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 124 | assert len(list(filenames)) > 0 | |
| 125 | for f, isDirectory in filenames: | |
| 126 | assert not isDirectory | |
| 127 | ||
| 128 | ||
| 129 | @with_setup(setup_func_SMB1) | |
| 130 | @with_teardown(teardown_func) | |
| 131 | def test_listPathFilterPattern_SMB1(): | |
| 132 | global conn | |
| 133 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*') | |
| 134 | filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results)) | |
| 135 | assert len(filenames) == 2 | |
| 136 | assert ( u'Test File.txt', False ) in filenames | |
| 137 | assert ( u'Test Folder', True ) in filenames | |
| 138 | assert ( u'子文件夹', True ) not in filenames | |
| 139 | ||
| 140 | @with_setup(setup_func_SMB2) | |
| 141 | @with_teardown(teardown_func) | |
| 142 | def test_listPathFilterPattern_SMB2(): | |
| 143 | global conn | |
| 144 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*') | |
| 145 | filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results)) | |
| 146 | assert len(filenames) == 2 | |
| 147 | assert ( u'Test File.txt', False ) in filenames | |
| 148 | assert ( u'Test Folder', True ) in filenames | |
| 149 | assert ( u'子文件夹', True ) not in filenames | |
| 150 | ||
| 151 | @with_setup(setup_func_SMB1) | |
| 152 | @with_teardown(teardown_func) | |
| 153 | def test_listPathFilterUnicodePattern_SMB1(): | |
| 154 | global conn | |
| 155 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹') | |
| 156 | filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results)) | |
| 157 | assert len(filenames) == 1 | |
| 158 | assert ( u'Test File.txt', False ) not in filenames | |
| 159 | assert ( u'Test Folder', True ) not in filenames | |
| 160 | assert ( u'子文件夹', True ) in filenames | |
| 161 | ||
| 162 | @with_setup(setup_func_SMB2) | |
| 163 | @with_teardown(teardown_func) | |
| 164 | def test_listPathFilterUnicodePattern_SMB2(): | |
| 165 | global conn | |
| 166 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹') | |
| 167 | filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results)) | |
| 168 | assert len(filenames) == 1 | |
| 169 | assert ( u'Test File.txt', False ) not in filenames | |
| 170 | assert ( u'Test Folder', True ) not in filenames | |
| 171 | assert ( u'子文件夹', True ) in filenames | |
| 0 | 0 | |
| 1 | from nose2.tools.decorators import with_setup, with_teardown | |
| 1 | 2 | from smb.SMBConnection import SMBConnection |
| 3 | from smb import smb_structs | |
| 2 | 4 | from .util import getConnectionInfo |
| 3 | from nose.tools import with_setup | |
| 4 | from smb import smb_structs | |
| 5 | 5 | |
| 6 | 6 | conn = None |
| 7 | 7 | |
| 9 | 9 | global conn |
| 10 | 10 | smb_structs.SUPPORT_SMB2 = False |
| 11 | 11 | info = getConnectionInfo() |
| 12 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 12 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 13 | 13 | assert conn.connect(info['server_ip'], info['server_port']) |
| 14 | 14 | |
| 15 | 15 | def setup_func_SMB2(): |
| 16 | 16 | global conn |
| 17 | 17 | smb_structs.SUPPORT_SMB2 = True |
| 18 | 18 | info = getConnectionInfo() |
| 19 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 19 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 20 | 20 | assert conn.connect(info['server_ip'], info['server_port']) |
| 21 | 21 | |
| 22 | 22 | def teardown_func(): |
| 23 | 23 | global conn |
| 24 | 24 | conn.close() |
| 25 | 25 | |
| 26 | @with_setup(setup_func_SMB1, teardown_func) | |
| 26 | @with_setup(setup_func_SMB1) | |
| 27 | @with_teardown(teardown_func) | |
| 27 | 28 | def test_listshares_SMB1(): |
| 28 | 29 | global conn |
| 29 | 30 | results = conn.listShares() |
| 30 | 31 | assert 'smbtest' in [r.name.lower() for r in results] |
| 31 | 32 | |
| 32 | @with_setup(setup_func_SMB2, teardown_func) | |
| 33 | @with_setup(setup_func_SMB2) | |
| 34 | @with_teardown(teardown_func) | |
| 33 | 35 | def test_listshares_SMB2(): |
| 34 | 36 | global conn |
| 35 | 37 | results = conn.listShares() |
| 0 | 0 | |
| 1 | from nose2.tools.decorators import with_setup, with_teardown | |
| 1 | 2 | from smb.SMBConnection import SMBConnection |
| 3 | from smb import smb_structs | |
| 2 | 4 | from .util import getConnectionInfo |
| 3 | from nose.tools import with_setup | |
| 4 | from smb import smb_structs | |
| 5 | 5 | |
| 6 | 6 | conn = None |
| 7 | 7 | |
| 9 | 9 | global conn |
| 10 | 10 | smb_structs.SUPPORT_SMB2 = False |
| 11 | 11 | info = getConnectionInfo() |
| 12 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 12 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 13 | 13 | assert conn.connect(info['server_ip'], info['server_port']) |
| 14 | 14 | |
| 15 | 15 | def setup_func_SMB2(): |
| 16 | 16 | global conn |
| 17 | 17 | smb_structs.SUPPORT_SMB2 = True |
| 18 | 18 | info = getConnectionInfo() |
| 19 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 19 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 20 | 20 | assert conn.connect(info['server_ip'], info['server_port']) |
| 21 | 21 | |
| 22 | 22 | def teardown_func(): |
| 23 | 23 | global conn |
| 24 | 24 | conn.close() |
| 25 | 25 | |
| 26 | @with_setup(setup_func_SMB1, teardown_func) | |
| 26 | @with_setup(setup_func_SMB1) | |
| 27 | @with_teardown(teardown_func) | |
| 27 | 28 | def test_listsnapshots_SMB1(): |
| 28 | 29 | global conn |
| 29 | 30 | results = conn.listSnapshots('smbtest', '/rfc1001.txt') |
| 30 | 31 | assert len(results) > 0 |
| 31 | 32 | |
| 32 | @with_setup(setup_func_SMB2, teardown_func) | |
| 33 | @with_setup(setup_func_SMB2) | |
| 34 | @with_teardown(teardown_func) | |
| 33 | 35 | def test_listsnapshots_SMB2(): |
| 34 | 36 | global conn |
| 35 | 37 | results = conn.listSnapshots('smbtest', '/rfc1001.txt') |
| 1 | 1 | |
| 2 | 2 | import os, time, random |
| 3 | 3 | from io import BytesIO |
| 4 | from nose2.tools.decorators import with_setup, with_teardown | |
| 4 | 5 | from smb.SMBConnection import SMBConnection |
| 6 | from smb import smb_structs | |
| 5 | 7 | from .util import getConnectionInfo |
| 6 | from nose.tools import with_setup | |
| 7 | from smb import smb_structs | |
| 8 | 8 | |
| 9 | 9 | conn = None |
| 10 | 10 | |
| 12 | 12 | global conn |
| 13 | 13 | smb_structs.SUPPORT_SMB2 = False |
| 14 | 14 | info = getConnectionInfo() |
| 15 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 15 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 16 | 16 | assert conn.connect(info['server_ip'], info['server_port']) |
| 17 | 17 | |
| 18 | 18 | def setup_func_SMB2(): |
| 19 | 19 | global conn |
| 20 | 20 | smb_structs.SUPPORT_SMB2 = True |
| 21 | 21 | info = getConnectionInfo() |
| 22 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 22 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 23 | 23 | assert conn.connect(info['server_ip'], info['server_port']) |
| 24 | 24 | |
| 25 | 25 | def teardown_func(): |
| 26 | 26 | global conn |
| 27 | 27 | conn.close() |
| 28 | 28 | |
| 29 | @with_setup(setup_func_SMB1, teardown_func) | |
| 29 | @with_setup(setup_func_SMB1) | |
| 30 | @with_teardown(teardown_func) | |
| 30 | 31 | def test_rename_english_file_SMB1(): |
| 31 | 32 | global conn |
| 32 | 33 | |
| 49 | 50 | |
| 50 | 51 | conn.deleteFiles('smbtest', new_path) |
| 51 | 52 | |
| 52 | @with_setup(setup_func_SMB2, teardown_func) | |
| 53 | @with_setup(setup_func_SMB2) | |
| 54 | @with_teardown(teardown_func) | |
| 53 | 55 | def test_rename_english_file_SMB2(): |
| 54 | 56 | global conn |
| 55 | 57 | |
| 72 | 74 | |
| 73 | 75 | conn.deleteFiles('smbtest', new_path) |
| 74 | 76 | |
| 75 | @with_setup(setup_func_SMB1, teardown_func) | |
| 77 | @with_setup(setup_func_SMB1) | |
| 78 | @with_teardown(teardown_func) | |
| 76 | 79 | def test_rename_unicode_file_SMB1(): |
| 77 | 80 | global conn |
| 78 | 81 | |
| 95 | 98 | |
| 96 | 99 | conn.deleteFiles('smbtest', new_path) |
| 97 | 100 | |
| 98 | @with_setup(setup_func_SMB2, teardown_func) | |
| 101 | @with_setup(setup_func_SMB2) | |
| 102 | @with_teardown(teardown_func) | |
| 99 | 103 | def test_rename_unicode_file_SMB2(): |
| 100 | 104 | global conn |
| 101 | 105 | |
| 118 | 122 | |
| 119 | 123 | conn.deleteFiles('smbtest', new_path) |
| 120 | 124 | |
| 121 | @with_setup(setup_func_SMB1, teardown_func) | |
| 125 | @with_setup(setup_func_SMB1) | |
| 126 | @with_teardown(teardown_func) | |
| 122 | 127 | def test_rename_english_directory_SMB1(): |
| 123 | 128 | global conn |
| 124 | 129 | |
| 141 | 146 | |
| 142 | 147 | conn.deleteDirectory('smbtest', new_path) |
| 143 | 148 | |
| 144 | @with_setup(setup_func_SMB2, teardown_func) | |
| 149 | @with_setup(setup_func_SMB2) | |
| 150 | @with_teardown(teardown_func) | |
| 145 | 151 | def test_rename_english_directory_SMB2(): |
| 146 | 152 | global conn |
| 147 | 153 | |
| 164 | 170 | |
| 165 | 171 | conn.deleteDirectory('smbtest', new_path) |
| 166 | 172 | |
| 167 | @with_setup(setup_func_SMB1, teardown_func) | |
| 173 | @with_setup(setup_func_SMB1) | |
| 174 | @with_teardown(teardown_func) | |
| 168 | 175 | def test_rename_unicode_directory_SMB1(): |
| 169 | 176 | global conn |
| 170 | 177 | |
| 187 | 194 | |
| 188 | 195 | conn.deleteDirectory('smbtest', new_path) |
| 189 | 196 | |
| 190 | @with_setup(setup_func_SMB2, teardown_func) | |
| 197 | @with_setup(setup_func_SMB2) | |
| 198 | @with_teardown(teardown_func) | |
| 191 | 199 | def test_rename_unicode_directory_SMB2(): |
| 192 | 200 | global conn |
| 193 | 201 | |
| 1 | 1 | |
| 2 | 2 | import os, tempfile |
| 3 | 3 | from io import BytesIO |
| 4 | from nose2.tools.decorators import with_setup, with_teardown | |
| 4 | 5 | from smb.SMBConnection import SMBConnection |
| 6 | from smb import smb_structs | |
| 5 | 7 | from .util import getConnectionInfo |
| 6 | from nose.tools import with_setup | |
| 7 | from smb import smb_structs | |
| 8 | 8 | |
| 9 | 9 | try: |
| 10 | 10 | import hashlib |
| 19 | 19 | global conn |
| 20 | 20 | smb_structs.SUPPORT_SMB2 = False |
| 21 | 21 | info = getConnectionInfo() |
| 22 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 22 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 23 | 23 | assert conn.connect(info['server_ip'], info['server_port']) |
| 24 | 24 | |
| 25 | 25 | def setup_func_SMB2(): |
| 26 | 26 | global conn |
| 27 | 27 | smb_structs.SUPPORT_SMB2 = True |
| 28 | 28 | info = getConnectionInfo() |
| 29 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 29 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 30 | 30 | assert conn.connect(info['server_ip'], info['server_port']) |
| 31 | 31 | |
| 32 | 32 | def teardown_func(): |
| 33 | 33 | global conn |
| 34 | 34 | conn.close() |
| 35 | 35 | |
| 36 | @with_setup(setup_func_SMB1, teardown_func) | |
| 36 | @with_setup(setup_func_SMB1) | |
| 37 | @with_teardown(teardown_func) | |
| 37 | 38 | def test_retr_multiplereads_SMB1(): |
| 38 | 39 | # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes) |
| 39 | 40 | global conn |
| 47 | 48 | |
| 48 | 49 | temp_fh.close() |
| 49 | 50 | |
| 50 | @with_setup(setup_func_SMB2, teardown_func) | |
| 51 | @with_setup(setup_func_SMB2) | |
| 52 | @with_teardown(teardown_func) | |
| 51 | 53 | def test_retr_multiplereads_SMB2(): |
| 52 | 54 | # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes) |
| 53 | 55 | global conn |
| 61 | 63 | |
| 62 | 64 | temp_fh.close() |
| 63 | 65 | |
| 64 | @with_setup(setup_func_SMB1, teardown_func) | |
| 66 | @with_setup(setup_func_SMB1) | |
| 67 | @with_teardown(teardown_func) | |
| 65 | 68 | def test_retr_longfilename_SMB1(): |
| 66 | 69 | # Test file retrieval that has a long English filename |
| 67 | 70 | global conn |
| 75 | 78 | |
| 76 | 79 | temp_fh.close() |
| 77 | 80 | |
| 78 | @with_setup(setup_func_SMB2, teardown_func) | |
| 81 | @with_setup(setup_func_SMB2) | |
| 82 | @with_teardown(teardown_func) | |
| 79 | 83 | def test_retr_longfilename_SMB2(): |
| 80 | 84 | # Test file retrieval that has a long English filename |
| 81 | 85 | global conn |
| 89 | 93 | |
| 90 | 94 | temp_fh.close() |
| 91 | 95 | |
| 92 | @with_setup(setup_func_SMB1, teardown_func) | |
| 96 | @with_setup(setup_func_SMB1) | |
| 97 | @with_teardown(teardown_func) | |
| 93 | 98 | def test_retr_unicodefilename_SMB1(): |
| 94 | 99 | # Test file retrieval that has a long non-English filename inside a folder with a non-English name |
| 95 | 100 | global conn |
| 103 | 108 | |
| 104 | 109 | temp_fh.close() |
| 105 | 110 | |
| 106 | @with_setup(setup_func_SMB2, teardown_func) | |
| 111 | @with_setup(setup_func_SMB2) | |
| 112 | @with_teardown(teardown_func) | |
| 107 | 113 | def test_retr_unicodefilename_SMB2(): |
| 108 | 114 | # Test file retrieval that has a long non-English filename inside a folder with a non-English name |
| 109 | 115 | global conn |
| 117 | 123 | |
| 118 | 124 | temp_fh.close() |
| 119 | 125 | |
| 120 | @with_setup(setup_func_SMB1, teardown_func) | |
| 126 | @with_setup(setup_func_SMB1) | |
| 127 | @with_teardown(teardown_func) | |
| 121 | 128 | def test_retr_offset_SMB1(): |
| 122 | 129 | # Test file retrieval from offset to EOF |
| 123 | 130 | global conn |
| 131 | 138 | |
| 132 | 139 | temp_fh.close() |
| 133 | 140 | |
| 134 | @with_setup(setup_func_SMB2, teardown_func) | |
| 141 | @with_setup(setup_func_SMB2) | |
| 142 | @with_teardown(teardown_func) | |
| 135 | 143 | def test_retr_offset_SMB2(): |
| 136 | 144 | # Test file retrieval from offset to EOF |
| 137 | 145 | global conn |
| 145 | 153 | |
| 146 | 154 | temp_fh.close() |
| 147 | 155 | |
| 148 | @with_setup(setup_func_SMB1, teardown_func) | |
| 156 | @with_setup(setup_func_SMB1) | |
| 157 | @with_teardown(teardown_func) | |
| 149 | 158 | def test_retr_offset_and_biglimit_SMB1(): |
| 150 | 159 | # Test file retrieval from offset with a big max_length |
| 151 | 160 | global conn |
| 159 | 168 | |
| 160 | 169 | temp_fh.close() |
| 161 | 170 | |
| 162 | @with_setup(setup_func_SMB2, teardown_func) | |
| 171 | @with_setup(setup_func_SMB2) | |
| 172 | @with_teardown(teardown_func) | |
| 163 | 173 | def test_retr_offset_and_biglimit_SMB2(): |
| 164 | 174 | # Test file retrieval from offset with a big max_length |
| 165 | 175 | global conn |
| 173 | 183 | |
| 174 | 184 | temp_fh.close() |
| 175 | 185 | |
| 176 | @with_setup(setup_func_SMB1, teardown_func) | |
| 186 | @with_setup(setup_func_SMB1) | |
| 187 | @with_teardown(teardown_func) | |
| 177 | 188 | def test_retr_offset_and_smalllimit_SMB1(): |
| 178 | 189 | # Test file retrieval from offset with a small max_length |
| 179 | 190 | global conn |
| 187 | 198 | |
| 188 | 199 | temp_fh.close() |
| 189 | 200 | |
| 190 | @with_setup(setup_func_SMB2, teardown_func) | |
| 201 | @with_setup(setup_func_SMB2) | |
| 202 | @with_teardown(teardown_func) | |
| 191 | 203 | def test_retr_offset_and_smalllimit_SMB2(): |
| 192 | 204 | # Test file retrieval from offset with a small max_length |
| 193 | 205 | global conn |
| 201 | 213 | |
| 202 | 214 | temp_fh.close() |
| 203 | 215 | |
| 204 | @with_setup(setup_func_SMB1, teardown_func) | |
| 216 | @with_setup(setup_func_SMB1) | |
| 217 | @with_teardown(teardown_func) | |
| 205 | 218 | def test_retr_offset_and_zerolimit_SMB1(): |
| 206 | 219 | # Test file retrieval from offset to EOF with max_length=0 |
| 207 | 220 | global conn |
| 215 | 228 | |
| 216 | 229 | temp_fh.close() |
| 217 | 230 | |
| 218 | @with_setup(setup_func_SMB2, teardown_func) | |
| 231 | @with_setup(setup_func_SMB2) | |
| 232 | @with_teardown(teardown_func) | |
| 219 | 233 | def test_retr_offset_and_zerolimit_SMB2(): |
| 220 | 234 | # Test file retrieval from offset to EOF with max_length=0 |
| 221 | 235 | global conn |
| 1 | 1 | |
| 2 | 2 | import os, tempfile, random, time |
| 3 | 3 | from io import BytesIO |
| 4 | from nose2.tools.decorators import with_setup, with_teardown | |
| 4 | 5 | from smb.SMBConnection import SMBConnection |
| 6 | from smb import smb_structs | |
| 5 | 7 | from .util import getConnectionInfo |
| 6 | from nose.tools import with_setup | |
| 7 | from smb import smb_structs | |
| 8 | 8 | |
| 9 | 9 | try: |
| 10 | 10 | import hashlib |
| 24 | 24 | smb_structs.SUPPORT_SMB2 = False |
| 25 | 25 | |
| 26 | 26 | info = getConnectionInfo() |
| 27 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 27 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 28 | 28 | assert conn.connect(info['server_ip'], info['server_port']) |
| 29 | 29 | |
| 30 | 30 | def setup_func_SMB2(): |
| 32 | 32 | smb_structs.SUPPORT_SMB2 = True |
| 33 | 33 | |
| 34 | 34 | info = getConnectionInfo() |
| 35 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 35 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True, is_direct_tcp = True) | |
| 36 | 36 | assert conn.connect(info['server_ip'], info['server_port']) |
| 37 | 37 | |
| 38 | 38 | def teardown_func(): |
| 40 | 40 | conn.close() |
| 41 | 41 | |
| 42 | 42 | |
| 43 | @with_setup(setup_func_SMB1, teardown_func) | |
| 43 | @with_setup(setup_func_SMB1) | |
| 44 | @with_teardown(teardown_func) | |
| 44 | 45 | def test_store_long_filename_SMB1(): |
| 45 | 46 | filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) |
| 46 | 47 | |
| 63 | 64 | conn.deleteFiles('smbtest', filename) |
| 64 | 65 | |
| 65 | 66 | |
| 66 | @with_setup(setup_func_SMB2, teardown_func) | |
| 67 | @with_setup(setup_func_SMB2) | |
| 68 | @with_teardown(teardown_func) | |
| 67 | 69 | def test_store_long_filename_SMB2(): |
| 68 | 70 | filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) |
| 69 | 71 | |
| 86 | 88 | conn.deleteFiles('smbtest', filename) |
| 87 | 89 | |
| 88 | 90 | |
| 89 | @with_setup(setup_func_SMB1, teardown_func) | |
| 91 | @with_setup(setup_func_SMB1) | |
| 92 | @with_teardown(teardown_func) | |
| 90 | 93 | def test_store_unicode_filename_SMB1(): |
| 91 | 94 | filename = os.sep + '上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) |
| 92 | 95 | |
| 109 | 112 | conn.deleteFiles('smbtest', filename) |
| 110 | 113 | |
| 111 | 114 | |
| 112 | @with_setup(setup_func_SMB2, teardown_func) | |
| 115 | @with_setup(setup_func_SMB2) | |
| 116 | @with_teardown(teardown_func) | |
| 113 | 117 | def test_store_unicode_filename_SMB2(): |
| 114 | 118 | filename = os.sep + '上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) |
| 115 | 119 | |
| 0 | ||
| 1 | from nose.twistedtools import reactor, deferred | |
| 2 | from twisted.internet import defer | |
| 3 | from smb.SMBProtocol import SMBProtocolFactory | |
| 4 | from smb import smb_structs | |
| 5 | from .util import getConnectionInfo | |
| 6 | ||
| 7 | ||
| 8 | class AuthFactory(SMBProtocolFactory): | |
| 9 | ||
| 10 | def __init__(self, *args, **kwargs): | |
| 11 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 12 | self.d = defer.Deferred() | |
| 13 | self.d.addBoth(self.testDone) | |
| 14 | ||
| 15 | def testDone(self, r): | |
| 16 | if self.instance: | |
| 17 | self.instance.transport.loseConnection() | |
| 18 | return r | |
| 19 | ||
| 20 | def onAuthOK(self): | |
| 21 | self.d.callback(True) | |
| 22 | ||
| 23 | def onAuthFailed(self): | |
| 24 | self.d.callback(False) | |
| 25 | ||
| 26 | ||
| 27 | @deferred(timeout=5.0) | |
| 28 | def test_NTLMv1_auth_SMB1(): | |
| 29 | def result(auth_passed): | |
| 30 | assert auth_passed | |
| 31 | ||
| 32 | smb_structs.SUPPORT_SMB2 = False | |
| 33 | info = getConnectionInfo() | |
| 34 | factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False) | |
| 35 | factory.d.addCallback(result) | |
| 36 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 37 | return factory.d | |
| 38 | ||
| 39 | ||
| 40 | @deferred(timeout=5.0) | |
| 41 | def test_NTLMv2_auth_SMB1(): | |
| 42 | def result(auth_passed): | |
| 43 | assert auth_passed | |
| 44 | ||
| 45 | smb_structs.SUPPORT_SMB2 = False | |
| 46 | info = getConnectionInfo() | |
| 47 | factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 48 | factory.d.addCallback(result) | |
| 49 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 50 | return factory.d | |
| 51 | ||
| 52 | ||
| 53 | @deferred(timeout=5.0) | |
| 54 | def test_NTLMv1_auth_SMB2(): | |
| 55 | def result(auth_passed): | |
| 56 | assert auth_passed | |
| 57 | ||
| 58 | smb_structs.SUPPORT_SMB2 = True | |
| 59 | info = getConnectionInfo() | |
| 60 | factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False) | |
| 61 | factory.d.addCallback(result) | |
| 62 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 63 | return factory.d | |
| 64 | ||
| 65 | ||
| 66 | @deferred(timeout=5.0) | |
| 67 | def test_NTLMv2_auth_SMB2(): | |
| 68 | def result(auth_passed): | |
| 69 | assert auth_passed | |
| 70 | ||
| 71 | smb_structs.SUPPORT_SMB2 = True | |
| 72 | info = getConnectionInfo() | |
| 73 | factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 74 | factory.d.addCallback(result) | |
| 75 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 76 | return factory.d |
| 0 | # -*- coding: utf-8 -*- | |
| 1 | ||
| 2 | import os, random, time | |
| 3 | from nose.twistedtools import reactor, deferred | |
| 4 | from twisted.internet import defer | |
| 5 | from smb.SMBProtocol import SMBProtocolFactory | |
| 6 | from smb import smb_structs | |
| 7 | from .util import getConnectionInfo | |
| 8 | ||
| 9 | ||
| 10 | class DirectoryFactory(SMBProtocolFactory): | |
| 11 | ||
| 12 | def __init__(self, *args, **kwargs): | |
| 13 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 14 | self.d = defer.Deferred() | |
| 15 | self.d.addBoth(self.testDone) | |
| 16 | self.service_name = '' | |
| 17 | self.path = '' | |
| 18 | ||
| 19 | def testDone(self, r): | |
| 20 | if self.instance: | |
| 21 | self.instance.transport.loseConnection() | |
| 22 | return r | |
| 23 | ||
| 24 | def createDone(self, result): | |
| 25 | d = self.listPath(self.service_name, os.path.dirname(self.path.replace('/', os.sep))) | |
| 26 | d.addCallback(self.listComplete) | |
| 27 | d.addErrback(self.d.errback) | |
| 28 | ||
| 29 | def listComplete(self, entries): | |
| 30 | names = [e.filename for e in entries] | |
| 31 | assert os.path.basename(self.path.replace('/', os.sep)) in names | |
| 32 | ||
| 33 | d = self.deleteDirectory(self.service_name, self.path) | |
| 34 | d.addCallback(self.deleteDone) | |
| 35 | d.addErrback(self.d.errback) | |
| 36 | ||
| 37 | def deleteDone(self, result): | |
| 38 | d = self.listPath(self.service_name, os.path.dirname(self.path.replace('/', os.sep))) | |
| 39 | d.addCallback(self.list2Complete) | |
| 40 | d.addErrback(self.d.errback) | |
| 41 | ||
| 42 | def list2Complete(self, entries): | |
| 43 | names = [e.filename for e in entries] | |
| 44 | assert os.path.basename(self.path.replace('/', os.sep)) not in names | |
| 45 | self.d.callback(True) | |
| 46 | ||
| 47 | def onAuthOK(self): | |
| 48 | d = self.createDirectory(self.service_name, self.path) | |
| 49 | d.addCallback(self.createDone) | |
| 50 | d.addErrback(self.d.errback) | |
| 51 | ||
| 52 | def onAuthFailed(self): | |
| 53 | self.d.errback('Auth failed') | |
| 54 | ||
| 55 | ||
| 56 | @deferred(timeout=15.0) | |
| 57 | def test_english_directory_SMB1(): | |
| 58 | info = getConnectionInfo() | |
| 59 | smb_structs.SUPPORT_SMB2 = False | |
| 60 | ||
| 61 | factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 62 | factory.service_name = 'smbtest' | |
| 63 | factory.path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 64 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 65 | return factory.d | |
| 66 | ||
| 67 | @deferred(timeout=15.0) | |
| 68 | def test_english_directory_SMB2(): | |
| 69 | info = getConnectionInfo() | |
| 70 | smb_structs.SUPPORT_SMB2 = True | |
| 71 | ||
| 72 | factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 73 | factory.service_name = 'smbtest' | |
| 74 | factory.path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 75 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 76 | return factory.d | |
| 77 | ||
| 78 | @deferred(timeout=15.0) | |
| 79 | def test_unicode_directory_SMB1(): | |
| 80 | info = getConnectionInfo() | |
| 81 | smb_structs.SUPPORT_SMB2 = False | |
| 82 | ||
| 83 | factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 84 | factory.service_name = 'smbtest' | |
| 85 | factory.path = os.sep + '文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 86 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 87 | return factory.d | |
| 88 | ||
| 89 | @deferred(timeout=15.0) | |
| 90 | def test_unicode_directory_SMB2(): | |
| 91 | info = getConnectionInfo() | |
| 92 | smb_structs.SUPPORT_SMB2 = True | |
| 93 | ||
| 94 | factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 95 | factory.service_name = 'smbtest' | |
| 96 | factory.path = os.sep + '文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 97 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 98 | return factory.d |
| 0 | ||
| 1 | from nose.twistedtools import reactor, deferred | |
| 2 | from twisted.internet import defer | |
| 3 | from smb.SMBProtocol import SMBProtocolFactory | |
| 4 | from .util import getConnectionInfo | |
| 5 | ||
| 6 | ||
| 7 | class EchoFactory(SMBProtocolFactory): | |
| 8 | ||
| 9 | def __init__(self, *args, **kwargs): | |
| 10 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 11 | self.d = defer.Deferred() | |
| 12 | self.d.addBoth(self.testDone) | |
| 13 | self.echo_data = 'This is an echo test' | |
| 14 | ||
| 15 | def testDone(self, r): | |
| 16 | if self.instance: | |
| 17 | self.instance.transport.loseConnection() | |
| 18 | return r | |
| 19 | ||
| 20 | def onAuthOK(self): | |
| 21 | def cb(data): | |
| 22 | assert data == self.echo_data | |
| 23 | self.d.callback(True) | |
| 24 | ||
| 25 | d = self.echo(self.echo_data) | |
| 26 | d.addCallback(cb) | |
| 27 | d.addErrback(self.d.errback) | |
| 28 | ||
| 29 | def onAuthFailed(self): | |
| 30 | self.d.errback('Auth failed') | |
| 31 | ||
| 32 | ||
| 33 | @deferred(timeout=15.0) | |
| 34 | def test_echo(): | |
| 35 | info = getConnectionInfo() | |
| 36 | factory = EchoFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 37 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 38 | return factory.d |
| 0 | ||
| 1 | from nose.twistedtools import reactor, deferred | |
| 2 | from twisted.internet import defer | |
| 3 | from smb.SMBProtocol import SMBProtocolFactory | |
| 4 | from smb import smb_structs | |
| 5 | from .util import getConnectionInfo | |
| 6 | ||
| 7 | ||
| 8 | class ListPathFactory(SMBProtocolFactory): | |
| 9 | ||
| 10 | def __init__(self, *args, **kwargs): | |
| 11 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 12 | self.d = defer.Deferred() | |
| 13 | self.d.addBoth(self.testDone) | |
| 14 | ||
| 15 | def testDone(self, r): | |
| 16 | if self.instance: | |
| 17 | self.instance.transport.loseConnection() | |
| 18 | return r | |
| 19 | ||
| 20 | def onAuthOK(self): | |
| 21 | def cb(results): | |
| 22 | filenames = [( r.filename, r.isDirectory ) for r in results] | |
| 23 | assert ( '\u6d4b\u8bd5\u6587\u4ef6\u5939', True ) in filenames # Test non-English folder names | |
| 24 | assert ( 'Test Folder with Long Name', True ) in filenames # Test long English folder names | |
| 25 | assert ( 'TestDir1', True ) in filenames # Test short English folder names | |
| 26 | assert ( 'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names | |
| 27 | assert ( 'rfc1001.txt', False ) in filenames # Test short English file names | |
| 28 | ||
| 29 | self.d.callback(True) | |
| 30 | ||
| 31 | d = self.listPath('smbtest', '/', timeout = 15) | |
| 32 | d.addCallback(cb) | |
| 33 | d.addErrback(self.d.errback) | |
| 34 | ||
| 35 | def onAuthFailed(self): | |
| 36 | self.d.errback('Auth failed') | |
| 37 | ||
| 38 | ||
| 39 | @deferred(timeout=15.0) | |
| 40 | def test_listPath_SMB1(): | |
| 41 | info = getConnectionInfo() | |
| 42 | smb_structs.SUPPORT_SMB2 = False | |
| 43 | ||
| 44 | factory = ListPathFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 45 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 46 | return factory.d | |
| 47 | ||
| 48 | @deferred(timeout=15.0) | |
| 49 | def test_listPath_SMB2(): | |
| 50 | info = getConnectionInfo() | |
| 51 | smb_structs.SUPPORT_SMB2 = True | |
| 52 | ||
| 53 | factory = ListPathFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 54 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 55 | return factory.d |
| 0 | ||
| 1 | from nose.twistedtools import reactor, deferred | |
| 2 | from twisted.internet import defer | |
| 3 | from smb.SMBProtocol import SMBProtocolFactory | |
| 4 | from smb import smb_structs | |
| 5 | from .util import getConnectionInfo | |
| 6 | ||
| 7 | ||
| 8 | class ListSharesFactory(SMBProtocolFactory): | |
| 9 | ||
| 10 | def __init__(self, *args, **kwargs): | |
| 11 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 12 | self.d = defer.Deferred() | |
| 13 | self.d.addBoth(self.testDone) | |
| 14 | ||
| 15 | def testDone(self, r): | |
| 16 | if self.instance: | |
| 17 | self.instance.transport.loseConnection() | |
| 18 | return r | |
| 19 | ||
| 20 | def onAuthOK(self): | |
| 21 | def cb(results): | |
| 22 | assert 'smbtest' in [r.name.lower() for r in results] | |
| 23 | self.d.callback(True) | |
| 24 | self.instance.transport.loseConnection() | |
| 25 | ||
| 26 | d = self.listShares(timeout = 15) | |
| 27 | d.addCallback(cb) | |
| 28 | d.addErrback(self.d.errback) | |
| 29 | ||
| 30 | def onAuthFailed(self): | |
| 31 | self.d.errback('Auth failed') | |
| 32 | ||
| 33 | ||
| 34 | @deferred(timeout=15.0) | |
| 35 | def test_listshares_SMB1(): | |
| 36 | info = getConnectionInfo() | |
| 37 | smb_structs.SUPPORT_SMB2 = False | |
| 38 | ||
| 39 | factory = ListSharesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 40 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 41 | return factory.d | |
| 42 | ||
| 43 | @deferred(timeout=15.0) | |
| 44 | def test_listshares_SMB2(): | |
| 45 | info = getConnectionInfo() | |
| 46 | smb_structs.SUPPORT_SMB2 = True | |
| 47 | ||
| 48 | factory = ListSharesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 49 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 50 | return factory.d |
| 0 | ||
| 1 | from nose.twistedtools import reactor, deferred | |
| 2 | from twisted.internet import defer | |
| 3 | from smb.SMBProtocol import SMBProtocolFactory | |
| 4 | from smb import smb_structs | |
| 5 | from .util import getConnectionInfo | |
| 6 | ||
| 7 | ||
| 8 | class ListSnapshotsFactory(SMBProtocolFactory): | |
| 9 | ||
| 10 | def __init__(self, *args, **kwargs): | |
| 11 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 12 | self.d = defer.Deferred() | |
| 13 | self.d.addBoth(self.testDone) | |
| 14 | self.service_name = None | |
| 15 | self.path = None | |
| 16 | ||
| 17 | def testDone(self, r): | |
| 18 | if self.instance: | |
| 19 | self.instance.transport.loseConnection() | |
| 20 | return r | |
| 21 | ||
| 22 | def onAuthOK(self): | |
| 23 | def cb(results): | |
| 24 | assert len(results) > 0 | |
| 25 | self.d.callback(True) | |
| 26 | self.instance.transport.loseConnection() | |
| 27 | ||
| 28 | d = self.listSnapshots(self.service_name, self.path, timeout = 15) | |
| 29 | d.addCallback(cb) | |
| 30 | d.addErrback(self.d.errback) | |
| 31 | ||
| 32 | def onAuthFailed(self): | |
| 33 | self.d.errback('Auth failed') | |
| 34 | ||
| 35 | ||
| 36 | @deferred(timeout=15.0) | |
| 37 | def test_listshares_SMB1(): | |
| 38 | info = getConnectionInfo() | |
| 39 | smb_structs.SUPPORT_SMB2 = False | |
| 40 | ||
| 41 | factory = ListSnapshotsFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 42 | factory.service_name = 'smbtest' | |
| 43 | factory.path = '/rfc1001.txt' | |
| 44 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 45 | return factory.d | |
| 46 | ||
| 47 | @deferred(timeout=15.0) | |
| 48 | def test_listshares_SMB2(): | |
| 49 | info = getConnectionInfo() | |
| 50 | smb_structs.SUPPORT_SMB2 = True | |
| 51 | ||
| 52 | factory = ListSnapshotsFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 53 | factory.service_name = 'smbtest' | |
| 54 | factory.path = '/rfc1001.txt' | |
| 55 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 56 | return factory.d |
| 0 | # -*- coding: utf-8 -*- | |
| 1 | ||
| 2 | import os, random, time | |
| 3 | from io import StringIO | |
| 4 | from nose.twistedtools import reactor, deferred | |
| 5 | from twisted.internet import defer | |
| 6 | from smb.SMBProtocol import SMBProtocolFactory | |
| 7 | from smb import smb_structs | |
| 8 | from .util import getConnectionInfo | |
| 9 | ||
| 10 | ||
| 11 | class RenameFactory(SMBProtocolFactory): | |
| 12 | ||
| 13 | def __init__(self, *args, **kwargs): | |
| 14 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 15 | self.d = defer.Deferred() | |
| 16 | self.d.addBoth(self.testDone) | |
| 17 | self.service = '' | |
| 18 | self.new_path = '' | |
| 19 | self.old_path = '' | |
| 20 | ||
| 21 | def testDone(self, r): | |
| 22 | if self.instance: | |
| 23 | self.instance.transport.loseConnection() | |
| 24 | return r | |
| 25 | ||
| 26 | def pathCreated(self, result): | |
| 27 | d = self.listPath(self.service, os.path.dirname(self.old_path.replace('/', os.sep))) | |
| 28 | d.addCallback(self.listComplete) | |
| 29 | d.addErrback(self.d.errback) | |
| 30 | ||
| 31 | def listComplete(self, entries): | |
| 32 | filenames = [e.filename for e in entries] | |
| 33 | assert os.path.basename(self.old_path.replace('/', os.sep)) in filenames | |
| 34 | assert os.path.basename(self.new_path.replace('/', os.sep)) not in filenames | |
| 35 | ||
| 36 | d = self.rename(self.service, self.old_path, self.new_path) | |
| 37 | d.addCallback(self.renameComplete) | |
| 38 | d.addErrback(self.d.errback) | |
| 39 | ||
| 40 | def renameComplete(self, result): | |
| 41 | d = self.listPath(self.service, os.path.dirname(self.new_path.replace('/', os.sep))) | |
| 42 | d.addCallback(self.list2Complete) | |
| 43 | d.addErrback(self.d.errback) | |
| 44 | ||
| 45 | def list2Complete(self, entries): | |
| 46 | filenames = [e.filename for e in entries] | |
| 47 | assert os.path.basename(self.new_path.replace('/', os.sep)) in filenames | |
| 48 | assert os.path.basename(self.old_path.replace('/', os.sep)) not in filenames | |
| 49 | self.cleanup() | |
| 50 | ||
| 51 | def onAuthFailed(self): | |
| 52 | self.d.errback('Auth failed') | |
| 53 | ||
| 54 | ||
| 55 | class RenameFileFactory(RenameFactory): | |
| 56 | ||
| 57 | def onAuthOK(self): | |
| 58 | d = self.storeFile(self.service, self.old_path, StringIO('Rename file test')) | |
| 59 | d.addCallback(self.pathCreated) | |
| 60 | d.addErrback(self.d.errback) | |
| 61 | ||
| 62 | def cleanup(self): | |
| 63 | d = self.deleteFiles(self.service, self.new_path) | |
| 64 | d.chainDeferred(self.d) | |
| 65 | ||
| 66 | ||
| 67 | class RenameDirectoryFactory(RenameFactory): | |
| 68 | ||
| 69 | def onAuthOK(self): | |
| 70 | d = self.createDirectory(self.service, self.old_path) | |
| 71 | d.addCallback(self.pathCreated) | |
| 72 | d.addErrback(self.d.errback) | |
| 73 | ||
| 74 | def cleanup(self): | |
| 75 | d = self.deleteDirectory(self.service, self.new_path) | |
| 76 | d.chainDeferred(self.d) | |
| 77 | ||
| 78 | ||
| 79 | @deferred(timeout=30.0) | |
| 80 | def test_rename_english_file_SMB1(): | |
| 81 | info = getConnectionInfo() | |
| 82 | smb_structs.SUPPORT_SMB2 = False | |
| 83 | ||
| 84 | factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 85 | factory.service = 'smbtest' | |
| 86 | factory.old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 87 | factory.new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 88 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 89 | return factory.d | |
| 90 | ||
| 91 | @deferred(timeout=30.0) | |
| 92 | def test_rename_english_file_SMB2(): | |
| 93 | info = getConnectionInfo() | |
| 94 | smb_structs.SUPPORT_SMB2 = True | |
| 95 | ||
| 96 | factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 97 | factory.service = 'smbtest' | |
| 98 | factory.old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 99 | factory.new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 100 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 101 | return factory.d | |
| 102 | ||
| 103 | @deferred(timeout=30.0) | |
| 104 | def test_rename_unicode_file_SMB1(): | |
| 105 | info = getConnectionInfo() | |
| 106 | smb_structs.SUPPORT_SMB2 = False | |
| 107 | ||
| 108 | factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 109 | factory.service = 'smbtest' | |
| 110 | factory.old_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 111 | factory.new_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 112 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 113 | return factory.d | |
| 114 | ||
| 115 | @deferred(timeout=30.0) | |
| 116 | def test_rename_unicode_file_SMB2(): | |
| 117 | info = getConnectionInfo() | |
| 118 | smb_structs.SUPPORT_SMB2 = True | |
| 119 | ||
| 120 | factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 121 | factory.service = 'smbtest' | |
| 122 | factory.old_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 123 | factory.new_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 124 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 125 | return factory.d | |
| 126 | ||
| 127 | @deferred(timeout=30.0) | |
| 128 | def test_rename_english_directory_SMB1(): | |
| 129 | info = getConnectionInfo() | |
| 130 | smb_structs.SUPPORT_SMB2 = False | |
| 131 | ||
| 132 | factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 133 | factory.service = 'smbtest' | |
| 134 | factory.old_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 135 | factory.new_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 136 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 137 | return factory.d | |
| 138 | ||
| 139 | @deferred(timeout=30.0) | |
| 140 | def test_rename_english_directory_SMB2(): | |
| 141 | info = getConnectionInfo() | |
| 142 | smb_structs.SUPPORT_SMB2 = True | |
| 143 | ||
| 144 | factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 145 | factory.service = 'smbtest' | |
| 146 | factory.old_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 147 | factory.new_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 148 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 149 | return factory.d | |
| 150 | ||
| 151 | @deferred(timeout=30.0) | |
| 152 | def test_rename_unicode_directory_SMB1(): | |
| 153 | info = getConnectionInfo() | |
| 154 | smb_structs.SUPPORT_SMB2 = False | |
| 155 | ||
| 156 | factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 157 | factory.service = 'smbtest' | |
| 158 | factory.old_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 159 | factory.new_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 160 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 161 | return factory.d | |
| 162 | ||
| 163 | @deferred(timeout=30.0) | |
| 164 | def test_rename_unicode_directory_SMB2(): | |
| 165 | info = getConnectionInfo() | |
| 166 | smb_structs.SUPPORT_SMB2 = True | |
| 167 | ||
| 168 | factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 169 | factory.service = 'smbtest' | |
| 170 | factory.old_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 171 | factory.new_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 172 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 173 | return factory.d |
| 0 | # -*- coding: utf-8 -*- | |
| 1 | ||
| 2 | import os, tempfile | |
| 3 | from nose.twistedtools import reactor, deferred | |
| 4 | from twisted.internet import defer | |
| 5 | from smb.SMBProtocol import SMBProtocolFactory | |
| 6 | from smb import smb_structs | |
| 7 | from .util import getConnectionInfo | |
| 8 | ||
| 9 | try: | |
| 10 | import hashlib | |
| 11 | def MD5(): return hashlib.md5() | |
| 12 | except ImportError: | |
| 13 | import md5 | |
| 14 | def MD5(): return md5.new() | |
| 15 | ||
| 16 | ||
| 17 | class RetrieveFileFactory(SMBProtocolFactory): | |
| 18 | ||
| 19 | def __init__(self, *args, **kwargs): | |
| 20 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 21 | self.d = defer.Deferred() | |
| 22 | self.d.addBoth(self.testDone) | |
| 23 | self.temp_fh = tempfile.NamedTemporaryFile(prefix = 'pysmbtest-') | |
| 24 | self.service = '' | |
| 25 | self.path = '' | |
| 26 | self.digest = '' | |
| 27 | self.offset = 0 | |
| 28 | self.max_length = -1 | |
| 29 | self.filesize = 0 | |
| 30 | ||
| 31 | def testDone(self, r): | |
| 32 | if self.instance: | |
| 33 | self.instance.transport.loseConnection() | |
| 34 | return r | |
| 35 | ||
| 36 | def fileRetrieved(self, write_result): | |
| 37 | file_obj, file_attributes, file_size = write_result | |
| 38 | assert file_obj == self.temp_fh | |
| 39 | ||
| 40 | md = MD5() | |
| 41 | filesize = 0 | |
| 42 | self.temp_fh.seek(0) | |
| 43 | while True: | |
| 44 | s = self.temp_fh.read(8192) | |
| 45 | if not s: | |
| 46 | break | |
| 47 | md.update(s) | |
| 48 | filesize += len(s) | |
| 49 | ||
| 50 | assert self.filesize == filesize | |
| 51 | assert md.hexdigest() == self.digest | |
| 52 | ||
| 53 | self.temp_fh.close() | |
| 54 | self.d.callback(True) | |
| 55 | self.instance.transport.loseConnection() | |
| 56 | ||
| 57 | def onAuthOK(self): | |
| 58 | assert self.service | |
| 59 | assert self.path | |
| 60 | ||
| 61 | d = self.retrieveFileFromOffset(self.service, self.path, self.temp_fh, self.offset, self.max_length, timeout = 15) | |
| 62 | d.addCallback(self.fileRetrieved) | |
| 63 | d.addErrback(self.d.errback) | |
| 64 | ||
| 65 | def onAuthFailed(self): | |
| 66 | self.d.errback('Auth failed') | |
| 67 | ||
| 68 | ||
| 69 | @deferred(timeout=30.0) | |
| 70 | def test_retr_multiplereads_SMB1(): | |
| 71 | # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes) | |
| 72 | info = getConnectionInfo() | |
| 73 | smb_structs.SUPPORT_SMB2 = False | |
| 74 | ||
| 75 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 76 | factory.service = 'smbtest' | |
| 77 | factory.path = '/rfc1001.txt' | |
| 78 | factory.digest = '5367c2bbf97f521059c78eab65309ad3' | |
| 79 | factory.filesize = 158437 | |
| 80 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 81 | return factory.d | |
| 82 | ||
| 83 | @deferred(timeout=30.0) | |
| 84 | def test_retr_multiplereads_SMB2(): | |
| 85 | # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes) | |
| 86 | info = getConnectionInfo() | |
| 87 | smb_structs.SUPPORT_SMB2 = True | |
| 88 | ||
| 89 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 90 | factory.service = 'smbtest' | |
| 91 | factory.path = '/rfc1001.txt' | |
| 92 | factory.digest = '5367c2bbf97f521059c78eab65309ad3' | |
| 93 | factory.filesize = 158437 | |
| 94 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 95 | return factory.d | |
| 96 | ||
| 97 | @deferred(timeout=30.0) | |
| 98 | def test_retr_longfilename_SMB1(): | |
| 99 | # Test file retrieval that has a long English filename | |
| 100 | info = getConnectionInfo() | |
| 101 | smb_structs.SUPPORT_SMB2 = False | |
| 102 | ||
| 103 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 104 | factory.service = 'smbtest' | |
| 105 | factory.path = '/Implementing CIFS - SMB.html' | |
| 106 | factory.digest = '671c5700d279fcbbf958c1bba3c2639e' | |
| 107 | factory.filesize = 421269 | |
| 108 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 109 | return factory.d | |
| 110 | ||
| 111 | @deferred(timeout=30.0) | |
| 112 | def test_retr_longfilename_SMB2(): | |
| 113 | # Test file retrieval that has a long English filename | |
| 114 | info = getConnectionInfo() | |
| 115 | smb_structs.SUPPORT_SMB2 = True | |
| 116 | ||
| 117 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 118 | factory.service = 'smbtest' | |
| 119 | factory.path = '/Implementing CIFS - SMB.html' | |
| 120 | factory.digest = '671c5700d279fcbbf958c1bba3c2639e' | |
| 121 | factory.filesize = 421269 | |
| 122 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 123 | return factory.d | |
| 124 | ||
| 125 | @deferred(timeout=30.0) | |
| 126 | def test_retr_unicodefilename_SMB1(): | |
| 127 | # Test file retrieval that has a long non-English filename inside a folder with a non-English name | |
| 128 | info = getConnectionInfo() | |
| 129 | smb_structs.SUPPORT_SMB2 = False | |
| 130 | ||
| 131 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 132 | factory.service = 'smbtest' | |
| 133 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 134 | factory.digest = '8a44c1e80d55e91c92350955cdf83442' | |
| 135 | factory.filesize = 256000 | |
| 136 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 137 | return factory.d | |
| 138 | ||
| 139 | @deferred(timeout=30.0) | |
| 140 | def test_retr_unicodefilename_SMB2(): | |
| 141 | # Test file retrieval that has a long non-English filename inside a folder with a non-English name | |
| 142 | info = getConnectionInfo() | |
| 143 | smb_structs.SUPPORT_SMB2 = True | |
| 144 | ||
| 145 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 146 | factory.service = 'smbtest' | |
| 147 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 148 | factory.digest = '8a44c1e80d55e91c92350955cdf83442' | |
| 149 | factory.filesize = 256000 | |
| 150 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 151 | return factory.d | |
| 152 | ||
| 153 | @deferred(timeout=30.0) | |
| 154 | def test_retr_offset_SMB1(): | |
| 155 | # Test file retrieval from offset to EOF | |
| 156 | info = getConnectionInfo() | |
| 157 | smb_structs.SUPPORT_SMB2 = False | |
| 158 | ||
| 159 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 160 | factory.service = 'smbtest' | |
| 161 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 162 | factory.digest = 'a141bd8024571ce7cb5c67f2b0d8ea0b' | |
| 163 | factory.filesize = 156000 | |
| 164 | factory.offset = 100000 | |
| 165 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 166 | return factory.d | |
| 167 | ||
| 168 | @deferred(timeout=30.0) | |
| 169 | def test_retr_offset_SMB2(): | |
| 170 | # Test file retrieval from offset to EOF | |
| 171 | info = getConnectionInfo() | |
| 172 | smb_structs.SUPPORT_SMB2 = True | |
| 173 | ||
| 174 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 175 | factory.service = 'smbtest' | |
| 176 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 177 | factory.digest = 'a141bd8024571ce7cb5c67f2b0d8ea0b' | |
| 178 | factory.filesize = 156000 | |
| 179 | factory.offset = 100000 | |
| 180 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 181 | return factory.d | |
| 182 | ||
| 183 | @deferred(timeout=30.0) | |
| 184 | def test_retr_offset_and_biglimit_SMB1(): | |
| 185 | # Test file retrieval from offset with a big max_length | |
| 186 | info = getConnectionInfo() | |
| 187 | smb_structs.SUPPORT_SMB2 = False | |
| 188 | ||
| 189 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 190 | factory.service = 'smbtest' | |
| 191 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 192 | factory.digest = '83b7afd7c92cdece3975338b5ca0b1c5' | |
| 193 | factory.filesize = 100000 | |
| 194 | factory.offset = 100000 | |
| 195 | factory.max_length = 100000 | |
| 196 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 197 | return factory.d | |
| 198 | ||
| 199 | @deferred(timeout=30.0) | |
| 200 | def test_retr_offset_and_biglimit_SMB2(): | |
| 201 | # Test file retrieval from offset with a big max_length | |
| 202 | info = getConnectionInfo() | |
| 203 | smb_structs.SUPPORT_SMB2 = True | |
| 204 | ||
| 205 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 206 | factory.service = 'smbtest' | |
| 207 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 208 | factory.digest = '83b7afd7c92cdece3975338b5ca0b1c5' | |
| 209 | factory.filesize = 100000 | |
| 210 | factory.offset = 100000 | |
| 211 | factory.max_length = 100000 | |
| 212 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 213 | return factory.d | |
| 214 | ||
| 215 | @deferred(timeout=30.0) | |
| 216 | def test_retr_offset_and_smalllimit_SMB1(): | |
| 217 | # Test file retrieval from offset with a small max_length | |
| 218 | info = getConnectionInfo() | |
| 219 | smb_structs.SUPPORT_SMB2 = False | |
| 220 | ||
| 221 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 222 | factory.service = 'smbtest' | |
| 223 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 224 | factory.digest = '746f60a96b39b712a7b6e17ddde19986' | |
| 225 | factory.filesize = 10 | |
| 226 | factory.offset = 100000 | |
| 227 | factory.max_length = 10 | |
| 228 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 229 | return factory.d | |
| 230 | ||
| 231 | @deferred(timeout=30.0) | |
| 232 | def test_retr_offset_and_smalllimit_SMB2(): | |
| 233 | # Test file retrieval from offset with a small max_length | |
| 234 | info = getConnectionInfo() | |
| 235 | smb_structs.SUPPORT_SMB2 = True | |
| 236 | ||
| 237 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 238 | factory.service = 'smbtest' | |
| 239 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 240 | factory.digest = '746f60a96b39b712a7b6e17ddde19986' | |
| 241 | factory.filesize = 10 | |
| 242 | factory.offset = 100000 | |
| 243 | factory.max_length = 10 | |
| 244 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 245 | return factory.d | |
| 246 | ||
| 247 | @deferred(timeout=30.0) | |
| 248 | def test_retr_offset_and_zerolimit_SMB1(): | |
| 249 | # Test file retrieval from offset to EOF with max_length=0 | |
| 250 | info = getConnectionInfo() | |
| 251 | smb_structs.SUPPORT_SMB2 = False | |
| 252 | ||
| 253 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 254 | factory.service = 'smbtest' | |
| 255 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 256 | factory.digest = 'd41d8cd98f00b204e9800998ecf8427e' | |
| 257 | factory.filesize = 0 | |
| 258 | factory.offset = 100000 | |
| 259 | factory.max_length = 0 | |
| 260 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 261 | return factory.d | |
| 262 | ||
| 263 | @deferred(timeout=30.0) | |
| 264 | def test_retr_offset_and_zerolimit_SMB2(): | |
| 265 | # Test file retrieval from offset to EOF with max_length=0 | |
| 266 | info = getConnectionInfo() | |
| 267 | smb_structs.SUPPORT_SMB2 = True | |
| 268 | ||
| 269 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 270 | factory.service = 'smbtest' | |
| 271 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 272 | factory.digest = 'd41d8cd98f00b204e9800998ecf8427e' | |
| 273 | factory.filesize = 0 | |
| 274 | factory.offset = 100000 | |
| 275 | factory.max_length = 0 | |
| 276 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 277 | return factory.d |
| 0 | # -*- coding: utf-8 -*- | |
| 1 | ||
| 2 | import os, time, random | |
| 3 | from io import StringIO | |
| 4 | from nose.twistedtools import reactor, deferred | |
| 5 | from twisted.internet import defer | |
| 6 | from smb.SMBProtocol import SMBProtocolFactory | |
| 7 | from smb import smb_structs | |
| 8 | from .util import getConnectionInfo | |
| 9 | ||
| 10 | try: | |
| 11 | import hashlib | |
| 12 | def MD5(): return hashlib.md5() | |
| 13 | except ImportError: | |
| 14 | import md5 | |
| 15 | def MD5(): return md5.new() | |
| 16 | ||
| 17 | class StoreFilesFactory(SMBProtocolFactory): | |
| 18 | """ | |
| 19 | A super test factory that tests store file, list files, retrieve file and delete file functionlities in sequence. | |
| 20 | """ | |
| 21 | ||
| 22 | TEST_FILENAME = os.path.join(os.path.dirname(__file__), os.pardir, 'SupportFiles', 'binary.dat') | |
| 23 | TEST_FILESIZE = 256000 | |
| 24 | TEST_DIGEST = 'bb6303f76e29f354b6fdf6ef58587e48' | |
| 25 | ||
| 26 | def __init__(self, *args, **kwargs): | |
| 27 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 28 | self.d = defer.Deferred() | |
| 29 | self.d.addBoth(self.testDone) | |
| 30 | self.service_name = '' | |
| 31 | self.filename = '' | |
| 32 | ||
| 33 | def testDone(self, r): | |
| 34 | if self.instance: | |
| 35 | self.instance.transport.loseConnection() | |
| 36 | return r | |
| 37 | ||
| 38 | def storeComplete(self, result): | |
| 39 | file_obj, filesize = result | |
| 40 | file_obj.close() | |
| 41 | assert filesize == self.TEST_FILESIZE | |
| 42 | ||
| 43 | d = self.listPath(self.service_name, os.path.dirname(self.filename.replace('/', os.sep))) | |
| 44 | d.addCallback(self.listComplete) | |
| 45 | d.addErrback(self.d.errback) | |
| 46 | ||
| 47 | def listComplete(self, entries): | |
| 48 | filenames = [e.filename for e in entries] | |
| 49 | assert os.path.basename(self.filename.replace('/', os.sep)) in filenames | |
| 50 | ||
| 51 | for entry in entries: | |
| 52 | if os.path.basename(self.filename.replace('/', os.sep)) == entry.filename: | |
| 53 | # The following asserts will fail if the remote machine's time is not in sync with the test machine's time | |
| 54 | assert abs(entry.create_time - time.time()) < 3 | |
| 55 | assert abs(entry.last_access_time - time.time()) < 3 | |
| 56 | assert abs(entry.last_write_time - time.time()) < 3 | |
| 57 | assert abs(entry.last_attr_change_time - time.time()) < 3 | |
| 58 | break | |
| 59 | ||
| 60 | d = self.retrieveFile(self.service_name, self.filename, StringIO()) | |
| 61 | d.addCallback(self.retrieveComplete) | |
| 62 | d.addErrback(self.d.errback) | |
| 63 | ||
| 64 | def retrieveComplete(self, result): | |
| 65 | file_obj, file_attributes, file_size = result | |
| 66 | ||
| 67 | md = MD5() | |
| 68 | md.update(file_obj.getvalue()) | |
| 69 | file_obj.close() | |
| 70 | ||
| 71 | assert file_size == self.TEST_FILESIZE | |
| 72 | assert md.hexdigest() == self.TEST_DIGEST | |
| 73 | ||
| 74 | d = self.deleteFiles(self.service_name, self.filename) | |
| 75 | d.addCallback(self.deleteComplete) | |
| 76 | d.addErrback(self.d.errback) | |
| 77 | ||
| 78 | def deleteComplete(self, result): | |
| 79 | d = self.listPath(self.service_name, os.path.dirname(self.filename.replace('/', os.sep))) | |
| 80 | d.addCallback(self.list2Complete) | |
| 81 | d.addErrback(self.d.errback) | |
| 82 | ||
| 83 | def list2Complete(self, entries): | |
| 84 | filenames = [e.filename for e in entries] | |
| 85 | assert os.path.basename(self.filename.replace('/', os.sep)) not in filenames | |
| 86 | self.d.callback(True) | |
| 87 | self.instance.transport.loseConnection() | |
| 88 | ||
| 89 | def onAuthOK(self): | |
| 90 | d = self.storeFile(self.service_name, self.filename, open(self.TEST_FILENAME, 'rb')) | |
| 91 | d.addCallback(self.storeComplete) | |
| 92 | d.addErrback(self.d.errback) | |
| 93 | ||
| 94 | def onAuthFailed(self): | |
| 95 | self.d.errback('Auth failed') | |
| 96 | ||
| 97 | ||
| 98 | @deferred(timeout=30.0) | |
| 99 | def test_store_long_filename_SMB1(): | |
| 100 | info = getConnectionInfo() | |
| 101 | smb_structs.SUPPORT_SMB2 = False | |
| 102 | ||
| 103 | factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 104 | factory.service_name = 'smbtest' | |
| 105 | factory.filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) | |
| 106 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 107 | return factory.d | |
| 108 | ||
| 109 | @deferred(timeout=30.0) | |
| 110 | def test_store_long_filename_SMB2(): | |
| 111 | info = getConnectionInfo() | |
| 112 | smb_structs.SUPPORT_SMB2 = True | |
| 113 | ||
| 114 | factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 115 | factory.service_name = 'smbtest' | |
| 116 | factory.filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) | |
| 117 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 118 | return factory.d | |
| 119 | ||
| 120 | @deferred(timeout=30.0) | |
| 121 | def test_store_unicode_filename_SMB1(): | |
| 122 | info = getConnectionInfo() | |
| 123 | smb_structs.SUPPORT_SMB2 = False | |
| 124 | ||
| 125 | factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 126 | factory.service_name = 'smbtest' | |
| 127 | factory.filename = os.sep + '上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) | |
| 128 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 129 | return factory.d | |
| 130 | ||
| 131 | @deferred(timeout=30.0) | |
| 132 | def test_store_unicode_filename_SMB2(): | |
| 133 | info = getConnectionInfo() | |
| 134 | smb_structs.SUPPORT_SMB2 = True | |
| 135 | ||
| 136 | factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 137 | factory.service_name = 'smbtest' | |
| 138 | factory.filename = os.sep + '上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) | |
| 139 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 140 | return factory.d |
| 0 | ||
| 1 | import os | |
| 2 | from ConfigParser import SafeConfigParser | |
| 3 | ||
| 4 | def getConnectionInfo(): | |
| 5 | config_filename = os.path.join(os.path.dirname(__file__), os.path.pardir, 'connection.ini') | |
| 6 | cp = SafeConfigParser() | |
| 7 | cp.read(config_filename) | |
| 8 | ||
| 9 | info = { | |
| 10 | 'server_name': cp.get('server', 'name'), | |
| 11 | 'server_ip': cp.get('server', 'ip'), | |
| 12 | 'server_port': cp.getint('server', 'direct_port'), | |
| 13 | 'client_name': cp.get('client', 'name'), | |
| 14 | 'user': cp.get('user', 'name'), | |
| 15 | 'password': cp.get('user', 'password'), | |
| 16 | 'is_direct_tcp': True, | |
| 17 | } | |
| 18 | return info |
| 0 | 0 | |
| 1 | 1 | from nmb.NetBIOS import NetBIOS |
| 2 | from nose.tools import with_setup | |
| 2 | from nose2.tools.decorators import with_teardown | |
| 3 | 3 | |
| 4 | 4 | conn = None |
| 5 | 5 | |
| 7 | 7 | global conn |
| 8 | 8 | conn.close() |
| 9 | 9 | |
| 10 | @with_setup(teardown = teardown_func) | |
| 10 | @with_teardown(teardown_func) | |
| 11 | 11 | def test_broadcast(): |
| 12 | 12 | global conn |
| 13 | 13 | conn = NetBIOS() |
| 0 | ||
| 1 | from nose.twistedtools import reactor, deferred | |
| 2 | from twisted.internet import defer | |
| 3 | from nmb.NetBIOSProtocol import NBNSProtocol | |
| 4 | from nose.tools import with_setup | |
| 5 | ||
| 6 | ||
| 7 | @deferred(timeout=15.0) | |
| 8 | def test_broadcast(): | |
| 9 | def cb(results): | |
| 10 | assert results | |
| 11 | ||
| 12 | def cleanup(r): | |
| 13 | p.transport.stopListening() | |
| 14 | ||
| 15 | p = NBNSProtocol() | |
| 16 | d = p.queryName('MICHAEL-I5PC', timeout = 10) | |
| 17 | d.addCallback(cb) | |
| 18 | d.addBoth(cleanup) | |
| 19 | ||
| 20 | return d |
| 0 | ||
| 1 | Steps to Follow to Run the Unit Tests | |
| 2 | ===================================== | |
| 3 | ||
| 4 | ## Step 1: Install system dependencies ## | |
| 5 | ||
| 6 | If you are using Ubuntu 20.04 LTS, you can install the system dependencies with the following command | |
| 7 | ``` | |
| 8 | $> apt-get install python3-dev python3-venv gcc g++ make automake autoconf | |
| 9 | ``` | |
| 10 | For other distributions, you can use their package managers and install the system dependencies (although the package names might differ slightly). | |
| 11 | ||
| 12 | ## Step 2: Setup python virtualenv ## | |
| 13 | ||
| 14 | We will create a python3 virtualenv and install the python dependencies for testing in the "venv3" folder. | |
| 15 | ||
| 16 | ``` | |
| 17 | $> cd <pysmb-home>/python3 | |
| 18 | $> virtualenv -p /usr/bin/python3 venv3 | |
| 19 | $> source venv3/bin/activate | |
| 20 | $venv3> pip install nose2 pyasn1 twisted | |
| 21 | ``` | |
| 22 | ||
| 23 | ## Step 3: Setup shared folder on your remote SMB server ## | |
| 24 | ||
| 25 | Prepare a shared folder called "smbtest" on your remote SMB server (Windows or Samba). | |
| 26 | ||
| 27 | Then, download [smbtest.zip](https://miketeo.net/files/Projects/pysmb/smbtest.zip) and unzip the contents of this zip file in the shared folder. | |
| 28 | ||
| 29 | You should also configure a user on the SMB server with read-write access to the "smbtest" folder. | |
| 30 | ||
| 31 | ## Step 4: Update connection details in connection.ini ## | |
| 32 | ||
| 33 | In the same folder where you are viewing this readme file, there should be an ini file called "connection.ini". Edit this file's connection details to match the shared folder's access information. | |
| 34 | ||
| 35 | ## Step 5: Run the unit tests in the python3 folder ## | |
| 36 | ||
| 37 | Before running the tests, the venv3 virtualenv must be activated. | |
| 38 | ``` | |
| 39 | $> cd <pysmb-home>/python3 | |
| 40 | $> source venv3/bin/activate | |
| 41 | ``` | |
| 42 | ||
| 43 | To run all the tests: | |
| 44 | ``` | |
| 45 | $venv3> nose2 -v tests | |
| 46 | ``` | |
| 47 | ||
| 48 | To selectively run some tests: | |
| 49 | ``` | |
| 50 | $venv3> nose2 -v tests.SMBConnectionTests | |
| 51 | $venv3> nose2 -v tests.SMBConnectionTests.test_rename | |
| 52 | $venv3> nose2 -v tests.SMBConnectionTests.test_rename.test_rename_english_file_SMB1 | |
| 53 | ``` | |
| 54 | For more information, please consult the [documentation for nose2](https://docs.nose2.io/). | |
| 55 | ||
| 56 |
| 1 | 1 | |
| 2 | 2 | import os, urllib.request, urllib.parse, urllib.error, urllib.request, urllib.error, urllib.parse, time, random |
| 3 | 3 | from smb.SMBHandler import SMBHandler |
| 4 | from . import util | |
| 4 | import util | |
| 5 | 5 | |
| 6 | 6 | |
| 7 | 7 | try: |
| 0 | 0 | |
| 1 | from nose2.tools.decorators import with_teardown | |
| 1 | 2 | from smb.SMBConnection import SMBConnection |
| 3 | from smb import smb_structs | |
| 2 | 4 | from .util import getConnectionInfo |
| 3 | from nose.tools import with_setup | |
| 4 | from smb import smb_structs | |
| 5 | 5 | |
| 6 | 6 | conn = None |
| 7 | 7 | |
| 9 | 9 | global conn |
| 10 | 10 | conn.close() |
| 11 | 11 | |
| 12 | @with_setup(teardown = teardown_func) | |
| 12 | @with_teardown(teardown_func) | |
| 13 | 13 | def test_NTLMv1_auth_SMB1(): |
| 14 | 14 | global conn |
| 15 | 15 | smb_structs.SUPPORT_SMB2 = False |
| 17 | 17 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = False) |
| 18 | 18 | assert conn.connect(info['server_ip'], info['server_port']) |
| 19 | 19 | |
| 20 | @with_setup(teardown = teardown_func) | |
| 20 | @with_teardown(teardown_func) | |
| 21 | 21 | def test_NTLMv2_auth_SMB1(): |
| 22 | 22 | global conn |
| 23 | 23 | smb_structs.SUPPORT_SMB2 = False |
| 25 | 25 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = True) |
| 26 | 26 | assert conn.connect(info['server_ip'], info['server_port']) |
| 27 | 27 | |
| 28 | @with_setup(teardown = teardown_func) | |
| 28 | @with_teardown(teardown_func) | |
| 29 | 29 | def test_NTLMv1_auth_SMB2(): |
| 30 | 30 | global conn |
| 31 | 31 | smb_structs.SUPPORT_SMB2 = True |
| 33 | 33 | conn = SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], domain = info['domain'], use_ntlm_v2 = False) |
| 34 | 34 | assert conn.connect(info['server_ip'], info['server_port']) |
| 35 | 35 | |
| 36 | @with_setup(teardown = teardown_func) | |
| 36 | @with_teardown(teardown_func) | |
| 37 | 37 | def test_NTLMv2_auth_SMB2(): |
| 38 | 38 | global conn |
| 39 | 39 | smb_structs.SUPPORT_SMB2 = True |
| 0 | 0 | # -*- coding: utf-8 -*- |
| 1 | 1 | |
| 2 | 2 | import os, time, random |
| 3 | from nose2.tools.decorators import with_setup, with_teardown | |
| 3 | 4 | from smb.SMBConnection import SMBConnection |
| 5 | from smb import smb_structs | |
| 4 | 6 | from .util import getConnectionInfo |
| 5 | from nose.tools import with_setup | |
| 6 | from smb import smb_structs | |
| 7 | 7 | |
| 8 | 8 | conn = None |
| 9 | 9 | |
| 27 | 27 | global conn |
| 28 | 28 | conn.close() |
| 29 | 29 | |
| 30 | @with_setup(setup_func_SMB1, teardown_func) | |
| 30 | @with_setup(setup_func_SMB1) | |
| 31 | @with_teardown(teardown_func) | |
| 31 | 32 | def test_english_directory_SMB1(): |
| 32 | 33 | global conn |
| 33 | 34 | |
| 44 | 45 | names = [e.filename for e in entries] |
| 45 | 46 | assert os.path.basename(path.replace('/', os.sep)) not in names |
| 46 | 47 | |
| 47 | @with_setup(setup_func_SMB2, teardown_func) | |
| 48 | @with_setup(setup_func_SMB2) | |
| 49 | @with_teardown(teardown_func) | |
| 48 | 50 | def test_english_directory_SMB2(): |
| 49 | 51 | global conn |
| 50 | 52 | |
| 61 | 63 | names = [e.filename for e in entries] |
| 62 | 64 | assert os.path.basename(path.replace('/', os.sep)) not in names |
| 63 | 65 | |
| 64 | @with_setup(setup_func_SMB1, teardown_func) | |
| 66 | @with_setup(setup_func_SMB1) | |
| 67 | @with_teardown(teardown_func) | |
| 65 | 68 | def test_unicode_directory_SMB1(): |
| 66 | 69 | global conn |
| 67 | 70 | |
| 78 | 81 | names = [e.filename for e in entries] |
| 79 | 82 | assert os.path.basename(path.replace('/', os.sep)) not in names |
| 80 | 83 | |
| 81 | @with_setup(setup_func_SMB2, teardown_func) | |
| 84 | @with_setup(setup_func_SMB2) | |
| 85 | @with_teardown(teardown_func) | |
| 82 | 86 | def test_unicode_directory_SMB2(): |
| 83 | 87 | global conn |
| 84 | 88 | |
| 1 | 1 | |
| 2 | 2 | import os, time, random |
| 3 | 3 | from io import BytesIO |
| 4 | from nose2.tools.decorators import with_setup, with_teardown | |
| 4 | 5 | from smb.SMBConnection import SMBConnection |
| 6 | from smb import smb_structs | |
| 5 | 7 | from .util import getConnectionInfo |
| 6 | from nose.tools import with_setup | |
| 7 | from smb import smb_structs | |
| 8 | 8 | |
| 9 | 9 | conn = None |
| 10 | 10 | |
| 28 | 28 | global conn |
| 29 | 29 | conn.close() |
| 30 | 30 | |
| 31 | @with_setup(setup_func_SMB1, teardown_func) | |
| 32 | def test_delete_SMB1(): | |
| 33 | global conn | |
| 34 | ||
| 35 | path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 36 | conn.createDirectory('smbtest', path) | |
| 37 | ||
| 38 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 39 | conn.storeFile('smbtest', path+"/"+filename, BytesIO(b"0123456789")) | |
| 40 | ||
| 41 | results = conn.listPath('smbtest', path) | |
| 42 | filenames = list(map(lambda r: r.filename, results)) | |
| 31 | @with_setup(setup_func_SMB1) | |
| 32 | @with_teardown(teardown_func) | |
| 33 | def test_delete_without_subfolder_SMB1(): | |
| 34 | global conn | |
| 35 | ||
| 36 | path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 37 | conn.createDirectory('smbtest', path) | |
| 38 | ||
| 39 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 40 | conn.storeFile('smbtest', path+"/"+filename, BytesIO(b"0123456789")) | |
| 41 | ||
| 42 | for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]: | |
| 43 | conn.createDirectory('smbtest', path+"/"+p) | |
| 44 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 45 | conn.storeFile('smbtest', path+"/"+p+"/"+filename, BytesIO(b"0123456789")) | |
| 46 | ||
| 47 | results = conn.listPath('smbtest', path) | |
| 48 | filenames = list(map(lambda r: r.filename, results)) | |
| 49 | assert 'aaTest.Folder' in filenames | |
| 50 | assert 'bbTest.Folder' in filenames | |
| 43 | 51 | assert 'aaTest.txt' in filenames |
| 44 | 52 | assert 'aaBest.txt' in filenames |
| 45 | 53 | assert 'aaTest.bin' in filenames |
| 50 | 58 | |
| 51 | 59 | results = conn.listPath('smbtest', path) |
| 52 | 60 | filenames = list(map(lambda r: r.filename, results)) |
| 61 | assert 'aaTest.Folder' in filenames | |
| 62 | assert 'bbTest.Folder' in filenames | |
| 53 | 63 | assert 'aaTest.txt' not in filenames |
| 54 | 64 | assert 'aaBest.txt' not in filenames |
| 55 | 65 | assert 'aaTest.bin' in filenames |
| 60 | 70 | |
| 61 | 71 | results = conn.listPath('smbtest', path) |
| 62 | 72 | filenames = list(map(lambda r: r.filename, results)) |
| 63 | assert 'aaTest.bin' not in filenames | |
| 64 | assert 'aaBest.bin' in filenames | |
| 65 | assert 'random.txt' in filenames | |
| 66 | ||
| 67 | conn.deleteFiles('smbtest', path+'/*') | |
| 68 | conn.deleteDirectory('smbtest', path) | |
| 69 | ||
| 70 | @with_setup(setup_func_SMB2, teardown_func) | |
| 71 | def test_delete_SMB2(): | |
| 72 | global conn | |
| 73 | ||
| 74 | path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 75 | conn.createDirectory('smbtest', path) | |
| 76 | ||
| 77 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 78 | conn.storeFile('smbtest', path+"/"+filename, BytesIO(b"0123456789")) | |
| 79 | ||
| 80 | results = conn.listPath('smbtest', path) | |
| 81 | filenames = list(map(lambda r: r.filename, results)) | |
| 73 | assert 'aaTest.Folder' in filenames | |
| 74 | assert 'bbTest.Folder' in filenames | |
| 75 | assert 'aaTest.bin' not in filenames | |
| 76 | assert 'aaBest.bin' in filenames | |
| 77 | assert 'random.txt' in filenames | |
| 78 | ||
| 79 | ||
| 80 | @with_setup(setup_func_SMB1) | |
| 81 | @with_teardown(teardown_func) | |
| 82 | def test_delete_with_subfolder_SMB1(): | |
| 83 | global conn | |
| 84 | ||
| 85 | path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 86 | conn.createDirectory('smbtest', path) | |
| 87 | ||
| 88 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 89 | conn.storeFile('smbtest', path+"/"+filename, BytesIO(b"0123456789")) | |
| 90 | ||
| 91 | for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]: | |
| 92 | conn.createDirectory('smbtest', path+"/"+p) | |
| 93 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 94 | conn.storeFile('smbtest', path+"/"+p+"/"+filename, BytesIO(b"0123456789")) | |
| 95 | ||
| 96 | results = conn.listPath('smbtest', path) | |
| 97 | filenames = list(map(lambda r: r.filename, results)) | |
| 98 | assert 'aaTest.Folder' in filenames | |
| 99 | assert 'bbTest.Folder' in filenames | |
| 100 | assert 'aaTest.txt' in filenames | |
| 101 | assert 'aaBest.txt' in filenames | |
| 102 | assert 'aaTest.bin' in filenames | |
| 103 | assert 'aaBest.bin' in filenames | |
| 104 | assert 'random.txt' in filenames | |
| 105 | ||
| 106 | conn.deleteFiles('smbtest', path+'/aa*.txt', delete_matching_folders=True) | |
| 107 | ||
| 108 | results = conn.listPath('smbtest', path) | |
| 109 | filenames = list(map(lambda r: r.filename, results)) | |
| 110 | assert 'aaTest.Folder' in filenames | |
| 111 | assert 'bbTest.Folder' in filenames | |
| 112 | assert 'aaTest.txt' not in filenames | |
| 113 | assert 'aaBest.txt' not in filenames | |
| 114 | assert 'aaTest.bin' in filenames | |
| 115 | assert 'aaBest.bin' in filenames | |
| 116 | assert 'random.txt' in filenames | |
| 117 | ||
| 118 | conn.deleteFiles('smbtest', path+'/aaTest.*', delete_matching_folders=True) | |
| 119 | ||
| 120 | results = conn.listPath('smbtest', path) | |
| 121 | filenames = list(map(lambda r: r.filename, results)) | |
| 122 | assert 'aaTest.Folder' not in filenames | |
| 123 | assert 'bbTest.Folder' in filenames | |
| 124 | assert 'aaTest.bin' not in filenames | |
| 125 | assert 'aaBest.bin' in filenames | |
| 126 | assert 'random.txt' in filenames | |
| 127 | ||
| 128 | ||
| 129 | @with_setup(setup_func_SMB2) | |
| 130 | @with_teardown(teardown_func) | |
| 131 | def test_delete_without_subfolder_SMB2(): | |
| 132 | global conn | |
| 133 | ||
| 134 | path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 135 | conn.createDirectory('smbtest', path) | |
| 136 | ||
| 137 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 138 | conn.storeFile('smbtest', path+"/"+filename, BytesIO(b"0123456789")) | |
| 139 | ||
| 140 | for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]: | |
| 141 | conn.createDirectory('smbtest', path+"/"+p) | |
| 142 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 143 | conn.storeFile('smbtest', path+"/"+p+"/"+filename, BytesIO(b"0123456789")) | |
| 144 | ||
| 145 | results = conn.listPath('smbtest', path) | |
| 146 | filenames = list(map(lambda r: r.filename, results)) | |
| 147 | assert 'aaTest.Folder' in filenames | |
| 148 | assert 'bbTest.Folder' in filenames | |
| 82 | 149 | assert 'aaTest.txt' in filenames |
| 83 | 150 | assert 'aaBest.txt' in filenames |
| 84 | 151 | assert 'aaTest.bin' in filenames |
| 89 | 156 | |
| 90 | 157 | results = conn.listPath('smbtest', path) |
| 91 | 158 | filenames = list(map(lambda r: r.filename, results)) |
| 159 | assert 'aaTest.Folder' in filenames | |
| 160 | assert 'bbTest.Folder' in filenames | |
| 92 | 161 | assert 'aaTest.txt' not in filenames |
| 93 | 162 | assert 'aaBest.txt' not in filenames |
| 94 | 163 | assert 'aaTest.bin' in filenames |
| 99 | 168 | |
| 100 | 169 | results = conn.listPath('smbtest', path) |
| 101 | 170 | filenames = list(map(lambda r: r.filename, results)) |
| 102 | assert 'aaTest.bin' not in filenames | |
| 103 | assert 'aaBest.bin' in filenames | |
| 104 | assert 'random.txt' in filenames | |
| 171 | assert 'aaTest.Folder' in filenames | |
| 172 | assert 'bbTest.Folder' in filenames | |
| 173 | assert 'aaTest.bin' not in filenames | |
| 174 | assert 'aaBest.bin' in filenames | |
| 175 | assert 'random.txt' in filenames | |
| 176 | ||
| 177 | @with_setup(setup_func_SMB2) | |
| 178 | @with_teardown(teardown_func) | |
| 179 | def test_delete_with_subfolder_SMB2(): | |
| 180 | global conn | |
| 181 | ||
| 182 | path = os.sep + u'testDelete %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 183 | conn.createDirectory('smbtest', path) | |
| 184 | ||
| 185 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 186 | conn.storeFile('smbtest', path+"/"+filename, BytesIO(b"0123456789")) | |
| 187 | ||
| 188 | for p in [ 'aaTest.Folder', 'aaTest.Folder/xyz', 'bbTest.Folder' ]: | |
| 189 | conn.createDirectory('smbtest', path+"/"+p) | |
| 190 | for filename in [ 'aaTest.txt', 'aaBest.txt', 'aaTest.bin', 'aaBest.bin', 'random.txt' ]: | |
| 191 | conn.storeFile('smbtest', path+"/"+p+"/"+filename, BytesIO(b"0123456789")) | |
| 192 | ||
| 193 | results = conn.listPath('smbtest', path) | |
| 194 | filenames = list(map(lambda r: r.filename, results)) | |
| 195 | assert 'aaTest.Folder' in filenames | |
| 196 | assert 'bbTest.Folder' in filenames | |
| 197 | assert 'aaTest.txt' in filenames | |
| 198 | assert 'aaBest.txt' in filenames | |
| 199 | assert 'aaTest.bin' in filenames | |
| 200 | assert 'aaBest.bin' in filenames | |
| 201 | assert 'random.txt' in filenames | |
| 202 | ||
| 203 | conn.deleteFiles('smbtest', path+'/aa*.txt', delete_matching_folders=True) | |
| 204 | ||
| 205 | results = conn.listPath('smbtest', path) | |
| 206 | filenames = list(map(lambda r: r.filename, results)) | |
| 207 | assert 'aaTest.Folder' in filenames | |
| 208 | assert 'bbTest.Folder' in filenames | |
| 209 | assert 'aaTest.txt' not in filenames | |
| 210 | assert 'aaBest.txt' not in filenames | |
| 211 | assert 'aaTest.bin' in filenames | |
| 212 | assert 'aaBest.bin' in filenames | |
| 213 | assert 'random.txt' in filenames | |
| 214 | ||
| 215 | conn.deleteFiles('smbtest', path+'/aaTest.*', delete_matching_folders=True) | |
| 216 | ||
| 217 | results = conn.listPath('smbtest', path) | |
| 218 | filenames = list(map(lambda r: r.filename, results)) | |
| 219 | assert 'aaTest.Folder' not in filenames | |
| 220 | assert 'bbTest.Folder' in filenames | |
| 221 | assert 'aaTest.bin' not in filenames | |
| 222 | assert 'aaBest.bin' in filenames | |
| 223 | assert 'random.txt' in filenames | |
| 0 | 0 | |
| 1 | 1 | import random |
| 2 | from nose2.tools.decorators import with_setup, with_teardown | |
| 2 | 3 | from smb.SMBConnection import SMBConnection |
| 3 | 4 | from .util import getConnectionInfo |
| 4 | from nose.tools import with_setup | |
| 5 | 5 | |
| 6 | 6 | conn = None |
| 7 | 7 | |
| 15 | 15 | global conn |
| 16 | 16 | conn.close() |
| 17 | 17 | |
| 18 | @with_setup(setup_func, teardown_func) | |
| 18 | @with_setup(setup_func) | |
| 19 | @with_teardown(teardown_func) | |
| 19 | 20 | def test_echo(): |
| 20 | 21 | global conn |
| 21 | 22 | |
| 1 | 1 | |
| 2 | 2 | from smb.SMBConnection import SMBConnection |
| 3 | 3 | from .util import getConnectionInfo |
| 4 | from nose.tools import with_setup | |
| 4 | from nose2.tools.decorators import with_setup | |
| 5 | 5 | from smb import smb_structs |
| 6 | 6 | |
| 7 | 7 | conn = None |
| 0 | 0 | # -*- coding: utf-8 -*- |
| 1 | 1 | |
| 2 | from nose2.tools.decorators import with_setup, with_teardown | |
| 2 | 3 | from smb.SMBConnection import SMBConnection |
| 4 | from smb.smb_constants import * | |
| 5 | from smb import smb_structs | |
| 3 | 6 | from .util import getConnectionInfo |
| 4 | from nose.tools import with_setup | |
| 5 | from smb import smb_structs | |
| 6 | 7 | |
| 7 | 8 | conn = None |
| 8 | 9 | |
| 24 | 25 | global conn |
| 25 | 26 | conn.close() |
| 26 | 27 | |
| 27 | @with_setup(setup_func_SMB1, teardown_func) | |
| 28 | @with_setup(setup_func_SMB1) | |
| 29 | @with_teardown(teardown_func) | |
| 28 | 30 | def test_listPath_SMB1(): |
| 29 | 31 | global conn |
| 30 | 32 | results = conn.listPath('smbtest', '/') |
| 35 | 37 | assert ( 'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names |
| 36 | 38 | assert ( 'rfc1001.txt', False ) in filenames # Test short English file names |
| 37 | 39 | |
| 38 | @with_setup(setup_func_SMB1, teardown_func) | |
| 40 | @with_setup(setup_func_SMB1) | |
| 41 | @with_teardown(teardown_func) | |
| 39 | 42 | def test_listSubPath_SMB1(): |
| 40 | 43 | global conn |
| 41 | 44 | results = conn.listPath('smbtest', '/Test Folder with Long Name/') |
| 44 | 47 | assert ( 'Test Folder', True ) in filenames |
| 45 | 48 | assert ( '子文件夹', True ) in filenames |
| 46 | 49 | |
| 47 | @with_setup(setup_func_SMB2, teardown_func) | |
| 50 | @with_setup(setup_func_SMB1) | |
| 51 | @with_teardown(teardown_func) | |
| 52 | def test_listPathWithManyFiles_SMB1(): | |
| 53 | global conn | |
| 54 | results = conn.listPath('smbtest', '/RFC Archive/') | |
| 55 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 56 | assert len(list(filenames))==999 | |
| 57 | ||
| 58 | @with_setup(setup_func_SMB2) | |
| 59 | @with_teardown(teardown_func) | |
| 48 | 60 | def test_listPath_SMB2(): |
| 49 | 61 | global conn |
| 50 | 62 | results = conn.listPath('smbtest', '/') |
| 55 | 67 | assert ( 'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names |
| 56 | 68 | assert ( 'rfc1001.txt', False ) in filenames # Test short English file names |
| 57 | 69 | |
| 58 | @with_setup(setup_func_SMB2, teardown_func) | |
| 70 | @with_setup(setup_func_SMB2) | |
| 71 | @with_teardown(teardown_func) | |
| 59 | 72 | def test_listSubPath_SMB2(): |
| 60 | 73 | global conn |
| 61 | 74 | results = conn.listPath('smbtest', '/Test Folder with Long Name/') |
| 63 | 76 | assert ( 'Test File.txt', False ) in filenames |
| 64 | 77 | assert ( 'Test Folder', True ) in filenames |
| 65 | 78 | assert ( '子文件夹', True ) in filenames |
| 79 | ||
| 80 | @with_setup(setup_func_SMB2) | |
| 81 | @with_teardown(teardown_func) | |
| 82 | def test_listPathWithManyFiles_SMB2(): | |
| 83 | global conn | |
| 84 | results = conn.listPath('smbtest', '/RFC Archive/') | |
| 85 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 86 | assert len(list(filenames))==999 | |
| 87 | ||
| 88 | @with_setup(setup_func_SMB1) | |
| 89 | @with_teardown(teardown_func) | |
| 90 | def test_listPathFilterForDirectory_SMB1(): | |
| 91 | global conn | |
| 92 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY) | |
| 93 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 94 | assert len(list(filenames)) > 0 | |
| 95 | for f, isDirectory in filenames: | |
| 96 | assert isDirectory | |
| 97 | ||
| 98 | @with_setup(setup_func_SMB2) | |
| 99 | @with_teardown(teardown_func) | |
| 100 | def test_listPathFilterForDirectory_SMB2(): | |
| 101 | global conn | |
| 102 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_DIRECTORY) | |
| 103 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 104 | assert len(list(filenames)) > 0 | |
| 105 | for f, isDirectory in filenames: | |
| 106 | assert isDirectory | |
| 107 | ||
| 108 | @with_setup(setup_func_SMB1) | |
| 109 | @with_teardown(teardown_func) | |
| 110 | def test_listPathFilterForFiles_SMB1(): | |
| 111 | global conn | |
| 112 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL) | |
| 113 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 114 | assert len(list(filenames)) > 0 | |
| 115 | for f, isDirectory in filenames: | |
| 116 | assert not isDirectory | |
| 117 | ||
| 118 | @with_setup(setup_func_SMB2) | |
| 119 | @with_teardown(teardown_func) | |
| 120 | def test_listPathFilterForFiles_SMB2(): | |
| 121 | global conn | |
| 122 | results = conn.listPath('smbtest', '/Test Folder with Long Name', search = SMB_FILE_ATTRIBUTE_READONLY | SMB_FILE_ATTRIBUTE_HIDDEN | SMB_FILE_ATTRIBUTE_SYSTEM | SMB_FILE_ATTRIBUTE_ARCHIVE | SMB_FILE_ATTRIBUTE_INCL_NORMAL) | |
| 123 | filenames = map(lambda r: ( r.filename, r.isDirectory ), results) | |
| 124 | assert len(list(filenames)) > 0 | |
| 125 | for f, isDirectory in filenames: | |
| 126 | assert not isDirectory | |
| 127 | ||
| 128 | @with_setup(setup_func_SMB1) | |
| 129 | @with_teardown(teardown_func) | |
| 130 | def test_listPathFilterPattern_SMB1(): | |
| 131 | global conn | |
| 132 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*') | |
| 133 | filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results)) | |
| 134 | assert len(filenames) == 2 | |
| 135 | assert ( u'Test File.txt', False ) in filenames | |
| 136 | assert ( u'Test Folder', True ) in filenames | |
| 137 | assert ( u'子文件夹', True ) not in filenames | |
| 138 | ||
| 139 | @with_setup(setup_func_SMB2) | |
| 140 | @with_teardown(teardown_func) | |
| 141 | def test_listPathFilterPattern_SMB2(): | |
| 142 | global conn | |
| 143 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = 'Test*') | |
| 144 | filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results)) | |
| 145 | assert len(filenames) == 2 | |
| 146 | assert ( u'Test File.txt', False ) in filenames | |
| 147 | assert ( u'Test Folder', True ) in filenames | |
| 148 | assert ( u'子文件夹', True ) not in filenames | |
| 149 | ||
| 150 | @with_setup(setup_func_SMB1) | |
| 151 | @with_teardown(teardown_func) | |
| 152 | def test_listPathFilterUnicodePattern_SMB1(): | |
| 153 | global conn | |
| 154 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹') | |
| 155 | filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results)) | |
| 156 | assert len(filenames) == 1 | |
| 157 | assert ( u'Test File.txt', False ) not in filenames | |
| 158 | assert ( u'Test Folder', True ) not in filenames | |
| 159 | assert ( u'子文件夹', True ) in filenames | |
| 160 | ||
| 161 | @with_setup(setup_func_SMB2) | |
| 162 | @with_teardown(teardown_func) | |
| 163 | def test_listPathFilterUnicodePattern_SMB2(): | |
| 164 | global conn | |
| 165 | results = conn.listPath('smbtest', '/Test Folder with Long Name', pattern = u'*件夹') | |
| 166 | filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results)) | |
| 167 | assert len(filenames) == 1 | |
| 168 | assert ( u'Test File.txt', False ) not in filenames | |
| 169 | assert ( u'Test Folder', True ) not in filenames | |
| 170 | assert ( u'子文件夹', True ) in filenames | |
| 171 | ||
| 172 | @with_setup(setup_func_SMB1) | |
| 173 | @with_teardown(teardown_func) | |
| 174 | def test_listPathFilterEmptyList_SMB1(): | |
| 175 | global conn | |
| 176 | results = conn.listPath('smbtest', '/RFC Archive', pattern = '*.abc') | |
| 177 | filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results)) | |
| 178 | ||
| 179 | @with_setup(setup_func_SMB2) | |
| 180 | @with_teardown(teardown_func) | |
| 181 | def test_listPathFilterEmptyList_SMB2(): | |
| 182 | global conn | |
| 183 | results = conn.listPath('smbtest', '/RFC Archive', pattern = '*.abc') | |
| 184 | filenames = list(map(lambda r: ( r.filename, r.isDirectory ), results)) | |
| 0 | 0 | |
| 1 | from nose2.tools.decorators import with_setup, with_teardown | |
| 1 | 2 | from smb.SMBConnection import SMBConnection |
| 3 | from smb import smb_structs | |
| 2 | 4 | from .util import getConnectionInfo |
| 3 | from nose.tools import with_setup | |
| 4 | from smb import smb_structs | |
| 5 | 5 | |
| 6 | 6 | conn = None |
| 7 | 7 | |
| 23 | 23 | global conn |
| 24 | 24 | conn.close() |
| 25 | 25 | |
| 26 | @with_setup(setup_func_SMB1, teardown_func) | |
| 26 | @with_setup(setup_func_SMB1) | |
| 27 | @with_teardown(teardown_func) | |
| 27 | 28 | def test_listshares_SMB1(): |
| 28 | 29 | global conn |
| 29 | 30 | results = conn.listShares() |
| 30 | 31 | assert 'smbtest' in [r.name.lower() for r in results] |
| 31 | 32 | |
| 32 | @with_setup(setup_func_SMB2, teardown_func) | |
| 33 | @with_setup(setup_func_SMB2) | |
| 34 | @with_teardown(teardown_func) | |
| 33 | 35 | def test_listshares_SMB2(): |
| 34 | 36 | global conn |
| 35 | 37 | results = conn.listShares() |
| 0 | 0 | |
| 1 | from nose2.tools.decorators import with_setup, with_teardown | |
| 1 | 2 | from smb.SMBConnection import SMBConnection |
| 3 | from smb import smb_structs | |
| 2 | 4 | from .util import getConnectionInfo |
| 3 | from nose.tools import with_setup | |
| 4 | from smb import smb_structs | |
| 5 | 5 | |
| 6 | 6 | conn = None |
| 7 | 7 | |
| 23 | 23 | global conn |
| 24 | 24 | conn.close() |
| 25 | 25 | |
| 26 | @with_setup(setup_func_SMB1, teardown_func) | |
| 26 | @with_setup(setup_func_SMB1) | |
| 27 | @with_teardown(teardown_func) | |
| 27 | 28 | def test_listsnapshots_SMB1(): |
| 28 | 29 | global conn |
| 29 | 30 | results = conn.listSnapshots('smbtest', '/rfc1001.txt') |
| 30 | 31 | assert len(results) > 0 |
| 31 | 32 | |
| 32 | @with_setup(setup_func_SMB2, teardown_func) | |
| 33 | @with_setup(setup_func_SMB2) | |
| 34 | @with_teardown(teardown_func) | |
| 33 | 35 | def test_listsnapshots_SMB2(): |
| 34 | 36 | global conn |
| 35 | 37 | results = conn.listSnapshots('smbtest', '/rfc1001.txt') |
| 1 | 1 | |
| 2 | 2 | import os, time, random |
| 3 | 3 | from io import BytesIO |
| 4 | from nose2.tools.decorators import with_setup, with_teardown | |
| 4 | 5 | from smb.SMBConnection import SMBConnection |
| 6 | from smb import smb_structs | |
| 5 | 7 | from .util import getConnectionInfo |
| 6 | from nose.tools import with_setup | |
| 7 | from smb import smb_structs | |
| 8 | 8 | |
| 9 | 9 | conn = None |
| 10 | 10 | |
| 26 | 26 | global conn |
| 27 | 27 | conn.close() |
| 28 | 28 | |
| 29 | @with_setup(setup_func_SMB1, teardown_func) | |
| 29 | @with_setup(setup_func_SMB1) | |
| 30 | @with_teardown(teardown_func) | |
| 30 | 31 | def test_rename_english_file_SMB1(): |
| 31 | 32 | global conn |
| 32 | 33 | |
| 49 | 50 | |
| 50 | 51 | conn.deleteFiles('smbtest', new_path) |
| 51 | 52 | |
| 52 | @with_setup(setup_func_SMB2, teardown_func) | |
| 53 | @with_setup(setup_func_SMB2) | |
| 54 | @with_teardown(teardown_func) | |
| 53 | 55 | def test_rename_english_file_SMB2(): |
| 54 | 56 | global conn |
| 55 | 57 | |
| 72 | 74 | |
| 73 | 75 | conn.deleteFiles('smbtest', new_path) |
| 74 | 76 | |
| 75 | @with_setup(setup_func_SMB1, teardown_func) | |
| 77 | @with_setup(setup_func_SMB1) | |
| 78 | @with_teardown(teardown_func) | |
| 76 | 79 | def test_rename_unicode_file_SMB1(): |
| 77 | 80 | global conn |
| 78 | 81 | |
| 95 | 98 | |
| 96 | 99 | conn.deleteFiles('smbtest', new_path) |
| 97 | 100 | |
| 98 | @with_setup(setup_func_SMB2, teardown_func) | |
| 101 | @with_setup(setup_func_SMB2) | |
| 102 | @with_teardown(teardown_func) | |
| 99 | 103 | def test_rename_unicode_file_SMB2(): |
| 100 | 104 | global conn |
| 101 | 105 | |
| 118 | 122 | |
| 119 | 123 | conn.deleteFiles('smbtest', new_path) |
| 120 | 124 | |
| 121 | @with_setup(setup_func_SMB1, teardown_func) | |
| 125 | @with_setup(setup_func_SMB1) | |
| 126 | @with_teardown(teardown_func) | |
| 122 | 127 | def test_rename_english_directory_SMB1(): |
| 123 | 128 | global conn |
| 124 | 129 | |
| 141 | 146 | |
| 142 | 147 | conn.deleteDirectory('smbtest', new_path) |
| 143 | 148 | |
| 144 | @with_setup(setup_func_SMB2, teardown_func) | |
| 149 | @with_setup(setup_func_SMB2) | |
| 150 | @with_teardown(teardown_func) | |
| 145 | 151 | def test_rename_english_directory_SMB2(): |
| 146 | 152 | global conn |
| 147 | 153 | |
| 164 | 170 | |
| 165 | 171 | conn.deleteDirectory('smbtest', new_path) |
| 166 | 172 | |
| 167 | @with_setup(setup_func_SMB1, teardown_func) | |
| 173 | @with_setup(setup_func_SMB1) | |
| 174 | @with_teardown(teardown_func) | |
| 168 | 175 | def test_rename_unicode_directory_SMB1(): |
| 169 | 176 | global conn |
| 170 | 177 | |
| 187 | 194 | |
| 188 | 195 | conn.deleteDirectory('smbtest', new_path) |
| 189 | 196 | |
| 190 | @with_setup(setup_func_SMB2, teardown_func) | |
| 197 | @with_setup(setup_func_SMB2) | |
| 198 | @with_teardown(teardown_func) | |
| 191 | 199 | def test_rename_unicode_directory_SMB2(): |
| 192 | 200 | global conn |
| 193 | 201 | |
| 1 | 1 | |
| 2 | 2 | import os, tempfile |
| 3 | 3 | from io import BytesIO |
| 4 | from nose2.tools.decorators import with_setup, with_teardown | |
| 4 | 5 | from smb.SMBConnection import SMBConnection |
| 6 | from smb import smb_structs | |
| 5 | 7 | from .util import getConnectionInfo |
| 6 | from nose.tools import with_setup | |
| 7 | from smb import smb_structs | |
| 8 | 8 | |
| 9 | 9 | try: |
| 10 | 10 | import hashlib |
| 33 | 33 | global conn |
| 34 | 34 | conn.close() |
| 35 | 35 | |
| 36 | @with_setup(setup_func_SMB1, teardown_func) | |
| 36 | @with_setup(setup_func_SMB1) | |
| 37 | @with_teardown(teardown_func) | |
| 37 | 38 | def test_retr_multiplereads_SMB1(): |
| 38 | 39 | # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes) |
| 39 | 40 | global conn |
| 47 | 48 | |
| 48 | 49 | temp_fh.close() |
| 49 | 50 | |
| 50 | @with_setup(setup_func_SMB2, teardown_func) | |
| 51 | @with_setup(setup_func_SMB2) | |
| 52 | @with_teardown(teardown_func) | |
| 51 | 53 | def test_retr_multiplereads_SMB2(): |
| 52 | 54 | # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes) |
| 53 | 55 | global conn |
| 61 | 63 | |
| 62 | 64 | temp_fh.close() |
| 63 | 65 | |
| 64 | @with_setup(setup_func_SMB1, teardown_func) | |
| 66 | @with_setup(setup_func_SMB1) | |
| 67 | @with_teardown(teardown_func) | |
| 65 | 68 | def test_retr_longfilename_SMB1(): |
| 66 | 69 | # Test file retrieval that has a long English filename |
| 67 | 70 | global conn |
| 75 | 78 | |
| 76 | 79 | temp_fh.close() |
| 77 | 80 | |
| 78 | @with_setup(setup_func_SMB2, teardown_func) | |
| 81 | @with_setup(setup_func_SMB2) | |
| 82 | @with_teardown(teardown_func) | |
| 79 | 83 | def test_retr_longfilename_SMB2(): |
| 80 | 84 | # Test file retrieval that has a long English filename |
| 81 | 85 | global conn |
| 89 | 93 | |
| 90 | 94 | temp_fh.close() |
| 91 | 95 | |
| 92 | @with_setup(setup_func_SMB1, teardown_func) | |
| 96 | @with_setup(setup_func_SMB1) | |
| 97 | @with_teardown(teardown_func) | |
| 93 | 98 | def test_retr_unicodefilename_SMB1(): |
| 94 | 99 | # Test file retrieval that has a long non-English filename inside a folder with a non-English name |
| 95 | 100 | global conn |
| 103 | 108 | |
| 104 | 109 | temp_fh.close() |
| 105 | 110 | |
| 106 | @with_setup(setup_func_SMB2, teardown_func) | |
| 111 | @with_setup(setup_func_SMB2) | |
| 112 | @with_teardown(teardown_func) | |
| 107 | 113 | def test_retr_unicodefilename_SMB2(): |
| 108 | 114 | # Test file retrieval that has a long non-English filename inside a folder with a non-English name |
| 109 | 115 | global conn |
| 117 | 123 | |
| 118 | 124 | temp_fh.close() |
| 119 | 125 | |
| 120 | @with_setup(setup_func_SMB1, teardown_func) | |
| 126 | @with_setup(setup_func_SMB1) | |
| 127 | @with_teardown(teardown_func) | |
| 121 | 128 | def test_retr_offset_SMB1(): |
| 122 | 129 | # Test file retrieval from offset to EOF |
| 123 | 130 | global conn |
| 131 | 138 | |
| 132 | 139 | temp_fh.close() |
| 133 | 140 | |
| 134 | @with_setup(setup_func_SMB2, teardown_func) | |
| 141 | @with_setup(setup_func_SMB2) | |
| 142 | @with_teardown(teardown_func) | |
| 135 | 143 | def test_retr_offset_SMB2(): |
| 136 | 144 | # Test file retrieval from offset to EOF |
| 137 | 145 | global conn |
| 145 | 153 | |
| 146 | 154 | temp_fh.close() |
| 147 | 155 | |
| 148 | @with_setup(setup_func_SMB1, teardown_func) | |
| 156 | @with_setup(setup_func_SMB1) | |
| 157 | @with_teardown(teardown_func) | |
| 149 | 158 | def test_retr_offset_and_biglimit_SMB1(): |
| 150 | 159 | # Test file retrieval from offset with a big max_length |
| 151 | 160 | global conn |
| 159 | 168 | |
| 160 | 169 | temp_fh.close() |
| 161 | 170 | |
| 162 | @with_setup(setup_func_SMB2, teardown_func) | |
| 171 | @with_setup(setup_func_SMB2) | |
| 172 | @with_teardown(teardown_func) | |
| 163 | 173 | def test_retr_offset_and_biglimit_SMB2(): |
| 164 | 174 | # Test file retrieval from offset with a big max_length |
| 165 | 175 | global conn |
| 173 | 183 | |
| 174 | 184 | temp_fh.close() |
| 175 | 185 | |
| 176 | @with_setup(setup_func_SMB1, teardown_func) | |
| 186 | @with_setup(setup_func_SMB1) | |
| 187 | @with_teardown(teardown_func) | |
| 177 | 188 | def test_retr_offset_and_smalllimit_SMB1(): |
| 178 | 189 | # Test file retrieval from offset with a small max_length |
| 179 | 190 | global conn |
| 187 | 198 | |
| 188 | 199 | temp_fh.close() |
| 189 | 200 | |
| 190 | @with_setup(setup_func_SMB2, teardown_func) | |
| 201 | @with_setup(setup_func_SMB2) | |
| 202 | @with_teardown(teardown_func) | |
| 191 | 203 | def test_retr_offset_and_smalllimit_SMB2(): |
| 192 | 204 | # Test file retrieval from offset with a small max_length |
| 193 | 205 | global conn |
| 201 | 213 | |
| 202 | 214 | temp_fh.close() |
| 203 | 215 | |
| 204 | @with_setup(setup_func_SMB1, teardown_func) | |
| 216 | @with_setup(setup_func_SMB1) | |
| 217 | @with_teardown(teardown_func) | |
| 205 | 218 | def test_retr_offset_and_zerolimit_SMB1(): |
| 206 | 219 | # Test file retrieval from offset to EOF with max_length=0 |
| 207 | 220 | global conn |
| 215 | 228 | |
| 216 | 229 | temp_fh.close() |
| 217 | 230 | |
| 218 | @with_setup(setup_func_SMB2, teardown_func) | |
| 231 | @with_setup(setup_func_SMB2) | |
| 232 | @with_teardown(teardown_func) | |
| 219 | 233 | def test_retr_offset_and_zerolimit_SMB2(): |
| 220 | 234 | # Test file retrieval from offset to EOF with max_length=0 |
| 221 | 235 | global conn |
| 1 | 1 | |
| 2 | 2 | import os, tempfile, random, time |
| 3 | 3 | from io import BytesIO |
| 4 | from nose2.tools.decorators import with_setup, with_teardown | |
| 4 | 5 | from smb.SMBConnection import SMBConnection |
| 6 | from smb import smb_structs | |
| 5 | 7 | from .util import getConnectionInfo |
| 6 | from nose.tools import with_setup | |
| 7 | from smb import smb_structs | |
| 8 | 8 | |
| 9 | 9 | try: |
| 10 | 10 | import hashlib |
| 40 | 40 | conn.close() |
| 41 | 41 | |
| 42 | 42 | |
| 43 | @with_setup(setup_func_SMB1, teardown_func) | |
| 43 | @with_setup(setup_func_SMB1) | |
| 44 | @with_teardown(teardown_func) | |
| 44 | 45 | def test_store_long_filename_SMB1(): |
| 45 | 46 | filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) |
| 46 | 47 | |
| 63 | 64 | conn.deleteFiles('smbtest', filename) |
| 64 | 65 | |
| 65 | 66 | |
| 66 | @with_setup(setup_func_SMB2, teardown_func) | |
| 67 | @with_setup(setup_func_SMB2) | |
| 68 | @with_teardown(teardown_func) | |
| 67 | 69 | def test_store_long_filename_SMB2(): |
| 68 | 70 | filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) |
| 69 | 71 | |
| 86 | 88 | conn.deleteFiles('smbtest', filename) |
| 87 | 89 | |
| 88 | 90 | |
| 89 | @with_setup(setup_func_SMB1, teardown_func) | |
| 91 | @with_setup(setup_func_SMB1) | |
| 92 | @with_teardown(teardown_func) | |
| 90 | 93 | def test_store_unicode_filename_SMB1(): |
| 91 | 94 | filename = os.sep + '上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) |
| 92 | 95 | |
| 109 | 112 | conn.deleteFiles('smbtest', filename) |
| 110 | 113 | |
| 111 | 114 | |
| 112 | @with_setup(setup_func_SMB1, teardown_func) | |
| 115 | @with_setup(setup_func_SMB1) | |
| 116 | @with_teardown(teardown_func) | |
| 113 | 117 | def test_store_from_offset_SMB1(): |
| 114 | 118 | filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) |
| 115 | 119 | |
| 129 | 133 | |
| 130 | 134 | conn.deleteFiles('smbtest', filename) |
| 131 | 135 | |
| 132 | @with_setup(setup_func_SMB2, teardown_func) | |
| 136 | @with_setup(setup_func_SMB2) | |
| 137 | @with_teardown(teardown_func) | |
| 133 | 138 | def test_store_unicode_filename_SMB2(): |
| 134 | 139 | filename = os.sep + '上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) |
| 135 | 140 | |
| 151 | 156 | |
| 152 | 157 | conn.deleteFiles('smbtest', filename) |
| 153 | 158 | |
| 154 | @with_setup(setup_func_SMB2, teardown_func) | |
| 159 | @with_setup(setup_func_SMB2) | |
| 160 | @with_teardown(teardown_func) | |
| 155 | 161 | def test_store_from_offset_SMB2(): |
| 156 | 162 | filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) |
| 157 | 163 | |
| 0 | # -*- coding: utf-8 -*- | |
| 1 | ||
| 2 | from smb.SMBConnection import SMBConnection | |
| 3 | from .util import getConnectionInfo | |
| 4 | ||
| 5 | def test_context(): | |
| 6 | info = getConnectionInfo() | |
| 7 | with SMBConnection(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) as conn: | |
| 8 | assert conn.connect(info['server_ip'], info['server_port']) | |
| 9 | ||
| 10 | assert conn.sock is None |
| 0 | ||
| 1 | from nose.twistedtools import reactor, deferred | |
| 2 | from twisted.internet import defer | |
| 3 | from smb.SMBProtocol import SMBProtocolFactory | |
| 4 | from smb import smb_structs | |
| 5 | from .util import getConnectionInfo | |
| 6 | ||
| 7 | ||
| 8 | class AuthFactory(SMBProtocolFactory): | |
| 9 | ||
| 10 | def __init__(self, *args, **kwargs): | |
| 11 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 12 | self.d = defer.Deferred() | |
| 13 | self.d.addBoth(self.testDone) | |
| 14 | ||
| 15 | def testDone(self, r): | |
| 16 | if self.instance: | |
| 17 | self.instance.transport.loseConnection() | |
| 18 | return r | |
| 19 | ||
| 20 | def onAuthOK(self): | |
| 21 | self.d.callback(True) | |
| 22 | ||
| 23 | def onAuthFailed(self): | |
| 24 | self.d.callback(False) | |
| 25 | ||
| 26 | ||
| 27 | @deferred(timeout=5.0) | |
| 28 | def test_NTLMv1_auth_SMB1(): | |
| 29 | def result(auth_passed): | |
| 30 | assert auth_passed | |
| 31 | ||
| 32 | smb_structs.SUPPORT_SMB2 = False | |
| 33 | info = getConnectionInfo() | |
| 34 | factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False) | |
| 35 | factory.d.addCallback(result) | |
| 36 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 37 | return factory.d | |
| 38 | ||
| 39 | ||
| 40 | @deferred(timeout=5.0) | |
| 41 | def test_NTLMv2_auth_SMB1(): | |
| 42 | def result(auth_passed): | |
| 43 | assert auth_passed | |
| 44 | ||
| 45 | smb_structs.SUPPORT_SMB2 = False | |
| 46 | info = getConnectionInfo() | |
| 47 | factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 48 | factory.d.addCallback(result) | |
| 49 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 50 | return factory.d | |
| 51 | ||
| 52 | ||
| 53 | @deferred(timeout=5.0) | |
| 54 | def test_NTLMv1_auth_SMB2(): | |
| 55 | def result(auth_passed): | |
| 56 | assert auth_passed | |
| 57 | ||
| 58 | smb_structs.SUPPORT_SMB2 = True | |
| 59 | info = getConnectionInfo() | |
| 60 | factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = False) | |
| 61 | factory.d.addCallback(result) | |
| 62 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 63 | return factory.d | |
| 64 | ||
| 65 | ||
| 66 | @deferred(timeout=5.0) | |
| 67 | def test_NTLMv2_auth_SMB2(): | |
| 68 | def result(auth_passed): | |
| 69 | assert auth_passed | |
| 70 | ||
| 71 | smb_structs.SUPPORT_SMB2 = True | |
| 72 | info = getConnectionInfo() | |
| 73 | factory = AuthFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 74 | factory.d.addCallback(result) | |
| 75 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 76 | return factory.d |
| 0 | # -*- coding: utf-8 -*- | |
| 1 | ||
| 2 | import os, random, time | |
| 3 | from nose.twistedtools import reactor, deferred | |
| 4 | from twisted.internet import defer | |
| 5 | from smb.SMBProtocol import SMBProtocolFactory | |
| 6 | from smb import smb_structs | |
| 7 | from .util import getConnectionInfo | |
| 8 | ||
| 9 | ||
| 10 | class DirectoryFactory(SMBProtocolFactory): | |
| 11 | ||
| 12 | def __init__(self, *args, **kwargs): | |
| 13 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 14 | self.d = defer.Deferred() | |
| 15 | self.d.addBoth(self.testDone) | |
| 16 | self.service_name = '' | |
| 17 | self.path = '' | |
| 18 | ||
| 19 | def testDone(self, r): | |
| 20 | if self.instance: | |
| 21 | self.instance.transport.loseConnection() | |
| 22 | return r | |
| 23 | ||
| 24 | def createDone(self, result): | |
| 25 | d = self.listPath(self.service_name, os.path.dirname(self.path.replace('/', os.sep))) | |
| 26 | d.addCallback(self.listComplete) | |
| 27 | d.addErrback(self.d.errback) | |
| 28 | ||
| 29 | def listComplete(self, entries): | |
| 30 | names = [e.filename for e in entries] | |
| 31 | assert os.path.basename(self.path.replace('/', os.sep)) in names | |
| 32 | ||
| 33 | d = self.deleteDirectory(self.service_name, self.path) | |
| 34 | d.addCallback(self.deleteDone) | |
| 35 | d.addErrback(self.d.errback) | |
| 36 | ||
| 37 | def deleteDone(self, result): | |
| 38 | d = self.listPath(self.service_name, os.path.dirname(self.path.replace('/', os.sep))) | |
| 39 | d.addCallback(self.list2Complete) | |
| 40 | d.addErrback(self.d.errback) | |
| 41 | ||
| 42 | def list2Complete(self, entries): | |
| 43 | names = [e.filename for e in entries] | |
| 44 | assert os.path.basename(self.path.replace('/', os.sep)) not in names | |
| 45 | self.d.callback(True) | |
| 46 | ||
| 47 | def onAuthOK(self): | |
| 48 | d = self.createDirectory(self.service_name, self.path) | |
| 49 | d.addCallback(self.createDone) | |
| 50 | d.addErrback(self.d.errback) | |
| 51 | ||
| 52 | def onAuthFailed(self): | |
| 53 | self.d.errback('Auth failed') | |
| 54 | ||
| 55 | ||
| 56 | @deferred(timeout=15.0) | |
| 57 | def test_english_directory_SMB1(): | |
| 58 | info = getConnectionInfo() | |
| 59 | smb_structs.SUPPORT_SMB2 = False | |
| 60 | ||
| 61 | factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 62 | factory.service_name = 'smbtest' | |
| 63 | factory.path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 64 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 65 | return factory.d | |
| 66 | ||
| 67 | @deferred(timeout=15.0) | |
| 68 | def test_english_directory_SMB2(): | |
| 69 | info = getConnectionInfo() | |
| 70 | smb_structs.SUPPORT_SMB2 = True | |
| 71 | ||
| 72 | factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 73 | factory.service_name = 'smbtest' | |
| 74 | factory.path = os.sep + 'TestDir %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 75 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 76 | return factory.d | |
| 77 | ||
| 78 | @deferred(timeout=15.0) | |
| 79 | def test_unicode_directory_SMB1(): | |
| 80 | info = getConnectionInfo() | |
| 81 | smb_structs.SUPPORT_SMB2 = False | |
| 82 | ||
| 83 | factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 84 | factory.service_name = 'smbtest' | |
| 85 | factory.path = os.sep + '文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 86 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 87 | return factory.d | |
| 88 | ||
| 89 | @deferred(timeout=15.0) | |
| 90 | def test_unicode_directory_SMB2(): | |
| 91 | info = getConnectionInfo() | |
| 92 | smb_structs.SUPPORT_SMB2 = True | |
| 93 | ||
| 94 | factory = DirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 95 | factory.service_name = 'smbtest' | |
| 96 | factory.path = os.sep + '文件夹创建 %d-%d' % ( time.time(), random.randint(0, 1000) ) | |
| 97 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 98 | return factory.d |
| 0 | ||
| 1 | from nose.twistedtools import reactor, deferred | |
| 2 | from twisted.internet import defer | |
| 3 | from smb.SMBProtocol import SMBProtocolFactory | |
| 4 | from .util import getConnectionInfo | |
| 5 | ||
| 6 | ||
| 7 | class EchoFactory(SMBProtocolFactory): | |
| 8 | ||
| 9 | def __init__(self, *args, **kwargs): | |
| 10 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 11 | self.d = defer.Deferred() | |
| 12 | self.d.addBoth(self.testDone) | |
| 13 | self.echo_data = 'This is an echo test' | |
| 14 | ||
| 15 | def testDone(self, r): | |
| 16 | if self.instance: | |
| 17 | self.instance.transport.loseConnection() | |
| 18 | return r | |
| 19 | ||
| 20 | def onAuthOK(self): | |
| 21 | def cb(data): | |
| 22 | assert data == self.echo_data | |
| 23 | self.d.callback(True) | |
| 24 | ||
| 25 | d = self.echo(self.echo_data) | |
| 26 | d.addCallback(cb) | |
| 27 | d.addErrback(self.d.errback) | |
| 28 | ||
| 29 | def onAuthFailed(self): | |
| 30 | self.d.errback('Auth failed') | |
| 31 | ||
| 32 | ||
| 33 | @deferred(timeout=15.0) | |
| 34 | def test_echo(): | |
| 35 | info = getConnectionInfo() | |
| 36 | factory = EchoFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 37 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 38 | return factory.d |
| 0 | ||
| 1 | from nose.twistedtools import reactor, deferred | |
| 2 | from twisted.internet import defer | |
| 3 | from smb.SMBProtocol import SMBProtocolFactory | |
| 4 | from smb import smb_structs | |
| 5 | from util import getConnectionInfo | |
| 6 | ||
| 7 | ||
| 8 | class GetAttributesFactory(SMBProtocolFactory): | |
| 9 | ||
| 10 | def __init__(self, *args, **kwargs): | |
| 11 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 12 | self.d = defer.Deferred() | |
| 13 | self.d.addBoth(self.testDone) | |
| 14 | self.path = '' | |
| 15 | self.is_directory = False | |
| 16 | ||
| 17 | def testDone(self, r): | |
| 18 | if self.instance: | |
| 19 | self.instance.transport.loseConnection() | |
| 20 | return r | |
| 21 | ||
| 22 | def onAuthOK(self): | |
| 23 | def cb(info): | |
| 24 | assert info.isDirectory == self.is_directory | |
| 25 | self.d.callback(True) | |
| 26 | ||
| 27 | d = self.getAttributes('smbtest', self.path, timeout = 15) | |
| 28 | d.addCallback(cb) | |
| 29 | d.addErrback(self.d.errback) | |
| 30 | ||
| 31 | def onAuthFailed(self): | |
| 32 | self.d.errback('Auth failed') | |
| 33 | ||
| 34 | ||
| 35 | @deferred(timeout=15.0) | |
| 36 | def test_getAttributes_SMB1_test1(): | |
| 37 | info = getConnectionInfo() | |
| 38 | smb_structs.SUPPORT_SMB2 = False | |
| 39 | ||
| 40 | factory = GetAttributesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 41 | factory.path = '/Test Folder with Long Name/' | |
| 42 | factory.is_directory = True | |
| 43 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 44 | return factory.d | |
| 45 | ||
| 46 | @deferred(timeout=15.0) | |
| 47 | def test_getAttributes_SMB1_test2(): | |
| 48 | info = getConnectionInfo() | |
| 49 | smb_structs.SUPPORT_SMB2 = False | |
| 50 | ||
| 51 | factory = GetAttributesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 52 | factory.path = '/rfc1001.txt' | |
| 53 | factory.is_directory = False | |
| 54 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 55 | return factory.d | |
| 56 | ||
| 57 | @deferred(timeout=15.0) | |
| 58 | def test_getAttributes_SMB1_test3(): | |
| 59 | info = getConnectionInfo() | |
| 60 | smb_structs.SUPPORT_SMB2 = False | |
| 61 | ||
| 62 | factory = GetAttributesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 63 | factory.path = u'/\u6d4b\u8bd5\u6587\u4ef6\u5939' | |
| 64 | factory.is_directory = True | |
| 65 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 66 | return factory.d | |
| 67 | ||
| 68 | @deferred(timeout=15.0) | |
| 69 | def test_getAttributes_SMB2_test1(): | |
| 70 | info = getConnectionInfo() | |
| 71 | smb_structs.SUPPORT_SMB2 = True | |
| 72 | ||
| 73 | factory = GetAttributesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 74 | factory.path = '/Test Folder with Long Name/' | |
| 75 | factory.is_directory = True | |
| 76 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 77 | return factory.d | |
| 78 | ||
| 79 | @deferred(timeout=15.0) | |
| 80 | def test_getAttributes_SMB2_test2(): | |
| 81 | info = getConnectionInfo() | |
| 82 | smb_structs.SUPPORT_SMB2 = True | |
| 83 | ||
| 84 | factory = GetAttributesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 85 | factory.path = '/rfc1001.txt' | |
| 86 | factory.is_directory = False | |
| 87 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 88 | return factory.d | |
| 89 | ||
| 90 | @deferred(timeout=15.0) | |
| 91 | def test_getAttributes_SMB2_test3(): | |
| 92 | info = getConnectionInfo() | |
| 93 | smb_structs.SUPPORT_SMB2 = True | |
| 94 | ||
| 95 | factory = GetAttributesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 96 | factory.path = u'/\u6d4b\u8bd5\u6587\u4ef6\u5939' | |
| 97 | factory.is_directory = True | |
| 98 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 99 | return factory.d |
| 0 | ||
| 1 | from nose.twistedtools import reactor, deferred | |
| 2 | from twisted.internet import defer | |
| 3 | from smb.SMBProtocol import SMBProtocolFactory | |
| 4 | from smb import smb_structs | |
| 5 | from .util import getConnectionInfo | |
| 6 | ||
| 7 | ||
| 8 | class ListPathFactory(SMBProtocolFactory): | |
| 9 | ||
| 10 | def __init__(self, *args, **kwargs): | |
| 11 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 12 | self.d = defer.Deferred() | |
| 13 | self.d.addBoth(self.testDone) | |
| 14 | ||
| 15 | def testDone(self, r): | |
| 16 | if self.instance: | |
| 17 | self.instance.transport.loseConnection() | |
| 18 | return r | |
| 19 | ||
| 20 | def onAuthOK(self): | |
| 21 | def cb(results): | |
| 22 | filenames = [( r.filename, r.isDirectory ) for r in results] | |
| 23 | assert ( '\u6d4b\u8bd5\u6587\u4ef6\u5939', True ) in filenames # Test non-English folder names | |
| 24 | assert ( 'Test Folder with Long Name', True ) in filenames # Test long English folder names | |
| 25 | assert ( 'TestDir1', True ) in filenames # Test short English folder names | |
| 26 | assert ( 'Implementing CIFS - SMB.html', False ) in filenames # Test long English file names | |
| 27 | assert ( 'rfc1001.txt', False ) in filenames # Test short English file names | |
| 28 | ||
| 29 | self.d.callback(True) | |
| 30 | ||
| 31 | d = self.listPath('smbtest', '/', timeout = 15) | |
| 32 | d.addCallback(cb) | |
| 33 | d.addErrback(self.d.errback) | |
| 34 | ||
| 35 | def onAuthFailed(self): | |
| 36 | self.d.errback('Auth failed') | |
| 37 | ||
| 38 | ||
| 39 | @deferred(timeout=15.0) | |
| 40 | def test_listPath_SMB1(): | |
| 41 | info = getConnectionInfo() | |
| 42 | smb_structs.SUPPORT_SMB2 = False | |
| 43 | ||
| 44 | factory = ListPathFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 45 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 46 | return factory.d | |
| 47 | ||
| 48 | @deferred(timeout=15.0) | |
| 49 | def test_listPath_SMB2(): | |
| 50 | info = getConnectionInfo() | |
| 51 | smb_structs.SUPPORT_SMB2 = True | |
| 52 | ||
| 53 | factory = ListPathFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 54 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 55 | return factory.d |
| 0 | ||
| 1 | from nose.twistedtools import reactor, deferred | |
| 2 | from twisted.internet import defer | |
| 3 | from smb.SMBProtocol import SMBProtocolFactory | |
| 4 | from smb import smb_structs | |
| 5 | from .util import getConnectionInfo | |
| 6 | ||
| 7 | ||
| 8 | class ListSharesFactory(SMBProtocolFactory): | |
| 9 | ||
| 10 | def __init__(self, *args, **kwargs): | |
| 11 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 12 | self.d = defer.Deferred() | |
| 13 | self.d.addBoth(self.testDone) | |
| 14 | ||
| 15 | def testDone(self, r): | |
| 16 | if self.instance: | |
| 17 | self.instance.transport.loseConnection() | |
| 18 | return r | |
| 19 | ||
| 20 | def onAuthOK(self): | |
| 21 | def cb(results): | |
| 22 | assert 'smbtest' in [r.name.lower() for r in results] | |
| 23 | self.d.callback(True) | |
| 24 | self.instance.transport.loseConnection() | |
| 25 | ||
| 26 | d = self.listShares(timeout = 15) | |
| 27 | d.addCallback(cb) | |
| 28 | d.addErrback(self.d.errback) | |
| 29 | ||
| 30 | def onAuthFailed(self): | |
| 31 | self.d.errback('Auth failed') | |
| 32 | ||
| 33 | ||
| 34 | @deferred(timeout=15.0) | |
| 35 | def test_listshares_SMB1(): | |
| 36 | info = getConnectionInfo() | |
| 37 | smb_structs.SUPPORT_SMB2 = False | |
| 38 | ||
| 39 | factory = ListSharesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 40 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 41 | return factory.d | |
| 42 | ||
| 43 | @deferred(timeout=15.0) | |
| 44 | def test_listshares_SMB2(): | |
| 45 | info = getConnectionInfo() | |
| 46 | smb_structs.SUPPORT_SMB2 = True | |
| 47 | ||
| 48 | factory = ListSharesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 49 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 50 | return factory.d |
| 0 | ||
| 1 | from nose.twistedtools import reactor, deferred | |
| 2 | from twisted.internet import defer | |
| 3 | from smb.SMBProtocol import SMBProtocolFactory | |
| 4 | from smb import smb_structs | |
| 5 | from .util import getConnectionInfo | |
| 6 | ||
| 7 | ||
| 8 | class ListSnapshotsFactory(SMBProtocolFactory): | |
| 9 | ||
| 10 | def __init__(self, *args, **kwargs): | |
| 11 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 12 | self.d = defer.Deferred() | |
| 13 | self.d.addBoth(self.testDone) | |
| 14 | self.service_name = None | |
| 15 | self.path = None | |
| 16 | ||
| 17 | def testDone(self, r): | |
| 18 | if self.instance: | |
| 19 | self.instance.transport.loseConnection() | |
| 20 | return r | |
| 21 | ||
| 22 | def onAuthOK(self): | |
| 23 | def cb(results): | |
| 24 | assert len(results) > 0 | |
| 25 | self.d.callback(True) | |
| 26 | self.instance.transport.loseConnection() | |
| 27 | ||
| 28 | d = self.listSnapshots(self.service_name, self.path, timeout = 15) | |
| 29 | d.addCallback(cb) | |
| 30 | d.addErrback(self.d.errback) | |
| 31 | ||
| 32 | def onAuthFailed(self): | |
| 33 | self.d.errback('Auth failed') | |
| 34 | ||
| 35 | ||
| 36 | @deferred(timeout=15.0) | |
| 37 | def test_listshares_SMB1(): | |
| 38 | info = getConnectionInfo() | |
| 39 | smb_structs.SUPPORT_SMB2 = False | |
| 40 | ||
| 41 | factory = ListSnapshotsFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 42 | factory.service_name = 'smbtest' | |
| 43 | factory.path = '/rfc1001.txt' | |
| 44 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 45 | return factory.d | |
| 46 | ||
| 47 | @deferred(timeout=15.0) | |
| 48 | def test_listshares_SMB2(): | |
| 49 | info = getConnectionInfo() | |
| 50 | smb_structs.SUPPORT_SMB2 = True | |
| 51 | ||
| 52 | factory = ListSnapshotsFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 53 | factory.service_name = 'smbtest' | |
| 54 | factory.path = '/rfc1001.txt' | |
| 55 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 56 | return factory.d |
| 0 | # -*- coding: utf-8 -*- | |
| 1 | ||
| 2 | import os, random, time | |
| 3 | from io import StringIO | |
| 4 | from nose.twistedtools import reactor, deferred | |
| 5 | from twisted.internet import defer | |
| 6 | from smb.SMBProtocol import SMBProtocolFactory | |
| 7 | from smb import smb_structs | |
| 8 | from .util import getConnectionInfo | |
| 9 | ||
| 10 | ||
| 11 | class RenameFactory(SMBProtocolFactory): | |
| 12 | ||
| 13 | def __init__(self, *args, **kwargs): | |
| 14 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 15 | self.d = defer.Deferred() | |
| 16 | self.d.addBoth(self.testDone) | |
| 17 | self.service = '' | |
| 18 | self.new_path = '' | |
| 19 | self.old_path = '' | |
| 20 | ||
| 21 | def testDone(self, r): | |
| 22 | if self.instance: | |
| 23 | self.instance.transport.loseConnection() | |
| 24 | return r | |
| 25 | ||
| 26 | def pathCreated(self, result): | |
| 27 | d = self.listPath(self.service, os.path.dirname(self.old_path.replace('/', os.sep))) | |
| 28 | d.addCallback(self.listComplete) | |
| 29 | d.addErrback(self.d.errback) | |
| 30 | ||
| 31 | def listComplete(self, entries): | |
| 32 | filenames = [e.filename for e in entries] | |
| 33 | assert os.path.basename(self.old_path.replace('/', os.sep)) in filenames | |
| 34 | assert os.path.basename(self.new_path.replace('/', os.sep)) not in filenames | |
| 35 | ||
| 36 | d = self.rename(self.service, self.old_path, self.new_path) | |
| 37 | d.addCallback(self.renameComplete) | |
| 38 | d.addErrback(self.d.errback) | |
| 39 | ||
| 40 | def renameComplete(self, result): | |
| 41 | d = self.listPath(self.service, os.path.dirname(self.new_path.replace('/', os.sep))) | |
| 42 | d.addCallback(self.list2Complete) | |
| 43 | d.addErrback(self.d.errback) | |
| 44 | ||
| 45 | def list2Complete(self, entries): | |
| 46 | filenames = [e.filename for e in entries] | |
| 47 | assert os.path.basename(self.new_path.replace('/', os.sep)) in filenames | |
| 48 | assert os.path.basename(self.old_path.replace('/', os.sep)) not in filenames | |
| 49 | self.cleanup() | |
| 50 | ||
| 51 | def onAuthFailed(self): | |
| 52 | self.d.errback('Auth failed') | |
| 53 | ||
| 54 | ||
| 55 | class RenameFileFactory(RenameFactory): | |
| 56 | ||
| 57 | def onAuthOK(self): | |
| 58 | d = self.storeFile(self.service, self.old_path, StringIO('Rename file test')) | |
| 59 | d.addCallback(self.pathCreated) | |
| 60 | d.addErrback(self.d.errback) | |
| 61 | ||
| 62 | def cleanup(self): | |
| 63 | d = self.deleteFiles(self.service, self.new_path) | |
| 64 | d.chainDeferred(self.d) | |
| 65 | ||
| 66 | ||
| 67 | class RenameDirectoryFactory(RenameFactory): | |
| 68 | ||
| 69 | def onAuthOK(self): | |
| 70 | d = self.createDirectory(self.service, self.old_path) | |
| 71 | d.addCallback(self.pathCreated) | |
| 72 | d.addErrback(self.d.errback) | |
| 73 | ||
| 74 | def cleanup(self): | |
| 75 | d = self.deleteDirectory(self.service, self.new_path) | |
| 76 | d.chainDeferred(self.d) | |
| 77 | ||
| 78 | ||
| 79 | @deferred(timeout=30.0) | |
| 80 | def test_rename_english_file_SMB1(): | |
| 81 | info = getConnectionInfo() | |
| 82 | smb_structs.SUPPORT_SMB2 = False | |
| 83 | ||
| 84 | factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 85 | factory.service = 'smbtest' | |
| 86 | factory.old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 87 | factory.new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 88 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 89 | return factory.d | |
| 90 | ||
| 91 | @deferred(timeout=30.0) | |
| 92 | def test_rename_english_file_SMB2(): | |
| 93 | info = getConnectionInfo() | |
| 94 | smb_structs.SUPPORT_SMB2 = True | |
| 95 | ||
| 96 | factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 97 | factory.service = 'smbtest' | |
| 98 | factory.old_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 99 | factory.new_path = '/RenameTest %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 100 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 101 | return factory.d | |
| 102 | ||
| 103 | @deferred(timeout=30.0) | |
| 104 | def test_rename_unicode_file_SMB1(): | |
| 105 | info = getConnectionInfo() | |
| 106 | smb_structs.SUPPORT_SMB2 = False | |
| 107 | ||
| 108 | factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 109 | factory.service = 'smbtest' | |
| 110 | factory.old_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 111 | factory.new_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 112 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 113 | return factory.d | |
| 114 | ||
| 115 | @deferred(timeout=30.0) | |
| 116 | def test_rename_unicode_file_SMB2(): | |
| 117 | info = getConnectionInfo() | |
| 118 | smb_structs.SUPPORT_SMB2 = True | |
| 119 | ||
| 120 | factory = RenameFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 121 | factory.service = 'smbtest' | |
| 122 | factory.old_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 123 | factory.new_path = '/改名测试 %d-%d.txt' % ( time.time(), random.randint(1000, 9999) ) | |
| 124 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 125 | return factory.d | |
| 126 | ||
| 127 | @deferred(timeout=30.0) | |
| 128 | def test_rename_english_directory_SMB1(): | |
| 129 | info = getConnectionInfo() | |
| 130 | smb_structs.SUPPORT_SMB2 = False | |
| 131 | ||
| 132 | factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 133 | factory.service = 'smbtest' | |
| 134 | factory.old_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 135 | factory.new_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 136 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 137 | return factory.d | |
| 138 | ||
| 139 | @deferred(timeout=30.0) | |
| 140 | def test_rename_english_directory_SMB2(): | |
| 141 | info = getConnectionInfo() | |
| 142 | smb_structs.SUPPORT_SMB2 = True | |
| 143 | ||
| 144 | factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 145 | factory.service = 'smbtest' | |
| 146 | factory.old_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 147 | factory.new_path = '/RenameTest %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 148 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 149 | return factory.d | |
| 150 | ||
| 151 | @deferred(timeout=30.0) | |
| 152 | def test_rename_unicode_directory_SMB1(): | |
| 153 | info = getConnectionInfo() | |
| 154 | smb_structs.SUPPORT_SMB2 = False | |
| 155 | ||
| 156 | factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 157 | factory.service = 'smbtest' | |
| 158 | factory.old_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 159 | factory.new_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 160 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 161 | return factory.d | |
| 162 | ||
| 163 | @deferred(timeout=30.0) | |
| 164 | def test_rename_unicode_directory_SMB2(): | |
| 165 | info = getConnectionInfo() | |
| 166 | smb_structs.SUPPORT_SMB2 = True | |
| 167 | ||
| 168 | factory = RenameDirectoryFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 169 | factory.service = 'smbtest' | |
| 170 | factory.old_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 171 | factory.new_path = '/改名测试 %d-%d' % ( time.time(), random.randint(1000, 9999) ) | |
| 172 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 173 | return factory.d |
| 0 | # -*- coding: utf-8 -*- | |
| 1 | ||
| 2 | import os, tempfile | |
| 3 | from nose.twistedtools import reactor, deferred | |
| 4 | from twisted.internet import defer | |
| 5 | from smb.SMBProtocol import SMBProtocolFactory | |
| 6 | from smb import smb_structs | |
| 7 | from .util import getConnectionInfo | |
| 8 | ||
| 9 | try: | |
| 10 | import hashlib | |
| 11 | def MD5(): return hashlib.md5() | |
| 12 | except ImportError: | |
| 13 | import md5 | |
| 14 | def MD5(): return md5.new() | |
| 15 | ||
| 16 | ||
| 17 | class RetrieveFileFactory(SMBProtocolFactory): | |
| 18 | ||
| 19 | def __init__(self, *args, **kwargs): | |
| 20 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 21 | self.d = defer.Deferred() | |
| 22 | self.d.addBoth(self.testDone) | |
| 23 | self.temp_fh = tempfile.NamedTemporaryFile(prefix = 'pysmbtest-') | |
| 24 | self.service = '' | |
| 25 | self.path = '' | |
| 26 | self.digest = '' | |
| 27 | self.offset = 0 | |
| 28 | self.max_length = -1 | |
| 29 | self.filesize = 0 | |
| 30 | ||
| 31 | def testDone(self, r): | |
| 32 | if self.instance: | |
| 33 | self.instance.transport.loseConnection() | |
| 34 | return r | |
| 35 | ||
| 36 | def fileRetrieved(self, write_result): | |
| 37 | file_obj, file_attributes, file_size = write_result | |
| 38 | assert file_obj == self.temp_fh | |
| 39 | ||
| 40 | md = MD5() | |
| 41 | filesize = 0 | |
| 42 | self.temp_fh.seek(0) | |
| 43 | while True: | |
| 44 | s = self.temp_fh.read(8192) | |
| 45 | if not s: | |
| 46 | break | |
| 47 | md.update(s) | |
| 48 | filesize += len(s) | |
| 49 | ||
| 50 | assert self.filesize == filesize | |
| 51 | assert md.hexdigest() == self.digest | |
| 52 | ||
| 53 | self.temp_fh.close() | |
| 54 | self.d.callback(True) | |
| 55 | self.instance.transport.loseConnection() | |
| 56 | ||
| 57 | def onAuthOK(self): | |
| 58 | assert self.service | |
| 59 | assert self.path | |
| 60 | ||
| 61 | d = self.retrieveFileFromOffset(self.service, self.path, self.temp_fh, self.offset, self.max_length, timeout = 15) | |
| 62 | d.addCallback(self.fileRetrieved) | |
| 63 | d.addErrback(self.d.errback) | |
| 64 | ||
| 65 | def onAuthFailed(self): | |
| 66 | self.d.errback('Auth failed') | |
| 67 | ||
| 68 | ||
| 69 | @deferred(timeout=30.0) | |
| 70 | def test_retr_multiplereads_SMB1(): | |
| 71 | # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes) | |
| 72 | info = getConnectionInfo() | |
| 73 | smb_structs.SUPPORT_SMB2 = False | |
| 74 | ||
| 75 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 76 | factory.service = 'smbtest' | |
| 77 | factory.path = '/rfc1001.txt' | |
| 78 | factory.digest = '5367c2bbf97f521059c78eab65309ad3' | |
| 79 | factory.filesize = 158437 | |
| 80 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 81 | return factory.d | |
| 82 | ||
| 83 | @deferred(timeout=30.0) | |
| 84 | def test_retr_multiplereads_SMB2(): | |
| 85 | # Test file retrieval using multiple ReadAndx calls (assuming each call will not reach more than 65534 bytes) | |
| 86 | info = getConnectionInfo() | |
| 87 | smb_structs.SUPPORT_SMB2 = True | |
| 88 | ||
| 89 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 90 | factory.service = 'smbtest' | |
| 91 | factory.path = '/rfc1001.txt' | |
| 92 | factory.digest = '5367c2bbf97f521059c78eab65309ad3' | |
| 93 | factory.filesize = 158437 | |
| 94 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 95 | return factory.d | |
| 96 | ||
| 97 | @deferred(timeout=30.0) | |
| 98 | def test_retr_longfilename_SMB1(): | |
| 99 | # Test file retrieval that has a long English filename | |
| 100 | info = getConnectionInfo() | |
| 101 | smb_structs.SUPPORT_SMB2 = False | |
| 102 | ||
| 103 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 104 | factory.service = 'smbtest' | |
| 105 | factory.path = '/Implementing CIFS - SMB.html' | |
| 106 | factory.digest = '671c5700d279fcbbf958c1bba3c2639e' | |
| 107 | factory.filesize = 421269 | |
| 108 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 109 | return factory.d | |
| 110 | ||
| 111 | @deferred(timeout=30.0) | |
| 112 | def test_retr_longfilename_SMB2(): | |
| 113 | # Test file retrieval that has a long English filename | |
| 114 | info = getConnectionInfo() | |
| 115 | smb_structs.SUPPORT_SMB2 = True | |
| 116 | ||
| 117 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 118 | factory.service = 'smbtest' | |
| 119 | factory.path = '/Implementing CIFS - SMB.html' | |
| 120 | factory.digest = '671c5700d279fcbbf958c1bba3c2639e' | |
| 121 | factory.filesize = 421269 | |
| 122 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 123 | return factory.d | |
| 124 | ||
| 125 | @deferred(timeout=30.0) | |
| 126 | def test_retr_unicodefilename_SMB1(): | |
| 127 | # Test file retrieval that has a long non-English filename inside a folder with a non-English name | |
| 128 | info = getConnectionInfo() | |
| 129 | smb_structs.SUPPORT_SMB2 = False | |
| 130 | ||
| 131 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 132 | factory.service = 'smbtest' | |
| 133 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 134 | factory.digest = '8a44c1e80d55e91c92350955cdf83442' | |
| 135 | factory.filesize = 256000 | |
| 136 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 137 | return factory.d | |
| 138 | ||
| 139 | @deferred(timeout=30.0) | |
| 140 | def test_retr_unicodefilename_SMB2(): | |
| 141 | # Test file retrieval that has a long non-English filename inside a folder with a non-English name | |
| 142 | info = getConnectionInfo() | |
| 143 | smb_structs.SUPPORT_SMB2 = True | |
| 144 | ||
| 145 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 146 | factory.service = 'smbtest' | |
| 147 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 148 | factory.digest = '8a44c1e80d55e91c92350955cdf83442' | |
| 149 | factory.filesize = 256000 | |
| 150 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 151 | return factory.d | |
| 152 | ||
| 153 | @deferred(timeout=30.0) | |
| 154 | def test_retr_offset_SMB1(): | |
| 155 | # Test file retrieval from offset to EOF | |
| 156 | info = getConnectionInfo() | |
| 157 | smb_structs.SUPPORT_SMB2 = False | |
| 158 | ||
| 159 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 160 | factory.service = 'smbtest' | |
| 161 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 162 | factory.digest = 'a141bd8024571ce7cb5c67f2b0d8ea0b' | |
| 163 | factory.filesize = 156000 | |
| 164 | factory.offset = 100000 | |
| 165 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 166 | return factory.d | |
| 167 | ||
| 168 | @deferred(timeout=30.0) | |
| 169 | def test_retr_offset_SMB2(): | |
| 170 | # Test file retrieval from offset to EOF | |
| 171 | info = getConnectionInfo() | |
| 172 | smb_structs.SUPPORT_SMB2 = True | |
| 173 | ||
| 174 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 175 | factory.service = 'smbtest' | |
| 176 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 177 | factory.digest = 'a141bd8024571ce7cb5c67f2b0d8ea0b' | |
| 178 | factory.filesize = 156000 | |
| 179 | factory.offset = 100000 | |
| 180 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 181 | return factory.d | |
| 182 | ||
| 183 | @deferred(timeout=30.0) | |
| 184 | def test_retr_offset_and_biglimit_SMB1(): | |
| 185 | # Test file retrieval from offset with a big max_length | |
| 186 | info = getConnectionInfo() | |
| 187 | smb_structs.SUPPORT_SMB2 = False | |
| 188 | ||
| 189 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 190 | factory.service = 'smbtest' | |
| 191 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 192 | factory.digest = '83b7afd7c92cdece3975338b5ca0b1c5' | |
| 193 | factory.filesize = 100000 | |
| 194 | factory.offset = 100000 | |
| 195 | factory.max_length = 100000 | |
| 196 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 197 | return factory.d | |
| 198 | ||
| 199 | @deferred(timeout=30.0) | |
| 200 | def test_retr_offset_and_biglimit_SMB2(): | |
| 201 | # Test file retrieval from offset with a big max_length | |
| 202 | info = getConnectionInfo() | |
| 203 | smb_structs.SUPPORT_SMB2 = True | |
| 204 | ||
| 205 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 206 | factory.service = 'smbtest' | |
| 207 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 208 | factory.digest = '83b7afd7c92cdece3975338b5ca0b1c5' | |
| 209 | factory.filesize = 100000 | |
| 210 | factory.offset = 100000 | |
| 211 | factory.max_length = 100000 | |
| 212 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 213 | return factory.d | |
| 214 | ||
| 215 | @deferred(timeout=30.0) | |
| 216 | def test_retr_offset_and_smalllimit_SMB1(): | |
| 217 | # Test file retrieval from offset with a small max_length | |
| 218 | info = getConnectionInfo() | |
| 219 | smb_structs.SUPPORT_SMB2 = False | |
| 220 | ||
| 221 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 222 | factory.service = 'smbtest' | |
| 223 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 224 | factory.digest = '746f60a96b39b712a7b6e17ddde19986' | |
| 225 | factory.filesize = 10 | |
| 226 | factory.offset = 100000 | |
| 227 | factory.max_length = 10 | |
| 228 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 229 | return factory.d | |
| 230 | ||
| 231 | @deferred(timeout=30.0) | |
| 232 | def test_retr_offset_and_smalllimit_SMB2(): | |
| 233 | # Test file retrieval from offset with a small max_length | |
| 234 | info = getConnectionInfo() | |
| 235 | smb_structs.SUPPORT_SMB2 = True | |
| 236 | ||
| 237 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 238 | factory.service = 'smbtest' | |
| 239 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 240 | factory.digest = '746f60a96b39b712a7b6e17ddde19986' | |
| 241 | factory.filesize = 10 | |
| 242 | factory.offset = 100000 | |
| 243 | factory.max_length = 10 | |
| 244 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 245 | return factory.d | |
| 246 | ||
| 247 | @deferred(timeout=30.0) | |
| 248 | def test_retr_offset_and_zerolimit_SMB1(): | |
| 249 | # Test file retrieval from offset to EOF with max_length=0 | |
| 250 | info = getConnectionInfo() | |
| 251 | smb_structs.SUPPORT_SMB2 = False | |
| 252 | ||
| 253 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 254 | factory.service = 'smbtest' | |
| 255 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 256 | factory.digest = 'd41d8cd98f00b204e9800998ecf8427e' | |
| 257 | factory.filesize = 0 | |
| 258 | factory.offset = 100000 | |
| 259 | factory.max_length = 0 | |
| 260 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 261 | return factory.d | |
| 262 | ||
| 263 | @deferred(timeout=30.0) | |
| 264 | def test_retr_offset_and_zerolimit_SMB2(): | |
| 265 | # Test file retrieval from offset to EOF with max_length=0 | |
| 266 | info = getConnectionInfo() | |
| 267 | smb_structs.SUPPORT_SMB2 = True | |
| 268 | ||
| 269 | factory = RetrieveFileFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 270 | factory.service = 'smbtest' | |
| 271 | factory.path = '/测试文件夹/垃圾文件.dat' | |
| 272 | factory.digest = 'd41d8cd98f00b204e9800998ecf8427e' | |
| 273 | factory.filesize = 0 | |
| 274 | factory.offset = 100000 | |
| 275 | factory.max_length = 0 | |
| 276 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 277 | return factory.d |
| 0 | # -*- coding: utf-8 -*- | |
| 1 | ||
| 2 | import os, time, random | |
| 3 | from io import StringIO | |
| 4 | from nose.twistedtools import reactor, deferred | |
| 5 | from twisted.internet import defer | |
| 6 | from smb.SMBProtocol import SMBProtocolFactory | |
| 7 | from smb import smb_structs | |
| 8 | from .util import getConnectionInfo | |
| 9 | ||
| 10 | try: | |
| 11 | import hashlib | |
| 12 | def MD5(): return hashlib.md5() | |
| 13 | except ImportError: | |
| 14 | import md5 | |
| 15 | def MD5(): return md5.new() | |
| 16 | ||
| 17 | class StoreFilesFactory(SMBProtocolFactory): | |
| 18 | """ | |
| 19 | A super test factory that tests store file, list files, retrieve file and delete file functionlities in sequence. | |
| 20 | """ | |
| 21 | ||
| 22 | TEST_FILENAME = os.path.join(os.path.dirname(__file__), os.pardir, 'SupportFiles', 'binary.dat') | |
| 23 | TEST_FILESIZE = 256000 | |
| 24 | TEST_DIGEST = 'bb6303f76e29f354b6fdf6ef58587e48' | |
| 25 | ||
| 26 | def __init__(self, *args, **kwargs): | |
| 27 | SMBProtocolFactory.__init__(self, *args, **kwargs) | |
| 28 | self.d = defer.Deferred() | |
| 29 | self.d.addBoth(self.testDone) | |
| 30 | self.service_name = '' | |
| 31 | self.filename = '' | |
| 32 | ||
| 33 | def testDone(self, r): | |
| 34 | if self.instance: | |
| 35 | self.instance.transport.loseConnection() | |
| 36 | return r | |
| 37 | ||
| 38 | def storeComplete(self, result): | |
| 39 | file_obj, filesize = result | |
| 40 | file_obj.close() | |
| 41 | assert filesize == self.TEST_FILESIZE | |
| 42 | ||
| 43 | d = self.listPath(self.service_name, os.path.dirname(self.filename.replace('/', os.sep))) | |
| 44 | d.addCallback(self.listComplete) | |
| 45 | d.addErrback(self.d.errback) | |
| 46 | ||
| 47 | def listComplete(self, entries): | |
| 48 | filenames = [e.filename for e in entries] | |
| 49 | assert os.path.basename(self.filename.replace('/', os.sep)) in filenames | |
| 50 | ||
| 51 | for entry in entries: | |
| 52 | if os.path.basename(self.filename.replace('/', os.sep)) == entry.filename: | |
| 53 | # The following asserts will fail if the remote machine's time is not in sync with the test machine's time | |
| 54 | assert abs(entry.create_time - time.time()) < 3 | |
| 55 | assert abs(entry.last_access_time - time.time()) < 3 | |
| 56 | assert abs(entry.last_write_time - time.time()) < 3 | |
| 57 | assert abs(entry.last_attr_change_time - time.time()) < 3 | |
| 58 | break | |
| 59 | ||
| 60 | d = self.retrieveFile(self.service_name, self.filename, StringIO()) | |
| 61 | d.addCallback(self.retrieveComplete) | |
| 62 | d.addErrback(self.d.errback) | |
| 63 | ||
| 64 | def retrieveComplete(self, result): | |
| 65 | file_obj, file_attributes, file_size = result | |
| 66 | ||
| 67 | md = MD5() | |
| 68 | md.update(file_obj.getvalue()) | |
| 69 | file_obj.close() | |
| 70 | ||
| 71 | assert file_size == self.TEST_FILESIZE | |
| 72 | assert md.hexdigest() == self.TEST_DIGEST | |
| 73 | ||
| 74 | d = self.deleteFiles(self.service_name, self.filename) | |
| 75 | d.addCallback(self.deleteComplete) | |
| 76 | d.addErrback(self.d.errback) | |
| 77 | ||
| 78 | def deleteComplete(self, result): | |
| 79 | d = self.listPath(self.service_name, os.path.dirname(self.filename.replace('/', os.sep))) | |
| 80 | d.addCallback(self.list2Complete) | |
| 81 | d.addErrback(self.d.errback) | |
| 82 | ||
| 83 | def list2Complete(self, entries): | |
| 84 | filenames = [e.filename for e in entries] | |
| 85 | assert os.path.basename(self.filename.replace('/', os.sep)) not in filenames | |
| 86 | self.d.callback(True) | |
| 87 | self.instance.transport.loseConnection() | |
| 88 | ||
| 89 | def onAuthOK(self): | |
| 90 | d = self.storeFile(self.service_name, self.filename, open(self.TEST_FILENAME, 'rb')) | |
| 91 | d.addCallback(self.storeComplete) | |
| 92 | d.addErrback(self.d.errback) | |
| 93 | ||
| 94 | def onAuthFailed(self): | |
| 95 | self.d.errback('Auth failed') | |
| 96 | ||
| 97 | ||
| 98 | @deferred(timeout=30.0) | |
| 99 | def test_store_long_filename_SMB1(): | |
| 100 | info = getConnectionInfo() | |
| 101 | smb_structs.SUPPORT_SMB2 = False | |
| 102 | ||
| 103 | factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 104 | factory.service_name = 'smbtest' | |
| 105 | factory.filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) | |
| 106 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 107 | return factory.d | |
| 108 | ||
| 109 | @deferred(timeout=30.0) | |
| 110 | def test_store_long_filename_SMB2(): | |
| 111 | info = getConnectionInfo() | |
| 112 | smb_structs.SUPPORT_SMB2 = True | |
| 113 | ||
| 114 | factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 115 | factory.service_name = 'smbtest' | |
| 116 | factory.filename = os.sep + 'StoreTest %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) | |
| 117 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 118 | return factory.d | |
| 119 | ||
| 120 | @deferred(timeout=30.0) | |
| 121 | def test_store_unicode_filename_SMB1(): | |
| 122 | info = getConnectionInfo() | |
| 123 | smb_structs.SUPPORT_SMB2 = False | |
| 124 | ||
| 125 | factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 126 | factory.service_name = 'smbtest' | |
| 127 | factory.filename = os.sep + '上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) | |
| 128 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 129 | return factory.d | |
| 130 | ||
| 131 | @deferred(timeout=30.0) | |
| 132 | def test_store_unicode_filename_SMB2(): | |
| 133 | info = getConnectionInfo() | |
| 134 | smb_structs.SUPPORT_SMB2 = True | |
| 135 | ||
| 136 | factory = StoreFilesFactory(info['user'], info['password'], info['client_name'], info['server_name'], use_ntlm_v2 = True) | |
| 137 | factory.service_name = 'smbtest' | |
| 138 | factory.filename = os.sep + '上载测试 %d-%d.dat' % ( time.time(), random.randint(0, 10000) ) | |
| 139 | reactor.connectTCP(info['server_ip'], info['server_port'], factory) | |
| 140 | return factory.d |
| 0 | ||
| 1 | import os | |
| 2 | from configparser import SafeConfigParser | |
| 3 | ||
| 4 | def getConnectionInfo(): | |
| 5 | config_filename = os.path.join(os.path.dirname(__file__), os.path.pardir, 'connection.ini') | |
| 6 | cp = SafeConfigParser() | |
| 7 | cp.read(config_filename) | |
| 8 | ||
| 9 | info = { | |
| 10 | 'server_name': cp.get('server', 'name'), | |
| 11 | 'server_ip': cp.get('server', 'ip'), | |
| 12 | 'server_port': cp.getint('server', 'port'), | |
| 13 | 'client_name': cp.get('client', 'name'), | |
| 14 | 'user': cp.get('user', 'name'), | |
| 15 | 'password': cp.get('user', 'password'), | |
| 16 | } | |
| 17 | return info | |
| 18 |
| 2 | 2 | name = SERVER |
| 3 | 3 | ip = 192.168.1.1 |
| 4 | 4 | port = 139 |
| 5 | direct_port = 445 | |
| 5 | 6 | |
| 6 | 7 | [client] |
| 7 | 8 | name = TESTCLIENT |
| 0 | import binascii | |
| 1 | ||
| 2 | from smb import security_descriptors as sd | |
| 3 | from smb import smb_constants as sc | |
| 4 | ||
| 5 | ||
| 6 | def test_sid_string_representation(): | |
| 7 | sid = sd.SID(1, 5, [2, 3, 4]) | |
| 8 | assert str(sid) == "S-1-5-2-3-4" | |
| 9 | sid = sd.SID(1, 2**32 + 3, []) | |
| 10 | assert str(sid) == "S-1-0x100000003" | |
| 11 | sid = sd.SID(1, 2**32, [3, 2, 1]) | |
| 12 | assert str(sid) == "S-1-0x100000000-3-2-1" | |
| 13 | ||
| 14 | ||
| 15 | def test_sid_binary_parsing(): | |
| 16 | raw_sid = binascii.unhexlify(b""" | |
| 17 | 01 05 00 00 00 00 00 05 15 00 00 00 de 53 c1 2a | |
| 18 | 2a 4f da ca c1 79 a6 32 b1 04 00 00 | |
| 19 | """.translate(None, b' \n')) | |
| 20 | assert str(sd.SID.from_bytes(raw_sid)) == "S-1-5-21-717312990-3403304746-849770945-1201" | |
| 21 | raw_sid += b"garbage" | |
| 22 | assert str(sd.SID.from_bytes(raw_sid)) == "S-1-5-21-717312990-3403304746-849770945-1201" | |
| 23 | sid, tail = sd.SID.from_bytes(raw_sid, return_tail=True) | |
| 24 | assert str(sid) == "S-1-5-21-717312990-3403304746-849770945-1201" | |
| 25 | assert tail == b"garbage" | |
| 26 | ||
| 27 | ||
| 28 | def test_ace_binary_parsing(): | |
| 29 | raw_ace = binascii.unhexlify(b""" | |
| 30 | 00 10 24 00 ff 01 1f 00 01 05 00 00 00 00 00 05 | |
| 31 | 15 00 00 00 de 53 c1 2a 2a 4f da ca c1 79 a6 32 | |
| 32 | 6e 04 00 00 | |
| 33 | """.translate(None, b' \n')) | |
| 34 | ace = sd.ACE.from_bytes(raw_ace) | |
| 35 | assert str(ace.sid) == "S-1-5-21-717312990-3403304746-849770945-1134" | |
| 36 | assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED | |
| 37 | assert ace.flags == sd.ACE_FLAG_INHERITED | |
| 38 | assert ace.mask == (sc.SYNCHRONIZE | sc.WRITE_OWNER | sc.WRITE_DAC | |
| 39 | | sc.READ_CONTROL | sc.DELETE | sc.FILE_READ_DATA | |
| 40 | | sc.FILE_WRITE_DATA | sc.FILE_APPEND_DATA | |
| 41 | | sc.FILE_READ_EA | sc.FILE_WRITE_EA | sc.FILE_EXECUTE | |
| 42 | | sc.FILE_DELETE_CHILD | sc.FILE_READ_ATTRIBUTES | |
| 43 | | sc.FILE_WRITE_ATTRIBUTES) | |
| 44 | assert not ace.additional_data | |
| 45 | ||
| 46 | raw_ace = binascii.unhexlify(b""" | |
| 47 | 00 13 18 00 a9 00 12 00 01 02 00 00 00 00 00 05 | |
| 48 | 20 00 00 00 21 02 00 00 | |
| 49 | """.translate(None, b' \n')) | |
| 50 | ace = sd.ACE.from_bytes(raw_ace) | |
| 51 | assert str(ace.sid) == "S-1-5-32-545" | |
| 52 | assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED | |
| 53 | assert ace.flags == (sd.ACE_FLAG_INHERITED | sd.ACE_FLAG_CONTAINER_INHERIT | |
| 54 | | sd.ACE_FLAG_OBJECT_INHERIT) | |
| 55 | assert ace.mask == (sc.SYNCHRONIZE | sc.READ_CONTROL | sc.FILE_READ_DATA | |
| 56 | | sc.FILE_READ_EA | sc.FILE_EXECUTE | |
| 57 | | sc.FILE_READ_ATTRIBUTES) | |
| 58 | assert not ace.additional_data | |
| 59 | ||
| 60 | raw_ace = binascii.unhexlify(b""" | |
| 61 | 01 03 24 00 a9 00 02 00 01 05 00 00 00 00 00 05 | |
| 62 | 15 00 00 00 de 53 c1 2a 2a 4f da ca c1 79 a6 32 | |
| 63 | 6c 04 00 00 | |
| 64 | """.translate(None, b' \n')) | |
| 65 | ace = sd.ACE.from_bytes(raw_ace) | |
| 66 | assert str(ace.sid) == "S-1-5-21-717312990-3403304746-849770945-1132" | |
| 67 | assert ace.type == sd.ACE_TYPE_ACCESS_DENIED | |
| 68 | assert ace.flags == (sd.ACE_FLAG_CONTAINER_INHERIT | |
| 69 | | sd.ACE_FLAG_OBJECT_INHERIT) | |
| 70 | assert ace.mask == (sc.READ_CONTROL | sc.FILE_READ_DATA | sc.FILE_READ_EA | |
| 71 | | sc.FILE_EXECUTE | sc.FILE_READ_ATTRIBUTES) | |
| 72 | assert not ace.additional_data | |
| 73 | ||
| 74 | ||
| 75 | def test_acl_binary_parsing(): | |
| 76 | raw_acl = binascii.unhexlify(b""" | |
| 77 | 02 00 70 00 04 00 00 00 00 10 18 00 89 00 10 00 | |
| 78 | 01 02 00 00 00 00 00 05 20 00 00 00 21 02 00 00 | |
| 79 | 00 10 14 00 ff 01 1f 00 01 01 00 00 00 00 00 05 | |
| 80 | 12 00 00 00 00 10 18 00 ff 01 1f 00 01 02 00 00 | |
| 81 | 00 00 00 05 20 00 00 00 20 02 00 00 00 10 24 00 | |
| 82 | ff 01 1f 00 01 05 00 00 00 00 00 05 15 00 00 00 | |
| 83 | de 53 c1 2a 2a 4f da ca c1 79 a6 32 b1 04 00 00 | |
| 84 | """.translate(None, b' \n')) | |
| 85 | acl = sd.ACL.from_bytes(raw_acl) | |
| 86 | assert acl.revision == 2 | |
| 87 | assert len(acl.aces) == 4 | |
| 88 | ||
| 89 | ace = acl.aces[0] | |
| 90 | assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED | |
| 91 | assert str(ace.sid) == "S-1-5-32-545" | |
| 92 | assert ace.flags == sd.ACE_FLAG_INHERITED | |
| 93 | assert ace.mask == (sc.SYNCHRONIZE | sc.FILE_READ_DATA | sc.FILE_READ_EA | |
| 94 | | sc.FILE_READ_ATTRIBUTES) | |
| 95 | ||
| 96 | ace = acl.aces[3] | |
| 97 | assert ace.type == sd.ACE_TYPE_ACCESS_ALLOWED | |
| 98 | assert str(ace.sid) == "S-1-5-21-717312990-3403304746-849770945-1201" | |
| 99 | assert ace.flags == sd.ACE_FLAG_INHERITED | |
| 100 | assert ace.mask == (sc.SYNCHRONIZE | sc.WRITE_OWNER | sc.WRITE_DAC | |
| 101 | | sc.READ_CONTROL | sc.DELETE | sc.FILE_READ_DATA | |
| 102 | | sc.FILE_WRITE_DATA | sc.FILE_APPEND_DATA | |
| 103 | | sc.FILE_READ_EA | sc.FILE_WRITE_EA | sc.FILE_EXECUTE | |
| 104 | | sc.FILE_DELETE_CHILD | sc.FILE_READ_ATTRIBUTES | |
| 105 | | sc.FILE_WRITE_ATTRIBUTES) | |
| 106 | ||
| 107 | ||
| 108 | def test_descriptor_binary_parsing(): | |
| 109 | raw_descriptor = binascii.unhexlify(b""" | |
| 110 | 01 00 04 84 14 00 00 00 30 00 00 00 00 00 00 00 | |
| 111 | 4c 00 00 00 01 05 00 00 00 00 00 05 15 00 00 00 | |
| 112 | de 53 c1 2a 2a 4f da ca c1 79 a6 32 b1 04 00 00 | |
| 113 | 01 05 00 00 00 00 00 05 15 00 00 00 de 53 c1 2a | |
| 114 | 2a 4f da ca c1 79 a6 32 01 02 00 00 02 00 70 00 | |
| 115 | 04 00 00 00 00 10 18 00 89 00 10 00 01 02 00 00 | |
| 116 | 00 00 00 05 20 00 00 00 21 02 00 00 00 10 14 00 | |
| 117 | ff 01 1f 00 01 01 00 00 00 00 00 05 12 00 00 00 | |
| 118 | 00 10 18 00 ff 01 1f 00 01 02 00 00 00 00 00 05 | |
| 119 | 20 00 00 00 20 02 00 00 00 10 24 00 ff 01 1f 00 | |
| 120 | 01 05 00 00 00 00 00 05 15 00 00 00 de 53 c1 2a | |
| 121 | 2a 4f da ca c1 79 a6 32 b1 04 00 00 | |
| 122 | """.translate(None, b' \n')) | |
| 123 | descriptor = sd.SecurityDescriptor.from_bytes(raw_descriptor) | |
| 124 | assert descriptor.flags == (sd.SECURITY_DESCRIPTOR_SELF_RELATIVE | |
| 125 | | sd.SECURITY_DESCRIPTOR_DACL_PRESENT | |
| 126 | | sd.SECURITY_DESCRIPTOR_DACL_AUTO_INHERITED) | |
| 127 | assert descriptor.dacl is not None | |
| 128 | assert descriptor.sacl is None | |
| 129 | assert str(descriptor.owner) == "S-1-5-21-717312990-3403304746-849770945-1201" | |
| 130 | assert str(descriptor.group) == "S-1-5-21-717312990-3403304746-849770945-513" | |
| 131 | ||
| 132 | acl = descriptor.dacl | |
| 133 | assert acl.revision == 2 | |
| 134 | assert len(acl.aces) == 4 | |
| 135 | assert str(acl.aces[0].sid) == sd.SID_BUILTIN_USERS | |
| 136 | assert str(acl.aces[1].sid) == sd.SID_LOCAL_SYSTEM | |
| 137 | assert str(acl.aces[2].sid) == sd.SID_BUILTIN_ADMINISTRATORS | |
| 138 | assert str(acl.aces[3].sid) == "S-1-5-21-717312990-3403304746-849770945-1201" |
| 7 | 7 | |
| 8 | 8 | setup( |
| 9 | 9 | name = "pysmb", |
| 10 | version = "1.1.19", | |
| 10 | version = "1.2.7", | |
| 11 | 11 | author = "Michael Teo", |
| 12 | 12 | author_email = "[email protected]", |
| 13 | 13 | license = "zlib/libpng", |
| 5 | 5 | |
| 6 | 6 | Notes |
| 7 | 7 | ----- |
| 8 | * Note that you need to pass in a valid hostname or IP address for the host component of the URL. | |
| 9 | Do not use the Windows/NetBIOS machine name for the host component. | |
| 8 | * The host component of the URL must be one of the following: | |
| 9 | ||
| 10 | * A fully-qualified hostname that can be resolved by your local DNS service. Example: myserver.test.com | |
| 11 | * An IP address. Example: 192.168.1.1 | |
| 12 | * A comma-separated string "<NBName>,<IP>" where *<NBName>* is the Windows/NetBIOS machine name for remote SMB service, and *<IP>* is the service's IP address. Example: MYSERVER,192.168.1.1 | |
| 13 | ||
| 10 | 14 | * The first component of the path in the URL points to the name of the shared folder. |
| 11 | 15 | Subsequent path components will point to the directory/folder of the file. |
| 12 | 16 | * You can retrieve and upload files, but you cannot delete files/folders or create folders. |
| 15 | 19 | Example |
| 16 | 20 | ------- |
| 17 | 21 | |
| 18 | The following code snippet illustrates file retrieval.:: | |
| 22 | The following code snippet illustrates file retrieval with Python 2.:: | |
| 19 | 23 | |
| 20 | 24 | # -*- coding: utf-8 -*- |
| 21 | 25 | import urllib2 |
| 33 | 37 | # Process fh2 like a file-like object and then close it. |
| 34 | 38 | fh2.close() |
| 35 | 39 | |
| 36 | The following code snippet illustrates file upload. You need to provide a file-like object for the *data* parameter in the *open()* method:: | |
| 40 | The following code snippet illustrates file upload with Python 2. You need to provide a file-like object for the *data* parameter in the *open()* method:: | |
| 37 | 41 | |
| 38 | 42 | import urllib2 |
| 39 | 43 | from smb.SMBHandler import SMBHandler |
| 45 | 49 | |
| 46 | 50 | # Reading from fh will only return an empty string |
| 47 | 51 | fh.close() |
| 52 | ||
| 53 | ||
| 54 | The following code snippet illustrates file retrieval with Python 3.:: | |
| 55 | ||
| 56 | import urllib | |
| 57 | from smb.SMBHandler import SMBHandler | |
| 58 | ||
| 59 | director = urllib.request.build_opener(SMBHandler) | |
| 60 | fh = director.open('smb://myuserID:[email protected]/sharedfolder/rfc1001.txt') | |
| 61 | ||
| 62 | # Process fh like a file-like object and then close it. | |
| 63 | fh.close() | |
| 64 | ||
| 65 | # For paths/files with unicode characters, simply pass in the URL as an unicode string | |
| 66 | fh2 = director.open(u'smb://myuserID:[email protected]/sharedfolder/测试文件夹/垃圾文件.dat') | |
| 67 | ||
| 68 | # Process fh2 like a file-like object and then close it. | |
| 69 | fh2.close() | |
| 70 | ||
| 71 | The following code snippet illustrates file upload with Python 3. You need to provide a file-like object for the *data* parameter in the *open()* method:: | |
| 72 | ||
| 73 | import urllib | |
| 74 | from smb.SMBHandler import SMBHandler | |
| 75 | ||
| 76 | file_fh = open('local_file.dat', 'rb') | |
| 77 | ||
| 78 | director = urllib.request.build_opener(SMBHandler) | |
| 79 | fh = director.open('smb://myuserID:[email protected]/sharedfolder/upload_file.dat', data = file_fh) | |
| 80 | ||
| 81 | # Reading from fh will only return an empty string | |
| 82 | fh.close() | |
| 0 | ||
| 1 | Security Descriptors | |
| 2 | ==================== | |
| 3 | ||
| 4 | .. module:: smb.security_descriptors | |
| 5 | :synopsis: Data structures used in Windows security descriptors. | |
| 6 | ||
| 7 | This module implements security descriptors, and associated data | |
| 8 | structures, as specified in `[MS-DTYP]`_. | |
| 9 | ||
| 10 | .. autoclass:: SID | |
| 11 | :members: | |
| 12 | ||
| 13 | .. autoclass:: ACE | |
| 14 | :members: | |
| 15 | ||
| 16 | .. autoclass:: ACL | |
| 17 | :members: | |
| 18 | ||
| 19 | .. autoclass:: SecurityDescriptor | |
| 20 | :members: | |
| 21 | ||
| 22 | .. _[MS-DTYP]: https://msdn.microsoft.com/en-us/library/cc230273.aspx |
| 0 | 0 | # -*- coding: utf-8 -*- |
| 1 | # | |
| 2 | # pysmb documentation build configuration file, created by | |
| 3 | # sphinx-quickstart on Sun Dec 18 15:54:40 2011. | |
| 4 | # | |
| 5 | # This file is execfile()d with the current directory set to its containing dir. | |
| 6 | # | |
| 7 | # Note that not all possible configuration values are present in this | |
| 8 | # autogenerated file. | |
| 9 | 1 | # |
| 10 | 2 | # All configuration values have a default; values that are commented out |
| 11 | 3 | # serve to show the default. |
| 16 | 8 | # add these directories to sys.path here. If the directory is relative to the |
| 17 | 9 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
| 18 | 10 | #sys.path.insert(0, os.path.abspath('.')) |
| 19 | sys.path.append(os.path.join(os.path.dirname(__file__), os.pardir, os.pardir, 'python2')) | |
| 11 | sys.path.append(os.path.join(os.path.dirname(__file__), os.pardir, os.pardir, 'python3')) | |
| 20 | 12 | |
| 21 | 13 | # -- General configuration ----------------------------------------------------- |
| 22 | 14 | |
| 41 | 33 | |
| 42 | 34 | # General information about the project. |
| 43 | 35 | project = u'pysmb' |
| 44 | copyright = u'2001-2015, Michael Teo http://miketeo.net/' | |
| 36 | copyright = u'2001-2021, Michael Teo https://miketeo.net/' | |
| 45 | 37 | |
| 46 | 38 | # The version info for the project you're documenting, acts as replacement for |
| 47 | 39 | # |version| and |release|, also used in various other places throughout the |
| 48 | 40 | # built documents. |
| 49 | 41 | # |
| 50 | 42 | # The short X.Y version. |
| 51 | version = '1.1.18' | |
| 43 | version = '1.2.7' | |
| 52 | 44 | # The full version, including alpha/beta/rc tags. |
| 53 | release = '1.1.18' | |
| 45 | release = '1.2.7' | |
| 54 | 46 | |
| 55 | 47 | # The language for content autogenerated by Sphinx. Refer to documentation |
| 56 | 48 | # for a list of supported languages. |
| 13 | 13 | 3. Write your own loop handling method to read data from the socket. Once data have been read, call *feedData* method with the parameter. |
| 14 | 14 | The *feedData* method has its own internal buffer, so it can accept incomplete NetBIOS session packet data. |
| 15 | 15 | 4. Override |
| 16 | ||
| 16 | 17 | * *onAuthOK* method to include your own operations to perform when authentication is successful. You can initiate file operations in this method. |
| 17 | 18 | * *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). |
| 18 | 19 | * *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. |
| 0 | .. pysmb documentation master file, created by | |
| 1 | sphinx-quickstart on Sun Dec 18 15:54:40 2011. | |
| 2 | You can adapt this file completely to your liking, but it should at least | |
| 3 | contain the root `toctree` directive. | |
| 4 | ||
| 5 | 0 | Welcome to pysmb's documentation! |
| 6 | 1 | ================================= |
| 7 | 2 | |
| 8 | 3 | pysmb is a pure Python implementation of the client-side SMB/CIFS protocol (SMB1 and SMB2) which is the underlying protocol |
| 9 | 4 | that facilitates file sharing and printing between Windows machines, as well as with Linux machines via the Samba server application. |
| 10 | 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. | |
| 5 | pysmb is developed in Python 2.7.x and Python 3.8.x and has been tested against shared folders on Windows 7, Windows 10 and Samba 4.x. | |
| 11 | 6 | |
| 12 | The latest version of pysmb is always available at the pysmb project page at `miketeo.net <http://miketeo.net/wp/index.php/projects/pysmb>`_. | |
| 7 | The latest version of pysmb is always available at the pysmb project page at `miketeo.net <http://miketeo.net/projects/pysmb>`_. | |
| 13 | 8 | |
| 14 | 9 | License |
| 15 | 10 | ------- |
| 89 | 84 | As a software developer who is looking to modify pysmb so that you can integrate it to other network frameworks: |
| 90 | 85 | * Read :doc:`extending` |
| 91 | 86 | |
| 87 | If you are upgrading from older pysmb versions: | |
| 88 | * Read :doc:`upgrading` | |
| 92 | 89 | |
| 93 | 90 | |
| 94 | 91 | Indices and tables |
| 100 | 97 | |
| 101 | 98 | api/* |
| 102 | 99 | extending |
| 100 | upgrading | |
| 103 | 101 | |
| 104 | 102 | * :ref:`genindex` |
| 105 | 103 | * :ref:`search` |
| 0 | Upgrading from older pysmb versions | |
| 1 | ==================================== | |
| 2 | ||
| 3 | This page documents the improvements and changes to the API that could be incompatible with previous releases. | |
| 4 | ||
| 5 | pysmb 1.2.0 | |
| 6 | ----------- | |
| 7 | - Add new `delete_matching_folders` parameter to `deleteFiles()` method in SMBProtocolFactory and SMBConnection | |
| 8 | class to support deletion of sub-folders. If you are passing timeout parameter to the `deleteFiles()` method | |
| 9 | in your application, please switch to using named parameter for timeout. | |
| 10 | ||
| 11 | pysmb 1.1.28 | |
| 12 | ------------ | |
| 13 | - SharedFile instances returned from the `listPath()` method now has a new property | |
| 14 | `file_id` attribute which represents the file reference number given by the remote SMB server. | |
| 15 | ||
| 16 | pysmb 1.1.26 | |
| 17 | ------------ | |
| 18 | - SMBConnection class can now be used as a context manager | |
| 19 | ||
| 20 | pysmb 1.1.25 | |
| 21 | ------------ | |
| 22 | - SharedFile class has a new property `isNormal` which will be True if the file is a | |
| 23 | 'normal' file. pysmb defines a 'normal' file as a file entry that is not | |
| 24 | read-only, not hidden, not system, not archive and not a directory; | |
| 25 | it ignores other attributes like compression, indexed, sparse, temporary and encryption. | |
| 26 | - `listPath()` method in SMBProtocolFactory and SMBConnection class will now include | |
| 27 | 'normal' files by default if you do not specify the `search` parameter. | |
| 28 | ||
| 29 | pysmb 1.1.20 | |
| 30 | ------------ | |
| 31 | - A new method `getSecurity()` was added to SMBConnection and SMBProtocolFactory class. | |
| 32 | ||
| 33 | pysmb 1.1.15 | |
| 34 | ------------ | |
| 35 | - Add new `truncate` parameter to `storeFileFromOffset()` in SMBProtocolFactory and SMBConnection | |
| 36 | class to support truncation of the file before writing. If you are passing timeout parameter | |
| 37 | to the `storeFileFromOffset()` method in your application, please switch to using named parameter for timeout. | |
| 38 | ||
| 39 | pysmb 1.1.11 | |
| 40 | ------------ | |
| 41 | - A new method `storeFileFromOffset()` was added to SMBConnection and SMBProtocolFactory class. | |
| 42 | ||
| 43 | pysmb 1.1.10 | |
| 44 | ------------ | |
| 45 | - A new method `getAttributes()` was added to SMBConnection and SMBProtocolFactory class | |
| 46 | - SharedFile class has a new property `isReadOnly` to indicate the file is read-only on the remote filesystem. | |
| 47 | ||
| 48 | pysmb 1.1.2 | |
| 49 | ----------- | |
| 50 | - `queryIPForName()` method in nmb.NetBIOS and nmb.NBNSProtocol class will now return only the server machine name and ignore workgroup names. | |
| 51 | ||
| 52 | pysmb 1.0.3 | |
| 53 | ----------- | |
| 54 | - Two new methods were added to NBNSProtocol class: `queryIPForName()` and `NetBIOS.queryIPForName()` | |
| 55 | to support querying for a machine's NetBIOS name at the given IP address. | |
| 56 | - A new method `retrieveFileFromOffset()` was added to SMBProtocolFactory and SMBConnection | |
| 57 | to support finer control of file retrieval operation. | |
| 58 | ||
| 59 | pysmb 1.0.0 | |
| 60 | ----------- | |
| 61 | pysmb was completely rewritten in version 1.0.0. | |
| 62 | If you are upgrading from pysmb 0.x, you most likely have to rewrite your application for the new 1.x API. |