/*

 * Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package jdk.internal.net.http.websocket;

import jdk.internal.net.http.common.Demand;

import jdk.internal.net.http.common.MinimalFuture;

import jdk.internal.net.http.common.SequentialScheduler;

import jdk.internal.net.http.common.SequentialScheduler.CompleteRestartableTask;

import jdk.internal.net.http.common.Utils;

import java.io.IOException;

import java.lang.System.Logger.Level;

import java.nio.ByteBuffer;

import java.nio.CharBuffer;

import java.nio.channels.SelectionKey;

import java.util.concurrent.CompletableFuture;

import java.util.concurrent.atomic.AtomicLong;

import java.util.concurrent.atomic.AtomicReference;

import java.util.function.BiConsumer;

import java.util.function.Supplier;

import static jdk.internal.net.http.websocket.TransportImpl.ChannelState.AVAILABLE;

import static jdk.internal.net.http.websocket.TransportImpl.ChannelState.CLOSED;

import static jdk.internal.net.http.websocket.TransportImpl.ChannelState.UNREGISTERED;

import static jdk.internal.net.http.websocket.TransportImpl.ChannelState.WAITING;

public class TransportImpl implements Transport {

    // -- Debugging infrastructure --

    private static final boolean DEBUG = Utils.DEBUG_WS;

    private static final System.Logger debug =

            Utils.getWebSocketLogger("[Transport]"::toString, DEBUG);

    /* Used for correlating enters to and exists from a method */

    private final AtomicLong counter = new AtomicLong();

    private final SequentialScheduler sendScheduler = new SequentialScheduler(new SendTask());

    private final MessageQueue queue = new MessageQueue();

    private final MessageEncoder encoder = new MessageEncoder();

    /* A reusable buffer for writing, initially with no remaining bytes */

    private final ByteBuffer dst = createWriteBuffer().position(0).limit(0);

    /* This array is created once for gathering writes accepted by RawChannel */

    private final ByteBuffer[] dstArray = new ByteBuffer[]{dst};

    private final MessageStreamConsumer messageConsumer;

    private final MessageDecoder decoder;

    private final Frame.Reader reader = new Frame.Reader();

    private final Demand demand = new Demand();

    private final SequentialScheduler receiveScheduler;

    private final RawChannel channel;

    private final Object closeLock = new Object();

    private final RawChannel.RawEvent writeEvent = new WriteEvent();

    private final RawChannel.RawEvent readEvent = new ReadEvent();

    private final AtomicReference<ChannelState> writeState

            = new AtomicReference<>(UNREGISTERED);

    private ByteBuffer data;

    private volatile ChannelState readState = UNREGISTERED;

    private boolean inputClosed;

    private boolean outputClosed;

    public TransportImpl(MessageStreamConsumer consumer, RawChannel channel) {

        this.messageConsumer = consumer;

        this.channel = channel;

        this.decoder = new MessageDecoder(this.messageConsumer);

        this.data = channel.initialByteBuffer();

        // To ensure the initial non-final `data` will be visible

        // (happens-before) when `readEvent.handle()` invokes `receiveScheduler`

        // the following assignment is done last:

        receiveScheduler = new SequentialScheduler(new ReceiveTask());

    }

    private ByteBuffer createWriteBuffer() {

        String name = "jdk.httpclient.websocket.writeBufferSize";

        int capacity = Utils.getIntegerNetProperty(name, 16384);

        debug.log(Level.DEBUG, "write buffer capacity %s%n", capacity);

        // TODO (optimization?): allocateDirect if SSL?

        return ByteBuffer.allocate(capacity);

    }

    private boolean write() throws IOException {

        long count = channel.write(dstArray, 0, dstArray.length);

        for (ByteBuffer b : dstArray) {

            if (b.hasRemaining()) {

                return false;

            }

        }

        return true;

    }

    @Override

    public <T> CompletableFuture<T> sendText(CharSequence message,

                                             boolean isLast,

                                             T attachment,

                                             BiConsumer<? super T, ? super Throwable> action) {

        long id = 0;

        if (debug.isLoggable(Level.DEBUG)) {

            id = counter.incrementAndGet();

                              id, message.length(), isLast);

        }

        // TODO (optimization?):

        // These sendXXX methods might be a good place to decide whether or not

        // we can write straight ahead, possibly returning null instead of

        // creating a CompletableFuture

        // Even if the text is already CharBuffer, the client will not be happy

        // if they discover the position is changing. So, no instanceof

        // cheating, wrap always.

        CharBuffer text = CharBuffer.wrap(message);

        MinimalFuture<T> f = new MinimalFuture<>();

        try {

            queue.addText(text, isLast, attachment, action, f);

            sendScheduler.runOrSchedule();

        } catch (IOException e) {

            f.completeExceptionally(e);

        }

        return f;

    }

    @Override

    public <T> CompletableFuture<T> sendBinary(ByteBuffer message,

                                               boolean isLast,

                                               T attachment,

                                               BiConsumer<? super T, ? super Throwable> action) {

        long id = 0;

        if (debug.isLoggable(Level.DEBUG)) {

            id = counter.incrementAndGet();

                              id, message.remaining(), isLast);

        }

        MinimalFuture<T> f = new MinimalFuture<>();

        try {

            queue.addBinary(message, isLast, attachment, action, f);

            sendScheduler.runOrSchedule();

        } catch (IOException e) {

            f.completeExceptionally(e);

        }

        return f;

    }

    @Override

    public <T> CompletableFuture<T> sendPing(ByteBuffer message,

                                             T attachment,

                                             BiConsumer<? super T, ? super Throwable> action) {

        long id = 0;

        if (debug.isLoggable(Level.DEBUG)) {

            id = counter.incrementAndGet();

                              id, message.remaining());

        }

        MinimalFuture<T> f = new MinimalFuture<>();

        try {

            queue.addPing(message, attachment, action, f);

            sendScheduler.runOrSchedule();

        } catch (IOException e) {

            f.completeExceptionally(e);

        }

        return f;

    }

    @Override

    public <T> CompletableFuture<T> sendPong(ByteBuffer message,

                                             T attachment,

                                             BiConsumer<? super T, ? super Throwable> action) {

        long id = 0;

        if (debug.isLoggable(Level.DEBUG)) {

            id = counter.incrementAndGet();

                              id, message.remaining());

        }

        MinimalFuture<T> f = new MinimalFuture<>();

        try {

            queue.addPong(message, attachment, action, f);

            sendScheduler.runOrSchedule();

        } catch (IOException e) {

            f.completeExceptionally(e);

        }

        return f;

    }

    @Override

    public <T> CompletableFuture<T> sendPong(Supplier<? extends ByteBuffer> message,

                                             T attachment,

                                             BiConsumer<? super T, ? super Throwable> action) {

        long id = 0;

        if (debug.isLoggable(Level.DEBUG)) {

            id = counter.incrementAndGet();

                      id, message);

        }

        MinimalFuture<T> f = new MinimalFuture<>();

        try {

            queue.addPong(message, attachment, action, f);

            sendScheduler.runOrSchedule();

        } catch (IOException e) {

            f.completeExceptionally(e);

        }

        return f;

    }

    @Override

    public <T> CompletableFuture<T> sendClose(int statusCode,

                                              String reason,

                                              T attachment,

                                              BiConsumer<? super T, ? super Throwable> action) {

        long id = 0;

        if (debug.isLoggable(Level.DEBUG)) {

            id = counter.incrementAndGet();

            debug.log(Level.DEBUG, "enter send close %s statusCode=%s, reason.length()=%s",

                              id, statusCode, reason.length());

        }

        MinimalFuture<T> f = new MinimalFuture<>();

        try {

            queue.addClose(statusCode, CharBuffer.wrap(reason), attachment, action, f);

            sendScheduler.runOrSchedule();

        } catch (IOException e) {

            f.completeExceptionally(e);

        }

        debug.log(Level.DEBUG, "exit send close %s returned %s", id, f);

        return f;

    }

    @Override

    public void request(long n) {

        debug.log(Level.DEBUG, "request %s", n);

        if (demand.increase(n)) {

            receiveScheduler.runOrSchedule();

        }

    }

    @Override

    public void acknowledgeReception() {

        boolean decremented = demand.tryDecrement();

        if (!decremented) {

            throw new InternalError();

        }

    }

    @Override

    public void closeOutput() throws IOException {

        debug.log(Level.DEBUG, "closeOutput");

        synchronized (closeLock) {

            if (!outputClosed) {

                outputClosed = true;

                try {

                    channel.shutdownOutput();

                } finally {

                    if (inputClosed) {

                        channel.close();

                    }

                }

            }

        }

        writeState.set(CLOSED);

        sendScheduler.runOrSchedule();

    }

    /*

     * Permanently stops reading from the channel and delivering messages

     * regardless of the current demand and data availability.

     */

    @Override

    public void closeInput() throws IOException {

        debug.log(Level.DEBUG, "closeInput");

        synchronized (closeLock) {

            if (!inputClosed) {

                inputClosed = true;

                try {

                    receiveScheduler.stop();

                    channel.shutdownInput();

                } finally {

                    if (outputClosed) {

                        channel.close();

                    }

                }

            }

        }

    }

    /* Common states for send and receive tasks */

    enum ChannelState {

        UNREGISTERED,

        AVAILABLE,

        WAITING,

        CLOSED,

    }

    @SuppressWarnings({"rawtypes"})

    private class SendTask extends CompleteRestartableTask {

        private final MessageQueue.QueueCallback<Boolean, IOException>

                encodingCallback = new MessageQueue.QueueCallback<>() {

            @Override

            public <T> Boolean onText(CharBuffer message,

                                      boolean isLast,

                                      T attachment,

                                      BiConsumer<? super T, ? super Throwable> action,

                                      CompletableFuture<? super T> future) throws IOException

            {

                return encoder.encodeText(message, isLast, dst);

            }

            @Override

            public <T> Boolean onBinary(ByteBuffer message,

                                        boolean isLast,

                                        T attachment,

                                        BiConsumer<? super T, ? super Throwable> action,

                                        CompletableFuture<? super T> future) throws IOException

            {

                return encoder.encodeBinary(message, isLast, dst);

            }

            @Override

            public <T> Boolean onPing(ByteBuffer message,

                                      T attachment,

                                      BiConsumer<? super T, ? super Throwable> action,

                                      CompletableFuture<? super T> future) throws IOException

            {

                return encoder.encodePing(message, dst);

            }

            @Override

            public <T> Boolean onPong(ByteBuffer message,

                                      T attachment,

                                      BiConsumer<? super T, ? super Throwable> action,

                                      CompletableFuture<? super T> future) throws IOException

            {

                return encoder.encodePong(message, dst);

            }

            @Override

            public <T> Boolean onPong(Supplier<? extends ByteBuffer> message,

                                      T attachment,

                                      BiConsumer<? super T, ? super Throwable> action,

                                      CompletableFuture<? super T> future) throws IOException {

                return encoder.encodePong(message.get(), dst);

            }

            @Override

            public <T> Boolean onClose(int statusCode,

                                       CharBuffer reason,

                                       T attachment,

                                       BiConsumer<? super T, ? super Throwable> action,

                                       CompletableFuture<? super T> future) throws IOException

            {

                return encoder.encodeClose(statusCode, reason, dst);

            }

            @Override

            public Boolean onEmpty() {

                return false;

            }

        };

        /* Whether the task sees the current head message for first time */

        private boolean firstPass = true;

        /* Whether the message has been fully encoded */

        private boolean encoded;

        // -- Current message completion communication fields --

        private Object attachment;

        private BiConsumer action;

        private CompletableFuture future;

        private final MessageQueue.QueueCallback<Boolean, RuntimeException>

                /* If there is a message, loads its completion communication fields */

                loadCallback = new MessageQueue.QueueCallback<Boolean, RuntimeException>() {

            @Override

            public <T> Boolean onText(CharBuffer message,

                                      boolean isLast,

                                      T attachment,

                                      BiConsumer<? super T, ? super Throwable> action,

                                      CompletableFuture<? super T> future)

            {

                SendTask.this.attachment = attachment;

                SendTask.this.action = action;

                SendTask.this.future = future;

                return true;

            }

            @Override

            public <T> Boolean onBinary(ByteBuffer message,

                                        boolean isLast,

                                        T attachment,

                                        BiConsumer<? super T, ? super Throwable> action,

                                        CompletableFuture<? super T> future)

            {

                SendTask.this.attachment = attachment;

                SendTask.this.action = action;

                SendTask.this.future = future;

                return true;

            }

            @Override

            public <T> Boolean onPing(ByteBuffer message,

                                      T attachment,

                                      BiConsumer<? super T, ? super Throwable> action,

                                      CompletableFuture<? super T> future)

            {

                SendTask.this.attachment = attachment;

                SendTask.this.action = action;

                SendTask.this.future = future;

                return true;

            }

            @Override

            public <T> Boolean onPong(ByteBuffer message,

                                      T attachment,

                                      BiConsumer<? super T, ? super Throwable> action,

                                      CompletableFuture<? super T> future)

            {

                SendTask.this.attachment = attachment;

                SendTask.this.action = action;

                SendTask.this.future = future;

                return true;

            }

            @Override

            public <T> Boolean onPong(Supplier<? extends ByteBuffer> message,

                                      T attachment,

                                      BiConsumer<? super T, ? super Throwable> action,

                                      CompletableFuture<? super T> future)

            {

                SendTask.this.attachment = attachment;

                SendTask.this.action = action;

                SendTask.this.future = future;

                return true;

            }

            @Override

            public <T> Boolean onClose(int statusCode,

                                       CharBuffer reason,

                                       T attachment,

                                       BiConsumer<? super T, ? super Throwable> action,

                                       CompletableFuture<? super T> future)

            {

                SendTask.this.attachment = attachment;

                SendTask.this.action = action;

                SendTask.this.future = future;

                return true;

            }

            @Override

            public Boolean onEmpty() {

                return false;

            }

        };

        @Override

        public void run() {

            // Could have been only called in one of the following cases:

            //   (a) A message has been added to the queue

            //   (b) The channel is ready for writing

            debug.log(Level.DEBUG, "enter send task");

            while (!queue.isEmpty()) {

                try {

                    if (dst.hasRemaining()) {

                        debug.log(Level.DEBUG, "%s bytes in buffer",

                                              dst.remaining());