001/*
002 *  Copyright 2024 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.HashMap;
019import java.util.Map;
020
021import org.apache.avalon.framework.configuration.Configuration;
022import org.apache.avalon.framework.service.ServiceException;
023import org.apache.avalon.framework.service.ServiceManager;
024import org.apache.cocoon.xml.AttributesImpl;
025import org.apache.cocoon.xml.XMLUtils;
026import org.xml.sax.ContentHandler;
027import org.xml.sax.SAXException;
028
029import org.ametys.cms.data.ametysobject.ModelAwareDataAwareAmetysObject;
030import org.ametys.cms.search.model.SystemProperty;
031import org.ametys.cms.search.query.Query;
032import org.ametys.cms.search.query.Query.Operator;
033import org.ametys.cms.search.query.WorkflowNameQuery;
034import org.ametys.core.model.type.ModelItemTypeHelper;
035import org.ametys.plugins.workflow.repository.WorkflowAwareAmetysObject;
036import org.ametys.plugins.workflow.support.WorkflowHelper;
037import org.ametys.plugins.workflow.support.WorkflowProvider;
038import org.ametys.plugins.workflow.support.WorkflowProvider.AmetysObjectWorkflow;
039import org.ametys.runtime.i18n.I18nizableText;
040import org.ametys.runtime.model.type.DataContext;
041import org.ametys.runtime.model.type.ModelItemTypeConstants;
042
043/**
044 * {@link SystemProperty} which represents the current workflow name of an ametys object.
045 */
046public class WorkflowNameSystemProperty extends AbstractIndexableSystemProperty<String, String, ModelAwareDataAwareAmetysObject>
047{
048    /** Solr field name. */
049    public static final String SOLR_FIELD_NAME = "workflowName";
050    
051    /** The workflow provider */
052    protected WorkflowProvider _workflowProvider;
053    /** The workflow helper */
054    protected WorkflowHelper _workflowHelper;
055    
056    @Override
057    public void service(ServiceManager manager) throws ServiceException
058    {
059        super.service(manager);
060        _workflowProvider = (WorkflowProvider) manager.lookup(WorkflowProvider.ROLE);
061        _workflowHelper = (WorkflowHelper) manager.lookup(WorkflowHelper.ROLE);
062    }
063    
064    @Override
065    public Query getQuery(Object value, Operator operator, String language, Map<String, Object> contextualParameters)
066    {
067        if (_criterionDefinitionHelper.isQueryValueEmpty(value))
068        {
069            return new WorkflowNameQuery(Operator.EXISTS);
070        }
071        else if (value instanceof String[] values)
072        {
073            return new WorkflowNameQuery(operator, values);
074        }
075        else
076        {
077            return new WorkflowNameQuery(operator, (String) value);
078        }
079    }
080    
081    @Override
082    public String getSolrFieldName()
083    {
084        return SOLR_FIELD_NAME;
085    }
086    
087    @Override
088    public String getSolrSortFieldName()
089    {
090        return SOLR_FIELD_NAME;
091    }
092    
093    @Override
094    public String getSolrFacetFieldName()
095    {
096        return SOLR_FIELD_NAME + "_dv";
097    }
098    
099    @Override
100    public Object getValue(ModelAwareDataAwareAmetysObject ametysObject)
101    {
102        if (ametysObject instanceof WorkflowAwareAmetysObject waAmetysObject)
103        {
104            AmetysObjectWorkflow workflow = _workflowProvider.getAmetysObjectWorkflow(waAmetysObject);
105            
106            long workflowId = waAmetysObject.getWorkflowId();
107            return workflow.getWorkflowName(workflowId);
108        }
109        
110        return null;
111    }
112    
113    public Object valueToJSON(ModelAwareDataAwareAmetysObject ametysObject, DataContext context)
114    {
115        String workflowName = (String) getValue(ametysObject);
116        if (workflowName != null)
117        {
118            return Map.of(
119                "value", workflowName,
120                "label", _workflowHelper.getWorkflowLabel(workflowName)
121            );
122        }
123        return Map.of();
124    }
125    
126    public void valueToSAX(ContentHandler contentHandler, ModelAwareDataAwareAmetysObject ametysObject, DataContext context) throws SAXException
127    {
128        String workflowName = (String) getValue(ametysObject);
129        if (workflowName != null)
130        {
131            AttributesImpl attr = ModelItemTypeHelper.getXMLAttributesFromDataContext(context);
132            attr.addCDATAAttribute("value", String.valueOf(workflowName));
133            XMLUtils.startElement(contentHandler, getName(), attr);
134            _workflowHelper.getWorkflowLabel(workflowName).toSAX(contentHandler);
135            XMLUtils.endElement(contentHandler, getName());
136        }
137    }
138    
139    @Override
140    protected String getTypeId()
141    {
142        return ModelItemTypeConstants.STRING_TYPE_ID;
143    }
144    
145    @Override
146    public Map<String, I18nizableText> getDefaultCriterionWidgetParameters(Configuration configuration)
147    {
148        Map<String, I18nizableText> parameters = new HashMap<>();
149        parameters.put("emptyText", new I18nizableText("plugin.cms", "WIDGET_COMBOBOX_ALL_OPTIONS"));
150        return parameters;
151    }
152}