DokuCli.psm1

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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
#region XmlRpc

Function Get-XmlRpcObject {
  [CmdletBinding()]
  Param(
    [Parameter(Mandatory=$False,Position=0)]
    [Object]$Object,
    [Parameter(Mandatory=$False,Position=1)]
    [Object[]]$Decorators = @("value"),
    [Parameter(Mandatory=$False,Position=2)]
    [String]$Prefix,
    [Parameter(Mandatory=$False,Position=3)]
    [String]$Suffix
  )

  Foreach ($Decorator in $Decorators) {
    $Prefix += "<$Decorator>"
    $Suffix = "</$Decorator>" + $Suffix
  }

  If ($Null -eq $Object) {
    Return "$Prefix<nil/>$Suffix"
  }

  Switch ($Object.GetType().Name) {
    "String" { Return "$Prefix<string>$([Security.SecurityElement]::Escape($Object))</string>$Suffix" }
    "Boolean" {
      If ($Object) {
        Return "$Prefix<boolean>1</boolean>$Suffix"
      }
      Else {
        Return "$Prefix<boolean>0</boolean>$Suffix"
      }
    }
    "Int32" { Return "$Prefix<i4>$Object</i4>$Suffix" }
    "Double" { Return "$Prefix<double>$Object</double>$Suffix" }
    "DateTime" {
      $iso8601dt = Get-Date -Date $Object -Format "o"
      Return "$Prefix<dateTime.iso8601>$iso8601dt</dateTime.iso8601>$Suffix"
    }
    "Object[]" {
      $ArrayString = "$Prefix<array><data>"
      Foreach ($Obj in $Object) {
        $ArrayString += Get-XmlRpcObject $Obj -Decorators @("value")
      }
      $ArrayString = "<data><array>$Suffix"
      Return $ArrayString
    }
    "HashTable" {
      $StructString = "$Prefix<struct>"
      Foreach ($Key in $Object.Keys) {
        $StructString += "<member><name>$Key</name>"
        $StructString += Get-XmlRpcObject $Object[$Key] -Decorators @("value")
        $StructString += "</member>"
      }
      $StructString += "</struct>$Suffix"
      Return $StructString
    }
    default { Write-Error "Unknown XmlRpcObject Type: $($Object.GetType().Name)" }
  }

}

Function Get-ObjectsFromXmlRpcChildNodes {
  [CmdletBinding()]
  Param (
    [Parameter(Mandatory=$True,Position=0)]
    [Object]$XmlChildNodes,
    [Parameter(Mandatory=$False,Position=1)]
    [String]$Property
  )

  $Array = @()
  Foreach ($XmlElement in $XmlChildNodes) {
    If ($Property -ne "") {
      $Array += Get-ObjectFromXmlRpcElement $XmlElement.$Property
    }
    Else {
      $Array += Get-ObjectFromXmlRpcElement $XmlElement
    }
  }
  Return $array
}

Function Get-ObjectFromXmlRpcElement {
  [CmdletBinding()]
  Param (
    [Parameter(Mandatory=$True,Position=0)]
    [System.Xml.XmlElement]$XmlElement
  )

  If ($Null -ne $XmlElement.value.boolean) {
    Return $XmlElement.value.boolean -eq 1
  }

  If ($Null -ne $XmlElement.value.string) {
    Return $XmlElement.value.string
  }

  If ($Null -ne $XmlElement.value.double) {
    Return [Double]$XmlElement.value.double
  }

  If ($Null -ne $XmlElement.value.int) {
    Return [Int32]$XmlElement.value.int
  }

  If ($Null -ne $XmlElement.value.i4) {
    Return [Int32]$XmlElement.value.i4
  }

  If ($Null -ne $XmlElement.value.array) {
    $Array = @()
    Foreach ($ArrayMember in $XmlElement.value.array.data) {
      $Array += Get-ObjectFromXmlRpcElement $ArrayMember
    }
    Return $Array
  }

  If ($Null -ne $XmlElement.value.struct) {
    $Struct = @{}
    Foreach ($StructMember in $XmlElement.value.struct.member) {
      $Struct[$StructMember.name] = Get-ObjectFromXmlRpcElement $StructMember
    }
    Return $Struct
  }

  Write-Error "Unable to create object from given XmlElement" -ErrorAction Stop

}

