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.module.InstallContext;
37 import info.magnolia.module.delta.AbstractRepositoryTask;
38
39 import javax.jcr.Node;
40 import javax.jcr.RepositoryException;
41 import javax.jcr.Session;
42
43 import org.apache.commons.lang3.StringUtils;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
46
47 /**
48 * Allows {@code OPTIONS} method for requests if node and property existence conditions are met.
49 * <p>
50 * If target does exist, and {@code OPTIONS} method is not yet allowed, task will append {@code OPTIONS} method the list of
51 * already available methods.
52 * </p>
53 * <p>
54 * If the target node {@code /server/IPConfig/allow-all} or it's target property {@code method} doesn't exist, task won't
55 * create, nor set any value to the target property.
56 * </p>
57 */
58 public class AllowOptionMethodForRequestsTask extends AbstractRepositoryTask {
59
60 private static final Logger log = LoggerFactory.getLogger(AllowOptionMethodForRequestsTask.class);
61
62 private static final String IP_CONFIG_PATH = "/server/IPConfig/allow-all";
63 private static final String OPTIONS_METHOD = "OPTIONS";
64 private static final String METHODS_PROPERTY = "methods";
65
66 public AllowOptionMethodForRequestsTask() {
67 super("Allow OPTIONS method", "Add OPTIONS method into allowed methods of the server configuration.");
68 }
69
70 @Override
71 protected void doExecute(final InstallContext installContext) throws RepositoryException {
72 final Session session = installContext.getConfigJCRSession();
73 if (!session.nodeExists(IP_CONFIG_PATH)) {
74 log.warn("Destination node [{}] does not exist. Task failed to allow OPTIONS method.", IP_CONFIG_PATH);
75 return;
76 }
77 final Node node = session.getNode(IP_CONFIG_PATH);
78 if (!node.hasProperty(METHODS_PROPERTY)) {
79 log.warn("Expected property [methods] to exist. Task failed to allow OPTIONS method.");
80 return;
81 }
82 String methods = node.getProperty(METHODS_PROPERTY).getString();
83 if (!StringUtils.containsIgnoreCase(methods, OPTIONS_METHOD)) {
84 methods = StringUtils.appendIfMissing(methods, ",");
85 final String newValue = methods.concat(OPTIONS_METHOD);
86 node.setProperty(METHODS_PROPERTY, newValue);
87 }
88 }
89 }