1 /**
2 * This file Copyright (c) 2008-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.module.delta;
35
36 import info.magnolia.cms.core.Content;
37 import info.magnolia.cms.core.HierarchyManager;
38 import info.magnolia.cms.util.ContentUtil;
39 import info.magnolia.module.InstallContext;
40
41 import javax.jcr.RepositoryException;
42 import javax.jcr.Value;
43
44 /**
45 * Renames a property found in a given subnode of all modules; typically, renames "path" to "templatePath"
46 * for all nodes under "paragraphs" for each module.
47 *
48 * @deprecated since 5.6 without replacement.
49 */
50 @Deprecated
51 public class RenamePropertyAllModulesNodeTask extends AllModulesNodeOperation {
52 private final String srcPropertyName;
53 private final String destPropertyName;
54 private final String baseNodeName;
55
56 public RenamePropertyAllModulesNodeTask(String name, String description, String baseNodeName, String srcPropertyName, String destPropertyName) {
57 super(name, description);
58 this.baseNodeName = baseNodeName;
59 this.srcPropertyName = srcPropertyName;
60 this.destPropertyName = destPropertyName;
61 }
62
63 @Override
64 protected void operateOnModuleNode(Content node, HierarchyManager hm, InstallContext ctx) throws RepositoryException, TaskExecutionException {
65 try {
66 if (node.hasContent(baseNodeName)) {
67 ContentUtil.visit(node.getContent(baseNodeName), new ContentUtil.Visitor() {
68 @Override
69 public void visit(Content subNode) throws Exception {
70 if (subNode.hasNodeData(srcPropertyName)) {
71 final Value value = subNode.getNodeData(srcPropertyName).getValue();
72 subNode.deleteNodeData(srcPropertyName);
73 subNode.setNodeData(destPropertyName, value);
74 }
75 }
76 });
77 }
78 } catch (RepositoryException e) {
79 throw e;
80 } catch (Exception e) {
81 // should not happen, but is a relict of info.magnolia.cms.util.ContentUtil#visit
82 throw new TaskExecutionException(e.getMessage(), e);
83 }
84 }
85 }
86