/*
 * [DVD.java]
 *
 * Summary: implements HTML DVD macro to sell a DVD.
 *
 * Copyright: (c) 2007-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.1 2007-03-25 add flags, B&N link, refactor
 */
package com.mindprod.stores;

import com.mindprod.common18.EIO;
import com.mindprod.common18.ST;
import com.mindprod.fastcat.FastCat;
import com.mindprod.htmlmacros.macro.Born;
import com.mindprod.htmlmacros.macro.CountryFlag;
import com.mindprod.htmlmacros.macro.GoogleCannedSearch;
import com.mindprod.htmlmacros.macro.Macro;
import com.mindprod.htmlmacros.support.BuildImage;
import com.mindprod.htmlmacros.support.ImageAlignment;
import com.mindprod.htmlmacros.support.Tools;
import com.mindprod.hunkio.HunkIO;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.regex.Pattern;

import static com.mindprod.htmlmacros.macro.Global.configuration;
import static com.mindprod.stores.DStore.*;
import static com.mindprod.stores.StockStatus.INSTOCK;
import static java.lang.System.*;

/**
 * implements HTML DVD macro to sell a DVD.
 * <p/>
 * Expands HTML DVD macro.
 * Covers images names after asin.
 * file named after upc
 * <p/>
 * Formats data in a table. Sell DVDs at electronic and other sources if UPC is known.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 1.1 2007-03-25 add flags, B&N link, refactor
 * @see DStore
 * @since 2007
 */
