Cutlery/jellyfin
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin.git synced 2025-05-30 19:55:08 -04:00
Code Issues Packages Projects Releases Wiki Activity

Use file-scoped namespaces in Jellyfin.Networking

Browse Source
This commit is contained in:
Patrick Barron 2023-11-30 12:26:37 -05:00
parent 1b821efcf2
commit eea676429b
6 changed files with 1400 additions and 1406 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

301
src/Jellyfin.Networking/ExternalPortForwarding.cs
View File

@ -16,181 +16,180 @@ using MediaBrowser.Controller.Plugins;
using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging;
using Mono.Nat; using Mono.Nat;
namespace Jellyfin.Networking namespace Jellyfin.Networking;
/// <summary>
/// Server entrypoint handling external port forwarding.
/// </summary>
public sealed class ExternalPortForwarding : IServerEntryPoint
{ {
private readonly IServerApplicationHost _appHost;
private readonly ILogger<ExternalPortForwarding> _logger;
private readonly IServerConfigurationManager _config;
private readonly ConcurrentDictionary<IPEndPoint, byte> _createdRules = new ConcurrentDictionary<IPEndPoint, byte>();
private Timer _timer;
private string _configIdentifier;
private bool _disposed;
/// <summary> /// <summary>
/// Server entrypoint handling external port forwarding. /// Initializes a new instance of the <see cref="ExternalPortForwarding"/> class.
/// </summary> /// </summary>
public sealed class ExternalPortForwarding : IServerEntryPoint /// <param name="logger">The logger.</param>
/// <param name="appHost">The application host.</param>
/// <param name="config">The configuration manager.</param>
public ExternalPortForwarding(
ILogger<ExternalPortForwarding> logger,
IServerApplicationHost appHost,
IServerConfigurationManager config)
{ {
private readonly IServerApplicationHost _appHost; _logger = logger;
private readonly ILogger<ExternalPortForwarding> _logger; _appHost = appHost;
private readonly IServerConfigurationManager _config; _config = config;
}
private readonly ConcurrentDictionary<IPEndPoint, byte> _createdRules = new ConcurrentDictionary<IPEndPoint, byte>(); private string GetConfigIdentifier()
{
const char Separator = '|';
var config = _config.GetNetworkConfiguration();
private Timer _timer; return new StringBuilder(32)
private string _configIdentifier; .Append(config.EnableUPnP).Append(Separator)
.Append(config.PublicHttpPort).Append(Separator)
.Append(config.PublicHttpsPort).Append(Separator)
.Append(_appHost.HttpPort).Append(Separator)
.Append(_appHost.HttpsPort).Append(Separator)
.Append(_appHost.ListenWithHttps).Append(Separator)
.Append(config.EnableRemoteAccess).Append(Separator)
.ToString();
}
private bool _disposed; private void OnConfigurationUpdated(object sender, EventArgs e)
{
var oldConfigIdentifier = _configIdentifier;
_configIdentifier = GetConfigIdentifier();
/// <summary> if (!string.Equals(_configIdentifier, oldConfigIdentifier, StringComparison.OrdinalIgnoreCase))
/// Initializes a new instance of the <see cref="ExternalPortForwarding"/> class.
/// </summary>
/// <param name="logger">The logger.</param>
/// <param name="appHost">The application host.</param>
/// <param name="config">The configuration manager.</param>
public ExternalPortForwarding(
ILogger<ExternalPortForwarding> logger,
IServerApplicationHost appHost,
IServerConfigurationManager config)
{
_logger = logger;
_appHost = appHost;
_config = config;
}
private string GetConfigIdentifier()
{
const char Separator = '|';
var config = _config.GetNetworkConfiguration();
return new StringBuilder(32)
.Append(config.EnableUPnP).Append(Separator)
.Append(config.PublicHttpPort).Append(Separator)
.Append(config.PublicHttpsPort).Append(Separator)
.Append(_appHost.HttpPort).Append(Separator)
.Append(_appHost.HttpsPort).Append(Separator)
.Append(_appHost.ListenWithHttps).Append(Separator)
.Append(config.EnableRemoteAccess).Append(Separator)
.ToString();
}
private void OnConfigurationUpdated(object sender, EventArgs e)
{
var oldConfigIdentifier = _configIdentifier;
_configIdentifier = GetConfigIdentifier();
if (!string.Equals(_configIdentifier, oldConfigIdentifier, StringComparison.OrdinalIgnoreCase))
{
Stop();
Start();
}
}
/// <inheritdoc />
public Task RunAsync()
{ {
Stop();
Start(); Start();
}
}
_config.ConfigurationUpdated += OnConfigurationUpdated; /// <inheritdoc />
public Task RunAsync()
{
Start();
_config.ConfigurationUpdated += OnConfigurationUpdated;
return Task.CompletedTask;
}
private void Start()
{
var config = _config.GetNetworkConfiguration();
if (!config.EnableUPnP || !config.EnableRemoteAccess)
{
return;
}
_logger.LogInformation("Starting NAT discovery");
NatUtility.DeviceFound += OnNatUtilityDeviceFound;
NatUtility.StartDiscovery();
_timer = new Timer((_) => _createdRules.Clear(), null, TimeSpan.FromMinutes(10), TimeSpan.FromMinutes(10));
}
private void Stop()
{
_logger.LogInformation("Stopping NAT discovery");
NatUtility.StopDiscovery();
NatUtility.DeviceFound -= OnNatUtilityDeviceFound;
_timer?.Dispose();
}
private async void OnNatUtilityDeviceFound(object sender, DeviceEventArgs e)
{
try
{
await CreateRules(e.Device).ConfigureAwait(false);
}
catch (Exception ex)
{
_logger.LogError(ex, "Error creating port forwarding rules");
}
}
private Task CreateRules(INatDevice device)
{
ObjectDisposedException.ThrowIf(_disposed, this);
// On some systems the device discovered event seems to fire repeatedly
// This check will help ensure we're not trying to port map the same device over and over
if (!_createdRules.TryAdd(device.DeviceEndpoint, 0))
{
return Task.CompletedTask; return Task.CompletedTask;
} }
private void Start() return Task.WhenAll(CreatePortMaps(device));
}
private IEnumerable<Task> CreatePortMaps(INatDevice device)
{
var config = _config.GetNetworkConfiguration();
yield return CreatePortMap(device, _appHost.HttpPort, config.PublicHttpPort);
if (_appHost.ListenWithHttps)
{ {
var config = _config.GetNetworkConfiguration(); yield return CreatePortMap(device, _appHost.HttpsPort, config.PublicHttpsPort);
if (!config.EnableUPnP || !config.EnableRemoteAccess)
{
return;
}
_logger.LogInformation("Starting NAT discovery");
NatUtility.DeviceFound += OnNatUtilityDeviceFound;
NatUtility.StartDiscovery();
_timer = new Timer((_) => _createdRules.Clear(), null, TimeSpan.FromMinutes(10), TimeSpan.FromMinutes(10));
} }
}
private void Stop() private async Task CreatePortMap(INatDevice device, int privatePort, int publicPort)
{
_logger.LogDebug(
"Creating port map on local port {LocalPort} to public port {PublicPort} with device {DeviceEndpoint}",
privatePort,
publicPort,
device.DeviceEndpoint);
try
{ {
_logger.LogInformation("Stopping NAT discovery"); var mapping = new Mapping(Protocol.Tcp, privatePort, publicPort, 0, _appHost.Name);
await device.CreatePortMapAsync(mapping).ConfigureAwait(false);
NatUtility.StopDiscovery();
NatUtility.DeviceFound -= OnNatUtilityDeviceFound;
_timer?.Dispose();
} }
catch (Exception ex)
private async void OnNatUtilityDeviceFound(object sender, DeviceEventArgs e)
{ {
try _logger.LogError(
{ ex,
await CreateRules(e.Device).ConfigureAwait(false); "Error creating port map on local port {LocalPort} to public port {PublicPort} with device {DeviceEndpoint}.",
}
catch (Exception ex)
{
_logger.LogError(ex, "Error creating port forwarding rules");
}
}
private Task CreateRules(INatDevice device)
{
ObjectDisposedException.ThrowIf(_disposed, this);
// On some systems the device discovered event seems to fire repeatedly
// This check will help ensure we're not trying to port map the same device over and over
if (!_createdRules.TryAdd(device.DeviceEndpoint, 0))
{
return Task.CompletedTask;
}
return Task.WhenAll(CreatePortMaps(device));
}
private IEnumerable<Task> CreatePortMaps(INatDevice device)
{
var config = _config.GetNetworkConfiguration();
yield return CreatePortMap(device, _appHost.HttpPort, config.PublicHttpPort);
if (_appHost.ListenWithHttps)
{
yield return CreatePortMap(device, _appHost.HttpsPort, config.PublicHttpsPort);
}
}
private async Task CreatePortMap(INatDevice device, int privatePort, int publicPort)
{
_logger.LogDebug(
"Creating port map on local port {LocalPort} to public port {PublicPort} with device {DeviceEndpoint}",
privatePort, privatePort,
publicPort, publicPort,
device.DeviceEndpoint); device.DeviceEndpoint);
try
{
var mapping = new Mapping(Protocol.Tcp, privatePort, publicPort, 0, _appHost.Name);
await device.CreatePortMapAsync(mapping).ConfigureAwait(false);
}
catch (Exception ex)
{
_logger.LogError(
ex,
"Error creating port map on local port {LocalPort} to public port {PublicPort} with device {DeviceEndpoint}.",
privatePort,
publicPort,
device.DeviceEndpoint);
}
}
/// <inheritdoc />
public void Dispose()
{
if (_disposed)
{
return;
}
_config.ConfigurationUpdated -= OnConfigurationUpdated;
Stop();
_timer?.Dispose();
_timer = null;
_disposed = true;
} }
} }
/// <inheritdoc />
public void Dispose()
{
if (_disposed)
{
return;
}
_config.ConfigurationUpdated -= OnConfigurationUpdated;
Stop();
_timer?.Dispose();
_timer = null;
_disposed = true;
}
} }

