Source code

001/*
002 *  Copyright 2015 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.search.systemprop;
017
018import java.util.ArrayList;
019import java.util.HashMap;
020import java.util.LinkedHashMap;
021import java.util.List;
022import java.util.Map;
023
024import org.apache.avalon.framework.configuration.Configuration;
025import org.apache.avalon.framework.configuration.ConfigurationException;
026import org.apache.avalon.framework.configuration.DefaultConfiguration;
027import org.apache.avalon.framework.service.ServiceException;
028import org.apache.avalon.framework.service.ServiceManager;
029import org.apache.cocoon.xml.AttributesImpl;
030import org.apache.cocoon.xml.XMLUtils;
031import org.xml.sax.ContentHandler;
032import org.xml.sax.SAXException;
033
034import org.ametys.cms.data.ametysobject.ModelAwareDataAwareAmetysObject;
035import org.ametys.cms.search.model.SystemProperty;
036import org.ametys.cms.search.query.OrQuery;
037import org.ametys.cms.search.query.Query;
038import org.ametys.cms.search.query.Query.Operator;
039import org.ametys.cms.search.query.WorkflowStepQuery;
040import org.ametys.cms.workflow.DefaultWorkflowStepEnumerator;
041import org.ametys.core.model.type.ModelItemTypeHelper;
042import org.ametys.plugins.workflow.repository.WorkflowAwareAmetysObject;
043import org.ametys.plugins.workflow.support.WorkflowHelper;
044import org.ametys.plugins.workflow.support.WorkflowProvider;
045import org.ametys.plugins.workflow.support.WorkflowProvider.AmetysObjectWorkflow;
046import org.ametys.runtime.i18n.I18nizableText;
047import org.ametys.runtime.model.Enumerator;
048import org.ametys.runtime.model.type.DataContext;
049import org.ametys.runtime.model.type.ModelItemTypeConstants;
050import org.ametys.runtime.plugin.component.ThreadSafeComponentManager;
051
052import com.opensymphony.workflow.loader.StepDescriptor;
053import com.opensymphony.workflow.loader.WorkflowDescriptor;
054import com.opensymphony.workflow.spi.Step;
055
056/**
057 * {@link SystemProperty} which represents the current workflow step ID of an ametys object.
058 */
059public class WorkflowStepSystemProperty extends AbstractIndexableSystemProperty<Long, Long, ModelAwareDataAwareAmetysObject>
060{
061    /** System property identifier */
062    public static final String SYSTEM_PROPERTY_ID = "workflowStep";
063    
064    /** Solr field name. */
065    public static final String SOLR_FIELD_NAME = SYSTEM_PROPERTY_ID;
066    
067    /** The workflow provider */
068    protected WorkflowProvider _workflowProvider;
069    /** The workflow helper */
070    protected WorkflowHelper _workflowHelper;
071    
072    @Override
073    public void service(ServiceManager manager) throws ServiceException
074    {
075        super.service(manager);
076        _workflowProvider = (WorkflowProvider) manager.lookup(WorkflowProvider.ROLE);
077        _workflowHelper = (WorkflowHelper) manager.lookup(WorkflowHelper.ROLE);
078    }
079    
080    @Override
081    public Query getQuery(Object value, Operator operator, String language, Map<String, Object> contextualParameters)
082    {
083        if (value == null)
084        {
085            return new WorkflowStepQuery(Operator.EXISTS);
086        }
087        
088        Long[] values = value instanceof Long longValue
089                ? new Long[] {longValue}
090                : (Long[]) value;
091        List<Query> queries = new ArrayList<>();
092        for (Long stepId : values)
093        {
094            if (stepId != 0)
095            {
096                queries.add(new WorkflowStepQuery(operator, Math.toIntExact(stepId)));
097            }
098        }
099        
100        switch (queries.size())
101        {
102            case 0: return null;
103            case 1: return queries.get(0);
104            default: return new OrQuery(queries);
105        }
106    }
107    
108    @Override
109    public String getSolrFieldName()
110    {
111        return SOLR_FIELD_NAME;
112    }
113    
114    @Override
115    public String getSolrSortFieldName()
116    {
117        return SOLR_FIELD_NAME;
118    }
119    
120    @Override
121    public String getSolrFacetFieldName()
122    {
123        return SOLR_FIELD_NAME + "_dv";
124    }
125    
126    @Override
127    public String getRenderer()
128    {
129        return "Ametys.plugins.cms.search.SearchGridHelper.renderWorkflowStep";
130    }
131    
132    @Override
133    public String getConverter()
134    {
135        return "Ametys.plugins.cms.search.SearchGridHelper.convertWorkflowStep";
136    }
137    
138    @Override
139    public Integer getColumnWidth()
140    {
141        return 60;
142    }
143    
144    @Override
145    public Object getValue(ModelAwareDataAwareAmetysObject ametysObject)
146    {
147        if (ametysObject instanceof WorkflowAwareAmetysObject waAmetysObject)
148        {
149            AmetysObjectWorkflow workflow = _workflowProvider.getAmetysObjectWorkflow(waAmetysObject);
150            
151            long workflowId = waAmetysObject.getWorkflowId();
152            List<Step> currentSteps = workflow.getCurrentSteps(workflowId);
153            
154            if (!currentSteps.isEmpty())
155            {
156                return Long.valueOf(currentSteps.iterator().next().getStepId());
157            }
158        }
159        
160        return null;
161    }
162    
163    public Object valueToJSON(ModelAwareDataAwareAmetysObject ametysObject, DataContext context)
164    {
165        Long value = (Long) getValue(ametysObject);
166        if (value != null)
167        {
168            Map<String, Object> workflowInfos = new LinkedHashMap<>();
169            
170            if (ametysObject instanceof WorkflowAwareAmetysObject waAmetysObject)
171            {
172                int currentStepId = Math.toIntExact(value);
173                
174                StepDescriptor stepDescriptor = _workflowHelper.getStepDescriptor(waAmetysObject, currentStepId);
175                
176                if (stepDescriptor != null)
177                {
178                    return _workflowHelper.workflowStep2JSON(stepDescriptor);
179                }
180            }
181            
182            return workflowInfos;
183        }
184        return value;
185    }
186    
187    public void valueToSAX(ContentHandler contentHandler, ModelAwareDataAwareAmetysObject ametysObject, DataContext context) throws SAXException
188    {
189        Long value = (Long) getValue(ametysObject);
190        if (value != null && ametysObject instanceof WorkflowAwareAmetysObject waAmetysObject)
191        {
192            int currentStepId = Math.toIntExact(value);
193            StepDescriptor stepDescriptor = _getStepDescriptor(waAmetysObject, currentStepId);
194            
195            if (stepDescriptor != null)
196            {
197                I18nizableText workflowStepName = new I18nizableText("application", stepDescriptor.getName());
198                
199                AttributesImpl attr = ModelItemTypeHelper.getXMLAttributesFromDataContext(context);
200                attr.addCDATAAttribute("id", String.valueOf(currentStepId));
201                XMLUtils.startElement(contentHandler, getName(), attr);
202                workflowStepName.toSAX(contentHandler);
203                XMLUtils.endElement(contentHandler, getName());
204            }
205        }
206    }
207    
208    private StepDescriptor _getStepDescriptor(WorkflowAwareAmetysObject ametysObject, int stepId)
209    {
210        long workflowId = ametysObject.getWorkflowId();
211        
212        AmetysObjectWorkflow workflow = _workflowProvider.getAmetysObjectWorkflow(ametysObject);
213        
214        String workflowName = workflow.getWorkflowName(workflowId);
215        WorkflowDescriptor workflowDescriptor = workflow.getWorkflowDescriptor(workflowName);
216        
217        if (workflowDescriptor != null)
218        {
219            StepDescriptor stepDescriptor = workflowDescriptor.getStep(stepId);
220            if (stepDescriptor != null)
221            {
222                return stepDescriptor;
223            }
224            else if (_logger.isWarnEnabled())
225            {
226                _logger.warn("Unknown step id '" + stepId + "' for workflow for name : " + workflowName);
227            }
228        }
229        else if (_logger.isWarnEnabled())
230        {
231            _logger.warn("Unknown workflow for name : " + workflowName);
232        }
233        
234        return null;
235    }
236    
237    @Override
238    public Enumerator<Long> getDefaultCriterionEnumerator(Configuration configuration, ThreadSafeComponentManager<Enumerator> enumeratorManager) throws ConfigurationException
239    {
240        DefaultConfiguration conf = new DefaultConfiguration("criteria");
241        
242        String workflowName = configuration.getChild("workflow").getAttribute("name", "content");
243        
244        DefaultConfiguration enumConf = new DefaultConfiguration("enumeration");
245        
246        DefaultConfiguration customEnumerator = new DefaultConfiguration("custom-enumerator");
247        customEnumerator.setAttribute("class", DefaultWorkflowStepEnumerator.class.getName());
248        enumConf.addChild(customEnumerator);
249        
250        DefaultConfiguration wfNameConf = new DefaultConfiguration("workflow-name");
251        wfNameConf.setValue(workflowName);
252        customEnumerator.addChild(wfNameConf);
253        
254        DefaultConfiguration excludeConf = new DefaultConfiguration("exclude-workflow-steps");
255        
256        // Exclude workflow steps greater than 9000
257        List<StepDescriptor> steps = _workflowHelper.getWorkflowDescriptor(workflowName).getSteps();
258        for (StepDescriptor stepDescriptor : steps)
259        {
260            if (stepDescriptor.getId() >= 9000)
261            {
262                DefaultConfiguration stepId = new DefaultConfiguration("id");
263                stepId.setValue(stepDescriptor.getId());
264                excludeConf.addChild(stepId);
265            }
266        }
267        
268        customEnumerator.addChild(excludeConf);
269        
270        conf.addChild(enumConf);
271        
272        String role = "enumerator";
273        enumeratorManager.addComponent(getPluginName(), null, role, DefaultWorkflowStepEnumerator.class, conf);
274        
275        try
276        {
277            enumeratorManager.initialize();
278            return enumeratorManager.lookup(role);
279        }
280        catch (Exception e)
281        {
282            throw new ConfigurationException("Unable to initialize the workflow step enumerator for system property '" + getName() + "'.", conf, e);
283        }
284    }
285    
286    @Override
287    public Map<String, I18nizableText> getDefaultCriterionWidgetParameters(Configuration configuration)
288    {
289        Map<String, I18nizableText> parameters = new HashMap<>();
290        parameters.put("emptyText", new I18nizableText("plugin.cms", "WIDGET_COMBOBOX_ALL_OPTIONS"));
291        return parameters;
292    }
293    
294    @Override
295    protected String getTypeId()
296    {
297        return ModelItemTypeConstants.LONG_TYPE_ID;
298    }
299}