1 /**
2 * This file Copyright (c) 2011-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.util;
35
36 import info.magnolia.cms.core.Content;
37 import info.magnolia.cms.core.NodeData;
38
39 import java.util.Collection;
40 import java.util.regex.Matcher;
41 import java.util.regex.Pattern;
42
43 /**
44 * A {@link info.magnolia.cms.util.ContentUtil.Visitor} which allows simple search/replace functionality.
45 *
46 * For sample usage, see {@link SearchReplaceTest}.
47 *
48 * @deprecated since 4.5, declared deprecated in 5.6.
49 */
50 @Deprecated
51 public class SearchReplace implements ContentUtil.Visitor {
52 private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(SearchReplace.class);
53
54 final String propertyNamePattern;
55 final String search;
56 final String replace;
57
58 private final Pattern searchPattern;
59
60 /**
61 * A search and replace which searches for literal occurrences of <code>search</code>.
62 *
63 * @see Pattern#LITERAL
64 */
65 public SearchReplace(String propertyNamePattern, String search, String replace) {
66 this(propertyNamePattern, search, replace, Pattern.LITERAL);
67 }
68
69 /**
70 * A search and replace which can use parameterized substitution; use 0 for the default java.util.Pattern behavior.
71 */
72 public SearchReplace(String propertyNamePattern, String search, String replace, int regexFlags) {
73 this.propertyNamePattern = propertyNamePattern;
74 this.search = search;
75 this.replace = replace;
76
77 this.searchPattern = Pattern.compile(search, regexFlags);
78 }
79
80 @Override
81 public void visit(Content node) throws Exception {
82 final Collection<NodeData> props = node.getNodeDataCollection(propertyNamePattern);
83 for (NodeData prop : props) {
84 if (prop.isExist()) {
85 final String oldValue = prop.getString();
86 final StringBuffer newValue = new StringBuffer();
87 final Matcher matcher = searchPattern.matcher(oldValue);
88 int count = 0;
89 while (matcher.find()) {
90 final String group = matcher.group();
91 matcher.appendReplacement(newValue, replace);
92 count++;
93 }
94 matcher.appendTail(newValue);
95 onPropertyVisit(prop, count, oldValue, newValue);
96 prop.setValue(newValue.toString());
97 }
98 }
99 }
100
101 protected void onPropertyVisit(NodeData prop, int count, String oldValue, StringBuffer newValue) {
102 log.debug(String.format("Found %d occurences of %s at %s", count, search, prop.getHandle()));
103 log.debug(String.format(" old value:\n %s\n\nnew value:\n%s", oldValue, newValue.toString()));
104 }
105
106 }