Coverage Report

Coverage Report - org.apache.turbine.util.uri.BaseURI

Classes in this File

Line Coverage

Branch Coverage

Complexity

BaseURI

36%

39/106

17%

6/34

1,643

 package org.apache.turbine.util.uri;
 
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you 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.
  */
 
 
 import javax.servlet.http.HttpServletResponse;
 
 import org.apache.commons.lang3.StringUtils;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.apache.turbine.Turbine;
 import org.apache.turbine.TurbineConstants;
 import org.apache.turbine.util.RunData;
 import org.apache.turbine.util.ServerData;
 
 /**
  * This is the base class for all dynamic URIs in the Turbine System.
  *
  * All of the classes used for generating URIs are derived from this.
  *
  * @author <a href="mailto:jon@clearink.com">Jon S. Stevens</a>
  * @author <a href="mailto:jvanzyl@periapt.com">Jason van Zyl</a>
  * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
  * @author <a href="mailto:quintonm@bellsouth.net">Quinton McCombs</a>
  * @version $Id: BaseURI.java 1854688 2019-03-03 10:36:42Z tv $
  */
 
 public abstract class BaseURI
         implements URI,
                    URIConstants
 {
     /** Logging */
     private static final Logger log = LogManager.getLogger(BaseURI.class);
 
     /** ServerData Object for scheme, name, port etc. */
     private ServerData serverData =
             new ServerData(null, HTTP_PORT, HTTP, null, null);
 
     /** Whether we want to redirect or not. */
     private boolean redirect = false;
 
     /** Servlet response interface. */
     private HttpServletResponse response = null;
 
     /** Reference Anchor (#ref) */
     private String reference = null;
 
     /*
      * ========================================================================
      *
      * Constructors
      *
      * ========================================================================
      *
      */
 
     /**
      * Empty C'tor. Uses Turbine.getDefaultServerData().
      *
      */
     public BaseURI()
     {
         init(Turbine.getDefaultServerData());
         setResponse(null);
     }
 
     /**
      * Constructor with a RunData object
      *
      * @param runData A RunData object
      */
     public BaseURI(RunData runData)
     {
         init(runData.getServerData());
         setResponse(runData.getResponse());
     }
 
     /**
      * Constructor, set explicit redirection
      *
      * @param runData A RunData object
      * @param redirect True if redirection allowed.
      */
     public BaseURI(RunData runData, boolean redirect)
     {
         init(runData.getServerData());
         setResponse(runData.getResponse());
         setRedirect(redirect);
     }
 
     /**
      * Constructor with a ServerData object
      *
      * @param serverData A ServerData object
      */
     public BaseURI(ServerData serverData)
     {
         init(serverData);
         setResponse(null);
     }
 
     /**
      * Constructor, set explicit redirection
      *
      * @param serverData A ServerData object
      * @param redirect True if redirection allowed.
      */
     public BaseURI(ServerData serverData, boolean redirect)
     {
         init(serverData);
         setResponse(null);
         setRedirect(redirect);
     }
 
     /*
      * ========================================================================
      *
      * Init
      *
      * ========================================================================
      *
      */
 
     /**
      * Init with a ServerData object
      *
      * @param serverData A ServerData object
      *
      */
     private void init(ServerData serverData)
     {
         log.debug("init({})", serverData);
 
         if (serverData != null)
         {
             // We must clone this, because if BaseURI is used in a pull tool,
             // then the fields might be changed. If we don't clone, this might pull
             // through to the ServerData object saved at firstRequest() in the
             // Turbine object.
             this.serverData = (ServerData) serverData.clone();
         }
         else
         {
             log.error("Passed null ServerData object!");
         }
         reference = null;
     }
 
     /*
      * ========================================================================
      *
      * Getter / Setter
      *
      * ========================================================================
      *
      */
 
     /**
      * Set the redirect Flag
      *
      * @param redirect The new value of the redirect flag.
      */
     public void setRedirect(boolean redirect)
     {
         this.redirect = redirect;
     }
 
     /**
      * Returns the current value of the Redirect flag
      *
      * @return True if Redirect is allowed
      *
      */
     public boolean isRedirect()
     {
         return redirect;
     }
 
     /**
      * Gets the script name (/servlets/Turbine).
      *
      * @return A String with the script name.
      */
     @Override
     public String getScriptName()
     {
         return serverData.getScriptName();
     }
 
     /**
      * Sets the script name (/servlets/Turbine).
      *
      * @param scriptName A String with the script name.
      */
     public void setScriptName(String scriptName)
     {
         serverData.setScriptName(scriptName);
     }
 
     /**
      * Gets the context path.
      *
      * @return A String with the context path.
      */
     @Override
     public String getContextPath()
     {
         return serverData.getContextPath();
     }
 
     /**
      * Sets the context path.
      *
      * @param contextPath A String with the context path
      */
     public void setContextPath(String contextPath)
     {
         serverData.setContextPath(contextPath);
     }
 
     /**
      * Gets the server name.
      *
      * @return A String with the server name.
      */
     @Override
     public String getServerName()
     {
         return serverData.getServerName();
     }
 
     /**
      * Sets the server name.
      *
      * @param serverName A String with the server name.
      */
     public void setServerName(String serverName)
     {
         serverData.setServerName(serverName);
     }
 
     /**
      * Gets the server port.
      *
      * @return A String with the server port.
      */
     @Override
     public int getServerPort()
     {
         int serverPort = serverData.getServerPort();
 
         if (serverPort == 0)
         {
             if(getServerScheme().equals(HTTPS))
             {
                 serverPort = HTTPS_PORT;
             }
             else
             {
                 serverPort = HTTP_PORT;
             }
         }
         return serverPort;
     }
 
     /**
      * Sets the server port.
      *
      * @param serverPort An int with the port.
      */
     public void setServerPort(int serverPort)
     {
         serverData.setServerPort(serverPort);
     }
 
     /**
      * Method to specify that a URI should use SSL. The default port
      * is used.
      */
     public void setSecure()
     {
         setSecure(HTTPS_PORT);
     }
 
     /**
      * Method to specify that a URI should use SSL.
      * Whether or not it does is determined from Turbine.properties.
      * If use.ssl in the Turbine.properties is set to false, then
      * http is used in any case. (Default of use.ssl is true).
      *
      * @param port An int with the port number.
      */
     public void setSecure(int port)
     {
         boolean useSSL =
                 Turbine.getConfiguration()
                 .getBoolean(TurbineConstants.USE_SSL_KEY,
                         TurbineConstants.USE_SSL_DEFAULT);
 
         setServerScheme(useSSL ? HTTPS : HTTP);
         setServerPort(port);
     }
 
     /**
      * Sets the scheme (HTTP or HTTPS).
      *
      * @param serverScheme A String with the scheme.
      */
     public void setServerScheme(String serverScheme)
     {
         serverData.setServerScheme(StringUtils.isNotEmpty(serverScheme)
                 ? serverScheme : "");
     }
 
     /**
      * Returns the current Server Scheme
      *
      * @return The current Server scheme
      *
      */
     @Override
     public String getServerScheme()
     {
         String serverScheme = serverData.getServerScheme();
 
         return StringUtils.isNotEmpty(serverScheme) ? serverScheme : HTTP;
     }
 
     /**
      * Sets a reference anchor (#ref).
      *
      * @param reference A String containing the reference.
      */
     public void setReference(String reference)
     {
         this.reference = reference;
     }
 
     /**
      * Returns the current reference anchor.
      *
      * @return A String containing the reference.
      */
     @Override
     public String getReference()
     {
         return hasReference() ? reference : "";
     }
 
     /**
      * Does this URI contain an anchor? (#ref)
      *
      * @return True if this URI contains an anchor.
      */
     public boolean hasReference()
     {
         return StringUtils.isNotEmpty(reference);
     }
 
     /*
      * ========================================================================
      *
      * Protected / Private Methods
      *
      * ========================================================================
      *
      */
 
     /**
      * Set a Response Object to use when creating the
      * response string.
      *
      * @param response the servlet response
      */
     protected void setResponse(HttpServletResponse response)
     {
         this.response = response;
     }
 
     /**
      * Returns the Response Object from the Servlet Container.
      *
      * @return The Servlet Response object or null
      *
      */
     protected HttpServletResponse getResponse()
     {
         return response;
     }
 
     /**
      * Append the Context Path and Script Name to the passed
      * String Buffer.
      *
      * <p>
      * This is a convenience method to be
      * used in the Link output routines of derived classes to
      * easily append the correct path.
      * </p>
      *
      * @param sb The StringBuilder to store context path and script name.
      */
     protected void getContextAndScript(StringBuilder sb)
     {
         String context = getContextPath();
 
         if(StringUtils.isNotEmpty(context))
         {
             if(context.charAt(0) != '/')
             {
                 sb.append('/');
             }
             sb.append (context);
         }
 
         // /servlet/turbine
         String script = getScriptName();
 
         if(StringUtils.isNotEmpty(script))
         {
             if(script.charAt(0) != '/')
             {
                 sb.append('/');
             }
             sb.append (script);
         }
     }
 
     /**
      * Appends Scheme, Server and optionally the port to the
      * supplied String Buffer.
      *
      * <p>
      * This is a convenience method to be
      * used in the Link output routines of derived classes to
      * easily append the correct server scheme.
      * </p>
      *
      * @param sb The StringBuilder to store the scheme and port information.
      */
     protected void getSchemeAndPort(StringBuilder sb)
     {
         // http(s)://<servername>
         sb.append(getServerScheme());
         sb.append(URIConstants.URI_SCHEME_SEPARATOR);
         sb.append(getServerName());
 
         // (:<port>)
         if ((getServerScheme().equals(HTTP)
                     && getServerPort() != HTTP_PORT)
                 || (getServerScheme().equals(HTTPS)
                         && getServerPort() != HTTPS_PORT))
         {
             sb.append(':');
             sb.append(getServerPort());
         }
     }
 
     /**
      * Encodes a Response Uri according to the Servlet Container.
      * This might add a Java session identifier or do redirection.
      * The resulting String can be used in a page or template.
      *
      * @param uri The Uri to encode
      *
      * @return An Uri encoded by the container.
      */
     protected String encodeResponse(String uri)
     {
         String res = uri;
 
         HttpServletResponse response = getResponse();
 
         if(response == null)
         {
             log.debug("No Response Object!");
         }
         else
         {
             try
             {
                 if(isRedirect())
                 {
                     log.debug("Should Redirect");
                     res = response.encodeRedirectURL(uri);
                 }
                 else
                 {
                     res = response.encodeURL(uri);
                 }
             }
             catch(Exception e)
             {
                 log.error("response" + response + ", uri: " + uri);
                 log.error("While trying to encode the URI: ", e);
             }
         }
 
         log.debug("encodeResponse():  " + res);
         return res;
     }
 }

