View Javadoc
1   /**
2    * This file Copyright (c) 2020 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.setup;
35  
36  import info.magnolia.cms.filters.AddHeadersFilter;
37  import info.magnolia.cors.AbstractCorsFilter;
38  import info.magnolia.jcr.util.NodeUtil;
39  import info.magnolia.jcr.wrapper.JCRMgnlPropertiesFilteringNodeWrapper;
40  import info.magnolia.module.InstallContext;
41  import info.magnolia.module.delta.AbstractRepositoryTask;
42  import info.magnolia.module.delta.TaskExecutionException;
43  
44  import javax.jcr.Node;
45  import javax.jcr.Property;
46  import javax.jcr.PropertyIterator;
47  import javax.jcr.RepositoryException;
48  
49  import com.machinezoo.noexception.Exceptions;
50  
51  /**
52   * Task that will output warn message if any previous CORS configuration added with AddHeadersFilter found.
53   */
54  public class WarnOnCorsAddedByAddHeadersFilter extends AbstractRepositoryTask {
55  
56      private static final String WARN_MESSAGE = "A custom CORS configuration has been detected via the AddHeadersFilter. " +
57              "Please either disable or remove this configuration, and use the out-of-the-box Magnolia CORS configuration. For more information, see the CORS section on https://documentation.magnolia-cms.com/display/DOCS/Filters.";
58  
59      public WarnOnCorsAddedByAddHeadersFilter() {
60          super("Warn on CORS filter configuration", "Warn if CORS filter configuration added using AddHeadersFilter is present");
61      }
62  
63      @Override
64      protected void doExecute(final InstallContext installContext) throws RepositoryException, TaskExecutionException {
65          final Node filtersNode = installContext.getConfigJCRSession().getNode("/server/filters");
66          final boolean shouldWarn = NodeUtil.asList(NodeUtil.getNodes(filtersNode)).stream()
67                  .filter(Exceptions.wrap().predicate(this::isAddHeadersFilter))
68                  .filter(Exceptions.wrap().predicate(this::isFilterEnabled))
69                  .anyMatch(Exceptions.wrap().predicate(this::hasCorsHeaders));
70          if (shouldWarn) {
71              installContext.warn(WARN_MESSAGE);
72          }
73      }
74  
75      private boolean hasCorsHeaders(final Node node) throws RepositoryException {
76          if (node.hasNode("headers")) {
77              final PropertyIterator properties = new JCRMgnlPropertiesFilteringNodeWrapper(node.getNode("headers")).getProperties();
78              while (properties.hasNext()) {
79                  final Property property = properties.nextProperty();
80                  if (property.getName().equalsIgnoreCase(AbstractCorsFilter.Headers.ACCESS_CONTROL_ALLOW_ORIGIN.getName())) {
81                      return true;
82                  }
83              }
84          }
85          return false;
86      }
87  
88      private boolean isAddHeadersFilter(final Node node) throws RepositoryException {
89          return node.hasProperty("class") && node.getProperty("class").getString().equals(AddHeadersFilter.class.getName());
90      }
91  
92      private boolean isFilterEnabled(final Node node) throws RepositoryException {
93          return !node.hasProperty("enabled") || (node.hasProperty("enabled") && node.getProperty("enabled").getBoolean());
94      }
95  }