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 2020/03/21 17:04:21 UTC
[jspwiki] 19/36: use Context instead of WikiContext
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 2f68a41f3359222ad8c5ee717f0c61a828746b91
Author: juanpablo <ju...@apache.org>
AuthorDate: Sat Mar 21 14:11:46 2020 +0100
use Context instead of WikiContext
---
.../org/apache/wiki/auth/DefaultUserManager.java | 6 +--
.../java/org/apache/wiki/auth/UserManager.java | 6 +--
.../org/apache/wiki/ui/GenericHTTPHandler.java | 7 +--
.../java/org/apache/wiki/ui/InputValidator.java | 31 ++++++------
.../org/apache/wiki/ui/admin/SimpleAdminBean.java | 6 +--
.../apache/wiki/ui/admin/WikiFormAdminBean.java | 35 ++++++--------
.../org/apache/wiki/ui/admin/beans/ModuleBean.java | 3 +-
.../wiki/ui/admin/beans/PlainEditorAdminBean.java | 55 +++++++++-------------
.../wiki/ui/admin/beans/SearchManagerBean.java | 6 +--
.../org/apache/wiki/ui/admin/beans/UserBean.java | 4 +-
10 files changed, 71 insertions(+), 88 deletions(-)
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/auth/DefaultUserManager.java b/jspwiki-main/src/main/java/org/apache/wiki/auth/DefaultUserManager.java
index 0b8db6f..776f741 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/auth/DefaultUserManager.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/auth/DefaultUserManager.java
@@ -20,10 +20,10 @@ package org.apache.wiki.auth;
import org.apache.commons.lang3.StringUtils;
import org.apache.log4j.Logger;
-import org.apache.wiki.WikiContext;
import org.apache.wiki.ajax.AjaxUtil;
import org.apache.wiki.ajax.WikiAjaxDispatcherServlet;
import org.apache.wiki.ajax.WikiAjaxServlet;
+import org.apache.wiki.api.core.Context;
import org.apache.wiki.api.core.Engine;
import org.apache.wiki.api.core.Session;
import org.apache.wiki.api.exceptions.NoRequiredPropertyException;
@@ -285,7 +285,7 @@ public class DefaultUserManager implements UserManager {
/** {@inheritDoc} */
@Override
- public UserProfile parseProfile( final WikiContext context ) {
+ public UserProfile parseProfile( final Context context ) {
// Retrieve the user's profile (may have been previously cached)
final UserProfile profile = getUserProfile( context.getWikiSession() );
final HttpServletRequest request = context.getHttpRequest();
@@ -315,7 +315,7 @@ public class DefaultUserManager implements UserManager {
/** {@inheritDoc} */
@Override
- public void validateProfile( final WikiContext context, final UserProfile profile ) {
+ public void validateProfile( final Context context, final UserProfile profile ) {
final boolean isNew = profile.isNew();
final Session session = context.getWikiSession();
final InputValidator validator = new InputValidator( SESSION_MESSAGES, context );
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/auth/UserManager.java b/jspwiki-main/src/main/java/org/apache/wiki/auth/UserManager.java
index fc62bb1..266cbe4 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/auth/UserManager.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/auth/UserManager.java
@@ -18,7 +18,7 @@
*/
package org.apache.wiki.auth;
-import org.apache.wiki.WikiContext;
+import org.apache.wiki.api.core.Context;
import org.apache.wiki.api.core.Engine;
import org.apache.wiki.api.core.Session;
import org.apache.wiki.api.exceptions.WikiException;
@@ -131,7 +131,7 @@ public interface UserManager {
* @param context the current wiki context
* @return a new, populated user profile
*/
- UserProfile parseProfile( WikiContext context );
+ UserProfile parseProfile( Context context );
/**
* Validates a user profile, and appends any errors to the session errors list. If the profile is new, the password will be checked to
@@ -143,7 +143,7 @@ public interface UserManager {
* @param context the current wiki context
* @param profile the supplied UserProfile
*/
- void validateProfile( WikiContext context, UserProfile profile );
+ void validateProfile( Context context, UserProfile profile );
/**
* A helper method for returning all of the known WikiNames in this system.
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/ui/GenericHTTPHandler.java b/jspwiki-main/src/main/java/org/apache/wiki/ui/GenericHTTPHandler.java
index f6b3abe..21d3c93 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/ui/GenericHTTPHandler.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/ui/GenericHTTPHandler.java
@@ -18,7 +18,8 @@
*/
package org.apache.wiki.ui;
-import org.apache.wiki.WikiContext;
+import org.apache.wiki.api.core.Context;
+
/**
* Provides a generic HTTP handler interface.
@@ -39,13 +40,13 @@ public interface GenericHTTPHandler {
* @param context associated WikiContext
* @return the HTML for the bean
*/
- String doGet( WikiContext context );
+ String doGet( Context context );
/**
* Handles a POST response.
* @param context associated WikiContext
* @return the response string resulting from the POST
*/
- String doPost( WikiContext context );
+ String doPost( Context context );
}
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/ui/InputValidator.java b/jspwiki-main/src/main/java/org/apache/wiki/ui/InputValidator.java
index 13aa834..8d0f5a4 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/ui/InputValidator.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/ui/InputValidator.java
@@ -18,7 +18,7 @@
*/
package org.apache.wiki.ui;
-import org.apache.wiki.WikiContext;
+import org.apache.wiki.api.core.Context;
import org.apache.wiki.api.core.Session;
import org.apache.wiki.i18n.InternationalizationManager;
import org.apache.wiki.preferences.Preferences;
@@ -36,28 +36,25 @@ import java.util.regex.Pattern;
* @since 2.3.54
*/
public final class InputValidator {
- /** Standard input validator. */
- public static final int STANDARD = 0;
+ /** Standard input validator. */
+ public static final int STANDARD = 0;
/** Input validator for e-mail addresses. **/
- public static final int EMAIL = 1;
-
+ public static final int EMAIL = 1;
/** @since 2.4.82 */
- public static final int ID = 2;
+ public static final int ID = 2;
+ /**
+ * Used when checking against IDs such as a full name when saving groups.
+ * @since 2.4.82
+ */
+ protected static final Pattern ID_PATTERN = Pattern.compile( "[\\x00\\r\\n\\x0f\"'<>;&\\xff{}]" );
protected static final Pattern EMAIL_PATTERN = Pattern.compile( "^[0-9a-zA-Z-_\\.\\+]+@([0-9a-zA-Z-_]+\\.)+[a-zA-Z]+$" );
-
protected static final Pattern UNSAFE_PATTERN = Pattern.compile( "[\\x00\\r\\n\\x0f\"':<>\\[\\];#&@\\xff{}\\$%\\\\]" );
- /** Used when checking against IDs such as a full name when saving groups.
- * @since 2.4.82 */
- protected static final Pattern ID_PATTERN = Pattern.compile( "[\\x00\\r\\n\\x0f\"'<>;&\\xff{}]" );
-
- private final String m_form;
-
- private final Session m_session;
-
- private final WikiContext m_context;
+ private final String m_form;
+ private final Session m_session;
+ private final Context m_context;
/**
* Constructs a new input validator for a specific form and wiki session. When validation errors are detected, they will be added to
@@ -66,7 +63,7 @@ public final class InputValidator {
* @param form the ID or name of the form this validator should be associated with
* @param context the wiki context
*/
- public InputValidator( final String form, final WikiContext context ) {
+ public InputValidator( final String form, final Context context ) {
m_form = form;
m_context = context;
m_session = context.getWikiSession();
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/SimpleAdminBean.java b/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/SimpleAdminBean.java
index 95faf07..0a065fd 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/SimpleAdminBean.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/SimpleAdminBean.java
@@ -19,7 +19,7 @@
package org.apache.wiki.ui.admin;
import org.apache.commons.lang3.StringUtils;
-import org.apache.wiki.WikiContext;
+import org.apache.wiki.api.core.Context;
import org.apache.wiki.api.core.Engine;
import org.apache.wiki.management.SimpleMBean;
@@ -65,7 +65,7 @@ public abstract class SimpleAdminBean extends SimpleMBean implements AdminBean {
* The value is determined by the toString() method of the attribute.
*/
@Override
- public String doGet( final WikiContext context ) {
+ public String doGet( final Context context ) {
final MBeanInfo info = getMBeanInfo();
final MBeanAttributeInfo[] attributes = info.getAttributes();
final StringBuilder sb = new StringBuilder();
@@ -97,7 +97,7 @@ public abstract class SimpleAdminBean extends SimpleMBean implements AdminBean {
* Not implemented yet.
*/
@Override
- public String doPost( final WikiContext context) {
+ public String doPost( final Context context) {
return null;
}
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/WikiFormAdminBean.java b/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/WikiFormAdminBean.java
index 3ca2668..533d612 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/WikiFormAdminBean.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/WikiFormAdminBean.java
@@ -18,7 +18,7 @@
*/
package org.apache.wiki.ui.admin;
-import org.apache.wiki.WikiContext;
+import org.apache.wiki.api.core.Context;
import org.apache.wiki.parser.WikiDocument;
import org.apache.wiki.render.RenderingManager;
@@ -31,29 +31,22 @@ import java.util.Map;
* This class is still experimental.
*
*/
-public abstract class WikiFormAdminBean
- implements AdminBean
-{
- public abstract String getForm( WikiContext context );
+public abstract class WikiFormAdminBean implements AdminBean {
+
+ public abstract String getForm( Context context );
- public abstract void handleResponse( WikiContext context, Map< ?, ? > params );
+ public abstract void handleResponse( Context context, Map< ?, ? > params );
- @Override public String doGet( final WikiContext context)
- {
+ @Override
+ public String doGet( final Context context ) {
String result = "";
-
- final String wikiMarkup = getForm(context);
-
+ final String wikiMarkup = getForm( context );
final RenderingManager mgr = context.getEngine().getManager( RenderingManager.class );
-
final WikiDocument doc;
- try
- {
+ try {
doc = mgr.getParser( context, wikiMarkup ).parse();
- result = mgr.getHTML(context, doc);
- }
- catch ( final IOException e)
- {
+ result = mgr.getHTML( context, doc );
+ } catch( final IOException e ) {
// TODO Auto-generated catch block
e.printStackTrace();
}
@@ -61,9 +54,9 @@ public abstract class WikiFormAdminBean
return result;
}
- public String handlePost( final WikiContext context, final HttpServletRequest req, final HttpServletResponse resp)
- {
- return null;
+ public String handlePost( final Context context, final HttpServletRequest req, final HttpServletResponse resp ) {
// FIXME: Not yet implemented
+ return null;
}
+
}
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/ModuleBean.java b/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/ModuleBean.java
index 9266d1e..7a0ad84 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/ModuleBean.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/ModuleBean.java
@@ -21,6 +21,7 @@ package org.apache.wiki.ui.admin.beans;
import org.apache.commons.lang3.StringUtils;
import org.apache.wiki.WikiContext;
import org.apache.wiki.api.Release;
+import org.apache.wiki.api.core.Context;
import org.apache.wiki.api.core.Engine;
import org.apache.wiki.modules.WikiModuleInfo;
import org.apache.wiki.ui.admin.SimpleAdminBean;
@@ -59,7 +60,7 @@ public abstract class ModuleBean extends SimpleAdminBean {
* {@inheritDoc}
*/
@Override
- public String doGet( final WikiContext context ) {
+ public String doGet( final Context context ) {
final Collection< WikiModuleInfo > filters = modules();
final Element root = title();
final Element tb = containerForModuleDetail( root );
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/PlainEditorAdminBean.java b/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/PlainEditorAdminBean.java
index 0ac1d9b..d6d8f14 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/PlainEditorAdminBean.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/PlainEditorAdminBean.java
@@ -18,7 +18,7 @@
*/
package org.apache.wiki.ui.admin.beans;
-import org.apache.wiki.WikiContext;
+import org.apache.wiki.api.core.Context;
import org.apache.wiki.api.core.Engine;
import org.apache.wiki.management.SimpleMBean;
import org.apache.wiki.ui.admin.AdminBean;
@@ -48,74 +48,65 @@ public class PlainEditorAdminBean extends SimpleMBean implements AdminBean {
public PlainEditorAdminBean() throws NotCompliantMBeanException {
}
- @Override public String doGet( final WikiContext context)
- {
+ @Override
+ public String doGet( final Context context) {
final HttpServletRequest req = context.getHttpRequest();
-
- if( req != null && req.getMethod().equals("POST") && getTitle().equals( req.getParameter("form") ) )
- {
+ if( req != null && req.getMethod().equals("POST") && getTitle().equals( req.getParameter("form") ) ) {
return doPost( context );
}
String base = TEMPLATE;
-
base = TextUtil.replaceString( base, "%checked", "checked='checked'" );
base = TextUtil.replaceString( base, "%messages", "" );
-
return base;
}
- @Override public String doPost( final WikiContext context )
- {
+ @Override
+ public String doPost( final Context context ) {
final HttpServletRequest req = context.getHttpRequest();
-
final boolean checked = "checked".equals( req.getParameter( "id" ) );
// Make changes
-
String base = TEMPLATE;
-
base = TextUtil.replaceString( base, "%checked", checked ? "checked='checked'" : "" );
base = TextUtil.replaceString( base, "%messages", "<br /><font color='red'>Your settings have been saved</font>" );
-
return base;
}
-
- @Override public String getTitle()
- {
+
+ @Override
+ public String getTitle() {
return "Plain editor";
}
- @Override public int getType()
- {
+ @Override
+ public int getType() {
return EDITOR;
}
- public boolean isEnabled()
- {
+ public boolean isEnabled() {
return true;
}
- @Override public String getId()
- {
+ @Override
+ public String getId() {
return "editor.plain";
}
-
- public boolean getChecked()
- {
+
+ public boolean getChecked() {
return m_checked;
}
-
- @Override public String[] getAttributeNames()
- {
+
+ @Override
+ public String[] getAttributeNames() {
return ATTRIBUTES;
}
- @Override public String[] getMethodNames()
- {
+ @Override
+ public String[] getMethodNames() {
return METHODS;
}
- @Override public void initialize( final Engine engine ) {
+ @Override
+ public void initialize( final Engine engine ) {
}
}
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/SearchManagerBean.java b/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/SearchManagerBean.java
index fd7f22e..f345ae2 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/SearchManagerBean.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/SearchManagerBean.java
@@ -19,7 +19,7 @@
package org.apache.wiki.ui.admin.beans;
import org.apache.wiki.WikiBackgroundThread;
-import org.apache.wiki.WikiContext;
+import org.apache.wiki.api.core.Context;
import org.apache.wiki.api.core.Engine;
import org.apache.wiki.api.core.Page;
import org.apache.wiki.pages.PageManager;
@@ -126,7 +126,7 @@ public class SearchManagerBean extends SimpleAdminBean {
}
@Override
- public String doGet( final WikiContext context ) {
+ public String doGet( final Context context ) {
if( m_updater != null ) {
return "Update already in progress ("+ context.getEngine().getManager( ProgressManager.class ).getProgress(PROGRESS_ID)+ "%)";
}
@@ -136,7 +136,7 @@ public class SearchManagerBean extends SimpleAdminBean {
}
@Override
- public String doPost( final WikiContext context ) {
+ public String doPost( final Context context ) {
final String val = context.getHttpParameter( "searchmanagerbean-reload" );
if( val != null ) {
reload();
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/UserBean.java b/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/UserBean.java
index 3574ba1..a7bfa05 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/UserBean.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/beans/UserBean.java
@@ -18,7 +18,7 @@
*/
package org.apache.wiki.ui.admin.beans;
-import org.apache.wiki.WikiContext;
+import org.apache.wiki.api.core.Context;
import org.apache.wiki.api.core.Engine;
import org.apache.wiki.api.core.Session;
import org.apache.wiki.auth.NoSuchPrincipalException;
@@ -53,7 +53,7 @@ public class UserBean extends SimpleAdminBean {
}
@Override
- public String doPost( final WikiContext context ) {
+ public String doPost( final Context context ) {
final HttpServletRequest request = context.getHttpRequest();
final Session session = context.getWikiSession();
final UserManager mgr = context.getEngine().getManager( UserManager.class );