/*
 * [Donate.java]
 *
 * Summary: Generate a PayPal request for donation.
 *
 * 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-02-11 initial version
 */
package com.mindprod.htmlmacros.macro;

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

import static java.lang.System.*;

/**
 * Generate a PayPal request for donation.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 1.0 2011-02-11 initial version
 * @since 2011-02-11
 */
public final class Donate extends Macro
    {
    /**
     * amount donated so for to all glossaries.
     */
    private static final String DONATED_SO_FAR = "$1989.00 US";

    /**
     * how to use the macro
     */
    private static final String USAGE = "\nDonate macro needs glossaryName payPalButtonId";

    /**
     * Expand Donate macro
     *
     * @param glossaryName   name of glossary the donation supports, also "CMP Utilities"
     * @param payPalButtonId code to index information about the button stored on PayPal website.
     *                       Encodes the glossary name for PayPal.
     *
     * @return expanded macro HTML
     */
    private String expand( final String glossaryName, final String payPalButtonId )
        {
        final FastCat sb = new FastCat();
        sb.append( "<form action=\"https://www.paypal.com/cgi-bin/webscr\" method=\"post\">\n" );
        sb.append( "<input type=\"hidden\" name=\"cmd\" value=\"_s-xclick\">\n" );
        sb.append( "<input type=\"hidden\" name=\"hosted_button_id\" value=\"" );
        sb.append( payPalButtonId );
        sb.append( "\">\n" );
        sb.append( "<input class=\"donate\" type=\"image\" src=\"" );
        sb.append( Tools.relativeURL( "image/buy/paypaldonate.png", fileBeingDistributed ) );
        // name=submit changed to name=submitdonation to keep htmlvalidator happy. Name not sent to PayPal. Also
        // removed border="0"
        sb.append( "\" width=\"92\" height=\"25\" name=\"submitdonation\" alt=\"PayPal - The safer, " +
                   "easier way to donate online!\">\n" );
        // this is slowing page loads down
        // sb.append( "<img alt=\"impression counter\" border=\"0\" src=\"https://www.paypal.com/en_US/i/scr/pixel
        // .gif\" width=\"1\" height=\"1\">\n" ); // impression counter
        sb.append( "<span class=\"currency\">" );
        sb.append( DONATED_SO_FAR );
        sb.append( "</span> donated so far. If the " );
        sb.append( glossaryName );
        sb.append( " solved your problem, please donate a buck or two,\n" );
        sb.append( "or donate to one of the charities featured in the footer public service ads\n" );
        sb.append( "throughout the website and get a tax receipt.\n" );
        sb.append( "</form>" );
        return sb.toString();
        } // end expandNoRef

    /**
     * Generate a PayPal payment request <!-- macro Donate "Java Glossary" RKZQ9H9Y4DL7A -->
     *
     * @param parms   show currency amount level.
     * @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( "D" );
            }
        if ( parms.length != 2 )
            {
            throw new IllegalArgumentException( USAGE );
            }
        final String glossaryName = parms[ 0 ];
        final String payPalButtonId = parms[ 1 ];
        return expand( glossaryName, payPalButtonId );
        }
    // Raw what PayPal wants:
    //    <form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
    //    <input type="hidden" name="cmd" value="_s-xclick">
    //    <input type="hidden" name="hosted_button_id" value="L7V3KW74U7FNW">
    //    <input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
    //    <img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">
    //    </form>
    }