Function Get-XmlRpcMethodCallBody {
  [CmdletBinding()]
  Param(
    [Parameter(Mandatory=$True,Position=0)]
    [String]$Name,
    [Parameter(Mandatory=$False,Position=1)]
    [Object[]]$Params
  )

  $XmlBody = '<?xml version="1.0" encoding="UTF-8"?>'
  $XmlBody += "<methodCall><methodName>$Name</methodName>"
  If ($Params.Count -gt 0) {
    $XmlBody += "<params>"
    foreach ($Param in $Params) {
      $XmlBody += Get-XmlRpcObject $Param -Decorators "param","value"
    }
    $XmlBody += '</params>'
  }
  $XmlBody += '</methodCall>'
  Return $XmlBody

}

Function Invoke-XmlRpcMethod {
  [CmdletBinding()]
  Param(
    [Parameter(Mandatory=$True,Position=0)]
    [String]$Uri,
    [Parameter(Mandatory=$True,Position=1)]
    [String]$Name,
    [Parameter(Mandatory=$False,Position=2)]
    [Object[]]$Params,
    [Parameter(Mandatory=$False,Position=3)]
    [String]$SessionVariable = "XmlRpcDefaultSession",
    [Parameter(Mandatory=$False,Position=4)]
    [Switch]$NewSession
  )

  $Body = Get-XmlRpcMethodCallBody -Name $Name -Params $Params

  $RequestParams = @{
    Body = [System.Text.Encoding]::UTF8.GetBytes($Body)
    UseBasicParsing = $True
    Method = "Post"
    ContentType = "text/xml"
    Uri = $Uri
    ErrorAction = "Stop"
  }

  If (Test-Path "variable:global:$SessionVariable") {
    $WebSession = Get-Variable -Name $SessionVariable -Scope Global -ValueOnly
  }

  # Create new session if the
  If ($NewSession -or ($Null -eq $WebSession)) {
    $RequestParams["SessionVariable"] = $SessionVariable
  }
  Else {
    $RequestParams["WebSession"] = $WebSession
  }

  # Perform request
  $Response = Invoke-WebRequest @RequestParams

  # Store Session Variable as global
  $WebSession = Get-Variable -Name $SessionVariable -ValueOnly
  Set-Variable -Name $SessionVariable -Scope Global -Value $WebSession

  # Response content as xml
  $ResponseXml = [xml]$Response.Content

  Return $ResponseXml.methodResponse

}

#endregion XmlRpc
#region DokuWiki

Function Invoke-DokuwikiXmlRpcMethod {
  [CmdletBinding()]
  Param(
    [Parameter(Mandatory=$True,Position=0)]
    [String]$BaseUri,
    [Parameter(Mandatory=$True,Position=1)]
    [String]$Name,
    [Parameter(Mandatory=$False,Position=2)]
    [Object[]]$Params,
    [Parameter(Mandatory=$False,Position=3)]
    [String]$SessionVariable = "DokuWikiXmlRpcSession",
    [Parameter(Mandatory=$False,Position=4)]
    [Switch]$NewSession
  )

  $XmlRpcParams = @{
    Uri = $BaseUri.trim("/") + "/lib/exe/xmlrpc.php"
    Name = $Name
    Params = $Params
    SessionVariable = $SessionVariable
    NewSession = $NewSession
  }

  $XmlResponse = Invoke-XmlRpcMethod @XmlRpcParams

  If ($XmlResponse.fault) {
    $Fault = Get-ObjectFromXmlRpcElement -XmlElement $XmlResponse.fault
    $ErrorMessage = "DokuWiki XmlRpc method call: $Name failed. [{0}]: {1}" -f $Fault["faultCode"], $Fault["faultString"]
    Write-Error $ErrorMessage
  }

  If ($XmlResponse.params) {
    Return @{Response = Get-ObjectsFromXmlRpcChildNodes $XmlResponse.params.ChildNodes}
  }

}