145
src/Jellyfin.Networking/HappyEyeballs/HttpClientExtension.cs
View File

@ -30,91 +30,90 @@ using System.Net.Sockets;
using System.Threading; using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
namespace Jellyfin.Networking.HappyEyeballs namespace Jellyfin.Networking.HappyEyeballs;
/// <summary>
/// Defines the <see cref="HttpClientExtension"/> class.
///
/// Implementation taken from https://github.com/ppy/osu-framework/pull/4191 .
/// </summary>
public static class HttpClientExtension
{ {
/// <summary> /// <summary>
/// Defines the <see cref="HttpClientExtension"/> class. /// Gets or sets a value indicating whether the client should use IPv6.
///
/// Implementation taken from https://github.com/ppy/osu-framework/pull/4191 .
/// </summary> /// </summary>
public static class HttpClientExtension public static bool UseIPv6 { get; set; } = true;
/// <summary>
/// Implements the httpclient callback method.
/// </summary>
/// <param name="context">The <see cref="SocketsHttpConnectionContext"/> instance.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> instance.</param>
/// <returns>The http steam.</returns>
public static async ValueTask<Stream> OnConnect(SocketsHttpConnectionContext context, CancellationToken cancellationToken)
{ {
/// <summary> if (!UseIPv6)
/// Gets or sets a value indicating whether the client should use IPv6.
/// </summary>
public static bool UseIPv6 { get; set; } = true;
/// <summary>
/// Implements the httpclient callback method.
/// </summary>
/// <param name="context">The <see cref="SocketsHttpConnectionContext"/> instance.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> instance.</param>
/// <returns>The http steam.</returns>
public static async ValueTask<Stream> OnConnect(SocketsHttpConnectionContext context, CancellationToken cancellationToken)
{ {
if (!UseIPv6) return await AttemptConnection(AddressFamily.InterNetwork, context, cancellationToken).ConfigureAwait(false);
{
return await AttemptConnection(AddressFamily.InterNetwork, context, cancellationToken).ConfigureAwait(false);
}
using var cancelIPv6 = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
var tryConnectAsyncIPv6 = AttemptConnection(AddressFamily.InterNetworkV6, context, cancelIPv6.Token);
// GetAwaiter().GetResult() is used instead of .Result as this results in improved exception handling.
// The tasks have already been completed.
// See https://github.com/dotnet/corefx/pull/29792/files#r189415885 for more details.
if (await Task.WhenAny(tryConnectAsyncIPv6, Task.Delay(200, cancelIPv6.Token)).ConfigureAwait(false) == tryConnectAsyncIPv6 && tryConnectAsyncIPv6.IsCompletedSuccessfully)
{
await cancelIPv6.CancelAsync().ConfigureAwait(false);
return tryConnectAsyncIPv6.GetAwaiter().GetResult();
}
using var cancelIPv4 = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
var tryConnectAsyncIPv4 = AttemptConnection(AddressFamily.InterNetwork, context, cancelIPv4.Token);
if (await Task.WhenAny(tryConnectAsyncIPv6, tryConnectAsyncIPv4).ConfigureAwait(false) == tryConnectAsyncIPv6)
{
if (tryConnectAsyncIPv6.IsCompletedSuccessfully)
{
await cancelIPv4.CancelAsync().ConfigureAwait(false);
return tryConnectAsyncIPv6.GetAwaiter().GetResult();
}
return tryConnectAsyncIPv4.GetAwaiter().GetResult();
}
else
{
if (tryConnectAsyncIPv4.IsCompletedSuccessfully)
{
await cancelIPv6.CancelAsync().ConfigureAwait(false);
return tryConnectAsyncIPv4.GetAwaiter().GetResult();
}
return tryConnectAsyncIPv6.GetAwaiter().GetResult();
}
} }
private static async Task<Stream> AttemptConnection(AddressFamily addressFamily, SocketsHttpConnectionContext context, CancellationToken cancellationToken) using var cancelIPv6 = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
{ var tryConnectAsyncIPv6 = AttemptConnection(AddressFamily.InterNetworkV6, context, cancelIPv6.Token);
// The following socket constructor will create a dual-mode socket on systems where IPV6 is available.
var socket = new Socket(addressFamily, SocketType.Stream, ProtocolType.Tcp)
{
// Turn off Nagle's algorithm since it degrades performance in most HttpClient scenarios.
NoDelay = true
};
try // GetAwaiter().GetResult() is used instead of .Result as this results in improved exception handling.
// The tasks have already been completed.
// See https://github.com/dotnet/corefx/pull/29792/files#r189415885 for more details.
if (await Task.WhenAny(tryConnectAsyncIPv6, Task.Delay(200, cancelIPv6.Token)).ConfigureAwait(false) == tryConnectAsyncIPv6 && tryConnectAsyncIPv6.IsCompletedSuccessfully)
{
await cancelIPv6.CancelAsync().ConfigureAwait(false);
return tryConnectAsyncIPv6.GetAwaiter().GetResult();
}
using var cancelIPv4 = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
var tryConnectAsyncIPv4 = AttemptConnection(AddressFamily.InterNetwork, context, cancelIPv4.Token);
if (await Task.WhenAny(tryConnectAsyncIPv6, tryConnectAsyncIPv4).ConfigureAwait(false) == tryConnectAsyncIPv6)
{
if (tryConnectAsyncIPv6.IsCompletedSuccessfully)
{ {
await socket.ConnectAsync(context.DnsEndPoint, cancellationToken).ConfigureAwait(false); await cancelIPv4.CancelAsync().ConfigureAwait(false);
// The stream should take the ownership of the underlying socket, return tryConnectAsyncIPv6.GetAwaiter().GetResult();
// closing it when it's disposed.
return new NetworkStream(socket, ownsSocket: true);
} }
catch
return tryConnectAsyncIPv4.GetAwaiter().GetResult();
}
else
{
if (tryConnectAsyncIPv4.IsCompletedSuccessfully)
{ {
socket.Dispose(); await cancelIPv6.CancelAsync().ConfigureAwait(false);
throw; return tryConnectAsyncIPv4.GetAwaiter().GetResult();
} }
return tryConnectAsyncIPv6.GetAwaiter().GetResult();
}
}
private static async Task<Stream> AttemptConnection(AddressFamily addressFamily, SocketsHttpConnectionContext context, CancellationToken cancellationToken)
{
// The following socket constructor will create a dual-mode socket on systems where IPV6 is available.
var socket = new Socket(addressFamily, SocketType.Stream, ProtocolType.Tcp)
{
// Turn off Nagle's algorithm since it degrades performance in most HttpClient scenarios.
NoDelay = true
};
try
{
await socket.ConnectAsync(context.DnsEndPoint, cancellationToken).ConfigureAwait(false);
// The stream should take the ownership of the underlying socket,
// closing it when it's disposed.
return new NetworkStream(socket, ownsSocket: true);
}
catch
{
socket.Dispose();
throw;
} }
} }
} }

