001/*
002 *  Copyright 2022 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.cms.workflow;
017
018import java.util.List;
019import java.util.Map;
020
021import javax.jcr.RepositoryException;
022
023import org.apache.commons.collections.ListUtils;
024
025import org.ametys.cms.repository.WorkflowAwareContent;
026import org.ametys.cms.repository.WorkflowAwareContentHelper;
027import org.ametys.runtime.i18n.I18nizableText;
028
029import com.opensymphony.module.propertyset.PropertySet;
030import com.opensymphony.workflow.WorkflowException;
031import com.opensymphony.workflow.spi.WorkflowEntry;
032
033/**
034 * OS workflow function to set the current step id
035 */
036public class ResetWorkflowIdFunction extends AbstractContentFunction
037{
038    @Override
039    public void execute(Map transientVars, Map args, PropertySet ps) throws WorkflowException
040    {
041        WorkflowAwareContent content = getContent(transientVars);
042        
043        try
044        {
045            // Add the lock token to the current session if the content is locked.
046            _addLockToken(content);
047            
048            // Save the current workflow ID.
049            if (content != null)
050            {
051                long workflowId = ((WorkflowEntry) transientVars.get("entry")).getId();
052                // Remove the old workflow (used on re-initialization of the workflow
053                WorkflowAwareContentHelper.removeWorkflowId(content);
054                content.setWorkflowId(workflowId);
055                content.saveChanges();
056            }
057        }
058        catch (RepositoryException e)
059        {
060            throw new WorkflowException("Unable to add a lock token to the current session.", e);
061        }
062    }
063    
064    @Override
065    public List<FunctionArgument> getArguments()
066    {
067        return ListUtils.EMPTY_LIST;
068    }
069
070    @Override
071    public I18nizableText getDescription(Map<String, String> args)
072    {
073        return new I18nizableText("plugin.cms", "PLUGINS_CMS_RESET_WORKFLOW_ID_FUNCTION_DESCRIPTION");
074    }
075}