/*
 *  Copyright 2013 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.content;

import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.ametys.cms.contenttype.MetadataDefinition;
import org.ametys.plugins.repository.metadata.ModifiableRichText;
import org.ametys.runtime.i18n.I18nizableText;

/**
 * The report object, used internally to provide useful informations once
 * the whole duplication process has ended.
 */
public final class CopyReport
{
    /** Name of the metadata set associated to this report */
    protected final String _metadataSetName;
    /** Type of the metadata set associated to this report */
    protected final String _metadataSetType;
    /** Identifier of the base content associated to this report */
    protected final String _baseContentId;
    /** Title of the base content associated to this report (can be null if unavailable) */
    protected final String _baseContentTitle;
    /** Indicates if the base content associated to this report is a a entry of a reference table (can be null if unavailable) */
    protected Boolean _baseContentIsReferenceTable;
    
    /** The copy mode used during the copy (creation or edition) */
    protected final CopyMode _mode;
    
    /** Identifier of the target content associated to this report */
    protected String _targetContentId;
    /** title of the target content associated to this report */
    protected String _targetContentTitle;
    /** Indicates if the target content associated to this report is a entry of a reference table */
    protected boolean _targetContentIsReferenceTable;
    
    /** Child reports associated to this report. Each child report denotes an inner copy */
    protected List<CopyReport> _innerReports;
    
    /** List of copied rich text metadata during the duplication process */ 
    protected Map<ModifiableRichText, MetadataDefinition> _copiedRichTexts;
    /**
     * List of paths (relative to the root attachment node of the target
     * content) of the copied attachments during the duplication
     */ 
    protected List<String> _copiedAttachments;
    
    /**
     * List of values (content id or list of content ids) to be set into
     * metadata of type content. Keys are the metadata path
     */
    protected Map<String, Object> _contentReferenceValues;
    
    /** List of info about repeaters to be used to perform the edition of content metadata */
    protected Map<String, Integer> _repeatersInfo;
    
    /** List of metadata labels. Each entry in the list denote an error during the copy of this metadata */
    protected List<I18nizableText> _metadataCopyErrors;
    
    /** The state of the copy */
    protected CopyState _state;
    
    /** Available copy mode */
    public enum CopyMode
    {
        /** Creation : a new content is created to perform the copy */
        CREATION,
        /** Edition : metadata are duplication into an already existing target content */
        EDITION
    }
    
    /** The possible state of the copy */
    public enum CopyState
    {
        /** Running : when the copy is still running */
        RUNNING,
        /** Success : when the copy has ended well */
        SUCCESS,
        /** Error : when an error was encountered during the copy (except for metadata copy errors). */
        ERROR
    }
    
    /**
     * Constructor.
     * If the title of the base content if available, should be used.
     * @param baseContentId The content id of the base content
     * @param baseContentIsRefTable Indicates if the base content is a reference table's entry (can be null if unavailable)
     * @param metadataSetName The metadata set name
     * @param metadataSetType The metadata set type (edit or view)
     * @param copyMode The mode of copy
     */
    public CopyReport(String baseContentId, Boolean baseContentIsRefTable, String metadataSetName, String metadataSetType, CopyMode copyMode)
    {
        this(baseContentId, null, baseContentIsRefTable, metadataSetName, metadataSetType, copyMode);
    }
    
    /**
     * Constructor.
     * @param baseContentId The content id of the base content
     * @param baseContentTitle The title of the base content
     * @param baseContentIsRefTable Indicates if the base content is a reference table's entry
     * @param metadataSetName The metadata set name
     * @param metadataSetType The metadata set type (edit or view)
     * @param copyMode The mode of copy
     */
    public CopyReport(String baseContentId, String baseContentTitle, Boolean baseContentIsRefTable, String metadataSetName, String metadataSetType, CopyMode copyMode)
    {
        _baseContentId = baseContentId;
        _baseContentTitle = baseContentTitle;
        _baseContentIsReferenceTable = baseContentIsRefTable;
        _metadataSetName = metadataSetName;
        _metadataSetType = metadataSetType;
        _mode = copyMode;
        
        _innerReports = new LinkedList<>();
        _copiedRichTexts = new HashMap<>();
        _copiedAttachments = new LinkedList<>();
        _contentReferenceValues = new HashMap<>();
        _repeatersInfo = new HashMap<>();
        _metadataCopyErrors = new LinkedList<>();
        
        _state = CopyState.RUNNING;
    }
    
    /**
     * Set whether the base content is a reference table's entry.
     * @param isRefTable true for reference table's entry.
     */
    public void setReferenceTable(boolean isRefTable)
    {
        _baseContentIsReferenceTable = isRefTable;
    }
    
    /**
     * Set the target content title.
     * @param title The target content title.
     */
    public void setTargetContentTitle(String title)
    {
        _targetContentTitle = title;
    }
    
    /**
     * Notify information about the target content to the report.
     * @param id The content id
     * @param title The content title
     * @param isRefTable Indicates if the target content is a reference table's entry.
     */
    protected void notifyContentCreation(String id, String title, boolean isRefTable)
    {
        _targetContentId = id;
        _targetContentTitle = title;
        _targetContentIsReferenceTable = isRefTable;
    }
    
