/*
 *  Copyright 2023 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.web.repository.page.virtual;

import java.util.ArrayList;
import java.util.List;
import java.util.Set;

import org.apache.commons.lang3.StringUtils;

import org.ametys.cms.repository.Content;
import org.ametys.plugins.explorer.resources.ResourceCollection;
import org.ametys.plugins.repository.AbstractAmetysObject;
import org.ametys.plugins.repository.AmetysObjectIterable;
import org.ametys.plugins.repository.AmetysRepositoryException;
import org.ametys.plugins.repository.CollectionIterable;
import org.ametys.plugins.repository.data.holder.DataHolder;
import org.ametys.plugins.repository.data.holder.ModelAwareDataHolder;
import org.ametys.plugins.repository.data.holder.impl.DefaultDataHolder;
import org.ametys.plugins.repository.data.repositorydata.RepositoryData;
import org.ametys.plugins.repository.data.repositorydata.impl.MemoryRepositoryData;
import org.ametys.web.repository.page.Page;
import org.ametys.web.repository.page.UnknownZoneException;
import org.ametys.web.repository.page.Zone;
import org.ametys.web.repository.site.Site;
import org.ametys.web.repository.sitemap.Sitemap;
import org.ametys.web.skin.Skin;

/**
 * An abstract configurable virtual page.
 * @param <T> The type of page factory to use
 */
public abstract class AbstractConfigurableVirtualPage<T extends AbstractConfigurableVirtualPageFactory> extends AbstractAmetysObject implements Page 
{
    /** The root page */
    protected Page _root;
    /** The AbstractVirtualPageConfiguration */
    protected VirtualPageConfiguration _configuration;
    /** The ModelItemTypeExtensionPoint for zones */
    /** The page's scheme */
    protected String _scheme;
    /** The factory */
    protected T _factory;
    
    /**
     * The constructor for an abstract configurable virtual page
     * @param root The root page
     * @param configuration The abstract virtual page configuration
     * @param scheme The page's scheme
     * @param factory The page's factory
     */
    public AbstractConfigurableVirtualPage(Page root, VirtualPageConfiguration configuration, String scheme, T factory)
    {
        _root = root;
        _configuration = configuration;
        _factory = factory;
        _scheme = scheme;
    }
    
    @Override
    public ResourceCollection getRootAttachments() throws AmetysRepositoryException
    {
        // Attachments not available on virtual pages
        return null;
    }
    /**
     * Get a zone configuration by its name
     * @param name The zone name
     * @return the VirtualPageZoneConfiguration
     */
    public VirtualZoneConfiguration getZoneConfiguration(String name) 
    {
        return _configuration.getZoneConfiguration(name, _root);
    }
    
    @Override
    public String getTemplate() throws AmetysRepositoryException 
    {
        Skin skin = _factory.getSkinsManager().getSkin(getSite().getSkinId());
        
        String template = _configuration.getTemplate(_root);
        
        if (StringUtils.isNotEmpty(template) && skin.getTemplate(template) != null)
        {
            return template;
        }
        else
        {
            return "page"; 
        }
    }

    @Override
    public boolean hasZone(String name) throws AmetysRepositoryException 
    {
        return _configuration.hasZoneConfiguration(name, _root);
    }

    @Override
    public PageType getType() throws AmetysRepositoryException 
    {
        return PageType.CONTAINER;
    }

    @Override
    public String getURL() throws AmetysRepositoryException 
    {
        throw new UnsupportedOperationException("getURL not supported on virtual pages");
    }

    @Override
    public LinkType getURLType() throws AmetysRepositoryException 
    {
        throw new UnsupportedOperationException("getURLType not supported on virtual pages");
    }

    @Override
    public Set<String> getReferers() throws AmetysRepositoryException 
    {
        throw new UnsupportedOperationException("getReferers not supported on virtual pages");
    }

    @Override
    public Site getSite() throws AmetysRepositoryException
    {
        return _root.getSite();
    }
    
    @Override
    public String getSiteName() throws AmetysRepositoryException
    {
        return _root.getSiteName();
    }

    @Override
    public Sitemap getSitemap() throws AmetysRepositoryException
    {
        return _root.getSitemap();
    }

    @Override
    public String getSitemapName() throws AmetysRepositoryException
    {
        return _root.getSitemapName();
    }
    
    @Override
    public String getPath() throws AmetysRepositoryException
    {
        return getParentPath() + "/" + getName();
    }
    
    @Override
    public Set<String> getTags() throws AmetysRepositoryException
    {
        return Set.of();
    }
    
    @Override
    public boolean isVisible() throws AmetysRepositoryException 
    {
        return true;
    }

    /**
     * Get the page's content
     * @param <C> The content's type
     * @return The content
     */
    public <C extends Content> C getContent() 
    {
        throw new UnsupportedOperationException("This virtual page does not have a content and the overriding configuration requires one.");
    }
    
    @Override
    public Zone getZone(String name) throws UnknownZoneException, AmetysRepositoryException
    {
        return _factory.getZoneFactory().createZone(this, name);
    }

    @Override
    public AmetysObjectIterable< ? extends Zone> getZones() throws AmetysRepositoryException
    {
        List<Zone> zones = new ArrayList<>();
        
        for (VirtualZoneConfiguration zoneConfiguration : _configuration.getZonesConfigurations(_root)) 
        {
            zones.add(getZone(zoneConfiguration.getId()));
        }
        
        return new CollectionIterable<>(zones);
    }
    
    @Override
    public ModelAwareDataHolder getTemplateParametersHolder() throws AmetysRepositoryException
    {
        // Template's parameters not available on virtual pages
        return null;
    }
    
    /**
     * Get the page's scheme
     * @return The scheme of the page
     */
    public String getScheme() 
    {
        return _scheme;
    }
    
    public boolean isIndexable()
    {
        return _root.isIndexable();
    }
    
    @Override
    protected DataHolder getDataHolder()
    {
        RepositoryData repositoryData = new MemoryRepositoryData(getName());
        return new DefaultDataHolder(_factory.getPageDataTypeExtensionPoint(), repositoryData);
    }
}