com.greenpepper.confluence.macros.GreenPepperChildren 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.Map;

import com.atlassian.confluence.renderer.radeox.macros.MacroUtils;
import com.atlassian.confluence.util.velocity.VelocityUtils;
import com.atlassian.renderer.RenderContext;
import com.greenpepper.confluence.actions.execution.ChildrenExecutionAction;
import com.greenpepper.confluence.utils.MacroCounter;
import com.greenpepper.server.GreenPepperServerException;

/**
 * GreenPepperChildren class.
 *
 * @author oaouattara
 * @version $Id: $Id
 */
public class GreenPepperChildren extends AbstractGreenPepperMacro
{
	/*
	  	all: Default --> false
			If set to true, the complete hierarchy of the parent page will be included in the execution list.
			Otherwise only the first-level children will be included.
			
		spaceKey: Default --> Macro's residing space
			You can specify a specific space for your parent page.
			
		pageTitle: Default --> Macro's residing page
			You can specify a specific title for the parent page.
			
		title: Default --> blank
			You can specify your own title.
			
		expanded: Default --> false
			You can ask for the list to be expanded on page load.
			
		suts: Default --> All
			You can narrow the list to specific Systems Under Test (1 or more; if more than one they must be separated by a comma).
			
		group: Default --> PAGE
			You can regroup all your macros in a page under a group name. (See Group Macro.)
			
		sort Default --> Hierarchical sort
			You can configure the way children are sorted. Choose Creation to sort by content creation dates, Title to sort alphabetically by titles and Modified to sort by modification dates (last date first).
			
		reverse Default --> false
			You can reverse the sorting sequence.
			
		openInSameWindow Default --> false NEW in v2.1
			You can control whether or not the link to the specification will open in the same window.
	 */
    /** Constant TITLE_PARAM="title" */
    public static final String TITLE_PARAM = "title";

	/**
	 * isInline.
	 *
	 * @return a boolean.
	 */
	public boolean isInline()
    {
        return false;
    }
	
	/** {@inheritDoc} */
	@Override
	public BodyType getBodyType()
	{
	    return BodyType.NONE;
	}
	 
	/** {@inheritDoc} */
	@Override
	public OutputType getOutputType()
	{
	    return OutputType.BLOCK;
	}

    /** {@inheritDoc} */
    @SuppressWarnings("unchecked")
    public String execute(Map parameters, String body, RenderContext renderContext)
    {
        try
        {
        	boolean openInSameWindow;
        	String boolValueOpenInSameWindow = (String) parameters.get("openInSameWindow");
        	if(boolValueOpenInSameWindow == null)
        	{
        		openInSameWindow = false;
        	}
        	else
        	{
        		openInSameWindow = Boolean.valueOf(boolValueOpenInSameWindow);
        	}
        	String view = "/templates/greenpepper/confluence/macros/greenPepperList.vm";
            Map contextMap = MacroUtils.defaultVelocityContext();
            contextMap.put(TITLE_PARAM, (String)parameters.get(TITLE_PARAM));
            
            String spaceKey = getSpaceKey(parameters, renderContext, true);
            boolean allChildren = withAllChildren(parameters);
            ChildrenExecutionAction action = new ChildrenExecutionAction();
            action.setBulkUID(getBulkUID(parameters));
            action.setExecutionUID("CHILDREN_" + (allChildren ? "ALL_" :"") + MacroCounter.instance().getNextCount());
            action.setSpaceKey(spaceKey);
            action.setPage(getPage(parameters, renderContext, spaceKey));
            action.setShowList(isExpanded(parameters));
            action.setForcedSuts((String)parameters.get("suts"));
            action.setAllChildren(allChildren);
            action.setSortType((String) parameters.get("sort"));
            action.setReverse(Boolean.valueOf((String) parameters.get("reverse")).booleanValue());
            
            contextMap.put("openInSameWindow", openInSameWindow);
            contextMap.put("action", action);
            contextMap.put("view", "/templates/greenpepper/confluence/execution/children-execution.vm");
            
            return VelocityUtils.getRenderedTemplate(view, contextMap);
        }
        catch (GreenPepperServerException gpe)
        {
            return getErrorView("greenpepper.children.macroid", gpe.getId());
        }
        catch (Exception e)
        {
            return getErrorView("greenpepper.children.macroid", e.getMessage());
        }
    }
    
    private boolean withAllChildren(Map parameters)
    {
        String all = (String)parameters.get("all");
        return all != null && Boolean.valueOf(all);
    }
}