/*
 * [Embellishment.java]
 *
 * Summary: Enumeration of the various icons used to decorate items in a glossary. Not a macro.
 *
 * Copyright: (c) 2003-2017 Roedy Green, Canadian Mind Products, http://mindprod.com
 *
 * Licence: This software may be copied and used freely for any purpose but military.
 *          http://mindprod.com/contact/nonmil.html
 *
 * Requires: JDK 1.8+
 *
 * Created with: JetBrains IntelliJ IDEA IDE http://www.jetbrains.com/idea/
 *
 * Version History:
 *  1.1 2009-03-21 dynamically detect image sizes at load time rather than manually specifying.
 *  1.2 2014-04-01 add altMarker to handle HTML5 alternate marker.
 */
package com.mindprod.htmlmacros.support;

import com.mindprod.common18.EIO;
import com.mindprod.common18.ImageInfo;
import com.mindprod.common18.ST;
import com.mindprod.csv.CSVReader;
import com.mindprod.fastcat.FastCat;
import com.mindprod.hunkio.HunkIO;

import java.io.EOFException;
import java.io.File;
import java.io.IOException;
import java.util.Collections;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;

import static com.mindprod.common18.ST.squish;
import static com.mindprod.htmlmacros.macro.Global.configuration;
import static java.lang.System.*;

/**
 * Enumeration of the various icons used to decorate items in a glossary. Not a macro.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 1.2 2014-04-01 add altMarker to handle HTML5 alternate marker.
 * @see com.mindprod.htmlmacros.ValidateEmbellishments
 * @since 2003-06-14
 */
