com.greenpepper.confluence.macros.AbstractGreenPepperMacro Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of greenpepper-confluence-code Show documentation
There is a newer version: 4.2.4
Show newest version
package com.greenpepper.confluence.macros;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import com.atlassian.confluence.content.render.xhtml.ConversionContext;
import com.atlassian.confluence.core.ContentEntityObject;
import com.atlassian.confluence.macro.Macro;
import com.atlassian.confluence.macro.MacroExecutionException;
import com.atlassian.confluence.pages.Page;
import com.atlassian.confluence.renderer.PageContext;
import com.atlassian.confluence.renderer.radeox.macros.MacroUtils;
import com.atlassian.confluence.spaces.Space;
import com.atlassian.confluence.util.SpaceComparator;
import com.atlassian.confluence.util.velocity.VelocityUtils;
import com.atlassian.renderer.RenderContext;
import com.atlassian.renderer.v2.RenderMode;
import com.atlassian.renderer.v2.macro.BaseMacro;
import com.atlassian.renderer.v2.macro.MacroException;
import com.greenpepper.confluence.velocity.ConfluenceGreenPepper;
import com.greenpepper.server.GreenPepperServerException;
import com.greenpepper.util.StringUtil;

/**
 * Abstract AbstractGreenPepperMacro class.
 *
 * @author oaouattara
 * @version $Id: $Id
 */
public abstract class AbstractGreenPepperMacro extends BaseMacro implements Macro
{
    protected ConfluenceGreenPepper gpUtil = new ConfluenceGreenPepper();

// Macros v4    
	/**
	 * getBodyType.
	 *
	 * @return a BodyType object.
	 */
	public BodyType getBodyType() {
		 return BodyType.NONE;
	}

	/**
	 * getOutputType.
	 *
	 * @return a OutputType object.
	 */
	public OutputType getOutputType() {
		 return OutputType.BLOCK;
	}

	/** {@inheritDoc} */
	public String execute(Map parameters, String body,
			ConversionContext context) throws MacroExecutionException {
	      try
	        {
	            return execute(parameters, body, context.getPageContext());
	        }
	        catch (MacroException e)
	        {
	            throw new MacroExecutionException(e);
	        } 	
	 }
// End Macros V4
	
    /**
     * isInline.
     *
     * @return a boolean.
     */
    public boolean isInline()
    {
        return false;
    }
    
    /**
     * hasBody.
     *
     * @return a boolean.
     */
    public boolean hasBody()
    {
        return false;
    }
    
    /**
     * getBodyRenderMode.
     *
     * @return a {@link com.atlassian.renderer.v2.RenderMode} object.
     */
    public RenderMode getBodyRenderMode()
    {
        return RenderMode.NO_RENDER;
    }
    

    /**
     * getSpaceKey.
     *
     * @param parameters a {@link java.util.Map} object.
     * @return a {@link java.lang.String} object.
     * @throws com.greenpepper.server.GreenPepperServerException if any.
     */
    protected String getSpaceKey(@SuppressWarnings("rawtypes") Map parameters) throws GreenPepperServerException
    {
        String spaceKey = (String)parameters.get("spaceKey");
        if(!StringUtil.isEmpty(spaceKey))
        {
            spaceKey = spaceKey.trim();

			Space space = gpUtil.getSpaceManager().getSpace(spaceKey);
			if(space == null)
				throw new GreenPepperServerException("greenpepper.children.spacenotfound", spaceKey);

			checkSpace(space);
        }
        
        return spaceKey;
    }
    
    /**
     * getSpaceKey.
     *
     * @param parameters a {@link java.util.Map} object.
     * @param renderContext a {@link com.atlassian.renderer.RenderContext} object.
     * @param checkPermission a boolean.
     * @return a {@link java.lang.String} object.
     * @throws com.greenpepper.server.GreenPepperServerException if any.
     */
    protected String getSpaceKey(@SuppressWarnings("rawtypes") Map parameters, RenderContext renderContext, boolean checkPermission) throws GreenPepperServerException
    {
    	Space space;
        String spaceKey = (String)parameters.get("spaceKey");
        
        if(StringUtil.isEmpty(spaceKey))
        {
			space = getCurrentSpace(renderContext);
        }
        else
        {
            spaceKey = spaceKey.trim();
            space = gpUtil.getSpaceManager().getSpace(spaceKey);
            if(space == null)
                throw new GreenPepperServerException("greenpepper.children.spacenotfound", spaceKey);
        }
        
        if (checkPermission)
        	checkSpace(space);
        
        return space.getKey();
    }

