jellyfin-server/Mono.Nat/Upnp/UpnpNatDevice.cs

211 lines
8.6 KiB
C#
Raw Normal View History

2016-09-11 07:33:53 +00:00
//
// Authors:
// Alan McGovern alan.mcgovern@gmail.com
// Ben Motmans <ben.motmans@gmail.com>
//
// Copyright (C) 2006 Alan McGovern
// Copyright (C) 2007 Ben Motmans
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.IO;
using System.Net;
using System.Xml;
using System.Text;
using System.Diagnostics;
2016-10-28 01:07:40 +00:00
using System.Threading.Tasks;
using MediaBrowser.Common.Net;
2016-10-27 23:53:57 +00:00
using MediaBrowser.Model.Logging;
2016-10-29 18:59:36 +00:00
using MediaBrowser.Model.Dlna;
2016-09-11 07:33:53 +00:00
namespace Mono.Nat.Upnp
{
2016-10-28 01:07:40 +00:00
public sealed class UpnpNatDevice : AbstractNatDevice, IEquatable<UpnpNatDevice>
{
private EndPoint hostEndPoint;
private IPAddress localAddress;
private string serviceDescriptionUrl;
private string controlUrl;
private string serviceType;
2016-10-27 23:53:57 +00:00
private readonly ILogger _logger;
2016-10-28 01:07:40 +00:00
private readonly IHttpClient _httpClient;
2016-09-11 07:33:53 +00:00
2016-10-27 23:53:57 +00:00
public override IPAddress LocalAddress
2016-10-28 01:07:40 +00:00
{
get { return localAddress; }
}
2016-09-11 07:33:53 +00:00
2016-10-28 01:07:40 +00:00
internal UpnpNatDevice(IPAddress localAddress, UpnpDeviceInfo deviceInfo, IPEndPoint hostEndPoint, string serviceType, ILogger logger, IHttpClient httpClient)
2016-09-11 07:33:53 +00:00
{
this.LastSeen = DateTime.Now;
this.localAddress = localAddress;
// Split the string at the "location" section so i can extract the ipaddress and service description url
string locationDetails = deviceInfo.Location.ToString();
this.serviceType = serviceType;
2016-10-27 23:53:57 +00:00
_logger = logger;
2016-10-28 01:07:40 +00:00
_httpClient = httpClient;
2016-09-11 07:33:53 +00:00
// Make sure we have no excess whitespace
locationDetails = locationDetails.Trim();
// FIXME: Is this reliable enough. What if we get a hostname as opposed to a proper http address
// Are we going to get addresses with the "http://" attached?
2016-10-28 03:11:21 +00:00
if (locationDetails.StartsWith("http://", StringComparison.OrdinalIgnoreCase))
2016-09-11 07:33:53 +00:00
{
NatUtility.Log("Found device at: {0}", locationDetails);
// This bit strings out the "http://" from the string
locationDetails = locationDetails.Substring(7);
this.hostEndPoint = hostEndPoint;
NatUtility.Log("Parsed device as: {0}", this.hostEndPoint.ToString());
// The service description URL is the remainder of the "locationDetails" string. The bit that was originally after the ip
// and port information
this.serviceDescriptionUrl = locationDetails.Substring(locationDetails.IndexOf('/'));
}
else
{
NatUtility.Log("Couldn't decode address. Please send following string to the developer: ");
}
}
2016-10-28 01:07:40 +00:00
internal UpnpNatDevice(IPAddress localAddress, string deviceDetails, string serviceType, ILogger logger, IHttpClient httpClient)
{
2016-10-27 23:53:57 +00:00
_logger = logger;
2016-10-28 01:07:40 +00:00
_httpClient = httpClient;
2016-10-27 23:53:57 +00:00
this.LastSeen = DateTime.Now;
2016-10-28 01:07:40 +00:00
this.localAddress = localAddress;
2016-09-11 07:33:53 +00:00
2016-10-28 01:07:40 +00:00
// Split the string at the "location" section so i can extract the ipaddress and service description url
2016-10-28 03:11:21 +00:00
string locationDetails = deviceDetails.Substring(deviceDetails.IndexOf("Location", StringComparison.OrdinalIgnoreCase) + 9).Split('\r')[0];
2016-09-11 07:33:53 +00:00
this.serviceType = serviceType;
2016-10-27 23:53:57 +00:00
// Make sure we have no excess whitespace
2016-10-28 01:07:40 +00:00
locationDetails = locationDetails.Trim();
2016-09-11 07:33:53 +00:00
2016-10-28 01:07:40 +00:00
// FIXME: Is this reliable enough. What if we get a hostname as opposed to a proper http address
// Are we going to get addresses with the "http://" attached?
2016-10-28 03:11:21 +00:00
if (locationDetails.StartsWith("http://", StringComparison.OrdinalIgnoreCase))
2016-10-28 01:07:40 +00:00
{
NatUtility.Log("Found device at: {0}", locationDetails);
// This bit strings out the "http://" from the string
locationDetails = locationDetails.Substring(7);
2016-09-11 07:33:53 +00:00
2016-10-28 01:07:40 +00:00
// We then split off the end of the string to get something like: 192.168.0.3:241 in our string
string hostAddressAndPort = locationDetails.Remove(locationDetails.IndexOf('/'));
2016-09-11 07:33:53 +00:00
2016-10-28 01:07:40 +00:00
// From this we parse out the IP address and Port
2016-09-11 07:33:53 +00:00
if (hostAddressAndPort.IndexOf(':') > 0)
{
this.hostEndPoint = new IPEndPoint(IPAddress.Parse(hostAddressAndPort.Remove(hostAddressAndPort.IndexOf(':'))),
Convert.ToUInt16(hostAddressAndPort.Substring(hostAddressAndPort.IndexOf(':') + 1), System.Globalization.CultureInfo.InvariantCulture));
}
else
{
// there is no port specified, use default port (80)
this.hostEndPoint = new IPEndPoint(IPAddress.Parse(hostAddressAndPort), 80);
}
2016-10-28 01:07:40 +00:00
NatUtility.Log("Parsed device as: {0}", this.hostEndPoint.ToString());
// The service description URL is the remainder of the "locationDetails" string. The bit that was originally after the ip
// and port information
this.serviceDescriptionUrl = locationDetails.Substring(locationDetails.IndexOf('/'));
}
else
{
2016-10-27 23:53:57 +00:00
logger.Warn("Couldn't decode address: " + deviceDetails);
2016-10-28 01:07:40 +00:00
}
}
/// <summary>
/// The EndPoint that the device is at
/// </summary>
internal EndPoint HostEndPoint
{
get { return this.hostEndPoint; }
}
/// <summary>
/// The relative url of the xml file that describes the list of services is at
/// </summary>
internal string ServiceDescriptionUrl
{
get { return this.serviceDescriptionUrl; }
}
/// <summary>
/// The relative url that we can use to control the port forwarding
/// </summary>
internal string ControlUrl
{
get { return this.controlUrl; }
}
/// <summary>
/// The service type we're using on the device
/// </summary>
public string ServiceType
{
get { return serviceType; }
}
public override Task CreatePortMap(Mapping mapping)
{
CreatePortMappingMessage message = new CreatePortMappingMessage(mapping, localAddress, this);
return _httpClient.SendAsync(message.Encode(), message.Method);
}
public override bool Equals(object obj)
{
UpnpNatDevice device = obj as UpnpNatDevice;
return (device == null) ? false : this.Equals((device));
}
public bool Equals(UpnpNatDevice other)
{
return (other == null) ? false : (this.hostEndPoint.Equals(other.hostEndPoint)
//&& this.controlUrl == other.controlUrl
&& this.serviceDescriptionUrl == other.serviceDescriptionUrl);
}
public override int GetHashCode()
{
return (this.hostEndPoint.GetHashCode() ^ this.controlUrl.GetHashCode() ^ this.serviceDescriptionUrl.GetHashCode());
}
2016-09-11 07:33:53 +00:00
/// <summary>
/// Overridden.
/// </summary>
/// <returns></returns>
2016-10-28 01:07:40 +00:00
public override string ToString()
2016-09-11 07:33:53 +00:00
{
//GetExternalIP is blocking and can throw exceptions, can't use it here.
2016-10-28 01:07:40 +00:00
return String.Format(
2016-09-11 07:33:53 +00:00
"UpnpNatDevice - EndPoint: {0}, External IP: {1}, Control Url: {2}, Service Description Url: {3}, Service Type: {4}, Last Seen: {5}",
this.hostEndPoint, "Manually Check" /*this.GetExternalIP()*/, this.controlUrl, this.serviceDescriptionUrl, this.serviceType, this.LastSeen);
}
2016-10-28 01:07:40 +00:00
}
2016-09-11 07:33:53 +00:00
}