1 /**
2 * This file Copyright (c) 2003-2014 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.cms.beans.config;
35
36 import java.util.regex.Matcher;
37 import java.util.regex.Pattern;
38
39 /**
40 * Query aware virtual uri mapping implementation that uses regular expressions in fromURI/toURI. When using regular expression in <code>fromURI</code>, <code>toURI</code> can contain references to the regexp matches. For example:
41 *
42 * <pre>
43 * fromURI=/products/([0-9A-Z]+)\.html\?available(true|false)
44 * toURI=/product/detail.html?productId=$1&available=$2
45 * </pre>
46 *
47 * @author Fabrizio Giustina
48 * @author philipp
49 * @version $Id: DefaultVirtualURIMapping.java 10295 2007-08-02 21:33:58Z fgiust $
50 */
51 public class RegexpVirtualURIMapping extends DefaultVirtualURIMapping implements QueryAwareVirtualURIMapping {
52 private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(RegexpVirtualURIMapping.class);
53
54 private Pattern regexp;
55
56 @Override
57 public MappingResult mapURI(final String uri) {
58 return mapURI(uri, null);
59 }
60
61 @Override
62 public MappingResult mapURI(final String uri, String queryString) {
63 if (regexp != null) {
64 final Matcher matcher;
65 if (queryString != null) {
66 matcher = regexp.matcher(uri + "?" + queryString);
67 } else {
68 matcher = regexp.matcher(uri);
69 }
70
71 if (matcher.find()) {
72 final MappingResult r = new MappingResult();
73 final int matcherCount = matcher.groupCount();
74 try {
75 final String replaced = matcher.replaceAll(toURI);
76
77 r.setLevel(matcherCount + 1);
78 r.setToURI(replaced);
79 return r;
80 } catch (IndexOutOfBoundsException e) {
81 log.warn("{} misconfigured: {}", toString(), e.getMessage());
82 }
83 }
84 }
85
86 return null;
87 }
88
89 @Override
90 public void setFromURI(String fromURI) {
91 this.fromURI = fromURI;
92 this.regexp = Pattern.compile(fromURI);
93 }
94
95 }