/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.jackrabbit.webdav.jcr;
import org.apache.jackrabbit.util.Text;
import org.apache.jackrabbit.webdav.DavCompliance;
import org.apache.jackrabbit.webdav.DavException;
import org.apache.jackrabbit.webdav.DavResource;
import org.apache.jackrabbit.webdav.DavResourceFactory;
import org.apache.jackrabbit.webdav.DavResourceLocator;
import org.apache.jackrabbit.webdav.DavServletResponse;
import org.apache.jackrabbit.webdav.io.OutputContext;
import org.apache.jackrabbit.webdav.jcr.nodetype.ItemDefinitionImpl;
import org.apache.jackrabbit.webdav.jcr.nodetype.NodeDefinitionImpl;
import org.apache.jackrabbit.webdav.jcr.nodetype.PropertyDefinitionImpl;
import org.apache.jackrabbit.webdav.jcr.property.JcrDavPropertyNameSet;
import org.apache.jackrabbit.webdav.observation.EventDiscovery;
import org.apache.jackrabbit.webdav.observation.ObservationConstants;
import org.apache.jackrabbit.webdav.observation.ObservationResource;
import org.apache.jackrabbit.webdav.observation.Subscription;
import org.apache.jackrabbit.webdav.observation.SubscriptionInfo;
import org.apache.jackrabbit.webdav.observation.SubscriptionManager;
import org.apache.jackrabbit.webdav.property.DavProperty;
import org.apache.jackrabbit.webdav.property.DavPropertyName;
import org.apache.jackrabbit.webdav.property.DefaultDavProperty;
import org.apache.jackrabbit.webdav.property.HrefProperty;
import org.apache.jackrabbit.webdav.transaction.TxLockEntry;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.jcr.Item;
import javax.jcr.Node;
import javax.jcr.PathNotFoundException;
import javax.jcr.Property;
import javax.jcr.RepositoryException;
import javax.jcr.Workspace;
import java.io.IOException;
/**
* <code>AbstractItemResource</code> covers common functionality for the various
* resources, that represent a repository item.
*/
abstract class AbstractItemResource extends AbstractResource implements
ObservationResource, ItemResourceConstants {
private static Logger log = LoggerFactory.getLogger(AbstractItemResource.class);
private SubscriptionManager subsMgr;
protected final Item item;
/**
* Create a new <code>AbstractItemResource</code>.
*
* @param locator
* @param session
* @param factory
* @param item
*/
AbstractItemResource(DavResourceLocator locator, JcrDavSession session,
DavResourceFactory factory, Item item) {
super(locator, session, factory);
this.item = item;
// initialize the supported locks and reports
initLockSupport();
initSupportedReports();
}
//----------------------------------------------< DavResource interface >---
/**
* @see org.apache.jackrabbit.webdav.DavResource#getComplianceClass()
*/
@Override
public String getComplianceClass() {
return DavCompliance.concatComplianceClasses(
new String[] {
super.getComplianceClass(),
DavCompliance.OBSERVATION,
}
);
}
@Override
public DavProperty<?> getProperty(DavPropertyName name) {
DavProperty prop = super.getProperty(name);
if (prop == null) {
if (JCR_DEFINITION.equals(name)) {
if (exists()) {
try {
// protected 'definition' property revealing the item definition
ItemDefinitionImpl val;
if (item.isNode()) {
val = NodeDefinitionImpl.create(((Node)item).getDefinition());
} else {
val = PropertyDefinitionImpl.create(((Property)item).getDefinition());
}
prop = new DefaultDavProperty<ItemDefinitionImpl>(JCR_DEFINITION, val, true);
} catch (RepositoryException e) {
// should not get here
log.error("Error while accessing item definition: " + e.getMessage());
}
}
} else if (JCR_ISNEW.equals(name)) {
// transaction resource additional protected properties
if (exists() && item.isNew()) {
prop = new DefaultDavProperty<String>(JCR_ISNEW, null, true);
}
} else if (JCR_ISMODIFIED.equals(name)) {
// transaction resource additional protected properties
if (exists() && item.isModified()) {
prop = new DefaultDavProperty<String>(JCR_ISMODIFIED, null, true);
}
} else if (ObservationConstants.SUBSCRIPTIONDISCOVERY.equals(name)) {
// observation resource
prop = subsMgr.getSubscriptionDiscovery(this);
}
}
return prop;
}
/**
* @see org.apache.jackrabbit.webdav.DavResource#getSupportedMethods()
*/
@Override
public String getSupportedMethods() {
return ItemResourceConstants.METHODS;
}
/**
* Returns true if there exists a {@link Item repository item} with the given
* resource path, false otherwise.
*
* @see org.apache.jackrabbit.webdav.DavResource#exists()
*/
@Override
public boolean exists() {
return item != null;
}
/**
* Retrieves the last segment of the item path (or the resource path if
* this resource does not exist). An item path is in addition first translated
* to the corresponding resource path.<br>
* NOTE: the display name is not equivalent to {@link Item#getName() item name}
* which is exposed with the {@link ItemResourceConstants#JCR_NAME
* {http://www.day.com/jcr/webdav/1.0}name} property.
*
* @see org.apache.jackrabbit.webdav.DavResource#getDisplayName()
*/
@Override
public String getDisplayName() {
String resPath = getResourcePath();
return (resPath != null) ? Text.getName(resPath) : resPath;
}
/**
* Spools the properties of this resource to the context. Note that subclasses
* are in charge of spooling the data to the output stream provided by the
* context.
*
* @see DavResource#spool(OutputContext)
*/
@Override
public void spool(OutputContext outputContext) throws IOException {
if (!initedProps) {
initProperties();
}
// export properties
outputContext.setModificationTime(getModificationTime());
DavProperty<?> etag = getProperty(DavPropertyName.GETETAG);
if (etag != null) {
outputContext.setETag(String.valueOf(etag.getValue()));
}
DavProperty<?> contentType = getProperty(DavPropertyName.GETCONTENTTYPE);
if (contentType != null) {
outputContext.setContentType(String.valueOf(contentType.getValue()));
}
DavProperty<?> contentLength = getProperty(DavPropertyName.GETCONTENTLENGTH);
if (contentLength != null) {
try {
long length = Long.parseLong(contentLength.getValue() + "");
if (length > 0) {
outputContext.setContentLength(length);
}
} catch (NumberFormatException e) {
log.error("Could not build content length from property value '" + contentLength.getValue() + "'");
}
}
DavProperty<?> contentLanguage = getProperty(DavPropertyName.GETCONTENTLANGUAGE);
if (contentLanguage != null) {
outputContext.setContentLanguage(contentLanguage.getValue().toString());
}
}
/**
* Returns the resource representing the parent item of the repository item
* represented by this resource. If this resoure represents the root item
* a {@link RootCollection} is returned.
*
* @return the collection this resource is internal member of. Except for the
* repository root, the returned collection always represent the parent
* repository node.
* @see org.apache.jackrabbit.webdav.DavResource#getCollection()
*/
@Override
public DavResource getCollection() {
DavResource collection = null;
String parentPath = Text.getRelativeParent(getResourcePath(), 1);
DavResourceLocator parentLoc = getLocator().getFactory().createResourceLocator(getLocator().getPrefix(), getLocator().getWorkspacePath(), parentPath);
try {
collection = createResourceFromLocator(parentLoc);
} catch (DavException e) {
log.error("Unexpected error while retrieving collection: " + e.getMessage());
}
return collection;
}
/**
* Moves the underlying repository item to the indicated destination.
*
* @param destination
* @throws DavException
* @see DavResource#move(DavResource)
* @see javax.jcr.Session#move(String, String)
*/
@Override
public void move(DavResource destination) throws DavException {
if (!exists()) {
throw new DavException(DavServletResponse.SC_NOT_FOUND);
}
DavResourceLocator destLocator = destination.getLocator();
if (!getLocator().isSameWorkspace(destLocator)) {
throw new DavException(DavServletResponse.SC_FORBIDDEN);
}
try {
String itemPath = getLocator().getRepositoryPath();
String destItemPath = destination.getLocator().getRepositoryPath();
if (getTransactionId() == null) {
// if not part of a transaction directly import on workspace
getRepositorySession().getWorkspace().move(itemPath, destItemPath);
} else {
// changes will not be persisted unless the tx is completed.
getRepositorySession().move(itemPath, destItemPath);
}
// no use in calling 'complete' that would fail for a moved item anyway.
} catch (PathNotFoundException e) {
// according to rfc 2518
throw new DavException(DavServletResponse.SC_CONFLICT, e.getMessage());
} catch (RepositoryException e) {
throw new JcrDavException(e);
}
}
/**
* Copies the underlying repository item to the indicated destination. If
* the locator of the specified destination resource indicates a different
* workspace, {@link Workspace#copy(String, String, String)} is used to perform
* the copy operation, {@link Workspace#copy(String, String)} otherwise.
* <p>
* Note, that this implementation does not support shallow copy.
*
* @param destination
* @param shallow
* @throws DavException
* @see DavResource#copy(DavResource, boolean)
* @see Workspace#copy(String, String)
* @see Workspace#copy(String, String, String)
*/
@Override
public void copy(DavResource destination, boolean shallow) throws DavException {
if (!exists()) {
throw new DavException(DavServletResponse.SC_NOT_FOUND);
}
// TODO: support shallow and deep copy is required by RFC 2518
if (shallow) {
throw new DavException(DavServletResponse.SC_FORBIDDEN, "Unable to perform shallow copy.");
}
try {
String itemPath = getLocator().getRepositoryPath();
String destItemPath = destination.getLocator().getRepositoryPath();
Workspace workspace = getRepositorySession().getWorkspace();
if (getLocator().isSameWorkspace(destination.getLocator())) {
workspace.copy(itemPath, destItemPath);
} else {
log.error("Copy between workspaces is not yet implemented (src: '" + getHref() + "', dest: '" + destination.getHref() + "')");
throw new DavException(DavServletResponse.SC_NOT_IMPLEMENTED);
}
} catch (PathNotFoundException e) {
// according to RFC 2518, should not occur
throw new DavException(DavServletResponse.SC_NOT_FOUND, e.getMessage());
} catch (RepositoryException e) {
throw new JcrDavException(e);
}
}
//--------------------------------------< ObservationResource interface >---
/**
* @see ObservationResource#init(SubscriptionManager)
*/
@Override
public void init(SubscriptionManager subsMgr) {
this.subsMgr = subsMgr;
}
/**
* @see ObservationResource#subscribe(org.apache.jackrabbit.webdav.observation.SubscriptionInfo, String)
* @see SubscriptionManager#subscribe(org.apache.jackrabbit.webdav.observation.SubscriptionInfo, String, org.apache.jackrabbit.webdav.observation.ObservationResource)
*/
@Override
public Subscription subscribe(SubscriptionInfo info, String subscriptionId)
throws DavException {
return subsMgr.subscribe(info, subscriptionId, this);
}
/**
* @see ObservationResource#unsubscribe(String)
* @see SubscriptionManager#unsubscribe(String, org.apache.jackrabbit.webdav.observation.ObservationResource)
*/
@Override
public void unsubscribe(String subscriptionId) throws DavException {
subsMgr.unsubscribe(subscriptionId, this);
}
/**
* @see ObservationResource#poll(String, long)
* @see SubscriptionManager#poll(String, long, org.apache.jackrabbit.webdav.observation.ObservationResource)
*/
@Override
public EventDiscovery poll(String subscriptionId, long timeout) throws DavException {
return subsMgr.poll(subscriptionId, timeout, this);
}
//--------------------------------------------------------------------------
/**
* Initialize the {@link org.apache.jackrabbit.webdav.lock.SupportedLock} property
* with entries that are valid for any type item resources.
*
* @see org.apache.jackrabbit.webdav.lock.SupportedLock
* @see org.apache.jackrabbit.webdav.transaction.TxLockEntry
* @see AbstractResource#initLockSupport()
*/
@Override
protected void initLockSupport() {
if (exists()) {
// add supported lock entries for local and eventually for global
// transaction locks
supportedLock.addEntry(new TxLockEntry(true));
supportedLock.addEntry(new TxLockEntry(false));
}
}
@Override
protected void initPropertyNames() {
super.initPropertyNames();
if (exists()) {
names.addAll(JcrDavPropertyNameSet.EXISTING_ITEM_BASE_SET);
try {
if (item.getDepth() > 0) {
names.add(JCR_PARENT);
}
} catch (RepositoryException e) {
log.warn("Error while accessing node depth: " + e.getMessage());
}
if (item.isNew()) {
names.add(JCR_ISNEW);
} else if (item.isModified()) {
names.add(JCR_ISMODIFIED);
}
} else {
names.addAll(JcrDavPropertyNameSet.ITEM_BASE_SET);
}
}
/**
* Fill the property set for this resource.
*/
@Override
protected void initProperties() {
super.initProperties();
if (exists()) {
try {
properties.add(new DefaultDavProperty<String>(JCR_NAME, item.getName()));
properties.add(new DefaultDavProperty<String>(JCR_PATH, item.getPath()));
int depth = item.getDepth();
properties.add(new DefaultDavProperty<String>(JCR_DEPTH, String.valueOf(depth)));
// add href-property for the items parent unless its the root item
if (depth > 0) {
String parentHref = getLocatorFromItem(item.getParent()).getHref(true);
properties.add(new HrefProperty(JCR_PARENT, parentHref, false));
}
} catch (RepositoryException e) {
// should not get here
log.error("Error while accessing jcr properties: " + e.getMessage());
}
}
}
/**
* @return href of the workspace or <code>null</code> if this resource
* does not represent a repository item.
*
* @see AbstractResource#getWorkspaceHref()
*/
@Override
protected String getWorkspaceHref() {
String workspaceHref = null;
DavResourceLocator locator = getLocator();
if (locator != null && locator.getWorkspacePath() != null) {
String wspPath = locator.getWorkspacePath();
DavResourceLocator wspLocator = locator.getFactory().createResourceLocator(locator.getPrefix(), wspPath, wspPath);
workspaceHref = wspLocator.getHref(true);
}
log.debug(workspaceHref);
return workspaceHref;
}
/**
* If this resource exists but does not contain a transaction id, complete
* will try to persist any modifications present on the underlying
* repository item.
*
* @throws DavException if calling {@link Item#save()} fails
*/
void complete() throws DavException {
if (exists() && getTransactionId() == null) {
try {
if (item.isModified()) {
item.save();
}
} catch (RepositoryException e) {
// this includes LockException, ConstraintViolationException etc. not detected before
log.error("Error while completing request: " + e.getMessage() +" -> reverting changes.");
try {
item.refresh(false);
} catch (RepositoryException re) {
log.error("Error while reverting changes: " + re.getMessage());
}
throw new JcrDavException(e);
}
}
}
/**
* Retrieves the last segment of the given path and removes the index if
* present.
*
* @param itemPath
* @return valid jcr item name
*/
protected static String getItemName(String itemPath) {
if (itemPath == null) {
throw new IllegalArgumentException("Cannot retrieve name from a 'null' item path.");
}
// retrieve the last part of the path
String name = Text.getName(itemPath);
// remove index
if (name.endsWith("]")) {
name = name.substring(0, name.lastIndexOf('['));
}
return name;
}
}