1 /**
2 * This file Copyright (c) 2003-2018 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.Random;
37
38 import org.apache.commons.lang3.StringUtils;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
41
42
43 /**
44 * <p>
45 * An extension of {@link RegexpVirtualURIMapping} that allows a rotation between different destination urls. In order
46 * to rotate <code>toURI</code> must contain the <code>*</code> that will be replaced by a random number between
47 * <code>start</code> (default is <code>1</code>) and <code>end</code> (defaults is <code>3</code>).
48 * </p>
49 * <p>
50 * An additional property <code>padding</code> can specify the left 0 padding for numbers (defaults is <code>2</code>).
51 * So for example a destination url like <code>forward:/banner/image_*.jpg</code> will randomly forward the request to
52 * <code>/banner/image_01.jpg</code>, <code>/banner/image_02.jpg</code> or <code>/banner/image_03.jpg</code>
53 * </p>
54 *
55 * @deprecated since 5.5.6, rotating URI mapping has been relocated to the virtual-uri module (see MAGNOLIA-7016).
56 */
57 @Deprecated
58 public class RotatingVirtualURIMapping extends RegexpVirtualURIMapping {
59
60 private static final Logger log = LoggerFactory.getLogger(RotatingVirtualURIMapping.class);
61
62 /**
63 * Placeholder that will be replaced by a random number.
64 */
65 private static final String RANDOM_PLACEHOLDER = "*";
66
67 /**
68 * Lower bound for the generated random number.
69 */
70 private int start = 1;
71
72 /**
73 * Upper bound for the generated random number.
74 */
75 private int end = 3;
76
77 /**
78 * Left padding (using 0s).
79 */
80 private int padding = 2;
81
82 /**
83 * Sets the start.
84 *
85 * @param start the start to set
86 */
87 public void setStart(int start) {
88 this.start = start;
89 }
90
91 /**
92 * Sets the end.
93 *
94 * @param end the end to set
95 */
96 public void setEnd(int end) {
97 this.end = end;
98 }
99
100 /**
101 * Sets the padding.
102 *
103 * @param padding the padding to set
104 */
105 public void setPadding(int padding) {
106 this.padding = padding;
107 }
108
109 /**
110 * {@inheritDoc}
111 */
112 @Override
113 public MappingResult mapURI(String uri) {
114 // delegate the initial processing to RegexpVirtualURIMapping
115 MappingResult mr = super.mapURI(uri);
116
117 if (mr != null) {
118 if (end > start) {
119 int randomNumber = new Random().nextInt(end - (start - 1)) + start;
120 String randomAsString = StringUtils.leftPad(Integer.toString(randomNumber), padding, '0');
121
122 mr.setToURI(StringUtils.replace(mr.getToURI(), RANDOM_PLACEHOLDER, randomAsString));
123 } else {
124 log.warn("End value must be greater than start value.");
125 }
126 }
127 return mr;
128 }
129
130 @Override
131 public boolean isValid() {
132 if (this.getClass().equals(RotatingVirtualURIMapping.class)) {
133 return StringUtils.isNotEmpty(fromURI) && StringUtils.isNotEmpty(toURI);
134 }
135
136 return true;
137 }
138 }