com.liferay.portal.webdav.methods.LockMethodImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-impl Show documentation
Show all versions of portal-impl Show documentation
Contains implementation for the portal services.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library 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 2.1 of the License, or (at your option)
* any later version.
*
* This library 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.
*/
package com.liferay.portal.webdav.methods;
import com.liferay.portal.NoSuchLockException;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.servlet.ServletResponseUtil;
import com.liferay.portal.kernel.util.ContentTypes;
import com.liferay.portal.kernel.util.FileUtil;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.kernel.util.StringBundler;
import com.liferay.portal.kernel.util.Time;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.kernel.webdav.Status;
import com.liferay.portal.kernel.webdav.WebDAVException;
import com.liferay.portal.kernel.webdav.WebDAVRequest;
import com.liferay.portal.kernel.webdav.WebDAVStorage;
import com.liferay.portal.kernel.webdav.WebDAVUtil;
import com.liferay.portal.kernel.webdav.methods.Method;
import com.liferay.portal.kernel.xml.Document;
import com.liferay.portal.kernel.xml.Element;
import com.liferay.portal.kernel.xml.SAXReaderUtil;
import com.liferay.portal.model.Lock;
import com.liferay.util.xml.XMLFormatter;
import java.util.List;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* @author Alexander Chow
*/
public class LockMethodImpl implements Method {
@Override
public int process(WebDAVRequest webDAVRequest) throws WebDAVException {
try {
return doProcess(webDAVRequest);
}
catch (Exception e) {
throw new WebDAVException(e);
}
}
protected int doProcess(WebDAVRequest webDAVRequest) throws Exception {
WebDAVStorage storage = webDAVRequest.getWebDAVStorage();
if (!storage.isSupportsClassTwo()) {
return HttpServletResponse.SC_METHOD_NOT_ALLOWED;
}
HttpServletRequest request = webDAVRequest.getHttpServletRequest();
HttpServletResponse response = webDAVRequest.getHttpServletResponse();
Lock lock = null;
Status status = null;
String lockUuid = webDAVRequest.getLockUuid();
long timeout = WebDAVUtil.getTimeout(request);
if (Validator.isNull(lockUuid)) {
// Create new lock
String owner = null;
String xml = new String(
FileUtil.getBytes(request.getInputStream()));
if (Validator.isNotNull(xml)) {
if (_log.isDebugEnabled()) {
_log.debug("Request XML\n" + XMLFormatter.toString(xml));
}
Document document = SAXReaderUtil.read(xml);
Element rootElement = document.getRootElement();
boolean exclusive = false;
Element lockscopeElement = rootElement.element("lockscope");
for (Element element : lockscopeElement.elements()) {
String name = GetterUtil.getString(element.getName());
if (name.equals("exclusive")) {
exclusive = true;
}
}
if (!exclusive) {
return HttpServletResponse.SC_BAD_REQUEST;
}
Element ownerElement = rootElement.element("owner");
owner = ownerElement.getTextTrim();
if (Validator.isNull(owner)) {
List hrefElements = ownerElement.elements("href");
for (Element hrefElement : hrefElements) {
owner =
"" + hrefElement.getTextTrim() +
" ";
}
}
}
else {
_log.error("Empty request XML");
return HttpServletResponse.SC_PRECONDITION_FAILED;
}
status = storage.lockResource(webDAVRequest, owner, timeout);
lock = (Lock)status.getObject();
}
else {
try {
// Refresh existing lock
lock = storage.refreshResourceLock(
webDAVRequest, lockUuid, timeout);
status = new Status(HttpServletResponse.SC_OK);
}
catch (WebDAVException wde) {
if (wde.getCause() instanceof NoSuchLockException) {
return HttpServletResponse.SC_PRECONDITION_FAILED;
}
else {
throw wde;
}
}
}
// Return lock details
if (lock == null) {
return status.getCode();
}
long depth = WebDAVUtil.getDepth(request);
String xml = getResponseXML(lock, depth);
if (_log.isDebugEnabled()) {
_log.debug("Response XML\n" + xml);
}
String lockToken = "<" + WebDAVUtil.TOKEN_PREFIX + lock.getUuid() + ">";
response.setContentType(ContentTypes.TEXT_XML_UTF8);
response.setHeader("Lock-Token", lockToken);
response.setStatus(status.getCode());
if (_log.isDebugEnabled()) {
_log.debug("Returning lock token " + lockToken);
}
try {
ServletResponseUtil.write(response, xml);
}
catch (Exception e) {
if (_log.isWarnEnabled()) {
_log.warn(e);
}
}
return status.getCode();
}
protected String getResponseXML(Lock lock, long depth) throws Exception {
StringBundler sb = new StringBundler(21);
long timeoutSecs = lock.getExpirationTime() / Time.SECOND;
sb.append("");
sb.append("");
sb.append("");
sb.append("");
sb.append(" ");
sb.append(" ");
if (depth < 0) {
sb.append("Infinity ");
}
sb.append("");
sb.append(lock.getOwner());
sb.append(" ");
sb.append("");
if (timeoutSecs > 0) {
sb.append("Second-");
sb.append(timeoutSecs);
}
else {
sb.append("Infinite");
}
sb.append(" ");
sb.append("");
sb.append(WebDAVUtil.TOKEN_PREFIX);
sb.append(lock.getUuid());
sb.append(" ");
sb.append(" ");
sb.append(" ");
sb.append(" ");
return XMLFormatter.toString(sb.toString());
}
private static Log _log = LogFactoryUtil.getLog(LockMethodImpl.class);
}