/*
 *  Copyright 2015 Anyware Services
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.ametys.cms.search.ui.model;

import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;

import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.avalon.framework.configuration.DefaultConfiguration;
import org.apache.avalon.framework.context.Context;
import org.apache.avalon.framework.context.ContextException;
import org.apache.avalon.framework.context.Contextualizable;
import org.apache.avalon.framework.service.ServiceException;
import org.apache.avalon.framework.service.ServiceManager;
import org.apache.avalon.framework.service.Serviceable;
import org.slf4j.Logger;

import org.ametys.cms.contenttype.ContentTypeExtensionPoint;
import org.ametys.cms.search.model.SearchCriterion;
import org.ametys.cms.search.query.Query.Operator;
import org.ametys.runtime.i18n.I18nizableText;
import org.ametys.runtime.plugin.component.LogEnabled;

/**
 * Abstract class for SearchUIModel.
 */
public abstract class AbstractSearchUIModel implements SearchUIModel, LogEnabled, Serviceable, Contextualizable
{
    /** The default plugin name for URLs */
    protected static final String DEFAULT_URL_PLUGIN = "cms";
    /** The default URL for search */
    protected static final String DEFAULT_SEARCH_URL = "search/list.json";
    /** The default URL for CSV export */
    protected static final String DEFAULT_EXPORT_CSV_URL = "search/export.csv";
    /** The default URL for DOC export */
    protected static final String DEFAULT_EXPORT_DOC_URL = "search/export.doc";
    /** The default URL for XML export */
    protected static final String DEFAULT_EXPORT_XML_URL = "search/export.xml";
    /** The URL for print results */
    protected static final String DEFAULT_PRINT_URL = "search/print.html";
    
    /** The content type extension point */
    protected ContentTypeExtensionPoint _cTypeEP;
    /** The search model helper. */
    protected SearchUIModelHelper _searchModelHelper;
    /** The logger. */
    protected Logger _logger;
    /** The service manager */
    protected ServiceManager _manager;
    /** The context. */
    protected Context _context;
    
    /** The content types of this search model. */
    protected Set<String> _cTypes;
    /** The content types excluded from this search model. */
    protected Set<String> _excludedCTypes;
    
    /** The search criteria in simple mode, indexed by ID. */
    protected Map<String, SearchUICriterion> _searchCriteria;
    /** The search criteria in advanced mode, indexed by ID. */
    protected Map<String, SearchUICriterion> _advancedSearchCriteria;
    /** The search criteria used as facets, indexed by ID. */
    protected Map<String, SearchUICriterion> _facetedCriteria;
    /** The result columns, indexed by ID. */
    protected Map<String, SearchUIColumn> _columns;
    
    public void setLogger(final Logger logger)
    {
        _logger = logger;
    }
    
    /**
     * Get the logger.
     * @return the logger.
     */
    protected final Logger getLogger()
    {
        return _logger;
    }
    
    @Override
    public void contextualize(Context context) throws ContextException
    {
        _context = context;
    }
    
    @Override
    public void service(ServiceManager manager) throws ServiceException
    {
        _cTypeEP = (ContentTypeExtensionPoint) manager.lookup(ContentTypeExtensionPoint.ROLE);
        _searchModelHelper = (SearchUIModelHelper) manager.lookup(SearchUIModelHelper.ROLE);
        _manager = manager;
    }
    
    @Override
    public Set<String> getContentTypes(Map<String, Object> contextualParameters)
    {
        return Collections.unmodifiableSet(_cTypes);
    }
    
    /**
     * Set the content types.
     * @param cTypes The content types.
     */
    public void setContentTypes(Set<String> cTypes)
    {
        _cTypes = new HashSet<>(cTypes);
    }
    
    @Override
    public Set<String> getExcludedContentTypes(Map<String, Object> contextualParameters)
    {
        return Collections.unmodifiableSet(_excludedCTypes);
    }
    
    /**
     * Set the excluded content types.
     * @param cTypes The excluded content types.
     */
    public void setExcludedContentTypes(Set<String> cTypes)
    {
        _excludedCTypes = new HashSet<>(cTypes);
    }
    
    @Override
    public Map<String, SearchUICriterion> getCriteria(Map<String, Object> contextualParameters)
    {
        return Collections.unmodifiableMap(_searchCriteria);
    }
    
    /**
     * Set the criteria in simple mode.
     * @param criteria A collection of search criteria.
     */
    public void setCriteria(Collection<SearchUICriterion> criteria)
    {
        _searchCriteria = new LinkedHashMap<>();
        for (SearchCriterion criterion : criteria)
        {
            _searchCriteria.put(criterion.getId(), (SearchUICriterion) criterion);
        }
    }
    
