James Moger
2011-10-10 70b492b89bdad54abc10795d12f306d8972d94a7
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/*
 * Copyright 2011 gitblit.com.
 *
 * 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.
 */
package com.gitblit.wicket;
 
import java.text.MessageFormat;
 
import org.apache.wicket.IRequestTarget;
import org.apache.wicket.Page;
import org.apache.wicket.PageParameters;
import org.apache.wicket.request.RequestParameters;
import org.apache.wicket.request.target.coding.MixedParamUrlCodingStrategy;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
 
import com.gitblit.GitBlit;
import com.gitblit.Keys;
 
/**
 * Simple subclass of mixed parameter url coding strategy that works around the
 * encoded forward-slash issue that is present in some servlet containers.
 * 
 * https://issues.apache.org/jira/browse/WICKET-1303
 * http://tomcat.apache.org/security-6.html
 * 
 * @author James Moger
 * 
 */
public class GitblitParamUrlCodingStrategy extends MixedParamUrlCodingStrategy {
 
    private Logger logger = LoggerFactory.getLogger(GitblitParamUrlCodingStrategy.class);
 
    /**
     * Construct.
     * 
     * @param <C>
     * @param mountPath
     *            mount path (not empty)
     * @param bookmarkablePageClass
     *            class of mounted page (not null)
     * @param parameterNames
     *            the parameter names (not null)
     */
    public <C extends Page> GitblitParamUrlCodingStrategy(String mountPath,
            Class<C> bookmarkablePageClass, String[] parameterNames) {
        super(mountPath, bookmarkablePageClass, parameterNames);
    }
 
    /**
     * Url encodes a string that is mean for a URL path (e.g., between slashes)
     * 
     * @param string
     *            string to be encoded
     * @return encoded string
     */
    protected String urlEncodePathComponent(String string) {
        char altChar = GitBlit.getChar(Keys.web.forwardSlashCharacter, '/');
        if (altChar != '/') {
            string = string.replace('/', altChar);
        }
        return super.urlEncodePathComponent(string);
    }
 
    /**
     * Returns a decoded value of the given value (taken from a URL path
     * section)
     * 
     * @param value
     * @return Decodes the value
     */
    protected String urlDecodePathComponent(String value) {
        char altChar = GitBlit.getChar(Keys.web.forwardSlashCharacter, '/');
        if (altChar != '/') {
            value = value.replace(altChar, '/');
        }
        return super.urlDecodePathComponent(value);
    }
 
    /**
     * Gets the decoded request target.
     * 
     * @param requestParameters
     *            the request parameters
     * @return the decoded request target
     */
    @Override
    public IRequestTarget decode(RequestParameters requestParameters) {
        final String parametersFragment = requestParameters.getPath().substring(
                getMountPath().length());
        logger.debug(MessageFormat
                .format("REQ: {0} PARAMS {1}", getMountPath(), parametersFragment));
 
        final PageParameters parameters = new PageParameters(decodeParameters(parametersFragment,
                requestParameters.getParameters()));
        return super.decode(requestParameters);
    }
}