/*
 *  Copyright 2010 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.skin;

import java.util.HashMap;
import java.util.Map;

import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.ametys.runtime.i18n.I18nizableText;

/**
 * A zone definition in a template 
 */
public class SkinTemplateZone
{
    /** The type of a primary zone */
    public static final String TYPE_PRIMARY = "primary";
    /** The type of a secondary zone */
    public static final String TYPE_SECONDARY = "secondary";
    
    private static Logger _logger = LoggerFactory.getLogger(SkinTemplateZone.class);

    /** The skin id */
    protected String _skinId;
    /** The template id */
    protected String _templateId;
    /** Template id (e.g. the directory name) */
    protected String _id;
    /** Zone type (primary or secondary) */
    protected String _type;
    /** Zone label */
    protected I18nizableText _label;
    /** Zone description */
    protected I18nizableText _description;
    /** Zone thumbnail 16px */
    protected String _smallImage;
    /** Zone thumbnail 32px */
    protected String _mediumImage;
    /** Zone thumbnail 48px */
    protected String _largeImage;
    /** The zone inheritance description. The key is the name of a template and the value is the name of the zone in that template. This means that this zone will inherit the zone given as value in the parent page if it uses the template given as key */
    protected Map<String, String> _inheritance;
    
    /**
     * Create a zone
     * @param skinId The id of the skin owning the template owning the zone
     * @param templateId The id of the template owning the zone
     * @param id The id of the zone
     * @param type The zone type between primary and secondary.
     * @param label The label of the zone
     * @param description The description of the zone
     * @param smallImage The small image to represent the zone
     * @param mediumImage The medium image to represent the zone
     * @param largeImage The large image to represent the zone
     * @param inheritanceString The inheritance scheme following the pattern "TemplateName-&gt;,ZoneNameInThatTemplate,..." where TemplateName can be "*" or "". A completely empty string is equals to "*-&gt;CurrentZoneName". A blank string after the arrow means "no inheritance for this template".
     */
    public SkinTemplateZone(String skinId, String templateId, String id, String type, I18nizableText label, I18nizableText description, String smallImage, String mediumImage, String largeImage, String inheritanceString)
    {
        _skinId = skinId;
        _templateId = templateId;
        _id = id;
        _type = type;
        _label = label;
        _description = description;
        _smallImage = smallImage;
        _mediumImage = mediumImage;
        _largeImage = largeImage;
        _inheritance = _parseInheritance(inheritanceString);
    }
    
    /**
     * Parse the inheritance argument for the constructor
     * @param inheritanceString the representation of the zone inheritance for the templates
     * @return the inheritance mapping between templates and zones
     */
    private Map<String, String> _parseInheritance(String inheritanceString)
    {
        if (inheritanceString == null)
        {
            return null;
        }

        Map<String, String> inheritance = new HashMap<>();
        if (StringUtils.isEmpty(inheritanceString))
        {
            inheritance.put(null, _id);
        }
        else
        {
            String[] inheritenaceParts = inheritanceString.split("[, ]");
            for (String inheritenacePart : inheritenaceParts)
            {
                if (StringUtils.isNotEmpty(inheritenacePart))
                {
                    String templateName = null;
                    String zoneName = "";

                    int i = inheritenacePart.indexOf("->");
                    if (i == -1)
                    {
                        zoneName = inheritenacePart.trim();
                    }
                    else
                    {
                        templateName = inheritenacePart.substring(0, i).trim();
                        if ("*".equals(templateName))
                        {
                            templateName = null;
                        }
                        
                        zoneName = inheritenacePart.substring(i + 2).trim();
                        if (StringUtils.isEmpty(zoneName))
                        {
                            zoneName = null;
                        }
                    }

                    if (inheritance.get(templateName) != null)
                    {
                        _logger.warn("In the skin '" + _skinId 
                                    + "', the template '" + _templateId 
                                    + "' defines the zone '" + _id 
                                    + "' which has a problem with its inheritance. It is declared as '" 
                                    + inheritanceString + "', but this declares twice the same template (" 
                                    + (templateName != null ? templateName : "*") 
                                    + "). The first declaration is kept intact.");
                    }
                    else
                    {
                        inheritance.put(templateName, zoneName);
                    }
                }
            }
        }
        
        return inheritance;
    }

    /**
     * The template id
     * @return the id
     */
    public String getId()
    {
        return _id;
    }
    
    /**
     * The template label
     * @return The label
     */
    public I18nizableText getLabel()
    {
        return _label;
    }
    /**
     * The template description
     * @return The description. Can not be null but can be empty
     */
    public I18nizableText getDescription()
    {
        return _description;
    }
    
    /**
     * The small image file uri
     * @return The small image file uri
     */
    public String getSmallImage()
    {
        return _smallImage;
    }

    /**
     * The medium image file uri
     * @return The medium image file uri
     */
    public String getMediumImage()
    {
        return _mediumImage;
    }
    
    /**
     * The large image file uri
     * @return The large image file uri
     */
    public String getLargeImage()
    {
        return _largeImage;
    }
    
    /**
     * Determine if this zone inherits another one
     * @return true if a inheritance is declared.
     */
    public boolean hasInheritance()
    {
        return _inheritance != null;
    }
    
    /**
     * Get the zone type (primary or secondary)
     * @return the type
     */
    public String getType()
    {
        return _type;
    }
    
    /**
     * Get the name of the zone to inherit in the given template
     * @param templateName The name of the template. Cannot be empty, null or a joker.
     * @return The name of a zone in that template, or null is not applicable for this template.
     */
    public String getInheritance(String templateName)
    {
        if (hasInheritance())
        {
            if (_inheritance.containsKey(templateName))
            {
                return _inheritance.get(templateName);
            }
            else
            {
                return _inheritance.get(null);
            }
        }
        else
        {
            return null;
        }
    }
}