trunk/src/modules/blog/java/src/org/apache/lenya/cms/site/usecases/CreateBlogEntry.java - lenya - Git at Google

 /*
  * 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.site.usecases;

 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 import java.util.Map;

 import org.apache.avalon.framework.service.ServiceSelector;
 import org.apache.cocoon.components.ContextHelper;
 import org.apache.cocoon.environment.ObjectModelHelper;
 import org.apache.cocoon.environment.Request;
 import org.apache.cocoon.environment.Session;
 import org.apache.lenya.ac.Identity;
 import org.apache.lenya.cms.metadata.dublincore.DublinCore;
 import org.apache.lenya.cms.publication.Document;
 import org.apache.lenya.cms.publication.DocumentException;
 import org.apache.lenya.cms.publication.DocumentFactory;
 import org.apache.lenya.cms.publication.DocumentManager;
 import org.apache.lenya.cms.publication.ResourceType;
 import org.apache.lenya.cms.repository.Node;
 import org.apache.lenya.cms.site.SiteStructure;
 import org.apache.lenya.cms.usecase.DocumentUsecase;
 import org.apache.lenya.cms.usecase.UsecaseException;
 import org.apache.lenya.xml.DocumentHelper;
 import org.apache.xpath.XPathAPI;
 import org.w3c.dom.Element;

 /**
  * Usecase to create a Blog entry.
  *
  * @version $Id$
  */
 public class CreateBlogEntry extends DocumentUsecase {

     protected static final String PARENT_ID = "parentId";
     protected static final String DOCUMENT_TYPE = "doctype";
     protected static final String DOCUMENT_ID = "documentId";

     /**
      * @see org.apache.lenya.cms.usecase.AbstractUsecase#getNodesToLock()
      */
     protected Node[] getNodesToLock() throws UsecaseException {
         SiteStructure structure = getSourceDocument().area().getSite();
         Node[] nodes = { structure.getRepositoryNode() };
         return nodes;
     }

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

         Document parent = getSourceDocument();
         try {
             setParameter(PARENT_ID, parent.getPath());
         } catch (DocumentException e) {
             throw new RuntimeException(e);
         }
     }

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

         String documentId = getParameterAsString(DOCUMENT_ID);

         if (documentId.equals("")) {
             addErrorMessage("The document ID is required.");
         }

         if (documentId.matches("[^a-zA-Z0-9\\-]+")) {
             addErrorMessage("The document ID is not valid.");
         }

         super.doCheckExecutionConditions();
     }

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

         // prepare values necessary for blog entry creation
         Document parent = getSourceDocument();
         String language = parent.getPublication().getDefaultLanguage();

         // create new document
         // implementation note: since blog does not have a hierarchy,
         // document id (full path) and document id-name (this leaf's id)
         // are the same
         DocumentManager documentManager = null;
         ServiceSelector selector = null;
         ResourceType resourceType = null;

         try {
             selector = (ServiceSelector) this.manager.lookup(ResourceType.ROLE + "Selector");
             resourceType = (ResourceType) selector.select(getDocumentTypeName());

             documentManager = (DocumentManager) this.manager.lookup(DocumentManager.ROLE);

             DocumentFactory map = getDocumentFactory();

             String documentId = getDocumentID();

             String sampleName = resourceType.getSampleNames()[0];
             String sampleUri = resourceType.getSample(sampleName).getUri();

             Document document = documentManager.add(map,
                     resourceType,
                     sampleUri,
                     getSourceDocument().getPublication(),
                     getSourceDocument().getArea(),
                     documentId,
                     language,
                     "xml",
                     getParameterAsString(DublinCore.ELEMENT_TITLE),
                     true);

             transformXML(document);
         } finally {
             if (documentManager != null) {
                 this.manager.release(documentManager);
             }
             if (selector != null) {
                 if (resourceType != null) {
                     selector.release(resourceType);
                 }
                 this.manager.release(selector);
             }
         }
     }

     /**
      * The blog publication has a specific site structuring: it groups nodes by date.
      *
      * <p>
      * Example structuring of blog entries:
      * </p>
      * <ul>
      * <li>2004</li>
      * <li>2005</li>
      * <ul>
      * <li>01</li>
      * <li>02</li>
      * <ul>
      * <li>23</li>
      * <li>24</li>
      * <ul>
      * <li>article-one</li>
      * <li>article-two</li>
      * </ul>
      * </ul>
      * </ul>
      * </ul>
      *
      * @return The document ID.
      */
     protected String getDocumentID() {
         DateFormat fmtyyyy = new SimpleDateFormat("yyyy");
         DateFormat fmtMM = new SimpleDateFormat("MM");
         DateFormat fmtdd = new SimpleDateFormat("dd");
         Date date = new Date();

         String year = fmtyyyy.format(date);
         String month = fmtMM.format(date);
         String day = fmtdd.format(date);

         String documentId = "/entries/" + year + "/" + month + "/" + day + "/"
                 + getNewDocumentName() + "/index";
         return documentId;
     }

     /**
      * @return The document name.
      * @see org.apache.lenya.cms.site.usecases.Create#getNewDocumentName()
      */
     protected String getNewDocumentName() {
         return getParameterAsString(DOCUMENT_ID);
     }

     /**
      * @return The name of the document type.
      * @see org.apache.lenya.cms.site.usecases.Create#getDocumentTypeName()
      */
     protected String getDocumentTypeName() {
         return getParameterAsString(DOCUMENT_TYPE);
     }

     protected void transformXML(Document document) throws Exception {

         Map objectModel = ContextHelper.getObjectModel(getContext());
         Request request = ObjectModelHelper.getRequest(objectModel);
         Session session = request.getSession(false);
         Identity identity = (Identity) session.getAttribute(Identity.class.getName());
         String title = getParameterAsString(DublinCore.ELEMENT_TITLE);

         org.w3c.dom.Document xmlDoc = DocumentHelper.readDocument(document.getInputStream());

         Element parent = xmlDoc.getDocumentElement();

         if (getLogger().isDebugEnabled())
             getLogger().debug("NewBlogEntryCreator.transformXML(): " + document);

         String[] steps = document.getPath().split("/");
         String nodeId = steps[5];

         // Replace id
         Element element = (Element) XPathAPI.selectSingleNode(parent,
                 "/*[local-name() = 'entry']/*[local-name() = 'id']");

         String year = steps[2];
         String month = steps[3];
         String day = steps[4];

         DocumentHelper.setSimpleElementText(element, year + "/" + month + "/" + day + "/" + nodeId);

         // Replace title
         element = (Element) XPathAPI.selectSingleNode(parent,
                 "/*[local-name() = 'entry']/*[local-name() = 'title']");
         DocumentHelper.setSimpleElementText(element, title);

         element = (Element) XPathAPI.selectSingleNode(parent,
                 "/*[local-name() = 'entry']/*[local-name() = 'link']");
         element.setAttribute("rel", "alternate");
         element.setAttribute("href", "");
         element.setAttribute("type", "text/xml");

         // Replace Summary
         element = (Element) XPathAPI.selectSingleNode(parent,
                 "/*[local-name() = 'entry']/*[local-name() = 'summary']");
         DocumentHelper.setSimpleElementText(element, "Summary");

         element = (Element) XPathAPI.selectSingleNode(parent,
                 "/*[local-name() = 'entry']/*[local-name() = 'author']/*[local-name() = 'name']");

         if (element == null) {
             throw new RuntimeException("Element entry/author/name not found.");
         }

         DocumentHelper.setSimpleElementText(element, identity.getUser().getId());

         // Replace date created, issued and modified
         DateFormat datefmt = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss");
         DateFormat ofsfmt = new SimpleDateFormat("Z");
         Date date = new Date();

         String dateofs = ofsfmt.format(date);
         String datestr = datefmt.format(date) + dateofs.substring(0, 3) + ":"
                 + dateofs.substring(3, 5);

         element = (Element) XPathAPI.selectSingleNode(parent,
                 "/*[local-name() = 'entry']/*[local-name() = 'created']");
         DocumentHelper.setSimpleElementText(element, datestr);
         element = (Element) XPathAPI.selectSingleNode(parent,
                 "/*[local-name() = 'entry']/*[local-name() = 'issued']");
         DocumentHelper.setSimpleElementText(element, datestr);
         element = (Element) XPathAPI.selectSingleNode(parent,
                 "/*[local-name() = 'entry']/*[local-name() = 'modified']");
         DocumentHelper.setSimpleElementText(element, datestr);

         DocumentHelper.writeDocument(xmlDoc, document.getOutputStream());
     }
 }
	/*
	* 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.site.usecases;

	import java.text.DateFormat;
	import java.text.SimpleDateFormat;
	import java.util.Date;
	import java.util.Map;

	import org.apache.avalon.framework.service.ServiceSelector;
	import org.apache.cocoon.components.ContextHelper;
	import org.apache.cocoon.environment.ObjectModelHelper;
	import org.apache.cocoon.environment.Request;
	import org.apache.cocoon.environment.Session;
	import org.apache.lenya.ac.Identity;
	import org.apache.lenya.cms.metadata.dublincore.DublinCore;
	import org.apache.lenya.cms.publication.Document;
	import org.apache.lenya.cms.publication.DocumentException;
	import org.apache.lenya.cms.publication.DocumentFactory;
	import org.apache.lenya.cms.publication.DocumentManager;
	import org.apache.lenya.cms.publication.ResourceType;
	import org.apache.lenya.cms.repository.Node;
	import org.apache.lenya.cms.site.SiteStructure;
	import org.apache.lenya.cms.usecase.DocumentUsecase;
	import org.apache.lenya.cms.usecase.UsecaseException;
	import org.apache.lenya.xml.DocumentHelper;
	import org.apache.xpath.XPathAPI;
	import org.w3c.dom.Element;

	/**
	* Usecase to create a Blog entry.
	*
	* @version $Id$
	*/
	public class CreateBlogEntry extends DocumentUsecase {

	protected static final String PARENT_ID = "parentId";
	protected static final String DOCUMENT_TYPE = "doctype";
	protected static final String DOCUMENT_ID = "documentId";

	/**
	* @see org.apache.lenya.cms.usecase.AbstractUsecase#getNodesToLock()
	*/
	protected Node[] getNodesToLock() throws UsecaseException {
	SiteStructure structure = getSourceDocument().area().getSite();
	Node[] nodes = { structure.getRepositoryNode() };
	return nodes;
	}

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

	Document parent = getSourceDocument();
	try {
	setParameter(PARENT_ID, parent.getPath());
	} catch (DocumentException e) {
	throw new RuntimeException(e);
	}
	}

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

	String documentId = getParameterAsString(DOCUMENT_ID);

	if (documentId.equals("")) {
	addErrorMessage("The document ID is required.");
	}

	if (documentId.matches("[^a-zA-Z0-9\\-]+")) {
	addErrorMessage("The document ID is not valid.");
	}

	super.doCheckExecutionConditions();
	}

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

	// prepare values necessary for blog entry creation
	Document parent = getSourceDocument();
	String language = parent.getPublication().getDefaultLanguage();

	// create new document
	// implementation note: since blog does not have a hierarchy,
	// document id (full path) and document id-name (this leaf's id)
	// are the same
	DocumentManager documentManager = null;
	ServiceSelector selector = null;
	ResourceType resourceType = null;

	try {
	selector = (ServiceSelector) this.manager.lookup(ResourceType.ROLE + "Selector");
	resourceType = (ResourceType) selector.select(getDocumentTypeName());

	documentManager = (DocumentManager) this.manager.lookup(DocumentManager.ROLE);

	DocumentFactory map = getDocumentFactory();

	String documentId = getDocumentID();

	String sampleName = resourceType.getSampleNames()[0];
	String sampleUri = resourceType.getSample(sampleName).getUri();

	Document document = documentManager.add(map,
	resourceType,
	sampleUri,
	getSourceDocument().getPublication(),
	getSourceDocument().getArea(),
	documentId,
	language,
	"xml",
	getParameterAsString(DublinCore.ELEMENT_TITLE),
	true);

	transformXML(document);
	} finally {
	if (documentManager != null) {
	this.manager.release(documentManager);
	}
	if (selector != null) {
	if (resourceType != null) {
	selector.release(resourceType);
	}
	this.manager.release(selector);
	}
	}
	}

	/**
	* The blog publication has a specific site structuring: it groups nodes by date.
	*
	* <p>
	* Example structuring of blog entries:
	* </p>
	* <ul>
	* <li>2004</li>
	* <li>2005</li>
	* <ul>
	* <li>01</li>
	* <li>02</li>
	* <ul>
	* <li>23</li>
	* <li>24</li>
	* <ul>
	* <li>article-one</li>
	* <li>article-two</li>
	* </ul>
	* </ul>
	* </ul>
	* </ul>
	*
	* @return The document ID.
	*/
	protected String getDocumentID() {
	DateFormat fmtyyyy = new SimpleDateFormat("yyyy");
	DateFormat fmtMM = new SimpleDateFormat("MM");
	DateFormat fmtdd = new SimpleDateFormat("dd");
	Date date = new Date();

	String year = fmtyyyy.format(date);
	String month = fmtMM.format(date);
	String day = fmtdd.format(date);

	String documentId = "/entries/" + year + "/" + month + "/" + day + "/"
	+ getNewDocumentName() + "/index";
	return documentId;
	}

	/**
	* @return The document name.
	* @see org.apache.lenya.cms.site.usecases.Create#getNewDocumentName()
	*/
	protected String getNewDocumentName() {
	return getParameterAsString(DOCUMENT_ID);
	}

	/**
	* @return The name of the document type.
	* @see org.apache.lenya.cms.site.usecases.Create#getDocumentTypeName()
	*/
	protected String getDocumentTypeName() {
	return getParameterAsString(DOCUMENT_TYPE);
	}

	protected void transformXML(Document document) throws Exception {

	Map objectModel = ContextHelper.getObjectModel(getContext());
	Request request = ObjectModelHelper.getRequest(objectModel);
	Session session = request.getSession(false);
	Identity identity = (Identity) session.getAttribute(Identity.class.getName());
	String title = getParameterAsString(DublinCore.ELEMENT_TITLE);

	org.w3c.dom.Document xmlDoc = DocumentHelper.readDocument(document.getInputStream());

	Element parent = xmlDoc.getDocumentElement();

	if (getLogger().isDebugEnabled())
	getLogger().debug("NewBlogEntryCreator.transformXML(): " + document);

	String[] steps = document.getPath().split("/");
	String nodeId = steps[5];

	// Replace id
	Element element = (Element) XPathAPI.selectSingleNode(parent,
	"/[local-name() = 'entry']/[local-name() = 'id']");

	String year = steps[2];
	String month = steps[3];
	String day = steps[4];

	DocumentHelper.setSimpleElementText(element, year + "/" + month + "/" + day + "/" + nodeId);

	// Replace title
	element = (Element) XPathAPI.selectSingleNode(parent,
	"/[local-name() = 'entry']/[local-name() = 'title']");
	DocumentHelper.setSimpleElementText(element, title);

	element = (Element) XPathAPI.selectSingleNode(parent,
	"/[local-name() = 'entry']/[local-name() = 'link']");
	element.setAttribute("rel", "alternate");
	element.setAttribute("href", "");
	element.setAttribute("type", "text/xml");

	// Replace Summary
	element = (Element) XPathAPI.selectSingleNode(parent,
	"/[local-name() = 'entry']/[local-name() = 'summary']");
	DocumentHelper.setSimpleElementText(element, "Summary");

	element = (Element) XPathAPI.selectSingleNode(parent,
	"/[local-name() = 'entry']/[local-name() = 'author']/*[local-name() = 'name']");

	if (element == null) {
	throw new RuntimeException("Element entry/author/name not found.");
	}

	DocumentHelper.setSimpleElementText(element, identity.getUser().getId());

	// Replace date created, issued and modified
	DateFormat datefmt = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss");
	DateFormat ofsfmt = new SimpleDateFormat("Z");
	Date date = new Date();

	String dateofs = ofsfmt.format(date);
	String datestr = datefmt.format(date) + dateofs.substring(0, 3) + ":"
	+ dateofs.substring(3, 5);

	element = (Element) XPathAPI.selectSingleNode(parent,
	"/[local-name() = 'entry']/[local-name() = 'created']");
	DocumentHelper.setSimpleElementText(element, datestr);
	element = (Element) XPathAPI.selectSingleNode(parent,
	"/[local-name() = 'entry']/[local-name() = 'issued']");
	DocumentHelper.setSimpleElementText(element, datestr);
	element = (Element) XPathAPI.selectSingleNode(parent,
	"/[local-name() = 'entry']/[local-name() = 'modified']");
	DocumentHelper.setSimpleElementText(element, datestr);

	DocumentHelper.writeDocument(xmlDoc, document.getOutputStream());
	}
	}