/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * license agreements; and to You under the Apache License, version 2.0:
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * This file is part of the Apache Pekko project, which was derived from Akka.
 */

/*
 * Copyright (C) since 2016 Lightbend Inc. <https://www.lightbend.com>
 */

package org.apache.pekko.stream.connectors.unixdomainsocket
package javadsl

import java.nio.file.Path
import java.util.Optional
import java.util.concurrent.CompletionStage

import org.apache.pekko
import pekko.NotUsed
import pekko.actor.{ ClassicActorSystemProvider, ExtendedActorSystem, Extension, ExtensionId, ExtensionIdProvider }
import pekko.stream.javadsl.{ Flow, Source }
import pekko.stream.Materializer
import pekko.util.ByteString
import scala.jdk.FutureConverters._

import scala.concurrent.duration.Duration
import scala.jdk.OptionConverters._

object UnixDomainSocket extends ExtensionId[UnixDomainSocket] with ExtensionIdProvider {

  /**
   * Represents a prospective UnixDomainSocket server binding.
   */
  final class ServerBinding private[pekko] (delegate: scaladsl.UnixDomainSocket.ServerBinding) {

    /**
     * The local address of the endpoint bound by the materialization of the `connections` [[pekko.stream.javadsl.Source Source]].
     */
    def localAddress: UnixSocketAddress = delegate.localAddress

    /**
     * Asynchronously triggers the unbinding of the port that was bound by the materialization of the `connections`
     * [[pekko.stream.javadsl.Source Source]].
     *
     * The produced [[java.util.concurrent.CompletionStage]] is fulfilled when the unbinding has been completed.
     */
    def unbind(): CompletionStage[Unit] = delegate.unbind().asJava
  }

  /**
   * Represents an accepted incoming UnixDomainSocket connection.
   */
  final class IncomingConnection private[pekko] (delegate: scaladsl.UnixDomainSocket.IncomingConnection) {

    /**
     * The local address this connection is bound to.
     */
    def localAddress: UnixSocketAddress = delegate.localAddress

    /**
     * The remote address this connection is bound to.
     */
    def remoteAddress: UnixSocketAddress = delegate.remoteAddress

    /**
     * Handles the connection using the given flow, which is materialized exactly once and the respective
     * materialized value is returned.
     *
     * Convenience shortcut for: `flow.join(handler).run()`.
     */
    def handleWith[Mat](handler: Flow[ByteString, ByteString, Mat], materializer: Materializer): Mat =
      delegate.handleWith(handler.asScala)(materializer)

    /**
     * A flow representing the client on the other side of the connection.
     * This flow can be materialized only once.
     */
    def flow: Flow[ByteString, ByteString, NotUsed] = new Flow(delegate.flow)
  }

  /**
   * Represents a prospective outgoing UnixDomainSocket connection.
   */
  final class OutgoingConnection private[pekko] (delegate: scaladsl.UnixDomainSocket.OutgoingConnection) {

    /**
     * The remote address this connection is or will be bound to.
     */
    def remoteAddress: UnixSocketAddress = delegate.remoteAddress

    /**
     * The local address of the endpoint bound by the materialization of the connection materialization.
     */
    def localAddress: UnixSocketAddress = delegate.localAddress
  }

  /**
   * Get the UnixDomainSocket extension with the classic actors API.
   */
  override def get(system: pekko.actor.ActorSystem): UnixDomainSocket = super.apply(system)

  /**
   * Get the UnixDomainSocket extension with the new actors API.
   */
  override def get(system: ClassicActorSystemProvider): UnixDomainSocket = super.apply(system.classicSystem)

  def lookup: ExtensionId[? <: Extension] =
    UnixDomainSocket

  def createExtension(system: ExtendedActorSystem): UnixDomainSocket =
    new UnixDomainSocket(system)
}

final class UnixDomainSocket(system: ExtendedActorSystem) extends pekko.actor.Extension {
  import UnixDomainSocket._
  import scala.concurrent.ExecutionContext.parasitic

  private lazy val delegate: scaladsl.UnixDomainSocket = scaladsl.UnixDomainSocket.apply(system)

