001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.webdav;
029
030import org.opencms.main.CmsLog;
031import org.opencms.main.OpenCms;
032import org.opencms.repository.A_CmsRepository;
033
034import java.io.IOException;
035import java.io.InputStream;
036import java.util.Collections;
037import java.util.Enumeration;
038import java.util.LinkedHashMap;
039
040import org.apache.commons.collections4.EnumerationUtils;
041import org.apache.commons.logging.Log;
042import org.apache.jackrabbit.webdav.DavLocatorFactory;
043import org.apache.jackrabbit.webdav.DavResource;
044import org.apache.jackrabbit.webdav.DavResourceFactory;
045import org.apache.jackrabbit.webdav.DavServletRequest;
046import org.apache.jackrabbit.webdav.DavSessionProvider;
047import org.apache.jackrabbit.webdav.WebdavRequest;
048import org.apache.jackrabbit.webdav.header.IfHeader;
049import org.apache.jackrabbit.webdav.io.InputContext;
050import org.apache.jackrabbit.webdav.lock.LockManager;
051import org.apache.jackrabbit.webdav.lock.SimpleLockManager;
052import org.apache.jackrabbit.webdav.server.AbstractWebdavServlet;
053
054import com.google.common.collect.Iterators;
055
056import jakarta.servlet.ServletConfig;
057import jakarta.servlet.ServletContext;
058import jakarta.servlet.ServletException;
059import jakarta.servlet.http.HttpServletRequest;
060import jakarta.servlet.http.HttpServletResponse;
061
062/**
063 * Webdav access servlet for OpenCms, implemented using jackrabbit-webdav library.
064 */
065public class CmsJackrabbitWebdavServlet extends AbstractWebdavServlet {
066
067    /** Logger instance for this class. */
068    private static final Log LOG = CmsLog.getLog(CmsJackrabbitWebdavServlet.class);
069
070    /** Serial version id. */
071    private static final long serialVersionUID = 1L;
072
073    /** The locator factory. */
074    private CmsDavLocatorFactory m_locatorFactory = new CmsDavLocatorFactory();
075
076    /** The session provider. */
077    private CmsDavSessionProvider m_sessionProvider = new CmsDavSessionProvider();
078
079    /** The resource factory. */
080    private CmsDavResourceFactory m_resourceFactory = new CmsDavResourceFactory();
081
082    /** The lock manager. */
083    private LockManager m_lockManager = new SimpleLockManager();
084
085    /** The repository. */
086    private A_CmsRepository m_repository;
087
088    /**
089     * @see org.apache.jackrabbit.webdav.server.AbstractWebdavServlet#getDavSessionProvider()
090     */
091    @Override
092    public DavSessionProvider getDavSessionProvider() {
093
094        return m_sessionProvider;
095    }
096
097    /**
098     * @see org.apache.jackrabbit.webdav.server.AbstractWebdavServlet#getLocatorFactory()
099     */
100    @Override
101    public DavLocatorFactory getLocatorFactory() {
102
103        return m_locatorFactory;
104    }
105
106    /**
107     * @see org.apache.jackrabbit.webdav.server.AbstractWebdavServlet#getResourceFactory()
108     */
109    @Override
110    public DavResourceFactory getResourceFactory() {
111
112        return m_resourceFactory;
113    }
114
115    /**
116     * @see jakarta.servlet.GenericServlet#init(jakarta.servlet.ServletConfig)
117     */
118    @Override
119    public void init(ServletConfig config) throws ServletException {
120
121        final LinkedHashMap<String, String> params = new LinkedHashMap<>();
122
123        params.put(AbstractWebdavServlet.INIT_PARAM_CREATE_ABSOLUTE_URI, "false");
124
125        for (String name : Collections.list(config.getInitParameterNames())) {
126            params.put(name, config.getInitParameter(name));
127        }
128        super.init(new ServletConfig() {
129
130            public String getInitParameter(String name) {
131
132                return params.get(name);
133
134            }
135
136            public Enumeration<String> getInitParameterNames() {
137
138                return Collections.enumeration(params.keySet());
139            }
140
141            public ServletContext getServletContext() {
142
143                return config.getServletContext();
144            }
145
146            public String getServletName() {
147
148                return config.getServletName();
149            }
150        });
151        String repName = config.getInitParameter(CmsDavUtil.PARAM_REPOSITORY);
152        A_CmsRepository repository = OpenCms.getRepositoryManager().getRepository(repName, A_CmsRepository.class);
153        m_repository = repository;
154        m_sessionProvider.setRepository(repository);
155        m_resourceFactory.setLockManager(m_lockManager);
156    }
157
158    /**
159     * @see org.apache.jackrabbit.webdav.server.AbstractWebdavServlet#setDavSessionProvider(org.apache.jackrabbit.webdav.DavSessionProvider)
160     */
161    @Override
162    public void setDavSessionProvider(DavSessionProvider davSessionProvider) {
163
164        throw new UnsupportedOperationException();
165    }
166
167    /**
168     * @see org.apache.jackrabbit.webdav.server.AbstractWebdavServlet#setLocatorFactory(org.apache.jackrabbit.webdav.DavLocatorFactory)
169     */
170    @Override
171    public void setLocatorFactory(DavLocatorFactory locatorFactory) {
172
173        throw new UnsupportedOperationException();
174
175    }
176
177    /**
178     * @see org.apache.jackrabbit.webdav.server.AbstractWebdavServlet#setResourceFactory(org.apache.jackrabbit.webdav.DavResourceFactory)
179     */
180    @Override
181    public void setResourceFactory(DavResourceFactory resourceFactory) {
182
183        throw new UnsupportedOperationException();
184    }
185
186    /**
187     * @see org.apache.jackrabbit.webdav.server.AbstractWebdavServlet#getInputContext(org.apache.jackrabbit.webdav.DavServletRequest, java.io.InputStream)
188     */
189    @Override
190    protected InputContext getInputContext(DavServletRequest request, InputStream in) {
191
192        return new CmsDavInputContext(request, in);
193    }
194
195    /**
196     * @see org.apache.jackrabbit.webdav.server.AbstractWebdavServlet#isPreconditionValid(org.apache.jackrabbit.webdav.WebdavRequest, org.apache.jackrabbit.webdav.DavResource)
197     */
198    @Override
199    protected boolean isPreconditionValid(WebdavRequest request, DavResource resource) {
200
201        IfHeader header = new IfHeader(request);
202        String[] tokens = Iterators.toArray(header.getAllTokens(), String.class);
203        for (String token : tokens) {
204            if ("DAV:no-lock".equals(token)) {
205                return false;
206            }
207        }
208        return !resource.exists() || request.matchesIfHeader(resource);
209    }
210
211    /**
212     * @see org.apache.jackrabbit.webdav.server.AbstractWebdavServlet#service(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)
213     */
214    @Override
215    protected void service(HttpServletRequest request, HttpServletResponse response)
216    throws ServletException, IOException {
217
218        LOG.debug("WEBDAV: " + request.getMethod() + " " + request.getRequestURI());
219        //printHeaderInfo(request);
220        if (Boolean.parseBoolean(m_repository.getConfiguration().getString("failOnRangeHeader", "false"))) {
221            // The MacOS WebDav client uses range requests and seems to assume they work even if the server sends a HTTP status of 200
222            // in response (rather than 206 Partial Content). This can cause big files to be corrupted. To prevent this,
223            // we send an empty response with status 400 when detecting a range request.
224            String range = request.getHeader("range");
225            if (range != null) {
226                response.setStatus(400);
227                return;
228            }
229        }
230        try {
231            super.service(request, response);
232        } catch (ServletException | IOException e) {
233            LOG.error(e.getLocalizedMessage(), e);
234            throw e;
235        } catch (Exception e) {
236            LOG.error(e.getLocalizedMessage(), e);
237            throw new RuntimeException(e);
238        }
239    }
240
241    /**
242     * Debug method for printing header information.
243     *
244     * @param request the current request
245     */
246    private void printHeaderInfo(HttpServletRequest request) {
247
248        System.out.println("--------------- " + request.getMethod() + " " + request.getRequestURI());
249        Enumeration<String> hnames = request.getHeaderNames();
250        while (hnames.hasMoreElements()) {
251            String name = hnames.nextElement();
252            System.out.println(name + ": " + EnumerationUtils.toList(request.getHeaders(name)));
253        }
254    }
255
256}