/*
 * [CoFoot.java]
 *
 * Summary: Generate the footer for Cherokee Obama page.
 *
 * Copyright: (c) 2009-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.8 2009-02-06 include go package in ZIP bundle.
 */
package com.mindprod.htmlmacros.macro;

import com.mindprod.fastcat.FastCat;
import com.mindprod.htmlmacros.support.BuildImage;
import com.mindprod.htmlmacros.support.ImageAlignment;
import com.mindprod.htmlmacros.support.Tools;

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

/**
 * Generate the footer for Cherokee Obama page.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 1.0 2010-01-23 initial cloned from Foot.
 * @since 2010-01-23
 */
public final class CoFoot extends Macro
    {
    /**
     * text to describe user's face IP
     */
    private static final String FACE_IP = "Your face IP:[<span class=\"ip\"><!--#echo var=\"REMOTE_ADDR\"--></span>]";

    /**
     * Usual HTML for an href.
     */
    private static final String PLAIN_HREF = "<a class=\"plain\" href=";

    /**
     * text to describe mindprod.com domain an ip
     */
    private static final String SITE_NAME_AND_IP = "<span class=\"domain\">"
                                                   + configuration.getWebsiteDomain()
                                                   + "</span> IP:[<span class=\"ip\">"
                                                   + configuration.getWebsiteIP()
                                                   + "</span>]";

    /**
     * suffix for a tag
     */
    private static final String TAG_TAIL = configuration.getTagTail();

    /**
     * how to use the macro
     */
    private static final String USAGE = "\nCoFoot macro takes no parameters";

    /**
     * Build button to get to home page
     *
     * @param homeLink link to home page
     *
     * @return HTML expansion
     */
    private String buildHomeButton( final String homeLink )
        {
        final FastCat sb = new FastCat( 6 );
        sb.append( PLAIN_HREF );
        sb.append( "\"" );
        sb.append( homeLink );
        sb.append( "\">" );
        sb.append( BuildImage.buildImgTag( "navigate/home.png",
                "home",
                ImageAlignment.middle,
                null,
                fileBeingDistributed ) );
        sb.append( "</a>" );
        return sb.toString();
        }

    /**
     * Build  logo
     *
     * @param homeLink link to home page
     *
     * @return HTML expansion
     */
    private String buildLogoImage( final String homeLink )
        {
        final FastCat sb = new FastCat( 6 );
        sb.append( PLAIN_HREF );
        sb.append( "\"" );
        sb.append( homeLink );
        sb.append( "\">" );
        sb.append( BuildImage.buildImgTag( "logo/" + configuration.getCompanyLogo(),
                configuration.getCompanyName(),
                ImageAlignment.middle,
                null,
                fileBeingDistributed ) );
        sb.append( "</a>" );
        return sb.toString();
        }

    /**
     * Build button that links to the next page.
     *
     * @return HTML expansion
     */
    private String buildNextButton()
        {
        // calculate next link based on filename
        final FastCat sb = new FastCat( 6 );
        sb.append( PLAIN_HREF );
        sb.append( "\"" );
        sb.append( configuration.calcNextPage( fileBeingDistributed ) );
        sb.append( "\">" );
        sb.append( BuildImage.buildImgTag( "navigate/next.png",
                "next page",
                ImageAlignment.middle,
                null,
                fileBeingDistributed ) );
        sb.append( "</a>" );
        return sb.toString();
        }

    /**
     * Build Post on blog.
     *
     * @return HTML expansion
     */
    private String buildPostOnBlog()
        {
        final String blogURL = configuration.blogForPage( fileBeingDistributed );
        if ( blogURL.length() == 0 )
            {
            return "";
            }
        final FastCat sb = new FastCat( 10 );
        sb.append( "<span class=\"pleasefeedback\">" );
        sb.append( BuildImage.buildImgTag( "navigate/blogger.png",
                "blogger",
                ImageAlignment.middle,
                "plain",
                fileBeingDistributed ) );
        sb.append( "&nbsp;You may post <strong>public</strong> comments about);" );
        sb.append( configuration.getBr() );
        sb.append( "<cite>Dreaming Gods of Gaia</cite> on the blog at :\n" );
        sb.append( "<a class=\"blogger\" href=\"" );
        sb.append( blogURL );
        sb.append( "\">" );
        sb.append( blogURL );
        sb.append( "</a></span>\n" );
        return sb.toString();
        }

    /**
     * Build button that links to the previous page.
     *
     * @return HTML expansion
     */
    private String buildPrevButton()
        {
        // calculate next link based on filename
        final FastCat sb = new FastCat( 6 );
        sb.append( PLAIN_HREF );
        sb.append( "\"" );
        sb.append( configuration.calcPrevPage( fileBeingDistributed ) );
        sb.append( "\">" );
        sb.append( BuildImage.buildImgTag( "navigate/prev.png",
                "prev page",
                ImageAlignment.middle,
                null,
                fileBeingDistributed ) );
        sb.append( "</a>" );
        return sb.toString();
        }

    /**
     * Build Please give feedback block.
     *
     * @return HTML expansion
     */
    private String buildPrivateFeedback()
        {
        final FastCat sb = new FastCat( 7 );
        sb.append( "<span class=\"pleasefeedback\">" );
        sb.append( BuildImage.buildImgTag( "navigate/feedback.png",
                "feedback",
                ImageAlignment.middle,
                "plain",
                fileBeingDistributed ) );
        sb.append(
                "&nbsp;Please email your <strong>private</strong> feedback, errors, omissions, typos, " +
                "formatting errors, suggestions to improve this novel or comments to\n"
        );
        sb.append( configuration.getAuthor() );
        sb.append( " :\n" );
        sb.append( BuildImage.buildImgTag( "mailto/feedback.png",
                "feedback email",
                null,
                "mailto",
                fileBeingDistributed ) );
        sb.append( "</span>" );
        return sb.toString();
        }

    /**
     * Build button that takes you back to top of page.
     *
     * @return expanded HTML text for button
     */
    private String buildToTopButton()
        {
        final FastCat sb = new FastCat( 4 );
        sb.append( PLAIN_HREF );
        sb.append( "\"#TOP\">" );
        sb.append( BuildImage.buildImgTag( "navigate/totop.png",
                "jump to top",
                ImageAlignment.middle,
                null,
                fileBeingDistributed ) );
        sb.append( "</a>\n" );
        return sb.toString();
        }

    /**
     * guts to Generate the footer for an amanuensis html document.
     *
     * @return expanded footer
     */
    private String expand()
        {
        // At this point have dir without lead or trail /, possibly ""
        if ( configuration.isKindle() )
            {
            return "</body></html>\n";
            }
        else
            {
            final String homeLink = Tools.relativeURL( "index.html", fileBeingDistributed );
            final String privateFeedback = buildPrivateFeedback();
            final String logo = buildLogoImage( homeLink );
            final String postOnBlog = buildPostOnBlog();
            final String homeButton = buildHomeButton( homeLink );
            final String prevButton = buildPrevButton();
            final String nextButton = buildNextButton();
            final String toTopButton = buildToTopButton();
            // finally after preparing so many fragments, we stitch them together.
            final FastCat sb = new FastCat( 28 );
            sb.append( "<hr class=\"foot\"" );
            sb.append( TAG_TAIL );
            sb.append( "\n<table class=\"borderless\"><caption class=\"hidden\">standard footer</caption>\n<tbody>\n" );
            sb.append( "<tr><td style=\"text-align:center;vertical-align:top\" id=\"BOTTOM\">" );
            sb.append( homeButton );
            sb.append( prevButton );
            sb.append( toTopButton );
            sb.append( nextButton );
            sb.append( "</td><td rowspan=\"3\">" );
            sb.append( logo );
            sb.append( "</td><td rowspan=\"2\">" );
            sb.append( privateFeedback );
            sb.append( "</td></tr>\n<tr><td>" );
            sb.append( configuration.getCompanyNameFancyHtml() );
            sb.append( "</td></tr>\n<tr><td>" );
            sb.append( SITE_NAME_AND_IP );
            sb.append( "</td><td rowspan=\"2\">" );
            sb.append( postOnBlog );
            sb.append( "</td></tr><tr><td style=\"vertical-align:top\">" );
            sb.append( FACE_IP );
            sb.append( "</td><td>&nbsp;</td></tr>\n<tr><td>&nbsp;</td><td>&nbsp;</td>" );
            /// no google ads
            sb.append( "</tr></tbody>\n</table></body></html>\n" );
            return sb.toString();
            }
        }

    /**
     * Generate the footer for an amanuensis html document.
     *
     * @param parms   not used.
     * @param quiet   true if want output suppressed.
     * @param verbose @return expanded macro HTML
     */
    public String expandMacro( String[] parms,
                               final boolean quiet, final boolean verbose )
        {
        if ( !quiet )
            {
            out.print( "F" );
            }
        if ( parms.length != 0 )
            {
            throw new IllegalArgumentException( USAGE );
            }
        return expand();
        }
    }