cmsmanagerslideimpl.java

jetspeed源代码

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *    "Apache Jetspeed" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact [e-mail].
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Apache Jetspeed", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.jetspeed.services.cms.manager;
/**
 * Slide implementation for the CmsManager
 *
 * @author <a href="mailto:[e-mail]">Christophe Lombart</a>
 *
 */

// Java 2 SDK
import java.util.*;
import java.io.FileWriter;
import java.io.FileInputStream;
import java.util.Vector;

// Turbine
import org.apache.turbine.services.TurbineServices;
import org.apache.turbine.services.resources.TurbineResources;
import org.apache.turbine.util.upload.FileItem;
import org.apache.turbine.util.Log;

// Slide

import org.apache.slide.structure.*;
import org.apache.slide.content.*;
import org.apache.slide.common.*;
import org.apache.slide.lock.*;
import org.apache.slide.security.*;
import org.apache.slide.authenticate.CredentialsToken;
import org.apache.slide.authenticate.SecurityToken;
import org.apache.slide.security.AccessDeniedException;

// Jetspeed
import org.apache.jetspeed.om.cms.*;
import org.apache.jetspeed.om.cms.slide.SlideResource;
import org.apache.jetspeed.services.cms.repository.slide.Utility;
import org.apache.jetspeed.services.cms.CmsService;
import org.apache.jetspeed.services.cms.JetspeedCMSException;
import org.apache.jetspeed.services.rundata.JetspeedRunDataService;
import org.apache.jetspeed.services.rundata.JetspeedRunData;
import org.apache.turbine.services.rundata.RunDataService;

public class CmsManagerSlideImpl implements CmsManager
{

	private NamespaceAccessToken token = null;
	private Structure structure = null;
	private Security security = null;
	private Content content = null;
	private Lock lock = null;
	private static String PROPERTY_CLASS_NAME = "resourceClassName";
	String nameSpace = null;

	/**
	* Initialise the CmsManager.
	* @param nameSpace used assigned to the CmsManager. This namespace can be
	* used to read parameters assigned to this namespace in the JR.prop
	*/
	public void init (String namespace)
			throws JetspeedCMSException
	{
		try
		{
            String domainFile =TurbineResources.getString("services.CmsService.CmsManager." + namespace + ".domainfile");
			Domain.init(new FileInputStream(domainFile));
		}
		catch (Exception e)
		{
			throw new JetspeedCMSException();
		}

		token = Domain.accessNamespace(new SecurityToken(new String()), namespace);

		structure = token.getStructureHelper();
		security = token.getSecurityHelper();
		content = token.getContentHelper();
		lock = token.getLockHelper();
		this.nameSpace = namespace;
	}

	/**
	* Export the CMS repository into an xml file
	* @param userNode User reference
	* @param xmlFileName output file
	*/

	public void exportRepository (String xmlFileName)
		   throws JetspeedCMSException
	{
		try
		{
			String userNode = this.getSlideUserNode();
			SlideToken slideToken = this.getSlideToken ( userNode );
			token.exportData(slideToken, new FileWriter( xmlFileName ));
		}
		catch (Exception e)
		{
			throw new JetspeedCMSException("Impossible to export the content respository");
		}
	}

	/**
	* Populate a catalog structure from the repository
	*
	* @param userNode User reference
	* @param Catalog object to populate
	*/
	public void populateCatalog (Catalog catalog)
		   throws JetspeedCMSException
	{
		this.populateCatalog(catalog, true, true, -1);
	}

	/**
	* Populate a catalog structure from the repository
	*
	* @param userNode User reference
	* @param catalog object to populate
	* @param withSubCatalog - retrieve or not sub-catalogs
	* @param withContent - retrieve or not child ContentItems
	*/
	public void populateCatalog (Catalog catalog,
								 boolean withSubCatalog, boolean withContent)
		   throws JetspeedCMSException
	{
		this.populateCatalog(catalog, withSubCatalog,
							 withContent, -1);
							 
	}

	/**
	* Populate a catalog structure from the repository
	*
	* @param userNode User reference
	* @param catalog object to populate
	* @param withSubCatalog - retrieve or not sub-catalogs
	* @param withContent - retrieve or not child ContentItems
	* @param numberOfLevels - number of tree level to populate
	*/
	public void populateCatalog (Catalog catalog,
								 boolean withSubCatalog, boolean withContent,
								 int numberOfLevels )
		   throws JetspeedCMSException
	{
		try
		{
			String userNode = this.getSlideUserNode();
			int tmpLevel = numberOfLevels ;
			SlideToken slideToken = this.getSlideToken ( userNode );
			ObjectNode objectNode = structure.retrieve(slideToken, catalog.getUri(), true);

			// -----------------  Get catalog children
			//Enumeration childrenUri = structure.getChildren(slideToken,objectNode);
			Enumeration childrenUri = objectNode.enumerateChildren();
			//Enumeration childrenUri = objectNode.getChildren();
			
			this.getChildren(userNode, childrenUri, catalog,
							 withSubCatalog, withContent, numberOfLevels);

			// -----------------  Get links
			Enumeration linksUri = objectNode.enumerateLinks();
			this.getChildren(userNode, linksUri, catalog,
							 withSubCatalog, withContent, tmpLevel);
		}
		catch (Exception e)
		{
			throw new JetspeedCMSException("Impossible to get catalog information");
		}
	}

