View Javadoc
1   /**
2    * This file Copyright (c) 2013-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.ui.contentapp.setup.for5_3;
35  
36  import info.magnolia.jcr.RuntimeRepositoryException;
37  import info.magnolia.jcr.util.NodeTypes;
38  import info.magnolia.jcr.util.NodeUtil;
39  import info.magnolia.module.InstallContext;
40  import info.magnolia.module.delta.NodeVisitorTask;
41  import info.magnolia.repository.RepositoryConstants;
42  
43  import javax.jcr.Node;
44  import javax.jcr.Property;
45  import javax.jcr.RepositoryException;
46  
47  import org.apache.commons.lang3.StringUtils;
48  import org.slf4j.Logger;
49  import org.slf4j.LoggerFactory;
50  
51  /**
52   * Substitutes availability rule class property with multiple availability rule definitions.
53   * This task normally is not meant to be used standalone.
54   *
55   * @see {@link ContentAppMigrationTask}
56   */
57  public class MigrateAvailabilityRulesTask extends NodeVisitorTask {
58  
59      private static final Logger log = LoggerFactory.getLogger(MigrateAvailabilityRulesTask.class);
60  
61      protected static final String RULE_CLASS = "ruleClass";
62      protected static final String RULES = "rules";
63  
64      public MigrateAvailabilityRulesTask(String path) {
65          super("Migrate availability rules", "Substitute availability rule class property with multiple availability rule definitions", RepositoryConstants.CONFIG, path);
66      }
67  
68      public MigrateAvailabilityRulesTask() {
69          this("/");
70      }
71  
72      @Override
73      protected boolean nodeMatches(Node node) {
74          try {
75              return node.getPrimaryNodeType().getName().equals(NodeTypes.ContentNode.NAME) && node.getName().equals("availability");
76          } catch (RepositoryException e) {
77              log.error("Couldn't evaluate visited node's name or node-type", e);
78          }
79          return false;
80      }
81  
82      @Override
83      protected void operateOnNode(InstallContext installContext, Node node) {
84          try {
85              if (node.hasProperty(RULE_CLASS)) {
86                  Property ruleClassProperty = node.getProperty(RULE_CLASS);
87                  String ruleClass = ruleClassProperty.getString();
88  
89                  Node ruleNode = NodeUtil.createPath(node, RULES + "/" + resolveRuleName(ruleClass), NodeTypes.ContentNode.NAME);
90                  ruleNode.setProperty("implementationClass", ruleClass);
91  
92                  ruleClassProperty.remove();
93              }
94          } catch (RepositoryException e) {
95              throw new RuntimeRepositoryException("Failed to migrate availability-rules.",e);
96          }
97      }
98  
99      private String resolveRuleName(String ruleClass) {
100         return StringUtils.substringAfterLast(ruleClass, ".");
101     }
102 }