You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by an...@apache.org on 2005/01/31 09:35:54 UTC
svn commit: r149232 - in
lenya/trunk/src/webapp/lenya/pubs/default/java/src/org/apache/lenya/defaultpub/cms/usecases:
./ Publish.java
Author: andreas
Date: Mon Jan 31 00:35:51 2005
New Revision: 149232
URL: http://svn.apache.org/viewcvs?view=rev&rev=149232
Log:
add publish usecase handler for default pub
Added:
lenya/trunk/src/webapp/lenya/pubs/default/java/src/org/apache/lenya/defaultpub/cms/usecases/
lenya/trunk/src/webapp/lenya/pubs/default/java/src/org/apache/lenya/defaultpub/cms/usecases/Publish.java
Added: lenya/trunk/src/webapp/lenya/pubs/default/java/src/org/apache/lenya/defaultpub/cms/usecases/Publish.java
URL: http://svn.apache.org/viewcvs/lenya/trunk/src/webapp/lenya/pubs/default/java/src/org/apache/lenya/defaultpub/cms/usecases/Publish.java?view=auto&rev=149232
==============================================================================
--- lenya/trunk/src/webapp/lenya/pubs/default/java/src/org/apache/lenya/defaultpub/cms/usecases/Publish.java (added)
+++ lenya/trunk/src/webapp/lenya/pubs/default/java/src/org/apache/lenya/defaultpub/cms/usecases/Publish.java Mon Jan 31 00:35:51 2005
@@ -0,0 +1,189 @@
+/*
+ * 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 org.apache.lenya.defaultpub.cms.usecases;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.lenya.cms.publication.Document;
+import org.apache.lenya.cms.publication.DocumentFactory;
+import org.apache.lenya.cms.publication.Publication;
+import org.apache.lenya.cms.publication.PublicationException;
+import org.apache.lenya.cms.publication.ResourcesManager;
+import org.apache.lenya.cms.publication.util.DocumentVisitor;
+import org.apache.lenya.cms.publication.util.OrderedDocumentSet;
+import org.apache.lenya.cms.site.SiteManager;
+import org.apache.lenya.cms.usecase.DocumentUsecase;
+import org.apache.lenya.cms.workflow.usecases.InvokeWorkflow;
+
+/**
+ * Publish usecase handler.
+ *
+ * @version $Id:$
+ */
+public class Publish extends DocumentUsecase implements DocumentVisitor {
+
+ protected static final String MISSING_DOCUMENTS = "missingDocuments";
+ protected static final String SUBTREE = "subtree";
+
+ /**
+ * Checks if the workflow event "publish" is supported and the parent of the
+ * document exists in the live area.
+ *
+ * @see org.apache.lenya.cms.usecase.AbstractUsecase#doCheckPreconditions()
+ */
+ protected void doCheckPreconditions() throws Exception {
+ super.doCheckPreconditions();
+
+ String event = getParameterAsString(InvokeWorkflow.EVENT);
+ Document document = getSourceDocument();
+
+ if (!getWorkflowInstance(getSourceDocument()).canInvoke(getSituation(), event)) {
+ addErrorMessage("Cannot publish document [" + document.getId()
+ + "]: workflow event not supported.");
+ }
+
+ Publication publication = document.getPublication();
+
+ Document liveDocument = publication.getAreaVersion(document, Publication.LIVE_AREA);
+
+ List missingDocuments = new ArrayList();
+
+ SiteManager manager = publication.getSiteManager(document.getIdentityMap());
+ Document[] requiredDocuments = manager.getRequiredResources(liveDocument);
+ for (int i = 0; i < requiredDocuments.length; i++) {
+ if (!manager.containsInAnyLanguage(requiredDocuments[i])) {
+ Document authoringVersion = publication.getAreaVersion(requiredDocuments[i],
+ Publication.AUTHORING_AREA);
+ missingDocuments.add(authoringVersion);
+ }
+ }
+
+ if (!missingDocuments.isEmpty()) {
+ addErrorMessage("Cannot publish document unless the following documents are published:");
+ setParameter(MISSING_DOCUMENTS, missingDocuments);
+ }
+
+ }
+
+ /**
+ * @see org.apache.lenya.cms.usecase.AbstractUsecase#doExecute()
+ */
+ protected void doExecute() throws Exception {
+ super.doExecute();
+ if (isSubtreeEnabled()) {
+ publishAll(getSourceDocument());
+ }
+ else {
+ publish(getSourceDocument());
+ }
+ }
+
+ /**
+ * Publishes a document.
+ * @param authoringDocument The authoring document.
+ */
+ protected void publish(Document authoringDocument) {
+
+ Publication publication = authoringDocument.getPublication();
+
+ try {
+ publication.copyDocumentToArea(authoringDocument, Publication.LIVE_AREA);
+
+ Document liveDocument = publication.getAreaVersion(authoringDocument,
+ Publication.LIVE_AREA);
+
+ ResourcesManager resourcesManager = authoringDocument.getResourcesManager();
+ resourcesManager.copyResourcesTo(liveDocument);
+ } catch (Exception e) {
+ throw new RuntimeException(e);
+ }
+
+ String event = getParameterAsString(InvokeWorkflow.EVENT);
+ triggerWorkflow(event);
+ }
+
+ /**
+ * Publishes a document or the subtree below a document, based on the parameter SUBTREE.
+ * @param document The document.
+ */
+ protected void publishAll(Document document) {
+
+ if (getLogger().isDebugEnabled()) {
+ getLogger().debug("Publishing document [" + document + "]");
+ getLogger().debug("Subtree publishing: [" + isSubtreeEnabled() + "]");
+ }
+
+ try {
+
+ OrderedDocumentSet set = new OrderedDocumentSet();
+ SiteManager manager = document.getPublication().getSiteManager(document
+ .getIdentityMap());
+ Document[] ancestors = manager.getRequiringResources(document);
+
+ set = new OrderedDocumentSet(ancestors);
+ set.add(document);
+ set.visitAscending(this);
+ } catch (Exception e) {
+ throw new RuntimeException(e);
+ }
+
+ if (getLogger().isDebugEnabled()) {
+ getLogger().debug("Publishing completed.");
+ }
+ }
+
+ /**
+ * Returns whether subtree publishing is enabled.
+ * @return A boolean value.
+ */
+ protected boolean isSubtreeEnabled() {
+ String value = getParameterAsString(SUBTREE);
+ return value != null;
+ }
+
+ /**
+ * @throws PublicationException
+ * @see org.apache.lenya.cms.publication.util.DocumentVisitor#visitDocument(org.apache.lenya.cms.publication.Document)
+ */
+ public void visitDocument(Document document) throws PublicationException {
+
+ if (getLogger().isDebugEnabled()) {
+ getLogger().debug("Visiting resource [" + document + "]");
+ }
+
+ publishAllLanguageVersions(document);
+ }
+
+ /**
+ * Publishes all existing language versions of a document.
+ * @param document The document.
+ * @throws PublicationException if an error occurs.
+ */
+ protected void publishAllLanguageVersions(Document document) throws PublicationException {
+ String[] languages = document.getPublication().getLanguages();
+ DocumentFactory factory = document.getIdentityMap().getFactory();
+ for (int i = 0; i < languages.length; i++) {
+ Document version = factory.getLanguageVersion(document, languages[i]);
+ if (version.exists()) {
+ publish(version);
+ }
+ }
+
+ }
+
+}
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org