Enable nullable reference types for MediaBrowser.Common

This commit is contained in:
Bond_009 2021-05-05 12:57:01 +02:00
parent 48e81e65e8
commit 91c2a57b28
43 changed files with 78 additions and 64 deletions

View File

@ -77,8 +77,9 @@ namespace Jellyfin.Api.Auth
return false; return false;
} }
var ip = _httpContextAccessor.HttpContext.GetNormalizedRemoteIp(); var isInLocalNetwork = _httpContextAccessor.HttpContext != null
var isInLocalNetwork = _networkManager.IsInLocalNetwork(ip); && _networkManager.IsInLocalNetwork(_httpContextAccessor.HttpContext.GetNormalizedRemoteIp());
// User cannot access remotely and user is remote // User cannot access remotely and user is remote
if (!user.HasPermission(PermissionKind.EnableRemoteAccess) && !isInLocalNetwork) if (!user.HasPermission(PermissionKind.EnableRemoteAccess) && !isInLocalNetwork)
{ {

View File

@ -1,3 +1,4 @@
using System;
using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations;
using System.Net.Mime; using System.Net.Mime;
using System.Text.Json; using System.Text.Json;
@ -94,6 +95,11 @@ namespace Jellyfin.Api.Controllers
{ {
var configurationType = _configurationManager.GetConfigurationType(key); var configurationType = _configurationManager.GetConfigurationType(key);
var configuration = await JsonSerializer.DeserializeAsync(Request.Body, configurationType, _serializerOptions).ConfigureAwait(false); var configuration = await JsonSerializer.DeserializeAsync(Request.Body, configurationType, _serializerOptions).ConfigureAwait(false);
if (configuration == null)
{
throw new ArgumentException("Body doesn't contain a valid configuration");
}
_configurationManager.SaveConfiguration(key, configuration); _configurationManager.SaveConfiguration(key, configuration);
return NoContent(); return NoContent();
} }

View File

@ -1,3 +1,5 @@
#nullable disable
using System; using System;
namespace MediaBrowser.Common.Configuration namespace MediaBrowser.Common.Configuration

View File

@ -1,3 +1,4 @@
#nullable disable
#pragma warning disable CS1591 #pragma warning disable CS1591
using System; using System;

View File

@ -1,3 +1,5 @@
#nullable disable
namespace MediaBrowser.Common.Configuration namespace MediaBrowser.Common.Configuration
{ {
/// <summary> /// <summary>

View File

@ -1,5 +1,4 @@
#pragma warning disable CS1591 #pragma warning disable CS1591
#nullable enable
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;

View File

@ -17,7 +17,7 @@ namespace MediaBrowser.Common.Events
/// <param name="sender">The sender.</param> /// <param name="sender">The sender.</param>
/// <param name="args">The <see cref="EventArgs" /> instance containing the event data.</param> /// <param name="args">The <see cref="EventArgs" /> instance containing the event data.</param>
/// <param name="logger">The logger.</param> /// <param name="logger">The logger.</param>
public static void QueueEventIfNotNull(EventHandler handler, object sender, EventArgs args, ILogger logger) public static void QueueEventIfNotNull(EventHandler? handler, object sender, EventArgs args, ILogger logger)
{ {
if (handler != null) if (handler != null)
{ {
@ -43,7 +43,7 @@ namespace MediaBrowser.Common.Events
/// <param name="sender">The sender.</param> /// <param name="sender">The sender.</param>
/// <param name="args">The args.</param> /// <param name="args">The args.</param>
/// <param name="logger">The logger.</param> /// <param name="logger">The logger.</param>
public static void QueueEventIfNotNull<T>(EventHandler<T> handler, object sender, T args, ILogger logger) public static void QueueEventIfNotNull<T>(EventHandler<T>? handler, object sender, T args, ILogger logger)
{ {
if (handler != null) if (handler != null)
{ {

View File

@ -1,5 +1,3 @@
#nullable enable
using System; using System;
using System.Security.Cryptography; using System.Security.Cryptography;
using System.Text; using System.Text;

View File

@ -1,5 +1,3 @@
#nullable enable
using System.Collections.Generic; using System.Collections.Generic;
namespace MediaBrowser.Common.Extensions namespace MediaBrowser.Common.Extensions

View File

@ -17,7 +17,7 @@ namespace MediaBrowser.Common.Extensions
{ {
return (context.Connection.LocalIpAddress == null return (context.Connection.LocalIpAddress == null
&& context.Connection.RemoteIpAddress == null) && context.Connection.RemoteIpAddress == null)
|| context.Connection.LocalIpAddress.Equals(context.Connection.RemoteIpAddress); || Equals(context.Connection.LocalIpAddress, context.Connection.RemoteIpAddress);
} }
/// <summary> /// <summary>

View File

@ -1,5 +1,3 @@
#nullable enable
using System; using System;
namespace MediaBrowser.Common.Extensions namespace MediaBrowser.Common.Extensions

View File

@ -1,5 +1,3 @@
#nullable enable
using System; using System;
using System.Diagnostics; using System.Diagnostics;
using System.Threading; using System.Threading;

View File

@ -1,4 +1,3 @@
#nullable enable
#pragma warning disable CS1591 #pragma warning disable CS1591
using System; using System;

View File

@ -1,5 +1,3 @@
#nullable enable
using System; using System;
namespace MediaBrowser.Common.Extensions namespace MediaBrowser.Common.Extensions

View File

@ -1,5 +1,3 @@
#nullable enable
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;

View File

@ -21,7 +21,7 @@ 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 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. SOFTWARE.
*/ */
#nullable enable
#pragma warning disable CS1591 #pragma warning disable CS1591
#pragma warning disable CA1034 #pragma warning disable CA1034
using System; using System;

View File

@ -1,5 +1,3 @@
#nullable enable
using System.Collections.Generic; using System.Collections.Generic;
using System.IO; using System.IO;
using System.Linq; using System.Linq;

View File

@ -1,3 +1,5 @@
#nullable disable
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Reflection; using System.Reflection;

View File

@ -9,7 +9,7 @@ namespace MediaBrowser.Common.Json.Converters
/// Convert comma delimited string to array of type. /// Convert comma delimited string to array of type.
/// </summary> /// </summary>
/// <typeparam name="T">Type to convert to.</typeparam> /// <typeparam name="T">Type to convert to.</typeparam>
public class JsonCommaDelimitedArrayConverter<T> : JsonConverter<T[]> public class JsonCommaDelimitedArrayConverter<T> : JsonConverter<T[]?>
{ {
private readonly TypeConverter _typeConverter; private readonly TypeConverter _typeConverter;
@ -22,11 +22,17 @@ namespace MediaBrowser.Common.Json.Converters
} }
/// <inheritdoc /> /// <inheritdoc />
public override T[] Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) public override T[]? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{ {
if (reader.TokenType == JsonTokenType.Null)
{
return null;
}
if (reader.TokenType == JsonTokenType.String) if (reader.TokenType == JsonTokenType.String)
{ {
var stringEntries = reader.GetString().Split(',', StringSplitOptions.RemoveEmptyEntries); // GetString can't return null here because we already handled it above
var stringEntries = reader.GetString()!.Split(',', StringSplitOptions.RemoveEmptyEntries);
if (stringEntries.Length == 0) if (stringEntries.Length == 0)
{ {
return Array.Empty<T>(); return Array.Empty<T>();
@ -67,7 +73,7 @@ namespace MediaBrowser.Common.Json.Converters
} }
/// <inheritdoc /> /// <inheritdoc />
public override void Write(Utf8JsonWriter writer, T[] value, JsonSerializerOptions options) public override void Write(Utf8JsonWriter writer, T[]? value, JsonSerializerOptions options)
{ {
throw new NotImplementedException(); throw new NotImplementedException();
} }

View File

@ -19,10 +19,10 @@ namespace MediaBrowser.Common.Json.Converters
} }
/// <inheritdoc /> /// <inheritdoc />
public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options) public override JsonConverter? CreateConverter(Type typeToConvert, JsonSerializerOptions options)
{ {
var structType = typeToConvert.GetElementType() ?? typeToConvert.GenericTypeArguments[0]; var structType = typeToConvert.GetElementType() ?? typeToConvert.GenericTypeArguments[0];
return (JsonConverter)Activator.CreateInstance(typeof(JsonCommaDelimitedArrayConverter<>).MakeGenericType(structType)); return (JsonConverter?)Activator.CreateInstance(typeof(JsonCommaDelimitedArrayConverter<>).MakeGenericType(structType));
} }
} }
} }

View File

@ -18,10 +18,10 @@ namespace MediaBrowser.Common.Json.Converters
} }
/// <inheritdoc /> /// <inheritdoc />
public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options) public override JsonConverter? CreateConverter(Type typeToConvert, JsonSerializerOptions options)
{ {
var structType = typeToConvert.GenericTypeArguments[0]; var structType = typeToConvert.GenericTypeArguments[0];
return (JsonConverter)Activator.CreateInstance(typeof(JsonNullableStructConverter<>).MakeGenericType(structType)); return (JsonConverter?)Activator.CreateInstance(typeof(JsonNullableStructConverter<>).MakeGenericType(structType));
} }
} }
} }

View File

@ -7,15 +7,21 @@ namespace MediaBrowser.Common.Json.Converters
/// <summary> /// <summary>
/// Converts a string <c>N/A</c> to <c>string.Empty</c>. /// Converts a string <c>N/A</c> to <c>string.Empty</c>.
/// </summary> /// </summary>
public class JsonOmdbNotAvailableStringConverter : JsonConverter<string> public class JsonOmdbNotAvailableStringConverter : JsonConverter<string?>
{ {
/// <inheritdoc /> /// <inheritdoc />
public override string Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) public override string? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{ {
if (reader.TokenType == JsonTokenType.Null)
{
return null;
}
if (reader.TokenType == JsonTokenType.String) if (reader.TokenType == JsonTokenType.String)
{ {
var str = reader.GetString(); // GetString can't return null here because we already handled it above
if (str != null && str.Equals("N/A", StringComparison.OrdinalIgnoreCase)) var str = reader.GetString()!;
if (str.Equals("N/A", StringComparison.OrdinalIgnoreCase))
{ {
return null; return null;
} }
@ -23,11 +29,11 @@ namespace MediaBrowser.Common.Json.Converters
return str; return str;
} }
return JsonSerializer.Deserialize<string>(ref reader, options); return JsonSerializer.Deserialize<string?>(ref reader, options);
} }
/// <inheritdoc /> /// <inheritdoc />
public override void Write(Utf8JsonWriter writer, string value, JsonSerializerOptions options) public override void Write(Utf8JsonWriter writer, string? value, JsonSerializerOptions options)
{ {
writer.WriteStringValue(value); writer.WriteStringValue(value);
} }

View File

@ -24,10 +24,16 @@ namespace MediaBrowser.Common.Json.Converters
/// <inheritdoc /> /// <inheritdoc />
public override T[] Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) public override T[] Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{ {
if (reader.TokenType == JsonTokenType.Null)
{
return Array.Empty<T>();
}
if (reader.TokenType == JsonTokenType.String) if (reader.TokenType == JsonTokenType.String)
{ {
var stringEntries = reader.GetString()?.Split('|', StringSplitOptions.RemoveEmptyEntries); // GetString can't return null here because we already handled it above
if (stringEntries == null || stringEntries.Length == 0) var stringEntries = reader.GetString()!.Split('|', StringSplitOptions.RemoveEmptyEntries);
if (stringEntries.Length == 0)
{ {
return Array.Empty<T>(); return Array.Empty<T>();
} }
@ -63,7 +69,8 @@ namespace MediaBrowser.Common.Json.Converters
return typedValues; return typedValues;
} }
return JsonSerializer.Deserialize<T[]>(ref reader, options); // can't return null here because we already handled it above
return JsonSerializer.Deserialize<T[]>(ref reader, options)!;
} }
/// <inheritdoc /> /// <inheritdoc />

View File

@ -19,10 +19,10 @@ namespace MediaBrowser.Common.Json.Converters
} }
/// <inheritdoc /> /// <inheritdoc />
public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options) public override JsonConverter? CreateConverter(Type typeToConvert, JsonSerializerOptions options)
{ {
var structType = typeToConvert.GetElementType() ?? typeToConvert.GenericTypeArguments[0]; var structType = typeToConvert.GetElementType() ?? typeToConvert.GenericTypeArguments[0];
return (JsonConverter)Activator.CreateInstance(typeof(JsonPipeDelimitedArrayConverter<>).MakeGenericType(structType)); return (JsonConverter?)Activator.CreateInstance(typeof(JsonPipeDelimitedArrayConverter<>).MakeGenericType(structType));
} }
} }
} }

