/*
 * [Insert.java]
 *
 * Summary: Implements Insert macro.
 *
 * Copyright: (c) 2012-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.0 2012-02-12 initial version
 */
package com.mindprod.htmlmacros.macro;

import com.mindprod.htmlmacros.Replacer;
import com.mindprod.htmlmacros.support.Tools;
import com.mindprod.hunkio.HunkIO;
import com.mindprod.isbn.ISBNValidate;

import java.io.File;
import java.io.IOException;

import static java.lang.System.*;

/**
 * Implements Insert macro.
 * <p/>
 * Like include, but includes only some of the text in the referenced file.
 * It picks out only the first macro invocation of the named type
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 1.0 2012-02-12 initial version
 * @since 2012-02-12
 */
public final class Insert extends Macro
    {
    /**
     * how to use the macro
     */
    private static final String USAGE = "\nInsert macro needs partno, [title] [price] [published=yyyy-mm-dd]";

    /**
     * guts of Insert expansion, also used by JGlossHead to insert caveat files.
     * Must set up files first.
     *
     * @param product product number e.g. 13-digit ISBN 12-digit DVD upc or 10-char ASIN
     * @param dir     where the file to insert is, webroot relative.
     * @param quiet   true if should display status
     * @param verbose true if want progress log.
     *
     * @return inserted HTML.
     */
    String insertFile( final String product, final String dir, final String pickMacro, final boolean quiet,
                       final boolean verbose )
        {
        File fileToInsert = Tools.toFileFromUPath( dir + "/" + product + ".html" );
        // we do not process title, price or published
        try
            {
            // we are not worrying about \r \n here.   It will be handled later in Replacer.
            final String textToInsert = HunkIO.readEntireFile( fileToInsert );
            final String marker = "<!-- macro " + pickMacro + " ";
            final int start = textToInsert.indexOf( marker );
            if ( start < 0 )
                {
                throw new IllegalArgumentException( "missing " + marker + " in " + fileToInsert );
                }
            int end = textToInsert.indexOf( " -->", start + marker.length() );
            if ( end < 0 )
                {
                throw new IllegalArgumentException( "missing --> in " + fileToInsert );
                }
            end += " -->".length();
            // <!-- .. --
            final String guts = textToInsert.substring( start, end );
            final int maxFastCatSlotsForInsertedFile = Replacer.estimateFastCatSlots( guts );
            final Include delegate = new Include();
            delegate.setFileBeingProcessedAndFileBeingDistributed( fileBeingProcessed, fileBeingDistributed );
            return delegate.includeStringGuts( guts,
                    Tools.uPathName( fileToInsert ),
                    maxFastCatSlotsForInsertedFile,
                    true
                    /* check */,
                    quiet,
                    verbose );
            }
        catch ( IOException e )
            {
            throw new IllegalArgumentException( "error: unable to find file "
                                                + fileToInsert
                                                + " to insert." );
            }
        catch ( Throwable e )
            {
            e.printStackTrace( err );
            throw new IllegalArgumentException( e.getMessage() );
            }
        }

    /**
     * Generate macro expansion for Insert macro
     *
     * @param parms   parsed params for the macro, in this case just "filename" and macroname
     * @param quiet   true if want output suppressed.
     * @param verbose @return expanded macro HTML
     *
     * @return text inserted from some file as result of this macro.
     */
    public final String expandMacro( final String[] parms, final boolean quiet, final boolean verbose )
        {
        if ( !quiet )
            {
            // indicate we handled an Insert macro on the console
            out.print( "I" );
            }
        if ( parms.length < 2 )
            {
            throw new IllegalArgumentException( USAGE );
            }
        final String product = parms[ 0 ];
        // ignore title
        final String dir;
        final String pickMacro;
        switch ( product.length() )
            {
            case 10:
                dir = "electronic";
                pickMacro = "Electronic";
                break;
            case 12:
                dir = "dvd";
                pickMacro = "DVD";
                break;
            case 13:
                ISBNValidate.ensureISBN13Valid( product );
                dir = "book";
                pickMacro = "Book";
                break;
            default:
                throw new IllegalArgumentException( "[product] should be 10, 12 or 13 chars without dashes" );
            }
        return insertFile( product, dir, pickMacro, quiet, verbose );
        }
    }