alteropen/jellyfin
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin.git synced 2026-07-19 12:44:19 +01:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Replace ISocket and UdpSocket, fix DLNA and SSDP binding and discovery

Browse Source
This commit is contained in:
Shadowghost
2023-02-16 18:15:12 +01:00
parent 3a91c37283
commit 42498194d9
21 changed files with 289 additions and 557 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
RSSDP/ISsdpCommunicationsServer.cs
View File

@@ -23,12 +23,12 @@ namespace Rssdp.Infrastructure
/// <summary>
/// Causes the server to begin listening for multicast messages, being SSDP search requests and notifications.
/// </summary>
void BeginListeningForBroadcasts();
void BeginListeningForMulticast();
/// <summary>
/// Causes the server to stop listening for multicast messages, being SSDP search requests and notifications.
/// </summary>
void StopListeningForBroadcasts();
void StopListeningForMulticast();
/// <summary>
/// Sends a message to a particular address (uni or multicast) and port.

168
RSSDP/SsdpCommunicationsServer.cs
View File

@@ -25,18 +25,18 @@ namespace Rssdp.Infrastructure
* Since stopping the service would be a bad idea (might not be allowed security wise and might
* break other apps running on the system) the only other work around is to use two sockets.
*
* We use one socket to listen for/receive notifications and search requests (_BroadcastListenSocket).
* We use a second socket, bound to a different local port, to send search requests and listen for
* responses (_SendSocket). The responses are sent to the local port this socket is bound to,
* which isn't port 1900 so the MS service doesn't steal them. While the caller can specify a local
* We use one group of sockets to listen for/receive notifications and search requests (_MulticastListenSockets).
* We use a second group, bound to a different local port, to send search requests and listen for
* responses (_SendSockets). The responses are sent to the local ports these sockets are bound to,
* which aren't port 1900 so the MS service doesn't steal them. While the caller can specify a local
* port to use, we will default to 0 which allows the underlying system to auto-assign a free port.
*/
private object _BroadcastListenSocketSynchroniser = new object();
private List<ISocket> _BroadcastListenSockets;
private List<Socket> _MulticastListenSockets;
private object _SendSocketSynchroniser = new object();
private List<ISocket> _sendSockets;
private List<Socket> _sendSockets;
private HttpRequestParser _RequestParser;
private HttpResponseParser _ResponseParser;
@@ -78,7 +78,7 @@ namespace Rssdp.Infrastructure
/// <exception cref="ArgumentOutOfRangeException">The <paramref name="multicastTimeToLive"/> argument is less than or equal to zero.</exception>
public SsdpCommunicationsServer(ISocketFactory socketFactory, int localPort, int multicastTimeToLive, INetworkManager networkManager, ILogger logger, bool enableMultiSocketBinding)
{
if (socketFactory == null)
if (socketFactory is null)
{
throw new ArgumentNullException(nameof(socketFactory));
}
@@ -107,25 +107,25 @@ namespace Rssdp.Infrastructure
/// Causes the server to begin listening for multicast messages, being SSDP search requests and notifications.
/// </summary>
/// <exception cref="ObjectDisposedException">Thrown if the <see cref="DisposableManagedObjectBase.IsDisposed"/> property is true (because <seealso cref="DisposableManagedObjectBase.Dispose()" /> has been called previously).</exception>
public void BeginListeningForBroadcasts()
public void BeginListeningForMulticast()
{
ThrowIfDisposed();
lock (_BroadcastListenSocketSynchroniser)
{
if (_BroadcastListenSockets == null)
if (_MulticastListenSockets is null)
{
try
{
_BroadcastListenSockets = ListenForBroadcasts();
_MulticastListenSockets = CreateMulticastSocketsAndListen();
}
catch (SocketException ex)
{
_logger.LogError("Failed to bind to port 1900: {Message}. DLNA will be unavailable", ex.Message);
_logger.LogError("Failed to bind to multicast address: {Message}. DLNA will be unavailable", ex.Message);
}
catch (Exception ex)
{
_logger.LogError(ex, "Error in BeginListeningForBroadcasts");
_logger.LogError(ex, "Error in BeginListeningForMulticast");
}
}
}
@@ -135,15 +135,19 @@ namespace Rssdp.Infrastructure
/// Causes the server to stop listening for multicast messages, being SSDP search requests and notifications.
/// </summary>
/// <exception cref="ObjectDisposedException">Thrown if the <see cref="DisposableManagedObjectBase.IsDisposed"/> property is true (because <seealso cref="DisposableManagedObjectBase.Dispose()" /> has been called previously).</exception>
public void StopListeningForBroadcasts()
public void StopListeningForMulticast()
{
lock (_BroadcastListenSocketSynchroniser)
{
if (_BroadcastListenSockets != null)
if (_MulticastListenSockets is not null)
{
_logger.LogInformation("{0} disposing _BroadcastListenSocket", GetType().Name);
_BroadcastListenSockets.ForEach(s => s.Dispose());
_BroadcastListenSockets = null;
foreach (var socket in _MulticastListenSockets)
{
socket.Dispose();
}
_MulticastListenSockets = null;
}
}
}
@@ -153,7 +157,7 @@ namespace Rssdp.Infrastructure
/// </summary>
public async Task SendMessage(byte[] messageData, IPEndPoint destination, IPAddress fromLocalIpAddress, CancellationToken cancellationToken)
{
if (messageData == null)
if (messageData is null)
{
throw new ArgumentNullException(nameof(messageData));
}
@@ -177,11 +181,11 @@ namespace Rssdp.Infrastructure
}
}
private async Task SendFromSocket(ISocket socket, byte[] messageData, IPEndPoint destination, CancellationToken cancellationToken)
private async Task SendFromSocket(Socket socket, byte[] messageData, IPEndPoint destination, CancellationToken cancellationToken)
{
try
{
await socket.SendToAsync(messageData, 0, messageData.Length, destination, cancellationToken).ConfigureAwait(false);
await socket.SendToAsync(messageData, destination, cancellationToken).ConfigureAwait(false);
}
catch (ObjectDisposedException)
{
@@ -191,37 +195,42 @@ namespace Rssdp.Infrastructure
}
catch (Exception ex)
{
_logger.LogError(ex, "Error sending socket message from {0} to {1}", socket.LocalIPAddress.ToString(), destination.ToString());
var localIP = ((IPEndPoint)socket.LocalEndPoint).Address;
_logger.LogError(ex, "Error sending socket message from {0} to {1}", localIP.ToString(), destination.ToString());
}
}
private List<ISocket> GetSendSockets(IPAddress fromLocalIpAddress, IPEndPoint destination)
private List<Socket> GetSendSockets(IPAddress fromLocalIpAddress, IPEndPoint destination)
{
EnsureSendSocketCreated();
lock (_SendSocketSynchroniser)
{
var sockets = _sendSockets.Where(i => i.LocalIPAddress.AddressFamily == fromLocalIpAddress.AddressFamily);
var sockets = _sendSockets.Where(s => s.AddressFamily == fromLocalIpAddress.AddressFamily);
// Send from the Any socket and the socket with the matching address
if (fromLocalIpAddress.AddressFamily == AddressFamily.InterNetwork)
{
sockets = sockets.Where(i => i.LocalIPAddress.Equals(IPAddress.Any) || fromLocalIpAddress.Equals(i.LocalIPAddress));
sockets = sockets.Where(s => ((IPEndPoint)s.LocalEndPoint).Address.Equals(IPAddress.Any)
|| ((IPEndPoint)s.LocalEndPoint).Address.Equals(fromLocalIpAddress));
// If sending to the loopback address, filter the socket list as well
if (destination.Address.Equals(IPAddress.Loopback))
{
sockets = sockets.Where(i => i.LocalIPAddress.Equals(IPAddress.Any) || i.LocalIPAddress.Equals(IPAddress.Loopback));
sockets = sockets.Where(s => ((IPEndPoint)s.LocalEndPoint).Address.Equals(IPAddress.Any)
|| ((IPEndPoint)s.LocalEndPoint).Address.Equals(IPAddress.Loopback));
}
}
else if (fromLocalIpAddress.AddressFamily == AddressFamily.InterNetworkV6)
{
sockets = sockets.Where(i => i.LocalIPAddress.Equals(IPAddress.IPv6Any) || fromLocalIpAddress.Equals(i.LocalIPAddress));
sockets = sockets.Where(s => ((IPEndPoint)s.LocalEndPoint).Address.Equals(IPAddress.IPv6Any)
|| ((IPEndPoint)s.LocalEndPoint).Address.Equals(fromLocalIpAddress));
// If sending to the loopback address, filter the socket list as well
if (destination.Address.Equals(IPAddress.IPv6Loopback))
{
sockets = sockets.Where(i => i.LocalIPAddress.Equals(IPAddress.IPv6Any) || i.LocalIPAddress.Equals(IPAddress.IPv6Loopback));
sockets = sockets.Where(s => ((IPEndPoint)s.LocalEndPoint).Address.Equals(IPAddress.IPv6Any)
|| ((IPEndPoint)s.LocalEndPoint).Address.Equals(IPAddress.IPv6Loopback));
}
}
@@ -239,7 +248,7 @@ namespace Rssdp.Infrastructure
/// </summary>
public async Task SendMulticastMessage(string message, int sendCount, IPAddress fromLocalIpAddress, CancellationToken cancellationToken)
{
if (message == null)
if (message is null)
{
throw new ArgumentNullException(nameof(message));
}
@@ -275,7 +284,7 @@ namespace Rssdp.Infrastructure
{
lock (_SendSocketSynchroniser)
{
if (_sendSockets != null)
if (_sendSockets is not null)
{
var sockets = _sendSockets.ToList();
_sendSockets = null;
@@ -284,7 +293,8 @@ namespace Rssdp.Infrastructure
foreach (var socket in sockets)
{
_logger.LogInformation("{0} disposing sendSocket from {1}", GetType().Name, socket.LocalIPAddress);
var socketAddress = ((IPEndPoint)socket.LocalEndPoint).Address;
_logger.LogInformation("{0} disposing sendSocket from {1}", GetType().Name, socketAddress);
socket.Dispose();
}
}
@@ -312,7 +322,7 @@ namespace Rssdp.Infrastructure
{
if (disposing)
{
StopListeningForBroadcasts();
StopListeningForMulticast();
StopListeningForResponses();
}
@@ -321,11 +331,11 @@ namespace Rssdp.Infrastructure
private Task SendMessageIfSocketNotDisposed(byte[] messageData, IPEndPoint destination, IPAddress fromLocalIpAddress, CancellationToken cancellationToken)
{
var sockets = _sendSockets;
if (sockets != null)
if (sockets is not null)
{
sockets = sockets.ToList();
var tasks = sockets.Where(s => (fromLocalIpAddress == null || fromLocalIpAddress.Equals(s.LocalIPAddress)))
var tasks = sockets.Where(s => (fromLocalIpAddress is null || fromLocalIpAddress.Equals(((IPEndPoint)s.LocalEndPoint).Address)))
.Select(s => SendFromSocket(s, messageData, destination, cancellationToken));
return Task.WhenAll(tasks);
}
@@ -333,82 +343,78 @@ namespace Rssdp.Infrastructure
return Task.CompletedTask;
}
private List<ISocket> ListenForBroadcasts()
private List<Socket> CreateMulticastSocketsAndListen()
{
var sockets = new List<ISocket>();
var nonNullBindAddresses = _networkManager.GetInternalBindAddresses().Where(x => x.Address != null);
var sockets = new List<Socket>();
var multicastGroupAddress = IPAddress.Parse(SsdpConstants.MulticastLocalAdminAddress);
if (_enableMultiSocketBinding)
{
foreach (var address in nonNullBindAddresses)
{
if (address.AddressFamily == AddressFamily.InterNetworkV6)
{
// Not supporting IPv6 right now
continue;
}
// IPv6 is currently unsupported
var validInterfaces = _networkManager.GetInternalBindAddresses()
.Where(x => x.Address is not null)
.Where(x => x.AddressFamily == AddressFamily.InterNetwork)
.DistinctBy(x => x.Index);
foreach (var intf in validInterfaces)
{
try
{
sockets.Add(_SocketFactory.CreateUdpMulticastSocket(IPAddress.Parse(SsdpConstants.MulticastLocalAdminAddress), address.Address, _MulticastTtl, SsdpConstants.MulticastPort));
var socket = _SocketFactory.CreateUdpMulticastSocket(multicastGroupAddress, intf, _MulticastTtl, SsdpConstants.MulticastPort);
_ = ListenToSocketInternal(socket);
sockets.Add(socket);
}
catch (Exception ex)
{
_logger.LogError(ex, "Error in ListenForBroadcasts. IPAddress: {0}", address);
_logger.LogError(ex, "Error in CreateMulticastSocketsAndListen. IP address: {0}", intf.Address);
}
}
}
else
{
sockets.Add(_SocketFactory.CreateUdpMulticastSocket(IPAddress.Parse(SsdpConstants.MulticastLocalAdminAddress), IPAddress.Any, _MulticastTtl, SsdpConstants.MulticastPort));
}
foreach (var socket in sockets)
{
var socket = _SocketFactory.CreateUdpMulticastSocket(multicastGroupAddress, new IPData(IPAddress.Any, null), _MulticastTtl, SsdpConstants.MulticastPort);
_ = ListenToSocketInternal(socket);
sockets.Add(socket);
}
return sockets;
}
private List<ISocket> CreateSocketAndListenForResponsesAsync()
private List<Socket> CreateSendSockets()
{
var sockets = new List<ISocket>();
var sockets = new List<Socket>();
if (_enableMultiSocketBinding)
{
foreach (var address in _networkManager.GetInternalBindAddresses())
{
if (address.AddressFamily == AddressFamily.InterNetworkV6)
{
// Not supporting IPv6 right now
continue;
}
// IPv6 is currently unsupported
var validInterfaces = _networkManager.GetInternalBindAddresses()
.Where(x => x.Address is not null)
.Where(x => x.AddressFamily == AddressFamily.InterNetwork);
foreach (var intf in validInterfaces)
{
try
{
sockets.Add(_SocketFactory.CreateSsdpUdpSocket(address.Address, _LocalPort));
var socket = _SocketFactory.CreateSsdpUdpSocket(intf, _LocalPort);
_ = ListenToSocketInternal(socket);
sockets.Add(socket);
}
catch (Exception ex)
{
_logger.LogError(ex, "Error in CreateSsdpUdpSocket. IPAddress: {0}", address);
_logger.LogError(ex, "Error in CreateSsdpUdpSocket. IPAddress: {0}", intf.Address);
}
}
}
else
{
sockets.Add(_SocketFactory.CreateSsdpUdpSocket(IPAddress.Any, _LocalPort));
var socket = _SocketFactory.CreateSsdpUdpSocket(new IPData(IPAddress.Any, null), _LocalPort);
_ = ListenToSocketInternal(socket);
sockets.Add(socket);
}
foreach (var socket in sockets)
{
_ = ListenToSocketInternal(socket);
}
return sockets;
}
private async Task ListenToSocketInternal(ISocket socket)
private async Task ListenToSocketInternal(Socket socket)
{
var cancelled = false;
var receiveBuffer = new byte[8192];
@@ -417,14 +423,17 @@ namespace Rssdp.Infrastructure
{
try
{
var result = await socket.ReceiveAsync(receiveBuffer, 0, receiveBuffer.Length, CancellationToken.None).ConfigureAwait(false);
var result = await socket.ReceiveMessageFromAsync(receiveBuffer, SocketFlags.None, new IPEndPoint(IPAddress.Any, 0), CancellationToken.None).ConfigureAwait(false);;
if (result.ReceivedBytes > 0)
{
// Strange cannot convert compiler error here if I don't explicitly
// assign or cast to Action first. Assignment is easier to read,
// so went with that.
ProcessMessage(UTF8Encoding.UTF8.GetString(result.Buffer, 0, result.ReceivedBytes), result.RemoteEndPoint, result.LocalIPAddress);
var remoteEndpoint = (IPEndPoint)result.RemoteEndPoint;
var localEndpointAddress = result.PacketInformation.Address;
ProcessMessage(
UTF8Encoding.UTF8.GetString(receiveBuffer, 0, result.ReceivedBytes),
remoteEndpoint,
localEndpointAddress);
}
}
catch (ObjectDisposedException)
@@ -440,11 +449,11 @@ namespace Rssdp.Infrastructure
private void EnsureSendSocketCreated()
{
if (_sendSockets == null)
if (_sendSockets is null)
{
lock (_SendSocketSynchroniser)
{
_sendSockets ??= CreateSocketAndListenForResponsesAsync();
_sendSockets ??= CreateSendSockets();
}
}
}
@@ -455,6 +464,7 @@ namespace Rssdp.Infrastructure
// requests start with a method which can vary and might be one we haven't
// seen/don't know. We'll check if this message is a request or a response
// by checking for the HTTP/ prefix on the start of the message.
_logger.LogDebug("Received data from {From} on {Port} at {Address}:\n{Data}", endPoint.Address, endPoint.Port, receivedOnLocalIpAddress, data);
if (data.StartsWith("HTTP/", StringComparison.OrdinalIgnoreCase))
{
HttpResponseMessage responseMessage = null;
@@ -467,7 +477,7 @@ namespace Rssdp.Infrastructure
// Ignore invalid packets.
}
if (responseMessage != null)
if (responseMessage is not null)
{
OnResponseReceived(responseMessage, endPoint, receivedOnLocalIpAddress);
}
@@ -484,7 +494,7 @@ namespace Rssdp.Infrastructure
// Ignore invalid packets.
}
if (requestMessage != null)
if (requestMessage is not null)
{
OnRequestReceived(requestMessage, endPoint, receivedOnLocalIpAddress);
}
@@ -502,7 +512,7 @@ namespace Rssdp.Infrastructure
}
var handlers = this.RequestReceived;
if (handlers != null)
if (handlers is not null)
{
handlers(this, new RequestReceivedEventArgs(data, remoteEndPoint, receivedOnLocalIpAddress));
}
@@ -511,7 +521,7 @@ namespace Rssdp.Infrastructure
private void OnResponseReceived(HttpResponseMessage data, IPEndPoint endPoint, IPAddress localIpAddress)
{
var handlers = this.ResponseReceived;
if (handlers != null)
if (handlers is not null)
{
handlers(this, new ResponseReceivedEventArgs(data, endPoint)
{

2
RSSDP/SsdpConstants.cs
View File

@@ -26,6 +26,8 @@ namespace Rssdp.Infrastructure
internal const string SsdpDeviceDescriptionXmlNamespace = "urn:schemas-upnp-org:device-1-0";
internal const string ServerVersion = "1.0";
/// <summary>
/// Default buffer size for receiving SSDP broadcasts. Value is 8192 (bytes).
/// </summary>

74
RSSDP/SsdpDeviceLocator.cs
View File

@@ -1,11 +1,11 @@
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
namespace Rssdp.Infrastructure
{
/// <summary>
@@ -19,19 +19,48 @@ namespace Rssdp.Infrastructure
private Timer _BroadcastTimer;
private object _timerLock = new object();
private string _OSName;
private string _OSVersion;
private readonly TimeSpan DefaultSearchWaitTime = TimeSpan.FromSeconds(4);
private readonly TimeSpan OneSecond = TimeSpan.FromSeconds(1);
/// <summary>
/// Default constructor.
/// </summary>
public SsdpDeviceLocator(ISsdpCommunicationsServer communicationsServer)
public SsdpDeviceLocator(
ISsdpCommunicationsServer communicationsServer,
string osName,
string osVersion)
{
if (communicationsServer == null)
if (communicationsServer is null)
{
throw new ArgumentNullException(nameof(communicationsServer));
}
if (osName is null)
{
throw new ArgumentNullException(nameof(osName));
}
if (osName.Length == 0)
{
throw new ArgumentException("osName cannot be an empty string.", nameof(osName));
}
if (osVersion is null)
{
throw new ArgumentNullException(nameof(osVersion));
}
if (osVersion.Length == 0)
{
throw new ArgumentException("osVersion cannot be an empty string.", nameof(osName));
}
_OSName = osName;
_OSVersion = osVersion;
_CommunicationsServer = communicationsServer;
_CommunicationsServer.ResponseReceived += CommsServer_ResponseReceived;
@@ -72,7 +101,7 @@ namespace Rssdp.Infrastructure
{
lock (_timerLock)
{
if (_BroadcastTimer == null)
if (_BroadcastTimer is null)
{
_BroadcastTimer = new Timer(OnBroadcastTimerCallback, null, dueTime, period);
}
@@ -87,7 +116,7 @@ namespace Rssdp.Infrastructure
{
lock (_timerLock)
{
if (_BroadcastTimer != null)
if (_BroadcastTimer is not null)
{
_BroadcastTimer.Dispose();
_BroadcastTimer = null;
@@ -148,7 +177,7 @@ namespace Rssdp.Infrastructure
private Task SearchAsync(string searchTarget, TimeSpan searchWaitTime, CancellationToken cancellationToken)
{
if (searchTarget == null)
if (searchTarget is null)
{
throw new ArgumentNullException(nameof(searchTarget));
}
@@ -187,7 +216,7 @@ namespace Rssdp.Infrastructure
{
_CommunicationsServer.RequestReceived -= CommsServer_RequestReceived;
_CommunicationsServer.RequestReceived += CommsServer_RequestReceived;
_CommunicationsServer.BeginListeningForBroadcasts();
_CommunicationsServer.BeginListeningForMulticast();
}
/// <summary>
@@ -219,7 +248,7 @@ namespace Rssdp.Infrastructure
}
var handlers = this.DeviceAvailable;
if (handlers != null)
if (handlers is not null)
{
handlers(this, new DeviceAvailableEventArgs(device, isNewDevice)
{
@@ -242,7 +271,7 @@ namespace Rssdp.Infrastructure
}
var handlers = this.DeviceUnavailable;
if (handlers != null)
if (handlers is not null)
{
handlers(this, new DeviceUnavailableEventArgs(device, expired));
}
@@ -281,7 +310,7 @@ namespace Rssdp.Infrastructure
var commsServer = _CommunicationsServer;
_CommunicationsServer = null;
if (commsServer != null)
if (commsServer is not null)
{
commsServer.ResponseReceived -= this.CommsServer_ResponseReceived;
commsServer.RequestReceived -= this.CommsServer_RequestReceived;
@@ -295,7 +324,7 @@ namespace Rssdp.Infrastructure
lock (_Devices)
{
var existingDevice = FindExistingDeviceNotification(_Devices, device.NotificationType, device.Usn);
if (existingDevice == null)
if (existingDevice is null)
{
_Devices.Add(device);
isNewDevice = true;
@@ -329,12 +358,13 @@ namespace Rssdp.Infrastructure
private Task BroadcastDiscoverMessage(string serviceType, TimeSpan mxValue, CancellationToken cancellationToken)
{
const string header = "M-SEARCH * HTTP/1.1";
var values = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
values["HOST"] = "239.255.255.250:1900";
values["USER-AGENT"] = "UPnP/1.0 DLNADOC/1.50 Platinum/1.0.4.2";
// values["X-EMBY-SERVERID"] = _appHost.SystemId;
values["USER-AGENT"] = string.Format(CultureInfo.InvariantCulture, "{0}/{1} UPnP/1.0 RSSDP/{2}", _OSName, _OSVersion, SsdpConstants.ServerVersion);
values["MAN"] = "\"ssdp:discover\"";
// Search target
@@ -343,8 +373,6 @@ namespace Rssdp.Infrastructure
// Seconds to delay response
values["MX"] = "3";
var header = "M-SEARCH * HTTP/1.1";
var message = BuildMessage(header, values);
return _CommunicationsServer.SendMulticastMessage(message, null, cancellationToken);
@@ -358,7 +386,7 @@ namespace Rssdp.Infrastructure
}
var location = GetFirstHeaderUriValue("Location", message);
if (location != null)
if (location is not null)
{
var device = new DiscoveredSsdpDevice()
{
@@ -395,7 +423,7 @@ namespace Rssdp.Infrastructure
private void ProcessAliveNotification(HttpRequestMessage message, IPAddress IpAddress)
{
var location = GetFirstHeaderUriValue("Location", message);
if (location != null)
if (location is not null)
{
var device = new DiscoveredSsdpDevice()
{
@@ -445,7 +473,7 @@ namespace Rssdp.Infrastructure
if (message.Headers.Contains(headerName))
{
message.Headers.TryGetValues(headerName, out values);
if (values != null)
if (values is not null)
{
retVal = values.FirstOrDefault();
}
@@ -461,7 +489,7 @@ namespace Rssdp.Infrastructure
if (message.Headers.Contains(headerName))
{
message.Headers.TryGetValues(headerName, out values);
if (values != null)
if (values is not null)
{
retVal = values.FirstOrDefault();
}
@@ -477,7 +505,7 @@ namespace Rssdp.Infrastructure
if (request.Headers.Contains(headerName))
{
request.Headers.TryGetValues(headerName, out values);
if (values != null)
if (values is not null)
{
value = values.FirstOrDefault();
}
@@ -495,7 +523,7 @@ namespace Rssdp.Infrastructure
if (response.Headers.Contains(headerName))
{
response.Headers.TryGetValues(headerName, out values);
if (values != null)
if (values is not null)
{
value = values.FirstOrDefault();
}
@@ -508,7 +536,7 @@ namespace Rssdp.Infrastructure
private TimeSpan CacheAgeFromHeader(System.Net.Http.Headers.CacheControlHeaderValue headerValue)
{
if (headerValue == null)
if (headerValue is null)
{
return TimeSpan.Zero;
}
@@ -565,7 +593,7 @@ namespace Rssdp.Infrastructure
}
}
if (existingDevices != null && existingDevices.Count > 0)
if (existingDevices is not null && existingDevices.Count > 0)
{
foreach (var removedDevice in existingDevices)
{

64
RSSDP/SsdpDevicePublisher.cs
View File

@@ -4,10 +4,9 @@ using System.Collections.ObjectModel;
using System.Globalization;
using System.Linq;
using System.Net;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using MediaBrowser.Common.Net;
using Microsoft.AspNetCore.HttpOverrides;
namespace Rssdp.Infrastructure
{
@@ -32,8 +31,6 @@ namespace Rssdp.Infrastructure
private Random _Random;
private const string ServerVersion = "1.0";
/// <summary>
/// Default constructor.
/// </summary>
@@ -43,12 +40,12 @@ namespace Rssdp.Infrastructure
string osVersion,
bool sendOnlyMatchedHost)
{
if (communicationsServer == null)
if (communicationsServer is null)
{
throw new ArgumentNullException(nameof(communicationsServer));
}
if (osName == null)
if (osName is null)
{
throw new ArgumentNullException(nameof(osName));
}
@@ -58,7 +55,7 @@ namespace Rssdp.Infrastructure
throw new ArgumentException("osName cannot be an empty string.", nameof(osName));
}
if (osVersion == null)
if (osVersion is null)
{
throw new ArgumentNullException(nameof(osVersion));
}
@@ -80,10 +77,13 @@ namespace Rssdp.Infrastructure
_OSVersion = osVersion;
_sendOnlyMatchedHost = sendOnlyMatchedHost;
_CommsServer.BeginListeningForBroadcasts();
_CommsServer.BeginListeningForMulticast();
// Send alive notification once on creation
SendAllAliveNotifications(null);
}
public void StartBroadcastingAliveMessages(TimeSpan interval)
public void StartSendingAliveNotifications(TimeSpan interval)
{
_RebroadcastAliveNotificationsTimer = new Timer(SendAllAliveNotifications, null, TimeSpan.FromSeconds(5), interval);
}
@@ -99,10 +99,9 @@ namespace Rssdp.Infrastructure
/// <param name="device">The <see cref="SsdpDevice"/> instance to add.</param>
/// <exception cref="ArgumentNullException">Thrown if the <paramref name="device"/> argument is null.</exception>
/// <exception cref="InvalidOperationException">Thrown if the <paramref name="device"/> contains property values that are not acceptable to the UPnP 1.0 specification.</exception>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1804:RemoveUnusedLocals", MessageId = "t", Justification = "Capture task to local variable suppresses compiler warning, but task is not really needed.")]
public void AddDevice(SsdpRootDevice device)
{
if (device == null)
if (device is null)
{
throw new ArgumentNullException(nameof(device));
}
@@ -138,7 +137,7 @@ namespace Rssdp.Infrastructure
/// <exception cref="ArgumentNullException">Thrown if the <paramref name="device"/> argument is null.</exception>
public async Task RemoveDevice(SsdpRootDevice device)
{
if (device == null)
if (device is null)
{
throw new ArgumentNullException(nameof(device));
}
@@ -200,7 +199,7 @@ namespace Rssdp.Infrastructure
DisposeRebroadcastTimer();
var commsServer = _CommsServer;
if (commsServer != null)
if (commsServer is not null)
{
commsServer.RequestReceived -= this.CommsServer_RequestReceived;
}
@@ -209,7 +208,7 @@ namespace Rssdp.Infrastructure
Task.WaitAll(tasks);
_CommsServer = null;
if (commsServer != null)
if (commsServer is not null)
{
if (!commsServer.IsShared)
{
@@ -282,23 +281,23 @@ namespace Rssdp.Infrastructure
}
else if (searchTarget.Trim().StartsWith("uuid:", StringComparison.OrdinalIgnoreCase))
{
devices = (from device in GetAllDevicesAsFlatEnumerable() where String.Compare(device.Uuid, searchTarget.Substring(5), StringComparison.OrdinalIgnoreCase) == 0 select device).ToArray();
devices = GetAllDevicesAsFlatEnumerable().Where(d => String.Compare(d.Uuid, searchTarget.Substring(5), StringComparison.OrdinalIgnoreCase) == 0).ToArray();
}
else if (searchTarget.StartsWith("urn:", StringComparison.OrdinalIgnoreCase))
{
devices = (from device in GetAllDevicesAsFlatEnumerable() where String.Compare(device.FullDeviceType, searchTarget, StringComparison.OrdinalIgnoreCase) == 0 select device).ToArray();
devices = GetAllDevicesAsFlatEnumerable().Where(d => String.Compare(d.FullDeviceType, searchTarget, StringComparison.OrdinalIgnoreCase) == 0).ToArray();
}
}
if (devices != null)
if (devices is not null)
{
var deviceList = devices.ToList();
// WriteTrace(String.Format("Sending {0} search responses", deviceList.Count));
foreach (var device in deviceList)
foreach (var device in devices)
{
var root = device.ToRootDevice();
if (!_sendOnlyMatchedHost || root.Address.Equals(remoteEndPoint.Address))
if (!_sendOnlyMatchedHost || root.Address.Equals(receivedOnlocalIpAddress))
{
SendDeviceSearchResponses(device, remoteEndPoint, receivedOnlocalIpAddress, cancellationToken);
}
@@ -318,7 +317,7 @@ namespace Rssdp.Infrastructure
IPAddress receivedOnlocalIpAddress,
CancellationToken cancellationToken)
{
bool isRootDevice = (device as SsdpRootDevice) != null;
bool isRootDevice = (device as SsdpRootDevice) is not null;
if (isRootDevice)
{
SendSearchResponse(SsdpConstants.UpnpDeviceTypeRootDevice, device, GetUsn(device.Udn, SsdpConstants.UpnpDeviceTypeRootDevice), endPoint, receivedOnlocalIpAddress, cancellationToken);
@@ -346,19 +345,17 @@ namespace Rssdp.Infrastructure
IPAddress receivedOnlocalIpAddress,
CancellationToken cancellationToken)
{
var rootDevice = device.ToRootDevice();
// var additionalheaders = FormatCustomHeadersForResponse(device);
const string header = "HTTP/1.1 200 OK";
var rootDevice = device.ToRootDevice();
var values = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
values["EXT"] = "";
values["DATE"] = DateTime.UtcNow.ToString("r");
values["HOST"] = "239.255.255.250:1900";
values["CACHE-CONTROL"] = "max-age = " + rootDevice.CacheLifetime.TotalSeconds;
values["ST"] = searchTarget;
values["SERVER"] = string.Format(CultureInfo.InvariantCulture, "{0}/{1} UPnP/1.0 RSSDP/{2}", _OSName, _OSVersion, ServerVersion);
values["SERVER"] = string.Format(CultureInfo.InvariantCulture, "{0}/{1} UPnP/1.0 RSSDP/{2}", _OSName, _OSVersion, SsdpConstants.ServerVersion);
values["USN"] = uniqueServiceName;
values["LOCATION"] = rootDevice.Location.ToString();
@@ -367,7 +364,7 @@ namespace Rssdp.Infrastructure
try
{
await _CommsServer.SendMessage(
System.Text.Encoding.UTF8.GetBytes(message),
Encoding.UTF8.GetBytes(message),
endPoint,
receivedOnlocalIpAddress,
cancellationToken)
@@ -492,7 +489,7 @@ namespace Rssdp.Infrastructure
values["DATE"] = DateTime.UtcNow.ToString("r");
values["CACHE-CONTROL"] = "max-age = " + rootDevice.CacheLifetime.TotalSeconds;
values["LOCATION"] = rootDevice.Location.ToString();
values["SERVER"] = string.Format(CultureInfo.InvariantCulture, "{0}/{1} UPnP/1.0 RSSDP/{2}", _OSName, _OSVersion, ServerVersion);
values["SERVER"] = string.Format(CultureInfo.InvariantCulture, "{0}/{1} UPnP/1.0 RSSDP/{2}", _OSName, _OSVersion, SsdpConstants.ServerVersion);
values["NTS"] = "ssdp:alive";
values["NT"] = notificationType;
values["USN"] = uniqueServiceName;
@@ -527,7 +524,6 @@ namespace Rssdp.Infrastructure
return Task.WhenAll(tasks);
}
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA2204:Literals should be spelled correctly", MessageId = "byebye", Justification = "Correct value for this type of notification in SSDP.")]
private Task SendByeByeNotification(SsdpDevice device, string notificationType, string uniqueServiceName, CancellationToken cancellationToken)
{
const string header = "NOTIFY * HTTP/1.1";
@@ -537,7 +533,7 @@ namespace Rssdp.Infrastructure
// If needed later for non-server devices, these headers will need to be dynamic
values["HOST"] = "239.255.255.250:1900";
values["DATE"] = DateTime.UtcNow.ToString("r");
values["SERVER"] = string.Format(CultureInfo.InvariantCulture, "{0}/{1} UPnP/1.0 RSSDP/{2}", _OSName, _OSVersion, ServerVersion);
values["SERVER"] = string.Format(CultureInfo.InvariantCulture, "{0}/{1} UPnP/1.0 RSSDP/{2}", _OSName, _OSVersion, SsdpConstants.ServerVersion);
values["NTS"] = "ssdp:byebye";
values["NT"] = notificationType;
values["USN"] = uniqueServiceName;
@@ -553,7 +549,7 @@ namespace Rssdp.Infrastructure
{
var timer = _RebroadcastAliveNotificationsTimer;
_RebroadcastAliveNotificationsTimer = null;
if (timer != null)
if (timer is not null)
{
timer.Dispose();
}
@@ -581,7 +577,7 @@ namespace Rssdp.Infrastructure
{
string retVal = null;
IEnumerable<String> values = null;
if (httpRequestHeaders.TryGetValues(headerName, out values) && values != null)
if (httpRequestHeaders.TryGetValues(headerName, out values) && values is not null)
{
retVal = values.FirstOrDefault();
}
@@ -593,7 +589,7 @@ namespace Rssdp.Infrastructure
private void WriteTrace(string text)
{
if (LogFunction != null)
if (LogFunction is not null)
{
LogFunction(text);
}
@@ -603,7 +599,7 @@ namespace Rssdp.Infrastructure
private void WriteTrace(string text, SsdpDevice device)
{
var rootDevice = device as SsdpRootDevice;
if (rootDevice != null)
if (rootDevice is not null)
{
WriteTrace(text + " " + device.DeviceType + " - " + device.Uuid + " - " + rootDevice.Location);
}