1893
src/Jellyfin.Networking/Manager/NetworkManager.cs
View File

File diff suppressed because it is too large Load Diff

49
src/Jellyfin.Networking/Udp/SocketFactory.cs
View File

@ -3,37 +3,36 @@ using System.Net;
using System.Net.Sockets; using System.Net.Sockets;
using MediaBrowser.Model.Net; using MediaBrowser.Model.Net;
namespace Jellyfin.Networking.Udp namespace Jellyfin.Networking.Udp;
/// <summary>
/// Factory class to create different kinds of sockets.
/// </summary>
public class SocketFactory : ISocketFactory
{ {
/// <summary> /// <inheritdoc />
/// Factory class to create different kinds of sockets. public Socket CreateUdpBroadcastSocket(int localPort)
/// </summary>
public class SocketFactory : ISocketFactory
{ {
/// <inheritdoc /> if (localPort < 0)
public Socket CreateUdpBroadcastSocket(int localPort)
{ {
if (localPort < 0) throw new ArgumentException("localPort cannot be less than zero.", nameof(localPort));
{ }
throw new ArgumentException("localPort cannot be less than zero.", nameof(localPort));
}
var socket = new Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp); var socket = new Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp);
try try
{ {
socket.EnableBroadcast = true; socket.EnableBroadcast = true;
socket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.ReuseAddress, true); socket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.ReuseAddress, true);
socket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Broadcast, 1); socket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Broadcast, 1);
socket.Bind(new IPEndPoint(IPAddress.Any, localPort)); socket.Bind(new IPEndPoint(IPAddress.Any, localPort));
return socket; return socket;
} }
catch catch
{ {
socket.Dispose(); socket.Dispose();
throw; throw;
}
} }
} }
} }

