001/*
002 *  Copyright 2023 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.Map;
019
020import org.apache.avalon.framework.service.ServiceException;
021import org.apache.avalon.framework.service.ServiceManager;
022import org.apache.commons.lang3.ArrayUtils;
023
024import org.ametys.cms.CmsConstants;
025import org.ametys.cms.data.type.indexing.IndexableElementType;
026import org.ametys.cms.model.CMSDataContext;
027import org.ametys.cms.repository.Content;
028import org.ametys.cms.search.model.CriterionDefinitionAwareElementDefinition;
029import org.ametys.cms.search.model.CriterionDefinitionHelper;
030import org.ametys.cms.search.model.SystemProperty;
031import org.ametys.cms.search.query.HasLiveVersionQuery;
032import org.ametys.cms.search.query.Query;
033import org.ametys.cms.search.query.Query.Operator;
034import org.ametys.plugins.repository.version.VersionAwareAmetysObject;
035import org.ametys.runtime.model.type.ModelItemTypeConstants;
036
037/**
038 * {@link SystemProperty} which indicate if the content has a live version. The current version or a past one.
039 */
040public class HasLiveVersionSystemProperty extends AbstractSystemProperty<Boolean, Content> implements CriterionDefinitionAwareElementDefinition<Boolean>, IndexationAwareSystemProperty<Boolean, Content>
041{
042    /** Solr field name. */
043    public static final String SOLR_FIELD_NAME = "hasLive";
044    
045    /** The criterion definition helper */
046    protected CriterionDefinitionHelper _criterionDefinitionHelper;
047    
048    @Override
049    public void service(ServiceManager manager) throws ServiceException
050    {
051        super.service(manager);
052        _criterionDefinitionHelper = (CriterionDefinitionHelper) manager.lookup(CriterionDefinitionHelper.ROLE);
053    }
054    
055    public Query getQuery(Object value, Operator operator, String language, Map<String, Object> contextualParameters)
056    {
057        return new HasLiveVersionQuery(operator, (Boolean) value);
058    }
059
060    public String getSolrFieldName()
061    {
062        return SOLR_FIELD_NAME;
063    }
064    
065    public String getSolrSortFieldName()
066    {
067        return SOLR_FIELD_NAME;
068    }
069    
070    public String getSolrFacetFieldName()
071    {
072        return SOLR_FIELD_NAME + "_dv";
073    }
074    
075    public Object getValue(Content ametysObject)
076    {
077        if (ametysObject instanceof VersionAwareAmetysObject versionAware)
078        {
079            String[] labels = versionAware.getAllLabels();
080            if (ArrayUtils.contains(labels, CmsConstants.LIVE_LABEL))
081            {
082                return true;
083            }
084        }
085        return false;
086    }
087
088    @Override
089    protected String getTypeId()
090    {
091        return ModelItemTypeConstants.BOOLEAN_TYPE_ID;
092    }
093
094    public IndexableElementType getDefaultCriterionType()
095    {
096        CMSDataContext context = CMSDataContext.newInstance()
097                                               .withModelItem(this);
098        
099        String typeId = getType().getDefaultCriterionTypeId(context);
100        return _criterionDefinitionHelper.getCriterionDefinitionType(typeId);
101    }
102}