You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1 line
17 KiB
1 line
17 KiB
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>portprober.js</title><link href="../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>net/portprober.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2013 Selenium committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2013 Software Freedom Conservancy<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the "License");<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an "AS IS" BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>'use strict';<tr><td><a name="l17" href="#l17">17</a><td><tr><td><a name="l18" href="#l18">18</a><td>var exec = require('child_process').exec,<tr><td><a name="l19" href="#l19">19</a><td> fs = require('fs'),<tr><td><a name="l20" href="#l20">20</a><td> net = require('net');<tr><td><a name="l21" href="#l21">21</a><td><tr><td><a name="l22" href="#l22">22</a><td>var promise = require('../index').promise;<tr><td><a name="l23" href="#l23">23</a><td><tr><td><a name="l24" href="#l24">24</a><td><tr><td><a name="l25" href="#l25">25</a><td>/**<tr><td><a name="l26" href="#l26">26</a><td> * The IANA suggested ephemeral port range.<tr><td><a name="l27" href="#l27">27</a><td> * @type {{min: number, max: number}}<tr><td><a name="l28" href="#l28">28</a><td> * @const<tr><td><a name="l29" href="#l29">29</a><td> * @see http://en.wikipedia.org/wiki/Ephemeral_ports<tr><td><a name="l30" href="#l30">30</a><td> */<tr><td><a name="l31" href="#l31">31</a><td>var DEFAULT_IANA_RANGE = {min: 49152, max: 65535};<tr><td><a name="l32" href="#l32">32</a><td><tr><td><a name="l33" href="#l33">33</a><td><tr><td><a name="l34" href="#l34">34</a><td>/**<tr><td><a name="l35" href="#l35">35</a><td> * The epheremal port range for the current system. Lazily computed on first<tr><td><a name="l36" href="#l36">36</a><td> * access.<tr><td><a name="l37" href="#l37">37</a><td> * @type {webdriver.promise.Promise.<{min: number, max: number}>}<tr><td><a name="l38" href="#l38">38</a><td> */<tr><td><a name="l39" href="#l39">39</a><td>var systemRange = null;<tr><td><a name="l40" href="#l40">40</a><td><tr><td><a name="l41" href="#l41">41</a><td><tr><td><a name="l42" href="#l42">42</a><td>/**<tr><td><a name="l43" href="#l43">43</a><td> * Computes the ephemeral port range for the current system. This is based on<tr><td><a name="l44" href="#l44">44</a><td> * http://stackoverflow.com/a/924337.<tr><td><a name="l45" href="#l45">45</a><td> * @return {webdriver.promise.Promise.<{min: number, max: number}>} A promise<tr><td><a name="l46" href="#l46">46</a><td> * that will resolve to the ephemeral port range of the current system.<tr><td><a name="l47" href="#l47">47</a><td> */<tr><td><a name="l48" href="#l48">48</a><td>function findSystemPortRange() {<tr><td><a name="l49" href="#l49">49</a><td> if (systemRange) {<tr><td><a name="l50" href="#l50">50</a><td> return systemRange;<tr><td><a name="l51" href="#l51">51</a><td> }<tr><td><a name="l52" href="#l52">52</a><td> var range = process.platform === 'win32' ?<tr><td><a name="l53" href="#l53">53</a><td> findWindowsPortRange() : findUnixPortRange();<tr><td><a name="l54" href="#l54">54</a><td> return systemRange = range.thenCatch(function() {<tr><td><a name="l55" href="#l55">55</a><td> return DEFAULT_IANA_RANGE;<tr><td><a name="l56" href="#l56">56</a><td> });<tr><td><a name="l57" href="#l57">57</a><td>}<tr><td><a name="l58" href="#l58">58</a><td><tr><td><a name="l59" href="#l59">59</a><td><tr><td><a name="l60" href="#l60">60</a><td>/**<tr><td><a name="l61" href="#l61">61</a><td> * Executes a command and returns its output if it succeeds.<tr><td><a name="l62" href="#l62">62</a><td> * @param {string} cmd The command to execute.<tr><td><a name="l63" href="#l63">63</a><td> * @return {!webdriver.promise.Promise<string>} A promise that will resolve<tr><td><a name="l64" href="#l64">64</a><td> * with the command's stdout data.<tr><td><a name="l65" href="#l65">65</a><td> */<tr><td><a name="l66" href="#l66">66</a><td>function execute(cmd) {<tr><td><a name="l67" href="#l67">67</a><td> var result = promise.defer();<tr><td><a name="l68" href="#l68">68</a><td> exec(cmd, function(err, stdout) {<tr><td><a name="l69" href="#l69">69</a><td> if (err) {<tr><td><a name="l70" href="#l70">70</a><td> result.reject(err);<tr><td><a name="l71" href="#l71">71</a><td> } else {<tr><td><a name="l72" href="#l72">72</a><td> result.fulfill(stdout);<tr><td><a name="l73" href="#l73">73</a><td> }<tr><td><a name="l74" href="#l74">74</a><td> });<tr><td><a name="l75" href="#l75">75</a><td> return result.promise;<tr><td><a name="l76" href="#l76">76</a><td>}<tr><td><a name="l77" href="#l77">77</a><td><tr><td><a name="l78" href="#l78">78</a><td><tr><td><a name="l79" href="#l79">79</a><td>/**<tr><td><a name="l80" href="#l80">80</a><td> * Computes the ephemeral port range for a Unix-like system.<tr><td><a name="l81" href="#l81">81</a><td> * @return {!webdriver.promise.Promise<{min: number, max: number}>} A promise<tr><td><a name="l82" href="#l82">82</a><td> * that will resolve with the ephemeral port range on the current system.<tr><td><a name="l83" href="#l83">83</a><td> */<tr><td><a name="l84" href="#l84">84</a><td>function findUnixPortRange() {<tr><td><a name="l85" href="#l85">85</a><td> var cmd;<tr><td><a name="l86" href="#l86">86</a><td> if (process.platform === 'sunos') {<tr><td><a name="l87" href="#l87">87</a><td> cmd =<tr><td><a name="l88" href="#l88">88</a><td> '/usr/sbin/ndd /dev/tcp tcp_smallest_anon_port tcp_largest_anon_port';<tr><td><a name="l89" href="#l89">89</a><td> } else if (fs.existsSync('/proc/sys/net/ipv4/ip_local_port_range')) {<tr><td><a name="l90" href="#l90">90</a><td> // Linux<tr><td><a name="l91" href="#l91">91</a><td> cmd = 'cat /proc/sys/net/ipv4/ip_local_port_range';<tr><td><a name="l92" href="#l92">92</a><td> } else {<tr><td><a name="l93" href="#l93">93</a><td> cmd = 'sysctl net.inet.ip.portrange.first net.inet.ip.portrange.last' +<tr><td><a name="l94" href="#l94">94</a><td> ' | sed -e "s/.*:\\s*//"';<tr><td><a name="l95" href="#l95">95</a><td> }<tr><td><a name="l96" href="#l96">96</a><td><tr><td><a name="l97" href="#l97">97</a><td> return execute(cmd).then(function(stdout) {<tr><td><a name="l98" href="#l98">98</a><td> if (!stdout || !stdout.length) return DEFAULT_IANA_RANGE;<tr><td><a name="l99" href="#l99">99</a><td> var range = stdout.trim().split(/\s+/).map(Number);<tr><td><a name="l100" href="#l100">100</a><td> if (range.some(isNaN)) return DEFAULT_IANA_RANGE;<tr><td><a name="l101" href="#l101">101</a><td> return {min: range[0], max: range[1]};<tr><td><a name="l102" href="#l102">102</a><td> });<tr><td><a name="l103" href="#l103">103</a><td>}<tr><td><a name="l104" href="#l104">104</a><td><tr><td><a name="l105" href="#l105">105</a><td><tr><td><a name="l106" href="#l106">106</a><td>/**<tr><td><a name="l107" href="#l107">107</a><td> * Computes the ephemeral port range for a Windows system.<tr><td><a name="l108" href="#l108">108</a><td> * @return {!webdriver.promise.Promise<{min: number, max: number}>} A promise<tr><td><a name="l109" href="#l109">109</a><td> * that will resolve with the ephemeral port range on the current system.<tr><td><a name="l110" href="#l110">110</a><td> */<tr><td><a name="l111" href="#l111">111</a><td>function findWindowsPortRange() {<tr><td><a name="l112" href="#l112">112</a><td> var deferredRange = promise.defer();<tr><td><a name="l113" href="#l113">113</a><td> // First, check if we're running on XP. If this initial command fails,<tr><td><a name="l114" href="#l114">114</a><td> // we just fallback on the default IANA range.<tr><td><a name="l115" href="#l115">115</a><td> return execute('cmd.exe /c ver').then(function(stdout) {<tr><td><a name="l116" href="#l116">116</a><td> if (/Windows XP/.test(stdout)) {<tr><td><a name="l117" href="#l117">117</a><td> // TODO: Try to read these values from the registry.<tr><td><a name="l118" href="#l118">118</a><td> return {min: 1025, max: 5000};<tr><td><a name="l119" href="#l119">119</a><td> } else {<tr><td><a name="l120" href="#l120">120</a><td> return execute('netsh int ipv4 show dynamicport tcp').<tr><td><a name="l121" href="#l121">121</a><td> then(function(stdout) {<tr><td><a name="l122" href="#l122">122</a><td> /* > netsh int ipv4 show dynamicport tcp<tr><td><a name="l123" href="#l123">123</a><td> Protocol tcp Dynamic Port Range<tr><td><a name="l124" href="#l124">124</a><td> ---------------------------------<tr><td><a name="l125" href="#l125">125</a><td> Start Port : 49152<tr><td><a name="l126" href="#l126">126</a><td> Number of Ports : 16384<tr><td><a name="l127" href="#l127">127</a><td> */<tr><td><a name="l128" href="#l128">128</a><td> var range = stdout.split(/\n/).filter(function(line) {<tr><td><a name="l129" href="#l129">129</a><td> return /.*:\s*\d+/.test(line);<tr><td><a name="l130" href="#l130">130</a><td> }).map(function(line) {<tr><td><a name="l131" href="#l131">131</a><td> return Number(line.split(/:\s*/)[1]);<tr><td><a name="l132" href="#l132">132</a><td> });<tr><td><a name="l133" href="#l133">133</a><td><tr><td><a name="l134" href="#l134">134</a><td> return {<tr><td><a name="l135" href="#l135">135</a><td> min: range[0],<tr><td><a name="l136" href="#l136">136</a><td> max: range[0] + range[1]<tr><td><a name="l137" href="#l137">137</a><td> };<tr><td><a name="l138" href="#l138">138</a><td> });<tr><td><a name="l139" href="#l139">139</a><td> }<tr><td><a name="l140" href="#l140">140</a><td> });<tr><td><a name="l141" href="#l141">141</a><td>}<tr><td><a name="l142" href="#l142">142</a><td><tr><td><a name="l143" href="#l143">143</a><td><tr><td><a name="l144" href="#l144">144</a><td>/**<tr><td><a name="l145" href="#l145">145</a><td> * Tests if a port is free.<tr><td><a name="l146" href="#l146">146</a><td> * @param {number} port The port to test.<tr><td><a name="l147" href="#l147">147</a><td> * @param {string=} opt_host The bound host to test the {@code port} against.<tr><td><a name="l148" href="#l148">148</a><td> * Defaults to {@code INADDR_ANY}.<tr><td><a name="l149" href="#l149">149</a><td> * @return {!webdriver.promise.Promise.<boolean>} A promise that will resolve<tr><td><a name="l150" href="#l150">150</a><td> * with whether the port is free.<tr><td><a name="l151" href="#l151">151</a><td> */<tr><td><a name="l152" href="#l152">152</a><td>function isFree(port, opt_host) {<tr><td><a name="l153" href="#l153">153</a><td> var result = promise.defer(function() {<tr><td><a name="l154" href="#l154">154</a><td> server.cancel();<tr><td><a name="l155" href="#l155">155</a><td> });<tr><td><a name="l156" href="#l156">156</a><td><tr><td><a name="l157" href="#l157">157</a><td> var server = net.createServer().on('error', function(e) {<tr><td><a name="l158" href="#l158">158</a><td> if (e.code === 'EADDRINUSE') {<tr><td><a name="l159" href="#l159">159</a><td> result.fulfill(false);<tr><td><a name="l160" href="#l160">160</a><td> } else {<tr><td><a name="l161" href="#l161">161</a><td> result.reject(e);<tr><td><a name="l162" href="#l162">162</a><td> }<tr><td><a name="l163" href="#l163">163</a><td> });<tr><td><a name="l164" href="#l164">164</a><td><tr><td><a name="l165" href="#l165">165</a><td> server.listen(port, opt_host, function() {<tr><td><a name="l166" href="#l166">166</a><td> server.close(function() {<tr><td><a name="l167" href="#l167">167</a><td> result.fulfill(true);<tr><td><a name="l168" href="#l168">168</a><td> });<tr><td><a name="l169" href="#l169">169</a><td> });<tr><td><a name="l170" href="#l170">170</a><td><tr><td><a name="l171" href="#l171">171</a><td> return result.promise;<tr><td><a name="l172" href="#l172">172</a><td>}<tr><td><a name="l173" href="#l173">173</a><td><tr><td><a name="l174" href="#l174">174</a><td><tr><td><a name="l175" href="#l175">175</a><td>/**<tr><td><a name="l176" href="#l176">176</a><td> * @param {string=} opt_host The bound host to test the {@code port} against.<tr><td><a name="l177" href="#l177">177</a><td> * Defaults to {@code INADDR_ANY}.<tr><td><a name="l178" href="#l178">178</a><td> * @return {!webdriver.promise.Promise.<number>} A promise that will resolve<tr><td><a name="l179" href="#l179">179</a><td> * to a free port. If a port cannot be found, the promise will be<tr><td><a name="l180" href="#l180">180</a><td> * rejected.<tr><td><a name="l181" href="#l181">181</a><td> */<tr><td><a name="l182" href="#l182">182</a><td>function findFreePort(opt_host) {<tr><td><a name="l183" href="#l183">183</a><td> return findSystemPortRange().then(function(range) {<tr><td><a name="l184" href="#l184">184</a><td> var attempts = 0;<tr><td><a name="l185" href="#l185">185</a><td> var deferredPort = promise.defer();<tr><td><a name="l186" href="#l186">186</a><td> findPort();<tr><td><a name="l187" href="#l187">187</a><td> return deferredPort.promise;<tr><td><a name="l188" href="#l188">188</a><td><tr><td><a name="l189" href="#l189">189</a><td> function findPort() {<tr><td><a name="l190" href="#l190">190</a><td> attempts += 1;<tr><td><a name="l191" href="#l191">191</a><td> if (attempts > 10) {<tr><td><a name="l192" href="#l192">192</a><td> deferredPort.reject(Error('Unable to find a free port'));<tr><td><a name="l193" href="#l193">193</a><td> }<tr><td><a name="l194" href="#l194">194</a><td><tr><td><a name="l195" href="#l195">195</a><td> var port = Math.floor(<tr><td><a name="l196" href="#l196">196</a><td> Math.random() * (range.max - range.min) + range.min);<tr><td><a name="l197" href="#l197">197</a><td> isFree(port, opt_host).then(function(isFree) {<tr><td><a name="l198" href="#l198">198</a><td> if (isFree) {<tr><td><a name="l199" href="#l199">199</a><td> deferredPort.fulfill(port);<tr><td><a name="l200" href="#l200">200</a><td> } else {<tr><td><a name="l201" href="#l201">201</a><td> findPort();<tr><td><a name="l202" href="#l202">202</a><td> }<tr><td><a name="l203" href="#l203">203</a><td> });<tr><td><a name="l204" href="#l204">204</a><td> }<tr><td><a name="l205" href="#l205">205</a><td> });<tr><td><a name="l206" href="#l206">206</a><td>}<tr><td><a name="l207" href="#l207">207</a><td><tr><td><a name="l208" href="#l208">208</a><td><tr><td><a name="l209" href="#l209">209</a><td>// PUBLIC API<tr><td><a name="l210" href="#l210">210</a><td><tr><td><a name="l211" href="#l211">211</a><td><tr><td><a name="l212" href="#l212">212</a><td>exports.findFreePort = findFreePort;<tr><td><a name="l213" href="#l213">213</a><td>exports.isFree = isFree;</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>No data</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>No data</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>No data</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../types.js"></script><script src="../../dossier.js"></script> |