package Torello.Browser;

import static Torello.Java.C.BYELLOW;
import static Torello.Java.C.RESET;

import Torello.Java.JSON.ReadJSON;
import Torello.JavaDoc.LinkJavaSource;
import Torello.Browser.BrowserEvent;
import Torello.Browser.WebSocketSender;
import NeoVisionaries.WebSockets.WebSocketException;

import java.util.stream.Stream;
import java.io.IOException;
import java.util.Objects;
import java.util.function.Consumer;
import java.util.Objects;
import javax.json.JsonObject;


// @AutoFindFieldDocs(location="BRDPC/PageConn/fields/")
/**
 * A Connection to a specific page within a browser.
 * <EMBED CLASS='external-html' DATA-FILE-ID=PAGE_CONN>
 */
@Torello.JavaDoc.CSSLinks(FileNames="BrowserAndPageConn.css")
public class PageConn
{
    // ********************************************************************************************
    // ********************************************************************************************
    // Public Fields
    // ********************************************************************************************
    // ********************************************************************************************


    /** <EMBED CLASS='external-html' DATA-FILE-ID=PC_ID> */
    public final String id;

    /** <EMBED CLASS='external-html' DATA-FILE-ID=PC_TYPE> */
    public final String type;

    /** <EMBED CLASS='external-html' DATA-FILE-ID=PC_TITLE> */
    public final String title;

    /** <EMBED CLASS='external-html' DATA-FILE-ID=PC_URL> */
    public final String url;

    /** <EMBED CLASS='external-html' DATA-FILE-ID=PC_DESCRIPTION> */
    public final String description;

    /** <EMBED CLASS='external-html' DATA-FILE-ID=PC_WS_DEBUG_URL> */
    public final String webSocketDebuggerUrl;

    /** <EMBED CLASS='external-html' DATA-FILE-ID=PC_DEVTOOLS_URL> */
    public final String devtoolsFrontendUrl;

    /** <EMBED CLASS='external-html' DATA-FILE-ID=PC_FAVICON_URL> */
    public final String faviconUrl;


    // ********************************************************************************************
    // ********************************************************************************************
    // Package Private Constructors
    // ********************************************************************************************
    // ********************************************************************************************


    public PageConn(
            final String id,
            final String type,
            final String title,
            final String url,
            final String description,
            final String webSocketDebuggerUrl,
            final String devtoolsFrontendUrl,
            final String faviconUrl
        )
    {
        Objects.requireNonNull(webSocketDebuggerUrl, "webSocketDebuggerUrl is null");

        this.id                     = id;
        this.type                   = type;
        this.title                  = title;
        this.url                    = url;
        this.description            = description;
        this.webSocketDebuggerUrl   = webSocketDebuggerUrl;
        this.devtoolsFrontendUrl    = devtoolsFrontendUrl;
        this.faviconUrl             = faviconUrl;
    }

    public PageConn(JsonObject jo)
    {
        // Boolean #1: 'isOptional'
        //      FALSE   ==> throws if Missing
        //      TRUE    ==> Assigns Null if Missing
        // 
        // Boolean #2: 'throwOnNull'
        //      FALSE   ==> returns null if Json-Null has been passed
        //      TRUE    ==> throws if Json-Null has been passed

        this.id     = ReadJSON.getString(jo, "id",      false, true);
        this.type   = ReadJSON.getString(jo, "type",    false, true);
        this.title  = ReadJSON.getString(jo, "title",   true, false);
        this.url    = ReadJSON.getString(jo, "url",     false, true);
    
        this.description =
            ReadJSON.getString(jo, "description", true, false);
    
        this.webSocketDebuggerUrl =
            ReadJSON.getString(jo, "webSocketDebuggerUrl", false, true);
    
        this.devtoolsFrontendUrl =
            ReadJSON.getString(jo, "devtoolsFrontendUrl", true, false);
    
        this.faviconUrl =
            ReadJSON.getString(jo, "faviconUrl", true, false);
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Builder Methods
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Creates a {@link WebSocketSender} connected to the {@link #webSocketDebuggerUrl} for this
     * tab.  This URL is the endpoint that speaks the Chrome DevTools Protocol (CDP).
     * 
     * @param eventHandler          <EMBED CLASS='external-html' DATA-FILE-ID=PCBC_EVENT_H>
     * @param rdpErrorHandler       <EMBED CLASS='external-html' DATA-FILE-ID=PCBC_RDP_ERR_H>
     * @param browserErrorHandler   <EMBED CLASS='external-html' DATA-FILE-ID=PCBC_BROWSER_ERR_H>
     */
    public WebSocketSender createSender(
            final Consumer<BrowserEvent>    eventHandler,
            final Consumer<RDPError>        rdpErrorHandler,
            final Consumer<BrowserError>    browserErrorHandler
        )
        throws IOException, WebSocketException
    {
        return new WebSocketSender
            (this.webSocketDebuggerUrl, eventHandler, rdpErrorHandler, browserErrorHandler);
    }

    /**
     * Retrieves all pages from the CDP-RDP endpoint currently open on the named port.
     * This queries {@code /json/list} and returns a Java-{@code Stream} of the instnces of this 
     * class.
     *
     * @param port  The DevTools port Chrome is listening on (default is 9222 if {@code null}).
     * @param quiet If {@code TRUE}, output is shunted.
     * @return A list of all Open-Pages, as instances of {@code PageConn}
     */
    @LinkJavaSource(handle="PCBuilder")
    public static Stream<PageConn> getAllPageConn(Integer port, final boolean quiet)
    { return PCBuilder.getAllPageConn(port, quiet); }


    // ********************************************************************************************
    // ********************************************************************************************
    // java.lang.Object Methods
    // ********************************************************************************************
    // ********************************************************************************************


    @LinkJavaSource(handle="PCHelper", name="toString")
    public String toString() { return PCHelper.toString(this); }

    @LinkJavaSource(handle="PCHelper", name="hashCode")
    public int hashCode() { return PCHelper.hashCode(this); }

    @LinkJavaSource(handle="PCHelper", name="equals")
    public boolean equals(Object o) { return PCHelper.equals(this, o); }

    @LinkJavaSource(handle="PCHelper", name="clone")
    public PageConn clone() { return PCHelper.clone(this); }
}