ExportRestlet.java

/*
 * (C) Copyright 2006-2008 Nuxeo SAS (http://nuxeo.com/) and contributors.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Lesser General Public License
 * (LGPL) version 2.1 which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/lgpl.html
 *
 * 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.
 *
 * Contributors:
 *     Thierry Delprat
 *     Florent Guillaume
 *
 * $Id: ExportRestlet.java 30251 2008-02-18 19:17:33Z fguillaume $
 */

package org.nuxeo.ecm.platform.ui.web.restAPI;

import java.io.IOException;
import java.io.OutputStream;
import java.io.Serializable;
import java.util.Map;

import org.nuxeo.ecm.core.api.ClientException;
import org.nuxeo.ecm.core.api.CoreSession;
import org.nuxeo.ecm.core.api.DocumentModel;
import org.nuxeo.ecm.core.api.DocumentModelList;
import org.nuxeo.ecm.core.api.DocumentSecurityException;
import org.nuxeo.ecm.core.api.IdRef;
import org.nuxeo.ecm.core.api.UnrestrictedSessionRunner;
import org.nuxeo.ecm.core.api.security.SecurityConstants;
import org.nuxeo.ecm.core.io.DocumentPipe;
import org.nuxeo.ecm.core.io.DocumentReader;
import org.nuxeo.ecm.core.io.DocumentWriter;
import org.nuxeo.ecm.core.io.impl.DocumentPipeImpl;
import org.nuxeo.ecm.core.io.impl.plugins.DocumentTreeReader;
import org.nuxeo.ecm.core.io.impl.plugins.NuxeoArchiveWriter;
import org.nuxeo.ecm.core.io.impl.plugins.SingleDocumentReader;
import org.nuxeo.ecm.core.io.impl.plugins.XMLDocumentTreeWriter;
import org.nuxeo.ecm.core.io.impl.plugins.XMLDocumentWriter;
import org.restlet.data.CharacterSet;
import org.restlet.data.Form;
import org.restlet.data.MediaType;
import org.restlet.data.Request;
import org.restlet.data.Response;
import org.restlet.resource.Representation;

import com.noelios.restlet.http.HttpConstants;

public class ExportRestlet extends BaseStatelessNuxeoRestlet implements Serializable {

    private static final long serialVersionUID = 7831287875548588711L;

    @Override
    protected void doHandleStatelessRequest(Request req, Response res) {
        boolean exportAsTree;
        boolean exportAsZip;
        String action = req.getResourceRef().getSegments().get(4);
        if (action.equals("exportTree")) {
            exportAsTree = true;
            exportAsZip = true;
        } else {
            // "export", "exportSingle"
            exportAsTree = false;
            String format = req.getResourceRef().getQueryAsForm().getFirstValue(
                    "format");
            if (format != null) {
                format = format.toLowerCase();
            } else {
                format = "xml";
            }
            exportAsZip = "zip".equals(format);
        }

        String repo = (String) req.getAttributes().get("repo");
        if (repo == null || repo.equals("*")) {
            handleError(res, "you must specify a repository");
            return;
        }

        DocumentModel root;
        String docid = (String) req.getAttributes().get("docid");
        boolean needUnrestricted = false;

        try {
            boolean init = initRepository(res, repo);
            if (!init) {
                handleError(res, "Unable to init repository");
                return;
            }
            if (docid == null || docid.equals("*")) {
                root = session.getRootDocument();
            } else if (session.hasPermission(new IdRef(docid),
                        SecurityConstants.READ)) {
                root = session.getDocument(new IdRef(docid));
            } else {
                UnrestrictedVersionExporter runner = new UnrestrictedVersionExporter(session, docid);
                runner.runUnrestricted();
                root = runner.root;
                needUnrestricted = true;

                // if user can't read version, export is authorized
                // if he can at least read a proxy pointing to this version
                if (!root.isVersion()) {
                    throw new DocumentSecurityException("Not enough rights to export " + root.getPathAsString());
                }
                DocumentModelList docs = session.getProxies(root.getRef(), null);
                boolean hasReadableProxy = false;
                for (DocumentModel doc : docs) {
                    if (session.hasPermission(doc.getRef(), SecurityConstants.READ)) {
                        hasReadableProxy = true;
                        break;
                    }
                }
                if (!hasReadableProxy) {
                    throw new DocumentSecurityException("Current user doesn't have access to any proxy pointing to version " + root.getPathAsString());
                }
          }
        } catch (ClientException e) {
            handleError(res, e);
            return;
        }

        if (exportAsZip) {
            // set the content disposition and file name
            String FILENAME = "export.zip";

            // use the Facelets APIs to set a new header
            Map<String, Object> attributes = res.getAttributes();
            Form headers = (Form) attributes.get(HttpConstants.ATTRIBUTE_HEADERS);
            if (headers == null) {
                headers = new Form();
            }
            headers.add("Content-Disposition", String.format(
                    "attachment; filename=\"%s\";", FILENAME));
            attributes.put(HttpConstants.ATTRIBUTE_HEADERS, headers);
        }

        MediaType mediaType = exportAsZip ? MediaType.APPLICATION_ZIP
                : MediaType.TEXT_XML;
        Representation entity = makeRepresentation(mediaType, root,
                exportAsTree, exportAsZip, needUnrestricted);

        res.setEntity(entity);
        if (mediaType == MediaType.TEXT_XML) {
            res.getEntity().setCharacterSet(CharacterSet.UTF_8);
        }
    }

    protected Representation makeRepresentation(MediaType mediaType,
            DocumentModel root, final boolean exportAsTree,
            final boolean exportAsZip, final boolean isUnrestricted) {

        return new ExportRepresentation(mediaType, root, isUnrestricted) {

            @Override
            protected DocumentPipe makePipe() {
                if (exportAsTree) {
                    return new DocumentPipeImpl(10);
                } else {
                    return new DocumentPipeImpl();
                }
            }

            @Override
            protected DocumentReader makeDocumentReader(
                    CoreSession documentManager, DocumentModel root)
                    throws ClientException {
                DocumentReader documentReader;
                if (exportAsTree) {
                    documentReader = new DocumentTreeReader(documentManager,
                            root, false);
                    if (!exportAsZip) {
                        ((DocumentTreeReader) documentReader).setInlineBlobs(true);
                    }
                } else {
                    documentReader = new SingleDocumentReader(documentManager,
                            root);
                }
                return documentReader;
            }

            @Override
            protected DocumentWriter makeDocumentWriter(
                    OutputStream outputStream) throws IOException {
                DocumentWriter documentWriter;
                if (exportAsZip) {
                    documentWriter = new NuxeoArchiveWriter(outputStream);
                } else {
                    if (exportAsTree) {
                        documentWriter = new XMLDocumentTreeWriter(outputStream);
                    } else {
                        documentWriter = new XMLDocumentWriter(outputStream);
                    }
                }
                return documentWriter;
            }
        };
    }

    protected static class UnrestrictedVersionExporter extends UnrestrictedSessionRunner {

        private final String docid;

        public DocumentModel root;

        protected UnrestrictedVersionExporter(CoreSession session, String docId) {
            super(session);
            docid = docId;
        }

        @Override
        public void run() throws ClientException {
            root = session.getDocument(new IdRef(docid));
        }

    }

}