net.sf.webdav.methods.DoPut Maven / Gradle / Ivy

/**
 * Copyright (C) 2006-2017 Apache Software Foundation (https://sourceforge.net/p/webdav-servlet, https://github.com/Commonjava/webdav-handler)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.sf.webdav.methods;

import static net.sf.webdav.WebdavStatus.SC_BAD_REQUEST;
import static net.sf.webdav.WebdavStatus.SC_CREATED;
import static net.sf.webdav.WebdavStatus.SC_FORBIDDEN;
import static net.sf.webdav.WebdavStatus.SC_INTERNAL_SERVER_ERROR;
import static net.sf.webdav.WebdavStatus.SC_LOCKED;
import static net.sf.webdav.WebdavStatus.SC_NOT_FOUND;
import static net.sf.webdav.WebdavStatus.SC_NO_CONTENT;

import java.io.IOException;
import java.util.Hashtable;

import net.sf.webdav.StoredObject;
import net.sf.webdav.WebdavStatus;
import net.sf.webdav.exceptions.AccessDeniedException;
import net.sf.webdav.exceptions.LockFailedException;
import net.sf.webdav.exceptions.WebdavException;
import net.sf.webdav.locking.IResourceLocks;
import net.sf.webdav.locking.LockedObject;
import net.sf.webdav.spi.ITransaction;
import net.sf.webdav.spi.IWebdavStore;
import net.sf.webdav.spi.WebdavRequest;
import net.sf.webdav.spi.WebdavResponse;

public class DoPut
    extends AbstractMethod
{

    private static org.slf4j.Logger LOG = org.slf4j.LoggerFactory.getLogger( DoPut.class );

    private final IWebdavStore _store;

    private final IResourceLocks _resourceLocks;

    private final boolean _readOnly;

    private final boolean _lazyFolderCreationOnPut;

    private String _userAgent;

    public DoPut( final IWebdavStore store, final IResourceLocks resLocks, final boolean readOnly, final boolean lazyFolderCreationOnPut )
    {
        _store = store;
        _resourceLocks = resLocks;
        _readOnly = readOnly;
        _lazyFolderCreationOnPut = lazyFolderCreationOnPut;
    }

    @Override
    public void execute( final ITransaction transaction, final WebdavRequest req, final WebdavResponse resp )
        throws IOException, LockFailedException
    {
        LOG.trace( "-- " + this.getClass()
                               .getName() );

        if ( !_readOnly )
        {
            final String path = getRelativePath( req );
            final String parentPath = getParentPath( path );

            _userAgent = req.getHeader( "User-Agent" );

            final Hashtable errorList = new Hashtable();

            if ( !checkLocks( transaction, req, resp, _resourceLocks, parentPath ) )
            {
                errorList.put( parentPath, SC_LOCKED );
                sendReport( req, resp, errorList );
                return; // parent is locked
            }

            if ( !checkLocks( transaction, req, resp, _resourceLocks, path ) )
            {
                errorList.put( path, SC_LOCKED );
                sendReport( req, resp, errorList );
                return; // resource is locked
            }

            final String tempLockOwner = "doPut" + System.currentTimeMillis() + req.toString();
            if ( _resourceLocks.lock( transaction, path, tempLockOwner, false, 0, TEMP_TIMEOUT, TEMPORARY ) )
            {
                StoredObject parentSo, so = null;
                try
                {
                    parentSo = _store.getStoredObject( transaction, parentPath );
                    if ( parentPath != null && parentSo != null && parentSo.isResource() )
                    {
                        resp.sendError( SC_FORBIDDEN );
                        return;

                    }
                    else if ( parentPath != null && parentSo == null && _lazyFolderCreationOnPut )
                    {
                        _store.createFolder( transaction, parentPath );

                    }
                    else if ( parentPath != null && parentSo == null && !_lazyFolderCreationOnPut )
                    {
                        errorList.put( parentPath, SC_NOT_FOUND );
                        sendReport( req, resp, errorList );
                        return;
                    }

                    so = _store.getStoredObject( transaction, path );

                    if ( so == null )
                    {
                        _store.createResource( transaction, path );
                        // resp.setStatus(SC_CREATED);
                    }
                    else
                    {
                        // This has already been created, just update the data
                        if ( so.isNullResource() )
                        {

                            final LockedObject nullResourceLo = _resourceLocks.getLockedObjectByPath( transaction, path );
                            if ( nullResourceLo == null )
                            {
                                resp.sendError( SC_INTERNAL_SERVER_ERROR );
                                return;
                            }
                            final String nullResourceLockToken = nullResourceLo.getID();
                            final String[] lockTokens = getLockIdFromIfHeader( req );
                            String lockToken = null;
                            if ( lockTokens != null )
                            {
                                lockToken = lockTokens[0];
                            }
                            else
                            {
                                resp.sendError( SC_BAD_REQUEST );
                                return;
                            }
                            if ( lockToken.equals( nullResourceLockToken ) )
                            {
                                so.setNullResource( false );
                                so.setFolder( false );

                                final String[] nullResourceLockOwners = nullResourceLo.getOwner();
                                String owner = null;
                                if ( nullResourceLockOwners != null )
                                {
                                    owner = nullResourceLockOwners[0];
                                }

                                if ( !_resourceLocks.unlock( transaction, lockToken, owner ) )
                                {
                                    resp.sendError( SC_INTERNAL_SERVER_ERROR );
                                }
                            }
                            else
                            {
                                errorList.put( path, SC_LOCKED );
                                sendReport( req, resp, errorList );
                            }
                        }
                    }
                    // User-Agent workarounds
                    doUserAgentWorkaround( resp );

                    // setting resourceContent
                    final long resourceLength = _store.setResourceContent( transaction, path, req.getInputStream(), req.getContentLength());

                    so = _store.getStoredObject( transaction, path );
                    if ( resourceLength != -1 )
                    {
                        so.setResourceLength( resourceLength );
                        // Now lets report back what was actually saved
                    }

                }
                catch ( final AccessDeniedException e )
                {
                    resp.sendError( SC_FORBIDDEN );
                }
                catch ( final WebdavException e )
                {
                    resp.sendError( SC_INTERNAL_SERVER_ERROR );
                }
                finally
                {
                    _resourceLocks.unlockTemporaryLockedObjects( transaction, path, tempLockOwner );
                }
            }
            else
            {
                resp.sendError( SC_INTERNAL_SERVER_ERROR );
            }
        }
        else
        {
            resp.sendError( SC_FORBIDDEN );
        }

    }

    /**
     * @param resp
     */
    private void doUserAgentWorkaround( final WebdavResponse resp )
    {
        if ( _userAgent != null && _userAgent.indexOf( "WebDAVFS" ) != -1 && _userAgent.indexOf( "Transmit" ) == -1 )
        {
            LOG.trace( "DoPut.execute() : do workaround for user agent '" + _userAgent + "'" );
            resp.setStatus( SC_CREATED );
        }
        else if ( _userAgent != null && _userAgent.indexOf( "Transmit" ) != -1 )
        {
            // Transmit also uses WEBDAVFS 1.x.x but crashes
            // with SC_CREATED response
            LOG.trace( "DoPut.execute() : do workaround for user agent '" + _userAgent + "'" );
            resp.setStatus( SC_NO_CONTENT );
        }
        else
        {
            resp.setStatus( SC_CREATED );
        }
    }
}