/*
 * [SortAliases.java]
 *
 * Summary: sorts the various alias comments after a <dt.
 *
 * Copyright: (c) 2014-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 2014-06-10 initial version.
 */
package com.mindprod.sortaliases;

import com.mindprod.commandline.CommandLine;
import com.mindprod.common18.EIO;
import com.mindprod.compactor.Compactor;
import com.mindprod.fastcat.FastCat;
import com.mindprod.filter.AllButFootDirectoriesFilter;
import com.mindprod.filter.ExtensionListFilter;
import com.mindprod.htmlmacros.macro.Global;
import com.mindprod.htmlmacros.support.ConfigurationForMindprod;
import com.mindprod.hunkio.HunkIO;
import com.mindprod.sortcode.SortCode;

import java.io.File;
import java.io.IOException;
import java.util.List;

import static java.lang.System.*;

/**
 * sorts the various alias comments after a <dt.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 1.0 2014-06-10 initial version.
 * @see com.mindprod.seesort.SeeSort
 * @since 2014-06-10
 */
public class SortAliases
    {
    // declarations

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

    /**
     * when program first copyrighted
     */
    private static final int FIRST_COPYRIGHT_YEAR = 2014;

    /**
     * undisplayed copyright notice
     */
    @SuppressWarnings( { "UnusedDeclaration" } )
    private static final String EMBEDDED_COPYRIGHT =
            "Copyright: (c) 2014-2017 Roedy Green, Canadian Mind Products, http://mindprod.com";

    @SuppressWarnings( { "UnusedDeclaration" } )
    private static final String RELEASE_DATE = "2014-06-10";

    /**
     * how to use the command line
     */
    private static final String USAGE = "\nsortaliasesjar [no parms needed]";

    /**
     * embedded version string.
     */
    @SuppressWarnings( { "UnusedDeclaration" } )
    private static final String VERSION_STRING = "1.0";

    /**
     * all the files we will process
     */
    static CommandLine filesToProcess;
    // /declarations
    // methods

    /**
     * Get fully qualified name of all the files to process.
     */
    private static void gatherFiles()
        {
        // just HTML dirs, not the include dirs. Not the KJV dirs.
        final List<String> htmlDirs = Global.configuration.getDirsContainingHTMLMacros();
        final String[] args = new String[ htmlDirs.size() + 1 ];
        args[ 0 ] = "-q";
        int i = 1;
        final String localWebrootDir = Global.configuration.getLocalWebrootWithBackslashes();
        for ( String aDir : htmlDirs )
            {
            args[ i++ ] = localWebrootDir + "\\" + aDir;
            }
        filesToProcess = new CommandLine( args, new AllButFootDirectoriesFilter(), new ExtensionListFilter( ExtensionListFilter.COMMON_HTML_EXTENSIONS ) );
        }// /method

    /**
     * debugging tool to display long strings
     *
     * @param s the string.
     */
    private static void showAbbreviated( String s )
        {
        if ( DEBUGGING )
            {
            out.println( "length:" + s.length() );
            if ( s.length() > 600 )
                {
                out.println( s.substring( 0, 300 ) );
                out.println( "    ..." );
                out.println( "    " + s.substring( s.length() - 300 ) );
                }
            else
                {
                out.println( s );
                }
            }
        }// /method

    /**
     * sort the various alias comments in the <dt>...</dt>
     */
    private static void sortAliasesInOneFile( File fileBeingProcessed ) throws IOException
        {
        final String original = HunkIO.readEntireFile( fileBeingProcessed, HunkIO.UTF8 );
        final int dtPlace = original.indexOf( "<dt id=" );
        if ( dtPlace < 0 )
            {
            return;
            }
        final int slashDtPlace = original.indexOf( "</dt>", dtPlace );
        if ( slashDtPlace < 0 )
            {
            return;
            }
        final String fatBand = original.substring( dtPlace, slashDtPlace );
        final int firstAlias = fatBand.indexOf( "<!-- alias" );
        final int firstCross = fatBand.indexOf( "<!-- cross" );
        // ignore lead <!-- macro Image
        final int first;
        if ( firstAlias < 0 && firstCross < 0 )
            {
            return;
            }
        else if ( firstAlias < 0 )
            {
            first = firstCross;
            }
        else if ( firstCross < 0 )
            {
            first = firstAlias;
            }
        else
            {
            first = Math.min( firstAlias, firstCross );
            }
        final int last = fatBand.lastIndexOf( " -->" );
        if ( last < 0 )
            {
            err.println( "unstructured dt comments in " + EIO.getCanOrAbsPath( fileBeingProcessed ) );
            return;
            }
        final String sortableBand = fatBand.substring( first, last + 4 );
        if ( DEBUGGING )
            {
            out.println( EIO.getCanOrAbsPath( fileBeingProcessed ) + " : " + sortableBand );
            }
        final String sorted = SortCode.sortContents( sortableBand,
                null /* startMarker */,
                " -->" /* marker */,
                null /* endMarker */,
                null /* string comparator */,
                "case-sensitive",
                "<dt comments in " + EIO.getCanOrAbsPath( fileBeingProcessed ),
                false /* not verbose */ );
        if ( sorted != null && !sorted.equals( sortableBand ) )
            {
            // we need to replace the sortableBand and and write the whole file back out.
            final String head = original.substring( 0, dtPlace + first );
            final String tail = original.substring( slashDtPlace - ( fatBand.length() - ( last + 4 ) ) );
            if ( DEBUGGING )
                {
                out.println( " H E A D " );
                showAbbreviated( head );
                out.println( "G U T S" );
                showAbbreviated( sorted );
                out.println( " T A I L " );
                showAbbreviated( tail );
                }
            final FastCat sb = new FastCat( 3 );
            sb.append( head );
            sb.append( sorted );
            sb.append( tail );
            final String compacted = Compactor.compactStringAsNeeded( sb.toString(),
                    fileBeingProcessed.getPath(),
                    Global.configuration.getCompacting() );
            if ( !compacted.equals( original ) )
                {
                HunkIO.writeEntireFile( fileBeingProcessed, compacted, HunkIO.UTF8 );
                }
            }
        }// /method

    /**
     * sort aliases in all the mindprod files
     *
     * @param args not used
     *
     * @throws IOException
     */
    public static void main( String[] args ) throws IOException
        {
        Global.installConfiguration( new ConfigurationForMindprod() );
        // sortAliasesInOneFile( new File( "E:/mindprod/jgloss/addition.html" ) );
        gatherFiles();
        for ( File fileBeingProcessed : filesToProcess )
            {
            sortAliasesInOneFile( fileBeingProcessed );
            }
        }// /method
    // /methods
    }