@SuppressWarnings( { "UnusedDeclaration" } )
public enum Embellishment
    {
        // If you add new letters, there must be corresponding new
        // styles table.glossindex tr td a.ind? in mindprod.css, and icons image/ind/ind?.png
        // letter, name (for alt), width, height
        // Also add to list of legal embellishment letters below.
        // embellishments are used in HTMLMacros to add warning text about prices and listings
        // at the top of the page and in building indexes.
        AWT( 'A', "awt", null, null, null ) /* pentagon, info about awt coding, not Applet to run */,
        COLLECTION( 'C', "collection"/* grey butterfly */, null, null, null ),
        DEFUNCT( 'D', "defunct"/* turned turtle */, "defunct.html", null, null ),
        ESSAY( 'E', "essay", null, null, null ) /* pencil */,
        HUGE( 'H', "huge"/* elephant */, null, null, null ),
        /* coffee bean, also for Applet, JDisplay, CurrCorn requires Java to view */
        JAVA( 'J', "java", "needsjava.html", "<!-- macro CMPApplet", null ),
        /* requires JDisplay to view Listing, just big ones rendered with Applet */
        LISTING( 'L', "listing", "needsjdisplay.html",
                /* html4, html5 */
                "<applet code=\"com.mindprod.jdisplay.JDisplay\"", "<param name=\"code\" value=\"com.mindprod.jdisplay.JDisplay\">" ),
        ONION( 'O', "onion", null, null, null ),
        PRICE( 'P', "price"/* contains CurrCon prices */, "needscurrcon.html", "<applet code=\"com.mindprod.jdisplay.CurrCon", "<param name=\"code\" value=\"com.mindprod.currcon.CurrCon\">" ),
        QUOTATION( 'Q', "quotation", null, "<!-- macro Quotation", null ), // contains a random changing quotation
        RECOMMENDED( 'R', "recommended"/* strawberry */, null, null, null ),
        SEE( 'X', "see"/* a redirect */, null, null, null ),
        SWING( 'S', "swing"/* tire swing */, null, null, null ),
        TIRED( 'T', "tired" /* brontosaurus */, null, null, null ),
        WEBSTART( 'W', "webstart", "needswebstart.html", "<!-- macro Button launch", null ),
        HYBRID( 'Y', "hybrid", "ishybrid.html", "above Applet hybrid", null );

    public static final String EMBELLISHMENT_CSV = "embellishment/embellishment.csv";

    /**
     * lookup embellishment letters by filename< webroot relative with .html chopped. names use / not \.
     */
    static HashMap<String, String> lookupEmbellishmentLettersByFilename;

    /**
     * letter codes allowed in Embellishment coding. Order is not significant.    upper case
     */
    private static String legalEmbellishmentLetters;

    /**
     * enums that have an addendum
     */
    private static Set<Embellishment> embellishmentsWithAddendum;

    /**
     * enums that have a marker
     */
    private static Set<Embellishment> embellishmentsWithMarker;

    /**
     * true if want extra debug output
     */
    private static boolean DEBUGGING = false;

    private static File webroot;

    /**
     * contents of addendum embellishment file.
     */
    private final String addendumContents;

    /**
     * human name for this embellishment, not used as CSS class. Used in <img alt.
     */
    private final String name;
    /**
     * relative to webroot\embellishments file where text of addendum for embellishment e.g. "needscurrcon.html"
     */
    /**
     * single letter used in embellishment files for this embellishment. Upper case
     */
    private final char letter;

    /**
     * Height of the icon in pixels.
     */
    private final int height;

    /**
     * width of the icon in pixels.
     */
    private final int width;

    /**
     * indicator that a document should get this embellishment
     */
    private final String marker;

    /**
     * alternate indicator that a document should get this embellishment
     */
    private final String altMarker;

    /**
     * constructor.
     *
     * @param letter       single code letter associated with this embellishment. Used in embellishment csv files.
     * @param name         human or the embellishment, also the name of the CSS class.
     * @param addendumFile relative to webroot\embellishments file where text of addendum for embellishment e.g.
     *                     "needscurrcon.html"
     * @param marker       string indicating this document needs a particular embellishment, e.g. html4
     * @param altMarker    alternate string indicating this document needs this particular embellishment, e.g. html5
     */
    @SuppressWarnings( { "WeakerAccess" } )
    Embellishment( char letter, String name, final String addendumFile, final String marker, final String altMarker )
        {
        this.letter = Character.toUpperCase( letter );
        this.name = name;
        // screwy Java rules block us from using static webroot.
        final File root = new File( configuration.getLocalWebrootWithSlashes() );
        try
            {
            this.addendumContents = ( addendumFile == null ) ? null : HunkIO.readEntireFile( new File( root,
                    "embellishment/" + addendumFile ), HunkIO.UTF8 );
            }
        catch ( IOException e )
            {
            throw new IllegalArgumentException( e.getMessage() );
            }
        this.marker = marker;
        this.altMarker = altMarker;
        // we don't use htmlmacros.BuildImage since it would bring in too much baggage.
        int[] dim = ImageInfo.getImageDimensions( configuration.getLocalWebrootWithSlashes()
                                                  + "/image/ind/"
                                                  + Character.toLowerCase( letter )
                                                  + ".png" );
        this.width = dim[ 0 ];
        this.height = dim[ 1 ];
        }

    /**
     * Get Embellishment enum constant corresponding to a given letter.
     *
     * @param letter lower or upper case e h j l r s t
     *
     * @return corresponding enum or null if no match.
     */
    static Embellishment getEmbellishmentEnumForLetter( char letter )
        {
        letter = Character.toUpperCase( letter );
        for ( Embellishment candidate : Embellishment.values() )
            {
            if ( candidate.letter == letter )
                {
                return candidate;
                }
            }
        return null;
        }

    /**
     * Does string consist only of legal embellishment code letters?
     *
     * @param candidate string of letters to test.
     *
     * @return true all letters ok.
     */
    static boolean isLegal( String candidate )
        {
        return ST.isLegal( candidate.toUpperCase(), legalEmbellishmentLetters );
        }

    /**
     * Reads list of files that have embellishments from a CSV-formatted stream.
     */
    private static void loadEmbellishmentsForIndividualFiles()
        {
        try
            {
            final File embellishmentcsv = new File( webroot, EMBELLISHMENT_CSV );
            final int initialCapacity = ( int ) ( embellishmentcsv.length() / 41.9f * 1.3f );
            lookupEmbellishmentLettersByFilename = new HashMap<>( initialCapacity );
            // where files that whose embellishments are.
            /// entire file is only 38K
            final CSVReader t = new CSVReader( EIO.getBufferedReader( embellishmentcsv, 32 * 1024, EIO.UTF8 ) );
            try
                {
                while ( true )
                    {
                    try
                        {
                        // read filename and embellishment letters.
                        String filename = t.get();
                        // store internally with slash, not backslash
                        // get the embellishment letters
                        String embellishmentLettersForFile = t.get();
                        // check out the filename
                        if ( filename == null || filename.length() == 0 )
                            {
                            throw new IllegalArgumentException(
                                    "void file name in embellishment file." );
                            }
                        filename = filename.toLowerCase().replace( '\\', '/' );
                        if ( !new File( webroot, filename ).exists() )
                            {
                            throw new IllegalArgumentException(
                                    "no such file to embellish " + filename );
                            }
                        // chop off .html
                        final String filenameBase =
                                filename.substring( 0, filename.length() - 5 )
                                        .intern();
                        // check out the embellishment letters.
                        if ( embellishmentLettersForFile == null
                             || embellishmentLettersForFile.length() == 0 )
                            {
                            throw new IllegalArgumentException(
                                    "void embellishment letters on file "
                                    + filename
                            );
                            }
                        embellishmentLettersForFile = squish( embellishmentLettersForFile.toUpperCase() );
                        // check that all legal letters.
                        if ( Embellishment.isLegal( embellishmentLettersForFile ) )
                            {
                            // There will be only a few common patterns, and we will be
                            // holding
                            // onto these string till the end.
                            embellishmentLettersForFile = embellishmentLettersForFile.intern();
                            // have file=letters pair.
                            final Object old =
                                    lookupEmbellishmentLettersByFilename.put(
                                            filenameBase,
                                            embellishmentLettersForFile );
                            if ( old != null )
                                {
                                throw new IllegalArgumentException( "duplicate entry for "
                                                                    + filename );
                                }
                            }
                        else
                            {
                            throw new IllegalArgumentException(
                                    "illegal embellishment letters on "
                                    + filename
                                    + " "
                                    + embellishmentLettersForFile
                            );
                            }
                        }
                    catch ( IllegalArgumentException e )
                        {
                        err.println( "embellishment error: " + e.getMessage() );
                        }
                    t.skipToNextLine();
                    } // end while
                }
            catch ( EOFException e )
                {
                t.close();
                }
            if ( configuration.isVerbose() )
                {
                out.println( initialCapacity
                             + " initial capacity with "
                             + lookupEmbellishmentLettersByFilename.size()
                             + " embellishments loaded from "
                             + EIO.getCanOrAbsPath( embellishmentcsv ) );
                }
            }
        catch ( IOException e )
            {
            err.println();
            e.printStackTrace( err );
            err.println( "problems reading the list of files that need embellishment." );
            err.println();
            }
        }

    /**
     * display debugging list of file/embellishments pairs
     */
    private static void showEmbellishments()
        {
        for ( Map.Entry<String, String> e : lookupEmbellishmentLettersByFilename.entrySet() )
            {
            out.println( e.getKey() + ",  " + e.getValue() );
            }
        }

    /**
     * Get html to link to the icon for this embellishment.
     *
     * @return &lt;img ... / &gt;
     */
    String buildIconRef()
        {
        final FastCat sb = new FastCat( 12 );
        sb.append( "<img src=\"../image/ind/" );
        sb.append( Character.toLowerCase( this.letter ) );
        sb.append( ".png\" width=\"" );
        sb.append( this.width );
        sb.append( "\" height=\"" );
        sb.append( this.height );
        sb.append( "\" alt=\"" );
        sb.append( this.name );
        sb.append( "\">" );
        return sb.toString();
        }

    /**
     * Get css class corresponding to this embellishment.
     *
     * @return e.g. indh.
     */
    String getCSSClass()
        {
        return "ind" + Character.toLowerCase( this.letter );
        }

    /**
     * Get extra HTML to embellish at hop of file itself.
     *
     * @param fileBeingDistributed e.g. affiliate.html index entry we are embellishing with added HTML.
     *
     * @return embellishment for that file, extra HTML to follow the entry.. "" for none
     */
    public static String buildEmbellishmentAddendumForHeader( File fileBeingDistributed )
        {
        // chop off trailing .html
        final String filenameBase = ST.chopTrailingString( Tools.uPathName(
                fileBeingDistributed ),
                ".html"
        );
        final String embellishmentLetters = lookupEmbellishmentLettersByFilename.get( filenameBase );
        // only files needing embellishment will be in the HashMap
        if ( embellishmentLetters == null || embellishmentLetters.length() == 0 )
            {
            return "";
            }
        final int length = embellishmentLetters.length();
        final FastCat sb = new FastCat( length );
        for ( int i = 0; i < length; i++ )
            {
            final Embellishment e = Embellishment.getEmbellishmentEnumForLetter( embellishmentLetters.charAt( i ) );
            if ( e == null )
                {
                throw new IllegalArgumentException( "illegal embellishment letter on " + fileBeingDistributed );
                }
            else
                {
                // caller will expand any macros in String
                if ( e.addendumContents != null )
                    {
                    sb.append( e.addendumContents );
                    }
                }
            } // end for
        return sb.toString();
        }

    /**
     * Get HTML to handle a single embellishment by using a CSS class. Where there are no embellishments, or more than
     * one, this method will return "".
     *
     * @param fileBeingDistributed e.g. file we are  are embellishing .
     *
     * @return embellishment for that file, extra HTML to follow the entry. e.g. _class="essay" or ""
     */
    public static String buildEmbellishmentCSSForIndex( File fileBeingDistributed )
        {
        // chop off trailing .html
        final String filenameBase = ST.chopTrailingString( Tools.uPathName(
                fileBeingDistributed ),
                ".html"
        );
        final String embellishmentLetters = lookupEmbellishmentLettersByFilename
                .get( filenameBase );
        if ( embellishmentLetters == null
             || embellishmentLetters.length() != 1 )
            {
            return "";// buildMultipleEmbellishments will handle it
            }
        final Embellishment e = Embellishment.getEmbellishmentEnumForLetter( embellishmentLetters.charAt( 0 ) );
        if ( e == null )
            {
            throw new IllegalArgumentException( "illegal embellishment letter on "
                                                + fileBeingDistributed );
            }
        else
            {
            final FastCat sb = new FastCat( 3 );
            sb.append( " class=\"" );
            sb.append( e.getCSSClass() );
            sb.append( "\"" );
            return sb.toString();
            }
        }

    /**
     * Get extra HTML to embellish an index
     * entry. List of files and embellishments they need is com/mindprod/qf/jglossembellishment.csv records of form:
     * J,affiliate.html where can have multiple letter codes for embellishment. J = needs Java.
     *
     * @param fileBeingDistributed file we wish to embellish
     *
     * @return embellishment for that file, extra HTML to follow the entry.. "" for none
     */
    public static String buildEmbellishmentIconsForIndex( File fileBeingDistributed )
        {
        // chop off trailing .html
        final String filenameBase = ST.chopTrailingString( Tools.uPathName(
                fileBeingDistributed ),
                ".html"
        );
        String embellishmentLetters = lookupEmbellishmentLettersByFilename.get( filenameBase );
        // only files needing embellishment will be in the HashMap
        if ( embellishmentLetters == null || embellishmentLetters.length() < 2 )
            {
            return "";  // only handle 2 or mere
            }
        final int length = embellishmentLetters.length();
        final FastCat sb = new FastCat( length * 2 + 2 );
        sb.append( "<span class=\"indimages\">" );
        for ( int i = 0; i < length; i++ )
            {
            final Embellishment e =
                    Embellishment.getEmbellishmentEnumForLetter( embellishmentLetters.charAt( i ) );
            if ( e == null )
                {
                throw new IllegalArgumentException( "illegal embellishment letter on "
                                                    + fileBeingDistributed );
                }
            else
                {
                // space between, and no wrap will be provided by css style
                sb.append( e.buildIconRef() );
                sb.append( " " );
                }
            } // end for
        sb.drop();
        sb.append( "</span>" );
        return sb.toString();
        }

    public static void fireup()
        {
        webroot = new File( configuration.getLocalWebrootWithSlashes() );
        {
        EnumSet<Embellishment> build = EnumSet.noneOf( Embellishment.class );
        for ( Embellishment e : Embellishment.values() )
            {
            if ( e.addendumContents != null )
                {
                build.add( e );
                }
            }
        embellishmentsWithAddendum = Collections.unmodifiableSet( build );
        }
        {
        EnumSet<Embellishment> build = EnumSet.noneOf( Embellishment.class );
        for ( Embellishment e : Embellishment.values() )
            {
            if ( e.marker != null )
                {
                build.add( e );
                }
            }
        embellishmentsWithMarker = Collections.unmodifiableSet( build );
        }
        {
        // for letter by letter StringBuilder is better than FastCat
        final StringBuilder sb = new StringBuilder( Embellishment.values().length );
        for ( Embellishment e : Embellishment.values() )
            {
            sb.append( e.letter );
            }
        legalEmbellishmentLetters = sb.toString();
        }
        loadEmbellishmentsForIndividualFiles();
        }

    /**
     * is this file already mark to be embellished with this letter?
     *
     * @param fileBeingDistributed file to test
     *
     * @return true if file is already marked embellished with this letter
     */
    public static String getEmbellishmentLettersForFile( File fileBeingDistributed )
        {
        // chop off trailing .html
        final String filenameBase = ST.chopTrailingString( Tools.uPathName(
                fileBeingDistributed ),
                ".html"
        );
        // uppercase
        final String embellishmentLetters = lookupEmbellishmentLettersByFilename.get( filenameBase );
        if ( embellishmentLetters == null || embellishmentLetters.length() == 0 )
            {
            return "";
            }
        else
            {
            return embellishmentLetters;
            }
        }

    /**
     * those just those enums that have an associated marker, Set of embellishments that can be automatically assigned.
     *
     * @return Set of Embellishment enums.
     */
    public static Set<Embellishment> getEmbellishmentsWithMarker()
        {
        return embellishmentsWithMarker;
        }

    /**
     * indicator that a document should get this embellishment
     *
     * @return string to look for in html text to see if file needs this embellishment.
     */
    public String getAltMarker()
        {
        return altMarker;
        }

    /**
     * get letter associated with this embellishment
     *
     * @return eletter, upper case
     */
    public char getLetter()
        {
        return letter;
        }

    /**
     * indicator that a document should get this embellishment
     *
     * @return string to look for in html text to see if file needs this embellishment.
     */
    public String getMarker()
        {
        return marker;
        }

    /**
     * is this file already marked to be embellished with this letter?
     *
     * @param fileBeingDistributed file to test
     *
     * @return true if file is already marked embellished with this letter
     */
    public boolean isFileEmbellishedWithThisLetter( File fileBeingDistributed )
        {
        // chop off trailing .html
        final String filenameBase = ST.chopTrailingString( Tools.uPathName(
                fileBeingDistributed ),
                ".html"
        );
        final String embellishmentLetters = lookupEmbellishmentLettersByFilename.get( filenameBase );
        return !( embellishmentLetters == null
                  || embellishmentLetters.length() == 0
                  || embellishmentLetters.indexOf( this.letter ) < 0 );
        }
    }