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.virtualuri.mapping;
35
36 import java.net.URI;
37 import java.util.Optional;
38 import java.util.regex.Matcher;
39 import java.util.regex.Pattern;
40
41 import org.apache.commons.lang3.StringUtils;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
44
45 /**
46 * 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:
47 *
48 * <pre>
49 * fromUri=/products/([0-9A-Z]+)\.html\?available(true|false)
50 * toUri=/product/detail.html?productId=$1&available=$2
51 * </pre>
52 */
53 public class RegexpVirtualUriMapping extends DefaultVirtualUriMapping {
54 private static final Logger log = LoggerFactory.getLogger(RegexpVirtualUriMapping.class);
55 private Pattern regexp;
56
57 @Override
58 public void setFromUri(String fromUri) {
59 setInternalFromUri(fromUri);
60
61 if (StringUtils.isNotEmpty(fromUri)) {
62 this.regexp = Pattern.compile(fromUri);
63 }
64 }
65
66 @Override
67 public Optional<Result> mapUri(URI uri) {
68
69 if (regexp != null) {
70 String uriString = uri.toString();
71 Matcher matcher = regexp.matcher(uriString);
72
73 if (matcher.find()) {
74 try {
75 String replacedUri = matcher.replaceAll(getToUri());
76 int groupCount = matcher.groupCount() + 1;
77 Result result = new Result(replacedUri, groupCount, this);
78
79 return Optional.of(result);
80 } catch (IndexOutOfBoundsException e) {
81 log.warn("{} misconfigured: {}", toString(), e.getMessage());
82 }
83 }
84 }
85 return Optional.empty();
86 }
87 }