juplo.de Git - website/blob - dist/facebook-utils-2.5.0/xref/de/juplo/facebook/aspects/SanitizeAspect.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   3 <head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
   4 <title>SanitizeAspect xref</title>
   5 <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
   6 </head>
   7 <body>
   8 <div id="overview"><a href="../../../../../apidocs/de/juplo/facebook/aspects/SanitizeAspect.html">View Javadoc</a></div><pre>
   9 <a class="jxr_linenumber" name="L1" href="#L1">1</a>   <strong class="jxr_keyword">package</strong> de.juplo.facebook.aspects;
  10 <a class="jxr_linenumber" name="L2" href="#L2">2</a>
  11 <a class="jxr_linenumber" name="L3" href="#L3">3</a>
  12 <a class="jxr_linenumber" name="L4" href="#L4">4</a>   <strong class="jxr_keyword">import</strong> org.aspectj.lang.ProceedingJoinPoint;
  13 <a class="jxr_linenumber" name="L5" href="#L5">5</a>   <strong class="jxr_keyword">import</strong> org.aspectj.lang.annotation.Around;
  14 <a class="jxr_linenumber" name="L6" href="#L6">6</a>   <strong class="jxr_keyword">import</strong> org.aspectj.lang.annotation.Aspect;
  15 <a class="jxr_linenumber" name="L7" href="#L7">7</a>   <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
  16 <a class="jxr_linenumber" name="L8" href="#L8">8</a>   <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
  17 <a class="jxr_linenumber" name="L9" href="#L9">9</a>
  18 <a class="jxr_linenumber" name="L10" href="#L10">10</a>
  19 <a class="jxr_linenumber" name="L11" href="#L11">11</a>
  20 <a class="jxr_linenumber" name="L12" href="#L12">12</a>  <em class="jxr_javadoccomment">/**</em>
  21 <a class="jxr_linenumber" name="L13" href="#L13">13</a>  <em class="jxr_javadoccomment"> * @author Kai Moritz</em>
  22 <a class="jxr_linenumber" name="L14" href="#L14">14</a>  <em class="jxr_javadoccomment"> */</em>
  23 <a class="jxr_linenumber" name="L15" href="#L15">15</a>  @Aspect
  24 <a class="jxr_linenumber" name="L16" href="#L16">16</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../de/juplo/facebook/aspects/SanitizeAspect.html">SanitizeAspect</a>
  25 <a class="jxr_linenumber" name="L17" href="#L17">17</a>  {
  26 <a class="jxr_linenumber" name="L18" href="#L18">18</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log =
  27 <a class="jxr_linenumber" name="L19" href="#L19">19</a>        LoggerFactory.getLogger(SanitizeAspect.<strong class="jxr_keyword">class</strong>);
  28 <a class="jxr_linenumber" name="L20" href="#L20">20</a>
  29 <a class="jxr_linenumber" name="L21" href="#L21">21</a>
  30 <a class="jxr_linenumber" name="L22" href="#L22">22</a>    <em class="jxr_javadoccomment">/**</em>
  31 <a class="jxr_linenumber" name="L23" href="#L23">23</a>  <em class="jxr_javadoccomment">   * This method sanitizes the given string in all means:</em>
  32 <a class="jxr_linenumber" name="L24" href="#L24">24</a>  <em class="jxr_javadoccomment">   * &lt;ul&gt;</em>
  33 <a class="jxr_linenumber" name="L25" href="#L25">25</a>  <em class="jxr_javadoccomment">   * &lt;li&gt;It removes leading and trailing whitspace.&lt;/li&gt;</em>
  34 <a class="jxr_linenumber" name="L26" href="#L26">26</a>  <em class="jxr_javadoccomment">   * &lt;li&gt;It removes characters, that are not allowed in the XML-output&lt;/li&gt;</em>
  35 <a class="jxr_linenumber" name="L27" href="#L27">27</a>  <em class="jxr_javadoccomment">   * &lt;li&gt;It checks the allowed length of the string&lt;/li&gt;</em>
  36 <a class="jxr_linenumber" name="L28" href="#L28">28</a>  <em class="jxr_javadoccomment">   * &lt;/ul&gt;</em>
  37 <a class="jxr_linenumber" name="L29" href="#L29">29</a>  <em class="jxr_javadoccomment">   *</em>
  38 <a class="jxr_linenumber" name="L30" href="#L30">30</a>  <em class="jxr_javadoccomment">   * This method ensures that the output String has only</em>
  39 <a class="jxr_linenumber" name="L31" href="#L31">31</a>  <em class="jxr_javadoccomment">   * valid XML unicode characters as specified by the</em>
  40 <a class="jxr_linenumber" name="L32" href="#L32">32</a>  <em class="jxr_javadoccomment">   * XML 1.0 standard. For reference, please see</em>
  41 <a class="jxr_linenumber" name="L33" href="#L33">33</a>  <em class="jxr_javadoccomment">   * &lt;a href="<a href="http://www.w3.org/TR/2000/REC-xml-20001006" target="alexandria_uri">http://www.w3.org/TR/2000/REC-xml-20001006</a>#NT-Char"&gt;the</em>
  42 <a class="jxr_linenumber" name="L34" href="#L34">34</a>  <em class="jxr_javadoccomment">   * standard&lt;/a&gt;. This method will return an empty</em>
  43 <a class="jxr_linenumber" name="L35" href="#L35">35</a>  <em class="jxr_javadoccomment">   * String if the input is null or empty.</em>
  44 <a class="jxr_linenumber" name="L36" href="#L36">36</a>  <em class="jxr_javadoccomment">   *</em>
  45 <a class="jxr_linenumber" name="L37" href="#L37">37</a>  <em class="jxr_javadoccomment">   * @param jp The join-point captured by AspectJ.</em>
  46 <a class="jxr_linenumber" name="L38" href="#L38">38</a>  <em class="jxr_javadoccomment">   * @param in The String whose non-valid characters we want to remove.</em>
  47 <a class="jxr_linenumber" name="L39" href="#L39">39</a>  <em class="jxr_javadoccomment">   * @param sanitize The annotation, the field was marked with.</em>
  48 <a class="jxr_linenumber" name="L40" href="#L40">40</a>  <em class="jxr_javadoccomment">   * @see &lt;a href="<a href="http://blog.mark-mclaren.info/2007/02/invalid-xml-characters-when-valid-utf8_5873.html" target="alexandria_uri">http://blog.mark-mclaren.info/2007/02/invalid-xml-characters-when-valid-utf8_5873.html</a>"&gt;Invalid XML Characters: when valid UTF8 does not mean valid XML&lt;/a&gt;</em>
  49 <a class="jxr_linenumber" name="L41" href="#L41">41</a>  <em class="jxr_javadoccomment">   * @see &lt;a href="<a href="http://up-download.de/up/docs/werkstatt/de/intrexx-werkstatt-ungueltige-zeichen-in-eingabefeldern-abfangen.pdf" target="alexandria_uri">http://up-download.de/up/docs/werkstatt/de/intrexx-werkstatt-ungueltige-zeichen-in-eingabefeldern-abfangen.pdf</a>"&gt;Ungültige Zeichen in Eingabefeldern abfangen&lt;/a&gt;</em>
  50 <a class="jxr_linenumber" name="L42" href="#L42">42</a>  <em class="jxr_javadoccomment">   */</em>
  51 <a class="jxr_linenumber" name="L43" href="#L43">43</a>    @Around(<span class="jxr_string">"set(String *) &amp;&amp; args(in) &amp;&amp; @annotation(sanitize)"</span>)
  52 <a class="jxr_linenumber" name="L44" href="#L44">44</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> sanitize(
  53 <a class="jxr_linenumber" name="L45" href="#L45">45</a>        ProceedingJoinPoint jp,
  54 <a class="jxr_linenumber" name="L46" href="#L46">46</a>        String in,
  55 <a class="jxr_linenumber" name="L47" href="#L47">47</a>        <a href="../../../../de/juplo/facebook/aspects/Sanitize.html">Sanitize</a> sanitize
  56 <a class="jxr_linenumber" name="L48" href="#L48">48</a>        )
  57 <a class="jxr_linenumber" name="L49" href="#L49">49</a>        <strong class="jxr_keyword">throws</strong> Throwable
  58 <a class="jxr_linenumber" name="L50" href="#L50">50</a>    {
  59 <a class="jxr_linenumber" name="L51" href="#L51">51</a>      <strong class="jxr_keyword">if</strong> (in == <strong class="jxr_keyword">null</strong>)
  60 <a class="jxr_linenumber" name="L52" href="#L52">52</a>      {
  61 <a class="jxr_linenumber" name="L53" href="#L53">53</a>        jp.proceed(<strong class="jxr_keyword">new</strong> Object[] { <strong class="jxr_keyword">null</strong> });
  62 <a class="jxr_linenumber" name="L54" href="#L54">54</a>        <strong class="jxr_keyword">return</strong>;
  63 <a class="jxr_linenumber" name="L55" href="#L55">55</a>      }
  64 <a class="jxr_linenumber" name="L56" href="#L56">56</a>
  65 <a class="jxr_linenumber" name="L57" href="#L57">57</a>      in = in.trim();
  66 <a class="jxr_linenumber" name="L58" href="#L58">58</a>      <strong class="jxr_keyword">if</strong> (<span class="jxr_string">""</span>.equals(in))
  67 <a class="jxr_linenumber" name="L59" href="#L59">59</a>      {
  68 <a class="jxr_linenumber" name="L60" href="#L60">60</a>        jp.proceed(<strong class="jxr_keyword">new</strong> Object[] { <strong class="jxr_keyword">null</strong> });
  69 <a class="jxr_linenumber" name="L61" href="#L61">61</a>        <strong class="jxr_keyword">return</strong>;
  70 <a class="jxr_linenumber" name="L62" href="#L62">62</a>      }
  71 <a class="jxr_linenumber" name="L63" href="#L63">63</a>
  72 <a class="jxr_linenumber" name="L64" href="#L64">64</a>      StringBuilder out = <strong class="jxr_keyword">new</strong> StringBuilder(); <em class="jxr_comment">// Used to hold the output.</em>
  73 <a class="jxr_linenumber" name="L65" href="#L65">65</a>      <strong class="jxr_keyword">char</strong> current; <em class="jxr_comment">// Used to reference the current character.</em>
  74 <a class="jxr_linenumber" name="L66" href="#L66">66</a>
  75 <a class="jxr_linenumber" name="L67" href="#L67">67</a>      <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; in.length(); i++)
  76 <a class="jxr_linenumber" name="L68" href="#L68">68</a>      {
  77 <a class="jxr_linenumber" name="L69" href="#L69">69</a>        current = in.charAt(i); <em class="jxr_comment">// NOTE: No IndexOutOfBoundsException caught here; it should not happen.</em>
  78 <a class="jxr_linenumber" name="L70" href="#L70">70</a>        <strong class="jxr_keyword">if</strong> ((current == 0x9) ||
  79 <a class="jxr_linenumber" name="L71" href="#L71">71</a>            (current == 0xA) ||
  80 <a class="jxr_linenumber" name="L72" href="#L72">72</a>            (current == 0xD) ||
  81 <a class="jxr_linenumber" name="L73" href="#L73">73</a>            ((current &gt;= 0x20) &amp;&amp; (current &lt;= 0xD7FF)) ||
  82 <a class="jxr_linenumber" name="L74" href="#L74">74</a>            ((current &gt;= 0xE000) &amp;&amp; (current &lt;= 0xFFFD)) ||
  83 <a class="jxr_linenumber" name="L75" href="#L75">75</a>            ((current &gt;= 0x10000) &amp;&amp; (current &lt;= 0x10FFFF)))
  84 <a class="jxr_linenumber" name="L76" href="#L76">76</a>          out.append(current);
  85 <a class="jxr_linenumber" name="L77" href="#L77">77</a>      }
  86 <a class="jxr_linenumber" name="L78" href="#L78">78</a>      <strong class="jxr_keyword">if</strong> (out.length() &gt; sanitize.length())
  87 <a class="jxr_linenumber" name="L79" href="#L79">79</a>      {
  88 <a class="jxr_linenumber" name="L80" href="#L80">80</a>        log.error(
  89 <a class="jxr_linenumber" name="L81" href="#L81">81</a>            <span class="jxr_string">"Maximum length for attribute {} exceeded: should={}, was={}"</span>,
  90 <a class="jxr_linenumber" name="L82" href="#L82">82</a>            jp.getSignature().getName(),
  91 <a class="jxr_linenumber" name="L83" href="#L83">83</a>            sanitize.length(),
  92 <a class="jxr_linenumber" name="L84" href="#L84">84</a>            out.length()
  93 <a class="jxr_linenumber" name="L85" href="#L85">85</a>            );
  94 <a class="jxr_linenumber" name="L86" href="#L86">86</a>        <strong class="jxr_keyword">if</strong> (sanitize.fail())
  95 <a class="jxr_linenumber" name="L87" href="#L87">87</a>          <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(<span class="jxr_string">"String is longer than "</span> + sanitize.length());
  96 <a class="jxr_linenumber" name="L88" href="#L88">88</a>        <strong class="jxr_keyword">else</strong>
  97 <a class="jxr_linenumber" name="L89" href="#L89">89</a>          out.setLength(sanitize.length());
  98 <a class="jxr_linenumber" name="L90" href="#L90">90</a>      }
  99 <a class="jxr_linenumber" name="L91" href="#L91">91</a>      jp.proceed(<strong class="jxr_keyword">new</strong> Object[] { out.toString() });
 100 <a class="jxr_linenumber" name="L92" href="#L92">92</a>    }
 101 <a class="jxr_linenumber" name="L93" href="#L93">93</a>  }
 102 </pre>
 103 <hr/>
 104 <div id="footer">Copyright &#169; 2015. All rights reserved.</div>
 105 </body>
 106 </html>