	/**
	 * getCurrentSpace.
	 *
	 * @param renderContext a {@link com.atlassian.renderer.RenderContext} object.
	 * @return a {@link com.atlassian.confluence.spaces.Space} object.
	 */
	protected Space getCurrentSpace(RenderContext renderContext)
	{
		ContentEntityObject owner = ((PageContext)renderContext).getEntity();
		return ((Page)owner).getSpace();
	}

	/**
	 * getPageTitle.
	 *
	 * @param parameters a {@link java.util.Map} object.
	 * @param renderContext a {@link com.atlassian.renderer.RenderContext} object.
	 * @param spaceKey a {@link java.lang.String} object.
	 * @return a {@link java.lang.String} object.
	 * @throws com.greenpepper.server.GreenPepperServerException if any.
	 */
	@SuppressWarnings("unchecked")
    protected String getPageTitle(@SuppressWarnings("rawtypes") Map parameters, RenderContext renderContext, String spaceKey) throws GreenPepperServerException
    {
        return getPage(parameters, renderContext, spaceKey).getTitle().trim();
    }
    
    /**
     * getPage.
     *
     * @param parameters a {@link java.util.Map} object.
     * @param renderContext a {@link com.atlassian.renderer.RenderContext} object.
     * @param spaceKey a {@link java.lang.String} object.
     * @return a {@link com.atlassian.confluence.pages.Page} object.
     * @throws com.greenpepper.server.GreenPepperServerException if any.
     */
    protected Page getPage(Map parameters, RenderContext renderContext, String spaceKey) throws GreenPepperServerException
    {
        String pageTitle = parameters.get("pageTitle");
        if(StringUtil.isEmpty(pageTitle))
        {
            ContentEntityObject owner = ((PageContext)renderContext).getEntity();
            return (Page)owner;
        }

        Page page = gpUtil.getPageManager().getPage(spaceKey, pageTitle);
        if(page == null)
            throw new GreenPepperServerException("greenpepper.children.pagenotfound", String.format("'%s' in space '%s'", pageTitle, spaceKey));
        
        return page;
    }

    /**
     * getSpaces.
     *
     * @return a {@link java.util.List} object.
     * @throws com.greenpepper.server.GreenPepperServerException if any.
     */
    protected List getSpaces() throws GreenPepperServerException
    {
        List spaces = new ArrayList();
        List potentialSpaces = gpUtil.getSpaceManager().getAllSpaces();
        
        for(Space space : potentialSpaces)
        {
            try { if(gpUtil.canView(space) && gpUtil.enable(space.getKey()) == null) spaces.add(space); }
            catch (GreenPepperServerException e){}
        } 
        
        if(spaces.isEmpty())
            throw new GreenPepperServerException("greenpepper.labels.registeredspacesempty", "No registered repository");

		Collections.sort(spaces, new SpaceComparator());
		
		return spaces;
    }
    
    /**
     * getBulkUID.
     *
     * @param parameters a {@link java.util.Map} object.
     * @return a {@link java.lang.String} object.
     */
    protected String getBulkUID(Map parameters)
    {
        String group = (String)parameters.get("group");
        return StringUtil.isEmpty(group) ? "PAGE" : group;
    }
    
    /**
     * isExpanded.
     *
     * @param parameters a {@link java.util.Map} object.
     * @return a boolean.
     */
    protected boolean isExpanded(Map parameters)
    {
        String all = parameters.get("expanded");
        return all != null && Boolean.valueOf(all);
    }

    /**
     * getErrorView.
     *
     * @param macroId a {@link java.lang.String} object.
     * @param errorId a {@link java.lang.String} object.
     * @return a {@link java.lang.String} object.
     */
    public static String getErrorView(String macroId, String errorId)
    {
        return getErrorView(macroId, errorId, null);
    }
    
    /**
     * getErrorView.
     *
     * @param macroId a {@link java.lang.String} object.
     * @param errorId a {@link java.lang.String} object.
     * @param message a {@link java.lang.String} object.
     * @return a {@link java.lang.String} object.
     */
    public static String getErrorView(String macroId, String errorId, String message)
    {
        Map contextMap = MacroUtils.defaultVelocityContext();
        contextMap.put("macroId", macroId);
        contextMap.put("errorId", errorId);
        contextMap.put("errorMessage", message != null ? message : "");
        return VelocityUtils.getRenderedTemplate("/templates/greenpepper/confluence/macros/greenPepperMacros-error.vm", contextMap);
    }

	private void checkSpace(Space space) throws GreenPepperServerException 
	{
		if(!gpUtil.canView(space))
            throw new GreenPepperServerException("greenpepper.macros.insufficientprivileges", ""); 

        String msg = gpUtil.enable(space.getKey());
        if(msg != null)
            throw new GreenPepperServerException("< " + space.getKey() + " > " + msg, "");
	}
}