    @Override
    public Map<String, SearchUICriterion> getAdvancedCriteria(Map<String, Object> contextualParameters)
    {
        return Collections.unmodifiableMap(_advancedSearchCriteria);
    }
    
    /**
     * Set the criteria in advanced mode.
     * @param criteria A collection of search criteria.
     */
    public void setAdvancedCriteria(Collection<SearchUICriterion> criteria)
    {
        _advancedSearchCriteria = new LinkedHashMap<>();
        for (SearchUICriterion criterion : criteria)
        {
            _advancedSearchCriteria.put(criterion.getId(), criterion);
        }
    }
    
    @Override
    public Map<String, SearchUICriterion> getFacetedCriteria(Map<String, Object> contextualParameters)
    {
        return Collections.unmodifiableMap(_facetedCriteria);
    }
    
    /**
     * Set the criteria to use as facets.
     * @param criteria A collection of search criteria.
     */
    public void setFacetedCriteria(Collection<SearchCriterion> criteria)
    {
        _facetedCriteria = new LinkedHashMap<>();
        for (SearchCriterion criterion : criteria)
        {
            _facetedCriteria.put(criterion.getId(), (SearchUICriterion) criterion);
        }
    }
    
    @Override
    public Map<String, SearchUIColumn> getResultFields(Map<String, Object> contextualParameters)
    {
        return Collections.unmodifiableMap(_columns);
    }
    
    /**
     * Set the result columns.
     * @param fields A collection of search columns.
     */
    public void setResultFields(Collection<SearchUIColumn> fields)
    {
        _columns = new LinkedHashMap<>();
        for (SearchUIColumn column : fields)
        {
            _columns.put(column.getId(), column);
        }
    }
    
    @Override
    public int getPageSize(Map<String, Object> contextualParameters)
    {
        // Use the default value or unlimited.
        return -1;
    }
    
    @Override
    public String getWorkspace(Map<String, Object> contextualParameters)
    {
        // Use the default workspace.
        return null;
    }
    
    @Override
    public String getSearchUrl(Map<String, Object> contextualParameters)
    {
        return DEFAULT_SEARCH_URL;
    }
    
    @Override
    public String getSearchUrlPlugin(Map<String, Object> contextualParameters)
    {
        return DEFAULT_URL_PLUGIN;
    }
    
    @Override
    public String getExportCSVUrl(Map<String, Object> contextualParameters)
    {
        return DEFAULT_EXPORT_CSV_URL;
    }
    
    @Override
    public String getExportCSVUrlPlugin(Map<String, Object> contextualParameters)
    {
        return DEFAULT_URL_PLUGIN;
    }

    @Override
    public String getExportDOCUrl(Map<String, Object> contextualParameters)
    {
        return DEFAULT_EXPORT_DOC_URL;
    }

    @Override
    public String getExportDOCUrlPlugin(Map<String, Object> contextualParameters)
    {
        return DEFAULT_URL_PLUGIN;
    }

    @Override
    public String getExportXMLUrl(Map<String, Object> contextualParameters)
    {
        return DEFAULT_EXPORT_XML_URL;
    }

    @Override
    public String getExportXMLUrlPlugin(Map<String, Object> contextualParameters)
    {
        return DEFAULT_URL_PLUGIN;
    }

    @Override
    public String getPrintUrl(Map<String, Object> contextualParameters)
    {
        return DEFAULT_PRINT_URL;
    }

    @Override
    public String getPrintUrlPlugin(Map<String, Object> contextualParameters)
    {
        return DEFAULT_URL_PLUGIN;
    }
    
    @Override
    public String getSummaryView()
    {
        return null;
    }
    
    /**
     * Get the configuration of a metadata criteria component.
     * @param baseContentTypeIds the "base" content type identifiers.
     * @param path the field path.
     * @param operator the criteria operator, can be null.
     * @return the configuration to provide to the metadata criteria component.
     * @throws ConfigurationException if an error occurs.
     */
    protected Configuration getIndexingFieldCriteriaConfiguration(Set<String> baseContentTypeIds, String path, Operator operator) throws ConfigurationException
    {
        return getIndexingFieldCriteriaConfiguration(baseContentTypeIds, path, operator, null);
    }
    
    /**
     * Get the configuration of a metadata criteria component.
     * @param baseContentTypeIds the "base" content type identifiers.
     * @param path the field path.
     * @param operator the criteria operator, can be null.
     * @param group The group. Can be null.
     * @return the configuration to provide to the metadata criteria component.
     * @throws ConfigurationException if an error occurs.
     */
    protected Configuration getIndexingFieldCriteriaConfiguration(Set<String> baseContentTypeIds, String path, Operator operator, I18nizableText group) throws ConfigurationException
    {
        return getIndexingFieldCriteriaConfiguration(new DefaultConfiguration("criteria"), baseContentTypeIds, path, operator, group);
    }
    
