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.web.search.systemprop;
017
018import java.util.LinkedHashMap;
019import java.util.Map;
020
021import org.apache.avalon.framework.configuration.Configuration;
022import org.apache.avalon.framework.configuration.ConfigurationException;
023import org.apache.avalon.framework.service.ServiceException;
024import org.apache.avalon.framework.service.ServiceManager;
025
026import org.ametys.cms.data.type.indexing.IndexableElementType;
027import org.ametys.cms.model.CMSDataContext;
028import org.ametys.cms.repository.Content;
029import org.ametys.cms.search.model.CriterionDefinitionAwareElementDefinition;
030import org.ametys.cms.search.model.CriterionDefinitionHelper;
031import org.ametys.cms.search.model.SystemProperty;
032import org.ametys.cms.search.query.Query;
033import org.ametys.cms.search.query.Query.Operator;
034import org.ametys.cms.search.systemprop.AbstractSystemProperty;
035import org.ametys.cms.search.systemprop.IndexationAwareSystemProperty;
036import org.ametys.runtime.model.Enumerator;
037import org.ametys.runtime.model.type.DataContext;
038import org.ametys.runtime.model.type.ModelItemTypeConstants;
039import org.ametys.runtime.plugin.component.ThreadSafeComponentManager;
040import org.ametys.web.indexing.solr.SolrWebFieldNames;
041import org.ametys.web.repository.content.WebContent;
042import org.ametys.web.repository.site.Site;
043import org.ametys.web.search.misc.SiteQueryHelper;
044import org.ametys.web.site.SiteEnumerator;
045
046/**
047 * {@link SystemProperty} which represents the site of a Content.
048 */
049public class SiteSystemProperty extends AbstractSystemProperty<String, Content> implements CriterionDefinitionAwareElementDefinition<String>, IndexationAwareSystemProperty<String, Content>
050{
051    /** Solr field name. */
052    public static final String SOLR_FIELD_NAME = SolrWebFieldNames.SITE_NAME;
053    
054    /** The site query helper */
055    protected SiteQueryHelper _siteQueryHelper;
056    /** The criterion definition helper */
057    protected CriterionDefinitionHelper _criterionDefinitionHelper;
058    
059    @Override
060    public void service(ServiceManager manager) throws ServiceException
061    {
062        super.service(manager);
063        _siteQueryHelper = (SiteQueryHelper) manager.lookup(SiteQueryHelper.ROLE);
064        _criterionDefinitionHelper = (CriterionDefinitionHelper) manager.lookup(CriterionDefinitionHelper.ROLE);
065    }
066    
067    @Override
068    public Query getQuery(Object value, Operator operator, String language, Map<String, Object> contextualParameters)
069    {
070        return _siteQueryHelper.getQuery(value, operator, getName(), contextualParameters);
071    }
072    
073    @Override
074    public String getDefaultCriterionWidget()
075    {
076        return "edition.select-site";
077    }
078    
079    @Override
080    public String getRenderer()
081    {
082        return "Ametys.plugins.web.search.ContentSearchTool.renderSite";
083    }
084    
085    @Override
086    public String getConverter()
087    {
088        return "Ametys.plugins.web.search.ContentSearchTool.convertSite";
089    }
090    
091    public String getSolrFieldName()
092    {
093        return SOLR_FIELD_NAME;
094    }
095    
096    public String getSolrSortFieldName()
097    {
098        return SOLR_FIELD_NAME + "_sort";
099    }
100    
101    public String getSolrFacetFieldName()
102    {
103        return SOLR_FIELD_NAME + "_dv";
104    }
105    
106    @Override
107    public Object getValue(Content content)
108    {
109        if (content instanceof WebContent webContent)
110        {
111            return webContent.getSiteName();
112        }
113        
114        return null;
115    }
116    
117    @Override
118    public Object valueToJSON(Content content, DataContext context)
119    {
120        String value = (String) getValue(content);
121        if (value != null)
122        {
123            Map<String, Object> info = new LinkedHashMap<>();
124            info.put("name", value);
125            
126            Site site = ((WebContent) content).getSite();
127            if (site != null)
128            {
129                info.put("title", site.getTitle());
130            }
131            return info;
132        }
133        
134        return value;
135    }
136    
137    @Override
138    public Object getSortValue(Content content)
139    {
140        if (content instanceof WebContent webContent)
141        {
142            return webContent.getSite().getTitle();
143        }
144        
145        return null;
146    }
147    
148    @Override
149    public Enumerator<String> getDefaultCriterionEnumerator(Configuration configuration, ThreadSafeComponentManager<Enumerator> enumeratorManager) throws ConfigurationException
150    {
151        String role = "enumerator";
152        enumeratorManager.addComponent(getPluginName(), null, role, SiteEnumerator.class, configuration);
153        
154        try
155        {
156            enumeratorManager.initialize();
157            return enumeratorManager.lookup(role);
158        }
159        catch (Exception e)
160        {
161            throw new ConfigurationException("Unable to initialize the site enumerator for system property '" + getName() + "'.", configuration, e);
162        }
163    }
164    
165    @Override
166    protected String getTypeId()
167    {
168        return ModelItemTypeConstants.STRING_TYPE_ID;
169    }
170    
171    public IndexableElementType getDefaultCriterionType()
172    {
173        CMSDataContext context = CMSDataContext.newInstance()
174                                               .withModelItem(this);
175        
176        String typeId = getType().getDefaultCriterionTypeId(context);
177        return _criterionDefinitionHelper.getCriterionDefinitionType(typeId);
178    }
179}