mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-14 17:58:59 +00:00
1cb0e9bdd4
* A dependency of the repository project on the remote-api project had crept in. * The dependency was stopping junit tests from being run in the Eclipse, since it does not define a dependency on remote-api by repository. git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@34213 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
552 lines
20 KiB
Java
552 lines
20 KiB
Java
/*
|
|
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
|
*
|
|
* This file is part of Alfresco
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
package org.alfresco.repo.webdav;
|
|
|
|
import java.util.Date;
|
|
import java.util.HashMap;
|
|
import java.util.Iterator;
|
|
import java.util.List;
|
|
import java.util.Timer;
|
|
import java.util.TimerTask;
|
|
|
|
import javax.servlet.http.HttpServletResponse;
|
|
|
|
import org.alfresco.model.ContentModel;
|
|
import org.alfresco.repo.security.authentication.AuthenticationUtil;
|
|
import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
|
|
import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
|
|
import org.alfresco.service.cmr.model.FileFolderService;
|
|
import org.alfresco.service.cmr.model.FileFolderUtil;
|
|
import org.alfresco.service.cmr.model.FileInfo;
|
|
import org.alfresco.service.cmr.model.FileNotFoundException;
|
|
import org.alfresco.service.cmr.repository.InvalidNodeRefException;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.namespace.QName;
|
|
import org.dom4j.io.XMLWriter;
|
|
import org.w3c.dom.Document;
|
|
import org.w3c.dom.Element;
|
|
import org.w3c.dom.Node;
|
|
|
|
/**
|
|
* Implements the WebDAV LOCK method
|
|
*
|
|
* @author gavinc
|
|
*/
|
|
public class LockMethod extends WebDAVMethod
|
|
{
|
|
public static final String EMPTY_NS = "";
|
|
|
|
private static Timer timer = new Timer(true);
|
|
|
|
protected int m_timeoutDuration = WebDAV.TIMEOUT_INFINITY;
|
|
|
|
protected LockInfo lockInfo = new LockInfoImpl();
|
|
|
|
protected boolean createExclusive;
|
|
|
|
protected String lockToken= null;
|
|
|
|
/**
|
|
* Default constructor
|
|
*/
|
|
public LockMethod()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Returns true if request has lock token in the If header
|
|
*
|
|
* @return boolean
|
|
*/
|
|
protected final boolean hasLockToken()
|
|
{
|
|
if (m_conditions != null)
|
|
{
|
|
for (Condition condition : m_conditions)
|
|
{
|
|
if (!condition.getLockTokensMatch().isEmpty())
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Return the lock timeout, in minutes
|
|
*
|
|
* @return int
|
|
*/
|
|
protected final int getLockTimeout()
|
|
{
|
|
return m_timeoutDuration;
|
|
}
|
|
|
|
/**
|
|
* Parse the request headers
|
|
*
|
|
* @exception WebDAVServerException
|
|
*/
|
|
protected void parseRequestHeaders() throws WebDAVServerException
|
|
{
|
|
// Get user Agent
|
|
|
|
m_userAgent = m_request.getHeader(WebDAV.HEADER_USER_AGENT);
|
|
|
|
// Get the depth
|
|
|
|
parseDepthHeader();
|
|
|
|
// According to the specification: "Values other than 0 or infinity MUST NOT be used with the Depth header on a LOCK method.".
|
|
// The specification does not specify the error code for this case - so we use HttpServletResponse.SC_INTERNAL_SERVER_ERROR.
|
|
if (m_depth != WebDAV.DEPTH_0 && m_depth != WebDAV.DEPTH_INFINITY)
|
|
{
|
|
throw new WebDAVServerException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
|
|
}
|
|
|
|
// Parse Lock tokens and ETags, if any
|
|
|
|
parseIfHeader();
|
|
|
|
// Get the lock timeout value
|
|
|
|
String strTimeout = m_request.getHeader(WebDAV.HEADER_TIMEOUT);
|
|
|
|
// If the timeout header starts with anything other than Second
|
|
// leave the timeout as the default
|
|
|
|
if (strTimeout != null && strTimeout.startsWith(WebDAV.SECOND))
|
|
{
|
|
try
|
|
{
|
|
// Some clients send header as Second-180 Seconds so we need to
|
|
// look for the space
|
|
|
|
int idx = strTimeout.indexOf(" ");
|
|
|
|
if (idx != -1)
|
|
{
|
|
// Get the bit after Second- and before the space
|
|
|
|
strTimeout = strTimeout.substring(WebDAV.SECOND.length(), idx);
|
|
}
|
|
else
|
|
{
|
|
// The string must be in the correct format
|
|
|
|
strTimeout = strTimeout.substring(WebDAV.SECOND.length());
|
|
}
|
|
m_timeoutDuration = Integer.parseInt(strTimeout);
|
|
}
|
|
catch (Exception e)
|
|
{
|
|
// Warn about the parse failure and leave the timeout as the
|
|
// default
|
|
|
|
logger.warn("Failed to parse Timeout header: " + strTimeout);
|
|
}
|
|
}
|
|
|
|
// DEBUG
|
|
|
|
if (logger.isDebugEnabled())
|
|
logger.debug("Timeout=" + getLockTimeout() + ", depth=" + getDepth());
|
|
}
|
|
|
|
/**
|
|
* Parse the request body
|
|
*
|
|
* @exception WebDAVServerException
|
|
*/
|
|
protected void parseRequestBody() throws WebDAVServerException
|
|
{
|
|
if (m_request.getContentLength() == -1)
|
|
{
|
|
return;
|
|
}
|
|
|
|
Document body = getRequestBodyAsDocument();
|
|
if (body != null)
|
|
{
|
|
OUTER: for (Node currentNode = body.getDocumentElement().getFirstChild(); currentNode != null; currentNode = currentNode.getNextSibling())
|
|
{
|
|
if (currentNode instanceof Element && WebDAV.DEFAULT_NAMESPACE_URI.equals(((Element) currentNode).getNamespaceURI())
|
|
&& WebDAV.XML_LOCK_SCOPE.equals(((Element) currentNode).getLocalName()))
|
|
{
|
|
for (Node propertiesNode = currentNode.getFirstChild(); propertiesNode != null; propertiesNode = propertiesNode.getNextSibling())
|
|
{
|
|
if (propertiesNode instanceof Element && WebDAV.DEFAULT_NAMESPACE_URI.equals(((Element) propertiesNode).getNamespaceURI()))
|
|
{
|
|
this.createExclusive = WebDAV.XML_EXCLUSIVE.equals(propertiesNode.getLocalName());
|
|
break OUTER;
|
|
}
|
|
}
|
|
break OUTER;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Execute the request
|
|
*
|
|
* @exception WebDAVServerException
|
|
*/
|
|
protected void executeImpl() throws WebDAVServerException, Exception
|
|
{
|
|
FileFolderService fileFolderService = getFileFolderService();
|
|
final String path = getPath();
|
|
NodeRef rootNodeRef = getRootNodeRef();
|
|
// Get the active user
|
|
final String userName = getDAVHelper().getAuthenticationService().getCurrentUserName();
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Locking node: \n" +
|
|
" user: " + userName + "\n" +
|
|
" path: " + path);
|
|
}
|
|
|
|
FileInfo lockNodeInfo = null;
|
|
try
|
|
{
|
|
// Check if the path exists
|
|
lockNodeInfo = getNodeForPath(getRootNodeRef(), getPath(), m_request.getServletPath());
|
|
}
|
|
catch (FileNotFoundException e)
|
|
{
|
|
// need to create it
|
|
String[] splitPath = getDAVHelper().splitPath(path);
|
|
// check
|
|
if (splitPath[1].length() == 0)
|
|
{
|
|
throw new WebDAVServerException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
|
|
}
|
|
|
|
FileInfo dirInfo = null;
|
|
List<String> dirPathElements = getDAVHelper().splitAllPaths(splitPath[0]);
|
|
if (dirPathElements.size() == 0)
|
|
{
|
|
// if there are no path elements we are at the root so get the root node
|
|
dirInfo = fileFolderService.getFileInfo(getRootNodeRef());
|
|
}
|
|
else
|
|
{
|
|
// make sure folder structure is present
|
|
dirInfo = FileFolderUtil.makeFolders(fileFolderService, rootNodeRef, dirPathElements, ContentModel.TYPE_FOLDER);
|
|
}
|
|
|
|
if (dirInfo == null)
|
|
{
|
|
throw new WebDAVServerException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
|
|
}
|
|
|
|
// create the file
|
|
lockNodeInfo = createNode(dirInfo.getNodeRef(), splitPath[1], ContentModel.TYPE_CONTENT);
|
|
|
|
// ALF-10309 fix, mark created node with webdavNoContent aspect, we assume that save operation
|
|
// is performed by client, webdavNoContent aspect normally removed in put method unless there
|
|
// is a cancel before the PUT request takes place
|
|
int lockTimeout = getLockTimeout();
|
|
if (lockTimeout > 0 &&
|
|
!getNodeService().hasAspect(lockNodeInfo.getNodeRef(), ContentModel.ASPECT_WEBDAV_NO_CONTENT))
|
|
{
|
|
final NodeRef nodeRef = lockNodeInfo.getNodeRef();
|
|
getNodeService().addAspect(nodeRef, ContentModel.ASPECT_WEBDAV_NO_CONTENT, null);
|
|
|
|
// Remove node after the timeout (MS Office 2003 requests 3 minutes) if the PUT or UNLOCK has not taken place
|
|
timer.schedule(new TimerTask()
|
|
{
|
|
@Override
|
|
public void run()
|
|
{
|
|
// run as current user
|
|
AuthenticationUtil.runAs(new RunAsWork<Void>()
|
|
{
|
|
@Override
|
|
public Void doWork() throws Exception
|
|
{
|
|
try
|
|
{
|
|
if (getNodeService().hasAspect(nodeRef, ContentModel.ASPECT_WEBDAV_NO_CONTENT))
|
|
{
|
|
getTransactionService().getRetryingTransactionHelper().doInTransaction(
|
|
new RetryingTransactionCallback<String>()
|
|
{
|
|
public String execute() throws Throwable
|
|
{
|
|
getNodeService().removeAspect(nodeRef, ContentModel.ASPECT_WEBDAV_NO_CONTENT);
|
|
getNodeService().deleteNode(nodeRef);
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Timer DELETE " + path);
|
|
}
|
|
return null;
|
|
}
|
|
}, false, true);
|
|
}
|
|
else if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Timer IGNORE " + path);
|
|
}
|
|
}
|
|
catch (InvalidNodeRefException e)
|
|
{
|
|
// Might get this if the node is deleted. If so just ignore.
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Timer DOES NOT EXIST " + path);
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
}, userName);
|
|
}
|
|
}, lockTimeout*1000);
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Timer START in " + lockTimeout + " seconds "+ path);
|
|
}
|
|
}
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Created new node for lock: \n" +
|
|
" path: " + path + "\n" +
|
|
" node: " + lockNodeInfo);
|
|
}
|
|
|
|
m_response.setStatus(HttpServletResponse.SC_CREATED);
|
|
}
|
|
|
|
// Check if this is a new lock or a lock refresh
|
|
if (hasLockToken())
|
|
{
|
|
lockInfo = checkNode(lockNodeInfo);
|
|
lockInfo.getRWLock().writeLock().lock();
|
|
try
|
|
{
|
|
// If a request body is not defined and "If" header is sent we have createExclusive as false,
|
|
// but we need to check a previous LOCK was an exclusive. I.e. get the property for node. It
|
|
// is already has got in a checkNode method, so we need just get a scope from lockInfo.
|
|
// This particular case was raised as ALF-4008.
|
|
this.createExclusive = WebDAV.XML_EXCLUSIVE.equals(this.lockInfo.getScope());
|
|
// Refresh an existing lock
|
|
refreshLock(lockNodeInfo, userName);
|
|
}
|
|
finally
|
|
{
|
|
lockInfo.getRWLock().writeLock().unlock();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
lockInfo = checkNode(lockNodeInfo, true, createExclusive);
|
|
lockInfo.getRWLock().writeLock().lock();
|
|
try
|
|
{
|
|
// Create a new lock
|
|
createLock(lockNodeInfo, userName);
|
|
}
|
|
finally
|
|
{
|
|
lockInfo.getRWLock().writeLock().unlock();
|
|
}
|
|
}
|
|
|
|
|
|
m_response.setHeader(WebDAV.HEADER_LOCK_TOKEN, "<" + WebDAV.makeLockToken(lockNodeInfo.getNodeRef(), userName) + ">");
|
|
m_response.setHeader(WebDAV.HEADER_CONTENT_TYPE, WebDAV.XML_CONTENT_TYPE);
|
|
|
|
// We either created a new lock or refreshed an existing lock, send back the lock details
|
|
generateResponse(lockNodeInfo, userName);
|
|
}
|
|
|
|
/**
|
|
* Create a new node
|
|
*
|
|
* @param parentNodeRef the parent node.
|
|
* @param name the name of the node
|
|
* @param typeQName the type to create
|
|
* @return Returns the new node's file information
|
|
*
|
|
*/
|
|
protected FileInfo createNode(NodeRef parentNodeRef, String name, QName typeQName)
|
|
{
|
|
return getFileFolderService().create(parentNodeRef, name, ContentModel.TYPE_CONTENT);
|
|
}
|
|
|
|
/**
|
|
* Create a new lock
|
|
*
|
|
* @param lockNode NodeRef
|
|
* @param userName String
|
|
* @exception WebDAVServerException
|
|
*/
|
|
protected final void createLock(FileInfo lockNode, String userName) throws WebDAVServerException
|
|
{
|
|
// Create Lock token
|
|
lockToken = WebDAV.makeLockToken(lockNode.getNodeRef(), userName);
|
|
|
|
lockInfo.getRWLock().writeLock().lock();
|
|
try
|
|
{
|
|
if (createExclusive)
|
|
{
|
|
// Lock the node
|
|
lockInfo.setTimeoutSeconds(getLockTimeout());
|
|
lockInfo.setExclusiveLockToken(lockToken);
|
|
}
|
|
else
|
|
{
|
|
lockInfo.addSharedLockToken(lockToken);
|
|
}
|
|
|
|
// Store lock depth
|
|
lockInfo.setDepth(WebDAV.getDepthName(m_depth));
|
|
// Store lock scope (shared/exclusive)
|
|
String scope = createExclusive ? WebDAV.XML_EXCLUSIVE : WebDAV.XML_SHARED;
|
|
lockInfo.setScope(scope);
|
|
// Store the owner of this lock
|
|
lockInfo.setOwner(userName);
|
|
// Lock the node
|
|
getLockStore().put(lockNode.getNodeRef(), lockInfo);
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Locked node " + lockNode + ": " + lockInfo);
|
|
}
|
|
}
|
|
finally
|
|
{
|
|
lockInfo.getRWLock().writeLock().unlock();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Refresh an existing lock
|
|
*
|
|
* @param lockNode NodeRef
|
|
* @param userName String
|
|
* @exception WebDAVServerException
|
|
*/
|
|
protected final void refreshLock(FileInfo lockNode, String userName) throws WebDAVServerException
|
|
{
|
|
if (this.createExclusive)
|
|
{
|
|
lockInfo.getRWLock().writeLock().lock();
|
|
try
|
|
{
|
|
// Update the expiry for the lock
|
|
lockInfo.setTimeoutSeconds(getLockTimeout());
|
|
}
|
|
finally
|
|
{
|
|
lockInfo.getRWLock().writeLock().unlock();
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generates the XML lock discovery response body
|
|
*/
|
|
protected void generateResponse(FileInfo lockNodeInfo, String userName) throws Exception
|
|
{
|
|
String scope;
|
|
String lt;
|
|
String owner;
|
|
Date expiry;
|
|
|
|
lockInfo.getRWLock().readLock().lock();
|
|
try
|
|
{
|
|
if (lockToken != null)
|
|
{
|
|
// In case of lock creation take the scope from request header
|
|
scope = this.createExclusive ? WebDAV.XML_EXCLUSIVE : WebDAV.XML_SHARED;
|
|
// Output created lock
|
|
lt = lockToken;
|
|
}
|
|
else
|
|
{
|
|
// In case of lock refreshing take the scope from previously stored lock
|
|
scope = this.lockInfo.getScope();
|
|
// Output refreshed lock
|
|
lt = this.lockInfo.getExclusiveLockToken();
|
|
}
|
|
owner = lockInfo.getOwner();
|
|
expiry = lockInfo.getExpires();
|
|
}
|
|
finally
|
|
{
|
|
lockInfo.getRWLock().readLock().unlock();
|
|
}
|
|
|
|
XMLWriter xml = createXMLWriter();
|
|
|
|
xml.startDocument();
|
|
|
|
String nsdec = generateNamespaceDeclarations(null);
|
|
xml.startElement(WebDAV.DAV_NS, WebDAV.XML_PROP + nsdec, WebDAV.XML_NS_PROP + nsdec, getDAVHelper().getNullAttributes());
|
|
|
|
// Output the lock details
|
|
generateLockDiscoveryXML(xml, lockNodeInfo, false, scope, WebDAV.getDepthName(m_depth), lt, owner, expiry);
|
|
|
|
// Close off the XML
|
|
xml.endElement(WebDAV.DAV_NS, WebDAV.XML_PROP, WebDAV.XML_NS_PROP);
|
|
|
|
|
|
}
|
|
|
|
/**
|
|
* Generates a list of namespace declarations for the response
|
|
*/
|
|
protected String generateNamespaceDeclarations(HashMap<String,String> nameSpaces)
|
|
{
|
|
StringBuilder ns = new StringBuilder();
|
|
|
|
ns.append(" ");
|
|
ns.append(WebDAV.XML_NS);
|
|
ns.append(":");
|
|
ns.append(WebDAV.DAV_NS);
|
|
ns.append("=\"");
|
|
ns.append(WebDAV.DEFAULT_NAMESPACE_URI);
|
|
ns.append("\"");
|
|
|
|
// Add additional namespaces
|
|
|
|
if ( nameSpaces != null)
|
|
{
|
|
Iterator<String> namespaceList = nameSpaces.keySet().iterator();
|
|
|
|
while (namespaceList.hasNext())
|
|
{
|
|
String strNamespaceUri = namespaceList.next();
|
|
String strNamespaceName = nameSpaces.get(strNamespaceUri);
|
|
|
|
ns.append(" ").append(WebDAV.XML_NS).append(":").append(strNamespaceName).append("=\"");
|
|
ns.append(strNamespaceUri).append("\" ");
|
|
}
|
|
}
|
|
|
|
return ns.toString();
|
|
}
|
|
}
|