Private/ConvertTo-AtwsFilter.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
209
210
211
212
213
214
215
<#
 
    .COPYRIGHT
    Copyright (c) Office Center Hønefoss AS. All rights reserved. Licensed under the MIT license.
    See https://github.com/officecenter/Autotask/blob/master/LICENSE.md for license information.
 
#>


Function ConvertTo-AtwsFilter {
  <#
      .SYNOPSIS
      This function converts a parameter set of a Get-function to a parsable approximation of a PowerShell
      filter.
      .DESCRIPTION
      This function converts a parameter set of a Get-function to a parsable approximation of a PowerShell
      filter. Due to internal scope contraints the function needs to be dot.sourced in the calling function.
      This function is not stand alone. It uses several variables that only exist in the calling scope,
      another reason it needs to be dot.sourced. This is not best practice, but it is still by design.
      .INPUTS
      System.Collections.Generic.Dictionary`2[System.String,System.Object]]
      .OUTPUTS
      [String[]]
      .EXAMPLE
      $Element | ConvertTo-AtwsDate -ParameterName <ParameterName>
      Converts variable $Element with must contain a single DateTime value to a string representation of the
      Date or the DateTime, based on the parameter name.
      .NOTES
      NAME: ConvertTo-AtwsFilter
       
  #>

  [cmdletbinding()]
  Param
  (
    [Parameter(
        Mandatory = $True,
        ValueFromPipeline = $True
    )]
    [System.Collections.Generic.Dictionary`2[System.String,System.Object]]
    $BoundParameters,
    
    [Parameter(
        Mandatory = $True
    )]
    [ValidateScript({ $Script:FieldInfoCache.Keys -contains $_ })]
    [String]
    $EntityName
  )

  Begin {
    # Enable modern -Debug behavior
    If ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) {$DebugPreference = 'Continue'}
    
    Write-Debug ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name)
        
    # Set up TimeZone offset handling
    If (-not($script:ESTzone)) {
      $script:ESTzone = [System.TimeZoneInfo]::FindSystemTimeZoneById("Eastern Standard Time")
    }
    
    If (-not($script:ESToffset)) {
      $Now = Get-Date
      $ESTtime = [System.TimeZoneInfo]::ConvertTimeFromUtc($Now.ToUniversalTime(), $ESTzone)

      $script:ESToffset = (New-TimeSpan -Start $ESTtime -End $Now).TotalHours
    }
    
    [String[]]$Filter = @()
  }

  Process {
    Write-Debug ('{0}: Query based on parameters, parsing' -F $MyInvocation.MyCommand.Name)
      
    $Fields = Get-AtwsFieldInfo -Entity $EntityName
 
    Foreach ($Parameter in $BoundParameters.GetEnumerator()) {
      $Field = $Fields | Where-Object {$_.Name -eq $Parameter.Key}
      
      # If Parameter value is null or an empty string for string types, add name to $IsNull array
      # and continue
      If (($Field.Type -ne 'String' -and $Null -eq $Parameter.Value) -or ($Field.Type -eq 'String' -and $Parameter.Value.Length -eq 0)) {
        If ($IsNull -notcontains $Parameter.Key) { 
          $IsNull += $Parameter.Key
        }
        Continue
      }
      
      If ($Field -or $Parameter.Key -eq 'UserDefinedField') { 
        If ($Parameter.Value.Count -gt 1) {
          $Filter += '-begin'
        }
        Foreach ($ParameterValue in $Parameter.Value) {   
          $Operator = '-or'
          $ParameterName = $Parameter.Key
          If ($Field.IsPickList) {
            If ($Field.PickListParentValueField) {
              $ParentField = $Fields.Where{$_.Name -eq $Field.PickListParentValueField}
              $ParentLabel = $PSBoundParameters.$($ParentField.Name)
              $ParentValue = $ParentField.PickListValues | Where-Object {$_.Label -eq $ParentLabel}
              $PickListValue = $Field.PickListValues | Where-Object {$_.Label -eq $ParameterValue -and $_.ParentValue -eq $ParentValue.Value}                
            }
            Else { 
              $PickListValue = $Field.PickListValues | Where-Object {$_.Label -eq $ParameterValue}
            }
            $Value = $PickListValue.Value
          }
          ElseIf ($ParameterName -eq 'UserDefinedField') {
            $Filter += '-udf'              
            $ParameterName = $ParameterValue.Name
            $Value = $ParameterValue.Value
          }
          ElseIf ($ParameterValue.GetType().Name -eq 'DateTime')  {
            If ($ParameterValue -eq $ParameterValue.Date -and 
              $Parameter.Key -notin $GreaterThan -and 
              $Parameter.Key -notin $GreaterThanOrEquals -and 
              $Parameter.Key -notin $LessThan -and 
            $Parameter.Key -notin $LessThanOrEquals) 
            {
              # User is searching for a date, not a specific datetime
              $Filter += $ParameterName
              $Filter += '-ge'
              $Filter += ConvertTo-AtwsDate -ParameterName $ParameterName -DateTime $ParameterValue
              [Array]$LessThanOrEquals += $ParameterName
              $Value = ConvertTo-AtwsDate -ParameterName $ParameterName -DateTime $ParameterValue.AddDays(1)
            }
            Else { 
              $Value = ConvertTo-AtwsDate -ParameterName $ParameterName -DateTime $ParameterValue
            }
          }            
          Else {
            $Value = $ParameterValue
          }
          $Filter += $ParameterName
          If ($Parameter.Key -in $NotEquals) { 
            $Filter += '-ne'
            $Operator = '-and'
          }
          ElseIf ($Parameter.Key -in $GreaterThan)
          { $Filter += '-gt'}
          ElseIf ($Parameter.Key -in $GreaterThanOrEquals)
          { $Filter += '-ge'}
          ElseIf ($Parameter.Key -in $LessThan)
          { $Filter += '-lt'}
          ElseIf ($Parameter.Key -in $LessThanOrEquals)
          { $Filter += '-le'}
          ElseIf ($Parameter.Key -in $Like) { 
            $Filter += '-like'
            $Value = $Value -replace '\*', '%'
          }
          ElseIf ($Parameter.Key -in $NotLike) { 
            $Filter += '-notlike'
            $Value = $Value -replace '\*', '%'
          }
          ElseIf ($Parameter.Key -in $BeginsWith)
          { $Filter += '-beginswith'}
          ElseIf ($Parameter.Key -in $EndsWith)
          { $Filter += '-endswith'}
          ElseIf ($Parameter.Key -in $Contains)
          { $Filter += '-contains'}
          ElseIf ($Parameter.Key -in $IsThisDay)
          { $Filter += '-isthisday'}
          ElseIf ($Parameter.Key -in $IsNull -and $Parameter.Key -eq 'UserDefinedField')
          {
            $Filter += '-IsNull'
            $IsNull = $IsNull.Where({$_ -ne 'UserDefinedField'})
          }
          ElseIf ($Parameter.Key -in $IsNotNull -and $Parameter.Key -eq 'UserDefinedField')
          {
            $Filter += '-IsNotNull'
            $IsNotNull = $IsNotNull.Where({$_ -ne 'UserDefinedField'})
          }
          Else
          { $Filter += '-eq'}
            
          # Add Value to expression, unless this is a UserDefinedfield AND UserDefinedField has been
          # specified for -IsNull or -IsNotNull
          If ($Filter[-1] -notin @('-IsNull','-IsNotNull'))
          {$Filter += $Value}

          If ($Parameter.Value.Count -gt 1 -and $ParameterValue -ne $Parameter.Value[-1]) {
            $Filter += $Operator
          }
          ElseIf ($Parameter.Value.Count -gt 1) {
            $Filter += '-end'
          }
            
        }
            
      }
    }
    # IsNull and IsNotNull are special. They are the only operators that does not require a value to work
    If ($IsNull.Count -gt 0) {
      If ($Filter.Count -gt 0) {
        $Filter += '-and'
      }
      Foreach ($PropertyName in $IsNull) {
        $Filter += $PropertyName
        $Filter += '-isnull'
      }
    }
    If ($IsNotNull.Count -gt 0) {
      If ($Filter.Count -gt 0) {
        $Filter += '-and'
      }
      Foreach ($PropertyName in $IsNotNull) {
        $Filter += $PropertyName
        $Filter += '-isnotnull'
      }
    }  
 
  }

  End {
    Return $Filter
  }
}