	/**
	* Get all children from a specific parent uri
	*
	* @param userNode User reference
	* @param parentUri uri used to get children
	*/
	public Vector getUriList (String parentUri)
		   throws JetspeedCMSException
	{
		try
		{
			
            String userNode = this.getSlideUserNode();
			Vector uriList = new Vector();

			// Add the parent uri
			uriList.add(parentUri);
			//System.out.println("URI : " + parentUri);

			// Retrieve children
			SlideToken slideToken = this.getSlideToken ( userNode );
			ObjectNode objectNode = structure.retrieve(slideToken, parentUri);
			Enumeration children = objectNode.enumerateChildren();

			// Add children to the vector
			while (children.hasMoreElements())
			{
				String uriChild  = (String) children.nextElement();
				Vector v = this.getUriList(uriChild);
				uriList.addAll(v);
			}

			return uriList;
		}
		catch (Exception e)
		{
		   throw new JetspeedCMSException("Impossible to get the uri List");
		}
	}


	/**
	* Get a resource object (Catalog or ContentItem)  from the repository
	* based on a uri.
	* @param userNode User reference
	* @param uri
	* @return resource that match to this uri
	*/
	public Resource getResource (String uri )
		   throws JetspeedCMSException
	{

		SlideResource resource = null;

		try
		{
			String userNode = this.getSlideUserNode();
			
			// Get the last NodeRevisionDescriptor
			SlideToken slideToken = this.getSlideToken( userNode );

			// uri parameter can be point to a linkNode => retrieve its target
			// objectnode
			ObjectNode objectNode = structure.retrieve(slideToken, uri, true);

			// Get the last Node revision descriptor
			NodeRevisionDescriptors revisionDescriptors =
				 content.retrieve(slideToken, objectNode.getUri());
			NodeRevisionDescriptor revisionDescriptor =
				 content.retrieve(slideToken, revisionDescriptors);

			// Check if the resource is a Catalog or an ContentItem
			// (based on the property class name) & an create an object for this resource
			NodeProperty p = revisionDescriptor.getProperty(PROPERTY_CLASS_NAME);
			String className = (String) p.getValue();
			resource = (SlideResource) Class.forName( className ).newInstance();
			resource.setUri(uri);
			// Populate the resource properties
			resource.setDescriptor(revisionDescriptor);

			// populate Security info
			resource.setPermissions(this.getSecurity(uri));
			return resource;
		}
		catch (AccessDeniedException e)
		{
			JetspeedCMSException e1 = new JetspeedCMSException("Impossible to get the content resource");
			e1.setIsAccessDenied(true);
			throw e1;
		}
		catch (NullPointerException e)
		{
			// Trigger when the objectNode has not the correct properties
			// eg. :  for a User or Action node in Slide. These type of node are mapped to Catalog

			Catalog catalog = (Catalog) CmsFactory.getCmsOmInstance("Catalog");
			catalog.setUri(uri);
			catalog.setLogicalName(uri);
			catalog.setTitle(uri);
			return catalog;
		}
		catch (RevisionDescriptorNotFoundException e)
		{
			// if  no revision descriptor => create an empty catalog object which
			// contains the uri data, a default title and a default logical name
			// This case arrives when the descriptor stores are not init by the
			// method Slide.createResource(...)
			// For example, after reading domain.xml, Slide will add all
			// namespace defined in the "scoop" xml tag in the target store
			// But in our case, we need different properties defined via the
			// NodeRevisionDescriptor like the title, logical name, ...

		    if (uri.equals(TurbineResources.getString("services.CmsService.catalog.root.uri")))
			{
				Catalog catalog =  (Catalog) CmsFactory.getCmsOmInstance("Catalog");
				catalog.setUri(uri);
				catalog.setLogicalName(TurbineResources.getString("services.CmsService.catalog.root.logicalname"));
				catalog.setTitle(TurbineResources.getString("services.CmsService.catalog.root.title"));
				return catalog;
			}
			else
			{
				// getResource called for a user/action ...
				Catalog catalog =  (Catalog) CmsFactory.getCmsOmInstance("Catalog");
				catalog.setUri(uri);
				catalog.setLogicalName(uri);
				catalog.setTitle(uri);
				return catalog;
				//e.printStackTrace();
				//return null;
			}
		}
		catch ( Exception e)
		{
			throw new JetspeedCMSException("Impossible to get the content resource");
		}
	}

	/**
	* Get all catalogs defined between 2 uri (from - to)
	*
	* @param userNode User reference
	* @param fromuri : first element of the interval
	* @param toUri  : last element of the interval
	* @return catalogs found between both uri
	*/
	public Vector getCatalogs(String fromUri, String toUri)
		   throws JetspeedCMSException
	{

		Vector catalogs = new Vector();
		String currentUri = toUri;

		while ( true )
		{
			try
			{
				Catalog catalog = (Catalog) this.getResource(currentUri);
				catalogs.insertElementAt(catalog, 0);

				if ((currentUri.equals(fromUri)) ||
					(catalog.getParentUri() == null) ||
					(catalog.getParentUri().equals("")) )
				{
					break;
				}

				currentUri = catalog.getParentUri();
			}
			catch (JetspeedCMSException e)
			{
				// If the exception is accessDenied : continue the loop for other catalog
				// else throw the exception
				if (!e.isAccessDenied())
				{
					throw new JetspeedCMSException("Impossible to get the complete catalog path");
				}
			}
		}

		return catalogs;
	}

	/**
	* Get Security information assigned to an uri
	* @param userNode User reference
	* @param uri for which the security info is asked
	*/
	public Vector getSecurity (String uri )
		   throws JetspeedCMSException
	{
		try
		{
			String userNode = this.getSlideUserNode();
			
			// Get the SlideToken in function of a SubjectNode string
			SlideToken slideToken = this.getSlideToken( userNode );
			// Retrieve security info
			Enumeration e = security.enumeratePermissions(slideToken, uri);