001/* 
002    Licensed to the Apache Software Foundation (ASF) under one
003    or more contributor license agreements.  See the NOTICE file
004    distributed with this work for additional information
005    regarding copyright ownership.  The ASF licenses this file
006    to you under the Apache License, Version 2.0 (the
007    "License"); you may not use this file except in compliance
008    with the License.  You may obtain a copy of the License at
009
010       http://www.apache.org/licenses/LICENSE-2.0
011
012    Unless required by applicable law or agreed to in writing,
013    software distributed under the License is distributed on an
014    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015    KIND, either express or implied.  See the License for the
016    specific language governing permissions and limitations
017    under the License.  
018 */
019package org.apache.wiki.url;
020
021import org.apache.logging.log4j.LogManager;
022import org.apache.logging.log4j.Logger;
023import org.apache.wiki.InternalWikiException;
024import org.apache.wiki.api.core.ContextEnum;
025import org.apache.wiki.api.core.Engine;
026import org.apache.wiki.util.TextUtil;
027
028import jakarta.servlet.http.HttpServletRequest;
029import java.nio.charset.Charset;
030import java.util.Properties;
031import org.apache.wiki.security.AuditLogger;
032
033
034/**
035 *  Provides a way to do short URLs of the form /wiki/PageName.
036 *
037 *  @since 2.2
038 */
039public class ShortURLConstructor extends DefaultURLConstructor {
040    
041    private static final String DEFAULT_PREFIX = "wiki/";
042    private static final Logger LOG = LogManager.getLogger( ShortURLConstructor.class );
043    
044    /** Contains the path part after the JSPWiki base URL */
045    protected String m_urlPrefix = "";
046    
047    /**
048     *  This corresponds to your WikiServlet path.  By default, it is assumed to be "wiki/", but you can set it to whatever you
049     *  like - including an empty name.
050     */
051    public static final String PROP_PREFIX = "jspwiki.shortURLConstructor.prefix";
052    
053    /** {@inheritDoc} */
054    @Override
055    public void initialize( final Engine engine, final Properties properties ) {
056        super.initialize( engine, properties );
057        
058        m_urlPrefix = TextUtil.getStringProperty( properties, PROP_PREFIX, null );
059        
060        if( m_urlPrefix == null ) {
061            m_urlPrefix = DEFAULT_PREFIX;
062        }
063
064        LOG.info("Short URL prefix path="+m_urlPrefix+" (You can use "+PROP_PREFIX+" to override this)");
065    }
066
067    /**
068     *  Constructs the actual URL based on the context.
069     */
070    private String makeURL( final String context, final String name ) {
071        final String viewurl = "%p" + m_urlPrefix + "%n";
072
073        if( context.equals( ContextEnum.PAGE_VIEW.getRequestContext() ) ) {
074            if( name == null ) {
075                return doReplacement("%u","" );
076            }
077            return doReplacement( viewurl, name );
078        } else if( context.equals( ContextEnum.PAGE_PREVIEW.getRequestContext() ) ) {
079            if( name == null ) {
080                return doReplacement("%u","" );
081            }
082            return doReplacement( viewurl + "?do=Preview", name );
083        } else if( context.equals( ContextEnum.PAGE_EDIT.getRequestContext() ) ) {
084            return doReplacement( viewurl + "?do=Edit", name );
085        } else if( context.equals( ContextEnum.PAGE_ATTACH.getRequestContext() ) ) {
086            return doReplacement( "%uattach/%n", name );
087        } else if( context.equals( ContextEnum.PAGE_INFO.getRequestContext() ) ) {
088            return doReplacement( viewurl + "?do=PageInfo", name );
089        } else if( context.equals( ContextEnum.PAGE_DIFF.getRequestContext() ) ) {
090            return doReplacement( viewurl + "?do=Diff", name );
091        } else if( context.equals( ContextEnum.PAGE_NONE.getRequestContext() ) ) {
092            return doReplacement( "%u%n", name );
093        } else if( context.equals( ContextEnum.PAGE_UPLOAD.getRequestContext() ) ) {
094            return doReplacement( viewurl + "?do=Upload", name ); 
095        } else if( context.equals( ContextEnum.PAGE_COMMENT.getRequestContext() ) ) {
096            return doReplacement( viewurl + "?do=Comment", name ); 
097        } else if( context.equals( ContextEnum.WIKI_LOGIN.getRequestContext() ) ) {
098            final String loginUrl = "%pLogin.jsp?redirect=%n";
099            return doReplacement( loginUrl, name ); 
100        } else if( context.equals( ContextEnum.PAGE_DELETE.getRequestContext() ) ) {
101            return doReplacement( viewurl + "?do=Delete", name ); 
102        } else if( context.equals( ContextEnum.PAGE_CONFLICT.getRequestContext() ) ) {
103            return doReplacement( viewurl + "?do=PageModified", name ); 
104        } else if( context.equals( ContextEnum.WIKI_PREFS.getRequestContext() ) ) {
105            return doReplacement( viewurl + "?do=UserPreferences", name ); 
106        } else if( context.equals( ContextEnum.WIKI_FIND.getRequestContext() ) ) {
107            return doReplacement( viewurl + "?do=Search", name ); 
108        } else if( context.equals( ContextEnum.WIKI_ERROR.getRequestContext() ) ) {
109            return doReplacement( "%uError.jsp", name );
110        } else if( context.equals( ContextEnum.WIKI_CREATE_GROUP.getRequestContext() ) ) {
111            return doReplacement( viewurl + "?do=NewGroup", name );
112        } else if( context.equals( ContextEnum.GROUP_DELETE.getRequestContext() ) ) {
113            return doReplacement( viewurl + "?do=DeleteGroup", name );
114        } else if( context.equals( ContextEnum.GROUP_EDIT.getRequestContext() ) ) {
115            return doReplacement( viewurl + "?do=EditGroup", name );
116        } else if( context.equals( ContextEnum.GROUP_VIEW.getRequestContext() ) ) {
117            return doReplacement( viewurl + "?do=Group&group=%n", name );
118        }
119        
120        throw new InternalWikiException( "Requested unsupported context " + context );
121    }
122
123    /**
124     *  {@inheritDoc}
125     */
126    @Override
127    public String makeURL( final String context, final String name, String parameters ) {
128        if( parameters != null && !parameters.isEmpty() ) {
129            if( context.equals( ContextEnum.PAGE_ATTACH.getRequestContext() ) || context.equals( ContextEnum.PAGE_VIEW.getRequestContext() ) ) {
130                parameters = "?" + parameters;
131            } else if( context.equals(ContextEnum.PAGE_NONE.getRequestContext()) ) {
132                parameters = (name.indexOf('?') != -1 ) ? "&" : "?" + parameters;
133            } else {
134                parameters = "&"+parameters;
135            }
136        } else {
137            parameters = "";
138        }
139        return makeURL( context, name )+parameters;
140    }
141
142    /**
143     * {@inheritDoc}
144     */
145    @Override
146    public String parsePage( final String context, final HttpServletRequest request, final Charset encoding ) {
147        final String pagereq = request.getParameter( "page" );
148        if( pagereq == null ) {
149            return URLConstructor.parsePageFromURL( request, encoding );
150        }
151
152        return pagereq;
153    }
154
155    /**
156     *  {@inheritDoc}
157     */
158    @Override
159    public String getForwardPage( final HttpServletRequest req ) {
160        String jspPage = req.getParameter( "do" );
161        if( jspPage == null ) {
162            jspPage = "Wiki";
163        } else {
164            // Block path traversal, slashes, backslashes, query delimiters, percent encoding, 
165            // and control characters to prevent JSPWIKI-1304 while supporting international characters.
166            if( jspPage.contains( ".." ) || jspPage.contains( "/" ) || jspPage.contains( "\\" ) || 
167                jspPage.contains( "?" ) || jspPage.contains( "%" ) || jspPage.matches( ".*[\\p{Cntrl}].*" ) ) {
168                LOG.warn( "Invalid characters or path traversal detected in 'do' parameter: {}. Falling back to default Wiki page.", TextUtil.replaceEntities( jspPage ) );
169                jspPage = "Wiki";
170            }
171        }
172    
173        return jspPage + ".jsp";
174    }
175}