/*
 * [Signed.java]
 *
 * Summary: Generate the html to explain how to run a signed Applet or JWS application.
 *
 * 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.Tools;
import com.mindprod.prices.AppCat;

import java.io.File;

import static com.mindprod.htmlmacros.macro.Global.configuration;
import static com.mindprod.htmlmacros.support.JDKandJREVersions.JDK_PATH;
import static com.mindprod.htmlmacros.support.JDKandJREVersions.JRE_PATH;
import static com.mindprod.htmlmacros.support.JDKandJREVersions.OLD_JDK_PATH;
import static com.mindprod.htmlmacros.support.JDKandJREVersions.OLD_JRE_PATH;
import static java.lang.System.*;

/**
 * Generate the html to explain how to run a signed Applet or JWS application.
 * <p/>
 * No longer used. NeedsJava handle this function.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 1.8 2009-02-06 include go package in ZIP bundle.
 * @since 2009
 */
public final class Signed extends Macro
    {
    /**
     * how to use the macro
     */
    private static final String USAGE = "\nSigned macro needs mainClass (Applet/weblet)";

    /**
     * guts to Generate the explanation of how to use a signed applet
     *
     * @param mainClass          name of class we will run
     * @param type               type APPLET HYBRID etc
     * @param fileBeingProcessed the file currently being processed.
     *
     * @return expanded explanation
     */
    private static String expand( String mainClass, AppCat type, File fileBeingProcessed
    )
        {
        final String br = configuration.getBr();
        FastCat kt = new FastCat( 5 );
        kt.append( "keytool&nbsp;-import -keystore cacerts -alias " );
        kt.append( configuration.getCodeSigningCert() );
        kt.append( " -file " );
        kt.append( configuration.getCodeSigningCert() );
        kt.append( ".cer\n" ).toString();
        final String keytool = kt.toString();
        final FastCat sb = new FastCat( 115 );
        sb.append( "You should be able to run this " );
        sb.append( type.getLongCategoryDescription( true ) );
        sb.append( " just by clicking OK to accept the certificate, but\n" );
        sb.append( "if you have trouble, you may have to install my code signing certificate in your\n" );
        sb.append( "cacerts certificate repository. To do this just click <a class=\"contact\" href=\"" );
        sb.append( Tools.relativeURL( "contact/" + configuration.getCodeSigningCert() + ".cer", fileBeingProcessed ) );
        sb.append( "\">install</a>\n" );
        sb.append( "and follow your nose. If that does not work, you can install it manually:\n" );
        sb.append( "<ol>\n" );
        sb.append( "<li>" );
        sb.append( "Download my X.509 DSA Java Codesigning certificate <a class=\"contact\" href=\"" );
        sb.append( Tools.relativeURL( "contact/" + configuration.getCodeSigningCert() + ".cer", fileBeingProcessed ) );
        sb.append( "\">" );
        sb.append( configuration.getCodeSigningCert() );
        sb.append( ".cer</a>.\n" );
        sb.append( "</li>\n" );
        sb.append( "<li>" );
        sb.append( "Then import it into you cacerts files with one or more of the relevant following commands:\n" );
        sb.append( br );
        sb.append( "<div class=\"bat\">\n" );
        sb.append( "<span class=\"rem\">REM The default password for the</span>\n" );
        sb.append( br );
        sb.append(
                "<span class=\"rem\">REM <span class=\"file\">cacerts</span> file is <span " +
                "class=\"red\">changeit</span>.</span>\n"
        );
        sb.append( br );
        sb.append(
                "<span class=\"rem\">REM keytool and cd commands should be all on one line when you type them" +
                ".</span>\n"
        );
        sb.append( br );
        sb.append( "<span class=\"rem\">REM import into the current JRE</span>\n" );
        sb.append( br );
        sb.append( "E:\n" );
        sb.append( br );
        sb.append( "cd&nbsp;&quot;" );
        sb.append( JRE_PATH );
        sb.append( "\\lib\\security&quot;\n" );
        sb.append( br );
        sb.append( keytool );
        sb.append( br );
        sb.append( "<span class=\"rem\">REM import into the current JDK</span>\n" );
        sb.append( br );
        sb.append( "J:\n" );
        sb.append( br );
        sb.append( "cd&nbsp;&quot;" );
        sb.append( JDK_PATH );
        sb.append( "\\jre\\lib\\security&quot;\n" );
        sb.append( br );
        sb.append( keytool );
        sb.append( br );
        sb.append( "<span class=\"rem\">REM import into the previous JRE</span>\n" );
        sb.append( br );
        sb.append( "E:\n" );
        sb.append( br );
        sb.append( "cd&nbsp;&quot;" );
        sb.append( OLD_JRE_PATH );
        sb.append( "\\lib\\security&quot;\n" );
        sb.append( br );
        sb.append( "keytool&nbsp;-import -keystore cacerts;-alias " );
        sb.append( configuration.getCodeSigningCert() );
        sb.append( " -file " );
        sb.append( configuration.getCodeSigningCert() );
        sb.append( ".cer\n" );
        sb.append( br );
        sb.append( "<span class=\"rem\">REM import into the previous JDK</span>\n" );
        sb.append( br );
        sb.append( "J:\n" );
        sb.append( br );
        sb.append( "cd&nbsp;&quot;" );
        sb.append( OLD_JDK_PATH );
        sb.append( "\\jre\\lib\\security&quot;\n" );
        sb.append( br );
        sb.append( keytool );
        sb.append( "</div>\n" );
        sb.append( "</li>\n" );
        if ( type == AppCat.APPLET || type == AppCat.HYBRID )
            {
            sb.append( "<li>" );
            sb.append( "Restart your browser and try the " );
            sb.append( mainClass );
            sb.append( " Applet again.\n" );
            sb.append( "</li>\n" );
            }
        if ( type == AppCat.JWS )
            {
            sb.append( "<li>" );
            sb.append( "Restart your browser and try the " );
            sb.append( mainClass );
            sb.append( " Java WebStart again.\n" );
            sb.append( "</li>\n" );
            sb.append( " <li>" );
            sb.append( " If the download fails, install " );
            sb.append( mainClass );
            sb.append( " manually by typing at the command prompt:\n" );
            sb.append( "<div class=\"bat\">" );
            sb.append( "<span class=\"batcomment\">rem On Windows</span>" );
            sb.append( br );
            sb.append( "<span class=\"exe\">javaws.exe</span> " );
            sb.append( "http://mindprod.com/webstart/" );
            sb.append( mainClass.toLowerCase() );
            sb.append( ".jnlp" );
            sb.append( br );
            sb.append( "<span class=\"bshcomment\"># on Linux/BASH</span>" );
            sb.append( br );
            sb.append( "<span class=\"exe\">javaws</span> " );
            sb.append( "http://mindprod.com/webstart/" );
            sb.append( mainClass.toLowerCase() );
            sb.append( ".jnlp" );
            sb.append( "</div>" );
            sb.append( "</li>\n" );
            }
        sb.append( "<li>" );
        sb.append( " You can also modify your <a class=\"plain\" href=\"" );
        sb.append( Tools.relativeURL( "jgloss/policyfile.html", fileBeingProcessed ) );
        sb.append( "\">policy file</a> to\n" );
        sb.append( " give automatic permission.\n" );
        sb.append( "</li>\n" );
        if ( type == AppCat.HYBRID )
            {
            sb.append( "<li> Alternatively you can <a class=\"download\" href=\"" );
            sb.append( Tools.relativeURL( "products.html#" + mainClass.toUpperCase(), fileBeingProcessed ) );
            sb.append( "\">download</a> " );
            sb.append( mainClass );
            sb.append( " and run\n" + " it as an application.\n" + "</li>\n" );
            }
        sb.append( "</ol>\n" );
        sb.append( "<!-- end Signed description of " + mainClass + " -->\n" );
        return sb.toString();
        }

    /**
     * Generate the html to explain how to run a signed Applet or JWS application.
     *
     * @param parms   mainClass type Applet or Weblet
     * @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( "S" );
            }
        if ( parms.length != 2 )
            {
            throw new IllegalArgumentException( USAGE );
            }
        String mainClass = parms[ 0 ];
        AppCat type = AppCat.valueOfAlias( parms[ 1 ] );
        return expand( mainClass, type, fileBeingProcessed );
        }
    }