package Torello.Browser.BrowserAPI;

import java.util.*;
import javax.json.*;
import javax.json.stream.*;
import java.io.*;

import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.function.Function;

import Torello.Browser.BrowserEvent;
import Torello.Browser.JavaScriptAPI.*;
import Torello.Browser.helper.*;

import Torello.Java.Additional.*;
import Torello.Java.JSON.*;

import static Torello.Java.JSON.JFlag.*;

import Torello.Java.StrCmpr;
import Torello.JavaDoc.StaticFunctional;
import Torello.JavaDoc.JDHeaderBackgroundImg;
import Torello.JavaDoc.Excuse;

/**
 * <SPAN CLASS=COPIEDJDK><B>Defines commands and events for browser extensions.</B></SPAN>
 * 
 * <EMBED CLASS='external-html' DATA-FILE-ID=CODE_GEN_NOTE>
 */
@StaticFunctional(Excused={"counter"}, Excuses={Excuse.CONFIGURATION})
@JDHeaderBackgroundImg(EmbedTagFileID="WOOD_PLANK_NOTE")
public class Extensions
{
    // ********************************************************************************************
    // ********************************************************************************************
    // Class Header Stuff
    // ********************************************************************************************
    // ********************************************************************************************


    // No Pubic Constructors
    private Extensions () { }

    // These two Vector's are used by all the "Methods" exported by this class.  java.lang.reflect
    // is used to generate the JSON String's.  It saves thousands of lines of Auto-Generated Code.
    private static final Map<String, Vector<String>>    parameterNames = new HashMap<>();
    private static final Map<String, Vector<Class<?>>>  parameterTypes = new HashMap<>();

    // Some Methods do not take any parameters - for instance all the "enable()" and "disable()"
    // I simply could not get ride of RAW-TYPES and UNCHECKED warnings... so there are now,
    // offically, two empty-vectors.  One for String's, and the other for Classes.

    private static final Vector<String>     EMPTY_VEC_STR = new Vector<>();
    private static final Vector<Class<?>>   EMPTY_VEC_CLASS = new Vector<>();

    static
    {
        for (Method m : Extensions.class.getMethods())
        {
            // This doesn't work!  The parameter names are all "arg0" ... "argN"
            // It works for java.lang.reflect.Field, BUT NOT java.lang.reflect.Parameter!
            //
            // Vector<String> parameterNamesList = new Vector<>(); -- NOPE!

            Vector<Class<?>> parameterTypesList = new Vector<>();
        
            for (Parameter p : m.getParameters()) parameterTypesList.add(p.getType());

            parameterTypes.put(
                m.getName(),
                (parameterTypesList.size() > 0) ? parameterTypesList : EMPTY_VEC_CLASS
            );
        }
    }

