File size: 5,180 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections.Generic;
using System.Management.Automation;
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// The ConvertFrom-Json command.
/// This command converts a Json string representation to a JsonObject.
/// </summary>
[Cmdlet(VerbsData.ConvertFrom, "Json", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2096606", RemotingCapability = RemotingCapability.None)]
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly")]
public class ConvertFromJsonCommand : Cmdlet
{
#region parameters
/// <summary>
/// Gets or sets the InputString property.
/// </summary>
[Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true)]
[AllowEmptyString]
public string InputObject { get; set; }
/// <summary>
/// InputObjectBuffer buffers all InputObject contents available in the pipeline.
/// </summary>
private readonly List<string> _inputObjectBuffer = new();
/// <summary>
/// Returned data structure is a Hashtable instead a CustomPSObject.
/// </summary>
[Parameter]
public SwitchParameter AsHashtable { get; set; }
/// <summary>
/// Gets or sets the maximum depth the JSON input is allowed to have. By default, it is 1024.
/// </summary>
[Parameter]
[ValidateRange(ValidateRangeKind.Positive)]
public int Depth { get; set; } = 1024;
/// <summary>
/// Gets or sets the switch to prevent ConvertFrom-Json from unravelling collections during deserialization, instead passing them as a single
/// object through the pipeline.
/// </summary>
[Parameter]
public SwitchParameter NoEnumerate { get; set; }
/// <summary>
/// Gets or sets the switch to control how DateTime values are to be parsed as a dotnet object.
/// </summary>
[Parameter]
public JsonDateKind DateKind { get; set; } = JsonDateKind.Default;
#endregion parameters
#region overrides
/// <summary>
/// Buffers InputObjet contents available in the pipeline.
/// </summary>
protected override void ProcessRecord()
{
_inputObjectBuffer.Add(InputObject);
}
/// <summary>
/// The main execution method for the ConvertFrom-Json command.
/// </summary>
protected override void EndProcessing()
{
// When Input is provided through pipeline, the input can be represented in the following two ways:
// 1. Each input in the collection is a complete Json content. There can be multiple inputs of this format.
// 2. The complete input is a collection which represents a single Json content. This is typically the majority of the case.
if (_inputObjectBuffer.Count > 0)
{
if (_inputObjectBuffer.Count == 1)
{
ConvertFromJsonHelper(_inputObjectBuffer[0]);
}
else
{
bool successfullyConverted = false;
try
{
// Try to deserialize the first element.
successfullyConverted = ConvertFromJsonHelper(_inputObjectBuffer[0]);
}
catch (ArgumentException)
{
// The first input string does not represent a complete Json Syntax.
// Hence consider the entire input as a single Json content.
}
if (successfullyConverted)
{
for (int index = 1; index < _inputObjectBuffer.Count; index++)
{
ConvertFromJsonHelper(_inputObjectBuffer[index]);
}
}
else
{
// Process the entire input as a single Json content.
ConvertFromJsonHelper(string.Join(System.Environment.NewLine, _inputObjectBuffer.ToArray()));
}
}
}
}
/// <summary>
/// ConvertFromJsonHelper is a helper method to convert to Json input to .Net Type.
/// </summary>
/// <param name="input">Input string.</param>
/// <returns>True if successfully converted, else returns false.</returns>
private bool ConvertFromJsonHelper(string input)
{
ErrorRecord error = null;
object result = JsonObject.ConvertFromJson(input, AsHashtable.IsPresent, Depth, DateKind, out error);
if (error != null)
{
ThrowTerminatingError(error);
}
WriteObject(result, !NoEnumerate.IsPresent);
return (result != null);
}
#endregion overrides
}
}
|