Function Connect-Dokuwiki {
  [CmdletBinding()]
  Param (
    [Parameter(Mandatory=$True,Position=0)]
    [String]$BaseUri,
    [Parameter(Mandatory=$True,Position=1)]
    [PSCredential]$Credential,
    [Parameter(Mandatory=$False,Position=2)]
    [String]$SessionName = "DokuWikiXmlRpcDefaultSession"
  )

  $DokuSession = @{
    BaseUri = $BaseUri
    Connected = $False
    WebSessionName = "$($SessionName)_WebSession"
  }
  Set-Variable -Name $SessionName -Value $DokuSession -Scope Global

  $XmlRpcParams = @{
    BaseUri = $DokuSession.BaseUri
    Name = "dokuwiki.login"
    Params =  $Credential.UserName,$Credential.getnetworkcredential().password
    SessionVariable = $DokuSession.WebSessionName
    NewSession = $True
  }

  $Response = Invoke-DokuwikiXmlRpcMethod @XmlRpcParams

  If ($Response.Response) {
    $DokuSession.Connected = $True
    Set-Variable -Name $SessionName -Value $DokuSession -Scope Global
  }

  Return $Response.Response

}

Function Get-DokuVersion {
  [CmdletBinding()]
  Param (
    [Parameter(Mandatory=$False,Position=0)]
    [String]$SessionName = "DokuWikiXmlRpcDefaultSession"
  )

  If (Test-Path "variable:global:$SessionName") {
    $DokuSession = Get-Variable -Name $SessionName -Scope Global -ValueOnly
  }
  If (-not ($DokuSession.Connected)) {
    Write-Error "Unable to Get-DokuVersion - Please use Connect-Dokuwiki first." -ErrorAction Stop
  }

  $XmlRpcParams = @{
    BaseUri = $DokuSession.BaseUri
    Name = "dokuwiki.getVersion"
    Params =  @()
    SessionVariable = $DokuSession.WebSessionName
    NewSession = $False
  }

  $Response = Invoke-DokuwikiXmlRpcMethod @XmlRpcParams

  Return $Response.Response

}

Function Get-DokuPage {
  [CmdletBinding()]
  Param (
    [Parameter(Mandatory=$True,Position=0)]
    [String]$Page,
    [Parameter(Mandatory=$False,Position=1)]
    [String]$SessionName = "DokuWikiXmlRpcDefaultSession"
  )

  If (Test-Path "variable:global:$SessionName") {
    $DokuSession = Get-Variable -Name $SessionName -Scope Global -ValueOnly
  }
  If (-not ($DokuSession.Connected)) {
    Write-Error "Unable to Get-DokuPage - Please use Connect-Dokuwiki first." -ErrorAction Stop
  }

  $XmlRpcParams = @{
    BaseUri = $DokuSession.BaseUri
    Name = "wiki.getPage"
    Params =  @($Page)
    SessionVariable = $DokuSession.WebSessionName
    NewSession = $False
  }

  $Response = Invoke-DokuwikiXmlRpcMethod @XmlRpcParams

  Return $Response.Response

}

Function Set-DokuPage {
  [CmdletBinding()]
  Param (
    [Parameter(Mandatory=$True,Position=0)]
    [String]$Page,
    [Parameter(Mandatory=$True,Position=1)]
    [String]$Content,
    [Parameter(Mandatory=$False,Position=2)]
    [String]$Comment,
    [Parameter(Mandatory=$False,Position=3)]
    [Switch]$MinorChange,
    [Parameter(Mandatory=$False,Position=4)]
    [String]$SessionName = "DokuWikiXmlRpcDefaultSession"
  )

  If (Test-Path "variable:global:$SessionName") {
    $DokuSession = Get-Variable -Name $SessionName -Scope Global -ValueOnly
  }
  If (-not ($DokuSession.Connected)) {
    Write-Error "Unable to Set-DokuPage - Please use Connect-Dokuwiki first." -ErrorAction Stop
  }

  $XmlRpcParams = @{
    BaseUri = $DokuSession.BaseUri
    Name = "wiki.putPage"
    Params = $Page, $Content, @{sum=$Comment;minor=$($MinorChange -eq $True)}
    SessionVariable = $DokuSession.WebSessionName
    NewSession = $False
  }

  $Response = Invoke-DokuwikiXmlRpcMethod @XmlRpcParams

  Return $Response.Response

}

#endregion DokuWiki