    /**
     * Get the configuration of a metadata criteria component.
     * @param originalConf the original criteria configuration.
     * @param baseContentTypeIds the "base" content type identifiers.
     * @param path the field path, separated by '/'.
     * @param operator the criteria operator, can be null.
     * @param group The group. Can be null.
     * @return the configuration to provide to the metadata criterion component.
     * @throws ConfigurationException if an error occurs.
     */
    protected Configuration getIndexingFieldCriteriaConfiguration(Configuration originalConf, Set<String> baseContentTypeIds, String path, Operator operator, I18nizableText group) throws ConfigurationException
    {
        DefaultConfiguration conf = new DefaultConfiguration(originalConf);
        
        DefaultConfiguration metaConf = new DefaultConfiguration("field");
        conf.addChild(metaConf);
        metaConf.setAttribute("path", path);
        
        if (operator != null)
        {
            DefaultConfiguration opConf = new DefaultConfiguration("test-operator");
            conf.addChild(opConf);
            opConf.setValue(operator.getName());
        }
        
        addContentTypesConfiguration(conf, baseContentTypeIds);
        
        if (group != null)
        {
            DefaultConfiguration groupConf = new DefaultConfiguration("group");
            groupConf.setAttribute("i18n", group.isI18n());
            groupConf.setValue(group.isI18n() ? group.getCatalogue() + ":" + group.getKey() : group.getLabel());
            conf.addChild(groupConf);
        }
        
        return conf;
    }
    
    /**
     * Get the configuration of a system criteria component.
     * @param baseContentTypeIds the "base" content type identifiers.
     * @param property the system property.
     * @return the configuration to provide to the system criterion component.
     */
    protected Configuration getSystemCriteriaConfiguration(Set<String> baseContentTypeIds, String property)
    {
        return getSystemCriteriaConfiguration(baseContentTypeIds, property, null);
    }
    
    /**
     * Get the configuration of a system criteria component.
     * @param baseContentTypeIds the "base" content type identifiers.
     * @param property the system property.
     * @param group The group. Can be null.
     * @return the configuration to provide to the system criterion component.
     */
    protected Configuration getSystemCriteriaConfiguration(Set<String> baseContentTypeIds, String property, I18nizableText group)
    {
        try
        {
            return getSystemCriteriaConfiguration(new DefaultConfiguration("criteria"), baseContentTypeIds, property, group);
        }
        catch (ConfigurationException e)
        {
            // Ignore, just can't happen.
            return null;
        }
    }
    
    /**
     * Get the configuration of a system criteria component.
     * @param originalConf the original column configuration.
     * @param baseContentTypeIds the "base" content type identifiers.
     * @param property the system property.
     * @param group The group. Can be null.
     * @return the configuration to provide to the system criterion component.
     * @throws ConfigurationException if an error occurs.
     */
    protected Configuration getSystemCriteriaConfiguration(Configuration originalConf, Set<String> baseContentTypeIds, String property, I18nizableText group) throws ConfigurationException
    {
        DefaultConfiguration conf = new DefaultConfiguration(originalConf);
        
        DefaultConfiguration propConf = new DefaultConfiguration("systemProperty");
        propConf.setAttribute("name", property);
        conf.addChild(propConf);
        
        addContentTypesConfiguration(conf, baseContentTypeIds);
        
        if (group != null)
        {
            DefaultConfiguration groupConf = new DefaultConfiguration("group");
            groupConf.setAttribute("i18n", group.isI18n());
            groupConf.setValue(group.isI18n() ? group.getCatalogue() + ":" + group.getKey() : group.getLabel());
            conf.addChild(groupConf);
        }
        
        return conf;
    }
    
    /**
     * Get the configuration of a custom criteria component.
     * @param originalConf the original column configuration.
     * @param baseContentTypeIds the "base" content type identifiers.
     * @param customCriterionId the custom criterion id
     * @param group The group. Can be null.
     * @return the configuration to provide to the custom criterion component.
     * @throws ConfigurationException if an error occurs.
     */
    protected Configuration getCustomCriteriaConfiguration(Configuration originalConf, Set<String> baseContentTypeIds, String customCriterionId, I18nizableText group) throws ConfigurationException
    {
        DefaultConfiguration conf = new DefaultConfiguration(originalConf);
        
        DefaultConfiguration customCriterionConf = new DefaultConfiguration("customCriterion");
        customCriterionConf.setAttribute("id", customCriterionId);
        conf.addChild(customCriterionConf);
        
        addContentTypesConfiguration(conf, baseContentTypeIds);
        
        if (group != null)
        {
            DefaultConfiguration groupConf = new DefaultConfiguration("group");
            groupConf.setAttribute("i18n", group.isI18n());
            groupConf.setValue(group.isI18n() ? group.getCatalogue() + ":" + group.getKey() : group.getLabel());
            conf.addChild(groupConf);
        }
        
        return conf;
    }

