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