1		package org.apache.turbine.util.uri;
2
3
4		/*
5		* Licensed to the Apache Software Foundation (ASF) under one
6		* or more contributor license agreements. See the NOTICE file
7		* distributed with this work for additional information
8		* regarding copyright ownership. The ASF licenses this file
9		* to you under the Apache License, Version 2.0 (the
10		* "License"); you may not use this file except in compliance
11		* with the License. You may obtain a copy of the License at
12		*
13		* http://www.apache.org/licenses/LICENSE-2.0
14		*
15		* Unless required by applicable law or agreed to in writing,
16		* software distributed under the License is distributed on an
17		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18		* KIND, either express or implied. See the License for the
19		* specific language governing permissions and limitations
20		* under the License.
21		*/
22
23
24		import javax.servlet.http.HttpServletResponse;
25
26		import org.apache.commons.lang3.StringUtils;
27		import org.apache.logging.log4j.LogManager;
28		import org.apache.logging.log4j.Logger;
29		import org.apache.turbine.Turbine;
30		import org.apache.turbine.TurbineConstants;
31		import org.apache.turbine.util.RunData;
32		import org.apache.turbine.util.ServerData;
33
34		/**
35		* This is the base class for all dynamic URIs in the Turbine System.
36		*
37		* All of the classes used for generating URIs are derived from this.
38		*
39		* @author <a href="mailto:jon@clearink.com">Jon S. Stevens</a>
40		* @author <a href="mailto:jvanzyl@periapt.com">Jason van Zyl</a>
41		* @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
42		* @author <a href="mailto:quintonm@bellsouth.net">Quinton McCombs</a>
43		* @version $Id: BaseURI.java 1854688 2019-03-03 10:36:42Z tv $
44		*/
45
46		public abstract class BaseURI
47		implements URI,
48		URIConstants
49		{
50		/** Logging */
51	12	private static final Logger log = LogManager.getLogger(BaseURI.class);
52
53		/** ServerData Object for scheme, name, port etc. */
54	69	private ServerData serverData =
55		new ServerData(null, HTTP_PORT, HTTP, null, null);
56
57		/** Whether we want to redirect or not. */
58	69	private boolean redirect = false;
59
60		/** Servlet response interface. */
61	69	private HttpServletResponse response = null;
62
63		/** Reference Anchor (#ref) */
64	69	private String reference = null;
65
66		/*
67		* ========================================================================
68		*
69		* Constructors
70		*
71		* ========================================================================
72		*
73		*/
74
75		/**
76		* Empty C'tor. Uses Turbine.getDefaultServerData().
77		*
78		*/
79		public BaseURI()
80	0	{
81	0	init(Turbine.getDefaultServerData());
82	0	setResponse(null);
83	0	}
84
85		/**
86		* Constructor with a RunData object
87		*
88		* @param runData A RunData object
89		*/
90		public BaseURI(RunData runData)
91	54	{
92	54	init(runData.getServerData());
93	54	setResponse(runData.getResponse());
94	54	}
95
96		/**
97		* Constructor, set explicit redirection
98		*
99		* @param runData A RunData object
100		* @param redirect True if redirection allowed.
101		*/
102		public BaseURI(RunData runData, boolean redirect)
103	0	{
104	0	init(runData.getServerData());
105	0	setResponse(runData.getResponse());
106	0	setRedirect(redirect);
107	0	}
108
109		/**
110		* Constructor with a ServerData object
111		*
112		* @param serverData A ServerData object
113		*/
114		public BaseURI(ServerData serverData)
115	15	{
116	15	init(serverData);
117	15	setResponse(null);
118	15	}
119
120		/**
121		* Constructor, set explicit redirection
122		*
123		* @param serverData A ServerData object
124		* @param redirect True if redirection allowed.
125		*/
126		public BaseURI(ServerData serverData, boolean redirect)
127	0	{
128	0	init(serverData);
129	0	setResponse(null);
130	0	setRedirect(redirect);
131	0	}
132
133		/*
134		* ========================================================================
135		*
136		* Init
137		*
138		* ========================================================================
139		*
140		*/
141
142		/**
143		* Init with a ServerData object
144		*
145		* @param serverData A ServerData object
146		*
147		*/
148		private void init(ServerData serverData)
149		{
150	69	log.debug("init({})", serverData);
151
152	69	if (serverData != null)
153		{
154		// We must clone this, because if BaseURI is used in a pull tool,
155		// then the fields might be changed. If we don't clone, this might pull
156		// through to the ServerData object saved at firstRequest() in the
157		// Turbine object.
158	69	this.serverData = (ServerData) serverData.clone();
159		}
160		else
161		{
162	0	log.error("Passed null ServerData object!");
163		}
164	69	reference = null;
165	69	}
166
167		/*
168		* ========================================================================
169		*
170		* Getter / Setter
171		*
172		* ========================================================================
173		*
174		*/
175
176		/**
177		* Set the redirect Flag
178		*
179		* @param redirect The new value of the redirect flag.
180		*/
181		public void setRedirect(boolean redirect)
182		{
183	0	this.redirect = redirect;
184	0	}
185
186		/**
187		* Returns the current value of the Redirect flag
188		*
189		* @return True if Redirect is allowed
190		*
191		*/
192		public boolean isRedirect()
193		{
194	0	return redirect;
195		}
196
197		/**
198		* Gets the script name (/servlets/Turbine).
199		*
200		* @return A String with the script name.
201		*/
202		@Override
203		public String getScriptName()
204		{
205	42	return serverData.getScriptName();
206		}
207
208		/**
209		* Sets the script name (/servlets/Turbine).
210		*
211		* @param scriptName A String with the script name.
212		*/
213		public void setScriptName(String scriptName)
214		{
215	0	serverData.setScriptName(scriptName);
216	0	}
217
218		/**
219		* Gets the context path.
220		*
221		* @return A String with the context path.
222		*/
223		@Override
224		public String getContextPath()
225		{
226	42	return serverData.getContextPath();
227		}
228
229		/**
230		* Sets the context path.
231		*
232		* @param contextPath A String with the context path
233		*/
234		public void setContextPath(String contextPath)
235		{
236	0	serverData.setContextPath(contextPath);
237	0	}
238
239		/**
240		* Gets the server name.
241		*
242		* @return A String with the server name.
243		*/
244		@Override
245		public String getServerName()
246		{
247	0	return serverData.getServerName();
248		}
249
250		/**
251		* Sets the server name.
252		*
253		* @param serverName A String with the server name.
254		*/
255		public void setServerName(String serverName)
256		{
257	0	serverData.setServerName(serverName);
258	0	}
259
260		/**
261		* Gets the server port.
262		*
263		* @return A String with the server port.
264		*/
265		@Override
266		public int getServerPort()
267		{
268	0	int serverPort = serverData.getServerPort();
269
270	0	if (serverPort == 0)
271		{
272	0	if(getServerScheme().equals(HTTPS))
273		{
274	0	serverPort = HTTPS_PORT;
275		}
276		else
277		{
278	0	serverPort = HTTP_PORT;
279		}
280		}
281	0	return serverPort;
282		}
283
284		/**
285		* Sets the server port.
286		*
287		* @param serverPort An int with the port.
288		*/
289		public void setServerPort(int serverPort)
290		{
291	0	serverData.setServerPort(serverPort);
292	0	}
293
294		/**
295		* Method to specify that a URI should use SSL. The default port
296		* is used.
297		*/
298		public void setSecure()
299		{
300	0	setSecure(HTTPS_PORT);
301	0	}
302
303		/**
304		* Method to specify that a URI should use SSL.
305		* Whether or not it does is determined from Turbine.properties.
306		* If use.ssl in the Turbine.properties is set to false, then
307		* http is used in any case. (Default of use.ssl is true).
308		*
309		* @param port An int with the port number.
310		*/
311		public void setSecure(int port)
312		{
313		boolean useSSL =
314	0	Turbine.getConfiguration()
315	0	.getBoolean(TurbineConstants.USE_SSL_KEY,
316		TurbineConstants.USE_SSL_DEFAULT);
317
318	0	setServerScheme(useSSL ? HTTPS : HTTP);
319	0	setServerPort(port);
320	0	}
321
322		/**
323		* Sets the scheme (HTTP or HTTPS).
324		*
325		* @param serverScheme A String with the scheme.
326		*/
327		public void setServerScheme(String serverScheme)
328		{
329	0	serverData.setServerScheme(StringUtils.isNotEmpty(serverScheme)
330		? serverScheme : "");
331	0	}
332
333		/**
334		* Returns the current Server Scheme
335		*
336		* @return The current Server scheme
337		*
338		*/
339		@Override
340		public String getServerScheme()
341		{
342	0	String serverScheme = serverData.getServerScheme();
343
344	0	return StringUtils.isNotEmpty(serverScheme) ? serverScheme : HTTP;
345		}
346
347		/**
348		* Sets a reference anchor (#ref).
349		*
350		* @param reference A String containing the reference.
351		*/
352		public void setReference(String reference)
353		{
354	0	this.reference = reference;
355	0	}
356
357		/**
358		* Returns the current reference anchor.
359		*
360		* @return A String containing the reference.
361		*/
362		@Override
363		public String getReference()
364		{
365	0	return hasReference() ? reference : "";
366		}
367
368		/**
369		* Does this URI contain an anchor? (#ref)
370		*
371		* @return True if this URI contains an anchor.
372		*/
373		public boolean hasReference()
374		{
375	42	return StringUtils.isNotEmpty(reference);
376		}
377
378		/*
379		* ========================================================================
380		*
381		* Protected / Private Methods
382		*
383		* ========================================================================
384		*
385		*/
386
387		/**
388		* Set a Response Object to use when creating the
389		* response string.
390		*
391		* @param response the servlet response
392		*/
393		protected void setResponse(HttpServletResponse response)
394		{
395	96	this.response = response;
396	96	}
397
398		/**
399		* Returns the Response Object from the Servlet Container.
400		*
401		* @return The Servlet Response object or null
402		*
403		*/
404		protected HttpServletResponse getResponse()
405		{
406	42	return response;
407		}
408
409		/**
410		* Append the Context Path and Script Name to the passed
411		* String Buffer.
412		*
413		* <p>
414		* This is a convenience method to be
415		* used in the Link output routines of derived classes to
416		* easily append the correct path.
417		* </p>
418		*
419		* @param sb The StringBuilder to store context path and script name.
420		*/
421		protected void getContextAndScript(StringBuilder sb)
422		{
423	42	String context = getContextPath();
424
425	42	if(StringUtils.isNotEmpty(context))
426		{
427	42	if(context.charAt(0) != '/')
428		{
429	0	sb.append('/');
430		}
431	42	sb.append (context);
432		}
433
434		// /servlet/turbine
435	42	String script = getScriptName();
436
437	42	if(StringUtils.isNotEmpty(script))
438		{
439	42	if(script.charAt(0) != '/')
440		{
441	0	sb.append('/');
442		}
443	42	sb.append (script);
444		}
445	42	}
446
447		/**
448		* Appends Scheme, Server and optionally the port to the
449		* supplied String Buffer.
450		*
451		* <p>
452		* This is a convenience method to be
453		* used in the Link output routines of derived classes to
454		* easily append the correct server scheme.
455		* </p>
456		*
457		* @param sb The StringBuilder to store the scheme and port information.
458		*/
459		protected void getSchemeAndPort(StringBuilder sb)
460		{
461		// http(s)://<servername>
462	0	sb.append(getServerScheme());
463	0	sb.append(URIConstants.URI_SCHEME_SEPARATOR);
464	0	sb.append(getServerName());
465
466		// (:<port>)
467	0	if ((getServerScheme().equals(HTTP)
468	0	&& getServerPort() != HTTP_PORT)
469	0	\|\| (getServerScheme().equals(HTTPS)
470	0	&& getServerPort() != HTTPS_PORT))
471		{
472	0	sb.append(':');
473	0	sb.append(getServerPort());
474		}
475	0	}
476
477		/**
478		* Encodes a Response Uri according to the Servlet Container.
479		* This might add a Java session identifier or do redirection.
480		* The resulting String can be used in a page or template.
481		*
482		* @param uri The Uri to encode
483		*
484		* @return An Uri encoded by the container.
485		*/
486		protected String encodeResponse(String uri)
487		{
488	42	String res = uri;
489
490	42	HttpServletResponse response = getResponse();
491
492	42	if(response == null)
493		{
494	42	log.debug("No Response Object!");
495		}
496		else
497		{
498		try
499		{
500	0	if(isRedirect())
501		{
502	0	log.debug("Should Redirect");
503	0	res = response.encodeRedirectURL(uri);
504		}
505		else
506		{
507	0	res = response.encodeURL(uri);
508		}
509		}
510	0	catch(Exception e)
511		{
512	0	log.error("response" + response + ", uri: " + uri);
513	0	log.error("While trying to encode the URI: ", e);
514	0	}
515		}
516
517	42	log.debug("encodeResponse(): " + res);
518	42	return res;
519		}
520		}