1 /**
2 * This file Copyright (c) 2012-2015 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.module.delta;
35
36 import info.magnolia.cms.util.QueryUtil;
37 import info.magnolia.module.InstallContext;
38 import info.magnolia.repository.RepositoryConstants;
39
40 import javax.jcr.Node;
41 import javax.jcr.NodeIterator;
42 import javax.jcr.Property;
43 import javax.jcr.PropertyIterator;
44 import javax.jcr.PropertyType;
45 import javax.jcr.RepositoryException;
46 import javax.jcr.query.Query;
47
48 /**
49 * Changes all properties in an entire workspace that are of type {@link PropertyType#STRING} and has a certain value.
50 * Note that this uses the query functionality of JCR and is therefore usable only if <code>currentValue</code> is a
51 * valid <code>fullTextSearchExpression</code> as defined in JCR2 6.7.19. More specifically it is not guaranteed to
52 * find all properties intended to be changed if <code>currentValue</code> either:
53 * <ul>
54 * <li>starts with a dash</li>
55 * <li>contains the word <code>OR</code></li>
56 * <li>contains characters that conflict with the query syntax such as quote, double quote, minus and backslash</li>
57 * </ul>
58 */
59 public class ChangeAllPropertiesWithCertainValueTask extends AbstractRepositoryTask {
60
61 private final String workspaceName;
62 private final String currentValue;
63 private final String newValue;
64
65 public ChangeAllPropertiesWithCertainValueTask(String currentValue, String newValue) {
66 this(RepositoryConstants.CONFIG, currentValue, newValue);
67 }
68
69 public ChangeAllPropertiesWithCertainValueTask(String workspaceName, String currentValue, String newValue) {
70 this("Rename all properties with certain name.", String.format("Renames all '%s' properties in '%s' workspace to '%s'.", currentValue, workspaceName, newValue),
71 workspaceName, currentValue, newValue);
72 }
73
74 public ChangeAllPropertiesWithCertainValueTask(String name, String description, String workspaceName, String currentValue, String newValue) {
75 super(name, description);
76 this.workspaceName = workspaceName;
77 this.currentValue = currentValue;
78 this.newValue = newValue;
79 }
80
81 @Override
82 protected void doExecute(InstallContext installContext) throws RepositoryException, TaskExecutionException {
83
84 String query = "select * from [nt:base] as t where contains(t.*,'" + currentValue + "')";
85 NodeIterator nodeIterator = QueryUtil.search(workspaceName, query, Query.JCR_SQL2);
86 while (nodeIterator.hasNext()) {
87 Node node = nodeIterator.nextNode();
88 PropertyIterator iterator = node.getProperties();
89 while (iterator.hasNext()) {
90 Property property = iterator.nextProperty();
91 if (property.getType() == PropertyType.STRING) {
92 if (property.getString().equals(currentValue)) {
93 property.setValue(newValue);
94 }
95 }
96 }
97 }
98 }
99 }