functions/serialization/Get-PSFTypeSerializationData.ps1

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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
function Get-PSFTypeSerializationData
{
<#
 .SYNOPSIS
  Creates a type extension XML for serializing an object
  
 .DESCRIPTION
  Creates a type extension XML for serializing an object
  Use this to register a type with a type serializer, so it will retain its integrity across process borders.
  
  This is relevant in order to have an object retain its type when ...
  - sending it over PowerShell Remoting
  - writing it to file via Export-Clixml and reading it later via Import-Clixml
  
  Note:
  In the default serializer, all types registered must:
  - Have all public properties be read & writable (the write needs not do anything, but it must not throw an exception).
  - All non-public properties will be ignored.
  - Come from an Assembly with a static name (like an existing dll file, not compiled at runtime).
  
 .PARAMETER InputObject
  The type to serialize.
  - Accepts a type object
  - The string name of the type
  - An object, whose type will then be determined
  
 .PARAMETER Mode
  Whether all types listed should be generated as a single definition ('Grouped'; default) or as one definition per type.
  Since multiple files have worse performance, it is generally recommended to group them all in a single file.
  
 .PARAMETER Fragment
  By setting this, the type XML is emitted without the outer XML shell, containing only the <Type> node(s).
  Use this if you want to add the output to existing type extension xml.
  
 .PARAMETER Serializer
  The serializer to use for the conversion.
  By default, the PSFramework serializer is used, which should work well enough, but requires the PSFramework to be present.
  
 .PARAMETER Method
  The serialization method to use.
  By default, the PSFramework serialization method is used, which should work well enough, but requires the PSFramework to be present.
  
 .EXAMPLE
  PS C:\> Get-PSFTypeSerializationData -InputObject 'My.Custom.Type'
  
  Generates an XML text that can be used to register via Update-TypeData.
#>

    [CmdletBinding()]
    Param (
        [Parameter(ValueFromPipeline = $true)]
        [object[]]
        $InputObject,
        
        [ValidateSet('Grouped','SingleItem')]
        [string]
        $Mode = "Grouped",
        
        [switch]
        $Fragment,
        
        [string]
        $Serializer = "PSFramework.Serialization.SerializationTypeConverter",
        
        [string]
        $Method = "GetSerializationData"
    )
    
    begin
    {
        #region XML builder functions
        function Get-XmlHeader
        {
            <#
    .SYNOPSIS
     Returns the header for a types XML file
   #>

            Param (
                
            )
            
            @"
<?xml version="1.0" encoding="utf-8"?>
<Types>
 
"@

        }
        
        function Get-XmlBody
        {
            <#
    .SYNOPSIS
     Processes a type into proper XML
   #>

            Param (
                [string]
                $Type,
                
                [string]
                $Serializer,
                
                [string]
                $Method
            )
            
            @"
 
  <!-- $Type -->
  <Type>
    <Name>Deserialized.$Type</Name>
    <Members>
      <MemberSet>
        <Name>PSStandardMembers</Name>
        <Members>
          <NoteProperty>
            <Name>
              TargetTypeForDeserialization
            </Name>
            <Value>
              $Type
            </Value>
          </NoteProperty>
        </Members>
      </MemberSet>
    </Members>
  </Type>
  <Type>
    <Name>$Type</Name>
    <Members>
      <CodeProperty IsHidden="true">
        <Name>SerializationData</Name>
        <GetCodeReference>
          <TypeName>$Serializer</TypeName>
          <MethodName>$Method</MethodName>
        </GetCodeReference>
      </CodeProperty>
    </Members>
    <TypeConverter>
      <TypeName>$Serializer</TypeName>
    </TypeConverter>
  </Type>
 
"@

        }
        
        function Get-XmlFooter
        {
            <#
    .SYNOPSIS
     Returns the footer for a types XML file
   #>

            Param (
                
            )
            @"
</Types>
"@

        }
        #endregion XML builder functions
        
        $types = @()
        if ($Mode -eq 'Grouped')
        {
            if (-not $Fragment) { $xml = Get-XmlHeader }
            else { $xml = "" }
        }
    }
    process
    {
        foreach ($item in $InputObject)
        {
            if ($null -eq $item) { continue }
            $type = $null
            if ($res = $item -as [System.Type]) { $type = $res }
            else { $type = $item.GetType() }
            
            if ($type -in $types) { continue }
            
            switch ($Mode)
            {
                'Grouped' { $xml += Get-XmlBody -Method $Method -Serializer $Serializer -Type $type.FullName }
                'SingleItem'
                {
                    if (-not $Fragment)
                    {
                        $xml = Get-XmlHeader
                        $xml += Get-XmlBody -Method $Method -Serializer $Serializer -Type $type.FullName
                        $xml += Get-XmlFooter
                        $xml
                    }
                    else
                    {
                        Get-XmlBody -Method $Method -Serializer $Serializer -Type $type.FullName
                    }
                }
            }
            
            $types += $type
        }
    }
    end
    {
        if ($Mode -eq 'Grouped')
        {
            if (-not $Fragment) { $xml += Get-XmlFooter }
            $xml
        }
    }
}