/*
 * [RepairBornsInBookMacros.java]
 *
 * Summary: Fill in birth/death dates of authors if they don't have them already in macro Book.
 *
 * Copyright: (c) 2011-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 2011-10-17 initial version
 */
package com.mindprod.repair;

import com.mindprod.fastcat.FastCat;

import java.io.File;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import static java.lang.System.*;

/**
 * Fill in birth/death dates of authors if they don't have them already in macro Book.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 1.0 2011-10-17 initial version
 * @since 2011-10-17
 */
class RepairBornsInBookMacros
    {
    /**
     * pattern of quote already handled, used to extract author in " "
     */
    private static final Pattern AUTHOR_PATTERN_IN_BOOK_MACRO1 = Pattern.compile( "author=\"(.+?)\"", Pattern.DOTALL );

    /**
     * pattern of quote already handled, used to extract author in {}
     */
    private static final Pattern AUTHOR_PATTERN_IN_BOOK_MACRO2 = Pattern.compile( "author=\\{(.+?)\\}",
            Pattern.DOTALL );

    /**
     * look for <!-- macro Book/DVD ... -->
     */
    private static final Pattern BOOK_MACRO_PATTERN = Pattern.compile( "(<!\\-\\- macro (?:Book|DVD)\\s+)(.+?)" +
                                                                       "(\\s+\\-\\->)",
            Pattern.DOTALL
    );

    /**
     * pattern of quote already handled, used to extract author
     */
    private static final Pattern MULTI_AUTHOR_SPLIT = Pattern.compile(
            "\\s+and\\s+|\\s+with\\s+|\\s+aka\\s+|,|&amp;|\\(|\\)" );

    /**
     * how many Book/DVD macros we corrected
     */
    static int corrected = 0;

    /**
     * how many Book/DVD macros were  missing birth fields
     */
    static int missing = 0;

    /**
     * Study chuck, return modified <!-- macro Book or unmodified.
     *
     * @param chunk              chunk to adjust
     * @param fileBeingProcessed file where this chunk in embedded.
     *
     * @return modified or unmodified chunk
     */
    private static String repairAuthorBiosBookMacrosForChunk( String chunk, File fileBeingProcessed )
        {
        if ( !chunk.contains( "birth=" ) )
            {
            //  not yet done.
            final Matcher a1 = AUTHOR_PATTERN_IN_BOOK_MACRO1.matcher( chunk );
            final Matcher a2 = AUTHOR_PATTERN_IN_BOOK_MACRO2.matcher( chunk );
            final boolean founda1 = a1.find();
            final boolean founda2 = a2.find();
            if ( founda1 || founda2 )
                {
                final Matcher a = founda1 ? a1 : a2;
                final String allAuthors = a.group( 1 );
                final String[] individualAuthors = MULTI_AUTHOR_SPLIT.split( allAuthors );
                final String author = individualAuthors.length >= 1 ? individualAuthors[ 0 ].trim() : "";
                final int start = a.start();
                final int end = a.end();
                if ( AuthorBio.containsKey( author ) )
                    {
                    final AuthorBio authorBio = AuthorBio.get( author );
                    final String birth = authorBio.getBirthdate();
                    final String death = authorBio.getDeathdate();
                    out.println( ( CollectAndRepairBorns.doCorrections ? "Correcting" : "Dry run correcting" ) +
                                 " Book/DVD: " + fileBeingProcessed.toString() + " " + author + ( author.equals(
                            allAuthors ) ? "" : "\n >> [" + allAuthors + "]" ) );
                    corrected++;
                    final FastCat sb = new FastCat( 11 );
                    sb.append( chunk.substring( 0, start ) );
                    sb.append( "author=\"" );
                    sb.append( allAuthors );
                    sb.append( "\" birth=\"" );
                    sb.append( birth );
                    sb.append( "\"" );
                    if ( death.length() > 0 )
                        {
                        sb.append( " death=\"" );
                        sb.append( death );
                        sb.append( "\" " );
                        }
                    sb.append( chunk.substring( end ) );
                    return sb.toString();
                    }
                else
                    {
                    out.println( "macro Book " + fileBeingProcessed.toString() + " book author without birth info " +
                                 author + ( author.equals(
                            allAuthors ) ? "" : "\n >> [" + allAuthors + "]" ) );
                    missing++;
                    }
                }
            else
                {
                err.println( "Error: " + fileBeingProcessed.toString() + " can't find author= in " + chunk + "\n\n" );
                missing++;
                }
            }
        return chunk;
        }

    /**
     * add birth date info to all Book macro authors on page without them
     *
     * @param originalPage       page before patching
     * @param fileBeingProcessed file we are repairing
     *
     * @return page after patching
     */
    static String repairBornsInBookMacrosForPage( final String originalPage, File fileBeingProcessed )
        {
        final Matcher m = BOOK_MACRO_PATTERN.matcher( originalPage );
        // where we collect the replacement. Must be a StringBuffer, not a StringBuilder. Regex has a legacy problem.
        final StringBuffer sb = new StringBuffer( originalPage.length() + 100 );
        while ( m.find() )
            {
            final String replacement = m.group( 1 ) + repairAuthorBiosBookMacrosForChunk( m.group( 2 ),
                    fileBeingProcessed ) + m.group( 3 );
            m.appendReplacement( sb, Matcher.quoteReplacement( replacement ) ); // also appends junk between hits.
            }
        m.appendTail( sb );
        return sb.toString();
        }
    // no main, called by CollectAndRepairBorns.java
    }