Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 1999,2004 The Apache Software Foundation.
*
* 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 nl.info.webdav.methods;
import nl.info.webdav.IMethodExecutor;
import nl.info.webdav.ITransaction;
import nl.info.webdav.StoredObject;
import nl.info.webdav.WebdavStatus;
import nl.info.webdav.fromcatalina.URLEncoder;
import nl.info.webdav.fromcatalina.XMLWriter;
import nl.info.webdav.locking.IResourceLocks;
import nl.info.webdav.locking.LockedObject;
import java.io.IOException;
import java.io.Writer;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Locale;
import java.util.TimeZone;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
/**
* Abstract base class for the implementation of the different WebDAV methods.
*/
public abstract class AbstractMethod implements IMethodExecutor {
private static final ThreadLocal thLastModifiedDateFormat = new ThreadLocal<>();
private static final ThreadLocal thCreationDateFormat = new ThreadLocal<>();
private static final ThreadLocal thLocalDateFormat = new ThreadLocal<>();
/**
* Array containing the safe characters set.
*/
protected static URLEncoder URL_ENCODER;
/**
* Default depth is infite.
*/
protected static final int INFINITY = 3;
/**
* Simple date format for the creation date ISO 8601 representation
* (partial).
*/
protected static final String CREATION_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'";
/**
* Simple date format for the last modified date. (RFC 822 updated by RFC
* 1123)
*/
protected static final String LAST_MODIFIED_DATE_FORMAT = "EEE, dd MMM yyyy HH:mm:ss z";
/**
* Format for local date values.
*/
protected static final String LOCAL_DATE_FORMAT = "dd/MM/yy' 'HH:mm:ss";
static {
// GMT timezone - all HTTP dates are on GMT
URL_ENCODER = new URLEncoder();
URL_ENCODER.addSafeCharacter('-');
URL_ENCODER.addSafeCharacter('_');
URL_ENCODER.addSafeCharacter('.');
URL_ENCODER.addSafeCharacter('*');
URL_ENCODER.addSafeCharacter('/');
}
/**
* size of the io-buffer
*/
protected static int BUF_SIZE = 65536;
/**
* Default lock timeout value.
*/
protected static final int DEFAULT_TIMEOUT = 3600;
/**
* Maximum lock timeout.
*/
protected static final int MAX_TIMEOUT = 604800;
/**
* Boolean value to temporary lock resources (for method locks)
*/
protected static final boolean TEMPORARY = true;
/**
* Timeout for temporary locks
*/
protected static final int TEMP_TIMEOUT = 10;
public static String lastModifiedDateFormat(final Date date) {
DateFormat df = thLastModifiedDateFormat.get();
if( df == null ) {
df = new SimpleDateFormat(LAST_MODIFIED_DATE_FORMAT, Locale.US);
df.setTimeZone(TimeZone.getTimeZone("GMT"));
thLastModifiedDateFormat.set( df );
}
return df.format(date);
}
public static String creationDateFormat(final Date date) {
DateFormat df = thCreationDateFormat.get();
if( df == null ) {
df = new SimpleDateFormat(CREATION_DATE_FORMAT);
df.setTimeZone(TimeZone.getTimeZone("GMT"));
thCreationDateFormat.set( df );
}
return df.format(date);
}
public static String getLocalDateFormat(final Date date, final Locale loc) {
DateFormat df = thLocalDateFormat.get();
if( df == null ) {
df = new SimpleDateFormat(LOCAL_DATE_FORMAT, loc);
}
return df.format(date);
}
/**
* Return the relative path associated with this servlet.
*
* @param request the servlet request we are processing
* @return the relative servlet path
*/
protected String getRelativePath(HttpServletRequest request) {
// Are we being processed by a RequestDispatcher.include()?
if (request.getAttribute("javax.servlet.include.request_uri") != null) {
String result = (String) request.getAttribute("javax.servlet.include.path_info");
// if (result == null)
// result = (String) request
// .getAttribute("javax.servlet.include.servlet_path");
if ((result == null) || (result.isEmpty()))
result = "/";
return result;
}
// No, extract the desired path directly from the request
String result = request.getPathInfo();
// if (result == null) {
// result = request.getServletPath();
// }
if ((result == null) || (result.isEmpty())) {
result = "/";
}
return result;
}
/**
* creates the parent path from the given path by removing the last '/' and
* everything after that
*
* @param path the path
* @return parent path
*/
protected String getParentPath(String path) {
int slash = path.lastIndexOf('/');
if (slash != -1) {
return path.substring(0, slash);
}
return null;
}
/**
* removes a / at the end of the path string, if present
*
* @param path the path
* @return the path without trailing /
*/
protected String getCleanPath(String path) {
if (path.endsWith("/") && path.length() > 1)
path = path.substring(0, path.length() - 1);
return path;
}
/**
* Return JAXP document builder instance.
*
* @return the document builder
* @throws ServletException when the builder could not be constructed
*/
protected DocumentBuilder getDocumentBuilder() throws ServletException {
try {
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
return documentBuilderFactory.newDocumentBuilder();
} catch (ParserConfigurationException e) {
throw new ServletException("Failed to construct a JAXP document builder", e);
}
}
/**
* reads the depth header from the request and returns it as a int
*
* @param httpServletRequest the servlet request
* @return the depth from the depth header
*/
protected int getDepth(HttpServletRequest httpServletRequest) {
int depth = INFINITY;
String depthStr = httpServletRequest.getHeader("Depth");
if (depthStr != null) {
if (depthStr.equals("0")) {
depth = 0;
} else if (depthStr.equals("1")) {
depth = 1;
}
}
return depth;
}
/**
* URL rewriter.
*
* @param path path which has to be rewiten
* @return the rewritten path
*/
protected String rewriteUrl(String path) {
return URL_ENCODER.encode(path);
}
/**
* Get the ETag for with a stored object.
*
* @param storedObject the stored object
* @return the ETag as a string
*/
protected String getETag(StoredObject storedObject) {
String resourceLength = "";
String lastModified = "";
if (storedObject != null && storedObject.isResource()) {
resourceLength = Long.valueOf(storedObject.getResourceLength()).toString();
lastModified = Long.valueOf(storedObject.getLastModified().getTime()).toString();
}
return "W/\"" + resourceLength + "-" + lastModified + "\"";
}
protected String[] getLockIdFromIfHeader(HttpServletRequest req) {
String[] ids = new String[2];
String id = req.getHeader("If");
if (id != null && !id.isEmpty()) {
if (id.indexOf(">)") == id.lastIndexOf(">)")) {
id = id.substring(id.indexOf("(<"), id.indexOf(">)"));
if (id.contains("locktoken:")) {
id = id.substring(id.indexOf(':') + 1);
}
ids[0] = id;
} else {
String firstId = id.substring(id.indexOf("(<"), id.indexOf(">)"));
if (firstId.contains("locktoken:")) {
firstId = firstId.substring(firstId.indexOf(':') + 1);
}
ids[0] = firstId;
String secondId = id.substring(id.lastIndexOf("(<"), id
.lastIndexOf(">)"));
if (secondId.contains("locktoken:")) {
secondId = secondId.substring(secondId.indexOf(':') + 1);
}
ids[1] = secondId;
}
} else {
ids = null;
}
return ids;
}
protected String getLockIdFromLockTokenHeader(HttpServletRequest req) {
String id = req.getHeader("Lock-Token");
if (id != null) {
id = id.substring(id.indexOf(":") + 1, id.indexOf(">"));
}
return id;
}
/**
* Checks if locks on resources at the given path exists and if so checks
* the If-Header to make sure the If-Header corresponds to the locked
* resource. Returning true if no lock exists or the If-Header is
* corresponding to the locked resource
*
* @param transaction the current WebDAV transaction
* @param httpServletRequest servlet request
* @param resourceLocks resource locks
* @param path path to the resource
* @return true if no lock on a resource with the given path exists or if
* the If-Header corresponds to the locked resource
*/
protected boolean checkLocks(
ITransaction transaction,
HttpServletRequest httpServletRequest,
IResourceLocks resourceLocks,
String path
) {
LockedObject loByPath = resourceLocks.getLockedObjectByPath(
transaction, path);
if (loByPath != null) {
if (loByPath.isShared())
return true;
// the resource is locked
String[] lockTokens = getLockIdFromIfHeader(httpServletRequest);
String lockToken = null;
if (lockTokens != null)
lockToken = lockTokens[0];
else {
return false;
}
if (lockToken != null) {
LockedObject loByIf = resourceLocks.getLockedObjectByID(
transaction, lockToken);
if (loByIf == null) {
// no locked resource to the given lockToken
return false;
}
if (!loByIf.equals(loByPath)) {
return false;
}
}
}
return true;
}
/**
* Send a multi-status element containing a complete error report to the
* client. If the errorList contains only one error, send the error
* directly without wrapping it in a multi-status message.
*
* @param req servlet request
* @param resp servlet response
* @param errorList list of error to be displayed
* @throws IOException if an error occurs while sending the error report
*/
protected void sendReport(
HttpServletRequest req,
HttpServletResponse resp,
Hashtable errorList
) throws IOException {
if (errorList.size() == 1) {
int code = errorList.elements().nextElement();
if (WebdavStatus.getStatusText(code) != "") {
resp.sendError(code, WebdavStatus.getStatusText(code));
} else {
resp.sendError(code);
}
}
else {
resp.setStatus(WebdavStatus.SC_MULTI_STATUS);
HashMap namespaces = new HashMap<>();
namespaces.put("DAV:", "D");
XMLWriter generatedXML = new XMLWriter(namespaces);
generatedXML.writeXMLHeader();
generatedXML.writeElement("DAV::multistatus", XMLWriter.OPENING);
Enumeration pathList = errorList.keys();
while (pathList.hasMoreElements()) {
String errorPath = pathList.nextElement();
int errorCode = errorList.get(errorPath);
generatedXML.writeElement("DAV::response", XMLWriter.OPENING);
generatedXML.writeElement("DAV::href", XMLWriter.OPENING);
generatedXML.writeText(errorPath);
generatedXML.writeElement("DAV::href", XMLWriter.CLOSING);
generatedXML.writeElement("DAV::status", XMLWriter.OPENING);
generatedXML.writeText("HTTP/1.1 " + errorCode + " "
+ WebdavStatus.getStatusText(errorCode));
generatedXML.writeElement("DAV::status", XMLWriter.CLOSING);
generatedXML.writeElement("DAV::response", XMLWriter.CLOSING);
}
generatedXML.writeElement("DAV::multistatus", XMLWriter.CLOSING);
Writer writer = resp.getWriter();
writer.write(generatedXML.toString());
writer.close();
}
}
}
