/*
* 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.version.report;
import org.apache.jackrabbit.commons.webdav.JcrRemotingConstants;
import org.apache.jackrabbit.util.Text;
import org.apache.jackrabbit.webdav.DavException;
import org.apache.jackrabbit.webdav.DavResource;
import org.apache.jackrabbit.webdav.jcr.ItemResourceConstants;
import org.apache.jackrabbit.webdav.jcr.JcrDavException;
import org.apache.jackrabbit.webdav.version.report.Report;
import org.apache.jackrabbit.webdav.version.report.ReportInfo;
import org.apache.jackrabbit.webdav.version.report.ReportType;
import org.apache.jackrabbit.webdav.xml.DomUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.xml.sax.SAXException;
import javax.jcr.PathNotFoundException;
import javax.jcr.RepositoryException;
import javax.jcr.Session;
import javax.xml.parsers.ParserConfigurationException;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
/**
* <code>ExportViewReport</code> handles REPORT requests for the 'exportview'
* report. The 'exportview' report is used to export
* {@link Session#exportDocumentView(String, java.io.OutputStream, boolean, boolean) DocView}
* and {@link Session#exportSystemView(String, java.io.OutputStream, boolean, boolean) SysView}
* of the {@link javax.jcr.Item item} represented by the requested resource.
* <p>
* The request body must contain a {@link ItemResourceConstants#NAMESPACE dcr}:exportview
* element:
* <pre>
* <!ELEMENT exportview ( (sysview | docview)?, skipbinary?, norecurse ) >
* <!ELEMENT sysview EMPTY >
* <!ELEMENT docview EMPTY >
* <!ELEMENT skipbinary EMPTY >
* <!ELEMENT norecurse EMPTY >
* </pre>
* If no view type is specified the DocView is generated.
*/
public class ExportViewReport extends AbstractJcrReport {
private static Logger log = LoggerFactory.getLogger(ExportViewReport.class);
/**
* The exportview report type
*/
public static final ReportType EXPORTVIEW_REPORT = ReportType.register(JcrRemotingConstants.REPORT_EXPORT_VIEW, ItemResourceConstants.NAMESPACE, ExportViewReport.class);
private String absNodePath;
/**
* Returns {@link #EXPORTVIEW_REPORT} report type.
*
* @return {@link #EXPORTVIEW_REPORT}
* @see org.apache.jackrabbit.webdav.version.report.Report#getType()
*/
public ReportType getType() {
return EXPORTVIEW_REPORT;
}
/**
* Always returns <code>false</code>.
*
* @return false
*/
public boolean isMultiStatusReport() {
return false;
}
/**
* @see Report#init(DavResource, ReportInfo)
*/
@Override
public void init(DavResource resource, ReportInfo info) throws DavException {
// delegate validation to super class
super.init(resource, info);
// report specific validation: resource must represent an existing
// repository node
absNodePath = resource.getLocator().getRepositoryPath();
try {
if (!(getRepositorySession().itemExists(absNodePath) && getRepositorySession().getItem(absNodePath).isNode())) {
throw new JcrDavException(new PathNotFoundException(absNodePath + " does not exist."));
}
} catch (RepositoryException e) {
throw new JcrDavException(e);
}
}
/**
* Creates a Xml document from the generated view.
*
* @param document
* @return Xml element representing the output of the specified view.
* @see org.apache.jackrabbit.webdav.xml.XmlSerializable#toXml(Document)
*/
public Element toXml(Document document) {
boolean skipBinary = getReportInfo().containsContentElement("skipbinary", ItemResourceConstants.NAMESPACE);
boolean noRecurse = getReportInfo().containsContentElement("norecurse", ItemResourceConstants.NAMESPACE);
// todo improve...
try {
// create tmpFile in default system-tmp directory
String prefix = "_tmp_" + Text.getName(absNodePath);
File tmpfile = File.createTempFile(prefix, null, null);
tmpfile.deleteOnExit();
FileOutputStream out = new FileOutputStream(tmpfile);
if (getReportInfo().containsContentElement("sysview", ItemResourceConstants.NAMESPACE)) {
getRepositorySession().exportSystemView(absNodePath, out, skipBinary, noRecurse);
} else {
// default is docview
getRepositorySession().exportDocumentView(absNodePath, out, skipBinary, noRecurse);
}
out.close();
Document tmpDoc =
DomUtil.parseDocument(new FileInputStream(tmpfile));
// import the root node of the generated xml to the given document.
Element rootElem = (Element)document.importNode(tmpDoc.getDocumentElement(), true);
return rootElem;
} catch (RepositoryException e) {
log.error(e.getMessage());
} catch (FileNotFoundException e) {
log.error(e.getMessage());
} catch (IOException e) {
log.error(e.getMessage());
} catch (ParserConfigurationException e) {
log.error(e.getMessage());
} catch (SAXException e) {
log.error(e.getMessage());
}
return null;
}
}