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
86 KiB
1 line
86 KiB
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>utils.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/uri/utils.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2008 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the "License");<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an "AS-IS" BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Simple utilities for dealing with URI strings.<tr><td><a name="l17" href="#l17">17</a><td> *<tr><td><a name="l18" href="#l18">18</a><td> * This is intended to be a lightweight alternative to constructing goog.Uri<tr><td><a name="l19" href="#l19">19</a><td> * objects. Whereas goog.Uri adds several kilobytes to the binary regardless<tr><td><a name="l20" href="#l20">20</a><td> * of how much of its functionality you use, this is designed to be a set of<tr><td><a name="l21" href="#l21">21</a><td> * mostly-independent utilities so that the compiler includes only what is<tr><td><a name="l22" href="#l22">22</a><td> * necessary for the task. Estimated savings of porting is 5k pre-gzip and<tr><td><a name="l23" href="#l23">23</a><td> * 1.5k post-gzip. To ensure the savings remain, future developers should<tr><td><a name="l24" href="#l24">24</a><td> * avoid adding new functionality to existing functions, but instead create<tr><td><a name="l25" href="#l25">25</a><td> * new ones and factor out shared code.<tr><td><a name="l26" href="#l26">26</a><td> *<tr><td><a name="l27" href="#l27">27</a><td> * Many of these utilities have limited functionality, tailored to common<tr><td><a name="l28" href="#l28">28</a><td> * cases. The query parameter utilities assume that the parameter keys are<tr><td><a name="l29" href="#l29">29</a><td> * already encoded, since most keys are compile-time alphanumeric strings. The<tr><td><a name="l30" href="#l30">30</a><td> * query parameter mutation utilities also do not tolerate fragment identifiers.<tr><td><a name="l31" href="#l31">31</a><td> *<tr><td><a name="l32" href="#l32">32</a><td> * By design, these functions can be slower than goog.Uri equivalents.<tr><td><a name="l33" href="#l33">33</a><td> * Repeated calls to some of functions may be quadratic in behavior for IE,<tr><td><a name="l34" href="#l34">34</a><td> * although the effect is somewhat limited given the 2kb limit.<tr><td><a name="l35" href="#l35">35</a><td> *<tr><td><a name="l36" href="#l36">36</a><td> * One advantage of the limited functionality here is that this approach is<tr><td><a name="l37" href="#l37">37</a><td> * less sensitive to differences in URI encodings than goog.Uri, since these<tr><td><a name="l38" href="#l38">38</a><td> * functions modify the strings in place, rather than decoding and<tr><td><a name="l39" href="#l39">39</a><td> * re-encoding.<tr><td><a name="l40" href="#l40">40</a><td> *<tr><td><a name="l41" href="#l41">41</a><td> * Uses features of RFC 3986 for parsing/formatting URIs:<tr><td><a name="l42" href="#l42">42</a><td> * http://www.ietf.org/rfc/rfc3986.txt<tr><td><a name="l43" href="#l43">43</a><td> *<tr><td><a name="l44" href="#l44">44</a><td> * @author gboyer@google.com (Garrett Boyer) - The "lightened" design.<tr><td><a name="l45" href="#l45">45</a><td> * @author msamuel@google.com (Mike Samuel) - Domain knowledge and regexes.<tr><td><a name="l46" href="#l46">46</a><td> */<tr><td><a name="l47" href="#l47">47</a><td><tr><td><a name="l48" href="#l48">48</a><td>goog.provide('goog.uri.utils');<tr><td><a name="l49" href="#l49">49</a><td>goog.provide('goog.uri.utils.ComponentIndex');<tr><td><a name="l50" href="#l50">50</a><td>goog.provide('goog.uri.utils.QueryArray');<tr><td><a name="l51" href="#l51">51</a><td>goog.provide('goog.uri.utils.QueryValue');<tr><td><a name="l52" href="#l52">52</a><td>goog.provide('goog.uri.utils.StandardQueryParam');<tr><td><a name="l53" href="#l53">53</a><td><tr><td><a name="l54" href="#l54">54</a><td>goog.require('goog.asserts');<tr><td><a name="l55" href="#l55">55</a><td>goog.require('goog.string');<tr><td><a name="l56" href="#l56">56</a><td>goog.require('goog.userAgent');<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> * Character codes inlined to avoid object allocations due to charCode.<tr><td><a name="l61" href="#l61">61</a><td> * @enum {number}<tr><td><a name="l62" href="#l62">62</a><td> * @private<tr><td><a name="l63" href="#l63">63</a><td> */<tr><td><a name="l64" href="#l64">64</a><td>goog.uri.utils.CharCode_ = {<tr><td><a name="l65" href="#l65">65</a><td> AMPERSAND: 38,<tr><td><a name="l66" href="#l66">66</a><td> EQUAL: 61,<tr><td><a name="l67" href="#l67">67</a><td> HASH: 35,<tr><td><a name="l68" href="#l68">68</a><td> QUESTION: 63<tr><td><a name="l69" href="#l69">69</a><td>};<tr><td><a name="l70" href="#l70">70</a><td><tr><td><a name="l71" href="#l71">71</a><td><tr><td><a name="l72" href="#l72">72</a><td>/**<tr><td><a name="l73" href="#l73">73</a><td> * Builds a URI string from already-encoded parts.<tr><td><a name="l74" href="#l74">74</a><td> *<tr><td><a name="l75" href="#l75">75</a><td> * No encoding is performed. Any component may be omitted as either null or<tr><td><a name="l76" href="#l76">76</a><td> * undefined.<tr><td><a name="l77" href="#l77">77</a><td> *<tr><td><a name="l78" href="#l78">78</a><td> * @param {?string=} opt_scheme The scheme such as 'http'.<tr><td><a name="l79" href="#l79">79</a><td> * @param {?string=} opt_userInfo The user name before the '@'.<tr><td><a name="l80" href="#l80">80</a><td> * @param {?string=} opt_domain The domain such as 'www.google.com', already<tr><td><a name="l81" href="#l81">81</a><td> * URI-encoded.<tr><td><a name="l82" href="#l82">82</a><td> * @param {(string|number|null)=} opt_port The port number.<tr><td><a name="l83" href="#l83">83</a><td> * @param {?string=} opt_path The path, already URI-encoded. If it is not<tr><td><a name="l84" href="#l84">84</a><td> * empty, it must begin with a slash.<tr><td><a name="l85" href="#l85">85</a><td> * @param {?string=} opt_queryData The URI-encoded query data.<tr><td><a name="l86" href="#l86">86</a><td> * @param {?string=} opt_fragment The URI-encoded fragment identifier.<tr><td><a name="l87" href="#l87">87</a><td> * @return {string} The fully combined URI.<tr><td><a name="l88" href="#l88">88</a><td> */<tr><td><a name="l89" href="#l89">89</a><td>goog.uri.utils.buildFromEncodedParts = function(opt_scheme, opt_userInfo,<tr><td><a name="l90" href="#l90">90</a><td> opt_domain, opt_port, opt_path, opt_queryData, opt_fragment) {<tr><td><a name="l91" href="#l91">91</a><td> var out = '';<tr><td><a name="l92" href="#l92">92</a><td><tr><td><a name="l93" href="#l93">93</a><td> if (opt_scheme) {<tr><td><a name="l94" href="#l94">94</a><td> out += opt_scheme + ':';<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> if (opt_domain) {<tr><td><a name="l98" href="#l98">98</a><td> out += '//';<tr><td><a name="l99" href="#l99">99</a><td><tr><td><a name="l100" href="#l100">100</a><td> if (opt_userInfo) {<tr><td><a name="l101" href="#l101">101</a><td> out += opt_userInfo + '@';<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> out += opt_domain;<tr><td><a name="l105" href="#l105">105</a><td><tr><td><a name="l106" href="#l106">106</a><td> if (opt_port) {<tr><td><a name="l107" href="#l107">107</a><td> out += ':' + opt_port;<tr><td><a name="l108" href="#l108">108</a><td> }<tr><td><a name="l109" href="#l109">109</a><td> }<tr><td><a name="l110" href="#l110">110</a><td><tr><td><a name="l111" href="#l111">111</a><td> if (opt_path) {<tr><td><a name="l112" href="#l112">112</a><td> out += opt_path;<tr><td><a name="l113" href="#l113">113</a><td> }<tr><td><a name="l114" href="#l114">114</a><td><tr><td><a name="l115" href="#l115">115</a><td> if (opt_queryData) {<tr><td><a name="l116" href="#l116">116</a><td> out += '?' + opt_queryData;<tr><td><a name="l117" href="#l117">117</a><td> }<tr><td><a name="l118" href="#l118">118</a><td><tr><td><a name="l119" href="#l119">119</a><td> if (opt_fragment) {<tr><td><a name="l120" href="#l120">120</a><td> out += '#' + opt_fragment;<tr><td><a name="l121" href="#l121">121</a><td> }<tr><td><a name="l122" href="#l122">122</a><td><tr><td><a name="l123" href="#l123">123</a><td> return out;<tr><td><a name="l124" href="#l124">124</a><td>};<tr><td><a name="l125" href="#l125">125</a><td><tr><td><a name="l126" href="#l126">126</a><td><tr><td><a name="l127" href="#l127">127</a><td>/**<tr><td><a name="l128" href="#l128">128</a><td> * A regular expression for breaking a URI into its component parts.<tr><td><a name="l129" href="#l129">129</a><td> *<tr><td><a name="l130" href="#l130">130</a><td> * {@link http://www.ietf.org/rfc/rfc3986.txt} says in Appendix B<tr><td><a name="l131" href="#l131">131</a><td> * As the "first-match-wins" algorithm is identical to the "greedy"<tr><td><a name="l132" href="#l132">132</a><td> * disambiguation method used by POSIX regular expressions, it is natural and<tr><td><a name="l133" href="#l133">133</a><td> * commonplace to use a regular expression for parsing the potential five<tr><td><a name="l134" href="#l134">134</a><td> * components of a URI reference.<tr><td><a name="l135" href="#l135">135</a><td> *<tr><td><a name="l136" href="#l136">136</a><td> * The following line is the regular expression for breaking-down a<tr><td><a name="l137" href="#l137">137</a><td> * well-formed URI reference into its components.<tr><td><a name="l138" href="#l138">138</a><td> *<tr><td><a name="l139" href="#l139">139</a><td> * <pre><tr><td><a name="l140" href="#l140">140</a><td> * ^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?<tr><td><a name="l141" href="#l141">141</a><td> * 12 3 4 5 6 7 8 9<tr><td><a name="l142" href="#l142">142</a><td> * </pre><tr><td><a name="l143" href="#l143">143</a><td> *<tr><td><a name="l144" href="#l144">144</a><td> * The numbers in the second line above are only to assist readability; they<tr><td><a name="l145" href="#l145">145</a><td> * indicate the reference points for each subexpression (i.e., each paired<tr><td><a name="l146" href="#l146">146</a><td> * parenthesis). We refer to the value matched for subexpression <n> as $<n>.<tr><td><a name="l147" href="#l147">147</a><td> * For example, matching the above expression to<tr><td><a name="l148" href="#l148">148</a><td> * <pre><tr><td><a name="l149" href="#l149">149</a><td> * http://www.ics.uci.edu/pub/ietf/uri/#Related<tr><td><a name="l150" href="#l150">150</a><td> * </pre><tr><td><a name="l151" href="#l151">151</a><td> * results in the following subexpression matches:<tr><td><a name="l152" href="#l152">152</a><td> * <pre><tr><td><a name="l153" href="#l153">153</a><td> * $1 = http:<tr><td><a name="l154" href="#l154">154</a><td> * $2 = http<tr><td><a name="l155" href="#l155">155</a><td> * $3 = //www.ics.uci.edu<tr><td><a name="l156" href="#l156">156</a><td> * $4 = www.ics.uci.edu<tr><td><a name="l157" href="#l157">157</a><td> * $5 = /pub/ietf/uri/<tr><td><a name="l158" href="#l158">158</a><td> * $6 = <undefined><tr><td><a name="l159" href="#l159">159</a><td> * $7 = <undefined><tr><td><a name="l160" href="#l160">160</a><td> * $8 = #Related<tr><td><a name="l161" href="#l161">161</a><td> * $9 = Related<tr><td><a name="l162" href="#l162">162</a><td> * </pre><tr><td><a name="l163" href="#l163">163</a><td> * where <undefined> indicates that the component is not present, as is the<tr><td><a name="l164" href="#l164">164</a><td> * case for the query component in the above example. Therefore, we can<tr><td><a name="l165" href="#l165">165</a><td> * determine the value of the five components as<tr><td><a name="l166" href="#l166">166</a><td> * <pre><tr><td><a name="l167" href="#l167">167</a><td> * scheme = $2<tr><td><a name="l168" href="#l168">168</a><td> * authority = $4<tr><td><a name="l169" href="#l169">169</a><td> * path = $5<tr><td><a name="l170" href="#l170">170</a><td> * query = $7<tr><td><a name="l171" href="#l171">171</a><td> * fragment = $9<tr><td><a name="l172" href="#l172">172</a><td> * </pre><tr><td><a name="l173" href="#l173">173</a><td> *<tr><td><a name="l174" href="#l174">174</a><td> * The regular expression has been modified slightly to expose the<tr><td><a name="l175" href="#l175">175</a><td> * userInfo, domain, and port separately from the authority.<tr><td><a name="l176" href="#l176">176</a><td> * The modified version yields<tr><td><a name="l177" href="#l177">177</a><td> * <pre><tr><td><a name="l178" href="#l178">178</a><td> * $1 = http scheme<tr><td><a name="l179" href="#l179">179</a><td> * $2 = <undefined> userInfo -\<tr><td><a name="l180" href="#l180">180</a><td> * $3 = www.ics.uci.edu domain | authority<tr><td><a name="l181" href="#l181">181</a><td> * $4 = <undefined> port -/<tr><td><a name="l182" href="#l182">182</a><td> * $5 = /pub/ietf/uri/ path<tr><td><a name="l183" href="#l183">183</a><td> * $6 = <undefined> query without ?<tr><td><a name="l184" href="#l184">184</a><td> * $7 = Related fragment without #<tr><td><a name="l185" href="#l185">185</a><td> * </pre><tr><td><a name="l186" href="#l186">186</a><td> * @type {!RegExp}<tr><td><a name="l187" href="#l187">187</a><td> * @private<tr><td><a name="l188" href="#l188">188</a><td> */<tr><td><a name="l189" href="#l189">189</a><td>goog.uri.utils.splitRe_ = new RegExp(<tr><td><a name="l190" href="#l190">190</a><td> '^' +<tr><td><a name="l191" href="#l191">191</a><td> '(?:' +<tr><td><a name="l192" href="#l192">192</a><td> '([^:/?#.]+)' + // scheme - ignore special characters<tr><td><a name="l193" href="#l193">193</a><td> // used by other URL parts such as :,<tr><td><a name="l194" href="#l194">194</a><td> // ?, /, #, and .<tr><td><a name="l195" href="#l195">195</a><td> ':)?' +<tr><td><a name="l196" href="#l196">196</a><td> '(?://' +<tr><td><a name="l197" href="#l197">197</a><td> '(?:([^/?#]*)@)?' + // userInfo<tr><td><a name="l198" href="#l198">198</a><td> '([^/#?]*?)' + // domain<tr><td><a name="l199" href="#l199">199</a><td> '(?::([0-9]+))?' + // port<tr><td><a name="l200" href="#l200">200</a><td> '(?=[/#?]|$)' + // authority-terminating character<tr><td><a name="l201" href="#l201">201</a><td> ')?' +<tr><td><a name="l202" href="#l202">202</a><td> '([^?#]+)?' + // path<tr><td><a name="l203" href="#l203">203</a><td> '(?:\\?([^#]*))?' + // query<tr><td><a name="l204" href="#l204">204</a><td> '(?:#(.*))?' + // fragment<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> * The index of each URI component in the return value of goog.uri.utils.split.<tr><td><a name="l210" href="#l210">210</a><td> * @enum {number}<tr><td><a name="l211" href="#l211">211</a><td> */<tr><td><a name="l212" href="#l212">212</a><td>goog.uri.utils.ComponentIndex = {<tr><td><a name="l213" href="#l213">213</a><td> SCHEME: 1,<tr><td><a name="l214" href="#l214">214</a><td> USER_INFO: 2,<tr><td><a name="l215" href="#l215">215</a><td> DOMAIN: 3,<tr><td><a name="l216" href="#l216">216</a><td> PORT: 4,<tr><td><a name="l217" href="#l217">217</a><td> PATH: 5,<tr><td><a name="l218" href="#l218">218</a><td> QUERY_DATA: 6,<tr><td><a name="l219" href="#l219">219</a><td> FRAGMENT: 7<tr><td><a name="l220" href="#l220">220</a><td>};<tr><td><a name="l221" href="#l221">221</a><td><tr><td><a name="l222" href="#l222">222</a><td><tr><td><a name="l223" href="#l223">223</a><td>/**<tr><td><a name="l224" href="#l224">224</a><td> * Splits a URI into its component parts.<tr><td><a name="l225" href="#l225">225</a><td> *<tr><td><a name="l226" href="#l226">226</a><td> * Each component can be accessed via the component indices; for example:<tr><td><a name="l227" href="#l227">227</a><td> * <pre><tr><td><a name="l228" href="#l228">228</a><td> * goog.uri.utils.split(someStr)[goog.uri.utils.CompontentIndex.QUERY_DATA];<tr><td><a name="l229" href="#l229">229</a><td> * </pre><tr><td><a name="l230" href="#l230">230</a><td> *<tr><td><a name="l231" href="#l231">231</a><td> * @param {string} uri The URI string to examine.<tr><td><a name="l232" href="#l232">232</a><td> * @return {!Array.<string|undefined>} Each component still URI-encoded.<tr><td><a name="l233" href="#l233">233</a><td> * Each component that is present will contain the encoded value, whereas<tr><td><a name="l234" href="#l234">234</a><td> * components that are not present will be undefined or empty, depending<tr><td><a name="l235" href="#l235">235</a><td> * on the browser's regular expression implementation. Never null, since<tr><td><a name="l236" href="#l236">236</a><td> * arbitrary strings may still look like path names.<tr><td><a name="l237" href="#l237">237</a><td> */<tr><td><a name="l238" href="#l238">238</a><td>goog.uri.utils.split = function(uri) {<tr><td><a name="l239" href="#l239">239</a><td> goog.uri.utils.phishingProtection_();<tr><td><a name="l240" href="#l240">240</a><td><tr><td><a name="l241" href="#l241">241</a><td> // See @return comment -- never null.<tr><td><a name="l242" href="#l242">242</a><td> return /** @type {!Array.<string|undefined>} */ (<tr><td><a name="l243" href="#l243">243</a><td> uri.match(goog.uri.utils.splitRe_));<tr><td><a name="l244" href="#l244">244</a><td>};<tr><td><a name="l245" href="#l245">245</a><td><tr><td><a name="l246" href="#l246">246</a><td><tr><td><a name="l247" href="#l247">247</a><td>/**<tr><td><a name="l248" href="#l248">248</a><td> * Safari has a nasty bug where if you have an http URL with a username, e.g.,<tr><td><a name="l249" href="#l249">249</a><td> * http://evil.com%2F@google.com/<tr><td><a name="l250" href="#l250">250</a><td> * Safari will report that window.location.href is<tr><td><a name="l251" href="#l251">251</a><td> * http://evil.com/google.com/<tr><td><a name="l252" href="#l252">252</a><td> * so that anyone who tries to parse the domain of that URL will get<tr><td><a name="l253" href="#l253">253</a><td> * the wrong domain. We've seen exploits where people use this to trick<tr><td><a name="l254" href="#l254">254</a><td> * Safari into loading resources from evil domains.<tr><td><a name="l255" href="#l255">255</a><td> *<tr><td><a name="l256" href="#l256">256</a><td> * To work around this, we run a little "Safari phishing check", and throw<tr><td><a name="l257" href="#l257">257</a><td> * an exception if we see this happening.<tr><td><a name="l258" href="#l258">258</a><td> *<tr><td><a name="l259" href="#l259">259</a><td> * There is no convenient place to put this check. We apply it to<tr><td><a name="l260" href="#l260">260</a><td> * anyone doing URI parsing on Webkit. We're not happy about this, but<tr><td><a name="l261" href="#l261">261</a><td> * it fixes the problem.<tr><td><a name="l262" href="#l262">262</a><td> *<tr><td><a name="l263" href="#l263">263</a><td> * This should be removed once Safari fixes their bug.<tr><td><a name="l264" href="#l264">264</a><td> *<tr><td><a name="l265" href="#l265">265</a><td> * Exploit reported by Masato Kinugawa.<tr><td><a name="l266" href="#l266">266</a><td> *<tr><td><a name="l267" href="#l267">267</a><td> * @type {boolean}<tr><td><a name="l268" href="#l268">268</a><td> * @private<tr><td><a name="l269" href="#l269">269</a><td> */<tr><td><a name="l270" href="#l270">270</a><td>goog.uri.utils.needsPhishingProtection_ = goog.userAgent.WEBKIT;<tr><td><a name="l271" href="#l271">271</a><td><tr><td><a name="l272" href="#l272">272</a><td><tr><td><a name="l273" href="#l273">273</a><td>/**<tr><td><a name="l274" href="#l274">274</a><td> * Check to see if the user is being phished.<tr><td><a name="l275" href="#l275">275</a><td> * @private<tr><td><a name="l276" href="#l276">276</a><td> */<tr><td><a name="l277" href="#l277">277</a><td>goog.uri.utils.phishingProtection_ = function() {<tr><td><a name="l278" href="#l278">278</a><td> if (goog.uri.utils.needsPhishingProtection_) {<tr><td><a name="l279" href="#l279">279</a><td> // Turn protection off, so that we don't recurse.<tr><td><a name="l280" href="#l280">280</a><td> goog.uri.utils.needsPhishingProtection_ = false;<tr><td><a name="l281" href="#l281">281</a><td><tr><td><a name="l282" href="#l282">282</a><td> // Use quoted access, just in case the user isn't using location externs.<tr><td><a name="l283" href="#l283">283</a><td> var location = goog.global['location'];<tr><td><a name="l284" href="#l284">284</a><td> if (location) {<tr><td><a name="l285" href="#l285">285</a><td> var href = location['href'];<tr><td><a name="l286" href="#l286">286</a><td> if (href) {<tr><td><a name="l287" href="#l287">287</a><td> var domain = goog.uri.utils.getDomain(href);<tr><td><a name="l288" href="#l288">288</a><td> if (domain && domain != location['hostname']) {<tr><td><a name="l289" href="#l289">289</a><td> // Phishing attack<tr><td><a name="l290" href="#l290">290</a><td> goog.uri.utils.needsPhishingProtection_ = true;<tr><td><a name="l291" href="#l291">291</a><td> throw Error();<tr><td><a name="l292" href="#l292">292</a><td> }<tr><td><a name="l293" href="#l293">293</a><td> }<tr><td><a name="l294" href="#l294">294</a><td> }<tr><td><a name="l295" href="#l295">295</a><td> }<tr><td><a name="l296" href="#l296">296</a><td>};<tr><td><a name="l297" href="#l297">297</a><td><tr><td><a name="l298" href="#l298">298</a><td><tr><td><a name="l299" href="#l299">299</a><td>/**<tr><td><a name="l300" href="#l300">300</a><td> * @param {?string} uri A possibly null string.<tr><td><a name="l301" href="#l301">301</a><td> * @return {?string} The string URI-decoded, or null if uri is null.<tr><td><a name="l302" href="#l302">302</a><td> * @private<tr><td><a name="l303" href="#l303">303</a><td> */<tr><td><a name="l304" href="#l304">304</a><td>goog.uri.utils.decodeIfPossible_ = function(uri) {<tr><td><a name="l305" href="#l305">305</a><td> return uri && decodeURIComponent(uri);<tr><td><a name="l306" href="#l306">306</a><td>};<tr><td><a name="l307" href="#l307">307</a><td><tr><td><a name="l308" href="#l308">308</a><td><tr><td><a name="l309" href="#l309">309</a><td>/**<tr><td><a name="l310" href="#l310">310</a><td> * Gets a URI component by index.<tr><td><a name="l311" href="#l311">311</a><td> *<tr><td><a name="l312" href="#l312">312</a><td> * It is preferred to use the getPathEncoded() variety of functions ahead,<tr><td><a name="l313" href="#l313">313</a><td> * since they are more readable.<tr><td><a name="l314" href="#l314">314</a><td> *<tr><td><a name="l315" href="#l315">315</a><td> * @param {goog.uri.utils.ComponentIndex} componentIndex The component index.<tr><td><a name="l316" href="#l316">316</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l317" href="#l317">317</a><td> * @return {?string} The still-encoded component, or null if the component<tr><td><a name="l318" href="#l318">318</a><td> * is not present.<tr><td><a name="l319" href="#l319">319</a><td> * @private<tr><td><a name="l320" href="#l320">320</a><td> */<tr><td><a name="l321" href="#l321">321</a><td>goog.uri.utils.getComponentByIndex_ = function(componentIndex, uri) {<tr><td><a name="l322" href="#l322">322</a><td> // Convert undefined, null, and empty string into null.<tr><td><a name="l323" href="#l323">323</a><td> return goog.uri.utils.split(uri)[componentIndex] || null;<tr><td><a name="l324" href="#l324">324</a><td>};<tr><td><a name="l325" href="#l325">325</a><td><tr><td><a name="l326" href="#l326">326</a><td><tr><td><a name="l327" href="#l327">327</a><td>/**<tr><td><a name="l328" href="#l328">328</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l329" href="#l329">329</a><td> * @return {?string} The protocol or scheme, or null if none. Does not<tr><td><a name="l330" href="#l330">330</a><td> * include trailing colons or slashes.<tr><td><a name="l331" href="#l331">331</a><td> */<tr><td><a name="l332" href="#l332">332</a><td>goog.uri.utils.getScheme = function(uri) {<tr><td><a name="l333" href="#l333">333</a><td> return goog.uri.utils.getComponentByIndex_(<tr><td><a name="l334" href="#l334">334</a><td> goog.uri.utils.ComponentIndex.SCHEME, uri);<tr><td><a name="l335" href="#l335">335</a><td>};<tr><td><a name="l336" href="#l336">336</a><td><tr><td><a name="l337" href="#l337">337</a><td><tr><td><a name="l338" href="#l338">338</a><td>/**<tr><td><a name="l339" href="#l339">339</a><td> * Gets the effective scheme for the URL. If the URL is relative then the<tr><td><a name="l340" href="#l340">340</a><td> * scheme is derived from the page's location.<tr><td><a name="l341" href="#l341">341</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l342" href="#l342">342</a><td> * @return {string} The protocol or scheme, always lower case.<tr><td><a name="l343" href="#l343">343</a><td> */<tr><td><a name="l344" href="#l344">344</a><td>goog.uri.utils.getEffectiveScheme = function(uri) {<tr><td><a name="l345" href="#l345">345</a><td> var scheme = goog.uri.utils.getScheme(uri);<tr><td><a name="l346" href="#l346">346</a><td> if (!scheme && self.location) {<tr><td><a name="l347" href="#l347">347</a><td> var protocol = self.location.protocol;<tr><td><a name="l348" href="#l348">348</a><td> scheme = protocol.substr(0, protocol.length - 1);<tr><td><a name="l349" href="#l349">349</a><td> }<tr><td><a name="l350" href="#l350">350</a><td> // NOTE: When called from a web worker in Firefox 3.5, location maybe null.<tr><td><a name="l351" href="#l351">351</a><td> // All other browsers with web workers support self.location from the worker.<tr><td><a name="l352" href="#l352">352</a><td> return scheme ? scheme.toLowerCase() : '';<tr><td><a name="l353" href="#l353">353</a><td>};<tr><td><a name="l354" href="#l354">354</a><td><tr><td><a name="l355" href="#l355">355</a><td><tr><td><a name="l356" href="#l356">356</a><td>/**<tr><td><a name="l357" href="#l357">357</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l358" href="#l358">358</a><td> * @return {?string} The user name still encoded, or null if none.<tr><td><a name="l359" href="#l359">359</a><td> */<tr><td><a name="l360" href="#l360">360</a><td>goog.uri.utils.getUserInfoEncoded = function(uri) {<tr><td><a name="l361" href="#l361">361</a><td> return goog.uri.utils.getComponentByIndex_(<tr><td><a name="l362" href="#l362">362</a><td> goog.uri.utils.ComponentIndex.USER_INFO, uri);<tr><td><a name="l363" href="#l363">363</a><td>};<tr><td><a name="l364" href="#l364">364</a><td><tr><td><a name="l365" href="#l365">365</a><td><tr><td><a name="l366" href="#l366">366</a><td>/**<tr><td><a name="l367" href="#l367">367</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l368" href="#l368">368</a><td> * @return {?string} The decoded user info, or null if none.<tr><td><a name="l369" href="#l369">369</a><td> */<tr><td><a name="l370" href="#l370">370</a><td>goog.uri.utils.getUserInfo = function(uri) {<tr><td><a name="l371" href="#l371">371</a><td> return goog.uri.utils.decodeIfPossible_(<tr><td><a name="l372" href="#l372">372</a><td> goog.uri.utils.getUserInfoEncoded(uri));<tr><td><a name="l373" href="#l373">373</a><td>};<tr><td><a name="l374" href="#l374">374</a><td><tr><td><a name="l375" href="#l375">375</a><td><tr><td><a name="l376" href="#l376">376</a><td>/**<tr><td><a name="l377" href="#l377">377</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l378" href="#l378">378</a><td> * @return {?string} The domain name still encoded, or null if none.<tr><td><a name="l379" href="#l379">379</a><td> */<tr><td><a name="l380" href="#l380">380</a><td>goog.uri.utils.getDomainEncoded = function(uri) {<tr><td><a name="l381" href="#l381">381</a><td> return goog.uri.utils.getComponentByIndex_(<tr><td><a name="l382" href="#l382">382</a><td> goog.uri.utils.ComponentIndex.DOMAIN, uri);<tr><td><a name="l383" href="#l383">383</a><td>};<tr><td><a name="l384" href="#l384">384</a><td><tr><td><a name="l385" href="#l385">385</a><td><tr><td><a name="l386" href="#l386">386</a><td>/**<tr><td><a name="l387" href="#l387">387</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l388" href="#l388">388</a><td> * @return {?string} The decoded domain, or null if none.<tr><td><a name="l389" href="#l389">389</a><td> */<tr><td><a name="l390" href="#l390">390</a><td>goog.uri.utils.getDomain = function(uri) {<tr><td><a name="l391" href="#l391">391</a><td> return goog.uri.utils.decodeIfPossible_(goog.uri.utils.getDomainEncoded(uri));<tr><td><a name="l392" href="#l392">392</a><td>};<tr><td><a name="l393" href="#l393">393</a><td><tr><td><a name="l394" href="#l394">394</a><td><tr><td><a name="l395" href="#l395">395</a><td>/**<tr><td><a name="l396" href="#l396">396</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l397" href="#l397">397</a><td> * @return {?number} The port number, or null if none.<tr><td><a name="l398" href="#l398">398</a><td> */<tr><td><a name="l399" href="#l399">399</a><td>goog.uri.utils.getPort = function(uri) {<tr><td><a name="l400" href="#l400">400</a><td> // Coerce to a number. If the result of getComponentByIndex_ is null or<tr><td><a name="l401" href="#l401">401</a><td> // non-numeric, the number coersion yields NaN. This will then return<tr><td><a name="l402" href="#l402">402</a><td> // null for all non-numeric cases (though also zero, which isn't a relevant<tr><td><a name="l403" href="#l403">403</a><td> // port number).<tr><td><a name="l404" href="#l404">404</a><td> return Number(goog.uri.utils.getComponentByIndex_(<tr><td><a name="l405" href="#l405">405</a><td> goog.uri.utils.ComponentIndex.PORT, uri)) || null;<tr><td><a name="l406" href="#l406">406</a><td>};<tr><td><a name="l407" href="#l407">407</a><td><tr><td><a name="l408" href="#l408">408</a><td><tr><td><a name="l409" href="#l409">409</a><td>/**<tr><td><a name="l410" href="#l410">410</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l411" href="#l411">411</a><td> * @return {?string} The path still encoded, or null if none. Includes the<tr><td><a name="l412" href="#l412">412</a><td> * leading slash, if any.<tr><td><a name="l413" href="#l413">413</a><td> */<tr><td><a name="l414" href="#l414">414</a><td>goog.uri.utils.getPathEncoded = function(uri) {<tr><td><a name="l415" href="#l415">415</a><td> return goog.uri.utils.getComponentByIndex_(<tr><td><a name="l416" href="#l416">416</a><td> goog.uri.utils.ComponentIndex.PATH, uri);<tr><td><a name="l417" href="#l417">417</a><td>};<tr><td><a name="l418" href="#l418">418</a><td><tr><td><a name="l419" href="#l419">419</a><td><tr><td><a name="l420" href="#l420">420</a><td>/**<tr><td><a name="l421" href="#l421">421</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l422" href="#l422">422</a><td> * @return {?string} The decoded path, or null if none. Includes the leading<tr><td><a name="l423" href="#l423">423</a><td> * slash, if any.<tr><td><a name="l424" href="#l424">424</a><td> */<tr><td><a name="l425" href="#l425">425</a><td>goog.uri.utils.getPath = function(uri) {<tr><td><a name="l426" href="#l426">426</a><td> return goog.uri.utils.decodeIfPossible_(goog.uri.utils.getPathEncoded(uri));<tr><td><a name="l427" href="#l427">427</a><td>};<tr><td><a name="l428" href="#l428">428</a><td><tr><td><a name="l429" href="#l429">429</a><td><tr><td><a name="l430" href="#l430">430</a><td>/**<tr><td><a name="l431" href="#l431">431</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l432" href="#l432">432</a><td> * @return {?string} The query data still encoded, or null if none. Does not<tr><td><a name="l433" href="#l433">433</a><td> * include the question mark itself.<tr><td><a name="l434" href="#l434">434</a><td> */<tr><td><a name="l435" href="#l435">435</a><td>goog.uri.utils.getQueryData = function(uri) {<tr><td><a name="l436" href="#l436">436</a><td> return goog.uri.utils.getComponentByIndex_(<tr><td><a name="l437" href="#l437">437</a><td> goog.uri.utils.ComponentIndex.QUERY_DATA, uri);<tr><td><a name="l438" href="#l438">438</a><td>};<tr><td><a name="l439" href="#l439">439</a><td><tr><td><a name="l440" href="#l440">440</a><td><tr><td><a name="l441" href="#l441">441</a><td>/**<tr><td><a name="l442" href="#l442">442</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l443" href="#l443">443</a><td> * @return {?string} The fragment identifier, or null if none. Does not<tr><td><a name="l444" href="#l444">444</a><td> * include the hash mark itself.<tr><td><a name="l445" href="#l445">445</a><td> */<tr><td><a name="l446" href="#l446">446</a><td>goog.uri.utils.getFragmentEncoded = function(uri) {<tr><td><a name="l447" href="#l447">447</a><td> // The hash mark may not appear in any other part of the URL.<tr><td><a name="l448" href="#l448">448</a><td> var hashIndex = uri.indexOf('#');<tr><td><a name="l449" href="#l449">449</a><td> return hashIndex < 0 ? null : uri.substr(hashIndex + 1);<tr><td><a name="l450" href="#l450">450</a><td>};<tr><td><a name="l451" href="#l451">451</a><td><tr><td><a name="l452" href="#l452">452</a><td><tr><td><a name="l453" href="#l453">453</a><td>/**<tr><td><a name="l454" href="#l454">454</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l455" href="#l455">455</a><td> * @param {?string} fragment The encoded fragment identifier, or null if none.<tr><td><a name="l456" href="#l456">456</a><td> * Does not include the hash mark itself.<tr><td><a name="l457" href="#l457">457</a><td> * @return {string} The URI with the fragment set.<tr><td><a name="l458" href="#l458">458</a><td> */<tr><td><a name="l459" href="#l459">459</a><td>goog.uri.utils.setFragmentEncoded = function(uri, fragment) {<tr><td><a name="l460" href="#l460">460</a><td> return goog.uri.utils.removeFragment(uri) + (fragment ? '#' + fragment : '');<tr><td><a name="l461" href="#l461">461</a><td>};<tr><td><a name="l462" href="#l462">462</a><td><tr><td><a name="l463" href="#l463">463</a><td><tr><td><a name="l464" href="#l464">464</a><td>/**<tr><td><a name="l465" href="#l465">465</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l466" href="#l466">466</a><td> * @return {?string} The decoded fragment identifier, or null if none. Does<tr><td><a name="l467" href="#l467">467</a><td> * not include the hash mark.<tr><td><a name="l468" href="#l468">468</a><td> */<tr><td><a name="l469" href="#l469">469</a><td>goog.uri.utils.getFragment = function(uri) {<tr><td><a name="l470" href="#l470">470</a><td> return goog.uri.utils.decodeIfPossible_(<tr><td><a name="l471" href="#l471">471</a><td> goog.uri.utils.getFragmentEncoded(uri));<tr><td><a name="l472" href="#l472">472</a><td>};<tr><td><a name="l473" href="#l473">473</a><td><tr><td><a name="l474" href="#l474">474</a><td><tr><td><a name="l475" href="#l475">475</a><td>/**<tr><td><a name="l476" href="#l476">476</a><td> * Extracts everything up to the port of the URI.<tr><td><a name="l477" href="#l477">477</a><td> * @param {string} uri The URI string.<tr><td><a name="l478" href="#l478">478</a><td> * @return {string} Everything up to and including the port.<tr><td><a name="l479" href="#l479">479</a><td> */<tr><td><a name="l480" href="#l480">480</a><td>goog.uri.utils.getHost = function(uri) {<tr><td><a name="l481" href="#l481">481</a><td> var pieces = goog.uri.utils.split(uri);<tr><td><a name="l482" href="#l482">482</a><td> return goog.uri.utils.buildFromEncodedParts(<tr><td><a name="l483" href="#l483">483</a><td> pieces[goog.uri.utils.ComponentIndex.SCHEME],<tr><td><a name="l484" href="#l484">484</a><td> pieces[goog.uri.utils.ComponentIndex.USER_INFO],<tr><td><a name="l485" href="#l485">485</a><td> pieces[goog.uri.utils.ComponentIndex.DOMAIN],<tr><td><a name="l486" href="#l486">486</a><td> pieces[goog.uri.utils.ComponentIndex.PORT]);<tr><td><a name="l487" href="#l487">487</a><td>};<tr><td><a name="l488" href="#l488">488</a><td><tr><td><a name="l489" href="#l489">489</a><td><tr><td><a name="l490" href="#l490">490</a><td>/**<tr><td><a name="l491" href="#l491">491</a><td> * Extracts the path of the URL and everything after.<tr><td><a name="l492" href="#l492">492</a><td> * @param {string} uri The URI string.<tr><td><a name="l493" href="#l493">493</a><td> * @return {string} The URI, starting at the path and including the query<tr><td><a name="l494" href="#l494">494</a><td> * parameters and fragment identifier.<tr><td><a name="l495" href="#l495">495</a><td> */<tr><td><a name="l496" href="#l496">496</a><td>goog.uri.utils.getPathAndAfter = function(uri) {<tr><td><a name="l497" href="#l497">497</a><td> var pieces = goog.uri.utils.split(uri);<tr><td><a name="l498" href="#l498">498</a><td> return goog.uri.utils.buildFromEncodedParts(null, null, null, null,<tr><td><a name="l499" href="#l499">499</a><td> pieces[goog.uri.utils.ComponentIndex.PATH],<tr><td><a name="l500" href="#l500">500</a><td> pieces[goog.uri.utils.ComponentIndex.QUERY_DATA],<tr><td><a name="l501" href="#l501">501</a><td> pieces[goog.uri.utils.ComponentIndex.FRAGMENT]);<tr><td><a name="l502" href="#l502">502</a><td>};<tr><td><a name="l503" href="#l503">503</a><td><tr><td><a name="l504" href="#l504">504</a><td><tr><td><a name="l505" href="#l505">505</a><td>/**<tr><td><a name="l506" href="#l506">506</a><td> * Gets the URI with the fragment identifier removed.<tr><td><a name="l507" href="#l507">507</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l508" href="#l508">508</a><td> * @return {string} Everything preceding the hash mark.<tr><td><a name="l509" href="#l509">509</a><td> */<tr><td><a name="l510" href="#l510">510</a><td>goog.uri.utils.removeFragment = function(uri) {<tr><td><a name="l511" href="#l511">511</a><td> // The hash mark may not appear in any other part of the URL.<tr><td><a name="l512" href="#l512">512</a><td> var hashIndex = uri.indexOf('#');<tr><td><a name="l513" href="#l513">513</a><td> return hashIndex < 0 ? uri : uri.substr(0, hashIndex);<tr><td><a name="l514" href="#l514">514</a><td>};<tr><td><a name="l515" href="#l515">515</a><td><tr><td><a name="l516" href="#l516">516</a><td><tr><td><a name="l517" href="#l517">517</a><td>/**<tr><td><a name="l518" href="#l518">518</a><td> * Ensures that two URI's have the exact same domain, scheme, and port.<tr><td><a name="l519" href="#l519">519</a><td> *<tr><td><a name="l520" href="#l520">520</a><td> * Unlike the version in goog.Uri, this checks protocol, and therefore is<tr><td><a name="l521" href="#l521">521</a><td> * suitable for checking against the browser's same-origin policy.<tr><td><a name="l522" href="#l522">522</a><td> *<tr><td><a name="l523" href="#l523">523</a><td> * @param {string} uri1 The first URI.<tr><td><a name="l524" href="#l524">524</a><td> * @param {string} uri2 The second URI.<tr><td><a name="l525" href="#l525">525</a><td> * @return {boolean} Whether they have the same domain and port.<tr><td><a name="l526" href="#l526">526</a><td> */<tr><td><a name="l527" href="#l527">527</a><td>goog.uri.utils.haveSameDomain = function(uri1, uri2) {<tr><td><a name="l528" href="#l528">528</a><td> var pieces1 = goog.uri.utils.split(uri1);<tr><td><a name="l529" href="#l529">529</a><td> var pieces2 = goog.uri.utils.split(uri2);<tr><td><a name="l530" href="#l530">530</a><td> return pieces1[goog.uri.utils.ComponentIndex.DOMAIN] ==<tr><td><a name="l531" href="#l531">531</a><td> pieces2[goog.uri.utils.ComponentIndex.DOMAIN] &&<tr><td><a name="l532" href="#l532">532</a><td> pieces1[goog.uri.utils.ComponentIndex.SCHEME] ==<tr><td><a name="l533" href="#l533">533</a><td> pieces2[goog.uri.utils.ComponentIndex.SCHEME] &&<tr><td><a name="l534" href="#l534">534</a><td> pieces1[goog.uri.utils.ComponentIndex.PORT] ==<tr><td><a name="l535" href="#l535">535</a><td> pieces2[goog.uri.utils.ComponentIndex.PORT];<tr><td><a name="l536" href="#l536">536</a><td>};<tr><td><a name="l537" href="#l537">537</a><td><tr><td><a name="l538" href="#l538">538</a><td><tr><td><a name="l539" href="#l539">539</a><td>/**<tr><td><a name="l540" href="#l540">540</a><td> * Asserts that there are no fragment or query identifiers, only in uncompiled<tr><td><a name="l541" href="#l541">541</a><td> * mode.<tr><td><a name="l542" href="#l542">542</a><td> * @param {string} uri The URI to examine.<tr><td><a name="l543" href="#l543">543</a><td> * @private<tr><td><a name="l544" href="#l544">544</a><td> */<tr><td><a name="l545" href="#l545">545</a><td>goog.uri.utils.assertNoFragmentsOrQueries_ = function(uri) {<tr><td><a name="l546" href="#l546">546</a><td> // NOTE: would use goog.asserts here, but jscompiler doesn't know that<tr><td><a name="l547" href="#l547">547</a><td> // indexOf has no side effects.<tr><td><a name="l548" href="#l548">548</a><td> if (goog.DEBUG && (uri.indexOf('#') >= 0 || uri.indexOf('?') >= 0)) {<tr><td><a name="l549" href="#l549">549</a><td> throw Error('goog.uri.utils: Fragment or query identifiers are not ' +<tr><td><a name="l550" href="#l550">550</a><td> 'supported: [' + uri + ']');<tr><td><a name="l551" href="#l551">551</a><td> }<tr><td><a name="l552" href="#l552">552</a><td>};<tr><td><a name="l553" href="#l553">553</a><td><tr><td><a name="l554" href="#l554">554</a><td><tr><td><a name="l555" href="#l555">555</a><td>/**<tr><td><a name="l556" href="#l556">556</a><td> * Supported query parameter values by the parameter serializing utilities.<tr><td><a name="l557" href="#l557">557</a><td> *<tr><td><a name="l558" href="#l558">558</a><td> * If a value is null or undefined, the key-value pair is skipped, as an easy<tr><td><a name="l559" href="#l559">559</a><td> * way to omit parameters conditionally. Non-array parameters are converted<tr><td><a name="l560" href="#l560">560</a><td> * to a string and URI encoded. Array values are expanded into multiple<tr><td><a name="l561" href="#l561">561</a><td> * &key=value pairs, with each element stringized and URI-encoded.<tr><td><a name="l562" href="#l562">562</a><td> *<tr><td><a name="l563" href="#l563">563</a><td> * @typedef {*}<tr><td><a name="l564" href="#l564">564</a><td> */<tr><td><a name="l565" href="#l565">565</a><td>goog.uri.utils.QueryValue;<tr><td><a name="l566" href="#l566">566</a><td><tr><td><a name="l567" href="#l567">567</a><td><tr><td><a name="l568" href="#l568">568</a><td>/**<tr><td><a name="l569" href="#l569">569</a><td> * An array representing a set of query parameters with alternating keys<tr><td><a name="l570" href="#l570">570</a><td> * and values.<tr><td><a name="l571" href="#l571">571</a><td> *<tr><td><a name="l572" href="#l572">572</a><td> * Keys are assumed to be URI encoded already and live at even indices. See<tr><td><a name="l573" href="#l573">573</a><td> * goog.uri.utils.QueryValue for details on how parameter values are encoded.<tr><td><a name="l574" href="#l574">574</a><td> *<tr><td><a name="l575" href="#l575">575</a><td> * Example:<tr><td><a name="l576" href="#l576">576</a><td> * <pre><tr><td><a name="l577" href="#l577">577</a><td> * var data = [<tr><td><a name="l578" href="#l578">578</a><td> * // Simple param: ?name=BobBarker<tr><td><a name="l579" href="#l579">579</a><td> * 'name', 'BobBarker',<tr><td><a name="l580" href="#l580">580</a><td> * // Conditional param -- may be omitted entirely.<tr><td><a name="l581" href="#l581">581</a><td> * 'specialDietaryNeeds', hasDietaryNeeds() ? getDietaryNeeds() : null,<tr><td><a name="l582" href="#l582">582</a><td> * // Multi-valued param: &house=LosAngeles&house=NewYork&house=null<tr><td><a name="l583" href="#l583">583</a><td> * 'house', ['LosAngeles', 'NewYork', null]<tr><td><a name="l584" href="#l584">584</a><td> * ];<tr><td><a name="l585" href="#l585">585</a><td> * </pre><tr><td><a name="l586" href="#l586">586</a><td> *<tr><td><a name="l587" href="#l587">587</a><td> * @typedef {!Array.<string|goog.uri.utils.QueryValue>}<tr><td><a name="l588" href="#l588">588</a><td> */<tr><td><a name="l589" href="#l589">589</a><td>goog.uri.utils.QueryArray;<tr><td><a name="l590" href="#l590">590</a><td><tr><td><a name="l591" href="#l591">591</a><td><tr><td><a name="l592" href="#l592">592</a><td>/**<tr><td><a name="l593" href="#l593">593</a><td> * Appends a URI and query data in a string buffer with special preconditions.<tr><td><a name="l594" href="#l594">594</a><td> *<tr><td><a name="l595" href="#l595">595</a><td> * Internal implementation utility, performing very few object allocations.<tr><td><a name="l596" href="#l596">596</a><td> *<tr><td><a name="l597" href="#l597">597</a><td> * @param {!Array.<string|undefined>} buffer A string buffer. The first element<tr><td><a name="l598" href="#l598">598</a><td> * must be the base URI, and may have a fragment identifier. If the array<tr><td><a name="l599" href="#l599">599</a><td> * contains more than one element, the second element must be an ampersand,<tr><td><a name="l600" href="#l600">600</a><td> * and may be overwritten, depending on the base URI. Undefined elements<tr><td><a name="l601" href="#l601">601</a><td> * are treated as empty-string.<tr><td><a name="l602" href="#l602">602</a><td> * @return {string} The concatenated URI and query data.<tr><td><a name="l603" href="#l603">603</a><td> * @private<tr><td><a name="l604" href="#l604">604</a><td> */<tr><td><a name="l605" href="#l605">605</a><td>goog.uri.utils.appendQueryData_ = function(buffer) {<tr><td><a name="l606" href="#l606">606</a><td> if (buffer[1]) {<tr><td><a name="l607" href="#l607">607</a><td> // At least one query parameter was added. We need to check the<tr><td><a name="l608" href="#l608">608</a><td> // punctuation mark, which is currently an ampersand, and also make sure<tr><td><a name="l609" href="#l609">609</a><td> // there aren't any interfering fragment identifiers.<tr><td><a name="l610" href="#l610">610</a><td> var baseUri = /** @type {string} */ (buffer[0]);<tr><td><a name="l611" href="#l611">611</a><td> var hashIndex = baseUri.indexOf('#');<tr><td><a name="l612" href="#l612">612</a><td> if (hashIndex >= 0) {<tr><td><a name="l613" href="#l613">613</a><td> // Move the fragment off the base part of the URI into the end.<tr><td><a name="l614" href="#l614">614</a><td> buffer.push(baseUri.substr(hashIndex));<tr><td><a name="l615" href="#l615">615</a><td> buffer[0] = baseUri = baseUri.substr(0, hashIndex);<tr><td><a name="l616" href="#l616">616</a><td> }<tr><td><a name="l617" href="#l617">617</a><td> var questionIndex = baseUri.indexOf('?');<tr><td><a name="l618" href="#l618">618</a><td> if (questionIndex < 0) {<tr><td><a name="l619" href="#l619">619</a><td> // No question mark, so we need a question mark instead of an ampersand.<tr><td><a name="l620" href="#l620">620</a><td> buffer[1] = '?';<tr><td><a name="l621" href="#l621">621</a><td> } else if (questionIndex == baseUri.length - 1) {<tr><td><a name="l622" href="#l622">622</a><td> // Question mark is the very last character of the existing URI, so don't<tr><td><a name="l623" href="#l623">623</a><td> // append an additional delimiter.<tr><td><a name="l624" href="#l624">624</a><td> buffer[1] = undefined;<tr><td><a name="l625" href="#l625">625</a><td> }<tr><td><a name="l626" href="#l626">626</a><td> }<tr><td><a name="l627" href="#l627">627</a><td><tr><td><a name="l628" href="#l628">628</a><td> return buffer.join('');<tr><td><a name="l629" href="#l629">629</a><td>};<tr><td><a name="l630" href="#l630">630</a><td><tr><td><a name="l631" href="#l631">631</a><td><tr><td><a name="l632" href="#l632">632</a><td>/**<tr><td><a name="l633" href="#l633">633</a><td> * Appends key=value pairs to an array, supporting multi-valued objects.<tr><td><a name="l634" href="#l634">634</a><td> * @param {string} key The key prefix.<tr><td><a name="l635" href="#l635">635</a><td> * @param {goog.uri.utils.QueryValue} value The value to serialize.<tr><td><a name="l636" href="#l636">636</a><td> * @param {!Array.<string>} pairs The array to which the 'key=value' strings<tr><td><a name="l637" href="#l637">637</a><td> * should be appended.<tr><td><a name="l638" href="#l638">638</a><td> * @private<tr><td><a name="l639" href="#l639">639</a><td> */<tr><td><a name="l640" href="#l640">640</a><td>goog.uri.utils.appendKeyValuePairs_ = function(key, value, pairs) {<tr><td><a name="l641" href="#l641">641</a><td> if (goog.isArray(value)) {<tr><td><a name="l642" href="#l642">642</a><td> // Convince the compiler it's an array.<tr><td><a name="l643" href="#l643">643</a><td> goog.asserts.assertArray(value);<tr><td><a name="l644" href="#l644">644</a><td> for (var j = 0; j < value.length; j++) {<tr><td><a name="l645" href="#l645">645</a><td> // Convert to string explicitly, to short circuit the null and array<tr><td><a name="l646" href="#l646">646</a><td> // logic in this function -- this ensures that null and undefined get<tr><td><a name="l647" href="#l647">647</a><td> // written as literal 'null' and 'undefined', and arrays don't get<tr><td><a name="l648" href="#l648">648</a><td> // expanded out but instead encoded in the default way.<tr><td><a name="l649" href="#l649">649</a><td> goog.uri.utils.appendKeyValuePairs_(key, String(value[j]), pairs);<tr><td><a name="l650" href="#l650">650</a><td> }<tr><td><a name="l651" href="#l651">651</a><td> } else if (value != null) {<tr><td><a name="l652" href="#l652">652</a><td> // Skip a top-level null or undefined entirely.<tr><td><a name="l653" href="#l653">653</a><td> pairs.push('&', key,<tr><td><a name="l654" href="#l654">654</a><td> // Check for empty string. Zero gets encoded into the url as literal<tr><td><a name="l655" href="#l655">655</a><td> // strings. For empty string, skip the equal sign, to be consistent<tr><td><a name="l656" href="#l656">656</a><td> // with UriBuilder.java.<tr><td><a name="l657" href="#l657">657</a><td> value === '' ? '' : '=',<tr><td><a name="l658" href="#l658">658</a><td> goog.string.urlEncode(value));<tr><td><a name="l659" href="#l659">659</a><td> }<tr><td><a name="l660" href="#l660">660</a><td>};<tr><td><a name="l661" href="#l661">661</a><td><tr><td><a name="l662" href="#l662">662</a><td><tr><td><a name="l663" href="#l663">663</a><td>/**<tr><td><a name="l664" href="#l664">664</a><td> * Builds a buffer of query data from a sequence of alternating keys and values.<tr><td><a name="l665" href="#l665">665</a><td> *<tr><td><a name="l666" href="#l666">666</a><td> * @param {!Array.<string|undefined>} buffer A string buffer to append to. The<tr><td><a name="l667" href="#l667">667</a><td> * first element appended will be an '&', and may be replaced by the caller.<tr><td><a name="l668" href="#l668">668</a><td> * @param {goog.uri.utils.QueryArray|Arguments} keysAndValues An array with<tr><td><a name="l669" href="#l669">669</a><td> * alternating keys and values -- see the typedef.<tr><td><a name="l670" href="#l670">670</a><td> * @param {number=} opt_startIndex A start offset into the arary, defaults to 0.<tr><td><a name="l671" href="#l671">671</a><td> * @return {!Array.<string|undefined>} The buffer argument.<tr><td><a name="l672" href="#l672">672</a><td> * @private<tr><td><a name="l673" href="#l673">673</a><td> */<tr><td><a name="l674" href="#l674">674</a><td>goog.uri.utils.buildQueryDataBuffer_ = function(<tr><td><a name="l675" href="#l675">675</a><td> buffer, keysAndValues, opt_startIndex) {<tr><td><a name="l676" href="#l676">676</a><td> goog.asserts.assert(Math.max(keysAndValues.length - (opt_startIndex || 0),<tr><td><a name="l677" href="#l677">677</a><td> 0) % 2 == 0, 'goog.uri.utils: Key/value lists must be even in length.');<tr><td><a name="l678" href="#l678">678</a><td><tr><td><a name="l679" href="#l679">679</a><td> for (var i = opt_startIndex || 0; i < keysAndValues.length; i += 2) {<tr><td><a name="l680" href="#l680">680</a><td> goog.uri.utils.appendKeyValuePairs_(<tr><td><a name="l681" href="#l681">681</a><td> keysAndValues[i], keysAndValues[i + 1], buffer);<tr><td><a name="l682" href="#l682">682</a><td> }<tr><td><a name="l683" href="#l683">683</a><td><tr><td><a name="l684" href="#l684">684</a><td> return buffer;<tr><td><a name="l685" href="#l685">685</a><td>};<tr><td><a name="l686" href="#l686">686</a><td><tr><td><a name="l687" href="#l687">687</a><td><tr><td><a name="l688" href="#l688">688</a><td>/**<tr><td><a name="l689" href="#l689">689</a><td> * Builds a query data string from a sequence of alternating keys and values.<tr><td><a name="l690" href="#l690">690</a><td> * Currently generates "&key&" for empty args.<tr><td><a name="l691" href="#l691">691</a><td> *<tr><td><a name="l692" href="#l692">692</a><td> * @param {goog.uri.utils.QueryArray} keysAndValues Alternating keys and<tr><td><a name="l693" href="#l693">693</a><td> * values. See the typedef.<tr><td><a name="l694" href="#l694">694</a><td> * @param {number=} opt_startIndex A start offset into the arary, defaults to 0.<tr><td><a name="l695" href="#l695">695</a><td> * @return {string} The encoded query string, in the form 'a=1&b=2'.<tr><td><a name="l696" href="#l696">696</a><td> */<tr><td><a name="l697" href="#l697">697</a><td>goog.uri.utils.buildQueryData = function(keysAndValues, opt_startIndex) {<tr><td><a name="l698" href="#l698">698</a><td> var buffer = goog.uri.utils.buildQueryDataBuffer_(<tr><td><a name="l699" href="#l699">699</a><td> [], keysAndValues, opt_startIndex);<tr><td><a name="l700" href="#l700">700</a><td> buffer[0] = ''; // Remove the leading ampersand.<tr><td><a name="l701" href="#l701">701</a><td> return buffer.join('');<tr><td><a name="l702" href="#l702">702</a><td>};<tr><td><a name="l703" href="#l703">703</a><td><tr><td><a name="l704" href="#l704">704</a><td><tr><td><a name="l705" href="#l705">705</a><td>/**<tr><td><a name="l706" href="#l706">706</a><td> * Builds a buffer of query data from a map.<tr><td><a name="l707" href="#l707">707</a><td> *<tr><td><a name="l708" href="#l708">708</a><td> * @param {!Array.<string|undefined>} buffer A string buffer to append to. The<tr><td><a name="l709" href="#l709">709</a><td> * first element appended will be an '&', and may be replaced by the caller.<tr><td><a name="l710" href="#l710">710</a><td> * @param {Object.<goog.uri.utils.QueryValue>} map An object where keys are<tr><td><a name="l711" href="#l711">711</a><td> * URI-encoded parameter keys, and the values conform to the contract<tr><td><a name="l712" href="#l712">712</a><td> * specified in the goog.uri.utils.QueryValue typedef.<tr><td><a name="l713" href="#l713">713</a><td> * @return {!Array.<string|undefined>} The buffer argument.<tr><td><a name="l714" href="#l714">714</a><td> * @private<tr><td><a name="l715" href="#l715">715</a><td> */<tr><td><a name="l716" href="#l716">716</a><td>goog.uri.utils.buildQueryDataBufferFromMap_ = function(buffer, map) {<tr><td><a name="l717" href="#l717">717</a><td> for (var key in map) {<tr><td><a name="l718" href="#l718">718</a><td> goog.uri.utils.appendKeyValuePairs_(key, map[key], buffer);<tr><td><a name="l719" href="#l719">719</a><td> }<tr><td><a name="l720" href="#l720">720</a><td><tr><td><a name="l721" href="#l721">721</a><td> return buffer;<tr><td><a name="l722" href="#l722">722</a><td>};<tr><td><a name="l723" href="#l723">723</a><td><tr><td><a name="l724" href="#l724">724</a><td><tr><td><a name="l725" href="#l725">725</a><td>/**<tr><td><a name="l726" href="#l726">726</a><td> * Builds a query data string from a map.<tr><td><a name="l727" href="#l727">727</a><td> * Currently generates "&key&" for empty args.<tr><td><a name="l728" href="#l728">728</a><td> *<tr><td><a name="l729" href="#l729">729</a><td> * @param {Object} map An object where keys are URI-encoded parameter keys,<tr><td><a name="l730" href="#l730">730</a><td> * and the values are arbitrary types or arrays. Keys with a null value<tr><td><a name="l731" href="#l731">731</a><td> * are dropped.<tr><td><a name="l732" href="#l732">732</a><td> * @return {string} The encoded query string, in the form 'a=1&b=2'.<tr><td><a name="l733" href="#l733">733</a><td> */<tr><td><a name="l734" href="#l734">734</a><td>goog.uri.utils.buildQueryDataFromMap = function(map) {<tr><td><a name="l735" href="#l735">735</a><td> var buffer = goog.uri.utils.buildQueryDataBufferFromMap_([], map);<tr><td><a name="l736" href="#l736">736</a><td> buffer[0] = '';<tr><td><a name="l737" href="#l737">737</a><td> return buffer.join('');<tr><td><a name="l738" href="#l738">738</a><td>};<tr><td><a name="l739" href="#l739">739</a><td><tr><td><a name="l740" href="#l740">740</a><td><tr><td><a name="l741" href="#l741">741</a><td>/**<tr><td><a name="l742" href="#l742">742</a><td> * Appends URI parameters to an existing URI.<tr><td><a name="l743" href="#l743">743</a><td> *<tr><td><a name="l744" href="#l744">744</a><td> * The variable arguments may contain alternating keys and values. Keys are<tr><td><a name="l745" href="#l745">745</a><td> * assumed to be already URI encoded. The values should not be URI-encoded,<tr><td><a name="l746" href="#l746">746</a><td> * and will instead be encoded by this function.<tr><td><a name="l747" href="#l747">747</a><td> * <pre><tr><td><a name="l748" href="#l748">748</a><td> * appendParams('http://www.foo.com?existing=true',<tr><td><a name="l749" href="#l749">749</a><td> * 'key1', 'value1',<tr><td><a name="l750" href="#l750">750</a><td> * 'key2', 'value?willBeEncoded',<tr><td><a name="l751" href="#l751">751</a><td> * 'key3', ['valueA', 'valueB', 'valueC'],<tr><td><a name="l752" href="#l752">752</a><td> * 'key4', null);<tr><td><a name="l753" href="#l753">753</a><td> * result: 'http://www.foo.com?existing=true&' +<tr><td><a name="l754" href="#l754">754</a><td> * 'key1=value1&' +<tr><td><a name="l755" href="#l755">755</a><td> * 'key2=value%3FwillBeEncoded&' +<tr><td><a name="l756" href="#l756">756</a><td> * 'key3=valueA&key3=valueB&key3=valueC'<tr><td><a name="l757" href="#l757">757</a><td> * </pre><tr><td><a name="l758" href="#l758">758</a><td> *<tr><td><a name="l759" href="#l759">759</a><td> * A single call to this function will not exhibit quadratic behavior in IE,<tr><td><a name="l760" href="#l760">760</a><td> * whereas multiple repeated calls may, although the effect is limited by<tr><td><a name="l761" href="#l761">761</a><td> * fact that URL's generally can't exceed 2kb.<tr><td><a name="l762" href="#l762">762</a><td> *<tr><td><a name="l763" href="#l763">763</a><td> * @param {string} uri The original URI, which may already have query data.<tr><td><a name="l764" href="#l764">764</a><td> * @param {...(goog.uri.utils.QueryArray|string|goog.uri.utils.QueryValue)} var_args<tr><td><a name="l765" href="#l765">765</a><td> * An array or argument list conforming to goog.uri.utils.QueryArray.<tr><td><a name="l766" href="#l766">766</a><td> * @return {string} The URI with all query parameters added.<tr><td><a name="l767" href="#l767">767</a><td> */<tr><td><a name="l768" href="#l768">768</a><td>goog.uri.utils.appendParams = function(uri, var_args) {<tr><td><a name="l769" href="#l769">769</a><td> return goog.uri.utils.appendQueryData_(<tr><td><a name="l770" href="#l770">770</a><td> arguments.length == 2 ?<tr><td><a name="l771" href="#l771">771</a><td> goog.uri.utils.buildQueryDataBuffer_([uri], arguments[1], 0) :<tr><td><a name="l772" href="#l772">772</a><td> goog.uri.utils.buildQueryDataBuffer_([uri], arguments, 1));<tr><td><a name="l773" href="#l773">773</a><td>};<tr><td><a name="l774" href="#l774">774</a><td><tr><td><a name="l775" href="#l775">775</a><td><tr><td><a name="l776" href="#l776">776</a><td>/**<tr><td><a name="l777" href="#l777">777</a><td> * Appends query parameters from a map.<tr><td><a name="l778" href="#l778">778</a><td> *<tr><td><a name="l779" href="#l779">779</a><td> * @param {string} uri The original URI, which may already have query data.<tr><td><a name="l780" href="#l780">780</a><td> * @param {Object} map An object where keys are URI-encoded parameter keys,<tr><td><a name="l781" href="#l781">781</a><td> * and the values are arbitrary types or arrays. Keys with a null value<tr><td><a name="l782" href="#l782">782</a><td> * are dropped.<tr><td><a name="l783" href="#l783">783</a><td> * @return {string} The new parameters.<tr><td><a name="l784" href="#l784">784</a><td> */<tr><td><a name="l785" href="#l785">785</a><td>goog.uri.utils.appendParamsFromMap = function(uri, map) {<tr><td><a name="l786" href="#l786">786</a><td> return goog.uri.utils.appendQueryData_(<tr><td><a name="l787" href="#l787">787</a><td> goog.uri.utils.buildQueryDataBufferFromMap_([uri], map));<tr><td><a name="l788" href="#l788">788</a><td>};<tr><td><a name="l789" href="#l789">789</a><td><tr><td><a name="l790" href="#l790">790</a><td><tr><td><a name="l791" href="#l791">791</a><td>/**<tr><td><a name="l792" href="#l792">792</a><td> * Appends a single URI parameter.<tr><td><a name="l793" href="#l793">793</a><td> *<tr><td><a name="l794" href="#l794">794</a><td> * Repeated calls to this can exhibit quadratic behavior in IE6 due to the<tr><td><a name="l795" href="#l795">795</a><td> * way string append works, though it should be limited given the 2kb limit.<tr><td><a name="l796" href="#l796">796</a><td> *<tr><td><a name="l797" href="#l797">797</a><td> * @param {string} uri The original URI, which may already have query data.<tr><td><a name="l798" href="#l798">798</a><td> * @param {string} key The key, which must already be URI encoded.<tr><td><a name="l799" href="#l799">799</a><td> * @param {*=} opt_value The value, which will be stringized and encoded<tr><td><a name="l800" href="#l800">800</a><td> * (assumed not already to be encoded). If omitted, undefined, or null, the<tr><td><a name="l801" href="#l801">801</a><td> * key will be added as a valueless parameter.<tr><td><a name="l802" href="#l802">802</a><td> * @return {string} The URI with the query parameter added.<tr><td><a name="l803" href="#l803">803</a><td> */<tr><td><a name="l804" href="#l804">804</a><td>goog.uri.utils.appendParam = function(uri, key, opt_value) {<tr><td><a name="l805" href="#l805">805</a><td> var paramArr = [uri, '&', key];<tr><td><a name="l806" href="#l806">806</a><td> if (goog.isDefAndNotNull(opt_value)) {<tr><td><a name="l807" href="#l807">807</a><td> paramArr.push('=', goog.string.urlEncode(opt_value));<tr><td><a name="l808" href="#l808">808</a><td> }<tr><td><a name="l809" href="#l809">809</a><td> return goog.uri.utils.appendQueryData_(paramArr);<tr><td><a name="l810" href="#l810">810</a><td>};<tr><td><a name="l811" href="#l811">811</a><td><tr><td><a name="l812" href="#l812">812</a><td><tr><td><a name="l813" href="#l813">813</a><td>/**<tr><td><a name="l814" href="#l814">814</a><td> * Finds the next instance of a query parameter with the specified name.<tr><td><a name="l815" href="#l815">815</a><td> *<tr><td><a name="l816" href="#l816">816</a><td> * Does not instantiate any objects.<tr><td><a name="l817" href="#l817">817</a><td> *<tr><td><a name="l818" href="#l818">818</a><td> * @param {string} uri The URI to search. May contain a fragment identifier<tr><td><a name="l819" href="#l819">819</a><td> * if opt_hashIndex is specified.<tr><td><a name="l820" href="#l820">820</a><td> * @param {number} startIndex The index to begin searching for the key at. A<tr><td><a name="l821" href="#l821">821</a><td> * match may be found even if this is one character after the ampersand.<tr><td><a name="l822" href="#l822">822</a><td> * @param {string} keyEncoded The URI-encoded key.<tr><td><a name="l823" href="#l823">823</a><td> * @param {number} hashOrEndIndex Index to stop looking at. If a hash<tr><td><a name="l824" href="#l824">824</a><td> * mark is present, it should be its index, otherwise it should be the<tr><td><a name="l825" href="#l825">825</a><td> * length of the string.<tr><td><a name="l826" href="#l826">826</a><td> * @return {number} The position of the first character in the key's name,<tr><td><a name="l827" href="#l827">827</a><td> * immediately after either a question mark or a dot.<tr><td><a name="l828" href="#l828">828</a><td> * @private<tr><td><a name="l829" href="#l829">829</a><td> */<tr><td><a name="l830" href="#l830">830</a><td>goog.uri.utils.findParam_ = function(<tr><td><a name="l831" href="#l831">831</a><td> uri, startIndex, keyEncoded, hashOrEndIndex) {<tr><td><a name="l832" href="#l832">832</a><td> var index = startIndex;<tr><td><a name="l833" href="#l833">833</a><td> var keyLength = keyEncoded.length;<tr><td><a name="l834" href="#l834">834</a><td><tr><td><a name="l835" href="#l835">835</a><td> // Search for the key itself and post-filter for surronuding punctuation,<tr><td><a name="l836" href="#l836">836</a><td> // rather than expensively building a regexp.<tr><td><a name="l837" href="#l837">837</a><td> while ((index = uri.indexOf(keyEncoded, index)) >= 0 &&<tr><td><a name="l838" href="#l838">838</a><td> index < hashOrEndIndex) {<tr><td><a name="l839" href="#l839">839</a><td> var precedingChar = uri.charCodeAt(index - 1);<tr><td><a name="l840" href="#l840">840</a><td> // Ensure that the preceding character is '&' or '?'.<tr><td><a name="l841" href="#l841">841</a><td> if (precedingChar == goog.uri.utils.CharCode_.AMPERSAND ||<tr><td><a name="l842" href="#l842">842</a><td> precedingChar == goog.uri.utils.CharCode_.QUESTION) {<tr><td><a name="l843" href="#l843">843</a><td> // Ensure the following character is '&', '=', '#', or NaN<tr><td><a name="l844" href="#l844">844</a><td> // (end of string).<tr><td><a name="l845" href="#l845">845</a><td> var followingChar = uri.charCodeAt(index + keyLength);<tr><td><a name="l846" href="#l846">846</a><td> if (!followingChar ||<tr><td><a name="l847" href="#l847">847</a><td> followingChar == goog.uri.utils.CharCode_.EQUAL ||<tr><td><a name="l848" href="#l848">848</a><td> followingChar == goog.uri.utils.CharCode_.AMPERSAND ||<tr><td><a name="l849" href="#l849">849</a><td> followingChar == goog.uri.utils.CharCode_.HASH) {<tr><td><a name="l850" href="#l850">850</a><td> return index;<tr><td><a name="l851" href="#l851">851</a><td> }<tr><td><a name="l852" href="#l852">852</a><td> }<tr><td><a name="l853" href="#l853">853</a><td> index += keyLength + 1;<tr><td><a name="l854" href="#l854">854</a><td> }<tr><td><a name="l855" href="#l855">855</a><td><tr><td><a name="l856" href="#l856">856</a><td> return -1;<tr><td><a name="l857" href="#l857">857</a><td>};<tr><td><a name="l858" href="#l858">858</a><td><tr><td><a name="l859" href="#l859">859</a><td><tr><td><a name="l860" href="#l860">860</a><td>/**<tr><td><a name="l861" href="#l861">861</a><td> * Regular expression for finding a hash mark or end of string.<tr><td><a name="l862" href="#l862">862</a><td> * @type {RegExp}<tr><td><a name="l863" href="#l863">863</a><td> * @private<tr><td><a name="l864" href="#l864">864</a><td> */<tr><td><a name="l865" href="#l865">865</a><td>goog.uri.utils.hashOrEndRe_ = /#|$/;<tr><td><a name="l866" href="#l866">866</a><td><tr><td><a name="l867" href="#l867">867</a><td><tr><td><a name="l868" href="#l868">868</a><td>/**<tr><td><a name="l869" href="#l869">869</a><td> * Determines if the URI contains a specific key.<tr><td><a name="l870" href="#l870">870</a><td> *<tr><td><a name="l871" href="#l871">871</a><td> * Performs no object instantiations.<tr><td><a name="l872" href="#l872">872</a><td> *<tr><td><a name="l873" href="#l873">873</a><td> * @param {string} uri The URI to process. May contain a fragment<tr><td><a name="l874" href="#l874">874</a><td> * identifier.<tr><td><a name="l875" href="#l875">875</a><td> * @param {string} keyEncoded The URI-encoded key. Case-sensitive.<tr><td><a name="l876" href="#l876">876</a><td> * @return {boolean} Whether the key is present.<tr><td><a name="l877" href="#l877">877</a><td> */<tr><td><a name="l878" href="#l878">878</a><td>goog.uri.utils.hasParam = function(uri, keyEncoded) {<tr><td><a name="l879" href="#l879">879</a><td> return goog.uri.utils.findParam_(uri, 0, keyEncoded,<tr><td><a name="l880" href="#l880">880</a><td> uri.search(goog.uri.utils.hashOrEndRe_)) >= 0;<tr><td><a name="l881" href="#l881">881</a><td>};<tr><td><a name="l882" href="#l882">882</a><td><tr><td><a name="l883" href="#l883">883</a><td><tr><td><a name="l884" href="#l884">884</a><td>/**<tr><td><a name="l885" href="#l885">885</a><td> * Gets the first value of a query parameter.<tr><td><a name="l886" href="#l886">886</a><td> * @param {string} uri The URI to process. May contain a fragment.<tr><td><a name="l887" href="#l887">887</a><td> * @param {string} keyEncoded The URI-encoded key. Case-sensitive.<tr><td><a name="l888" href="#l888">888</a><td> * @return {?string} The first value of the parameter (URI-decoded), or null<tr><td><a name="l889" href="#l889">889</a><td> * if the parameter is not found.<tr><td><a name="l890" href="#l890">890</a><td> */<tr><td><a name="l891" href="#l891">891</a><td>goog.uri.utils.getParamValue = function(uri, keyEncoded) {<tr><td><a name="l892" href="#l892">892</a><td> var hashOrEndIndex = uri.search(goog.uri.utils.hashOrEndRe_);<tr><td><a name="l893" href="#l893">893</a><td> var foundIndex = goog.uri.utils.findParam_(<tr><td><a name="l894" href="#l894">894</a><td> uri, 0, keyEncoded, hashOrEndIndex);<tr><td><a name="l895" href="#l895">895</a><td><tr><td><a name="l896" href="#l896">896</a><td> if (foundIndex < 0) {<tr><td><a name="l897" href="#l897">897</a><td> return null;<tr><td><a name="l898" href="#l898">898</a><td> } else {<tr><td><a name="l899" href="#l899">899</a><td> var endPosition = uri.indexOf('&', foundIndex);<tr><td><a name="l900" href="#l900">900</a><td> if (endPosition < 0 || endPosition > hashOrEndIndex) {<tr><td><a name="l901" href="#l901">901</a><td> endPosition = hashOrEndIndex;<tr><td><a name="l902" href="#l902">902</a><td> }<tr><td><a name="l903" href="#l903">903</a><td> // Progress forth to the end of the "key=" or "key&" substring.<tr><td><a name="l904" href="#l904">904</a><td> foundIndex += keyEncoded.length + 1;<tr><td><a name="l905" href="#l905">905</a><td> // Use substr, because it (unlike substring) will return empty string<tr><td><a name="l906" href="#l906">906</a><td> // if foundIndex > endPosition.<tr><td><a name="l907" href="#l907">907</a><td> return goog.string.urlDecode(<tr><td><a name="l908" href="#l908">908</a><td> uri.substr(foundIndex, endPosition - foundIndex));<tr><td><a name="l909" href="#l909">909</a><td> }<tr><td><a name="l910" href="#l910">910</a><td>};<tr><td><a name="l911" href="#l911">911</a><td><tr><td><a name="l912" href="#l912">912</a><td><tr><td><a name="l913" href="#l913">913</a><td>/**<tr><td><a name="l914" href="#l914">914</a><td> * Gets all values of a query parameter.<tr><td><a name="l915" href="#l915">915</a><td> * @param {string} uri The URI to process. May contain a framgnet.<tr><td><a name="l916" href="#l916">916</a><td> * @param {string} keyEncoded The URI-encoded key. Case-snsitive.<tr><td><a name="l917" href="#l917">917</a><td> * @return {!Array.<string>} All URI-decoded values with the given key.<tr><td><a name="l918" href="#l918">918</a><td> * If the key is not found, this will have length 0, but never be null.<tr><td><a name="l919" href="#l919">919</a><td> */<tr><td><a name="l920" href="#l920">920</a><td>goog.uri.utils.getParamValues = function(uri, keyEncoded) {<tr><td><a name="l921" href="#l921">921</a><td> var hashOrEndIndex = uri.search(goog.uri.utils.hashOrEndRe_);<tr><td><a name="l922" href="#l922">922</a><td> var position = 0;<tr><td><a name="l923" href="#l923">923</a><td> var foundIndex;<tr><td><a name="l924" href="#l924">924</a><td> var result = [];<tr><td><a name="l925" href="#l925">925</a><td><tr><td><a name="l926" href="#l926">926</a><td> while ((foundIndex = goog.uri.utils.findParam_(<tr><td><a name="l927" href="#l927">927</a><td> uri, position, keyEncoded, hashOrEndIndex)) >= 0) {<tr><td><a name="l928" href="#l928">928</a><td> // Find where this parameter ends, either the '&' or the end of the<tr><td><a name="l929" href="#l929">929</a><td> // query parameters.<tr><td><a name="l930" href="#l930">930</a><td> position = uri.indexOf('&', foundIndex);<tr><td><a name="l931" href="#l931">931</a><td> if (position < 0 || position > hashOrEndIndex) {<tr><td><a name="l932" href="#l932">932</a><td> position = hashOrEndIndex;<tr><td><a name="l933" href="#l933">933</a><td> }<tr><td><a name="l934" href="#l934">934</a><td><tr><td><a name="l935" href="#l935">935</a><td> // Progress forth to the end of the "key=" or "key&" substring.<tr><td><a name="l936" href="#l936">936</a><td> foundIndex += keyEncoded.length + 1;<tr><td><a name="l937" href="#l937">937</a><td> // Use substr, because it (unlike substring) will return empty string<tr><td><a name="l938" href="#l938">938</a><td> // if foundIndex > position.<tr><td><a name="l939" href="#l939">939</a><td> result.push(goog.string.urlDecode(uri.substr(<tr><td><a name="l940" href="#l940">940</a><td> foundIndex, position - foundIndex)));<tr><td><a name="l941" href="#l941">941</a><td> }<tr><td><a name="l942" href="#l942">942</a><td><tr><td><a name="l943" href="#l943">943</a><td> return result;<tr><td><a name="l944" href="#l944">944</a><td>};<tr><td><a name="l945" href="#l945">945</a><td><tr><td><a name="l946" href="#l946">946</a><td><tr><td><a name="l947" href="#l947">947</a><td>/**<tr><td><a name="l948" href="#l948">948</a><td> * Regexp to find trailing question marks and ampersands.<tr><td><a name="l949" href="#l949">949</a><td> * @type {RegExp}<tr><td><a name="l950" href="#l950">950</a><td> * @private<tr><td><a name="l951" href="#l951">951</a><td> */<tr><td><a name="l952" href="#l952">952</a><td>goog.uri.utils.trailingQueryPunctuationRe_ = /[?&]($|#)/;<tr><td><a name="l953" href="#l953">953</a><td><tr><td><a name="l954" href="#l954">954</a><td><tr><td><a name="l955" href="#l955">955</a><td>/**<tr><td><a name="l956" href="#l956">956</a><td> * Removes all instances of a query parameter.<tr><td><a name="l957" href="#l957">957</a><td> * @param {string} uri The URI to process. Must not contain a fragment.<tr><td><a name="l958" href="#l958">958</a><td> * @param {string} keyEncoded The URI-encoded key.<tr><td><a name="l959" href="#l959">959</a><td> * @return {string} The URI with all instances of the parameter removed.<tr><td><a name="l960" href="#l960">960</a><td> */<tr><td><a name="l961" href="#l961">961</a><td>goog.uri.utils.removeParam = function(uri, keyEncoded) {<tr><td><a name="l962" href="#l962">962</a><td> var hashOrEndIndex = uri.search(goog.uri.utils.hashOrEndRe_);<tr><td><a name="l963" href="#l963">963</a><td> var position = 0;<tr><td><a name="l964" href="#l964">964</a><td> var foundIndex;<tr><td><a name="l965" href="#l965">965</a><td> var buffer = [];<tr><td><a name="l966" href="#l966">966</a><td><tr><td><a name="l967" href="#l967">967</a><td> // Look for a query parameter.<tr><td><a name="l968" href="#l968">968</a><td> while ((foundIndex = goog.uri.utils.findParam_(<tr><td><a name="l969" href="#l969">969</a><td> uri, position, keyEncoded, hashOrEndIndex)) >= 0) {<tr><td><a name="l970" href="#l970">970</a><td> // Get the portion of the query string up to, but not including, the ?<tr><td><a name="l971" href="#l971">971</a><td> // or & starting the parameter.<tr><td><a name="l972" href="#l972">972</a><td> buffer.push(uri.substring(position, foundIndex));<tr><td><a name="l973" href="#l973">973</a><td> // Progress to immediately after the '&'. If not found, go to the end.<tr><td><a name="l974" href="#l974">974</a><td> // Avoid including the hash mark.<tr><td><a name="l975" href="#l975">975</a><td> position = Math.min((uri.indexOf('&', foundIndex) + 1) || hashOrEndIndex,<tr><td><a name="l976" href="#l976">976</a><td> hashOrEndIndex);<tr><td><a name="l977" href="#l977">977</a><td> }<tr><td><a name="l978" href="#l978">978</a><td><tr><td><a name="l979" href="#l979">979</a><td> // Append everything that is remaining.<tr><td><a name="l980" href="#l980">980</a><td> buffer.push(uri.substr(position));<tr><td><a name="l981" href="#l981">981</a><td><tr><td><a name="l982" href="#l982">982</a><td> // Join the buffer, and remove trailing punctuation that remains.<tr><td><a name="l983" href="#l983">983</a><td> return buffer.join('').replace(<tr><td><a name="l984" href="#l984">984</a><td> goog.uri.utils.trailingQueryPunctuationRe_, '$1');<tr><td><a name="l985" href="#l985">985</a><td>};<tr><td><a name="l986" href="#l986">986</a><td><tr><td><a name="l987" href="#l987">987</a><td><tr><td><a name="l988" href="#l988">988</a><td>/**<tr><td><a name="l989" href="#l989">989</a><td> * Replaces all existing definitions of a parameter with a single definition.<tr><td><a name="l990" href="#l990">990</a><td> *<tr><td><a name="l991" href="#l991">991</a><td> * Repeated calls to this can exhibit quadratic behavior due to the need to<tr><td><a name="l992" href="#l992">992</a><td> * find existing instances and reconstruct the string, though it should be<tr><td><a name="l993" href="#l993">993</a><td> * limited given the 2kb limit. Consider using appendParams to append multiple<tr><td><a name="l994" href="#l994">994</a><td> * parameters in bulk.<tr><td><a name="l995" href="#l995">995</a><td> *<tr><td><a name="l996" href="#l996">996</a><td> * @param {string} uri The original URI, which may already have query data.<tr><td><a name="l997" href="#l997">997</a><td> * @param {string} keyEncoded The key, which must already be URI encoded.<tr><td><a name="l998" href="#l998">998</a><td> * @param {*} value The value, which will be stringized and encoded (assumed<tr><td><a name="l999" href="#l999">999</a><td> * not already to be encoded).<tr><td><a name="l1000" href="#l1000">1000</a><td> * @return {string} The URI with the query parameter added.<tr><td><a name="l1001" href="#l1001">1001</a><td> */<tr><td><a name="l1002" href="#l1002">1002</a><td>goog.uri.utils.setParam = function(uri, keyEncoded, value) {<tr><td><a name="l1003" href="#l1003">1003</a><td> return goog.uri.utils.appendParam(<tr><td><a name="l1004" href="#l1004">1004</a><td> goog.uri.utils.removeParam(uri, keyEncoded), keyEncoded, value);<tr><td><a name="l1005" href="#l1005">1005</a><td>};<tr><td><a name="l1006" href="#l1006">1006</a><td><tr><td><a name="l1007" href="#l1007">1007</a><td><tr><td><a name="l1008" href="#l1008">1008</a><td>/**<tr><td><a name="l1009" href="#l1009">1009</a><td> * Generates a URI path using a given URI and a path with checks to<tr><td><a name="l1010" href="#l1010">1010</a><td> * prevent consecutive "//". The baseUri passed in must not contain<tr><td><a name="l1011" href="#l1011">1011</a><td> * query or fragment identifiers. The path to append may not contain query or<tr><td><a name="l1012" href="#l1012">1012</a><td> * fragment identifiers.<tr><td><a name="l1013" href="#l1013">1013</a><td> *<tr><td><a name="l1014" href="#l1014">1014</a><td> * @param {string} baseUri URI to use as the base.<tr><td><a name="l1015" href="#l1015">1015</a><td> * @param {string} path Path to append.<tr><td><a name="l1016" href="#l1016">1016</a><td> * @return {string} Updated URI.<tr><td><a name="l1017" href="#l1017">1017</a><td> */<tr><td><a name="l1018" href="#l1018">1018</a><td>goog.uri.utils.appendPath = function(baseUri, path) {<tr><td><a name="l1019" href="#l1019">1019</a><td> goog.uri.utils.assertNoFragmentsOrQueries_(baseUri);<tr><td><a name="l1020" href="#l1020">1020</a><td><tr><td><a name="l1021" href="#l1021">1021</a><td> // Remove any trailing '/'<tr><td><a name="l1022" href="#l1022">1022</a><td> if (goog.string.endsWith(baseUri, '/')) {<tr><td><a name="l1023" href="#l1023">1023</a><td> baseUri = baseUri.substr(0, baseUri.length - 1);<tr><td><a name="l1024" href="#l1024">1024</a><td> }<tr><td><a name="l1025" href="#l1025">1025</a><td> // Remove any leading '/'<tr><td><a name="l1026" href="#l1026">1026</a><td> if (goog.string.startsWith(path, '/')) {<tr><td><a name="l1027" href="#l1027">1027</a><td> path = path.substr(1);<tr><td><a name="l1028" href="#l1028">1028</a><td> }<tr><td><a name="l1029" href="#l1029">1029</a><td> return goog.string.buildString(baseUri, '/', path);<tr><td><a name="l1030" href="#l1030">1030</a><td>};<tr><td><a name="l1031" href="#l1031">1031</a><td><tr><td><a name="l1032" href="#l1032">1032</a><td><tr><td><a name="l1033" href="#l1033">1033</a><td>/**<tr><td><a name="l1034" href="#l1034">1034</a><td> * Replaces the path.<tr><td><a name="l1035" href="#l1035">1035</a><td> * @param {string} uri URI to use as the base.<tr><td><a name="l1036" href="#l1036">1036</a><td> * @param {string} path New path.<tr><td><a name="l1037" href="#l1037">1037</a><td> * @return {string} Updated URI.<tr><td><a name="l1038" href="#l1038">1038</a><td> */<tr><td><a name="l1039" href="#l1039">1039</a><td>goog.uri.utils.setPath = function(uri, path) {<tr><td><a name="l1040" href="#l1040">1040</a><td> // Add any missing '/'.<tr><td><a name="l1041" href="#l1041">1041</a><td> if (!goog.string.startsWith(path, '/')) {<tr><td><a name="l1042" href="#l1042">1042</a><td> path = '/' + path;<tr><td><a name="l1043" href="#l1043">1043</a><td> }<tr><td><a name="l1044" href="#l1044">1044</a><td> var parts = goog.uri.utils.split(uri);<tr><td><a name="l1045" href="#l1045">1045</a><td> return goog.uri.utils.buildFromEncodedParts(<tr><td><a name="l1046" href="#l1046">1046</a><td> parts[goog.uri.utils.ComponentIndex.SCHEME],<tr><td><a name="l1047" href="#l1047">1047</a><td> parts[goog.uri.utils.ComponentIndex.USER_INFO],<tr><td><a name="l1048" href="#l1048">1048</a><td> parts[goog.uri.utils.ComponentIndex.DOMAIN],<tr><td><a name="l1049" href="#l1049">1049</a><td> parts[goog.uri.utils.ComponentIndex.PORT],<tr><td><a name="l1050" href="#l1050">1050</a><td> path,<tr><td><a name="l1051" href="#l1051">1051</a><td> parts[goog.uri.utils.ComponentIndex.QUERY_DATA],<tr><td><a name="l1052" href="#l1052">1052</a><td> parts[goog.uri.utils.ComponentIndex.FRAGMENT]);<tr><td><a name="l1053" href="#l1053">1053</a><td>};<tr><td><a name="l1054" href="#l1054">1054</a><td><tr><td><a name="l1055" href="#l1055">1055</a><td><tr><td><a name="l1056" href="#l1056">1056</a><td>/**<tr><td><a name="l1057" href="#l1057">1057</a><td> * Standard supported query parameters.<tr><td><a name="l1058" href="#l1058">1058</a><td> * @enum {string}<tr><td><a name="l1059" href="#l1059">1059</a><td> */<tr><td><a name="l1060" href="#l1060">1060</a><td>goog.uri.utils.StandardQueryParam = {<tr><td><a name="l1061" href="#l1061">1061</a><td><tr><td><a name="l1062" href="#l1062">1062</a><td> /** Unused parameter for unique-ifying. */<tr><td><a name="l1063" href="#l1063">1063</a><td> RANDOM: 'zx'<tr><td><a name="l1064" href="#l1064">1064</a><td>};<tr><td><a name="l1065" href="#l1065">1065</a><td><tr><td><a name="l1066" href="#l1066">1066</a><td><tr><td><a name="l1067" href="#l1067">1067</a><td>/**<tr><td><a name="l1068" href="#l1068">1068</a><td> * Sets the zx parameter of a URI to a random value.<tr><td><a name="l1069" href="#l1069">1069</a><td> * @param {string} uri Any URI.<tr><td><a name="l1070" href="#l1070">1070</a><td> * @return {string} That URI with the "zx" parameter added or replaced to<tr><td><a name="l1071" href="#l1071">1071</a><td> * contain a random string.<tr><td><a name="l1072" href="#l1072">1072</a><td> */<tr><td><a name="l1073" href="#l1073">1073</a><td>goog.uri.utils.makeUnique = function(uri) {<tr><td><a name="l1074" href="#l1074">1074</a><td> return goog.uri.utils.setParam(uri,<tr><td><a name="l1075" href="#l1075">1075</a><td> goog.uri.utils.StandardQueryParam.RANDOM, goog.string.getRandomString());<tr><td><a name="l1076" href="#l1076">1076</a><td>};</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> |