You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jspwiki.apache.org by ju...@apache.org on 2019/08/19 20:17:15 UTC
[jspwiki] 16/24: removal of @deprecated code (12) - WikiEngine: *
removed WikiEngine.getEditURL -> use instead WikiEngine#getURL(String,
String, String, boolean) or WikiContext#getURL(String,
String) * removed WikiEngine.getAttachmentURL -> use instead
WikiEngine#getURL(String, String, String,
boolean) or WikiContext#getURL(String,
String) * removed WikiEngine.safeGetParameter -> no replacement,
no longer necessary
This is an automated email from the ASF dual-hosted git repository.
juanpablo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jspwiki.git
commit 9e9ec9fdcd3b5aa16c9a3643527c4a03db96cb95
Author: juanpablo <ju...@apache.org>
AuthorDate: Sun Aug 18 19:10:54 2019 +0200
removal of @deprecated code (12) - WikiEngine:
* removed WikiEngine.getEditURL -> use instead WikiEngine#getURL(String, String, String, boolean) or WikiContext#getURL(String, String)
* removed WikiEngine.getAttachmentURL -> use instead WikiEngine#getURL(String, String, String, boolean) or WikiContext#getURL(String, String)
* removed WikiEngine.safeGetParameter -> no replacement, no longer necessary
---
.../src/main/java/org/apache/wiki/WikiContext.java | 20 ++-
.../src/main/java/org/apache/wiki/WikiEngine.java | 149 ++++-----------------
2 files changed, 32 insertions(+), 137 deletions(-)
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/WikiContext.java b/jspwiki-main/src/main/java/org/apache/wiki/WikiContext.java
index c443e21..503ac22 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/WikiContext.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/WikiContext.java
@@ -64,9 +64,8 @@ import java.util.PropertyPermission;
* @see org.apache.wiki.plugin.Counter
*
*/
-public class WikiContext
- implements Cloneable, Command
-{
+public class WikiContext implements Cloneable, Command {
+
private Command m_command = null;
private WikiPage m_page;
@@ -600,7 +599,7 @@ public class WikiContext
* @param page The page to which to link
* @return An URL to the page, honours the absolute/relative setting in jspwiki.properties
*/
- public String getURL( String context, String page ) {
+ public String getURL( final String context, final String page ) {
return getURL( context, page, null );
}
@@ -615,8 +614,8 @@ public class WikiContext
*
* @return An URL to the given context and page.
*/
- public String getURL( String context, String page, String params ) {
- boolean absolute = "absolute".equals(m_engine.getVariable( this, WikiEngine.PROP_REFSTYLE ));
+ public String getURL( final String context, final String page, final String params ) {
+ final boolean absolute = "absolute".equals(m_engine.getVariable( this, WikiEngine.PROP_REFSTYLE ));
// FIXME: is rather slow
return m_engine.getURL( context, page, params, absolute );
@@ -638,10 +637,8 @@ public class WikiContext
* @return A shallow clone of the WikiContext
*/
@Override
- public Object clone()
- {
- try
- {
+ public Object clone() {
+ try {
// super.clone() must always be called to make sure that inherited objects
// get the right type
WikiContext copy = (WikiContext)super.clone();
@@ -656,8 +653,7 @@ public class WikiContext
copy.m_page = m_page;
copy.m_realPage = m_realPage;
return copy;
- }
- catch( CloneNotSupportedException e ){} // Never happens
+ } catch( CloneNotSupportedException e ){} // Never happens
return null;
}
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java b/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java
index 286bb7d..fad91ec 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java
@@ -74,7 +74,6 @@ import org.apache.wiki.workflow.WorkflowManager;
import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
-import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import java.io.File;
import java.io.IOException;
@@ -788,22 +787,16 @@ public class WikiEngine
* @since 1.6.1
* @return The Base URL.
*/
-
- public String getBaseURL()
- {
- String contextPath = m_servletContext.getContextPath();
-
- return contextPath;
+ public String getBaseURL() {
+ return m_servletContext.getContextPath();
}
-
/**
* Returns the moment when this engine was started.
*
* @since 2.0.15.
* @return The start time of this wiki.
*/
-
public Date getStartTime()
{
return (Date)m_startTime.clone();
@@ -822,49 +815,11 @@ public class WikiEngine
* @param pageName The name of the page. May be null, in which case defaults to the front page.
* @return An absolute URL to the page.
*/
- public String getViewURL( String pageName )
- {
- if( pageName == null )
- {
+ public String getViewURL( String pageName ) {
+ if( pageName == null ) {
pageName = getFrontPage();
}
- return getURLConstructor().makeURL(WikiContext.VIEW, pageName, "absolute".equals(PROP_REFSTYLE), null);
- }
-
- /**
- * Returns the basic URL to an editor. Please use WikiContext.getURL() or
- * WikiEngine.getURL() instead.
- *
- * @see #getURL(String, String, String, boolean)
- * @see WikiContext#getURL(String, String)
- * @deprecated
- *
- * @param pageName The name of the page.
- * @return An URI.
- *
- * @since 2.0.3
- */
- @Deprecated
- public String getEditURL( String pageName )
- {
- return m_urlConstructor.makeURL( WikiContext.EDIT, pageName, false, null );
- }
-
- /**
- * Returns the basic attachment URL.Please use WikiContext.getURL() or
- * WikiEngine.getURL() instead.
- *
- * @see #getURL(String, String, String, boolean)
- * @see WikiContext#getURL(String, String)
- * @since 2.0.42.
- * @param attName Attachment name
- * @deprecated
- * @return An URI.
- */
- @Deprecated
- public String getAttachmentURL( String attName )
- {
- return m_urlConstructor.makeURL( WikiContext.ATTACH, attName, false, null );
+ return getURLConstructor().makeURL( WikiContext.VIEW, pageName, "absolute".equals( PROP_REFSTYLE ), null );
}
/**
@@ -876,9 +831,10 @@ public class WikiEngine
* @param absolute If true, will generate an absolute URL regardless of properties setting.
* @return An URL (absolute or relative).
*/
- public String getURL( String context, String pageName, String params, boolean absolute )
- {
- if( pageName == null ) pageName = getFrontPage();
+ public String getURL( final String context, String pageName, final String params, final boolean absolute ) {
+ if( pageName == null ) {
+ pageName = getFrontPage();
+ }
return m_urlConstructor.makeURL( context, pageName, absolute, params );
}
@@ -908,49 +864,6 @@ public class WikiEngine
}
/**
- * This is a safe version of the Servlet.Request.getParameter() routine.
- * Unfortunately, the default version always assumes that the incoming
- * character set is ISO-8859-1, even though it was something else.
- * This means that we need to make a new string using the correct
- * encoding.
- * <P>
- * For more information, see:
- * <A HREF="http://www.jguru.com/faq/view.jsp?EID=137049">JGuru FAQ</A>.
- * <P>
- * Incidentally, this is almost the same as encodeName(), below.
- * I am not yet entirely sure if it's safe to merge the code.
- *
- * @param request The servlet request
- * @param name The parameter name to get.
- * @return The parameter value or null
- * @since 1.5.3
- * @deprecated JSPWiki now requires servlet API 2.3, which has a better
- * way of dealing with this stuff. This will be removed in
- * the near future.
- */
-
- @Deprecated
- public String safeGetParameter( ServletRequest request, String name )
- {
- try
- {
- String res = request.getParameter( name );
- if( res != null )
- {
- res = new String(res.getBytes( StandardCharsets.ISO_8859_1), getContentEncoding() );
- }
-
- return res;
- }
- catch( UnsupportedEncodingException e )
- {
- log.fatal( "Unsupported encoding", e );
- return "";
- }
-
- }
-
- /**
* Returns the query string (the portion after the question mark).
*
* @param request The HTTP request to parse.
@@ -959,33 +872,25 @@ public class WikiEngine
*
* @since 2.1.3
*/
- public String safeGetQueryString( HttpServletRequest request )
- {
- if (request == null)
- {
+ public String safeGetQueryString( final HttpServletRequest request ) {
+ if (request == null) {
return "";
}
- try
- {
+ try {
String res = request.getQueryString();
- if( res != null )
- {
- res = new String(res.getBytes("ISO-8859-1"),
- getContentEncoding() );
+ if( res != null ) {
+ res = new String( res.getBytes( StandardCharsets.ISO_8859_1 ), getContentEncoding() );
//
// Ensure that the 'page=xyz' attribute is removed
- // FIXME: Is it really the mandate of this routine to
- // do that?
+ // FIXME: Is it really the mandate of this routine to do that?
//
- int pos1 = res.indexOf("page=");
- if (pos1 >= 0)
- {
- String tmpRes = res.substring(0, pos1);
- int pos2 = res.indexOf("&",pos1) + 1;
- if ( (pos2 > 0) && (pos2 < res.length()) )
- {
+ final int pos1 = res.indexOf("page=");
+ if( pos1 >= 0 ) {
+ String tmpRes = res.substring( 0, pos1 );
+ final int pos2 = res.indexOf( "&",pos1 ) + 1;
+ if ( ( pos2 > 0 ) && ( pos2 < res.length() ) ) {
tmpRes = tmpRes + res.substring(pos2);
}
res = tmpRes;
@@ -993,9 +898,7 @@ public class WikiEngine
}
return res;
- }
- catch( UnsupportedEncodingException e )
- {
+ } catch( UnsupportedEncodingException e ) {
log.fatal( "Unsupported encoding", e );
return "";
}
@@ -1293,14 +1196,10 @@ public class WikiEngine
* @return A decoded string.
* @see #encodeName(String)
*/
- public String decodeName( String pagerequest )
- {
- try
- {
+ public String decodeName( final String pagerequest ) {
+ try {
return URLDecoder.decode( pagerequest, m_useUTF8 ? "UTF-8" : "ISO-8859-1" );
- }
- catch( UnsupportedEncodingException e )
- {
+ } catch( UnsupportedEncodingException e ) {
throw new InternalWikiException("ISO-8859-1 not a supported encoding!?! Your platform is borked.", e);
}
}