View Javadoc
1   /**
2    * This file Copyright (c) 2014-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.rendering.module.setup;
35  
36  import info.magnolia.module.InstallContext;
37  import info.magnolia.module.delta.ArrayDelegateTask;
38  import info.magnolia.module.delta.BootstrapSingleResource;
39  import info.magnolia.module.delta.NodeVisitorTask;
40  import info.magnolia.module.delta.RemoveNodeTask;
41  import info.magnolia.rendering.context.RenderingListener;
42  import info.magnolia.rendering.listeners.AbstractRenderingListener;
43  import info.magnolia.repository.RepositoryConstants;
44  
45  import javax.jcr.Node;
46  import javax.jcr.RepositoryException;
47  
48  /**
49   * Migrates configuration under modules/rendering/renderers/listeners/ to server/rendering/engine/listeners/.
50   */
51  public class MigrateRenderingListenersTask extends ArrayDelegateTask {
52  
53      protected static final String OLD_RENDERING_LISTENERS_LOCATION = "modules/rendering/renderers/listeners/";
54      protected static final String NEW_RENDERING_LISTENERS_LOCATION = "server/rendering/engine/listeners/";
55  
56      public MigrateRenderingListenersTask() {
57          super("Migrate rendering listeners.",
58                  new BootstrapSingleResource("Boostrap new rendering liteners configuration", "Boostrap new rendering liteners configuration",
59                          "/mgnl-bootstrap/rendering/config.server.rendering.engine.listeners.xml"),
60  
61                  new NodeVisitorTask("Migrate old rendering listeners configuration.",
62                          String.format("Migrate configuration under '%s' to '%s'.", OLD_RENDERING_LISTENERS_LOCATION, NEW_RENDERING_LISTENERS_LOCATION), RepositoryConstants.CONFIG, "/" + OLD_RENDERING_LISTENERS_LOCATION) {
63                      @Override
64                      protected boolean nodeMatches(Node node) {
65                          try {
66                              return !"dar".equals(node.getName());
67                          } catch (RepositoryException e) {
68                              return false;
69                          }
70                      }
71  
72                      @Override
73                      protected void operateOnNode(InstallContext installContext, Node node) {
74                          try {
75                              if (!node.hasProperty("class")) {
76                                  return;
77                              }
78  
79                              installContext.warn(String.format("You have custom rendering listener '%s/class=%s' registered. "
80                                      + "Please reimplement this listener by extending from '%s' as '%s' is now deprecated and move this node under '%s'.",
81                                      node, node.getProperty("class").getString(),
82                                      AbstractRenderingListener.class.getName(), RenderingListener.class.getName(), NEW_RENDERING_LISTENERS_LOCATION));
83  
84                          } catch (RepositoryException e) {
85                              installContext.warn(String.format("Cannot move '%s' to '%s'.", node, NEW_RENDERING_LISTENERS_LOCATION));
86                          }
87                      }
88                  },
89                  new RemoveNodeTask("", "/" + OLD_RENDERING_LISTENERS_LOCATION));
90  
91      }
92  }