197
src/Jellyfin.Networking/Udp/UdpServer.cs
View File

@ -11,127 +11,126 @@ using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging;
using static MediaBrowser.Controller.Extensions.ConfigurationExtensions; using static MediaBrowser.Controller.Extensions.ConfigurationExtensions;
namespace Jellyfin.Networking.Udp namespace Jellyfin.Networking.Udp;
/// <summary>
/// Provides a Udp Server.
/// </summary>
public sealed class UdpServer : IDisposable
{ {
/// <summary> /// <summary>
/// Provides a Udp Server. /// The _logger.
/// </summary> /// </summary>
public sealed class UdpServer : IDisposable private readonly ILogger _logger;
private readonly IServerApplicationHost _appHost;
private readonly IConfiguration _config;
private readonly byte[] _receiveBuffer = new byte[8192];
private readonly Socket _udpSocket;
private readonly IPEndPoint _endpoint;
private bool _disposed;
/// <summary>
/// Initializes a new instance of the <see cref="UdpServer" /> class.
/// </summary>
/// <param name="logger">The logger.</param>
/// <param name="appHost">The application host.</param>
/// <param name="configuration">The configuration manager.</param>
/// <param name="bindAddress"> The bind address.</param>
/// <param name="port">The port.</param>
public UdpServer(
ILogger logger,
IServerApplicationHost appHost,
IConfiguration configuration,
IPAddress bindAddress,
int port)
{ {
/// <summary> _logger = logger;
/// The _logger. _appHost = appHost;
/// </summary> _config = configuration;
private readonly ILogger _logger;
private readonly IServerApplicationHost _appHost;
private readonly IConfiguration _config;
private readonly byte[] _receiveBuffer = new byte[8192]; _endpoint = new IPEndPoint(bindAddress, port);
private readonly Socket _udpSocket; _udpSocket = new Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp)
private readonly IPEndPoint _endpoint;
private bool _disposed;
/// <summary>
/// Initializes a new instance of the <see cref="UdpServer" /> class.
/// </summary>
/// <param name="logger">The logger.</param>
/// <param name="appHost">The application host.</param>
/// <param name="configuration">The configuration manager.</param>
/// <param name="bindAddress"> The bind address.</param>
/// <param name="port">The port.</param>
public UdpServer(
ILogger logger,
IServerApplicationHost appHost,
IConfiguration configuration,
IPAddress bindAddress,
int port)
{ {
_logger = logger; MulticastLoopback = false,
_appHost = appHost; };
_config = configuration; _udpSocket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.ReuseAddress, true);
}
_endpoint = new IPEndPoint(bindAddress, port); private async Task RespondToV2Message(EndPoint endpoint, CancellationToken cancellationToken)
{
_udpSocket = new Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp) string? localUrl = _config[AddressOverrideKey];
{ if (string.IsNullOrEmpty(localUrl))
MulticastLoopback = false, {
}; localUrl = _appHost.GetSmartApiUrl(((IPEndPoint)endpoint).Address);
_udpSocket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.ReuseAddress, true);
} }
private async Task RespondToV2Message(EndPoint endpoint, CancellationToken cancellationToken) if (string.IsNullOrEmpty(localUrl))
{ {
string? localUrl = _config[AddressOverrideKey]; _logger.LogWarning("Unable to respond to server discovery request because the local ip address could not be determined.");
if (string.IsNullOrEmpty(localUrl)) return;
{ }
localUrl = _appHost.GetSmartApiUrl(((IPEndPoint)endpoint).Address);
}
if (string.IsNullOrEmpty(localUrl)) var response = new ServerDiscoveryInfo(localUrl, _appHost.SystemId, _appHost.FriendlyName);
{
_logger.LogWarning("Unable to respond to server discovery request because the local ip address could not be determined.");
return;
}
var response = new ServerDiscoveryInfo(localUrl, _appHost.SystemId, _appHost.FriendlyName); try
{
_logger.LogDebug("Sending AutoDiscovery response");
await _udpSocket.SendToAsync(JsonSerializer.SerializeToUtf8Bytes(response), SocketFlags.None, endpoint, cancellationToken).ConfigureAwait(false);
}
catch (SocketException ex)
{
_logger.LogError(ex, "Error sending response message");
}
}
/// <summary>
/// Starts the specified port.
/// </summary>
/// <param name="cancellationToken">The cancellation token to cancel operation.</param>
public void Start(CancellationToken cancellationToken)
{
_udpSocket.Bind(_endpoint);
_ = Task.Run(async () => await BeginReceiveAsync(cancellationToken).ConfigureAwait(false), cancellationToken).ConfigureAwait(false);
}
private async Task BeginReceiveAsync(CancellationToken cancellationToken)
{
while (!cancellationToken.IsCancellationRequested)
{
try try
{ {
_logger.LogDebug("Sending AutoDiscovery response"); var endpoint = (EndPoint)new IPEndPoint(IPAddress.Any, 0);
await _udpSocket.SendToAsync(JsonSerializer.SerializeToUtf8Bytes(response), SocketFlags.None, endpoint, cancellationToken).ConfigureAwait(false); var result = await _udpSocket.ReceiveFromAsync(_receiveBuffer, endpoint, cancellationToken).ConfigureAwait(false);
var text = Encoding.UTF8.GetString(_receiveBuffer, 0, result.ReceivedBytes);
if (text.Contains("who is JellyfinServer?", StringComparison.OrdinalIgnoreCase))
{
await RespondToV2Message(result.RemoteEndPoint, cancellationToken).ConfigureAwait(false);
}
} }
catch (SocketException ex) catch (SocketException ex)
{ {
_logger.LogError(ex, "Error sending response message"); _logger.LogError(ex, "Failed to receive data from socket");
} }
} catch (OperationCanceledException)
/// <summary>
/// Starts the specified port.
/// </summary>
/// <param name="cancellationToken">The cancellation token to cancel operation.</param>
public void Start(CancellationToken cancellationToken)
{
_udpSocket.Bind(_endpoint);
_ = Task.Run(async () => await BeginReceiveAsync(cancellationToken).ConfigureAwait(false), cancellationToken).ConfigureAwait(false);
}
private async Task BeginReceiveAsync(CancellationToken cancellationToken)
{
while (!cancellationToken.IsCancellationRequested)
{ {
try _logger.LogDebug("Broadcast socket operation cancelled");
{
var endpoint = (EndPoint)new IPEndPoint(IPAddress.Any, 0);
var result = await _udpSocket.ReceiveFromAsync(_receiveBuffer, endpoint, cancellationToken).ConfigureAwait(false);
var text = Encoding.UTF8.GetString(_receiveBuffer, 0, result.ReceivedBytes);
if (text.Contains("who is JellyfinServer?", StringComparison.OrdinalIgnoreCase))
{
await RespondToV2Message(result.RemoteEndPoint, cancellationToken).ConfigureAwait(false);
}
}
catch (SocketException ex)
{
_logger.LogError(ex, "Failed to receive data from socket");
}
catch (OperationCanceledException)
{
_logger.LogDebug("Broadcast socket operation cancelled");
}
} }
} }
}
/// <inheritdoc />
public void Dispose() /// <inheritdoc />
{ public void Dispose()
if (_disposed) {
{ if (_disposed)
return; {
} return;
}
_udpSocket.Dispose();
_disposed = true; _udpSocket.Dispose();
} _disposed = true;
} }
} }

