1 /**
2 * This file Copyright (c) 2003-2017 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 import org.apache.commons.lang3.StringUtils;
40
41 /**
42 * 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:
43 *
44 * <pre>
45 * fromURI=/products/([0-9A-Z]+)\.html\?available(true|false)
46 * toURI=/product/detail.html?productId=$1&available=$2
47 * </pre>
48 *
49 * @deprecated since 5.5.6, regex URI mapping has been relocated to the virtual-uri module (see MAGNOLIA-7016).
50 */
51 @Deprecated
52 public class RegexpVirtualURIMapping extends DefaultVirtualURIMapping implements QueryAwareVirtualURIMapping {
53 private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(RegexpVirtualURIMapping.class);
54
55 private Pattern regexp;
56
57 @Override
58 public MappingResult mapURI(final String uri) {
59 return mapURI(uri, null);
60 }
61
62 @Override
63 public MappingResult mapURI(final String uri, String queryString) {
64
65 if (regexp != null) {
66 final Matcher matcher;
67 if (queryString != null) {
68 matcher = regexp.matcher(uri + "?" + queryString);
69 } else {
70 matcher = regexp.matcher(uri);
71 }
72
73 if (matcher.find()) {
74 final MappingResult r = new MappingResult();
75 final int matcherCount = matcher.groupCount();
76 try {
77 final String replaced = matcher.replaceAll(toURI);
78
79 r.setLevel(matcherCount + 1);
80 r.setToURI(replaced);
81 return r;
82 } catch (IndexOutOfBoundsException e) {
83 log.warn("{} misconfigured: {}", toString(), e.getMessage());
84 }
85 }
86 }
87
88 return null;
89 }
90
91 @Override
92 public void setFromURI(String fromURI) {
93 this.fromURI = fromURI;
94
95 if (StringUtils.isNotEmpty(fromURI)) {
96 this.regexp = Pattern.compile(fromURI);
97 }
98 }
99
100 @Override
101 public boolean isValid() {
102 if (this.getClass().equals(RegexpVirtualURIMapping.class)) {
103 return StringUtils.isNotEmpty(fromURI) && StringUtils.isNotEmpty(toURI);
104 }
105
106 return true;
107 }
108 }