View Javadoc
1   /**
2    * This file Copyright (c) 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.cache.setup;
35  
36  import info.magnolia.module.InstallContext;
37  import info.magnolia.module.cache.AbstractCacheModule;
38  import info.magnolia.module.cache.filter.CacheFilter;
39  import info.magnolia.module.delta.NodeVisitorTask;
40  import info.magnolia.repository.RepositoryConstants;
41  
42  import javax.jcr.Node;
43  import javax.jcr.Property;
44  import javax.jcr.RepositoryException;
45  
46  import org.slf4j.Logger;
47  import org.slf4j.LoggerFactory;
48  
49  /**
50   * Migrate cache filters configurations from 5.3 to 5.4.
51   */
52  public class MigrateCacheFilterConfigurationTask extends NodeVisitorTask {
53  
54      private static final Logger log = LoggerFactory.getLogger(MigrateCacheFilterConfigurationTask.class);
55  
56      private static final String OLD_DEFAULT_CACHE_CONFIG = "default";
57  
58      private static final String FILTERS_PATH = "/server/filters";
59  
60      public MigrateCacheFilterConfigurationTask() {
61          super("Set defaultContentConfigurationName property to cache filters.", "Set defaultContentConfigurationName property to cache filters.", RepositoryConstants.CONFIG, FILTERS_PATH);
62      }
63  
64  
65  
66      @Override
67      protected boolean nodeMatches(Node node) {
68          try {
69              if (node.hasProperty("class") && CacheFilter.class.isAssignableFrom(Class.forName(node.getProperty("class").getString()))) {
70                  return true;
71              }
72          } catch (RepositoryException e) {
73              log.error("Could not execute task: ", e);
74          } catch (ClassNotFoundException e) {
75              log.warn("Filter class '{}' not found.", e.getMessage());
76          }
77          return false;
78      }
79  
80      @Override
81      protected void operateOnNode(InstallContext installContext, Node node) {
82          try {
83              if (node.hasProperty("cacheConfigurationName")) {
84                  Property oldProperty = node.getProperty("cacheConfigurationName");
85                  if (oldProperty.getString().equals(OLD_DEFAULT_CACHE_CONFIG)) {
86                      node.setProperty("defaultContentCachingConfigurationName", AbstractCacheModule.DEFAULT_CACHE_CONFIG);
87                  } else {
88                      node.setProperty("defaultContentCachingConfigurationName", oldProperty.getValue());
89                  }
90                  oldProperty.remove();
91              } else if (node.hasProperty(AbstractCacheModule.DEFAULT_CACHE_CONFIG)) {
92                  //incorrectly set name in 5.4 version
93                  Property oldProperty = node.getProperty(AbstractCacheModule.DEFAULT_CACHE_CONFIG);
94                  node.setProperty("defaultContentCachingConfigurationName", oldProperty.getValue());
95                  oldProperty.remove();
96              } else {
97                  node.setProperty("defaultContentCachingConfigurationName", AbstractCacheModule.DEFAULT_CACHE_CONFIG);
98              }
99          } catch (RepositoryException e) {
100             installContext.error("Could not execute task: ", e);
101         }
102     }
103 }