View File

@ -9,10 +9,10 @@ namespace MediaBrowser.Common.Json.Converters
/// <summary> /// <summary>
/// Converter to allow the serializer to read strings. /// Converter to allow the serializer to read strings.
/// </summary> /// </summary>
public class JsonStringConverter : JsonConverter<string> public class JsonStringConverter : JsonConverter<string?>
{ {
/// <inheritdoc /> /// <inheritdoc />
public override string Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) public override string? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{ {
return reader.TokenType switch return reader.TokenType switch
{ {
@ -23,7 +23,7 @@ namespace MediaBrowser.Common.Json.Converters
} }
/// <inheritdoc /> /// <inheritdoc />
public override void Write(Utf8JsonWriter writer, string value, JsonSerializerOptions options) public override void Write(Utf8JsonWriter writer, string? value, JsonSerializerOptions options)
{ {
writer.WriteStringValue(value); writer.WriteStringValue(value);
} }
@ -36,4 +36,4 @@ namespace MediaBrowser.Common.Json.Converters
return Encoding.UTF8.GetString(utf8Bytes); return Encoding.UTF8.GetString(utf8Bytes);
} }
} }
} }

View File

@ -14,7 +14,7 @@ namespace MediaBrowser.Common.Json.Converters
{ {
/// <inheritdoc /> /// <inheritdoc />
public override Version Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) public override Version Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
=> new Version(reader.GetString()); => new Version(reader.GetString()!); // Will throw ArgumentNullException on null
/// <inheritdoc /> /// <inheritdoc />
public override void Write(Utf8JsonWriter writer, Version value, JsonSerializerOptions options) public override void Write(Utf8JsonWriter writer, Version value, JsonSerializerOptions options)

View File

@ -33,6 +33,7 @@
<GenerateAssemblyInfo>false</GenerateAssemblyInfo> <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
<GenerateDocumentationFile>true</GenerateDocumentationFile> <GenerateDocumentationFile>true</GenerateDocumentationFile>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors> <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
<Nullable>enable</Nullable>
<AnalysisMode>AllEnabledByDefault</AnalysisMode> <AnalysisMode>AllEnabledByDefault</AnalysisMode>
<CodeAnalysisRuleSet>../jellyfin.ruleset</CodeAnalysisRuleSet> <CodeAnalysisRuleSet>../jellyfin.ruleset</CodeAnalysisRuleSet>
<PublishRepositoryUrl>true</PublishRepositoryUrl> <PublishRepositoryUrl>true</PublishRepositoryUrl>

View File

@ -1,4 +1,3 @@
#nullable enable
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Collections.ObjectModel; using System.Collections.ObjectModel;

View File

@ -1,4 +1,3 @@
#nullable enable
using System; using System;
using System.Diagnostics; using System.Diagnostics;
using System.Linq; using System.Linq;

View File

@ -1,4 +1,3 @@
#nullable enable
using System; using System;
using System.Net; using System.Net;
using System.Net.Sockets; using System.Net.Sockets;

View File

@ -1,4 +1,3 @@
#nullable enable
using System; using System;
using System.Net; using System.Net;
using System.Net.Sockets; using System.Net.Sockets;

View File

@ -1,3 +1,5 @@
#nullable disable
using System; using System;
using System.IO; using System.IO;
using System.Reflection; using System.Reflection;

View File

@ -1,4 +1,6 @@
#nullable disable
#pragma warning disable SA1649 // File name should match first type name #pragma warning disable SA1649 // File name should match first type name
using System; using System;
using System.IO; using System.IO;
using System.Runtime.InteropServices; using System.Runtime.InteropServices;

View File

@ -1,3 +1,5 @@
#nullable disable
using System; using System;
using MediaBrowser.Model.Plugins; using MediaBrowser.Model.Plugins;

View File

@ -1,5 +1,3 @@
#nullable enable
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Reflection; using System.Reflection;

View File

@ -1,4 +1,3 @@
#nullable enable
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using MediaBrowser.Model.Plugins; using MediaBrowser.Model.Plugins;

View File

@ -1,5 +1,3 @@
#nullable enable
using System; using System;
using System.Text.Json.Serialization; using System.Text.Json.Serialization;
using MediaBrowser.Model.Plugins; using MediaBrowser.Model.Plugins;

View File

@ -14,9 +14,9 @@ namespace MediaBrowser.Common.Progress
/// <summary> /// <summary>
/// The _actions. /// The _actions.
/// </summary> /// </summary>
private Action<T> _action; private Action<T>? _action;
public event EventHandler<T> ProgressChanged; public event EventHandler<T>? ProgressChanged;
/// <summary> /// <summary>
/// Registers the action. /// Registers the action.

View File

@ -7,7 +7,7 @@ namespace MediaBrowser.Common.Progress
{ {
public class SimpleProgress<T> : IProgress<T> public class SimpleProgress<T> : IProgress<T>
{ {
public event EventHandler<T> ProgressChanged; public event EventHandler<T>? ProgressChanged;
public void Report(T value) public void Report(T value)
{ {

View File

@ -1,6 +1,4 @@
#nullable enable using System;
using System;
using System.Diagnostics.CodeAnalysis; using System.Diagnostics.CodeAnalysis;
namespace MediaBrowser.Common.Providers namespace MediaBrowser.Common.Providers

View File

@ -1,5 +1,3 @@
#nullable enable
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Threading; using System.Threading;

View File

@ -1,3 +1,5 @@
#nullable disable
using System; using System;
using MediaBrowser.Model.Updates; using MediaBrowser.Model.Updates;

View File

@ -1,3 +1,4 @@
#nullable disable
#pragma warning disable CS1591 #pragma warning disable CS1591
using System; using System;