  /**
   * Creates a [[UnixDomainSocket.ServerBinding]] instance which represents a prospective UnixDomainSocket server binding on the given `endpoint`.
   *
   * Please note that the startup of the server is asynchronous, i.e. after materializing the enclosing
   * [[pekko.stream.scaladsl.RunnableGraph]] the server is not immediately available. Only after the materialized future
   * completes is the server ready to accept client connections.
   *
   * TODO: Support idleTimeout as per Tcp.
   *
   * @param path      The path to listen on
   * @param backlog   Controls the size of the connection backlog
   * @param halfClose
   *                  Controls whether the connection is kept open even after writing has been completed to the accepted
   *                  UnixDomainSocket connections.
   *                  If set to true, the connection will implement the UnixDomainSocket half-close mechanism, allowing the client to
   *                  write to the connection even after the server has finished writing. The UnixDomainSocket socket is only closed
   *                  after both the client and server finished writing.
   *                  If set to false, the connection will immediately closed once the server closes its write side,
   *                  independently whether the client is still attempting to write. This setting is recommended
   *                  for servers, and therefore it is the default setting.
   */
  def bind(path: Path, backlog: Int, halfClose: Boolean): Source[IncomingConnection, CompletionStage[ServerBinding]] =
    Source.fromGraph(
      delegate
        .bind(path, backlog, halfClose)
        .map(new IncomingConnection(_))
        .mapMaterializedValue(_.map(new ServerBinding(_))(parasitic).asJava))

  /**
   * Creates a [[UnixDomainSocket.ServerBinding]] without specifying options.
   * It represents a prospective UnixDomainSocket server binding on the given `endpoint`.
   *
   * Please note that the startup of the server is asynchronous, i.e. after materializing the enclosing
   * [[pekko.stream.scaladsl.RunnableGraph]] the server is not immediately available. Only after the materialized future
   * completes is the server ready to accept client connections.
   */
  def bind(path: Path): Source[IncomingConnection, CompletionStage[ServerBinding]] =
    Source.fromGraph(
      delegate
        .bind(path)
        .map(new IncomingConnection(_))
        .mapMaterializedValue(_.map(new ServerBinding(_))(parasitic).asJava))

  /**
   * Creates an [[UnixDomainSocket.OutgoingConnection]] instance representing a prospective UnixDomainSocket client connection to the given endpoint.
   *
   * Note that the ByteString chunk boundaries are not retained across the network,
   * to achieve application level chunks you have to introduce explicit framing in your streams,
   * for example using the [[pekko.stream.javadsl.Framing]] stages.
   *
   * TODO: Support idleTimeout as per Tcp.
   *
   * @param remoteAddress The remote address to connect to
   * @param localAddress  Optional local address for the connection
   * @param halfClose
   *                  Controls whether the connection is kept open even after writing has been completed to the accepted
   *                  UnixDomainSocket connections.
   *                  If set to true, the connection will implement the UnixDomainSocket half-close mechanism, allowing the server to
   *                  write to the connection even after the client has finished writing. The UnixDomainSocket socket is only closed
   *                  after both the client and server finished writing. This setting is recommended for clients and
   *                  therefore it is the default setting.
   *                  If set to false, the connection will immediately closed once the client closes its write side,
   *                  independently whether the server is still attempting to write.
   */
  def outgoingConnection(remoteAddress: UnixSocketAddress,
      localAddress: Optional[UnixSocketAddress],
      halfClose: Boolean,
      connectTimeout: Duration): Flow[ByteString, ByteString, CompletionStage[OutgoingConnection]] =
    Flow.fromGraph(
      delegate
        .outgoingConnection(remoteAddress, localAddress.toScala, halfClose, connectTimeout)
        .mapMaterializedValue(_.map(new OutgoingConnection(_))(parasitic).asJava))

  /**
   * Creates an [[UnixDomainSocket.OutgoingConnection]] without specifying options.
   * It represents a prospective UnixDomainSocket client connection to the given endpoint.
   *
   * TODO: Support idleTimeout as per Tcp.
   *
   * Note that the ByteString chunk boundaries are not retained across the network,
   * to achieve application level chunks you have to introduce explicit framing in your streams,
   * for example using the [[pekko.stream.javadsl.Framing]] stages.
   */
  def outgoingConnection(path: Path): Flow[ByteString, ByteString, CompletionStage[OutgoingConnection]] =
    Flow.fromGraph(
      delegate
        .outgoingConnection(new UnixSocketAddress(path))
        .mapMaterializedValue(_.map(new OutgoingConnection(_))(parasitic).asJava))

}