@SuppressWarnings( { "ConstantConditions" } )
public class DVD extends Macro
    {
    // declarations

    /**
     * Google search modifier to ensure find only other DVD stores
     */
    private static final String JUST_OTHER_DVDSTORES = "-amazon -site:barnesandnoble.com -site:powells.com";

    /**
     * this item goes on the left side.
     */
    private static final boolean ON_LEFT = false;

    /**
     * this item goes on the right side.
     */
    private static final boolean ON_RIGHT = true;

    /**
     * how to use the macro
     */
    private static final String USAGE = "\nDVD macro needs asin=, upc=, [isbn=,] title= author= "
                                        + "[birth=] [death=] [type=] [notes=]";

    /**
     * list of image formats we support for DVD cover to display in HTML.
     */
    private static final String[] SUPPORTED_EXTENSIONS = { ".png", ".jpg", ".gif" };
    // /declarations
    // methods

    /**
     * split isbns at comma, gets rid of spaces around comma
     */
    private static final Pattern SPLIT_ON_COMMA = Pattern.compile( "\\s*,\\s*" );

    /**
     * true if one or more stores was grayed out for beingout of stock or not carried
     */
    private boolean greyed = false;

    /**
     * find best isbn to display for this store, ideally instock
     *
     * @param dvdStore          DVD store
     * @param preferredProducts list of isbns etc in preferred order
     *
     * @return bet fit isbn, null if no fit. will be NOTCARRIED, OUTOFSTOCK or INSTOCK.
     */
    private static BestResult best( DStore dvdStore, String[] preferredProducts )
        {
        String bestProduct = null;
        StockStatus bestStockStatus = StockStatus.UNKNOWN;
        for ( String product : preferredProducts )
            {
            final StockStatus stockStatus = dvdStore.getProductStatus( product, true );
            if ( stockStatus.compareTo( bestStockStatus ) > 0 )
                {
                bestStockStatus = stockStatus;
                bestProduct = product;
                // if we find an isbn in stock, no point in continuing to search.
                if ( bestStockStatus == StockStatus.INSTOCK )
                    {
                    break;
                    }
                }
            } // end  for
        // we might have fallen out the loop without finding anything
        if ( bestStockStatus.compareTo( StockStatus.NOTCARRIED ) < 0 )
            {
            return new BestResult( dvdStore, null, bestStockStatus );
            }
        else
            {
            return new BestResult( dvdStore, bestProduct, bestStockStatus );
            }
        }// /method

    /**
     * Build a link to a DVD at dummy vendor.  May be needed later.
     *
     * @param onRight true if inserting on right side of table.
     *
     * @return HTML for a filler, dummy vendor.
     */
    @SuppressWarnings( { "SameParameterValue" } )
    private static String buildDummy( boolean onRight )
        {
        return onRight ? "<td></td><td></td></tr>\n" : "<tr><td></td><td></td>";
        }// /method

    /**
     * Get filename of the dvdcover of the form B00005Y726.gif or B00005Y726.jpg
     *
     * @param asin item number without dashes or spaces.
     *
     * @return filename of cover image. Will return dummy "nodvdcover.png if there is no match.
     */
    private static String getDVDCoverName( String asin )
        {
        for ( String ext : SUPPORTED_EXTENSIONS )
            {
            // ext includes the dot
            final String candidateDVDCoverImageName = asin + ext;
            if ( Tools.toFileFromUPath( "image/dvdcover/" + candidateDVDCoverImageName ).exists() )
                {
                return candidateDVDCoverImageName;
                }
            }
        err.println( "Warning no image for DVD asin " + asin );
        // could not find an image
        return "nodvdcover.png";
        }// /method

    /**
     * is this electronic device stocked anywhere
     *
     * @param asin amazon part number
     * @param upc  upc of dvd
     *
     * @return true if in stock in at most one store.
     */
    private static boolean isStockedSomewhere( final String asin, final String upc, final String isbn13 )
        {
        final String[] asins = splitProducts( asin );
        for ( DStore d : AMAZON_DVDSTORES )
            {
            if ( d.isAlive() )
                {
                final BestResult br = best( d, asins );
                if ( br.stockStatus == INSTOCK )
                    {
                    return true;
                    }
                }
            }
        DStore b = DStore.BN;
        if ( b.isAlive() )
            {
            final BestResult br = best( b, splitProducts( upc ) );
            if ( br.stockStatus == INSTOCK )
                {
                return true;
                }
            }
        DStore p = DStore.POWELLS;
        if ( !p.isAlive() )
            {
            final BestResult br = best( p, splitProducts( isbn13 ) );
            if ( br.stockStatus == INSTOCK )
                {
                return true;
                }
            }
        return false;
        }// /method

    /**
     * Create a little *.nostockers file to warn of products nobody stocks.
     *
     * @param product          tHe product number
     * @param productCategory, i.e. DVD
     * @param pageUrl          the url of the product description file
     * @param title            title of the DVD
     */
    private static void reportUnstockedProduct( final String productCategory, final String product, final String pageUrl, final String title )
        {
        final String responseProblemFile = "C:\\temp\\" + productCategory.toUpperCase() + "_" + product +
                                           ".nostockers";
        final FastCat sb = new FastCat( 9 );
        sb.append( "N O S T O C K E R S\n" );
        sb.append( productCategory, " not in stock at any store and not registered as rare in Configuration.isProductRare\n" );
        sb.append( " pageUrl: ", pageUrl, "\n" );
        sb.append( "   title: ", title, "\n" );
        final String problem = sb.toString();
        try
            {
            HunkIO.writeEntireFile( new File( responseProblemFile ), problem, HunkIO.UTF8 );
            }
        catch ( IOException e )
            {
            err.println( "Unable to capture .nostockers file" );
            }
        }// /method

    /**
     * create list of product ids
     *
     * @param productLists, comma-separated product list
     *
     * @return array of products, combining inputs
     */
    private static String[] splitProducts( final String... productLists )
        {
        ArrayList<String> a = new ArrayList<>( 10 );
        for ( String productList : productLists )
            {
            if ( ST.isEmpty( productList ) )
                {
                continue;
                }
            final String[] products = SPLIT_ON_COMMA.split( productList );
            for ( String product : products )
                {
                if ( ST.isEmpty( product ) || a.contains( product ) )
                    {
                    // duplicate
                    continue;
                    }
                a.add( product );
                }
            }
        return a.toArray( new String[ a.size() ] );
        }// /method

    /**
     * build link with flag
     *
     * @param onright           true if flag on right
     * @param dvdStore          which DVD store
     * @param preferredProducts array of ISBNs in order to preference
     * @param title             title of book
     * @param author            author of book
     */
    private String buildProductLinkWithFlag( boolean onright, DStore dvdStore, String[] preferredProducts, final String title, final String author )
        {
        // flag comes from the store
        CountryFlag flag = dvdStore.getFlag();
        final FastCat sb = new FastCat( 12 );
        sb.append( leadingCountryFlag( onright, flag ) );
        if ( dvdStore.isAlive() )
            {
            final BestResult br = best( dvdStore, preferredProducts );
            final String product = br.product;
            final StockStatus status = br.stockStatus;
            sb.append( "<a class=\"", status.getCssClass() );
            switch ( status )
                {
                case OUTOFSTOCK:
                    if ( dvdStore.takesPayPal() )
                        {
                        sb.append( " paypal" );
                        }
                    sb.append( "\" rel=\"nofollow\" href=\"" );
                    sb.append( dvdStore.buildProductLink( product ), "\">" );
                    greyed = true;
                    break;
                case INSTOCK:
                    if ( dvdStore.takesPayPal() )
                        {
                        sb.append( " paypal" );
                        }
                    sb.append( "\" rel=\"nofollow\" href=\"" );
                    sb.append( dvdStore.buildProductLink( product ), "\">" );
                    break;
                case NOTCARRIED:
                default:
                    // unknown will show up here if there is no product number
                    sb.append( "\" rel=\"nofollow\" href=\"" );
                    sb.append( dvdStore.buildQueryLink( title, author ), "\">" );
                    greyed = true;
                }
            sb.append( dvdStore.getDecoratedStoreName(), "</a>" );
            }
        else
            {
            sb.append( "<span class=\"construction\">", dvdStore.getDecoratedStoreName(), "</span>" );
            }
        sb.append( trailingCountryFlag( onright, flag ) );
        return sb.toString();
        }// /method

    /**
     * build link with flag
     *
     * @param onright true if flag on right
     * @param topic   topic of search   book title
     *
     * @return generated HTML to links to Google Search
     */
    private String buildSearchLinkWithUNFlag( boolean onright, String topic, String upc )
        {
        CountryFlag flag = CountryFlag.UN;
        // search web with google for this topic
        if ( upc != null )
            {
            topic = topic + " " + upc;
            }
        final FastCat sb = new FastCat( 3 );
        sb.append( leadingCountryFlag( onright, flag ) );
        sb.append( GoogleCannedSearch.expand( false, JUST_OTHER_DVDSTORES, topic, "other stores",
                fileBeingDistributed ) );
        sb.append( trailingCountryFlag( onright, flag ) );
        return sb.toString();
        }// /method

    /**
     * build grid of store buttons
     *
     * @param title  title of DVD
     * @param upc12  product number
     * @param asin   Amazon product number
     * @param isbn13 isbn
     *
     * @return generated HTML for store grid
     */
    private String buildStoreButtons( final String title, final String author, final String upc12,
                                      final String asin, final String isbn13 )
        {
        greyed = false;
        final String[] asins = splitProducts( asin );
        final FastCat sb = new FastCat( 25 );
        sb.append( "<tr><td colspan=\"3\" class=\"buy\">" );
        sb.append( "<table class=\"selldvdgrid\"><caption class=\"hidden\">" );
        sb.append( "Online stores carrying " );
        sb.append( Tools.stripHTMLTags( title ) );
        sb.append( "</caption>\n" );
        sb.append( "<colgroup>" );
        sb.append( "<col style=\"width:75px;text-align:center\">" );
        sb.append( "<col style=\"text-align:left\">" );
        sb.append( "<col style=\"text-align:right\">" );
        sb.append( "<col style=\"width:75px;text-align:center\">" );
        sb.append( "</colgroup>" );
        sb.append( "<tbody>\n" );
            /*
                 L A Y O U T
                 amazon.de       amazon.uk
                 amazon.es       amazon.ca
                 amazon.fr       amazon.com
                 amazon.it       powells   (isbn)
                 junglee         B&N       (upc)
                 other
            */
        sb.append( Book.interleave(
                new String[] {
                        // buildProductLinkWithFlag( ON_LEFT, AMAZONCN, asin, title, author ),
                        buildProductLinkWithFlag( ON_LEFT, AMAZONDE, asins, title, author ),
                        buildProductLinkWithFlag( ON_LEFT, AMAZONES, asins, title, author ),
                        buildProductLinkWithFlag( ON_LEFT, AMAZONFR, asins, title, author ),
                        buildProductLinkWithFlag( ON_LEFT, AMAZONIT, asins, title, author ),
                        buildProductLinkWithFlag( ON_LEFT, JUNGLEE, asins, title, author ),
                        buildSearchLinkWithUNFlag( ON_LEFT, title, upc12 )
                },
                new String[] {
                        buildProductLinkWithFlag( ON_RIGHT, AMAZONUK, asins, title, author ),
                        buildProductLinkWithFlag( ON_RIGHT, AMAZONCA, asins, title, author ),
                        buildProductLinkWithFlag( ON_RIGHT, AMAZONCOM, asins, title, author ),
                        buildProductLinkWithFlag( ON_RIGHT, POWELLS, splitProducts( isbn13 ), title, author ),  // Powells proprietary ISBN
                        buildProductLinkWithFlag( ON_RIGHT, BN, splitProducts( upc12 ), title, author ),
                        buildDummy( ON_RIGHT )
                }
        ) );
        // end inner sellclassgrid table
        sb.append( "</tbody></table></td></tr>\n" );
        sb.append( "<tr><td class=\"unobtrusive alignedcenter\" colspan=\"3\">Greyed out stores probably " +
                   "do not have the item in stock</td></tr>\n" );
        return sb.toString();
        }// /method

    /**
     * Generate HTML for one DVD. Assumes all data is clean. All fields must be HTML, i.e. ampersands must be shown as
     * ampersand-amp; etc. Does NOT generate the <!-- macro, <!-- generated or <!-- /generated.
     *
     * @param asin   Amazon order number for DVD without dashes or spaces.
     * @param upc12  Universal Product Code for DVD, "" if none.
     * @param isbn13 optional isbn13
     * @param title  Title of the DVD.
     * @param author Name of author or authors.
     * @param birth  in form yyyy-mm-dd
     * @param death  in form yyyy-mm-dd
     * @param type   e.g. DVD, CD, software,
     * @param notes  Notes about the dvd. May contain embedded newlines.
     *
     * @return String representing all the HTML needed for one dvd referral.
     */
    @SuppressWarnings( "SameParameterValue" )
    private String expand( String asin, String upc12, String isbn13, String title, String author, String birth, String death,
                           String type, String notes )
        {
        final boolean haveAsin = asin.length() > 0;
        final boolean haveUpc = upc12.length() > 0;
        final boolean haveIsbn = isbn13.length() > 0;
        final boolean haveBirth = birth.length() > 0 && !birth.equals( "unknown" );
        final boolean haveDeath = death.length() > 0 && !death.equals( "unknown" );
        final String birthAndDeath;
        if ( haveBirth && haveDeath )
            {
            birthAndDeath = Born.trimBorn( new Born().expandMacro( new String[] { birth, death }, true, false ) );
            // <span class="unobtrusive">(born: <span class="birthdate">1915-01-06</span> died: <span
            // class="deathdate">2001-09-30</span> at age: <span class="age">86</span>)</span>
            // strip out (born:_ and final )
            }
        else if ( haveBirth )
            {
            birthAndDeath = Born.trimBorn( new Born().expandMacro( new String[] { birth }, true, false ) );
            }
        else
            {
            birthAndDeath = "";
            }
        final boolean haveBirthAndDeath = birthAndDeath.length() > 0;
        int rowspan = 3;
        if ( haveBirthAndDeath )
            {
            rowspan++;
            }
        if ( haveAsin )
            {
            rowspan++;
            }
        if ( haveUpc )
            {
            rowspan++;
            }
        if ( haveIsbn )
            {
            rowspan++;
            }
        boolean stockedSomewhere = isStockedSomewhere( asin, upc12, isbn13 );
        if ( !stockedSomewhere && !configuration.isProductRare( upc12 ) )
            {
            reportUnstockedProduct( "DVD", upc12, EIO.getCanOrAbsPath( fileBeingProcessed ), title );
            }
        final FastCat sb = new FastCat( 49 );
        sb.append( "<table  class=\"selldvd\" id=\"X", upc12, "\"><caption class=\"hidden\">" );
        sb.append( "DVD referral for " );
        sb.append( Tools.stripHTMLTags( title ) );
        sb.append( "</caption>\n" );
        sb.append( "<tbody>" );
        sb.append( "<tr><td rowspan=\"" );
        sb.append( rowspan );
        sb.append( "\">" );
        sb.append( BuildImage.buildImgTag( "dvdcover/" + getDVDCoverName( asin ),
                "dvd cover",
                null
                /* align */,
                null
                /* css */,
                fileBeingDistributed ) );
        // pigeon icon takes you to the electronic home which is copied to other places.
        final boolean needPigeon = !fileBeingDistributed.getParent().endsWith( "dvd" );
        // layout
        //  image   ( title---pigeon)
        //  ----    xxxx: yyyyyyyyyyy
        //   1        2      3
        sb.append( "</td>\n<td colspan=\"2\" class=\"dvdtitle\">" );
        // text for google desktop to search for.
        sb.append( "<span class=\"indexing\">recommend DVD&rArr;</span>" );
        sb.append( title );
        if ( needPigeon )
            {
            sb.append( Tools.completeLink( "dvd/" + upc12 + ".html",
                    BuildImage.buildImgTag( "navigate/pigeon.png",
                            "to dvd home",
                            ImageAlignment.floatright,
                            null,
                            fileBeingDistributed ), "plain", fileBeingDistributed
            ) );
            }
        sb.append( "</td></tr>\n" );
        sb.append( "<tr><th></th><td class=\"dvdtype\">", type, "</td></tr>\n" );
        sb.append( "<tr><th class=\"alignedright\">by</th><td class=\"by\">", author, "</td></tr>\n" );
        if ( haveBirthAndDeath )
            {
            sb.append( "<tr><th class=\"alignedright\">birth</th><td>", birthAndDeath, "</td></tr>\n" );
            }
        if ( haveAsin )
            {
            sb.append( "<tr><th class=\"alignedright\">asin</th><td class=\"asin\">", asin, "</td></tr>\n" );
            }
        if ( haveUpc )
            {
            sb.append( "<tr><th class=\"alignedright\">upc</th><td class=\"upc\">", upc12, "</td></tr>\n" );
            }
        if ( haveIsbn )
            {
            sb.append( "<tr><th class=\"alignedright\">isbn</th><td class=\"isbn\">", isbn13, "</td></tr>\n" );
            }
        if ( notes.length() > 0 || !stockedSomewhere )
            {
            sb.append( "<tr><td colspan=\"3\" class=\"notes\">" );
            if ( !stockedSomewhere )
                {
                sb.append( "This DVD is not in stock at any of the major online stores. " );
                }
            sb.append( notes, "</td></tr>\n" );
            }
        if ( stockedSomewhere )
            {
            sb.append( buildStoreButtons( title, author, upc12, asin, isbn13 ) );
            }
        sb.append( "</tbody></table>\n" );
        sb.append( "<!-- end DVD referral for ", title, " -->\n" );
        return sb.toString();
        }// /method

    /**
     * Insert optional country flag on left of link.
     * <p/>
     *
     * @param whichSide true if inserting on right side of table.
     * @param flag      CountryFlag country.
     *
     * @return HTML to display the flag
     */
    private String leadingCountryFlag( boolean whichSide, CountryFlag flag )
        {
        return whichSide ? "<td>" : "<tr><td class=\"flag\">" + flag.getFlagRef( fileBeingDistributed ) + "</td>\n<td>";
        }// /method

    /**
     * Insert optional country flag on right of link.
     *
     * @param whichSide true if inserting on right side of table.
     * @param flag      CountryFlag country.
     *
     * @return HTML to display the flag
     */
    private String trailingCountryFlag( boolean whichSide, CountryFlag flag )
        {
        return whichSide ? "</td>\n<td class=\"flag\">" + flag.getFlagRef( fileBeingDistributed ) + "</td></tr>\n" :
               "</td>\n";
        }// /method

    /**
     * Generate macro expansion for DVD macro
     *
     * @param parms   parsed params for the macro. parms typically look like this: <!-- macro DVD
     *                upc="B0007P8KZA" title="1984" author="George Orwell" type=DVD notes={What
     *                happens when the state gets too much power. &quot;Political language is designed to
     *                make lies sound truthful and murder respectable, and to give an appearance of solidity
     *                to pure wind.&quot;<br> ~ George Orwell} --> Parms may be in any order.
     * @param quiet   true if want output suppressed.
     * @param verbose @return expanded text
     */
    public String expandMacro( String[] parms, final boolean quiet, final boolean verbose )
        {
        if ( parms.length < 3 * 2 )
            {
            throw new IllegalArgumentException( USAGE );
            }
        // must have even number of parms
        if ( ( parms.length & 1 ) != 0 )
            {
            throw new IllegalArgumentException( "DVD macro syntax error: must have parm=value pairs\n" + USAGE );
            }
        // set defaults
        String asin = "";
        String upc12 = "";
        String isbn13 = "";
        String title = "unknown title";
        String author = "anonymous";
        String type = "DVD";
        String notes = "&nbsp;";
        String birth = "";
        String death = "";
        // extract data from parms
        for ( int i = 0; i < parms.length; i += 2 )
            {
            String name = parms[ i ];
            String value = parms[ i + 1 ];
            switch ( name )
                {
                case "asin":
                    if ( value.length() != 10 )
                        {
                        throw new IllegalArgumentException( "asin " + value + "  must be 10 characters long" );
                        }
                    asin = value;
                    break;
                case "upc":
                    if ( !( value.length() == 12 && ST.isNumeric( value ) ) )
                        {
                        throw new IllegalArgumentException( "upc " + value + " must be 12 digits long" );
                        }
                    upc12 = value;// don't check UPC check digit.
                    break;
                case "isbn":
                    // this is Powells ISBN. Do not validate
                    isbn13 = value;
                    break;
                case "title":
                    title = value;
                    break;
                case "author":
                    author = value;
                    break;
                case "birth":
                    birth = value;
                    break;
                case "death":
                    death = value;
                    break;
                case "type":
                    type = value.toUpperCase();   // e.g. DVD CD software
                    break;
                case "notes":
                    notes = value;
                    break;
                default:
                    throw new IllegalArgumentException( "DVD macro syntax error: unknown parm: " + name + "\n" + USAGE );
                }
            } // end for
        if ( ST.isEmpty( asin ) )
            {
            throw new IllegalArgumentException( "DVD macro asin is missing\n" + USAGE );
            }
        if ( ST.isEmpty( upc12 ) )
            {
            throw new IllegalArgumentException( "DVD macro upc12 is missing\n" + USAGE );
            }
        // generate the HTML to refer this dvd.
        return expand( asin, upc12, isbn13, title, author, birth, death, type, notes );
        }// /method
    // /methods
    }