|
@@ -1,15 +1,18 @@
|
|
|
-using System;
|
|
|
+#nullable enable
|
|
|
+
|
|
|
+using System;
|
|
|
+using System.Buffers;
|
|
|
+using System.IO.Pipelines;
|
|
|
+using System.Net;
|
|
|
using System.Net.WebSockets;
|
|
|
-using System.Text;
|
|
|
+using System.Text.Json;
|
|
|
using System.Threading;
|
|
|
using System.Threading.Tasks;
|
|
|
-using Emby.Server.Implementations.Net;
|
|
|
+using MediaBrowser.Common.Json;
|
|
|
using MediaBrowser.Controller.Net;
|
|
|
using MediaBrowser.Model.Net;
|
|
|
-using MediaBrowser.Model.Serialization;
|
|
|
using Microsoft.AspNetCore.Http;
|
|
|
using Microsoft.Extensions.Logging;
|
|
|
-using UtfUnknown;
|
|
|
|
|
|
namespace Emby.Server.Implementations.HttpServer
|
|
|
{
|
|
@@ -24,69 +27,50 @@ namespace Emby.Server.Implementations.HttpServer
|
|
|
private readonly ILogger _logger;
|
|
|
|
|
|
/// <summary>
|
|
|
- /// The json serializer.
|
|
|
+ /// The json serializer options.
|
|
|
/// </summary>
|
|
|
- private readonly IJsonSerializer _jsonSerializer;
|
|
|
+ private readonly JsonSerializerOptions _jsonOptions;
|
|
|
|
|
|
/// <summary>
|
|
|
/// The socket.
|
|
|
/// </summary>
|
|
|
- private readonly IWebSocket _socket;
|
|
|
+ private readonly WebSocket _socket;
|
|
|
|
|
|
/// <summary>
|
|
|
/// Initializes a new instance of the <see cref="WebSocketConnection" /> class.
|
|
|
/// </summary>
|
|
|
+ /// <param name="logger">The logger.</param>
|
|
|
/// <param name="socket">The socket.</param>
|
|
|
/// <param name="remoteEndPoint">The remote end point.</param>
|
|
|
- /// <param name="jsonSerializer">The json serializer.</param>
|
|
|
- /// <param name="logger">The logger.</param>
|
|
|
- /// <exception cref="ArgumentNullException">socket</exception>
|
|
|
- public WebSocketConnection(IWebSocket socket, string remoteEndPoint, IJsonSerializer jsonSerializer, ILogger logger)
|
|
|
+ /// <param name="query">The query.</param>
|
|
|
+ public WebSocketConnection(
|
|
|
+ ILogger<WebSocketConnection> logger,
|
|
|
+ WebSocket socket,
|
|
|
+ IPAddress? remoteEndPoint,
|
|
|
+ IQueryCollection query)
|
|
|
{
|
|
|
- if (socket == null)
|
|
|
- {
|
|
|
- throw new ArgumentNullException(nameof(socket));
|
|
|
- }
|
|
|
-
|
|
|
- if (string.IsNullOrEmpty(remoteEndPoint))
|
|
|
- {
|
|
|
- throw new ArgumentNullException(nameof(remoteEndPoint));
|
|
|
- }
|
|
|
-
|
|
|
- if (jsonSerializer == null)
|
|
|
- {
|
|
|
- throw new ArgumentNullException(nameof(jsonSerializer));
|
|
|
- }
|
|
|
-
|
|
|
- if (logger == null)
|
|
|
- {
|
|
|
- throw new ArgumentNullException(nameof(logger));
|
|
|
- }
|
|
|
-
|
|
|
- Id = Guid.NewGuid();
|
|
|
- _jsonSerializer = jsonSerializer;
|
|
|
+ _logger = logger;
|
|
|
_socket = socket;
|
|
|
- _socket.OnReceiveBytes = OnReceiveInternal;
|
|
|
-
|
|
|
RemoteEndPoint = remoteEndPoint;
|
|
|
- _logger = logger;
|
|
|
+ QueryString = query;
|
|
|
|
|
|
- socket.Closed += OnSocketClosed;
|
|
|
+ _jsonOptions = JsonDefaults.GetOptions();
|
|
|
+ LastActivityDate = DateTime.Now;
|
|
|
}
|
|
|
|
|
|
/// <inheritdoc />
|
|
|
- public event EventHandler<EventArgs> Closed;
|
|
|
+ public event EventHandler<EventArgs>? Closed;
|
|
|
|
|
|
/// <summary>
|
|
|
/// Gets or sets the remote end point.
|
|
|
/// </summary>
|
|
|
- public string RemoteEndPoint { get; private set; }
|
|
|
+ public IPAddress? RemoteEndPoint { get; }
|
|
|
|
|
|
/// <summary>
|
|
|
/// Gets or sets the receive action.
|
|
|
/// </summary>
|
|
|
/// <value>The receive action.</value>
|
|
|
- public Func<WebSocketMessageInfo, Task> OnReceive { get; set; }
|
|
|
+ public Func<WebSocketMessageInfo, Task>? OnReceive { get; set; }
|
|
|
|
|
|
/// <summary>
|
|
|
/// Gets the last activity date.
|
|
@@ -94,23 +78,11 @@ namespace Emby.Server.Implementations.HttpServer
|
|
|
/// <value>The last activity date.</value>
|
|
|
public DateTime LastActivityDate { get; private set; }
|
|
|
|
|
|
- /// <summary>
|
|
|
- /// Gets the id.
|
|
|
- /// </summary>
|
|
|
- /// <value>The id.</value>
|
|
|
- public Guid Id { get; private set; }
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets or sets the URL.
|
|
|
- /// </summary>
|
|
|
- /// <value>The URL.</value>
|
|
|
- public string Url { get; set; }
|
|
|
-
|
|
|
/// <summary>
|
|
|
/// Gets or sets the query string.
|
|
|
/// </summary>
|
|
|
/// <value>The query string.</value>
|
|
|
- public IQueryCollection QueryString { get; set; }
|
|
|
+ public IQueryCollection QueryString { get; }
|
|
|
|
|
|
/// <summary>
|
|
|
/// Gets the state.
|
|
@@ -118,138 +90,135 @@ namespace Emby.Server.Implementations.HttpServer
|
|
|
/// <value>The state.</value>
|
|
|
public WebSocketState State => _socket.State;
|
|
|
|
|
|
- void OnSocketClosed(object sender, EventArgs e)
|
|
|
+ /// <summary>
|
|
|
+ /// Sends a message asynchronously.
|
|
|
+ /// </summary>
|
|
|
+ /// <typeparam name="T"></typeparam>
|
|
|
+ /// <param name="message">The message.</param>
|
|
|
+ /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
+ /// <returns>Task.</returns>
|
|
|
+ public Task SendAsync<T>(WebSocketMessage<T> message, CancellationToken cancellationToken)
|
|
|
{
|
|
|
- Closed?.Invoke(this, EventArgs.Empty);
|
|
|
+ var json = JsonSerializer.SerializeToUtf8Bytes(message, _jsonOptions);
|
|
|
+ return _socket.SendAsync(json, WebSocketMessageType.Text, true, cancellationToken);
|
|
|
}
|
|
|
|
|
|
- /// <summary>
|
|
|
- /// Called when [receive].
|
|
|
- /// </summary>
|
|
|
- /// <param name="bytes">The bytes.</param>
|
|
|
- private void OnReceiveInternal(byte[] bytes)
|
|
|
+ /// <inheritdoc />
|
|
|
+ public async Task ProcessAsync(CancellationToken cancellationToken = default)
|
|
|
{
|
|
|
- LastActivityDate = DateTime.UtcNow;
|
|
|
+ var pipe = new Pipe();
|
|
|
+ var writer = pipe.Writer;
|
|
|
|
|
|
- if (OnReceive == null)
|
|
|
+ ValueWebSocketReceiveResult receiveresult;
|
|
|
+ do
|
|
|
{
|
|
|
- return;
|
|
|
- }
|
|
|
- var charset = CharsetDetector.DetectFromBytes(bytes).Detected?.EncodingName;
|
|
|
+ // Allocate at least 512 bytes from the PipeWriter
|
|
|
+ Memory<byte> memory = writer.GetMemory(512);
|
|
|
+ try
|
|
|
+ {
|
|
|
+ receiveresult = await _socket.ReceiveAsync(memory, cancellationToken);
|
|
|
+ }
|
|
|
+ catch (WebSocketException ex)
|
|
|
+ {
|
|
|
+ _logger.LogWarning("WS {IP} error receiving data: {Message}", RemoteEndPoint, ex.Message);
|
|
|
+ break;
|
|
|
+ }
|
|
|
|
|
|
- if (string.Equals(charset, "utf-8", StringComparison.OrdinalIgnoreCase))
|
|
|
- {
|
|
|
- OnReceiveInternal(Encoding.UTF8.GetString(bytes, 0, bytes.Length));
|
|
|
- }
|
|
|
- else
|
|
|
+ int bytesRead = receiveresult.Count;
|
|
|
+ if (bytesRead == 0)
|
|
|
+ {
|
|
|
+ break;
|
|
|
+ }
|
|
|
+
|
|
|
+ // Tell the PipeWriter how much was read from the Socket
|
|
|
+ writer.Advance(bytesRead);
|
|
|
+
|
|
|
+ // Make the data available to the PipeReader
|
|
|
+ FlushResult flushResult = await writer.FlushAsync();
|
|
|
+ if (flushResult.IsCompleted)
|
|
|
+ {
|
|
|
+ // The PipeReader stopped reading
|
|
|
+ break;
|
|
|
+ }
|
|
|
+
|
|
|
+ LastActivityDate = DateTime.UtcNow;
|
|
|
+
|
|
|
+ if (receiveresult.EndOfMessage)
|
|
|
+ {
|
|
|
+ await ProcessInternal(pipe.Reader).ConfigureAwait(false);
|
|
|
+ }
|
|
|
+ } while (
|
|
|
+ (_socket.State == WebSocketState.Open || _socket.State == WebSocketState.Connecting)
|
|
|
+ && receiveresult.MessageType != WebSocketMessageType.Close);
|
|
|
+
|
|
|
+ Closed?.Invoke(this, EventArgs.Empty);
|
|
|
+
|
|
|
+ if (_socket.State == WebSocketState.Open
|
|
|
+ || _socket.State == WebSocketState.CloseReceived
|
|
|
+ || _socket.State == WebSocketState.CloseSent)
|
|
|
{
|
|
|
- OnReceiveInternal(Encoding.ASCII.GetString(bytes, 0, bytes.Length));
|
|
|
+ await _socket.CloseAsync(
|
|
|
+ WebSocketCloseStatus.NormalClosure,
|
|
|
+ string.Empty,
|
|
|
+ cancellationToken).ConfigureAwait(false);
|
|
|
}
|
|
|
}
|
|
|
|
|
|
- private void OnReceiveInternal(string message)
|
|
|
+ private async Task ProcessInternal(PipeReader reader)
|
|
|
{
|
|
|
- LastActivityDate = DateTime.UtcNow;
|
|
|
-
|
|
|
- if (!message.StartsWith("{", StringComparison.OrdinalIgnoreCase))
|
|
|
- {
|
|
|
- // This info is useful sometimes but also clogs up the log
|
|
|
- _logger.LogDebug("Received web socket message that is not a json structure: {message}", message);
|
|
|
- return;
|
|
|
- }
|
|
|
+ ReadResult result = await reader.ReadAsync().ConfigureAwait(false);
|
|
|
+ ReadOnlySequence<byte> buffer = result.Buffer;
|
|
|
|
|
|
if (OnReceive == null)
|
|
|
{
|
|
|
+ // Tell the PipeReader how much of the buffer we have consumed
|
|
|
+ reader.AdvanceTo(buffer.End);
|
|
|
return;
|
|
|
}
|
|
|
|
|
|
+ WebSocketMessage<object> stub;
|
|
|
try
|
|
|
{
|
|
|
- var stub = (WebSocketMessage<object>)_jsonSerializer.DeserializeFromString(message, typeof(WebSocketMessage<object>));
|
|
|
|
|
|
- var info = new WebSocketMessageInfo
|
|
|
+ if (buffer.IsSingleSegment)
|
|
|
{
|
|
|
- MessageType = stub.MessageType,
|
|
|
- Data = stub.Data?.ToString(),
|
|
|
- Connection = this
|
|
|
- };
|
|
|
-
|
|
|
- OnReceive(info);
|
|
|
+ stub = JsonSerializer.Deserialize<WebSocketMessage<object>>(buffer.FirstSpan, _jsonOptions);
|
|
|
+ }
|
|
|
+ else
|
|
|
+ {
|
|
|
+ var buf = ArrayPool<byte>.Shared.Rent(Convert.ToInt32(buffer.Length));
|
|
|
+ try
|
|
|
+ {
|
|
|
+ buffer.CopyTo(buf);
|
|
|
+ stub = JsonSerializer.Deserialize<WebSocketMessage<object>>(buf, _jsonOptions);
|
|
|
+ }
|
|
|
+ finally
|
|
|
+ {
|
|
|
+ ArrayPool<byte>.Shared.Return(buf);
|
|
|
+ }
|
|
|
+ }
|
|
|
}
|
|
|
- catch (Exception ex)
|
|
|
+ catch (JsonException ex)
|
|
|
{
|
|
|
+ // Tell the PipeReader how much of the buffer we have consumed
|
|
|
+ reader.AdvanceTo(buffer.End);
|
|
|
_logger.LogError(ex, "Error processing web socket message");
|
|
|
- }
|
|
|
- }
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Sends a message asynchronously.
|
|
|
- /// </summary>
|
|
|
- /// <typeparam name="T"></typeparam>
|
|
|
- /// <param name="message">The message.</param>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">message</exception>
|
|
|
- public Task SendAsync<T>(WebSocketMessage<T> message, CancellationToken cancellationToken)
|
|
|
- {
|
|
|
- if (message == null)
|
|
|
- {
|
|
|
- throw new ArgumentNullException(nameof(message));
|
|
|
- }
|
|
|
-
|
|
|
- var json = _jsonSerializer.SerializeToString(message);
|
|
|
-
|
|
|
- return SendAsync(json, cancellationToken);
|
|
|
- }
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Sends a message asynchronously.
|
|
|
- /// </summary>
|
|
|
- /// <param name="buffer">The buffer.</param>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- public Task SendAsync(byte[] buffer, CancellationToken cancellationToken)
|
|
|
- {
|
|
|
- if (buffer == null)
|
|
|
- {
|
|
|
- throw new ArgumentNullException(nameof(buffer));
|
|
|
+ return;
|
|
|
}
|
|
|
|
|
|
- cancellationToken.ThrowIfCancellationRequested();
|
|
|
+ // Tell the PipeReader how much of the buffer we have consumed
|
|
|
+ reader.AdvanceTo(buffer.End);
|
|
|
|
|
|
- return _socket.SendAsync(buffer, true, cancellationToken);
|
|
|
- }
|
|
|
+ _logger.LogDebug("WS {IP} received message: {@Message}", RemoteEndPoint, stub);
|
|
|
|
|
|
- /// <inheritdoc />
|
|
|
- public Task SendAsync(string text, CancellationToken cancellationToken)
|
|
|
- {
|
|
|
- if (string.IsNullOrEmpty(text))
|
|
|
+ var info = new WebSocketMessageInfo
|
|
|
{
|
|
|
- throw new ArgumentNullException(nameof(text));
|
|
|
- }
|
|
|
+ MessageType = stub.MessageType,
|
|
|
+ Data = stub.Data?.ToString(), // Data can be null
|
|
|
+ Connection = this
|
|
|
+ };
|
|
|
|
|
|
- cancellationToken.ThrowIfCancellationRequested();
|
|
|
-
|
|
|
- return _socket.SendAsync(text, true, cancellationToken);
|
|
|
- }
|
|
|
-
|
|
|
- /// <inheritdoc />
|
|
|
- public void Dispose()
|
|
|
- {
|
|
|
- Dispose(true);
|
|
|
- GC.SuppressFinalize(this);
|
|
|
- }
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Releases unmanaged and - optionally - managed resources.
|
|
|
- /// </summary>
|
|
|
- /// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
|
|
- protected virtual void Dispose(bool dispose)
|
|
|
- {
|
|
|
- if (dispose)
|
|
|
- {
|
|
|
- _socket.Dispose();
|
|
|
- }
|
|
|
+ await OnReceive(info).ConfigureAwait(false);
|
|
|
}
|
|
|
}
|
|
|
}
|