View Javadoc
1   /**
2    * This file Copyright (c) 2014-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.module.InstallContext;
39  import info.magnolia.module.delta.NodeVisitorTask;
40  import info.magnolia.repository.RepositoryConstants;
41  
42  import java.util.Collections;
43  import java.util.HashMap;
44  import java.util.Map;
45  
46  import javax.jcr.Node;
47  import javax.jcr.RepositoryException;
48  
49  import org.slf4j.Logger;
50  import org.slf4j.LoggerFactory;
51  
52  /**
53   * A task which is changing values for availability@ruleClass-properties in the config app- for a few classes which have been moved from
54   * package info.magnolia.ui.api.availability to package info.magnolia.ui.framework.availability.
55   * This task normally is not meant to be used standalone.
56   *
57   * @see {@link ContentAppMigrationTask}
58   */
59  public class ChangeAvailabilityRuleClassesTask extends NodeVisitorTask {
60  
61      private static final Logger log = LoggerFactory.getLogger(ChangeAvailabilityRuleClassesTask.class);
62  
63      private static final String RULE_CLASS = "ruleClass";
64  
65      private Map<String, String> classMappings;
66  
67      public ChangeAvailabilityRuleClassesTask(String path) {
68          super("Update rule classes to ui-framework", "This task changes availability@ruleClass properties for classes which have been moved from package info.magnolia.ui.api.availability to package info.magnolia.ui.framework.availability.", RepositoryConstants.CONFIG, path);
69      }
70  
71      public ChangeAvailabilityRuleClassesTask() {
72          this("/");
73      }
74  
75      @Override
76      protected boolean nodeMatches(Node node) {
77          try {
78              return node.getPrimaryNodeType().getName().equals(NodeTypes.ContentNode.NAME) && node.getName().equals("availability");
79          } catch (RepositoryException e) {
80              log.error("Couldn't evaluate visited node's name or node-type", e);
81          }
82          return false;
83      }
84  
85      @Override
86      protected void operateOnNode(InstallContext installContext, Node node) {
87          try {
88              if (node.hasProperty(RULE_CLASS)) {
89                  String classRulePropertyValue = node.getProperty(RULE_CLASS).getString();
90                  if (getClassMapping().containsKey(classRulePropertyValue)) {
91                      node.setProperty(RULE_CLASS, getClassMapping().get(classRulePropertyValue));
92                  }
93              }
94          } catch (RepositoryException e) {
95              throw new RuntimeRepositoryException("Failed to change availability-rule-classes.", e);
96          }
97      }
98  
99      private Map<String, String> getClassMapping() {
100         if (classMappings == null) {
101             classMappings = new HashMap<String, String>();
102             classMappings.put("info.magnolia.ui.api.availability.HasVersionsRule", "info.magnolia.ui.framework.availability.HasVersionsRule");
103             classMappings.put("info.magnolia.ui.api.availability.IsDeletedRule", "info.magnolia.ui.framework.availability.IsDeletedRule");
104             classMappings.put("info.magnolia.ui.api.availability.IsNotDeletedRule", "info.magnolia.ui.framework.availability.IsNotDeletedRule");
105             classMappings.put("info.magnolia.ui.api.availability.IsNotVersionedRule", "info.magnolia.ui.framework.availability.IsNotVersionedRule");
106             classMappings = Collections.unmodifiableMap(classMappings);
107         }
108         return classMappings;
109     }
110 
111 
112 }