221
src/Jellyfin.Networking/UdpServerEntryPoint.cs
View File

@ -13,132 +13,131 @@ using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging;
using IConfigurationManager = MediaBrowser.Common.Configuration.IConfigurationManager; using IConfigurationManager = MediaBrowser.Common.Configuration.IConfigurationManager;
namespace Jellyfin.Networking namespace Jellyfin.Networking;
/// <summary>
/// Class responsible for registering all UDP broadcast endpoints and their handlers.
/// </summary>
public sealed class UdpServerEntryPoint : IServerEntryPoint
{ {
/// <summary> /// <summary>
/// Class responsible for registering all UDP broadcast endpoints and their handlers. /// The port of the UDP server.
/// </summary> /// </summary>
public sealed class UdpServerEntryPoint : IServerEntryPoint public const int PortNumber = 7359;
/// <summary>
/// The logger.
/// </summary>
private readonly ILogger<UdpServerEntryPoint> _logger;
private readonly IServerApplicationHost _appHost;
private readonly IConfiguration _config;
private readonly IConfigurationManager _configurationManager;
private readonly INetworkManager _networkManager;
/// <summary>
/// The UDP server.
/// </summary>
private readonly List<UdpServer> _udpServers;
private readonly CancellationTokenSource _cancellationTokenSource = new CancellationTokenSource();
private bool _disposed;
/// <summary>
/// Initializes a new instance of the <see cref="UdpServerEntryPoint" /> class.
/// </summary>
/// <param name="logger">Instance of the <see cref="ILogger{UdpServerEntryPoint}"/> interface.</param>
/// <param name="appHost">Instance of the <see cref="IServerApplicationHost"/> interface.</param>
/// <param name="configuration">Instance of the <see cref="IConfiguration"/> interface.</param>
/// <param name="configurationManager">Instance of the <see cref="IConfigurationManager"/> interface.</param>
/// <param name="networkManager">Instance of the <see cref="INetworkManager"/> interface.</param>
public UdpServerEntryPoint(
ILogger<UdpServerEntryPoint> logger,
IServerApplicationHost appHost,
IConfiguration configuration,
IConfigurationManager configurationManager,
INetworkManager networkManager)
{ {
/// <summary> _logger = logger;
/// The port of the UDP server. _appHost = appHost;
/// </summary> _config = configuration;
public const int PortNumber = 7359; _configurationManager = configurationManager;
_networkManager = networkManager;
_udpServers = new List<UdpServer>();
}
/// <summary> /// <inheritdoc />
/// The logger. public Task RunAsync()
/// </summary> {
private readonly ILogger<UdpServerEntryPoint> _logger; ObjectDisposedException.ThrowIf(_disposed, this);
private readonly IServerApplicationHost _appHost;
private readonly IConfiguration _config;
private readonly IConfigurationManager _configurationManager;
private readonly INetworkManager _networkManager;
/// <summary> if (!_configurationManager.GetNetworkConfiguration().AutoDiscovery)
/// The UDP server.
/// </summary>
private readonly List<UdpServer> _udpServers;
private readonly CancellationTokenSource _cancellationTokenSource = new CancellationTokenSource();
private bool _disposed;
/// <summary>
/// Initializes a new instance of the <see cref="UdpServerEntryPoint" /> class.
/// </summary>
/// <param name="logger">Instance of the <see cref="ILogger{UdpServerEntryPoint}"/> interface.</param>
/// <param name="appHost">Instance of the <see cref="IServerApplicationHost"/> interface.</param>
/// <param name="configuration">Instance of the <see cref="IConfiguration"/> interface.</param>
/// <param name="configurationManager">Instance of the <see cref="IConfigurationManager"/> interface.</param>
/// <param name="networkManager">Instance of the <see cref="INetworkManager"/> interface.</param>
public UdpServerEntryPoint(
ILogger<UdpServerEntryPoint> logger,
IServerApplicationHost appHost,
IConfiguration configuration,
IConfigurationManager configurationManager,
INetworkManager networkManager)
{ {
_logger = logger;
_appHost = appHost;
_config = configuration;
_configurationManager = configurationManager;
_networkManager = networkManager;
_udpServers = new List<UdpServer>();
}
/// <inheritdoc />
public Task RunAsync()
{
ObjectDisposedException.ThrowIf(_disposed, this);
if (!_configurationManager.GetNetworkConfiguration().AutoDiscovery)
{
return Task.CompletedTask;
}
try
{
// Linux needs to bind to the broadcast addresses to get broadcast traffic
// Windows receives broadcast fine when binding to just the interface, it is unable to bind to broadcast addresses
if (OperatingSystem.IsLinux())
{
// Add global broadcast listener
var server = new UdpServer(_logger, _appHost, _config, IPAddress.Broadcast, PortNumber);
server.Start(_cancellationTokenSource.Token);
_udpServers.Add(server);
// Add bind address specific broadcast listeners
// IPv6 is currently unsupported
var validInterfaces = _networkManager.GetInternalBindAddresses().Where(i => i.AddressFamily == AddressFamily.InterNetwork);
foreach (var intf in validInterfaces)
{
var broadcastAddress = NetworkUtils.GetBroadcastAddress(intf.Subnet);
_logger.LogDebug("Binding UDP server to {Address} on port {PortNumber}", broadcastAddress, PortNumber);
server = new UdpServer(_logger, _appHost, _config, broadcastAddress, PortNumber);
server.Start(_cancellationTokenSource.Token);
_udpServers.Add(server);
}
}
else
{
// Add bind address specific broadcast listeners
// IPv6 is currently unsupported
var validInterfaces = _networkManager.GetInternalBindAddresses().Where(i => i.AddressFamily == AddressFamily.InterNetwork);
foreach (var intf in validInterfaces)
{
var intfAddress = intf.Address;
_logger.LogDebug("Binding UDP server to {Address} on port {PortNumber}", intfAddress, PortNumber);
var server = new UdpServer(_logger, _appHost, _config, intfAddress, PortNumber);
server.Start(_cancellationTokenSource.Token);
_udpServers.Add(server);
}
}
}
catch (SocketException ex)
{
_logger.LogWarning(ex, "Unable to start AutoDiscovery listener on UDP port {PortNumber}", PortNumber);
}
return Task.CompletedTask; return Task.CompletedTask;
} }
/// <inheritdoc /> try
public void Dispose()
{ {
if (_disposed) // Linux needs to bind to the broadcast addresses to get broadcast traffic
// Windows receives broadcast fine when binding to just the interface, it is unable to bind to broadcast addresses
if (OperatingSystem.IsLinux())
{ {
return; // Add global broadcast listener
} var server = new UdpServer(_logger, _appHost, _config, IPAddress.Broadcast, PortNumber);
server.Start(_cancellationTokenSource.Token);
_udpServers.Add(server);
_cancellationTokenSource.Cancel(); // Add bind address specific broadcast listeners
_cancellationTokenSource.Dispose(); // IPv6 is currently unsupported
foreach (var server in _udpServers) var validInterfaces = _networkManager.GetInternalBindAddresses().Where(i => i.AddressFamily == AddressFamily.InterNetwork);
foreach (var intf in validInterfaces)
{
var broadcastAddress = NetworkUtils.GetBroadcastAddress(intf.Subnet);
_logger.LogDebug("Binding UDP server to {Address} on port {PortNumber}", broadcastAddress, PortNumber);
server = new UdpServer(_logger, _appHost, _config, broadcastAddress, PortNumber);
server.Start(_cancellationTokenSource.Token);
_udpServers.Add(server);
}
}
else
{ {
server.Dispose(); // Add bind address specific broadcast listeners
} // IPv6 is currently unsupported
var validInterfaces = _networkManager.GetInternalBindAddresses().Where(i => i.AddressFamily == AddressFamily.InterNetwork);
foreach (var intf in validInterfaces)
{
var intfAddress = intf.Address;
_logger.LogDebug("Binding UDP server to {Address} on port {PortNumber}", intfAddress, PortNumber);
_udpServers.Clear(); var server = new UdpServer(_logger, _appHost, _config, intfAddress, PortNumber);
_disposed = true; server.Start(_cancellationTokenSource.Token);
_udpServers.Add(server);
}
}
} }
catch (SocketException ex)
{
_logger.LogWarning(ex, "Unable to start AutoDiscovery listener on UDP port {PortNumber}", PortNumber);
}
return Task.CompletedTask;
}
/// <inheritdoc />
public void Dispose()
{
if (_disposed)
{
return;
}
_cancellationTokenSource.Cancel();
_cancellationTokenSource.Dispose();
foreach (var server in _udpServers)
{
server.Dispose();
}
_udpServers.Clear();
_disposed = true;
} }
} }