Added: dev/commons/fileupload/2.0.0-M1-RC1/site/xref/org/apache/commons/fileupload2/core/ParameterParser.html ============================================================================== --- dev/commons/fileupload/2.0.0-M1-RC1/site/xref/org/apache/commons/fileupload2/core/ParameterParser.html (added) +++ dev/commons/fileupload/2.0.0-M1-RC1/site/xref/org/apache/commons/fileupload2/core/ParameterParser.html Sat Jul 15 23:26:25 2023 @@ -0,0 +1,310 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> +<title>ParameterParser xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/fileupload2/core/ParameterParser.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.commons.fileupload2.core; +<a class="jxr_linenumber" name="L18" href="#L18">18</a> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.util.HashMap; +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * A simple parser intended to parse sequences of name/value pairs.</em> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * Parameter values are expected to be enclosed in quotes if they contain unsafe characters, such as '=' characters or separators. Parameter values are optional</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * and can be omitted.</em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * {@code param1 = value; param2 = "anything goes; really"; param3}</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="ParameterParser" href="../../../../../org/apache/commons/fileupload2/core/ParameterParser.html#ParameterParser">ParameterParser</a> { +<a class="jxr_linenumber" name="L35" href="#L35">35</a> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * String to be parsed.</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">char</strong>[] chars = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * Current position in the string.</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> pos = 0; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * Maximum position in the string.</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> len = 0; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * Start of a token.</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> i1 = 0; +<a class="jxr_linenumber" name="L55" href="#L55">55</a> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * End of a token.</em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> i2 = 0; +<a class="jxr_linenumber" name="L60" href="#L60">60</a> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * Whether names stored in the map should be converted to lower case.</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> lowerCaseNames = false; +<a class="jxr_linenumber" name="L65" href="#L65">65</a> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * Default ParameterParser constructor.</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">public</strong> <a name="ParameterParser" href="../../../../../org/apache/commons/fileupload2/core/ParameterParser.html#ParameterParser">ParameterParser</a>() { +<a class="jxr_linenumber" name="L70" href="#L70">70</a> } +<a class="jxr_linenumber" name="L71" href="#L71">71</a> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * A helper method to process the parsed token. This method removes leading and trailing blanks as well as enclosing quotation marks, when necessary.</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * @param quoted {@code true} if quotation marks are expected, {@code false} otherwise.</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * @return the token</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> String getToken(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> quoted) { +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_comment">// Trim leading white spaces</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">while</strong> (i1 < i2 && Character.isWhitespace(chars[i1])) { +<a class="jxr_linenumber" name="L81" href="#L81">81</a> i1++; +<a class="jxr_linenumber" name="L82" href="#L82">82</a> } +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_comment">// Trim trailing white spaces</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">while</strong> (i2 > i1 && Character.isWhitespace(chars[i2 - 1])) { +<a class="jxr_linenumber" name="L85" href="#L85">85</a> i2--; +<a class="jxr_linenumber" name="L86" href="#L86">86</a> } +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_comment">// Strip away quotation marks if necessary</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">if</strong> (quoted && i2 - i1 >= 2 && chars[i1] == '"' && chars[i2 - 1] == '"') { +<a class="jxr_linenumber" name="L89" href="#L89">89</a> i1++; +<a class="jxr_linenumber" name="L90" href="#L90">90</a> i2--; +<a class="jxr_linenumber" name="L91" href="#L91">91</a> } +<a class="jxr_linenumber" name="L92" href="#L92">92</a> String result = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">if</strong> (i2 > i1) { +<a class="jxr_linenumber" name="L94" href="#L94">94</a> result = <strong class="jxr_keyword">new</strong> String(chars, i1, i2 - i1); +<a class="jxr_linenumber" name="L95" href="#L95">95</a> } +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">return</strong> result; +<a class="jxr_linenumber" name="L97" href="#L97">97</a> } +<a class="jxr_linenumber" name="L98" href="#L98">98</a> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * Tests if there any characters left to parse.</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * @return {@code true} if there are unparsed characters, {@code false} otherwise.</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> hasChar() { +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.pos < <strong class="jxr_keyword">this</strong>.len; +<a class="jxr_linenumber" name="L106" href="#L106">106</a> } +<a class="jxr_linenumber" name="L107" href="#L107">107</a> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * Tests {@code true} if parameter names are to be converted to lower case when name/value pairs are parsed.</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * @return {@code true} if parameter names are to be converted to lower case when name/value pairs are parsed. Otherwise returns {@code false}</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isLowerCaseNames() { +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.lowerCaseNames; +<a class="jxr_linenumber" name="L115" href="#L115">115</a> } +<a class="jxr_linenumber" name="L116" href="#L116">116</a> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * Tests if the given character is present in the array of characters.</em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * @param ch the character to test for presence in the array of characters</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * @param charray the array of characters to test against</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * @return {@code true} if the character is present in the array of characters, {@code false} otherwise.</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isOneOf(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong> ch, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] charray) { +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">boolean</strong> result = false; +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong> element : charray) { +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">if</strong> (ch == element) { +<a class="jxr_linenumber" name="L128" href="#L128">128</a> result = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">break</strong>; +<a class="jxr_linenumber" name="L130" href="#L130">130</a> } +<a class="jxr_linenumber" name="L131" href="#L131">131</a> } +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">return</strong> result; +<a class="jxr_linenumber" name="L133" href="#L133">133</a> } +<a class="jxr_linenumber" name="L134" href="#L134">134</a> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * Parses a map of name/value pairs from the given array of characters. Names are expected to be unique.</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * @param charArray the array of characters that contains a sequence of name/value pairs</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @param separator the name/value pairs separator</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * @return a map of name/value pairs</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">public</strong> Map<String, String> parse(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] charArray, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong> separator) { +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">if</strong> (charArray == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> HashMap<>(); +<a class="jxr_linenumber" name="L145" href="#L145">145</a> } +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">return</strong> parse(charArray, 0, charArray.length, separator); +<a class="jxr_linenumber" name="L147" href="#L147">147</a> } +<a class="jxr_linenumber" name="L148" href="#L148">148</a> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * Parses a map of name/value pairs from the given array of characters. Names are expected to be unique.</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * @param charArray the array of characters that contains a sequence of name/value pairs</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * @param offset - the initial offset.</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * @param length - the length.</em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * @param separator the name/value pairs separator</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * @return a map of name/value pairs</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">public</strong> Map<String, String> parse(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] charArray, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> offset, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> length, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong> separator) { +<a class="jxr_linenumber" name="L159" href="#L159">159</a> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">if</strong> (charArray == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> HashMap<>(); +<a class="jxr_linenumber" name="L162" href="#L162">162</a> } +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">final</strong> HashMap<String, String> params = <strong class="jxr_keyword">new</strong> HashMap<>(); +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">this</strong>.chars = charArray.clone(); +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">this</strong>.pos = offset; +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">this</strong>.len = length; +<a class="jxr_linenumber" name="L167" href="#L167">167</a> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> String paramName; +<a class="jxr_linenumber" name="L169" href="#L169">169</a> String paramValue; +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">while</strong> (hasChar()) { +<a class="jxr_linenumber" name="L171" href="#L171">171</a> paramName = parseToken(<strong class="jxr_keyword">new</strong> <strong class="jxr_keyword">char</strong>[] { '=', separator }); +<a class="jxr_linenumber" name="L172" href="#L172">172</a> paramValue = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">if</strong> (hasChar() && charArray[pos] == '=') { +<a class="jxr_linenumber" name="L174" href="#L174">174</a> pos++; <em class="jxr_comment">// skip '='</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> paramValue = parseQuotedToken(<strong class="jxr_keyword">new</strong> <strong class="jxr_keyword">char</strong>[] { separator }); +<a class="jxr_linenumber" name="L176" href="#L176">176</a> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">if</strong> (paramValue != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L179" href="#L179">179</a> paramValue = RFC2231Utils.hasEncodedValue(paramName) ? RFC2231Utils.decodeText(paramValue) : MimeUtils.decodeText(paramValue); +<a class="jxr_linenumber" name="L180" href="#L180">180</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> UnsupportedEncodingException ignored) { +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_comment">// let's keep the original value in this case</em> +<a class="jxr_linenumber" name="L182" href="#L182">182</a> } +<a class="jxr_linenumber" name="L183" href="#L183">183</a> } +<a class="jxr_linenumber" name="L184" href="#L184">184</a> } +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">if</strong> (hasChar() && charArray[pos] == separator) { +<a class="jxr_linenumber" name="L186" href="#L186">186</a> pos++; <em class="jxr_comment">// skip separator</em> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> } +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">if</strong> (paramName != <strong class="jxr_keyword">null</strong> && !paramName.isEmpty()) { +<a class="jxr_linenumber" name="L189" href="#L189">189</a> paramName = RFC2231Utils.stripDelimiter(paramName); +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.lowerCaseNames) { +<a class="jxr_linenumber" name="L191" href="#L191">191</a> paramName = paramName.toLowerCase(Locale.ENGLISH); +<a class="jxr_linenumber" name="L192" href="#L192">192</a> } +<a class="jxr_linenumber" name="L193" href="#L193">193</a> params.put(paramName, paramValue); +<a class="jxr_linenumber" name="L194" href="#L194">194</a> } +<a class="jxr_linenumber" name="L195" href="#L195">195</a> } +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">return</strong> params; +<a class="jxr_linenumber" name="L197" href="#L197">197</a> } +<a class="jxr_linenumber" name="L198" href="#L198">198</a> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * Parses a map of name/value pairs from the given string. Names are expected to be unique.</em> +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @param str the string that contains a sequence of name/value pairs</em> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @param separator the name/value pairs separator</em> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * @return a map of name/value pairs</em> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">public</strong> Map<String, String> parse(<strong class="jxr_keyword">final</strong> String str, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong> separator) { +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">if</strong> (str == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> HashMap<>(); +<a class="jxr_linenumber" name="L209" href="#L209">209</a> } +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">return</strong> parse(str.toCharArray(), separator); +<a class="jxr_linenumber" name="L211" href="#L211">211</a> } +<a class="jxr_linenumber" name="L212" href="#L212">212</a> +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * Parses a map of name/value pairs from the given string. Names are expected to be unique. Multiple separators may be specified and the earliest found in</em> +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * the input string is used.</em> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * @param str the string that contains a sequence of name/value pairs</em> +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * @param separators the name/value pairs separators</em> +<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * @return a map of name/value pairs</em> +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">public</strong> Map<String, String> parse(<strong class="jxr_keyword">final</strong> String str, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] separators) { +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">if</strong> (separators == <strong class="jxr_keyword">null</strong> || separators.length == 0) { +<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> HashMap<>(); +<a class="jxr_linenumber" name="L224" href="#L224">224</a> } +<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">char</strong> separator = separators[0]; +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">if</strong> (str != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">int</strong> idx = str.length(); +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong> separator2 : separators) { +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> tmp = str.indexOf(separator2); +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">if</strong> (tmp != -1 && tmp < idx) { +<a class="jxr_linenumber" name="L231" href="#L231">231</a> idx = tmp; +<a class="jxr_linenumber" name="L232" href="#L232">232</a> separator = separator2; +<a class="jxr_linenumber" name="L233" href="#L233">233</a> } +<a class="jxr_linenumber" name="L234" href="#L234">234</a> } +<a class="jxr_linenumber" name="L235" href="#L235">235</a> } +<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">return</strong> parse(str, separator); +<a class="jxr_linenumber" name="L237" href="#L237">237</a> } +<a class="jxr_linenumber" name="L238" href="#L238">238</a> +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * Parses out a token until any of the given terminators is encountered outside the quotation marks.</em> +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> * @param terminators the array of terminating characters. Any of these characters when encountered outside the quotation marks signify the end of the token</em> +<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> * @return the token</em> +<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">private</strong> String parseQuotedToken(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] terminators) { +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">char</strong> ch; +<a class="jxr_linenumber" name="L247" href="#L247">247</a> i1 = pos; +<a class="jxr_linenumber" name="L248" href="#L248">248</a> i2 = pos; +<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">boolean</strong> quoted = false; +<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">boolean</strong> charEscaped = false; +<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">while</strong> (hasChar()) { +<a class="jxr_linenumber" name="L252" href="#L252">252</a> ch = chars[pos]; +<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">if</strong> (!quoted && isOneOf(ch, terminators)) { +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">break</strong>; +<a class="jxr_linenumber" name="L255" href="#L255">255</a> } +<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">if</strong> (!charEscaped && ch == '"') { +<a class="jxr_linenumber" name="L257" href="#L257">257</a> quoted = !quoted; +<a class="jxr_linenumber" name="L258" href="#L258">258</a> } +<a class="jxr_linenumber" name="L259" href="#L259">259</a> charEscaped = !charEscaped && ch == '\\'; +<a class="jxr_linenumber" name="L260" href="#L260">260</a> i2++; +<a class="jxr_linenumber" name="L261" href="#L261">261</a> pos++; +<a class="jxr_linenumber" name="L262" href="#L262">262</a> +<a class="jxr_linenumber" name="L263" href="#L263">263</a> } +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">return</strong> getToken(<strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L265" href="#L265">265</a> } +<a class="jxr_linenumber" name="L266" href="#L266">266</a> +<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * Parses out a token until any of the given terminators is encountered.</em> +<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * @param terminators the array of terminating characters. Any of these characters when encountered signify the end of the token</em> +<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * @return the token</em> +<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">private</strong> String parseToken(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] terminators) { +<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">char</strong> ch; +<a class="jxr_linenumber" name="L275" href="#L275">275</a> i1 = pos; +<a class="jxr_linenumber" name="L276" href="#L276">276</a> i2 = pos; +<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">while</strong> (hasChar()) { +<a class="jxr_linenumber" name="L278" href="#L278">278</a> ch = chars[pos]; +<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">if</strong> (isOneOf(ch, terminators)) { +<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">break</strong>; +<a class="jxr_linenumber" name="L281" href="#L281">281</a> } +<a class="jxr_linenumber" name="L282" href="#L282">282</a> i2++; +<a class="jxr_linenumber" name="L283" href="#L283">283</a> pos++; +<a class="jxr_linenumber" name="L284" href="#L284">284</a> } +<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">return</strong> getToken(false); +<a class="jxr_linenumber" name="L286" href="#L286">286</a> } +<a class="jxr_linenumber" name="L287" href="#L287">287</a> +<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * Sets the flag if parameter names are to be converted to lower case when name/value pairs are parsed.</em> +<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> * @param lowerCaseNames {@code true} if parameter names are to be converted to lower case when name/value pairs are parsed. {@code false} otherwise.</em> +<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLowerCaseNames(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> lowerCaseNames) { +<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">this</strong>.lowerCaseNames = lowerCaseNames; +<a class="jxr_linenumber" name="L295" href="#L295">295</a> } +<a class="jxr_linenumber" name="L296" href="#L296">296</a> +<a class="jxr_linenumber" name="L297" href="#L297">297</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2002–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html>
Added: dev/commons/fileupload/2.0.0-M1-RC1/site/xref/org/apache/commons/fileupload2/core/ProgressListener.html ============================================================================== --- dev/commons/fileupload/2.0.0-M1-RC1/site/xref/org/apache/commons/fileupload2/core/ProgressListener.html (added) +++ dev/commons/fileupload/2.0.0-M1-RC1/site/xref/org/apache/commons/fileupload2/core/ProgressListener.html Sat Jul 15 23:26:25 2023 @@ -0,0 +1,54 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> +<title>ProgressListener xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/fileupload2/core/ProgressListener.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.commons.fileupload2.core; +<a class="jxr_linenumber" name="L18" href="#L18">18</a> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_javadoccomment"> * Receives progress information. May be used to display a progress bar.</em> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> @FunctionalInterface +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a name="ProgressListener" href="../../../../../org/apache/commons/fileupload2/core/ProgressListener.html#ProgressListener">ProgressListener</a> { +<a class="jxr_linenumber" name="L24" href="#L24">24</a> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * Nop implementation.</em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <a name="ProgressListener" href="../../../../../org/apache/commons/fileupload2/core/ProgressListener.html#ProgressListener">ProgressListener</a> NOP = (bytesRead, contentLength, items) -> { +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_comment">// nop</em> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> }; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * Updates the listeners status information.</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @param bytesRead The total number of bytes, which have been read so far.</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * @param contentLength The total number of bytes, which are being read. May be -1, if this number is unknown.</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * @param items The number of the field, which is currently being read. (0 = no item so far, 1 = first item is being read, ...)</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">void</strong> update(<strong class="jxr_keyword">long</strong> bytesRead, <strong class="jxr_keyword">long</strong> contentLength, <strong class="jxr_keyword">int</strong> items); +<a class="jxr_linenumber" name="L40" href="#L40">40</a> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2002–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> Added: dev/commons/fileupload/2.0.0-M1-RC1/site/xref/org/apache/commons/fileupload2/core/QuotedPrintableDecoder.html ============================================================================== --- dev/commons/fileupload/2.0.0-M1-RC1/site/xref/org/apache/commons/fileupload2/core/QuotedPrintableDecoder.html (added) +++ dev/commons/fileupload/2.0.0-M1-RC1/site/xref/org/apache/commons/fileupload2/core/QuotedPrintableDecoder.html Sat Jul 15 23:26:25 2023 @@ -0,0 +1,123 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> +<title>QuotedPrintableDecoder xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/fileupload2/core/QuotedPrintableDecoder.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.commons.fileupload2.core; +<a class="jxr_linenumber" name="L18" href="#L18">18</a> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.io.OutputStream; +<a class="jxr_linenumber" name="L21" href="#L21">21</a> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a name="QuotedPrintableDecoder" href="../../../../../org/apache/commons/fileupload2/core/QuotedPrintableDecoder.html#QuotedPrintableDecoder">QuotedPrintableDecoder</a> { +<a class="jxr_linenumber" name="L25" href="#L25">25</a> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * The shift value required to create the upper nibble from the first of 2 byte values converted from ascii hex.</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> UPPER_NIBBLE_SHIFT = Byte.SIZE / 2; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * Decodes the encoded byte data writing it to the given output stream.</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * @param data The array of byte data to decode.</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @param out The output stream used to return the decoded data.</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * @return the number of bytes produced.</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * @throws IOException if an IO error occurs</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> decode(<strong class="jxr_keyword">final</strong> byte[] data, <strong class="jxr_keyword">final</strong> OutputStream out) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">int</strong> off = 0; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> length = data.length; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> endOffset = off + length; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">int</strong> bytesWritten = 0; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">while</strong> (off < endOffset) { +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">final</strong> byte ch = data[off++]; +<a class="jxr_linenumber" name="L48" href="#L48">48</a> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_comment">// space characters were translated to '_' on encode, so we need to translate them back.</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">if</strong> (ch == '_') { +<a class="jxr_linenumber" name="L51" href="#L51">51</a> out.write(' '); +<a class="jxr_linenumber" name="L52" href="#L52">52</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (ch == '=') { +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_comment">// we found an encoded character. Reduce the 3 char sequence to one.</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_comment">// but first, make sure we have two characters to work with.</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">if</strong> (off + 1 >= endOffset) { +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(<span class="jxr_string">"Invalid quoted printable encoding; truncated escape sequence"</span>); +<a class="jxr_linenumber" name="L57" href="#L57">57</a> } +<a class="jxr_linenumber" name="L58" href="#L58">58</a> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">final</strong> byte b1 = data[off++]; +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">final</strong> byte b2 = data[off++]; +<a class="jxr_linenumber" name="L61" href="#L61">61</a> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_comment">// we've found an encoded carriage return. The next char needs to be a newline</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">if</strong> (b1 == '\r') { +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">if</strong> (b2 != '\n') { +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(<span class="jxr_string">"Invalid quoted printable encoding; CR must be followed by LF"</span>); +<a class="jxr_linenumber" name="L66" href="#L66">66</a> } +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_comment">// this was a soft linebreak inserted by the encoding. We just toss this away</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_comment">// on decode.</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_comment">// this is a hex pair we need to convert back to a single byte.</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> c1 = hexToBinary(b1); +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> c2 = hexToBinary(b2); +<a class="jxr_linenumber" name="L73" href="#L73">73</a> out.write(c1 << UPPER_NIBBLE_SHIFT | c2); +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_comment">// 3 bytes in, one byte out</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> bytesWritten++; +<a class="jxr_linenumber" name="L76" href="#L76">76</a> } +<a class="jxr_linenumber" name="L77" href="#L77">77</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_comment">// simple character, just write it out.</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> out.write(ch); +<a class="jxr_linenumber" name="L80" href="#L80">80</a> bytesWritten++; +<a class="jxr_linenumber" name="L81" href="#L81">81</a> } +<a class="jxr_linenumber" name="L82" href="#L82">82</a> } +<a class="jxr_linenumber" name="L83" href="#L83">83</a> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">return</strong> bytesWritten; +<a class="jxr_linenumber" name="L85" href="#L85">85</a> } +<a class="jxr_linenumber" name="L86" href="#L86">86</a> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * Converts a hex digit to the binary value it represents.</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * @param b the ascii hex byte to convert (0-0, A-F, a-f)</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * @return the int value of the hex byte, 0-15</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * @throws IOException if the byte is not a valid hex digit.</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> hexToBinary(<strong class="jxr_keyword">final</strong> byte b) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_comment">// CHECKSTYLE IGNORE MagicNumber FOR NEXT 1 LINE</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> i = Character.digit((<strong class="jxr_keyword">char</strong>) b, 16); +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">if</strong> (i == -1) { +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(<span class="jxr_string">"Invalid quoted printable encoding: not a valid hex digit: "</span> + b); +<a class="jxr_linenumber" name="L99" href="#L99">99</a> } +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">return</strong> i; +<a class="jxr_linenumber" name="L101" href="#L101">101</a> } +<a class="jxr_linenumber" name="L102" href="#L102">102</a> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * Hidden constructor, this class must not be instantiated.</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">private</strong> <a name="QuotedPrintableDecoder" href="../../../../../org/apache/commons/fileupload2/core/QuotedPrintableDecoder.html#QuotedPrintableDecoder">QuotedPrintableDecoder</a>() { +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_comment">// do nothing</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> } +<a class="jxr_linenumber" name="L109" href="#L109">109</a> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2002–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> Added: dev/commons/fileupload/2.0.0-M1-RC1/site/xref/org/apache/commons/fileupload2/core/RFC2231Utils.html ============================================================================== --- dev/commons/fileupload/2.0.0-M1-RC1/site/xref/org/apache/commons/fileupload2/core/RFC2231Utils.html (added) +++ dev/commons/fileupload/2.0.0-M1-RC1/site/xref/org/apache/commons/fileupload2/core/RFC2231Utils.html Sat Jul 15 23:26:25 2023 @@ -0,0 +1,165 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> +<title>RFC2231Utils xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/fileupload2/core/RFC2231Utils.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.commons.fileupload2.core; +<a class="jxr_linenumber" name="L18" href="#L18">18</a> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.io.ByteArrayOutputStream; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException; +<a class="jxr_linenumber" name="L21" href="#L21">21</a> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment"> * Utility class to decode/encode character set on HTTP Header fields based on RFC 2231. This implementation adheres to RFC 5987 in particular, which was</em> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * defined for HTTP headers</em> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * RFC 5987 builds on RFC 2231, but has lesser scope like <a href="<a href="https://tools.ietf.org/html/rfc5987"; target="alexandria_uri">https://tools.ietf.org/html/rfc5987</a>#section-3.2">mandatory charset definition</a> and</em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * <a href="<a href="https://tools.ietf.org/html/rfc5987"; target="alexandria_uri">https://tools.ietf.org/html/rfc5987</a>#section-4">no parameter continuation</a></em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="https://tools.ietf.org/html/rfc2231"; target="alexandria_uri">https://tools.ietf.org/html/rfc2231</a>">RFC 2231</a></em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="https://tools.ietf.org/html/rfc5987"; target="alexandria_uri">https://tools.ietf.org/html/rfc5987</a>">RFC 5987</a></em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a name="RFC2231Utils" href="../../../../../org/apache/commons/fileupload2/core/RFC2231Utils.html#RFC2231Utils">RFC2231Utils</a> { +<a class="jxr_linenumber" name="L34" href="#L34">34</a> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * The Hexadecimal values char array.</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] HEX_DIGITS = <span class="jxr_string">"0123456789ABCDEF"</span>.toCharArray(); +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * The Hexadecimal representation of 127.</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte MASK = 0x7f; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * The Hexadecimal representation of 128.</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> MASK_128 = 0x80; +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * The Hexadecimal decode value.</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte[] HEX_DECODE = <strong class="jxr_keyword">new</strong> byte[MASK_128]; +<a class="jxr_linenumber" name="L51" href="#L51">51</a> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_comment">// create a ASCII decoded array of Hexadecimal values</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">static</strong> { +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < HEX_DIGITS.length; i++) { +<a class="jxr_linenumber" name="L55" href="#L55">55</a> HEX_DECODE[HEX_DIGITS[i]] = (byte) i; +<a class="jxr_linenumber" name="L56" href="#L56">56</a> HEX_DECODE[Character.toLowerCase(HEX_DIGITS[i])] = (byte) i; +<a class="jxr_linenumber" name="L57" href="#L57">57</a> } +<a class="jxr_linenumber" name="L58" href="#L58">58</a> } +<a class="jxr_linenumber" name="L59" href="#L59">59</a> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * Decodes a string of text obtained from a HTTP header as per RFC 2231</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * <b>Eg 1.</b> {@code us-ascii'en-us'This%20is%20%2A%2A%2Afun%2A%2A%2A} will be decoded to {@code This is ***fun***}</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * <b>Eg 2.</b> {@code iso-8859-1'en'%A3%20rate} will be decoded to {@code £ rate}.</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * <b>Eg 3.</b> {@code UTF-8''%c2%a3%20and%20%e2%82%ac%20rates} will be decoded to {@code £ and ⬠rates}.</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * @param encodedText - Text to be decoded has a format of {@code <charset>'<language>'<encoded_value>} and ASCII only</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * @return Decoded text based on charset encoding</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @throws UnsupportedEncodingException The requested character set wasn't found.</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">static</strong> String decodeText(<strong class="jxr_keyword">final</strong> String encodedText) <strong class="jxr_keyword">throws</strong> UnsupportedEncodingException { +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> langDelimitStart = encodedText.indexOf('\''); +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">if</strong> (langDelimitStart == -1) { +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_comment">// missing charset</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">return</strong> encodedText; +<a class="jxr_linenumber" name="L78" href="#L78">78</a> } +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">final</strong> String mimeCharset = encodedText.substring(0, langDelimitStart); +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> langDelimitEnd = encodedText.indexOf('\'', langDelimitStart + 1); +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">if</strong> (langDelimitEnd == -1) { +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_comment">// missing language</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">return</strong> encodedText; +<a class="jxr_linenumber" name="L84" href="#L84">84</a> } +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">final</strong> byte[] bytes = fromHex(encodedText.substring(langDelimitEnd + 1)); +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> String(bytes, getJavaCharset(mimeCharset)); +<a class="jxr_linenumber" name="L87" href="#L87">87</a> } +<a class="jxr_linenumber" name="L88" href="#L88">88</a> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * Converts {@code text} to their corresponding Hex value.</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * @param text - ASCII text input</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * @return Byte array of characters decoded from ASCII table</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> byte[] fromHex(<strong class="jxr_keyword">final</strong> String text) { +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> shift = 4; +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">final</strong> ByteArrayOutputStream out = <strong class="jxr_keyword">new</strong> ByteArrayOutputStream(text.length()); +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < text.length();) { +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong> c = text.charAt(i++); +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">if</strong> (c == '%') { +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">if</strong> (i > text.length() - 2) { +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">break</strong>; <em class="jxr_comment">// unterminated sequence</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> } +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">final</strong> byte b1 = HEX_DECODE[text.charAt(i++) & MASK]; +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">final</strong> byte b2 = HEX_DECODE[text.charAt(i++) & MASK]; +<a class="jxr_linenumber" name="L106" href="#L106">106</a> out.write(b1 << shift | b2); +<a class="jxr_linenumber" name="L107" href="#L107">107</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L108" href="#L108">108</a> out.write((byte) c); +<a class="jxr_linenumber" name="L109" href="#L109">109</a> } +<a class="jxr_linenumber" name="L110" href="#L110">110</a> } +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">return</strong> out.toByteArray(); +<a class="jxr_linenumber" name="L112" href="#L112">112</a> } +<a class="jxr_linenumber" name="L113" href="#L113">113</a> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String getJavaCharset(<strong class="jxr_keyword">final</strong> String mimeCharset) { +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_comment">// good enough for standard values</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">return</strong> mimeCharset; +<a class="jxr_linenumber" name="L117" href="#L117">117</a> } +<a class="jxr_linenumber" name="L118" href="#L118">118</a> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * Tests if asterisk (*) at the end of parameter name to indicate, if it has charset and language information to decode the value.</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * @param paramName The parameter, which is being checked.</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * @return {@code true}, if encoded as per RFC 2231, {@code false} otherwise</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> hasEncodedValue(<strong class="jxr_keyword">final</strong> String paramName) { +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">if</strong> (paramName != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">return</strong> paramName.lastIndexOf('*') == paramName.length() - 1; +<a class="jxr_linenumber" name="L128" href="#L128">128</a> } +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L130" href="#L130">130</a> } +<a class="jxr_linenumber" name="L131" href="#L131">131</a> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * If {@code paramName} has Asterisk (*) at the end, it will be stripped off, else the passed value will be returned.</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @param paramName The parameter, which is being inspected.</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * @return stripped {@code paramName} of Asterisk (*), if RFC2231 encoded</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">static</strong> String stripDelimiter(<strong class="jxr_keyword">final</strong> String paramName) { +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">if</strong> (hasEncodedValue(paramName)) { +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">final</strong> StringBuilder paramBuilder = <strong class="jxr_keyword">new</strong> StringBuilder(paramName); +<a class="jxr_linenumber" name="L141" href="#L141">141</a> paramBuilder.deleteCharAt(paramName.lastIndexOf('*')); +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">return</strong> paramBuilder.toString(); +<a class="jxr_linenumber" name="L143" href="#L143">143</a> } +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">return</strong> paramName; +<a class="jxr_linenumber" name="L145" href="#L145">145</a> } +<a class="jxr_linenumber" name="L146" href="#L146">146</a> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * Private constructor so that no instances can be created. This class contains only static utility methods.</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">private</strong> <a name="RFC2231Utils" href="../../../../../org/apache/commons/fileupload2/core/RFC2231Utils.html#RFC2231Utils">RFC2231Utils</a>() { +<a class="jxr_linenumber" name="L151" href="#L151">151</a> } +<a class="jxr_linenumber" name="L152" href="#L152">152</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2002–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html>