    /**
     * Notify a copy success
     */
    protected void notifyContentCopySuccess()
    {
        _state = CopyState.SUCCESS;
    }
    
    /**
     * Notify that the copy ended with an error (except for metadata copy
     * error, where {@link #notifyMetadataCopyError(I18nizableText)} must be
     * used).
     */
    protected void notifyContentCopyError()
    {
        _state = CopyState.ERROR;
    }
    
    /**
     * Notify a metadata copy error.
     * @param label The label of the metadata
     */
    protected void notifyMetadataCopyError(I18nizableText label)
    {
        _metadataCopyErrors.add(label);
    }
    
    /**
     * Add a rich text to the list of copied rich texts.
     * @param richText the rich text
     * @param definition the metadata definition
     */
    protected void addRichText(ModifiableRichText richText, MetadataDefinition definition)
    {
        _copiedRichTexts.put(richText, definition);
    }
    
    /**
     * Get the list of copied rich text metadata.
     * @return List of {@link ModifiableRichText}
     */
    protected Map<ModifiableRichText, MetadataDefinition> getCopiedRichTexts()
    {
        return Collections.unmodifiableMap(_copiedRichTexts);
    }
    
    /**
     * Add an attachments to the copied attachments report list
     * @param relPath The relative path where to copy
     */
    protected void addAttachment(String relPath)
    {
        _copiedAttachments.add(relPath);
    }
    
    /**
     * Should be used to store the values of a content metadata.
     * These values will be used later in the copy process to properly edit content metadata
     * @param metadataPath The path of the metadata to copy
     * @param values The values
     */
    protected void addContentReferenceValues(String metadataPath, Object values)
    {
        _contentReferenceValues.put(metadataPath, values);
    }
    
    /**
     * Get the list content reference values 
     * @return Map representing the content reference values
     */
    protected Map<String, Object> getContentReferenceValuesMap()
    {
        return Collections.unmodifiableMap(_contentReferenceValues);
    }
    
    /**
     * Add repeater info to be able to perform an edition at the of the copy for content metadata
     * @param metadataPath The path of the metadata concerned
     * @param entryCount the entry count
     */
    protected void addRepeaterInfo(String metadataPath, int entryCount)
    {
        _repeatersInfo.put(metadataPath, entryCount);
    }
    
    /**
     * Get the map of info about copied repeaters
     * @return Map holding repeaters info. Each values is the size of a repeater
     */
    protected Map<String, Integer> getRepeatersInfo()
    {
        return Collections.unmodifiableMap(_repeatersInfo);
    }
    
    /*
     * PUBLIC API
     */
    /**
     * Get the status of the copy
     * @return A copy state enum value
     */
    public CopyState getStatus()
    {
        return _state;
    }
    
    /**
     * Get the mode of the copy
     * @return A cope mode enum value
     */
    public CopyMode getMode()
    {
        return _mode;
    }
    
    /**
     * Get the name of the metadataset used for the copy.
     * @return the metadataset name
     */
    public String getMetadataSetName()
    {
        return _metadataSetName;
    }
    
    /**
     * Get the type of the metadataset used for the copy.
     * @return the metadataset name
     */
    public String getMetadataSetType()
    {
        return _metadataSetType;
    }
    
    /**
     * Get the base content identifier
     * @return The identifier
     */
    public String getBaseContentId()
    {
        return _baseContentId;
    }
    
    /**
     * Get the base content title.
     * @return The title or null (if unavailable)
     */
    public String getBaseContentTitle()
    {
        return _baseContentTitle;
    }
    
    /**
     * Is the base content a reference table entry ?
     * @return true if it is, null if unknown.
     */
    public Boolean getBaseContentIsReferenceTable()
    {
        return _baseContentIsReferenceTable;
    }
    
    /**
     * Get the target content identifier
     * @return The identifier
     */
    public String getTargetContentId()
    {
        return _targetContentId;
    }
    
    /**
     * Get the target content title
     * @return The title
     */
    public String getTargetContentTitle()
    {
        return _targetContentTitle;
    }
    
    /**
     * Is the target content a reference table entry?
     * @return true if it is.
     */
    public boolean getTargetContentIsReferenceTable()
    {
        return _targetContentIsReferenceTable;
    }
    
    /**
     * Get the list of child copy reports.
     * Each child report denotes an inner copy
     * @return The list of copy reports.
     */
    public List<CopyReport> getChildReports()
    {
        return Collections.unmodifiableList(_innerReports);
    }
    
    /**
     * Get the list of metadata errors during the copy.
     * @return List of the label of each metadata in error.
     */
    public List<I18nizableText> getMetadataErrors()
    {
        return Collections.unmodifiableList(_metadataCopyErrors);
    }
    
    
    /**
     * Get the list of the copied attachments.
     * @return List of paths (relative to the root attachment node of the target content)
     */
    public List<String> getCopiedAttachments()
    {
        return Collections.unmodifiableList(_copiedAttachments);
    }
    
    /**
     * Add a child report to the report. This must be done when an copy is requested 
     * @param report The report of the copy to add
     */
    public void addReport(CopyReport report)
    {
        _innerReports.add(report);
    }
}