org.apache.lenya.module.editors/src/main/java/org/apache/lenya/cms/editors/EditDocument.java

/*
 * 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.lenya.cms.editors;

import org.apache.excalibur.source.SourceResolver;
import org.apache.lenya.cms.cocoon.source.SourceUtil;
import org.apache.lenya.cms.publication.Document;
import org.apache.lenya.cms.publication.Node;
import org.apache.lenya.cms.publication.ResourceType;
import org.apache.lenya.cms.usecase.DocumentUsecase;
import org.apache.lenya.cms.usecase.UsecaseException;
import org.apache.lenya.cms.usecase.xml.UsecaseErrorHandler;
import org.apache.lenya.cms.workflow.WorkflowUtil;
import org.apache.lenya.xml.Schema;
import org.apache.lenya.xml.ValidationUtil;

/**
 * <p>
 * You can use this usecase to save a document. It reads XML data from a source and saves as the
 * content of the current document.
 * </p>
 * <ul>
 * <li>If the document's resource type supports validation, the XML document is validated and not
 * saved if validation errors occur.</li>
 * <li>All URL-based internal links in the XML source are converted to UUID-based links before
 * saving.</li>
 * <li>A workflow event is invoked. The event defaults to "edit", you can override it using the
 * <em>event</em> parameter.</li>
 * </ul>
 * <p>
 * Parameters:
 * </p>
 * <ul>
 * <li><em>sourceUri</em> - the URI to read the XML data from</li>
 * <li><em>event</em> - the workflow event to invoke</li>
 * </ul>
 * <p>
 * A typical usage scenario is to save XML data entered in a form. In this case, the
 * <em>sourceUri</em> parameter refers to a Cocoon pipeline featuring the stream generator.
 * </p>
 * 
 * @version $Id$
 */
public class EditDocument extends DocumentUsecase {

    protected static final String EVENT = "event";
    protected static final String DEFAULT_EVENT = "edit";
    
    private SourceResolver sourceResolver;

    /**
     * The URI to copy the document source from.
     */
    public static final String SOURCE_URI = "sourceUri";

    /**
     * @see org.apache.lenya.cms.usecase.AbstractUsecase#doExecute()
     */
    protected void doExecute() throws Exception {
        super.doExecute();

        Document sourceDoc = getSourceDocument();

        String sourceUri = getParameterAsString(SOURCE_URI);
        org.w3c.dom.Document xmlDoc = SourceUtil.readDOM(sourceUri, getSourceResolver());

        ResourceType resourceType = sourceDoc.getResourceType();
        Schema schema = resourceType.getSchema();
        ValidationUtil.validate(xmlDoc, schema, new UsecaseErrorHandler(this));

        if (!hasErrors()) {
            SourceUtil.writeDOM(xmlDoc, sourceDoc.getOutputStream());
            String event = getParameterAsString(EVENT, DEFAULT_EVENT);
            WorkflowUtil.invoke(getSourceDocument(), event);
        }
    }

    /**
     * @see org.apache.lenya.cms.usecase.AbstractUsecase#getNodesToLock()
     */
    protected Node[] getNodesToLock() throws UsecaseException {
        Node[] objects = { getSourceDocument() };
        return objects;
    }

    /**
     * TODO: Bean wiring
     */
    public void setSourceResolver(SourceResolver sourceResolver) {
        this.sourceResolver = sourceResolver;
    }

    public SourceResolver getSourceResolver() {
        return sourceResolver;
    }

}