    /**
     * Get the configuration of a metadata column component.
     * @param baseContentTypeIds the "base" content type identifiers.
     * @param metadataPath the metadata path.
     * @return the configuration to provide to the metadata column component.
     * @throws ConfigurationException if an error occurs.
     */
    protected Configuration getMetadataColumnConfiguration(Set<String> baseContentTypeIds, String metadataPath) throws ConfigurationException
    {
        return getMetadataColumnConfiguration(new DefaultConfiguration("column"), baseContentTypeIds, metadataPath);
    }
    
    /**
     * Get the configuration of a metadata column component.
     * @param originalConf the original column configuration.
     * @param baseContentTypeIds the base content type identifiers.
     * @param metadataPath the metadata path.
     * @return the configuration to provide to the metadata column component.
     * @throws ConfigurationException if an error occurs.
     */
    protected Configuration getMetadataColumnConfiguration(Configuration originalConf, Set<String> baseContentTypeIds, String metadataPath) throws ConfigurationException
    {
        DefaultConfiguration conf = new DefaultConfiguration(originalConf);
        
        DefaultConfiguration metaConf = new DefaultConfiguration("metadata");
        conf.addChild(metaConf);
        metaConf.setAttribute("path", metadataPath);
        
        addContentTypesConfiguration(conf, baseContentTypeIds);
        
        // conf for allowing sort on multiple join
        DefaultConfiguration allowSortOnMultipleJoinConf = new DefaultConfiguration("allow-sort-on-multiple-join");
        allowSortOnMultipleJoinConf.setValue(allowSortOnMultipleJoin());
        conf.addChild(allowSortOnMultipleJoinConf);
        
        return conf;
    }
    
    /**
     * Get the configuration of a system column component.
     * @param baseContentTypeIds the "base" content type identifiers.
     * @param property the system property.
     * @return the configuration to provide to the system column component.
     * @throws ConfigurationException if an error occurs.
     */
    protected Configuration getSystemColumnConfiguration(Set<String> baseContentTypeIds, String property) throws ConfigurationException
    {
        return getSystemColumnConfiguration(new DefaultConfiguration("column"), baseContentTypeIds, property);
    }
    
    /**
     * Get the configuration of a system column component.
     * @param originalConf the original column configuration.
     * @param baseContentTypeIds the "base" content type identifiers.
     * @param property the system property.
     * @return the configuration to provide to the system column component.
     * @throws ConfigurationException if an error occurs.
     */
    protected Configuration getSystemColumnConfiguration(Configuration originalConf, Set<String> baseContentTypeIds, String property) throws ConfigurationException
    {
        DefaultConfiguration conf = originalConf != null ? new DefaultConfiguration(originalConf) : new DefaultConfiguration("column");
        
        DefaultConfiguration propConf = new DefaultConfiguration("systemProperty");
        propConf.setAttribute("name", property);
        conf.addChild(propConf);
        
        addContentTypesConfiguration(conf, baseContentTypeIds);
        
        return conf;
    }
    
    /**
     * Add the content types configuration.
     * @param conf The configuration to write to.
     * @param baseContentTypeIds The "base" content type identifiers.
     */
    protected void addContentTypesConfiguration(DefaultConfiguration conf, Set<String> baseContentTypeIds)
    {
        Set<String> contentTypes = _searchModelHelper.getAllContentTypes(this, Collections.emptyMap());
        DefaultConfiguration cTypesConf = new DefaultConfiguration("contentTypes");
        conf.addChild(cTypesConf);
        for (String contentType : contentTypes)
        {
            DefaultConfiguration cTypeConf = new DefaultConfiguration("type");
            cTypeConf.setAttribute("id", contentType);
            cTypesConf.addChild(cTypeConf);
        }
        
        if (baseContentTypeIds != null)
        {
            for (String baseContentTypeId : baseContentTypeIds)
            {
                DefaultConfiguration cTypeConf = new DefaultConfiguration("baseType");
                cTypeConf.setAttribute("id", baseContentTypeId);
                cTypesConf.addChild(cTypeConf);
            }
        }
    }
    
}