Coverage Report

Coverage Report - org.owasp.dependencycheck.reporting.EscapeTool

Classes in this File

Line Coverage

Branch Coverage

Complexity

EscapeTool

0/15

0/12

4.667

 /*
  * This file is part of dependency-check-core.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
  * Copyright (c) 2014 Jeremy Long. All Rights Reserved.
  */
 package org.owasp.dependencycheck.reporting;
 
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
 import org.apache.commons.lang3.StringEscapeUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
  * An extremely simple wrapper around various escape utils to perform URL and HTML encoding within the reports. This class was
  * created to simplify the velocity configuration and avoid using the "built-in" escape tool.
  *
  * @author Jeremy Long
  */
 public class EscapeTool {
 
     /**
      * The logger.
      */
     private static final Logger LOGGER = LoggerFactory.getLogger(EscapeTool.class);
 
     /**
      * URL Encodes the provided text.
      *
      * @param text the text to encode
      * @return the URL encoded text
      */
     public String url(String text) {
         if (text == null || text.isEmpty()) {
             return text;
         }
         try {
             return URLEncoder.encode(text, "UTF-8");
         } catch (UnsupportedEncodingException ex) {
             LOGGER.warn("UTF-8 is not supported?");
             LOGGER.info("", ex);
         }
         return "";
     }
 
     /**
      * HTML Encodes the provided text.
      *
      * @param text the text to encode
      * @return the HTML encoded text
      */
     public String html(String text) {
         if (text == null || text.isEmpty()) {
             return text;
         }
         return StringEscapeUtils.escapeHtml4(text);
     }
 
     /**
      * XML Encodes the provided text.
      *
      * @param text the text to encode
      * @return the XML encoded text
      */
     public String xml(String text) {
         if (text == null || text.isEmpty()) {
             return text;
         }
         return StringEscapeUtils.escapeXml11(text);
     }
 }

1		/*
2		* This file is part of dependency-check-core.
3		*
4		* Licensed under the Apache License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.apache.org/licenses/LICENSE-2.0
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*
16		* Copyright (c) 2014 Jeremy Long. All Rights Reserved.
17		*/
18		package org.owasp.dependencycheck.reporting;
19
20		import java.io.UnsupportedEncodingException;
21		import java.net.URLEncoder;
22		import org.apache.commons.lang3.StringEscapeUtils;
23		import org.slf4j.Logger;
24		import org.slf4j.LoggerFactory;
25
26		/**
27		* An extremely simple wrapper around various escape utils to perform URL and HTML encoding within the reports. This class was
28		* created to simplify the velocity configuration and avoid using the "built-in" escape tool.
29		*
30		* @author Jeremy Long
31		*/
32	0	public class EscapeTool {
33
34		/**
35		* The logger.
36		*/
37	0	private static final Logger LOGGER = LoggerFactory.getLogger(EscapeTool.class);
38
39		/**
40		* URL Encodes the provided text.
41		*
42		* @param text the text to encode
43		* @return the URL encoded text
44		*/
45		public String url(String text) {
46	0	if (text == null \|\| text.isEmpty()) {
47	0	return text;
48		}
49		try {
50	0	return URLEncoder.encode(text, "UTF-8");
51	0	} catch (UnsupportedEncodingException ex) {
52	0	LOGGER.warn("UTF-8 is not supported?");
53	0	LOGGER.info("", ex);
54		}
55	0	return "";
56		}
57
58		/**
59		* HTML Encodes the provided text.
60		*
61		* @param text the text to encode
62		* @return the HTML encoded text
63		*/
64		public String html(String text) {
65	0	if (text == null \|\| text.isEmpty()) {
66	0	return text;
67		}
68	0	return StringEscapeUtils.escapeHtml4(text);
69		}
70
71		/**
72		* XML Encodes the provided text.
73		*
74		* @param text the text to encode
75		* @return the XML encoded text
76		*/
77		public String xml(String text) {
78	0	if (text == null \|\| text.isEmpty()) {
79	0	return text;
80		}
81	0	return StringEscapeUtils.escapeXml11(text);
82		}
83		}