WorkflowGraphExportService.java

/*
 * Copyright (c) 2002-2022, City of Paris
 * 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
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS 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 COPYRIGHT HOLDERS OR 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.
 *
 * License 1.0
 */
/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */
package fr.paris.lutece.plugins.workflow.service;

import fr.paris.lutece.plugins.workflowcore.business.workflow.Workflow;
import fr.paris.lutece.plugins.workflowcore.business.state.State;
import fr.paris.lutece.plugins.workflowcore.business.action.Action;
import fr.paris.lutece.plugins.workflowcore.service.task.ITask;

/**
 *
 * @author seboo
 */
public class WorkflowGraphExportService
{

    private static final String KEY_GRAPH = "graph TD";
    private static final String KEY_ASSIGN_LABEL_START = "[\"";
    private static final String KEY_ASSIGN_LABEL_END = "\"]";
    private static final String KEY_ASSIGN_ACTIONS_START = " --> |\"";
    private static final String KEY_ASSIGN_ACTIONS_END = "\"| ";
    private static final String KEY_ASSIGN_ALTERNATIVE_ACTION_PREFIX = "fa:fa-ban ";
    private static final String KEY_ASSIGN_DEFAULT_ACTION_PREFIX = "fa:fa-check ";
    private static final String KEY_NEWLINE = "<br /> ";
    private static final String KEY_CLICK = "click";
    private static final String STATE_URL_PART = "/jsp/admin/plugins/workflow/ModifyState.jsp?id_state=";
    private static final String NEWLINE = "\n";

    /**
     * Export workflow as Mermaid MD graph
     * 
     * @param wf
     * @param locale
     * @return the markdown definition of the workflow
     */
    public static String generate( Workflow wf, String strBaseUrl )
    {
        StringBuilder sb = new StringBuilder( KEY_GRAPH ).append( NEWLINE );

        // list states
        for ( State state : wf.getAllStates( ) )
        {
            sb.append( state.getId( ) ).append( KEY_ASSIGN_LABEL_START ).append( state.getName( ).replaceAll( "\"", "'" ) ).append( KEY_ASSIGN_LABEL_END )
                    .append( NEWLINE );
        }

        // list actions with tasks
        for ( Action action : wf.getAllActions( ) )
        {
            for ( Integer idState : action.getListIdStateBefore( ) )
            {
            	sb.append( idState ).append( KEY_ASSIGN_ACTIONS_START )
            		.append( getDefaultTransitionType( action ) )
            		.append( getTransitionLabel( action ) )
                    .append( KEY_ASSIGN_ACTIONS_END ).append( action.getStateAfter( ).getId( ) ).append( NEWLINE );
            	
            	if ( action.getAlternativeStateAfter( ) != null && action.getAlternativeStateAfter( ).getId( ) > 0)
                {
            		sb.append( idState ).append( KEY_ASSIGN_ACTIONS_START )
	            		.append( getAlternativeTransitionType( action ) )	
	            		.append( getTransitionLabel( action ) )
	                    .append( KEY_ASSIGN_ACTIONS_END ).append( action.getAlternativeStateAfter( ).getId( ) ).append( NEWLINE );
        	
                }
            }
        }

        if ( strBaseUrl != null )
        {
            // add links
            for ( State state : wf.getAllStates( ) )
            {
                sb.append( KEY_CLICK ).append( " " ).append( state.getId( ) ).append( " \"" ).append( strBaseUrl ).append( STATE_URL_PART )
                        .append( state.getId( ) ).append( "\"" ).append( NEWLINE );
            }
        }

        return sb.toString( );
    }

    /**
     * get labels for actions and tasks
     * 
     * @param action
     * @return the label
     */
    private static String getTransitionLabel( Action action )
    {
        StringBuilder sb = new StringBuilder( action.getName( ) );

        if ( action.getAllTasks( ) == null )
            return sb.toString( );

        for ( ITask task : action.getAllTasks( ) )
        {
            sb.append( KEY_NEWLINE ).append( " * " ).append( task.getTaskType( ).getTitle( ) );
        }

        return sb.toString( ).replaceAll( "\"", "'" );
    }
    
    private static String getDefaultTransitionType( Action action )
    {
    	if ( action.getAlternativeStateAfter( ) != null && action.getAlternativeStateAfter( ).getId( ) > 0)
    	{
    		return KEY_ASSIGN_DEFAULT_ACTION_PREFIX ;
    	}
    	else
    	{
    		return "";
    	}
    }
    
    private static String getAlternativeTransitionType( Action action )
    {
    	if ( action.getAlternativeStateAfter( ) != null && action.getAlternativeStateAfter( ).getId( ) > 0)
    	{
    		return KEY_ASSIGN_ALTERNATIVE_ACTION_PREFIX ;
    	}
    	else
    	{
    		return "";
    	}
    }

}