    static
    {
        Vector<String> v = null;

        v = new Vector<String>(1);
        parameterNames.put("loadUnpacked", v);
        Collections.addAll(v, new String[]
        { "path", });

        v = new Vector<String>(1);
        parameterNames.put("uninstall", v);
        Collections.addAll(v, new String[]
        { "id", });

        v = new Vector<String>(3);
        parameterNames.put("getStorageItems", v);
        Collections.addAll(v, new String[]
        { "id", "storageArea", "keys", });

        v = new Vector<String>(3);
        parameterNames.put("removeStorageItems", v);
        Collections.addAll(v, new String[]
        { "id", "storageArea", "keys", });

        v = new Vector<String>(2);
        parameterNames.put("clearStorageItems", v);
        Collections.addAll(v, new String[]
        { "id", "storageArea", });

        v = new Vector<String>(3);
        parameterNames.put("setStorageItems", v);
        Collections.addAll(v, new String[]
        { "id", "storageArea", "values", });
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Types - Static Inner Classes
    // ********************************************************************************************
    // ********************************************************************************************

    /** Storage areas. */
    public static final String[] StorageArea =
    { "session", "local", "sync", "managed", };
    
    
    // Counter for keeping the WebSocket Request ID's distinct.
    private static int counter = 1;
    
    /**
     * Installs an unpacked extension from the filesystem similar to
     * --load-extension CLI flags. Returns extension ID once the extension
     * has been installed. Available if the client is connected using the
     * --remote-debugging-pipe flag and the --enable-unsafe-extension-debugging
     * flag is set.
     * 
     * @param path Absolute file path.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * String&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * String&gt;</CODE> will be returned.
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>String (<B>id</B></CODE>)
     *     <BR />Extension id.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, String> loadUnpacked(String path)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (path == null) THROWS.throwNPE("path");
        
        final int       webSocketID = 10000000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("loadUnpacked"),
            parameterNames.get("loadUnpacked"),
            optionals, webSocketID,
            "Extensions.loadUnpacked",
            path
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'String'
        Function<JsonObject, String> responseProcessor = (JsonObject jo) ->
            ReadJSON.getString(jo, "id", false, true);
        
        return new Script<>(webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * Uninstalls an unpacked extension (others not supported) from the profile.
     * Available if the client is connected using the --remote-debugging-pipe flag
     * and the --enable-unsafe-extension-debugging.
     * 
     * @param id Extension id.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR />This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> uninstall(String id)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (id == null) THROWS.throwNPE("id");
        
        final int       webSocketID = 10001000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("uninstall"),
            parameterNames.get("uninstall"),
            optionals, webSocketID,
            "Extensions.uninstall",
            id
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (webSocketID, requestJSON, VOID_RETURN.NoReturnValues);
    }
    
    /**
     * Gets data from extension storage in the given {@code storageArea}. If {@code keys} is
     * specified, these are used to filter the result.
     * 
     * @param id ID of extension.
     * 
     * @param storageArea StorageArea to retrieve data from.
     * 
     * @param keys Keys to retrieve.
     * <BR /><B CLASS=Opt>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * JsonObject&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * JsonObject&gt;</CODE> will be returned.
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>JsonObject (<B>data</B></CODE>)
     *     <BR />-
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, JsonObject> getStorageItems
        (String id, String storageArea, String[] keys)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (id == null)          THROWS.throwNPE("id");
        if (storageArea == null) THROWS.throwNPE("storageArea");
        
        // Exception-Check(s) to ensure that if any parameters which must adhere to a
        // provided List of Enumerated Values, fails, then IllegalArgumentException shall throw.
        
        THROWS.checkIAE("storageArea", storageArea, "Extensions.StorageArea", Extensions.StorageArea);
        
        final int       webSocketID = 10002000 + counter++;
        final boolean[] optionals   = { false, false, true, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("getStorageItems"),
            parameterNames.get("getStorageItems"),
            optionals, webSocketID,
            "Extensions.getStorageItems",
            id, storageArea, keys
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'JsonObject'
        Function<JsonObject, JsonObject> responseProcessor = (JsonObject jo) ->
            jo.getJsonObject("data");
        
        return new Script<>(webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * Removes {@code keys} from extension storage in the given {@code storageArea}.
     * 
     * @param id ID of extension.
     * 
     * @param storageArea StorageArea to remove data from.
     * 
     * @param keys Keys to remove.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR />This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> removeStorageItems
        (String id, String storageArea, String[] keys)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (id == null)          THROWS.throwNPE("id");
        if (storageArea == null) THROWS.throwNPE("storageArea");
        if (keys == null)        THROWS.throwNPE("keys");
        
        // Exception-Check(s) to ensure that if any parameters which must adhere to a
        // provided List of Enumerated Values, fails, then IllegalArgumentException shall throw.
        
        THROWS.checkIAE("storageArea", storageArea, "Extensions.StorageArea", Extensions.StorageArea);
        
        final int       webSocketID = 10003000 + counter++;
        final boolean[] optionals   = { false, false, false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("removeStorageItems"),
            parameterNames.get("removeStorageItems"),
            optionals, webSocketID,
            "Extensions.removeStorageItems",
            id, storageArea, keys
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (webSocketID, requestJSON, VOID_RETURN.NoReturnValues);
    }
    
    /**
     * Clears extension storage in the given {@code storageArea}.
     * 
     * @param id ID of extension.
     * 
     * @param storageArea StorageArea to remove data from.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR />This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> clearStorageItems
        (String id, String storageArea)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (id == null)          THROWS.throwNPE("id");
        if (storageArea == null) THROWS.throwNPE("storageArea");
        
        // Exception-Check(s) to ensure that if any parameters which must adhere to a
        // provided List of Enumerated Values, fails, then IllegalArgumentException shall throw.
        
        THROWS.checkIAE("storageArea", storageArea, "Extensions.StorageArea", Extensions.StorageArea);
        
        final int       webSocketID = 10004000 + counter++;
        final boolean[] optionals   = { false, false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("clearStorageItems"),
            parameterNames.get("clearStorageItems"),
            optionals, webSocketID,
            "Extensions.clearStorageItems",
            id, storageArea
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (webSocketID, requestJSON, VOID_RETURN.NoReturnValues);
    }
    
    /**
     * Sets {@code values} in extension storage in the given {@code storageArea}. The provided {@code values}
     * will be merged with existing values in the storage area.
     * 
     * @param id ID of extension.
     * 
     * @param storageArea StorageArea to set data in.
     * 
     * @param values Values to set.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR />This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> setStorageItems
        (String id, String storageArea, JsonObject values)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (id == null)          THROWS.throwNPE("id");
        if (storageArea == null) THROWS.throwNPE("storageArea");
        if (values == null)      THROWS.throwNPE("values");
        
        // Exception-Check(s) to ensure that if any parameters which must adhere to a
        // provided List of Enumerated Values, fails, then IllegalArgumentException shall throw.
        
        THROWS.checkIAE("storageArea", storageArea, "Extensions.StorageArea", Extensions.StorageArea);
        
        final int       webSocketID = 10005000 + counter++;
        final boolean[] optionals   = { false, false, false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("setStorageItems"),
            parameterNames.get("setStorageItems"),
            optionals, webSocketID,
            "Extensions.setStorageItems",
            id, storageArea, values
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (webSocketID, requestJSON, VOID_RETURN.NoReturnValues);
    }
    
}