Changes to AOLserver.tcl.
Changes to ChannelServer.tcl.
Deleted CheckAndBuild.tcl.
Changes to ClientSide.tcl.
1
2
3
4
5
6
7
8
9
10
|
1
2
3
4
5
6
7
8
9
10
11
|
+
-
+
|
###############################################################################
## ##
## Copyright (c) 2016-2019, Harald Oehlmann ##
## Copyright (c) 2006-2008, Gerald W. Lester ##
## Copyright (c) 2006-2013, Gerald W. Lester ##
## Copyright (c) 2008, Georgios Petasis ##
## Copyright (c) 2006, Visiprise Software, Inc ##
## Copyright (c) 2006, Arnulf Wiedemann ##
## Copyright (c) 2006, Colin McCormack ##
## Copyright (c) 2006, Rolf Ade ##
## Copyright (c) 2001-2006, Pat Thoyts ##
## All rights reserved. ##
|
︙ | | |
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
|
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
|
-
+
-
-
-
+
-
+
+
+
+
+
+
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
## CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT ##
## LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ##
## ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE ##
## POSSIBILITY OF SUCH DAMAGE. ##
## ##
###############################################################################
package require WS::Utils
package require Tcl 8.6-
#package require Tcl 8.5
if {![llength [info command dict]]} {
package require dict
package require WS::Utils ; # logsubst
}
package require tdom 0.8
package require http 2
package require log
package require uri
package provide WS::Client 3.0.1
namespace eval ::WS::Client {
# register https only if not yet registered
if {[catch { http::unregister https } lPortCmd]} {
# not registered -> register on my own
catch {
package require tls
http::register https 443 ::tls::socket
}
package provide WS::Client 1.4.1
namespace eval ::WS::Client {
if {[catch {
package require tls
http::register https 443 ::tls::socket
} err]} {
log::log warning "No TLS package: $err"
if { [catch {
package require twapi_crypto
http::register https 443 ::twapi::tls_socket
} Err] } {
log::log warning "No https support. No TWAPI package: $err"
}
}
} else {
# Ok, was registered - reregister
http::register https {*}$lPortCmd
}
unset -nocomplain err lPortCmd
##
## serviceArr is indexed by service name and contains a dictionary that
## defines the service. The dictionary has the following structure:
## targetNamespace - the target namespace
## operList - list of operations
## objList - list of operations
## headers - list of http headers
|
︙ | | |
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
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
|
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
## is the operations name and each with the following structure:
## inputs --- list of fields with type info
## outputs --- return type
##
## Note -- all type information is formated suitable to be passed
## to ::WS::Utils::ServiceTypeDef
##
array set serviceArr {}
set currentBaseUrl {}
}
array set ::WS::Client::serviceArr {}
set ::WS::Client::currentBaseUrl {}
array set ::WS::Client::options {
skipLevelWhenActionPresent 0
skipLevelOnReply 0
skipHeaderLevel 0
suppressTargetNS 0
allowOperOverloading 1
contentType {text/xml;charset=utf-8}
UseNS {}
parseInAttr {}
genOutAttr {}
valueAttrCompatiblityMode 1
suppressNS {}
useTypeNs {}
nsOnChangeOnly {}
noTargetNs 0
errorOnRedefine 0
inlineElementNS 1
queryTimeout 60000
}
##
## List of options which are copied to the service array
##
set ::WS::Client::serviceLocalOptionsList {
skipLevelWhenActionPresent
skipLevelOnReply
skipHeaderLevel
suppressTargetNS
allowOperOverloading
contentType
UseNS
parseInAttr
genOutAttr
valueAttrCompatiblityMode
suppressNS
useTypeNs
nsOnChangeOnly
noTargetNs
queryTimeout
}
##
## List of options which are set and restored in the Utilities module
## when we do a call into the module
##
set ::WS::Client::utilsOptionsList {
UseNS
parseInAttr
genOutAttr
valueAttrCompatiblityMode
suppressNS
useTypeNs
nsOnChangeOnly
}
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::SetOption
#
# Description : Set or get file global or default option.
# Global option control the service creation process.
# Default options are takren as defaults to new created services.
#
# Arguments :
# -globalonly
# - Return list of global options/values
# -defaultonly
# - Return list of default options/values
# --
# option - Option to be set/retrieved
# Return all option/values if omitted
# args - Value to set the option to
# Return the value if not given
#
# Returns : The value of the option
#
# Side-Effects : None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 04/272009 G.Lester Initial version
# 2.4.5 2017-12-04 H.Oehlmann Return all current options if no argument
# given. Options -globalonly or -defaultonly
# limit this to options which are (not)
# copied to the service.
#
###########################################################################
proc ::WS::Client::SetOption {args} {
variable options
variable serviceLocalOptionsList
if {0 == [llength $args]} {
return [array get options]
}
set args [lassign $args option]
switch -exact -- $option {
-globalonly {
##
## Return list of global options
##
# A list convertible to a dict is build for performance reasons:
# - lappend does not test existence for each element
# - if a list is needed, dict build burden is avoided
set res {}
foreach option [array names options] {
if {$option ni $serviceLocalOptionsList} {
lappend res $option $options($option)
}
}
return $res
}
-defaultonly {
##
## Return list of default options
##
set res {}
foreach option [array names options] {
if {$option in $serviceLocalOptionsList} {
lappend res $option $options($option)
}
}
return $res
}
-- {
##
## End of options
##
set args [lassign $args option]
}
}
##
## Check if given option exists
##
if {![info exists options($option)]} {
return -code error \
-errorcode [list WS CLIENT UNKOPT $option] \
"Unknown option: '$option'"
}
##
## Check if value is given
##
switch -exact -- [llength $args] {
0 {
return $options($option)
}
1 {
set value [lindex $args 0]
set options($option) $value
return $value
}
default {
return -code error \
-errorcode [list WS CLIENT INVALDCNT $args] \
"To many parameters: '$args'"
}
}
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
|
︙ | | |
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
|
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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
|
-
+
+
+
-
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 04/14/2009 G.Lester Initial version
#
# 2.4.5 2017-12-04 H.Oehlmann Use distinct list of option items, which are
# copied to the service array. Not all options
# are used in the service array.
#
###########################################################################
proc ::WS::Client::CreateService {serviceName type url args} {
proc ::WS::Client::CreateService {serviceName type url target args} {
variable serviceArr
variable options
variable serviceLocalOptionsList
if {$options(errorOnRedefine) && [info exists serviceArr($serviceName)]} {
return -code error "Service '$serviceName' already exists"
} elseif {[info exists serviceArr($serviceName)]} {
unset serviceArr($serviceName)
}
dict set serviceArr($serviceName) types {}
dict set serviceArr($serviceName) operList {}
dict set serviceArr($serviceName) objList {}
dict set serviceArr($serviceName) headers {}
dict set serviceArr($serviceName) targetNamespace [list [list tns1 $url]]
dict set serviceArr($serviceName) targetNamespace tns1 $target
dict set serviceArr($serviceName) name $serviceName
dict set serviceArr($serviceName) location $url
dict set serviceArr($serviceName) style $type
dict set serviceArr($serviceName) imports {}
dict set serviceArr($serviceName) inTransform {}
dict set serviceArr($serviceName) outTransform {}
foreach item $serviceLocalOptionsList {
dict set serviceArr($serviceName) $item $options($item)
}
foreach {name value} $args {
set name [string trimleft $name {-}]
dict set serviceArr($serviceName) $name $value
}
::log::logsubst debug {Setting Target Namespace tns1 as $target}
if {[dict exists $serviceArr($serviceName) xns]} {
set xns [dict get $serviceArr($serviceName) xns]
::log::log debug [list Setting targetNamespae to $xns]
dict set serviceArr($serviceName) targetNamespace [list $xns]
foreach xnsItem [dict get $serviceArr($serviceName) xns] {
lassign $xnsItem tns xns
::log::logsubst debug {Setting targetNamespace $tns for $xns}
dict set serviceArr($serviceName) targetNamespace $tns $xns
}
}
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::Config
#
# Description : Configure a service information
#
# Arguments :
# serviceName - Service name to add namespace to.
# Return a list of items/values of default options if not
# given.
# item - The item to configure. Return a list of all items/values
# if not given.
# value - Optional, the new value. Return the value, if not given.
#
# Returns : The value of the option or a list of item/value pairs.
#
# Side-Effects : None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 04/14/2009 G.Lester Initial version
# 2.4.5 2017-12-04 H.Oehlmann Allow to set an option to the empty string.
# Return all option/values, if called without
# item. Return default items/values if no
# service given.
#
###########################################################################
proc ::WS::Client::Config {args} {
variable serviceArr
variable options
variable serviceLocalOptionsList
set validOptionList $serviceLocalOptionsList
lappend validOptionList location targetNamespace
if {0 == [llength $args]} {
# A list convertible to a dict is build for performance reasons:
# - lappend does not test existence for each element
# - if a list is needed, dict build burden is avoided
set res {}
foreach item $validOptionList {
lappend res $item
if {[info exists options($item)]} {
lappend res $options($item)
} else {
lappend res {}
}
}
return $res
}
set args [lassign $args serviceName]
if {0 == [llength $args]} {
set res {}
foreach item $validOptionList {
lappend res $item [dict get $serviceArr($serviceName) $item]
}
return $res
}
set args [lassign $args item]
if { $item ni $validOptionList } {
return -code error "Uknown option '$item' -- must be one of: [join $validOptionList {, }]"
}
switch -exact -- [llength $args] {
0 {
return [dict get $serviceArr($serviceName) $item]
}
1 {
set value [lindex $args 0]
dict set serviceArr($serviceName) $item $value
return $value
}
default {
::log::log debug "To many arguments arguments {$args}"
return \
-code error \
-errorcode [list WS CLIENT INVARGCNT $args] \
"To many arguments '$args'"
}
}
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
|
︙ | | |
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
|
-
+
|
###########################################################################
proc ::WS::Client::SetServiceTransforms {serviceName {inTransform {}} {outTransform {}}} {
variable serviceArr
dict set serviceArr($serviceName) inTransform $inTransform
dict set serviceArr($serviceName) outTransform $outTransform
return;
return
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
|
︙ | | |
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
|
-
-
-
+
+
+
+
-
+
|
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::DefineRestMethod
#
# Description : Define a method
#
# Arguments :
# serviceName - Service name to add namespace to
# methodName - The name of the method to add
# inputArgs - List of input argument definitions where each argument
# serviceName - Service name to add namespace to
# objectName - Name of the object
# operationName - The name of the method to add
# inputArgs - List of input argument definitions where each argument
# definition is of the format: name typeInfo
# returnType - The type, if any returned by the procedure. Format is:
# returnType - The type, if any returned by the procedure. Format is:
# xmlTag typeInfo
#
# where, typeInfo is of the format {type typeName comment commentString}
#
# Returns : The current service definition
#
# Side-Effects : None
|
︙ | | |
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
|
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
|
-
+
-
+
-
+
|
#
#
###########################################################################
proc ::WS::Client::DefineRestMethod {serviceName objectName operationName inputArgs returnType {location {}}} {
variable serviceArr
if {[lsearch -exact [dict get $serviceArr($serviceName) objList] $objectName] == -1} {
dict lappend $serviceArr($serviceName) objList $objectName
dict lappend serviceArr($serviceName) objList $objectName
}
if {![llength $location]} {
set location [dict get $serviceArr($serviceName) location]
}
if {![string equal $inputArgs {}]} {
if {$inputArgs ne {}} {
set inType $objectName.$operationName.Request
::WS::Utils::ServiceTypeDef Client $serviceName $inType $inputArgs
} else {
set inType {}
}
if {![string equal $returnType {}]} {
if {$returnType ne {}} {
set outType $objectName.$operationName.Results
::WS::Utils::ServiceTypeDef Client $serviceName $outType $returnType
} else {
set outType {}
}
dict set serviceArr($serviceName) object $objectName location $location
|
︙ | | |
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
|
+
+
+
+
+
-
+
-
+
-
-
+
-
-
+
-
-
-
-
-
-
+
-
-
-
+
+
-
-
-
+
+
+
|
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 01/30/2009 G.Lester Initial version
# 2.4.1 2017-08-31 H.Oehlmann Use utility function
# ::WS::Utils::geturl_fetchbody for http call
# which also follows redirects.
# 3.0.0 2020-10-26 H.Oehlmann Add geturl timeout
#
#
###########################################################################
proc ::WS::Client::ImportNamespace {serviceName url} {
variable serviceArr
set serviceInfo $serviceArr($serviceName)
switch [dict get [::uri::split $url] scheme] {
switch -exact -- [dict get [::uri::split $url] scheme] {
file {
upvar #0 [::uri::geturl $url] token
set xml $token(data)
unset token
}
http {
http -
set token [::http::geturl $url]
::http::wait $token
https {
set ncode [::http::ncode $token]
set xml [::http::data $token]
set xml [::WS::Utils::geturl_fetchbody $url\
::http::cleanup $token
if {$ncode != 200} {
return \
-code error \
-errorcode [list WS CLIENT HTTPFAIL $url] \
"HTTP get of import file failed '$url'"
-timeout [dict get $serviceInfo queryTimeout]]
}
}
default {
return \
-code error \
-errorcode [list WS CLIENT UNKURLTYP $url] \
"Unknown URL type '$url'"
}
}
set tnsCount [llength [dict get $serviceArr($serviceName) targetNamespace]]
set serviceInfo $serviceArr($serviceName)
set tnsCount [expr {[llength [dict get $serviceArr($serviceName) targetNamespace]]/2}]
dict lappend serviceInfo imports $url
::WS::Utils::ProcessImportXml Client $url $xml $serviceName serviceInfo tnsCount
set serviceArr($serviceName) $serviceInfo
set result {}
foreach pair [dict get $serviceArr($serviceName) targetNamespace] {
if {[string equal [lindex $pair 1] $url]} {
set result [lindex $pair 0]
foreach {result target} [dict get $serviceArr($serviceName) targetNamespace] {
if {$target eq $url} {
break
}
}
return $result
}
###########################################################################
#
|
︙ | | |
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
|
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
|
-
+
-
+
-
+
|
# 1 01/30/2009 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::GetOperationList {serviceName {object {}}} {
variable serviceArr
if {[string equal $object {}]} {
if {$object eq {}} {
return [dict get $serviceArr($serviceName) operList]
} else {
return [dict get $serviceArr($serviceName) operation $object inputs]
return [list $object [dict get $serviceArr($serviceName) operation $object inputs] [dict get $serviceArr($serviceName) operation $object outputs]]
}
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::AddInputHeader
#
# Description : Import and additional namespace into the service
#
# Arguments :
# serviceName - Service name to of the oepration
# serviceName - Service name to of the operation
# operation - name of operation to add an input header to
# headerType - the type name to add as a header
# attrList - list of name value pairs of attributes and their
# values to add to the XML
#
# Returns : Nothing
#
|
︙ | | |
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
|
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
|
-
+
-
+
|
variable serviceArr
set serviceInfo $serviceArr($serviceName)
set soapRequestHeader [dict get $serviceInfo operation $operationName soapRequestHeader]
lappend soapRequestHeader [list $headerType $attrList]
dict set serviceInfo operation $operationName soapRequestHeader $soapRequestHeader
set serviceArr($serviceName) $serviceInfo
return ;
return
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::AddOutputHeader
#
# Description : Import and additional namespace into the service
# Description : Import any additional namespace into the service
#
# Arguments :
# serviceName - Service name to of the oepration
# operation - name of operation to add an output header to
# headerType - the type name to add as a header
# attrList - list of name value pairs of attributes and their
# values to add to the XML
|
︙ | | |
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
|
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
|
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
+
+
+
+
+
+
+
+
|
#
#
###########################################################################
proc ::WS::Client::AddOutputHeader {serviceName operation headerType} {
variable serviceArr
set serviceInfo $serviceArr($serviceName)
set soapReplyHeader [dict get $serviceInfo operation $operationName soapReplyHeader]
set soapReplyHeader [dict get $serviceInfo operation $operation soapReplyHeader]
lappend soapReplyHeader $headerType
dict set serviceInfo operation $operationName soapReplyHeader $soapReplyHeader
dict set serviceInfo operation $operation soapReplyHeader $soapReplyHeader
set serviceArr($serviceName) $serviceInfo
return
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::GetParsedWsdl
#
# Description : Get a service definition
#
# Arguments :
# serviceName - Name of the service.
#
# Returns : The parsed service information
#
# Side-Effects : None
#
# Exception Conditions : UNKSERVICE
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 07/06/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::GetParsedWsdl {serviceName} {
variable serviceArr
if {![info exists serviceArr($serviceName)]} {
return ;
}
return \
-code error "Unknown service '$serviceName'" \
-errorcode [list UNKSERVICE $serviceName]
}
return $serviceArr($serviceName)
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
|
︙ | | |
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
|
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
-
-
-
+
+
-
-
-
+
+
+
+
-
-
+
+
-
-
+
+
-
-
-
+
+
+
+
+
+
-
+
+
+
+
-
+
+
-
+
-
+
+
-
+
-
-
+
-
-
+
+
-
|
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 07/06/2006 G.Lester Initial version
# 3.0.0 2020-10-30 H.Oehlmann Smooth option migration.
#
#
###########################################################################
proc ::WS::Client::LoadParsedWsdl {serviceInfo {headers {}} {serviceAlias {}}} {
variable serviceArr
variable options
variable serviceLocalOptionsList
if {[string length $serviceAlias]} {
set serviceName $serviceAlias
} else {
set serviceName [dict get $serviceInfo name]
}
if {$options(errorOnRedefine) && [info exists serviceArr($serviceName)]} {
return -code error "Service '$serviceName' already exists"
} elseif {[info exists serviceArr($serviceName)]} {
unset serviceArr($serviceName)
}
if {[llength $headers]} {
dict set serviceInfo headers $headers
}
set serviceArr($serviceName) $serviceInfo
##
## Copy any not present options from the default values
## This allows smooth migration, if a new version of the package define
## new options and the preparsed service of the old version was stored.
##
foreach item $serviceLocalOptionsList {
if {![dict exists $serviceArr($serviceName) $item]} {
dict set serviceArr($serviceName) $item $options($item)
}
}
if {[dict exists $serviceInfo types]} {
foreach {typeName partList} [dict get $serviceInfo types] {
set definition [dict get $partList definition]
set xns [dict get $partList xns]
set isAbstarct [dict get $partList abstract]
if {[string equal [lindex [split $typeName {:}] 1] {}]} {
::WS::Utils::ServiceTypeDef Client $serviceName $typeName $partList tns1
if {[lindex [split $typeName {:}] 1] eq {}} {
::WS::Utils::ServiceTypeDef Client $serviceName $typeName $definition tns1 $isAbstarct
} else {
set xns [lindex [split $typeName {:}] 0]
set typeName [lindex [split $typeName {:}] 1]
::WS::Utils::ServiceTypeDef Client $serviceName $typeName $partList $xns
#set typeName [lindex [split $typeName {:}] 1]
::WS::Utils::ServiceTypeDef Client $serviceName $typeName $definition $xns $isAbstarct
}
}
}
if {[dict exists $serviceInfo simpletypes]} {
foreach {typeName partList} [dict get $serviceInfo simpletypes] {
if {[string equal [lindex [split $typeName {:}] 1] {}]} {
::WS::Utils::ServiceSimpleTypeDef Client $serviceName $typeName $partList tns1
foreach partList [dict get $serviceInfo simpletypes] {
lassign $partList typeName definition
if {[lindex [split $typeName {:}] 1] eq {}} {
::WS::Utils::ServiceSimpleTypeDef Client $serviceName $typeName $definition tns1
} else {
set xns [lindex [split $typeName {:}] 0]
set typeName [lindex [split $typeName {:}] 1]
::WS::Utils::ServiceSimpleTypeDef Client $serviceName $typeName $partList $xns
#set typeName [lindex [split $typeName {:}] 1]
::WS::Utils::ServiceSimpleTypeDef Client $serviceName $typeName $definition $xns
}
}
}
return $serviceName
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::GetAndParseWsdl
#
# Description :
#
# Arguments :
# url - The url of the WSDL
# headers - Extra headers to add to the HTTP request. This
# url - The url of the WSDL
# headers - Extra headers to add to the HTTP request. This
# is a key value list argument. It must be a list with
# an even number of elements that alternate between
# keys and values. The keys become header field names.
# Newlines are stripped from the values so the header
# cannot be corrupted.
# This is an optional argument and defaults to {}.
# serviceAlias - Alias (unique) name for service.
# This is an optional argument and defaults to the name of the
# service in serviceInfo.
# serviceAlias - Alias (unique) name for service.
# This is an optional argument and defaults to the name
# of the service in serviceInfo.
# serviceNumber - Number of service within the WSDL to assign the
# serviceAlias to. Only usable with a serviceAlias.
# First service (default) is addressed by value "1".
#
# Returns : The parsed service definition
#
# Side-Effects : None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 07/06/2006 G.Lester Initial version
#
# 2.4.1 2017-08-31 H.Oehlmann Use utility function
# ::WS::Utils::geturl_fetchbody for http call
# 2.4.6 2017-12-07 H.Oehlmann Added argument "serviceNumber".
# 3.0.0 2020-10-26 H.Oehlmann Added query timeout
#
###########################################################################
proc ::WS::Client::GetAndParseWsdl {url {headers {}} {serviceAlias {}}} {
proc ::WS::Client::GetAndParseWsdl {url {headers {}} {serviceAlias {}} {serviceNumber 1}} {
variable currentBaseUrl
variable options
set currentBaseUrl $url
switch [dict get [::uri::split $url] scheme] {
switch -exact -- [dict get [::uri::split $url] scheme] {
file {
upvar #0 [::uri::geturl $url] token
set wsdlInfo [ParseWsdl $token(data) -headers $headers -serviceAlias $serviceAlias]
set wsdlInfo [ParseWsdl $token(data) -headers $headers -serviceAlias $serviceAlias -serviceNumber $serviceNumber]
unset token
}
http -
https {
set largs {}
if {[llength $headers]} {
set token [::http::geturl $url -headers $headers]
lappend largs -headers $headers
} else {
set token [::http::geturl $url]
}
set body [::WS::Utils::geturl_fetchbody $url\
::http::wait $token
set wsdlInfo [ParseWsdl [::http::data $token] -headers $headers -serviceAlias $serviceAlias]
-timeout $options(queryTimeout) {*}$largs]
set wsdlInfo [ParseWsdl $body -headers $headers -serviceAlias $serviceAlias -serviceNumber $serviceNumber]
::http::cleanup $token
}
default {
return \
-code error \
-errorcode [list WS CLIENT UNKURLTYP $url] \
"Unknown URL type '$url'"
}
|
︙ | | |
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
|
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
|
-
+
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
+
+
+
+
-
+
+
|
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::ParseWsdl
#
# Description : Parse a WSDL
# Description : Parse a WSDL and create the service. Create stubs if specified.
#
# Arguments :
# wsdlXML - XML of the WSDL
#
# Optional Arguments:
# -createStubs 0|1 - create stub routines for the service
# NOTE -- Webservice arguments are position
# independent, thus the proc arguments
# will be defined in alphabetical order.
# -headers - Extra headers to add to the HTTP request. This
# is a key value list argument. It must be a list with
# an even number of elements that alternate between
# keys and values. The keys become header field names.
# Newlines are stripped from the values so the header
# cannot be corrupted.
# This is an optional argument and defaults to {}.
# -serviceAlias - Alias (unique) name for service.
# This is an optional argument and defaults to the name of the
# service in serviceInfo.
# -serviceAlias - Alias (unique) name for service.
# This is an optional argument and defaults to the
# name of the service in serviceInfo.
# -serviceNumber - Number of service within the WSDL to assign the
# serviceAlias to. Only usable with a serviceAlias.
# First service (default) is addressed by value "1".
#
# NOTE -- Arguments are position independent.
#
# Returns : The parsed service definition
#
# Side-Effects : None
#
# Exception Conditions :None
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 07/06/2006 G.Lester Initial version
#
# 2.4.4 2017-11-03 H.Oehlmann Included ticket [dcce437d7a] with
# solution by Wolfgang Winkler:
# Search namespace prfix also in element
# nodes and not only in definition node
# of wsdl file.
# 2.4.4 2017-11-06 H.Oehlmann Added check (for nested namespace prefix
# case), that a namespace prefix is not
# reused for another URI.
# 2.4.5 2017-11-24 H.Oehlmann Added option "inlineElementNS" to activate
# namespace definition search in element nodes
# 2.4.6 2017-12-07 H.Oehlmann Added argument "-serviceNumber".
#
###########################################################################
proc ::WS::Client::ParseWsdl {wsdlXML args} {
variable currentBaseUrl
variable serviceArr
variable options
# Build the argument array with the following defaults
array set defaults {
array set argument {
-createStubs 0
-headers {}
-serviceAlias {}
-serviceNumber 1
}
array set argument $args
array set defaults $args
dom parse $wsdlXML wsdlDoc
set first [string first {<} $wsdlXML]
if {$first > 0} {
set wsdlXML [string range $wsdlXML $first end]
}
::log::logsubst debug {Parsing WSDL: $wsdlXML}
# save parsed document node to tmpdoc
dom parse $wsdlXML tmpdoc
# save transformed document handle in variable wsdlDoc
$tmpdoc xslt $::WS::Utils::xsltSchemaDom wsdlDoc
$tmpdoc delete
# save top node in variable wsdlNode
$wsdlDoc documentElement wsdlNode
set nsCount 1
set targetNs [$wsdlNode getAttribute targetNamespace]
set ::WS::Utils::targetNs $targetNs
##
## Build the namespace prefix dict
##
# nsDict contains two tables:
# 1) Lookup URI, get internal prefix
# url <URI> <tns>
# 2) Lookup wsdl namespace prefix, get internal namespace prefix
# tns <ns> <tns>
# <URI>: unique ID, mostly URL
# <ns>: namespace prefix used in wsdl
# <tns> internal namespace prefix which allows to use predefined prefixes
# not to clash with the wsdl prefix in <ns>
# Predefined:
# - tns1 : targetNamespace
# - w: http://schemas.xmlsoap.org/wsdl/
# - d: http://schemas.xmlsoap.org/wsdl/soap/
# - xs: http://www.w3.org/2001/XMLSchema
#
# The top node
# <wsdl:definitions
# targetNamespace="http://www.webserviceX.NET/">
# xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/ ...>
# contains the target namespace and all namespace definitions
dict set nsDict url $targetNs tns$nsCount
$wsdlDoc selectNodesNamespaces {
w http://schemas.xmlsoap.org/wsdl/
d http://schemas.xmlsoap.org/wsdl/soap/
s http://www.w3.org/2001/XMLSchema
xs http://www.w3.org/2001/XMLSchema
}
if {[string length $defaults(-serviceAlias)]} {
set serviceAlias $defaults(-serviceAlias)
} else {
set serviceAlias {}
##
## build list of namespace definition nodes
##
## the top node is always used
set NSDefinitionNodeList [list $wsdlNode]
##
## get namespace definitions in element nodes
##
## Element nodes may declare namespaces inline like:
## <xs:element xmlns:q1="myURI" type="q1:MessageQ1"/>
## ticket [dcce437d7a]
# This is only done, if option inlineElementNS is set in the default
# options. Service dependent options may not be used at this stage,
# as serviceArr is not created jet (Client::Config will fail) and the
# service name is not known jet.
if {$options(inlineElementNS)} {
lappend NSDefinitionNodeList {*}[$wsdlDoc selectNodes {//xs:element}]
}
foreach elemNode $NSDefinitionNodeList {
# Get list of xmlns attributes
# This list looks for the example like: {{q1 q1 {}} ... }
set xmlnsAttributes [$elemNode attributes xmlns:*]
# Loop over found namespaces
foreach itemList $xmlnsAttributes {
set ns [lindex $itemList 0]
set url [$elemNode getAttribute xmlns:$ns]
if {[dict exists $nsDict url $url]} {
set tns [dict get $nsDict url $url]
} else {
##
## Check for hardcoded namespaces
##
switch -exact -- $url {
http://schemas.xmlsoap.org/wsdl/ {
set tns w
}
http://schemas.xmlsoap.org/wsdl/soap/ {
set tns d
}
http://www.w3.org/2001/XMLSchema {
set tns xs
}
default {
set tns tns[incr nsCount]
}
}
dict set nsDict url $url $tns
}
##
## Check if same namespace prefix was already assigned to a
## different URL
##
# This may happen, if the element namespace prefix overwrites
# a global one, like
# <wsdl:definitions xmlns:q1="URI1" ...>
# <xs:element xmlns:q1="URI2" type="q1:MessageQ1"/>
if { [dict exists $nsDict tns $ns] && $tns ne [dict get $nsDict tns $ns] } {
::log::logsubst debug {Namespace prefix '$ns' with different URI '$url': $nsDict}
return \
-code error \
-errorcode [list WS CLIENT AMBIGNSPREFIX] \
"element namespace prefix '$ns' used again for different URI '$url'.\
Sorry, this is a current implementation limitation of TCLWS."
}
dict set nsDict tns $ns $tns
}
}
if {[info exists currentBaseUrl]} {
set url $currentBaseUrl
} else {
set url $targetNs
}
array unset ::WS::Utils::includeArr
::WS::Utils::ProcessIncludes $wsdlNode $url
set serviceInfo {}
foreach serviceInfo [buildServiceInfo $wsdlNode $serviceInfo $serviceAlias] {
foreach serviceInfo [buildServiceInfo $wsdlNode $nsDict $serviceInfo $argument(-serviceAlias) $argument(-serviceNumber)] {
set serviceName [dict get $serviceInfo name]
if {[llength $defaults(-headers)]} {
dict set serviceInfo headers $defaults(-headers)
if {[llength $argument(-headers)]} {
dict set serviceInfo headers $argument(-headers)
}
dict set serviceInfo types [::WS::Utils::GetServiceTypeDef Client $serviceName]
dict set serviceInfo simpletypes [::WS::Utils::GetServiceSimpleTypeDef Client $serviceName]
set serviceArr($serviceName) $serviceInfo
if {$defaults(-createStubs)} {
if {$argument(-createStubs)} {
catch {namespace delete $serviceName}
namespace eval $serviceName {}
CreateStubs $serviceName
}
}
$wsdlDoc delete
unset -nocomplain ::WS::Utils::targetNs
return $serviceInfo
}
###########################################################################
#
|
︙ | | |
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
|
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
|
+
+
+
-
+
-
+
-
+
-
+
-
+
|
}
set serviceInfo $serviceArr($serviceName)
set procList {}
foreach operationName [dict get $serviceInfo operList] {
if {[dict get $serviceInfo operation $operationName cloned]} {
continue
}
set procName [format {::%s::%s} $serviceName $operationName]
set argList {}
foreach inputHeaderTypeItem [dict get $serviceInfo operation $operationName soapRequestHeader] {
set inputHeaderType [lindex $inputHeaderTypeItem 0]
if {[string equal $inputHeaderType {}]} {
if {$inputHeaderType eq {}} {
continue
}
set headerTypeInfo [::WS::Utils::GetServiceTypeDef Client $serviceName $inputHeaderType]
set headerFields [dict keys [dict get $headerTypeInfo definition]]
if {![string equal $headerFields {}]} {
if {$headerFields ne {}} {
lappend argList [lsort -dictionary $headerFields]
}
}
set inputMsgType [dict get $serviceInfo operation $operationName inputs]
## Petasis, 14 July 2008: If an input message has no elements, just do
## not add any arguments...
set inputMsgTypeDefinition [::WS::Utils::GetServiceTypeDef Client $serviceName $inputMsgType]
if {[dict exists $inputMsgTypeDefinition definition]} {
set inputFields [dict keys [dict get $inputMsgTypeDefinition definition]]
} else {
::log::log debug "no definition found for inputMsgType $inputMsgType"
::log::logsubst debug {no definition found for inputMsgType $inputMsgType}
set inputFields {}
}
if {![string equal $inputFields {}]} {
if {$inputFields ne {}} {
lappend argList [lsort -dictionary $inputFields]
}
set argList [join $argList]
set body {
set procName [lindex [info level 0] 0]
set serviceName [string trim [namespace qualifiers $procName] {:}]
set operationName [string trim [namespace tail $procName] {:}]
set argList {}
foreach var [namespace eval ::${serviceName}:: [list info args $operationName]] {
lappend argList $var [set $var]
}
::log::log debug [list ::WS::Client::DoCall $serviceName $operationName $argList]
::log::logsubst debug {::WS::Client::DoCall $serviceName $operationName $argList}
::WS::Client::DoCall $serviceName $operationName $argList
}
proc $procName $argList $body
append procList "\n\t[list $procName $argList]"
}
return "$procList\n"
}
|
︙ | | |
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
|
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
|
-
+
-
+
+
+
+
+
-
+
+
+
+
+
+
+
-
+
+
+
+
+
+
-
+
-
-
-
-
-
+
-
-
-
+
-
+
-
-
-
-
-
-
-
+
+
-
-
+
-
-
-
-
-
+
+
-
-
-
-
-
-
+
+
+
+
+
+
-
-
+
-
+
+
+
+
+
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
-
+
+
+
+
+
+
+
-
-
+
-
-
-
+
-
+
+
+
+
+
-
+
-
+
-
-
-
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
+
-
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
+
-
+
-
+
|
# Procedure Name : ::WS::Client::DoRawCall
#
# Description : Call an operation of a web service
#
# Arguments :
# serviceName - The name of the Webservice
# operationName - The name of the Operation to call
# argList - The arguements to the operation as a dictionary object.
# argList - The arguments to the operation as a dictionary object.
# This is for both the Soap Header and Body messages.
# headers - Extra headers to add to the HTTP request. This
# is a key value list argument. It must be a list with
# an even number of elements that alternate between
# keys and values. The keys become header field names.
# Newlines are stripped from the values so the header
# cannot be corrupted.
# This is an optional argument and defaults to {}.
#
# Returns :
# The XML of the operation.
#
# Side-Effects : None
#
# Exception Conditions :
# WSCLIENT HTTPERROR - if an HTTP error occured
# WS CLIENT HTTPERROR - if an HTTP error occurred
#
# Pre-requisite Conditions : Service must have been defined.
#
# Original Author : Gerald W. Lester
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 07/06/2006 G.Lester Initial version
# 2.4.1 2017-08-31 H.Oehlmann Use utility function
# ::WS::Utils::geturl_fetchbody for http call
# which also follows redirects.
# 3.0.0 2020-10-26 H.Oehlmann Added query timeout
#
#
###########################################################################
proc ::WS::Client::DoRawCall {serviceName operationName argList {headers {}}} {
variable serviceArr
::log::log debug "Entering ::WS::Client::DoRawCall {$serviceName $operationName $argList}"
::log::logsubst debug {Entering [info level 0]}
if {![info exists serviceArr($serviceName)]} {
return \
-code error \
-errorcode [list WS CLIENT UNKSRV $serviceName] \
"Unknown service '$serviceName'"
}
set serviceInfo $serviceArr($serviceName)
if {![dict exists $serviceInfo operation $operationName]} {
return \
-code error \
-errorcode [list WS CLIENT UNKOPER [list $serviceName $operationName]] \
"Unknown operation '$operationName' for service '$serviceName'"
}
##
## build query
##
set url [dict get $serviceInfo location]
SaveAndSetOptions $serviceName
set query [buildCallquery $serviceName $operationName $url $argList]
if {[catch {set query [buildCallquery $serviceName $operationName $url $argList]} err]} {
RestoreSavedOptions $serviceName
return -code error -errorcode $::errorCode -errorinfo $::errorInfo $err
} else {
RestoreSavedOptions $serviceName
}
if {[dict exists $serviceInfo headers]} {
set headers [concat $headers [dict get $serviceInfo headers]]
}
if {[dict exists $serviceInfo operation $operationName action]} {
lappend headers SOAPAction [dict get $serviceInfo operation $operationName action]
lappend headers SOAPAction [format {"%s"} [dict get $serviceInfo operation $operationName action]]
}
if {[llength $headers]} {
set token [::http::geturl $url -query $query -type text/xml -headers $headers]
} else {
set token [::http::geturl $url -query $query -type text/xml]
}
::http::wait $token
##
## Check for errors
## do http call
##
set body [::http::data $token]
if {![string equal [::http::status $token] ok] ||
([::http::ncode $token] != 200 && [string equal $body {}])} {
set errorCode [list WSCLIENT HTTPERROR [::http::code $token]]
set errorInfo {}
set results [::http::error $token]
set hadError 1
} else {
set largs {}
if {[llength $headers]} {
set hadError 0
set results [::http::data $token]
lappend largs -headers $headers
}
::http::cleanup $token
if {$hadError} {
::log::log debug "Leaving (error) ::WS::Client::DoRawCall"
return \
-code error \
set body [::WS::Utils::geturl_fetchbody $url\
-query $query\
-errorcode $errorCode \
-errorinfo $errorInfo \
$results
} else {
::log::log debug "Leaving ::WS::Client::DoRawCall with {$results}"
return $results
-type [dict get $serviceInfo contentType]\
-timeout [dict get $serviceInfo queryTimeout]\
{*}$largs]
::log::logsubst debug {Leaving ::WS::Client::DoRawCall with {$body}}
return $body
}
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::DoCall
#
# Description : Call an operation of a web service
#
# Arguments :
# serviceName - The name of the Webservice
# operationName - The name of the Operation to call
# argList - The arguements to the operation as a dictionary object
# argList - The arguments to the operation as a dictionary object
# This is for both the Soap Header and Body messages.
# headers - Extra headers to add to the HTTP request. This
# is a key value list argument. It must be a list with
# an even number of elements that alternate between
# keys and values. The keys become header field names.
# Newlines are stripped from the values so the header
# cannot be corrupted.
# This is an optional argument and defaults to {}.
#
# Returns :
# The return value of the operation as a dictionary object.
#
# Side-Effects : None
#
# Exception Conditions :
# WSCLIENT HTTPERROR - if an HTTP error occured
# WS CLIENT HTTPERROR - if an HTTP error occurred
# others - as raised by called Operation
#
# Pre-requisite Conditions : Service must have been defined.
#
# Original Author : Gerald W. Lester
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 07/06/2006 G.Lester Initial version
# 2.4.1 2017-08-30 H.Oehlmann Use ::WS::Utils::geturl_fetchbody to do
# http call. This automates a lot and follows
# redirects.
# 3.0.0 2020-10-26 H.Oehlmann Added query timeout
#
#
###########################################################################
proc ::WS::Client::DoCall {serviceName operationName argList {headers {}}} {
variable serviceArr
::log::log debug "Entering ::WS::Client::DoCall {$serviceName $operationName $argList}"
::log::logsubst debug {Entering [info level 0]}
if {![info exists serviceArr($serviceName)]} {
return \
-code error \
-errorcode [list WS CLIENT UNKSRV $serviceName] \
"Unknown service '$serviceName'"
}
set serviceInfo $serviceArr($serviceName)
if {![dict exists $serviceInfo operation $operationName]} {
return \
-code error \
-errorcode [list WS CLIENT UNKOPER [list $serviceName $operationName]] \
"Unknown operation '$operationName' for service '$serviceName'"
} elseif {[dict get $serviceInfo operation $operationName cloned]} {
return \
-code error \
-errorcode [list WS CLIENT MUSTCALLCLONE [list $serviceName $operationName]] \
"Operation '$operationName' for service '$serviceName' is overloaded, you must call one of its clones."
}
set url [dict get $serviceInfo location]
SaveAndSetOptions $serviceName
set query [buildCallquery $serviceName $operationName $url $argList]
if {[catch {set query [buildCallquery $serviceName $operationName $url $argList]} err]} {
RestoreSavedOptions $serviceName
return -code error -errorcode $::errorCode -errorinfo $::errorInfo "buildCallquery error -- $err"
} else {
RestoreSavedOptions $serviceName
}
if {[dict exists $serviceInfo headers]} {
set headers [concat $headers [dict get $serviceInfo headers]]
}
if {[dict exists $serviceInfo operation $operationName action]} {
lappend headers SOAPAction [dict get $serviceInfo operation $operationName action]
lappend headers SOAPAction [format {"%s"} [dict get $serviceInfo operation $operationName action]]
}
##
## Do the http request
##
# This will directly return with correct error
# side effect: sets the variable httpCode
set largs {}
if {[llength $headers]} {
::log::log debug [list ::http::geturl $url -query $query -type text/xml -headers $headers]
set token [::http::geturl $url -query $query -type text/xml -headers $headers]
lappend largs -headers $headers
} else {
::log::log debug [list ::http::geturl $url -query $query -type text/xml]
set token [::http::geturl $url -query $query -type text/xml]
}
set body [::WS::Utils::geturl_fetchbody -codeok {200 500} -codevar httpCode $url\
::http::wait $token
-query $query\
-type [dict get $serviceInfo contentType]\
-headers $headers\
{*}$largs]
# numerical http code was saved in variable httpCode
##
## Check for errors
## Process body
##
set body [::http::data $token]
set outTransform [dict get $serviceInfo outTransform]
::log::log debug "\tReceived: $body"
set httpStatus [::http::status $token]
if {![string equal $httpStatus ok] ||
if {$httpCode == 500} {
## Code 500 treatment
if {$outTransform ne {}} {
SaveAndSetOptions $serviceName
catch {set body [$outTransform $serviceName $operationName REPLY $body]}
RestoreSavedOptions $serviceName
}
set hadError [catch {parseResults $serviceName $operationName $body} results]
if {$hadError} {
([::http::ncode $token] != 200 && [string equal $body {}])} {
::log::log debug "\tHTTP error [array get $token]"
set results [::http::error $token]
lassign $::errorCode mainError subError
if {$mainError eq {WSCLIENT} && $subError eq {NOSOAP}} {
::log::logsubst debug {\tHTTP error $body}
set results $body
if {[string equal $results {}] || [string equal $httpStatus eof]} {
set results {Unexpected EOF received from Server}
set errorCode [list WSCLIENT HTTPERROR UNEXPEOF]
} else {
set errorCode [list WSCLIENT HTTPERROR [::http::code $token]]
}
set errorCode [list WSCLIENT HTTPERROR $body]
set errorInfo {}
} else {
::log::logsubst debug {Reply was $body}
set errorCode $::errorCode
set errorInfo $::errorInfo
}
set errorInfo {}
set hadError 1
}
} else {
if {$outTransform ne {}} {
SaveAndSetOptions $serviceName
catch {set body [$outTransform $serviceName $operationName REPLY $body]}
RestoreSavedOptions $serviceName
}
SaveAndSetOptions $serviceName
set hadError [catch {parseResults $serviceName $operationName $body} results]
RestoreSavedOptions $serviceName
if {$hadError} {
::log::log debug "Reply was [::http::data $token]"
::log::logsubst debug {Reply was $body}
set errorCode $::errorCode
set errorInfo $::errorInfo
}
}
::http::cleanup $token
if {$hadError} {
::log::log debug "Leaving (error) ::WS::Client::DoCall"
return \
-code error \
-errorcode $errorCode \
-errorinfo $errorInfo \
$results
} else {
::log::log debug "Leaving ::WS::Client::DoCall with {$results}"
::log::logsubst debug {Leaving ::WS::Client::DoCall with {$results}}
return $results
}
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::FormatHTTPError
#
# Description : Format error after a http::geturl failure.
# A failure consists wether in the HTTP return code unequal to 200
# or in the status equal "error". Status "timeout" is untreated, as this
# http feature is not used in the package.
#
# Arguments :
# tolken - tolken of the http::geturl request
#
# Returns :
# Error message
#
# Side-Effects : None
#
# Pre-requisite Conditions : HTTP failure must be present
#
# Original Author : Harald Oehlmann
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 06/02/2015 H.Oehlmann Initial version
#
#
###########################################################################
proc ::WS::Client::FormatHTTPError {token} {
if {[::http::status $token] eq {ok}} {
if {[::http::size $token] == 0} {
return "HTTP failure socket closed"
}
return "HTTP failure code [::http::ncode $token]"
} else {
return "HTTP error: [::http::error $token]"
}
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::DoAsyncCall
#
# Description : Call an operation of a web service asynchronously
#
# Arguments :
# serviceName - The name of the Webservice
# operationName - The name of the Operation to call
# argList - The arguements to the operation as a dictionary object
# argList - The arguments to the operation as a dictionary object
# This is for both the Soap Header and Body messages.
# succesCmd - A command prefix to be called if the operations
# does not raise an error. The results, as a dictionary
# object are concatinated to the prefix.
# object are concatenated to the prefix.
# errorCmd - A command prefix to be called if the operations
# raises an error. The error code and stack trace
# are concatinated to the prefix.
# are concatenated to the prefix.
# headers - Extra headers to add to the HTTP request. This
# is a key value list argument. It must be a list with
# an even number of elements that alternate between
# keys and values. The keys become header field names.
# Newlines are stripped from the values so the header
# cannot be corrupted.
# This is an optional argument and defaults to {}.
#
# Returns :
# None.
#
# Side-Effects : None
#
# Exception Conditions :
# WSCLIENT HTTPERROR - if an HTTP error occured
# WS CLIENT HTTPERROR - if an HTTP error occurred
# others - as raised by called Operation
#
# Pre-requisite Conditions : Service must have been defined.
#
# Original Author : Gerald W. Lester
#
#>>END PUBLIC<<
|
︙ | | |
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
|
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
|
-
+
+
-
+
+
+
+
+
+
+
+
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
|
# 1 07/06/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::DoAsyncCall {serviceName operationName argList succesCmd errorCmd {headers {}}} {
variable serviceArr
::log::log debug "Entering ::WS::Client::DoAsyncCall [list $serviceName $operationName $argList $succesCmd $errorCmd $headers]"
::log::logsubst debug {Entering [info level 0]}
if {![info exists serviceArr($serviceName)]} {
return \
-code error \
-errorcode [list WS CLIENT UNKSRV $serviceName] \
"Unknown service '$serviceName'"
}
set serviceInfo $serviceArr($serviceName)
if {![dict exists $serviceInfo operation $operationName]} {
return \
-code error \
-errorcode [list WS CLIENT UNKOPER [list $serviceName $operationName]] \
"Unknown operation '$operationName' for service '$serviceName'"
}
if {[dict exists $serviceInfo headers]} {
set headers [concat $headers [dict get $serviceInfo headers]]
}
set url [dict get $serviceInfo location]
SaveAndSetOptions $serviceName
set query [buildCallquery $serviceName $operationName $url $argList]
if {[catch {set query [buildCallquery $serviceName $operationName $url $argList]} err]} {
RestoreSavedOptions $serviceName
return -code error -errorcode $::errorCode -errorinfo $::errorInfo $err
} else {
RestoreSavedOptions $serviceName
}
set largs {}
if {[llength $headers]} {
lappend largs -headers $headers
}
::http::geturl $url \
::log::logsubst info {::http::geturl $url \
-query $query \
-type text/xml \
-type [dict get $serviceInfo contentType] \
-headers $headers \
-command [list ::WS::Client::asyncCallDone $serviceName $operationName $succesCmd $errorCmd]
} else {
::http::geturl $url \
-query $query \
-type text/xml \
-command [list ::WS::Client::asyncCallDone $serviceName $operationName $succesCmd $errorCmd]
}
::log::log debug "Leaving ::WS::Client::DoAsyncCall"
return;
-command [list ::WS::Client::asyncCallDone $serviceName $operationName $succesCmd $errorCmd]\
-timeout [dict get $serviceInfo queryTimeout] \
{*}$largs}
::http::geturl $url \
-query $query \
-type [dict get $serviceInfo contentType] \
-command [list ::WS::Client::asyncCallDone $serviceName $operationName $succesCmd $errorCmd] \
-timeout [dict get $serviceInfo queryTimeout] \
{*}$largs
::log::logsubst debug {Leaving ::WS::Client::DoAsyncCall}
return
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
|
︙ | | |
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
|
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
|
+
-
+
+
+
-
+
-
+
+
-
-
-
+
+
+
+
+
+
+
|
"Unknown service '$serviceName'"
}
set serviceInfo $serviceArr($serviceName)
set procList {}
foreach operationName [lsort -dictionary [dict get $serviceInfo operList]] {
foreach operationName [dict get $serviceInfo operList] {
if {[dict get $serviceInfo operation $operationName cloned]} {
continue
}
set procName $operationName
set argList {}
foreach inputHeaderTypeItem [dict get $serviceInfo operation $operationName soapRequestHeader] {
set inputHeaderType [lindex $inputHeaderTypeItem 0]
if {[string equal $inputHeaderType {}]} {
if {$inputHeaderType eq {}} {
continue
}
set headerTypeInfo [::WS::Utils::GetServiceTypeDef Client $serviceName $inputHeaderType]
set headerFields [dict keys [dict get $headerTypeInfo definition]]
if {![string equal $headerFields {}]} {
if {$headerFields ne {}} {
lappend argList [lsort -dictionary $headerFields]
}
}
set inputMsgType [dict get $serviceInfo operation $operationName inputs]
if {$inputMsgType ne {}} {
set inputFields [dict keys [dict get [::WS::Utils::GetServiceTypeDef Client $serviceName $inputMsgType] definition]]
if {![string equal $inputFields {}]} {
lappend argList [lsort -dictionary $inputFields]
set inTypeDef [::WS::Utils::GetServiceTypeDef Client $serviceName $inputMsgType]
if {[dict exists $inTypeDef definition]} {
set inputFields [dict keys [dict get $inTypeDef definition]]
if {$inputFields ne {}} {
lappend argList [lsort -dictionary $inputFields]
}
}
}
set argList [join $argList]
append procList "\n\t$procName $argList"
}
return "$procList\n"
}
|
︙ | | |
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
|
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
|
-
+
-
+
-
+
|
foreach object [dict get $serviceInfo objList] {
foreach operationName [dict keys [dict get $serviceInfo object $object operations]] {
set procName $operationName
set argList {}
foreach inputHeaderTypeItem [dict get $serviceInfo operation $operationName soapRequestHeader] {
set inputHeaderType [lindex $inputHeaderTypeItem 0]
if {[string equal $inputHeaderType {}]} {
if {$inputHeaderType eq {}} {
continue
}
set headerTypeInfo [::WS::Utils::GetServiceTypeDef Client $serviceName $inputHeaderType]
set headerFields [dict keys [dict get $headerTypeInfo definition]]
if {![string equal $headerFields {}]} {
if {$headerFields ne {}} {
lappend argList [lsort -dictionary $headerFields]
}
}
set inputMsgType [dict get $serviceInfo operation $operationName inputs]
set inputFields [dict keys [dict get [::WS::Utils::GetServiceTypeDef Client $serviceName $inputMsgType] definition]]
if {![string equal $inputFields {}]} {
if {$inputFields ne {}} {
lappend argList [lsort -dictionary $inputFields]
}
set argList [join $argList]
append procList "\n\t$object $procName $argList"
}
}
|
︙ | | |
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
|
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
|
-
+
+
+
-
-
-
+
+
+
+
-
+
+
+
+
+
-
-
-
+
+
+
+
+
-
-
+
|
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 07/06/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::asyncCallDone {serviceName operationName succesCmd errorCmd token} {
::log::log debug "Entering ::WS::Client::asyncCallDone {$serviceName $operationName $succesCmd $errorCmd $token}"
::log::logsubst debug {Entering [info level 0]}
##
## Check for errors
##
set body [::http::data $token]
::log::logsubst info {\nReceived: $body}
set results {}
if {![string equal [::http::status $token] ok] ||
([::http::ncode $token] != 200 && [string equal $body {}])} {
set errorCode [list WSCLIENT HTTPERROR [::http::code $token]]
if {[::http::status $token] ne {ok} ||
( [::http::ncode $token] != 200 && $body eq {} )} {
set errorCode [list WS CLIENT HTTPERROR [::http::code $token]]
set hadError 1
set results [FormatHTTPError $token]
set errorInfo [::http::error $token]
set errorInfo ""
} else {
SaveAndSetOptions $serviceName
set hadError [catch {parseResults $serviceName $operationName $body} results]
RestoreSavedOptions $serviceName
if {$hadError} {
set errorCode $::errorCode
set errorInfo $::errorInfo
}
}
::http::cleanup $token
##
## Call the appropriate callback
##
if {$hadError} {
set cmd $errorCmd
lappend cmd $errorCode $errorInfo
} else {
set cmd $succesCmd
}
if {$cmd ne ""} {
lappend cmd $results
catch $cmd
lappend cmd $results
if {[catch $cmd cmdErr]} {
::log::log error "Error invoking callback '$cmd': $cmdErr"
}
}
##
## All done
##
::http::cleanup $token
return;
return
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
|
︙ | | |
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
|
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
|
-
+
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
-
+
-
+
-
-
-
-
+
+
+
+
+
+
+
-
+
+
+
+
-
-
+
+
-
+
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
-
-
+
-
+
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
+
-
-
-
+
+
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-
+
+
+
+
-
-
-
-
-
-
+
+
+
-
+
-
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
# inXML - the XML returned by the operation
#
# Returns : A dictionary object representing the results
#
# Side-Effects : None
#
# Exception Conditions :
# WSCLIENT REMERR - The remote end raised an exception, the third element of
# WS CLIENT REMERR - The remote end raised an exception, the third element of
# the error code is the remote fault code.
# Error info is set to the remote fault details.
# The error message is the remote fault string;
# WSCLIENT BADREPLY - Badly formatted reply, the third element is a list of
# The error message is the remote fault string.
# WS CLIENT BADREPLY - Badly formatted reply, the third element is a list of
# what message type was received vs what was expected.
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
#
#>>END PRIVATE<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 07/06/2006 G.Lester Initial version
#
# 2.4.2 2017-08-31 H.Oehlmann The response node name may also be the
# output name and not only the output type.
# (ticket [21f41e22bc]).
# 2.4.3 2017-11-03 H.Oehlmann Extended upper commit also to search
# for multiple child nodes.
# 2.5.1 2018-05-14 H.Oehlmann Add support to translate namespace prefixes
# in attribute values or text values.
# Translation dict "xnsDistantToLocalDict" is
# passed to ::WS::Utils::convertTypeToDict
# to translate abstract types.
#
###########################################################################
proc ::WS::Client::parseResults {serviceName operationName inXML} {
variable serviceArr
::log::log debug "In parseResults $serviceName $operationName {$inXML}"
::log::logsubst debug {Entering [info level 0]}
set serviceInfo $serviceArr($serviceName)
set outTransform [dict get $serviceInfo outTransform]
if {![string equal $outTransform {}]} {
set inXML [$outTransform $serviceName $operationName REPLY $inXML]
}
set expectedMsgType [dict get $serviceInfo operation $operationName outputs]
set expectedMsgTypeBase [lindex [split $expectedMsgType {:}] end]
set first [string first {<} $inXML]
if {$first > 0} {
set inXML [string range $inXML $first end]
}
set expectedMsgType [dict get $serviceInfo operation $operationName outputs]
# parse xml and save handle in variable doc and free it when out of scope
dom parse $inXML doc
# save top node handle in variable top and free it if out of scope
$doc documentElement top
set xns {
ENV http://schemas.xmlsoap.org/soap/envelope/
xsi "http://www.w3.org/2001/XMLSchema-instance"
xs "http://www.w3.org/2001/XMLSchema"
}
foreach tmp [dict get $serviceInfo targetNamespace] {
lappend xns [lindex $tmp 0] [lindex $tmp 1]
foreach {prefixCur URICur} [dict get $serviceInfo targetNamespace] {
lappend xns $prefixCur $URICur
}
::log::log debug "Using namespaces {$xns}"
::log::logsubst debug {Using namespaces {$xns}}
$doc selectNodesNamespaces $xns
set body [$top selectNodes ENV:Body]
set rootNode [$body childNodes]
::log::log debug "Have [llength $rootNode]"
if {[llength $rootNode] > 1} {
foreach tmp $rootNode {
##
## When arguments with tags are passed (example: abstract types),
## the upper "selectNodesNamespaces translation must be executed manually.
## Thus, we need a list of server namespace prefixes to our client namespace
## prefixes. (bug 584bfb77)
##
# Example xml:
# <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
# xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
# xmlns:xsd="http://www.w3.org/2001/XMLSchema"
# xmlns:tns="http://www.esri.com/schemas/ArcGIS/10.3">
set xnsDistantToLocalDict {}
foreach attributeCur [$top attributes] {
# attributeCur is a list of "prefix local URI",
# which is for xmlns tags: "prefix prefix {}".
set attributeCur [lindex $attributeCur 0]
# Check if this is a namespace prefix
if { ! [$top hasAttribute "xmlns:$attributeCur"] } {continue}
set URIServer [$top getAttribute "xmlns:$attributeCur"]
# Check if it is included in xns
foreach {prefixCur URICur} $xns {
#puts "\t Got {[$tmp localName]} looking for {$expectedMsgType}"
if {[string equal [$tmp localName] $expectedMsgType] ||
if {$URIServer eq $URICur} {
[string equal [$tmp nodeName] $expectedMsgType]} {
set rootNode $tmp
dict set xnsDistantToLocalDict $attributeCur $prefixCur
break
}
}
}
if {![string equal $rootNode {}]} {
::log::logsubst debug {Server to Client prefix dict: $xnsDistantToLocalDict}
set rootName [$rootNode localName]
if {[string equal $rootName {}]} {
set rootName [$rootNode nodeName]
}
} else {
set rootName {}
##
## Get body tag
##
set body [$top selectNodes ENV:Body]
if {![llength $body]} {
return \
-code error \
-errorcode [list WS CLIENT BADREPLY $inXML] \
"Bad reply type, no SOAP envelope received in: \n$inXML"
}
##
## Find the reply root node with the response.
##
# <SOAP-ENV:Envelope...>
# <SOAP-ENV:Body>
# <i2:TestResponse id="ref-1" xmlns:i2=...> <-- this one
#
# WSDL 1.0: http://xml.coverpages.org/wsdl20000929.html
# Chapter 2.4.2 (name optional) and 2.4.5 (default name)
# The node name could be:
# 1) an error node "Fault"
# 2) equal to the WSDL name property of the output node
# 3) if no name tag, equal to <Operation>Response
# 4) the local output type name
#
# Possibility (2) "OutName" WSDL example:
# <wsdl:portType...><wsdl:operation...>
# <wsdl:output name="{OutName}" message="tns:{OutMsgName}" />
# This possibility is requested by ticket [21f41e22bc]
#
# Possibility (3) default name "{OperationName}Result" WSDL example:
# <wsdl:portType...><wsdl:operation name="{OperationName}">
# <wsdl:output message="tns:{OutMsgName}" -> *** no name tag ***
#
# Possibility (4) was not found in wsdl 1.0 standard but was used as only
# solution by TCLWS prior to 2.4.2.
# The following sketch shows the location of the local output type name
# "OutTypeName" in a WSDL file:
# -> In WSDL portType output message name
# <wsdl:portType...><wsdl:operation...>
# <wsdl:output message="tns:{OutMsgName}" />
# -> then in message, use the element:
::log::log debug "root name is {$rootName}"
# <wsdl:message name="{OutMsgName}">
# <wsdl:part name="..." element="tns:<{OutTypeName}>" />
# -> The element "OutTypeName" is also find in a type definition:
# <wsdl:types>
# <s:element name="{OutMsgName}">
# <s:complexType>...
#
# Build a list of possible names
set nodeNameCandidateList [list Fault $expectedMsgTypeBase]
# We check if the preparsed wsdl contains the name flag.
# This is not the case, if it was parsed with tclws prior 2.4.2
# *** ToDo *** This security may be removed on a major release
##
## See if it is a standard error packet
##
if {[string equal $rootName {Fault}]} {
set faultcode {}
set faultstring {}
set errorInfo {}
if {[dict exists $serviceInfo operation $operationName outputsname]} {
if {[catch {set faultcode [[$rootNode selectNodes ENV:faultcode] asText]}]} {
catch {set faultcode [[$rootNode selectNodes faultcode] asText]}
}
lappend nodeNameCandidateList [dict get $serviceInfo operation $operationName outputsname]
}
if {[catch {set faultstring [[$rootNode selectNodes ENV:faultstring] asText]}]} {
catch {set faultstring [[$rootNode selectNodes faultstring] asText]}
}
if {[catch {set errorInfo [[$rootNode selectNodes ENV:detail] asXML]}]} {
catch {set errorInfo [[$rootNode selectNodes detail/] asXML]}
set rootNodeList [$body childNodes]
::log::logsubst debug {Have [llength $rootNodeList] node under Body}
foreach rootNodeCur $rootNodeList {
set rootNameCur [$rootNodeCur localName]
if {$rootNameCur eq {}} {
set rootNameCur [$rootNodeCur nodeName]
}
if {$rootNameCur in $nodeNameCandidateList} {
$doc delete
return \
set rootNode $rootNodeCur
set rootName $rootNameCur
::log::logsubst debug {Result root name is '$rootName'}
break
-code error \
-errorcode [list WSCLIENT REMERR $faultcode] \
-errorinfo $errorInfo \
$faultstring
}
}
::log::logsubst debug {Result root name '$rootNameCur' not in candidates '$nodeNameCandidateList'}
}
##
## Validated that it is the expected packet type
## Exit if there is no such node
##
if {![string equal $rootName $expectedMsgType]} {
if {![info exists rootName]} {
$doc delete
return \
-code error \
-errorcode [list WSCLIENT BADREPLY [list $rootName $expectedMsgType]] \
"Bad reply type, received '$rootName; but expected '$expectedMsgType'."
-errorcode [list WS CLIENT BADREPLY [list $rootNameCur $expectedMsgTypeBase]] \
"Bad reply type, received '$rootNameCur'; but expected '$expectedMsgTypeBase'."
}
##
## See if it is a standard error packet
##
if {$rootName eq {Fault}} {
set faultcode {}
set faultstring {}
set detail {}
foreach item {faultcode faultstring detail} {
set tmpNode [$rootNode selectNodes ENV:$item]
if {$tmpNode eq {}} {
set tmpNode [$rootNode selectNodes $item]
}
if {$tmpNode ne {}} {
if {[$tmpNode hasAttribute href]} {
set tmpNode [GetReferenceNode $top [$tmpNode getAttribute href]]
}
set $item [$tmpNode asText]
}
}
$doc delete
return \
-code error \
-errorcode [list WS CLIENT REMERR $faultcode] \
-errorinfo $detail \
$faultstring
}
##
## Convert the packet to a dictionary
##
set results {}
set headerRootNode [$top selectNodes ENV:Header]
if {[llength $headerRootNode]} {
foreach outHeaderType [dict get $serviceInfo operation $operationName soapReplyHeader] {
if {[string equal $outHeaderType {}]} {
continue
}
set xns [dict get [::WS::Utils::GetServiceTypeDef Client $serviceName $outputHeaderType] xns]
set node [$headerRootNode selectNodes $xns:outHeaderType]
if {[llength $outHeaderAttrs]} {
::WS::Utils::setAttr $node $outHeaderAttrs
foreach outHeaderType [dict get $serviceInfo operation $operationName soapReplyHeader] {
if {$outHeaderType eq {}} {
continue
}
set xns [dict get [::WS::Utils::GetServiceTypeDef Client $serviceName $outHeaderType] xns]
set node [$headerRootNode selectNodes $outHeaderType]
if {![llength $node]} {
set node [$headerRootNode selectNodes $xns:$outHeaderType]
if {![llength $node]} {
continue
}
}
#if {[llength $outHeaderAttrs]} {
# ::WS::Utils::setAttr $node $outHeaderAttrs
}
::log::log debug "Calling [list ::WS::Utils::convertTypeToDict Client $serviceName $node $outHeaderType $headerRootNode]"
lappend results [::WS::Utils::convertTypeToDict Client $serviceName $node $outHeaderType $headerRootNode]
}
#}
::log::logsubst debug {Calling convertTypeToDict from header node type '$outHeaderType'}
lappend results [::WS::Utils::convertTypeToDict Client $serviceName $node $outHeaderType $headerRootNode 0 $xnsDistantToLocalDict]
}
::log::log debug "Calling [list ::WS::Utils::convertTypeToDict Client $serviceName $rootNode $expectedMsgType $body]"
if {![string equal $rootName {}]} {
lappend results [::WS::Utils::convertTypeToDict \
Client $serviceName $rootNode $expectedMsgType $body]
}
##
## Call Utility function to build result list
##
if {$rootName ne {}} {
::log::log debug "Calling convertTypeToDict with root node"
set bodyData [::WS::Utils::convertTypeToDict \
Client $serviceName $rootNode $expectedMsgType $body 0 $xnsDistantToLocalDict]
if {![llength $bodyData] && ([dict get $serviceInfo skipLevelWhenActionPresent] || [dict get $serviceInfo skipLevelOnReply])} {
::log::log debug "Calling convertTypeToDict with skipped action level (skipLevelWhenActionPresent was set)"
set bodyData [::WS::Utils::convertTypeToDict \
Client $serviceName $body $expectedMsgType $body 0 $xnsDistantToLocalDict]
}
lappend results $bodyData
}
set results [join $results]
$doc delete
set ::errorCode {}
set ::errorInfo {}
return $results
|
︙ | | |
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
|
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
|
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
-
-
+
+
+
+
-
-
+
+
-
+
|
###########################################################################
proc ::WS::Client::buildCallquery {serviceName operationName url argList} {
variable serviceArr
set serviceInfo $serviceArr($serviceName)
set style [dict get $serviceInfo operation $operationName style]
set suppressTargetNS [dict get $serviceInfo suppressTargetNS]
set inSuppressNs [::WS::Utils::SetOption suppressNS]
if {$suppressTargetNS} {
::WS::Utils::SetOption suppressNS tns1
} else {
::WS::Utils::SetOption suppressNS {}
switch $style {
}
switch -exact -- $style {
document/literal {
set xml [buildDocLiteralCallquery $serviceName $operationName $url $argList]
}
rpc/encoded {
set xml [buildRpcEncodedCallquery $serviceName $operationName $url $argList]
}
default {
return \
-code error \
"Unsupported Style '$style'"
}
}
}
::WS::Utils::SetOption suppressNS $inSuppressNs
set inTransform [dict get $serviceInfo inTransform]
if {![string equal $inTransform {}]} {
set query [$inTransform $serviceName $operationName REQUEST $xml $url $argList]
if {$inTransform ne {}} {
set xml [$inTransform $serviceName $operationName REQUEST $xml $url $argList]
}
::log::log debug "Leaving ::::WS::Client::buildCallquery with {$xml}"
::log::logsubst debug {Leaving ::WS::Client::buildCallquery with {$xml}}
return $xml
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
|
︙ | | |
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
|
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
|
-
+
+
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
-
+
-
+
|
# 1 07/06/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::buildDocLiteralCallquery {serviceName operationName url argList} {
variable serviceArr
::log::log debug "Entering [info level 0]"
::log::logsubst debug {Entering [info level 0]}
set serviceInfo $serviceArr($serviceName)
set msgType [dict get $serviceInfo operation $operationName inputs]
set url [dict get $serviceInfo location]
set xnsList [dict get $serviceInfo targetNamespace]
# save the document in variable doc and free it if out of scope
dom createDocument "SOAP-ENV:Envelope" doc
$doc documentElement env
$env setAttribute \
"xmlns:SOAP-ENV" "http://schemas.xmlsoap.org/soap/envelope/" \
"xmlns:SOAP-ENC" "http://schemas.xmlsoap.org/soap/encoding/" \
"xmlns:xsi" "http://www.w3.org/2001/XMLSchema-instance" \
"xmlns:xs" "http://www.w3.org/2001/XMLSchema"
array set tnsArray {}
array unset tnsArray *
foreach xns $xnsList {
set tns [lindex $xns 0]
set target [lindex $xns 1]
"xmlns:xs" "http://www.w3.org/2001/XMLSchema"
if {[dict exists $serviceInfo noTargetNs] && ![dict get $serviceInfo noTargetNs]} {
$env setAttribute "xmlns" [dict get $xnsList tns1]
}
array unset tnsArray *
array set tnsArray {
"http://schemas.xmlsoap.org/soap/envelope/" "xmlns:SOAP-ENV"
"http://schemas.xmlsoap.org/soap/encoding/" "xmlns:SOAP-ENC"
"http://www.w3.org/2001/XMLSchema-instance" "xmlns:xsi"
"http://www.w3.org/2001/XMLSchema" "xmlns:xs"
}
foreach {tns target} $xnsList {
#set tns [lindex $xns 0]
#set target [lindex $xns 1]
set tnsArray($target) $tns
$env setAttribute \
xmlns:$tns $target
}
#parray tnsArray
set firstHeader 1
foreach inputHeaderTypeItem [dict get $serviceInfo operation $operationName soapRequestHeader] {
lassign $inputHeaderTypeItem inputHeaderType attrList
if {[string equal $inputHeaderType {}]} {
if {$inputHeaderType eq {}} {
continue
}
set xns [dict get [::WS::Utils::GetServiceTypeDef Client $serviceName $inputHeaderType] xns]
if {[info exists tnsArray($xns)]} {
set xns $tnsArray($xns)
}
if {$firstHeader} {
# side effect: save new node handle in variable header
$env appendChild [$doc createElement "SOAP-ENV:Header" header]
set firstHeader 0
}
if {[dict exists $serviceInfo skipHeaderLevel] && [dict get $serviceInfo skipHeaderLevel]} {
set headerData $header
} else {
set typeInfo [split $inputHeaderType {:}]
if {[llength $typeInfo] > 1} {
set headerType $inputHeaderType
} else {
set headerType $xns:$inputHeaderType
}
$header appendChild [$doc createElement $xns:$inputHeaderType headerData]
if {[llength $attrList]} {
::WS::Utils::setAttr $headerData $attrList
$header appendChild [$doc createElement $headerType headerData]
if {[llength $attrList]} {
::WS::Utils::setAttr $headerData $attrList
}
}
::WS::Utils::convertDictToType Client $serviceName $doc $headerData $argList $inputHeaderType
}
# side effect: save new element handle in variable bod
$env appendChild [$doc createElement "SOAP-ENV:Body" bod]
#puts "set xns \[dict get \[::WS::Utils::GetServiceTypeDef Client $serviceName $msgType\] xns\]"
#puts "\t [::WS::Utils::GetServiceTypeDef Client $serviceName $msgType]"
set xns [dict get [::WS::Utils::GetServiceTypeDef Client $serviceName $msgType] xns]
if {[info exists tnsArray($xns)]} {
set xns $tnsArray($xns)
}
set typeInfo [split $msgType {:}]
if {[llength $typeInfo] != 1} {
set xns [lindex $typeInfo 0]
set msgType [lindex $typeInfo 1]
::log::log debug [list $bod appendChild \[$doc createElement $xns:$msgType reply\]]
$bod appendChild [$doc createElement $xns:$msgType reply]
::log::log debug "calling [list ::WS::Utils::convertDictToType Client $serviceName $doc $bod $argList $msgType]"
::WS::Utils::convertDictToType Client $serviceName $doc $reply $argList $msgType
}
if {[dict get $serviceInfo skipLevelWhenActionPresent] && [dict exists $serviceInfo operation $operationName action]} {
set forceNs 1
set reply $bod
} else {
::log::logsubst debug {$bod appendChild \[$doc createElement $xns:$msgType reply\]}
$bod appendChild [$doc createElement $xns:$msgType reply]
set forceNs 0
}
::WS::Utils::convertDictToType Client $serviceName $doc $reply $argList $xns:$msgType $forceNs
append xml \
{<?xml version="1.0" encoding="utf-8"?>} \
set encoding [lindex [split [lindex [split [dict get $serviceInfo contentType] {:}] end] {=}] end]
set xml [format {<?xml version="1.0" encoding="%s"?>} $encoding]
"\n" \
[$doc asXML -indent none -doctypeDeclaration 0]
append xml "\n" [$doc asXML -indent none -doctypeDeclaration 0]
#regsub "<!DOCTYPE\[^>\]*>\n" [::dom::DOMImplementation serialize $doc] {} xml
$doc delete
::log::log debug "Leaving ::::WS::Client::buildDocLiteralCallquery with {$xml}"
::log::logsubst debug {Leaving ::WS::Client::buildDocLiteralCallquery with {$xml}}
return $xml
return [encoding convertto $encoding $xml]
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
|
︙ | | |
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
|
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
|
-
+
-
-
-
-
-
+
+
+
-
-
-
+
+
-
+
+
-
+
+
+
+
+
-
+
-
+
-
-
+
+
-
-
+
-
-
+
-
+
-
+
-
-
+
+
+
+
+
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-
+
+
+
+
-
+
+
+
+
|
# 1 07/06/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::buildRpcEncodedCallquery {serviceName operationName url argList} {
variable serviceArr
::log::log debug "Entering [info level 0]"
::log::logsubst debug {Entering [info level 0]}
set serviceInfo $serviceArr($serviceName)
set msgType [dict get $serviceInfo operation $operationName inputs]
#set url [dict get $serviceInfo location]
set xnsList [dict get $serviceInfo targetNamespace]
#set action [dict get $serviceInfo operation $operationName action]
dom createDocument "SOAP-ENV:Envelope" doc
$doc documentElement env
$env setAttribute \
xmlns:SOAP-ENV "http://schemas.xmlsoap.org/soap/envelope/" \
xmlns:xsi "http://www.w3.org/2001/XMLSchema-instance" \
xmlns:xs "http://www.w3.org/2001/XMLSchema"
foreach xns $xnsList {
set tns [lindex $xns 0]
xmlns:xs "http://www.w3.org/2001/XMLSchema"
foreach {tns target} $xnsList {
set target [lindex $xns 1]
$env setAttribute \
xmlns:$tns $target
$env setAttribute xmlns:$tns $target
}
set firstHeader 1
foreach inputHeaderType [dict get $serviceInfo operation $operationName soapRequestHeader] {
if {[string equal $inputHeaderType {}]} {
if {$inputHeaderType eq {}} {
continue
}
set xns [dict get [::WS::Utils::GetServiceTypeDef Client $serviceName $inputHeaderType] xns]
if {$firstHeader} {
$env appendChild [$doc createElement "SOAP-ENV:Header" header]
$env appendChild [$doc createElement "SOAP-ENV:Header" header]
set firstHeader 0
}
$header appendChild [$doc createElement $xns:$inputHeaderType headerData]
::WS::Utils::convertDictToEncodedType Client $serviceName $doc $headerData $argList $inputHeaderType
}
$env appendChild [$doc createElement "SOAP-ENV:Body" bod]
set baseName [dict get $serviceInfo operation $operationName name]
set callXns [dict get $serviceInfo operation $operationName xns]
# side effect: node handle is saved in variable reply
if {![string is space $callXns]} {
$bod appendChild [$doc createElement $callXns:$operationName reply]
$bod appendChild [$doc createElement $callXns:$baseName reply]
} else {
$bod appendChild [$doc createElement $operationName reply]
$bod appendChild [$doc createElement $baseName reply]
}
$reply setAttribute \
SOAP-ENV:encodingStyle "http://schemas.xmlsoap.org/soap/encoding/"
::WS::Utils::convertDictToEncodedType Client $serviceName $doc $reply $argList $msgType
append xml \
{<?xml version="1.0" encoding="utf-8"?>} \
set encoding [lindex [split [lindex [split [dict get $serviceInfo contentType] {;}] end] {=}] end]
set xml [format {<?xml version="1.0" encoding="%s"?>} $encoding]
"\n" \
[$doc asXML -indent none -doctypeDeclaration 0]
append xml "\n" [$doc asXML -indent none -doctypeDeclaration 0]
#regsub "<!DOCTYPE\[^>\]*>\n" [::dom::DOMImplementation serialize $doc] {} xml
$doc delete
::log::log debug "Leaving ::::WS::Client::buildRpcEncodedCallquery with {$xml}"
::log::logsubst debug {Leaving ::WS::Client::buildRpcEncodedCallquery with {$xml}}
return $xml
return [encoding convertto $encoding $xml]
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Client::buildServiceInfo
#
# Description : Parse the WSDL into our internal representation
#
# Arguments :
# wsdlNode - The top node of the WSDL
# results - Inital definition. This is optional and defaults to no definition.
# results - Initial definition. This is optional and defaults to no definition.
# serviceAlias - Alias (unique) name for service.
# This is an optional argument and defaults to the name of the
# service in serviceInfo.
# This is an optional argument and defaults to the name of the
# service in serviceInfo.
# serviceNumber - Number of service within the WSDL to assign the
# serviceAlias to. Only usable with a serviceAlias.
# First service (default) is addressed by value "1".
#
# Returns : The parsed WSDL
#
# Side-Effects : Defines Client mode types as specified by the WSDL
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
#
#>>END PRIVATE<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 07/06/2006 G.Lester Initial version
# 2.4.6 2017-12-07 H.Oehlmann Added argument "serviceNumber"
#
#
###########################################################################
proc ::WS::Client::buildServiceInfo {wsdlNode {serviceInfo {}} {serviceAlias {}}} {
proc ::WS::Client::buildServiceInfo {wsdlNode tnsDict {serviceInfo {}} {serviceAlias {}} {serviceNumber 1}} {
##
## Need to refactor to foreach service parseService
## Service drills down to ports, which drills down to bindings and messages
##
::log::log debug "Entering ::WS::Client::buildServiceInfo with doc $wsdlNode"
::log::logsubst debug {Entering [info level 0]}
##
## Parse Service information
##
# WSDL snippet:
# <definitions ...>
# <service name="service1">
# ...
# </service>
# <service name="service2">
# ...
# </service>
# </definitions>
# Without serviceAlias and serviceNumber, two services "service1" and
# "service2" are created.
# With serviceAlias = "SE" and serviceNumber=2, "service2" is created as
# "SE".
set serviceNameList [$wsdlNode selectNodes w:service]
if {[string length $serviceAlias] & ([llength $serviceNameList] > 1)} {
return \
-code error \
-errorcode [list WS CLIENT MULTISVC] \
"Can not specify alias when WSDL defines multiple services"
} elseif {[llength $serviceNameList] == 0} {
# Check for no service node
if {[llength $serviceNameList] == 0} {
return \
-code error \
-errorcode [list WS CLIENT NOSVC] \
"WSDL does not define any services"
}
if {"" ne $serviceAlias} {
if {$serviceNumber < 1 || $serviceNumber > [llength $serviceNameList]} {
return \
-code error \
-errorcode [list WS CLIENT INVALDCNT] \
"WSDL does not define service number $serviceNumber"
}
set serviceNameList [lrange $serviceNameList $serviceNumber-1 $serviceNumber-1]
}
foreach serviceNode $serviceNameList {
lappend serviceInfo [parseService $wsdlNode $serviceNode $serviceAlias]
lappend serviceInfo [parseService $wsdlNode $serviceNode $serviceAlias $tnsDict]
}
::log::logsubst debug {Leaving ::WS::Client::buildServiceInfo with $serviceInfo}
return $serviceInfo
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Client::parseService
#
# Description : Parse a service from a WSDL into our internal representation
#
# Arguments :
# wsdlNode - The top node of the WSDL
# serviceNode - The DOM node for the service.
# serviceAlias - Alias (unique) name for service.
# This is an optional argument and defaults to the name of the
# service in serviceInfo.
# tnsDict - Dictionary of URI to namespaces used
#
# Returns : The parsed service WSDL
#
# Side-Effects : Defines Client mode types for the service as specified by the WSDL
#
# Exception Conditions : None
#
|
︙ | | |
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
|
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
|
-
+
+
+
|
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 08/06/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::parseService {wsdlNode serviceNode serviceAlias} {
proc ::WS::Client::parseService {wsdlNode serviceNode serviceAlias tnsDict} {
variable serviceArr
variable options
::log::logsubst debug {Entering [info level 0]}
if {[string length $serviceAlias]} {
set serviceName $serviceAlias
} else {
set serviceName [$serviceNode getAttribute name]
}
set addressNodeList [$serviceNode getElementsByTagNameNS http://schemas.xmlsoap.org/wsdl/soap/ address]
if {[llength $addressNodeList] == 1} {
|
︙ | | |
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
|
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
|
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
|
if {![info exists location]} {
return \
-code error \
-errorcode [list WS CLIENT NOSOAPADDR] \
"Malformed WSDL -- No SOAP address node found."
}
set xns {}
foreach url [dict keys [dict get $tnsDict url]] {
lappend xns [list [dict get $tnsDict url $url] $url]
}
if {[$wsdlNode hasAttribute targetNamespace]} {
set target [$wsdlNode getAttribute targetNamespace]
} else {
set target $location
}
set tmpTargetNs $::WS::Utils::targetNs
set ::WS::Utils::targetNs $target
CreateService $serviceName WSDL $location
CreateService $serviceName WSDL $location $target xns $xns
set serviceInfo $serviceArr($serviceName)
dict set serviceInfo tnsList $tnsDict
set bindingName [lindex [split [$portNode getAttribute binding] {:}] end]
##
## Parse types
##
parseTypes $wsdlNode $serviceName serviceInfo
##
## Parse bindings
##
parseBinding $wsdlNode $serviceName $bindingName serviceInfo
##
## All done, so return results
##
#dict unset serviceInfo tnsList
dict set serviceInfo suppressTargetNS $options(suppressTargetNS)
foreach {key value} [dict get $serviceInfo tnsList url] {
dict set serviceInfo targetNamespace $value $key
}
set serviceArr($serviceName) $serviceInfo
set ::WS::Utils::targetNs $tmpTargetNs
::log::logsubst debug {Leaving [lindex [info level 0] 0] with $serviceInfo}
return $serviceInfo
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
|
︙ | | |
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
|
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
|
+
+
-
+
+
-
+
-
+
+
+
|
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 08/06/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::parseTypes {wsdlNode serviceName serviceInfoVar} {
::log::log debug "Entering [info level 0]"
upvar $serviceInfoVar serviceInfo
upvar 1 $serviceInfoVar serviceInfo
set tnsCount 0
set tnsCount [llength [dict keys [dict get $serviceInfo tnsList url]]]
set baseUrl [dict get $serviceInfo location]
foreach schemaNode [$wsdlNode selectNodes w:types/s:schema] {
foreach schemaNode [$wsdlNode selectNodes w:types/xs:schema] {
::log::log debug "Parsing node $schemaNode"
::WS::Utils::parseScheme Client $baseUrl $schemaNode $serviceName serviceInfo tnsCount
}
::log::log debug "Leaving [lindex [info level 0] 0]"
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
|
︙ | | |
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
|
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
|
+
+
+
-
+
+
+
-
+
+
-
+
+
-
+
-
-
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
-
+
+
-
-
+
+
-
+
-
-
-
+
+
-
+
+
-
-
+
+
-
-
+
+
-
+
-
+
+
-
-
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-
+
+
+
+
+
+
-
-
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
+
+
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
|
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 08/06/2006 G.Lester Initial version
# 2.4.2 2017-08-31 H.Oehlmann Also set serviceArr operation members
# inputsName and outputsName.
#
#
###########################################################################
proc ::WS::Client::parseBinding {wsdlNode serviceName bindingName serviceInfoVar} {
::log::log debug "Entering [info level 0]"
upvar $serviceInfoVar serviceInfo
upvar 1 $serviceInfoVar serviceInfo
variable options
set bindQuery [format {w:binding[attribute::name='%s']} $bindingName]
array set msgToOper {}
foreach binding [$wsdlNode selectNodes $bindQuery] {
array unset msgToOper *
set portName [lindex [split [$binding getAttribute type] {:}] end]
::log::log debug "\t Processing binding '$bindingName' on port '$portName'"
set operList [$binding selectNodes w:operation]
set styleNode [$binding selectNodes d:binding]
if {![info exists style]} {
if {[catch {$styleNode getAttribute style} tmpStyle]} {
set styleNode [$binding selectNodes {w:operation[1]/d:operation}]
if {[string equal $styleNode {}]} {
if {$styleNode eq {}} {
##
## This binding is for a SOAP level other than 1.1
##
::log::log debug "Skiping non-SOAP 1.1 binding [$binding asXML]"
continue
}
set style [$styleNode getAttribute style]
#puts "Using style for first operation {$style}"
} else {
set style $tmpStyle
#puts "Using style for first binding {$style}"
}
if {!([string equal $style document] || [string equal $style rpc])} {
if {!($style eq {document} || $style eq {rpc} )} {
::log::log debug "Leaving [lindex [info level 0] 0] with error @1"
return \
-code error \
-errorcode [list WSCLIENT UNSSTY $style] \
-errorcode [list WS CLIENT UNSSTY $style] \
"Unsupported calling style: '$style'"
}
if {![info exists use]} {
set use [[$binding selectNodes {w:operation[1]/w:input/d:body}] getAttribute use]
if {!([string equal $style document] && [string equal $use literal]) &&
!([string equal $style rpc] && [string equal $use encoded])} {
if {!($style eq {document} && $use eq {literal} ) &&
!($style eq {rpc} && $use eq {encoded} )} {
::log::log debug "Leaving [lindex [info level 0] 0] with error @2"
return \
-code error \
-errorcode [list WSCLIENT UNSMODE $use] \
-errorcode [list WS CLIENT UNSMODE $use] \
"Unsupported mode: $style/$use"
}
}
}
set style $style/$use
##
## Process each operation
##
foreach oper $operList {
set operName [$oper getAttribute name]
set baseName $operName
::log::log debug "\t Processing operation '$operName'"
##
## Check for overloading
##
set inNode [$oper selectNodes w:input]
if {[llength $inNode] == 1 && [$inNode hasAttribute name]} {
set inName [$inNode getAttribute name]
} else {
set inName {}
}
if {[dict exists $serviceInfo operation $operName]} {
if {!$options(allowOperOverloading)} {
return -code error \
-errorcode [list WS CLIENT NOOVERLOAD $operName]
}
##
## See if the existing operation needs to be cloned
##
set origType [lindex [split [dict get $serviceInfo operation $operName inputs] {:}] end]
set newName ${operName}_${origType}
if {![dict exists $serviceInfo operation $newName]} {
##
## Clone it
##
dict set serviceInfo operation $baseName cloned 1
dict lappend serviceInfo operList $operName
dict lappend serviceInfo operList $newName
dict set serviceInfo operation $newName [dict get $serviceInfo operation $operName]
}
# typNameList contains inType inName outType outName
set typeNameList [getTypesForPort $wsdlNode $serviceName $baseName $portName $inName serviceInfo $style]
set operName ${operName}_[lindex [split [lindex $typeNameList 0] {:}] end]
set cloneList [dict get $serviceInfo operation $baseName cloneList]
lappend cloneList $operName
dict set serviceInfo operation $baseName cloneList $cloneList
dict set serviceInfo operation $operName isClone 1
} else {
set typeNameList [getTypesForPort $wsdlNode $serviceName $baseName $portName $inName serviceInfo $style]
dict set serviceInfo operation $operName isClone 0
}
#puts "Processing operation $operName"
set actionNode [$oper selectNodes d:operation]
if {[string equal $actionNode {}]} {
if {$actionNode eq {}} {
::log::log debug "Skiping operation with no action [$oper asXML]"
continue
}
dict lappend serviceInfo operList $operName
dict set serviceInfo operation $operName style $style/$use
dict set serviceInfo operation $operName cloneList {}
dict set serviceInfo operation $operName cloned 0
dict set serviceInfo operation $operName name $baseName
dict set serviceInfo operation $operName style $style
catch {
set action [$actionNode getAttribute soapAction]
dict set serviceInfo operation $operName action $action
if {[dict exists $serviceInfo soapActions $action]} {
set actionList [dict get $serviceInfo soapActions $action]
} else {
set actionList {}
}
lappend actionList $operName
dict set serviceInfo soapActions $action $actionList
}
##
## Get the input headers, if any
##
set soapRequestHeaderList {{}}
foreach inHeader [$oper selectNodes w:input/d:header] {
##set part [$inHeader getAttribute part]
set tmp [$inHeader getAttribute use]
if {![string equal $tmp $use]} {
if {$tmp ne $use} {
::log::log debug "Leaving [lindex [info level 0] 0] with error @3"
return \
-code error \
-errorcode [list WSCLIENT MIXUSE $use $tmp] \
"Mixed usageage not supported!'"
-errorcode [list WS CLIENT MIXUSE $use $tmp] \
"Mixed usage not supported!'"
}
set messagePath [$inHeader getAttribute message]
set msgName [$inHeader getAttribute message]
set msgName [lindex [split $messagePath {:}] end]
::log:::log debug [list messageToType $wsdlNode $serviceName $operName $msgName serviceInfo]
set type [messageToType $wsdlNode $serviceName $operName $msgName serviceInfo]
::log::log debug [list messageToType $wsdlNode $serviceName $baseName $msgName serviceInfo $style]
set type [messageToType $wsdlNode $serviceName $baseName $msgName serviceInfo $style]
lappend soapRequestHeaderList $type
}
dict set serviceInfo operation $operName soapRequestHeader $soapRequestHeaderList
if {![dict exists [dict get $serviceInfo operation $operName] action]} {
dict set serviceInfo operation $operName action $serviceName
}
##
## Get the output header, if one
##
set soapReplyHeaderList {{}}
foreach outHeader [$oper selectNodes w:output/d:header] {
##set part [$outHeader getAttribute part]
set tmp [$outHeader getAttribute use]
if {![string equal $tmp $use]} {
if {$tmp ne $use} {
::log::log debug "Leaving [lindex [info level 0] 0] with error @4"
return \
-code error \
-errorcode [list WSCLIENT MIXUSE $use $tmp] \
"Mixed usageage not supported!'"
-errorcode [list WS CLIENT MIXUSE $use $tmp] \
"Mixed usage not supported!'"
}
set messagePath [$outHeader getAttribute message]
set msgName [lindex [split $messagePath {:}] end]
::log:::log debug [list messageToType $wsdlNode $serviceName $operName $msgName serviceInfo]
set type [messageToType $wsdlNode $serviceName $operName $msgName serviceInfo]
::log::log debug [list messageToType $wsdlNode $serviceName $baseName $msgName serviceInfo $style]
set type [messageToType $wsdlNode $serviceName $baseName $msgName serviceInfo $style]
lappend soapReplyHeaderList $type
}
dict set serviceInfo operation $operName soapReplyHeader $soapReplyHeaderList
##
## Validate that the input and output uses
## Validate that the input and output uses are the same
##
set inUse $use
set outUse $use
catch {set inUse [[$oper selectNodes w:input/d:body] getAttribute use]}
catch {set outUse [[$oper selectNodes w:output/d:body] getAttribute use]}
foreach tmp [list $inUse $outUse] {
if {![string equal $tmp $use]} {
if {$tmp ne $use} {
::log::log debug "Leaving [lindex [info level 0] 0] with error @5"
return \
-code error \
-errorcode [list WSCLIENT MIXUSE $use $tmp] \
"Mixed usageage not supported!'"
-errorcode [list WS CLIENT MIXUSE $use $tmp] \
"Mixed usage not supported!'"
}
}
set typeList [getTypesForPort $wsdlNode $serviceName $operName $portName serviceInfo]
foreach type $typeList mode {inputs outputs} {
::log::log debug "\t Input/Output types and names are {$typeNameList}"
foreach {type name} $typeNameList mode {inputs outputs} {
dict set serviceInfo operation $operName $mode $type
# also set outputsname which is used to match it as alternate response node name
dict set serviceInfo operation $operName ${mode}name $name
}
set inMessage [dict get $serviceInfo operation $operName inputs]
if {[dict exists $serviceInfo inputMessages $inMessage] } {
set operList [dict get $serviceInfo inputMessages $inMessage]
} else {
set operList {}
}
lappend operList $operName
dict set serviceInfo inputMessages $inMessage $operList
##
## Handle target namespace defined at WSDL level for older RPC/Encoded
##
if {![dict exists $serviceInfo targetNamespace]} {
catch {
#puts "attempting to get tragetNamespace"
dict lappend serviceInfo targetNamespace [list tns1 [[$oper selectNodes w:input/d:body] getAttribute namespace]]
dict set serviceInfo targetNamespace tns1 [[$oper selectNodes w:input/d:body] getAttribute namespace]
}
}
set xns tns1
catch {
set xns {}
set target [[$oper selectNodes w:input/d:body] getAttribute namespace]
foreach item [dict get $serviceInfo targetNamespace] {
lassign $item ns url
if {[string equal $url $target]} {
set xns $ns
break
}
}
if {[string equal $xns {}]} {
set cnt [llength [dict get $serviceInfo targetNamespace]]
incr cnt
dict lappend serviceInfo targetNamespace [list tns$cnt $target]
set xns tns$cnt
}
}
dict set serviceInfo operation $operName xns $xns
}
}
::log::log debug "Leaving [lindex [info level 0] 0]"
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Client::getTypesForPort
#
# Description : Get the types for a port.
#
# Arguments :
# wsdlNode - The top node of the WSDL
# serviceNode - The DOM node for the service.
# operNode - The DOM node for the operation.
# portName - The name of the port.
# inName - The name of the input message.
# serviceInfoVar - The name of the dictionary containing the partially
# parsed service.
# style - style of call
#
# Returns : A list containing the input and output types
# Returns : A list containing the input and output types and names
#
# Side-Effects : Defines Client mode types for the service as specified by the WSDL
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
#
#>>END PRIVATE<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 08/06/2006 G.Lester Initial version
# 2.4.2 2017-08-31 H.Oehlmann Extend return by names to verify this
# as return output node name.
# 2.4.3 2017-11-03 H.Oehlmann If name is not given, set the default
# name of <OP>Request/Response given by the
# WSDL 1.0 standard.
#
#
###########################################################################
proc ::WS::Client::getTypesForPort {wsdlNode serviceName operName portName serviceInfoVar} {
upvar $serviceInfoVar serviceInfo
proc ::WS::Client::getTypesForPort {wsdlNode serviceName operName portName inName serviceInfoVar style} {
::log::log debug "Entering [info level 0]"
upvar 1 $serviceInfoVar serviceInfo
set style [dict get $serviceInfo operation $operName style]
set inType {}
set outType {}
set portQuery [format {w:portType[attribute::name='%s']} $portName]
set portNode [lindex [$wsdlNode selectNodes $portQuery] 0]
set operQuery [format {w:operation[attribute::name='%s']} $operName]
set operNode [lindex [$portNode selectNodes $operQuery] 0]
set inputMsgNode [$operNode selectNodes {w:input}]
if {![string equal $inputMsgNode {}]} {
set inputMsgPath [$inputMsgNode getAttribute message]
#set portQuery [format {w:portType[attribute::name='%s']} $portName]
#set portNode [lindex [$wsdlNode selectNodes $portQuery] 0]
if {$inName eq {}} {
set operQuery [format {w:portType[attribute::name='%s']/w:operation[attribute::name='%s']} \
$portName $operName]
} else {
set operQuery [format {w:portType[attribute::name='%s']/w:operation[attribute::name='%s']/w:input[attribute::name='%s']/parent::*} \
$portName $operName $inName]
}
::log::log debug "\t operNode query is {$operQuery}"
set operNode [$wsdlNode selectNodes $operQuery]
if {$operNode eq {} && $inName ne {}} {
set inputMsg [lindex [split $inputMsgPath {:}] end]
set inType [messageToType $wsdlNode $serviceName $operName $inputMsg serviceInfo]
set operQuery [format {w:portType[attribute::name='%s']/w:operation[attribute::name='%s']} \
$portName $operName]
::log::log debug "\t operNode query is {$operQuery}"
set operNode [$wsdlNode selectNodes $operQuery]
}
set resList {}
foreach sel {w:input w:output} defaultNameSuffix {Request Response} {
set outputMsgNode [$operNode selectNodes {w:output}]
if {![string equal $outputMsgNode {}]} {
set outputMsgPath [$outputMsgNode getAttribute message]
set outputMsg [lindex [split $outputMsgPath {:}] end]
set outType [messageToType $wsdlNode $serviceName $operName $outputMsg serviceInfo]
set nodeList [$operNode selectNodes $sel]
if {1 == [llength $nodeList]} {
set nodeCur [lindex $nodeList 0]
set msgPath [$nodeCur getAttribute message]
set msgCur [lindex [split $msgPath {:}] end]
# Append type
lappend resList [messageToType $wsdlNode $serviceName $operName $msgCur serviceInfo $style]
# Append name
if {[$nodeCur hasAttribute name]} {
lappend resList [$nodeCur getAttribute name]
} else {
# Build the default name according WSDL 1.0 as
# <Operation>Request/Response
lappend resList ${operName}$defaultNameSuffix
}
}
}
##
## Return the types
##
::log::log debug "Leaving [lindex [info level 0] 0] with $resList"
return [list $inType $outType]
return $resList
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Client::messageToType
#
# Description : Get a type name from a message
#
# Arguments :
# wsdlNode - The top node of the WSDL
# serviceName - The name of the service.
# operName - The name of the operation.
# msgName - The name of the message.
# serviceInfoVar - The name of the dictionary containing the partially
# parsed service.
# style - Style of call
#
# Returns : The requested type name
#
# Side-Effects : Defines Client mode types for the service as specified by the WSDL
#
# Exception Conditions : None
#
|
︙ | | |
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
|
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
|
-
-
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
-
+
+
+
-
+
-
+
+
+
+
+
-
+
+
+
+
+
+
-
+
+
-
+
+
+
+
+
+
-
-
-
-
-
+
-
-
-
+
-
+
-
-
-
-
-
-
-
+
+
-
-
+
-
-
-
-
-
+
+
-
-
-
-
-
-
+
+
+
+
+
+
-
-
+
-
+
+
+
+
+
-
+
-
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
+
-
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
+
+
+
+
-
-
-
-
-
-
-
+
-
-
+
-
-
-
+
+
-
-
-
+
+
-
-
+
-
+
-
+
-
+
|
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 08/06/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::messageToType {wsdlNode serviceName operName msgName serviceInfoVar} {
upvar $serviceInfoVar serviceInfo
proc ::WS::Client::messageToType {wsdlNode serviceName operName msgName serviceInfoVar style} {
upvar 1 $serviceInfoVar serviceInfo
::log::log debug "Entering [info level 0]"
#puts "Message to Type $serviceName $operName $msgName"
set style [dict get $serviceInfo operation $operName style]
set msgQuery [format {w:message[attribute::name='%s']} $msgName]
set msg [$wsdlNode selectNodes $msgQuery]
if {$msg eq {} &&
[llength [set msgNameList [split $msgName {:}]]] > 1} {
set tmpMsgName [join [lrange $msgNameList 1 end] {:}]
set msgQuery [format {w:message[attribute::name='%s']} $tmpMsgName]
set msg [$wsdlNode selectNodes $msgQuery]
}
if {$msg eq {}} {
return \
-code error \
-errorcode [list WS CLIENT BADMSGSEC $msgName] \
"Can not find message '$msgName'"
}
switch $style {
switch -exact -- $style {
document/literal {
set partNode [$msg selectNodes w:part]
set partNodeCount [llength $partNode]
::log::log debug "partNodeCount = {$partNodeCount}"
if {$partNodeCount == 1} {
if {[$partNode hasAttribute element]} {
set typePath [$partNode getAttribute element]
set type [::WS::Utils::getQualifiedType $serviceInfo [$partNode getAttribute element] tns1]
set type [lindex [split $typePath {:}] end]
}
}
if {($partNodeCount > 1) || ![info exist type]} {
set tmpType {}
foreach part [$msg selectNodes w:part] {
set partName [$part getAttribute name]
if {[$part hasAttribute type]} {
set partType [lindex [split [$part getAttribute type] {:}] end]
set partType [$part getAttribute type]
} else {
set partType [lindex [split [$part getAttribute element] {:}] end]
set partType [$part getAttribute element]
}
lappend tmpType $partName [list type $partType comment {}]
lappend tmpType $partName [list type [::WS::Utils::getQualifiedType $serviceInfo $partType tns1] comment {}]
}
set type $msgName
set type tns1:$msgName
dict set serviceInfo types $type $tmpType
::WS::Utils::ServiceTypeDef Client $serviceName $type $tmpType tns1
} elseif {!$partNodeCount} {
return \
-code error \
-errorcode [list WS CLIENT BADMSGSEC $msgName] \
"Invalid format for message '$msgName'"
}
}
rpc/encoded {
set tmpType {}
foreach part [$msg selectNodes w:part] {
set partName [$part getAttribute name]
if {[$part hasAttribute type]} {
set partType [lindex [split [$part getAttribute type] {:}] end]
set partType [$part getAttribute type]
} else {
set partType [lindex [split [$part getAttribute element] {:}] end]
set partType [$part getAttribute element]
}
lappend tmpType $partName [list type $partType comment {}]
lappend tmpType $partName [list type [::WS::Utils::getQualifiedType $serviceInfo $partType tns1] comment {}]
}
set type $msgName
set type tns1:$msgName
dict set serviceInfo types $type $tmpType
::WS::Utils::ServiceTypeDef Client $serviceName $type $tmpType xs
::WS::Utils::ServiceTypeDef Client $serviceName $type $tmpType tns1
}
default {
return \
-code error \
-errorcode [list WS CLIENT UNKSTYUSE [list $style $use]] \
"Unknown style/use combination $style/$use"
-errorcode [list WS CLIENT UNKSTY $style] \
"Unknown style combination $style"
}
}
##
## Return the type name
##
::log::log debug "Leaving [lindex [info level 0] 0] with {$type}"
return $type
}
#---------------------------------------
#---------------------------------------
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::DoRawRestCall
#
# Description : Call an operation of a web service
#
# Arguments :
# serviceName - The name of the Webservice
# operationName - The name of the Operation to call
# argList - The arguements to the operation as a dictionary object.
# argList - The arguments to the operation as a dictionary object.
# This is for both the Soap Header and Body messages.
# headers - Extra headers to add to the HTTP request. This
# is a key value list argument. It must be a list with
# an even number of elements that alternate between
# keys and values. The keys become header field names.
# Newlines are stripped from the values so the header
# cannot be corrupted.
# This is an optional argument and defaults to {}.
#
# Returns :
# The XML of the operation.
#
# Side-Effects : None
#
# Exception Conditions :
# WSCLIENT HTTPERROR - if an HTTP error occured
# WS CLIENT HTTPERROR - if an HTTP error occurred
#
# Pre-requisite Conditions : Service must have been defined.
#
# Original Author : Gerald W. Lester
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 07/06/2006 G.Lester Initial version
# 2.4.1 2017-08-31 H.Oehlmann Use utility function
# ::WS::Utils::geturl_fetchbody for http call
# which also follows redirects.
# 3.0.0 2020-10-26 H.Oehlmann Added query timeout
#
#
###########################################################################
proc ::WS::Client::DoRawRestCall {serviceName objectName operationName argList {headers {}} {location {}}} {
variable serviceArr
::log::log debug "Entering [info level 0]"
::log::logsubst debug {Entering [info level 0]}
if {![info exists serviceArr($serviceName)]} {
return \
-code error \
-errorcode [list WS CLIENT UNKSRV $serviceName] \
"Unknown service '$serviceName'"
}
set serviceInfo $serviceArr($serviceName)
if {![dict exists $serviceInfo object $objectName]} {
return \
-code error \
-errorcode [list WS CLIENT UNKOBJ [list $serviceName $objectName]] \
"Unknown object '$objectName' for service '$serviceName'"
}
if {![dict exists $serviceInfo object $objectName operation $operationName]} {
return \
-code error \
-errorcode [list WS CLIENT UNKOPER [list $serviceName $objectName $operationName]] \
"Unknown operation '$operationName' for object '$objectName' of service '$serviceName'"
}
##
## build call query
##
if {![string equal $location {}]} {
if {$location ne {}} {
set url $location
} else {
set url [dict get $serviceInfo object $objectName location]
}
SaveAndSetOptions $serviceName
set query [buildRestCallquery $serviceName $objectName $operationName $url $argList]
if {[catch {set query [buildRestCallquery $serviceName $objectName $operationName $url $argList]} err]} {
RestoreSavedOptions $serviceName
return -code error -errorcode $::errorCode -errorinfo $::errorInfo $err
} else {
RestoreSavedOptions $serviceName
}
if {[dict exists $serviceInfo headers]} {
set headers [concat $headers [dict get $serviceInfo headers]]
}
if {[llength $headers]} {
set token [::http::geturl $url -query $query -type text/xml -headers $headers]
} else {
set token [::http::geturl $url -query $query -type text/xml]
}
::http::wait $token
##
## Check for errors
## do http call
##
set body [::http::data $token]
if {![string equal [::http::status $token] ok] ||
([::http::ncode $token] != 200 && [string equal $body {}])} {
set errorCode [list WSCLIENT HTTPERROR [::http::code $token]]
set errorInfo {}
set results [::http::error $token]
set hadError 1
} else {
set largs {}
if {[llength $headers]} {
set hadError 0
set results [::http::data $token]
lappend largs -headers $headers
}
::http::cleanup $token
if {$hadError} {
::log::log debug "Leaving (error) ::WS::Client::DoRawRestCall"
return \
-code error \
set body [::WS::Utils::geturl_fetchbody $url\
-query $query\
-errorcode $errorCode \
-errorinfo $errorInfo \
$results
} else {
::log::log debug "Leaving ::WS::Client::DoRawRestCall with {$results}"
return $results
-type [dict get $serviceInfo contentType]\
-timeout [dict get $serviceInfo queryTimeout]\
{*}$largs]
::log::logsubst debug {Leaving ::WS::Client::DoRawRestCall with {$body}}
return $body
}
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::DoRestCall
#
# Description : Call an operation of a web service
#
# Arguments :
# serviceName - The name of the Webservice
# operationName - The name of the Operation to call
# argList - The arguements to the operation as a dictionary object
# argList - The arguments to the operation as a dictionary object
# This is for both the Soap Header and Body messages.
# headers - Extra headers to add to the HTTP request. This
# is a key value list argument. It must be a list with
# an even number of elements that alternate between
# keys and values. The keys become header field names.
# Newlines are stripped from the values so the header
# cannot be corrupted.
# This is an optional argument and defaults to {}.
#
# Returns :
# The return value of the operation as a dictionary object.
#
# Side-Effects : None
#
# Exception Conditions :
# WSCLIENT HTTPERROR - if an HTTP error occured
# WS CLIENT HTTPERROR - if an HTTP error occurred
# others - as raised by called Operation
#
# Pre-requisite Conditions : Service must have been defined.
#
# Original Author : Gerald W. Lester
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 07/06/2006 G.Lester Initial version
# 2.4.1 2017-08-31 H.Oehlmann Use utility function
# ::WS::Utils::geturl_fetchbody for http call
# which also follows redirects.
# 3.0.0 2020-10-26 H.Oehlmann Added query timeout
#
#
###########################################################################
proc ::WS::Client::DoRestCall {serviceName objectName operationName argList {headers {}} {location {}}} {
variable serviceArr
::log::log debug "Entering [info level 0]"
::log::logsubst debug {Entering [info level 0]}
if {![info exists serviceArr($serviceName)]} {
return \
-code error \
-errorcode [list WS CLIENT UNKSRV $serviceName] \
"Unknown service '$serviceName'"
}
set serviceInfo $serviceArr($serviceName)
if {![dict exists $serviceInfo object $objectName]} {
return \
-code error \
-errorcode [list WS CLIENT UNKOBJ [list $serviceName $objectName]] \
"Unknown object '$objectName' for service '$serviceName'"
}
if {![dict exists $serviceInfo object $objectName operation $operationName]} {
return \
-code error \
-errorcode [list WS CLIENT UNKOPER [list $serviceName $objectName $operationName]] \
"Unknown operation '$operationName' for object '$objectName' of service '$serviceName'"
}
if {![string equal $location {}]} {
if {$location ne {}} {
set url $location
} else {
set url [dict get $serviceInfo object $objectName location]
}
##
## build call query
##
SaveAndSetOptions $serviceName
set query [buildRestCallquery $serviceName $objectName $operationName $url $argList]
if {[catch {set query [buildRestCallquery $serviceName $objectName $operationName $url $argList]} err]} {
RestoreSavedOptions $serviceName
return -code error -errorcode $::errorCode -errorinfo $::errorInfo $err
}
RestoreSavedOptions $serviceName
##
## Do http call
##
if {[dict exists $serviceInfo headers]} {
set headers [concat $headers [dict get $serviceInfo headers]]
}
set largs {}
if {[llength $headers]} {
set token [::http::geturl $url -query $query -type text/xml -headers $headers]
lappend largs -headers $headers
} else {
set token [::http::geturl $url -query $query -type text/xml]
}
set body [::WS::Utils::geturl_fetchbody $url\
::http::wait $token
-query $query\
-type [dict get $serviceInfo contentType]\
-timeout [dict get $serviceInfo queryTimeout]\
{*}$largs]
##
## Check for errors
## Parse results
##
set body [::http::data $token]
::log::log debug "\tReceived: $body"
set httpStatus [::http::status $token]
set hadError 0
set results {}
if {![string equal $httpStatus ok] ||
([::http::ncode $token] != 200 && [string equal $body {}])} {
::log::log debug "\tHTTP error [array get $token]"
set results [::http::error $token]
if {[string equal $results {}] || [string equal $httpStatus eof]} {
set results {Unexpected EOF received from Server}
set errorCode [list WSCLIENT HTTPERROR UNEXPEOF]
} else {
set errorCode [list WSCLIENT HTTPERROR [::http::code $token]]
}
set errorInfo {}
set hadError 1
} else {
set hadError [catch {parseRestResults $serviceName $objectName $operationName $body} results]
if {$hadError} {
SaveAndSetOptions $serviceName
if {[catch {
parseRestResults $serviceName $objectName $operationName $body
} results]} {
::log::log debug "Reply was [::http::data $token]"
set errorCode $::errorCode
set errorInfo $::errorInfo
}
}
::http::cleanup $token
if {$hadError} {
RestoreSavedOptions $serviceName
::log::log debug "Leaving (error) ::WS::Client::DoRestCall"
return \
-code error \
return -code error $results
-errorcode $errorCode \
-errorinfo $errorInfo \
$results
}
RestoreSavedOptions $serviceName
} else {
::log::log debug "Leaving ::WS::Client::DoRestCall with {$results}"
return $results
::log::logsubst debug {Leaving ::WS::Client::DoRestCall with {$results}}
return $results
}
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::DoARestsyncCall
#
# Description : Call an operation of a web service asynchronously
#
# Arguments :
# serviceName - The name of the Webservice
# operationName - The name of the Operation to call
# argList - The arguements to the operation as a dictionary object
# argList - The arguments to the operation as a dictionary object
# This is for both the Soap Header and Body messages.
# succesCmd - A command prefix to be called if the operations
# does not raise an error. The results, as a dictionary
# object are concatinated to the prefix.
# object are concatenated to the prefix.
# errorCmd - A command prefix to be called if the operations
# raises an error. The error code and stack trace
# are concatinated to the prefix.
# are concatenated to the prefix.
# headers - Extra headers to add to the HTTP request. This
# is a key value list argument. It must be a list with
# an even number of elements that alternate between
# keys and values. The keys become header field names.
# Newlines are stripped from the values so the header
# cannot be corrupted.
# This is an optional argument and defaults to {}.
#
# Returns :
# None.
#
# Side-Effects : None
#
# Exception Conditions :
# WSCLIENT HTTPERROR - if an HTTP error occured
# WS CLIENT HTTPERROR - if an HTTP error occurred
# others - as raised by called Operation
#
# Pre-requisite Conditions : Service must have been defined.
#
# Original Author : Gerald W. Lester
#
#>>END PUBLIC<<
|
︙ | | |
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
|
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
|
-
+
-
+
+
-
+
+
+
+
+
+
+
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
-
-
+
+
+
+
+
-
+
|
#
###########################################################################
proc ::WS::Client::DoRestAsyncCall {serviceName objectName operationName argList succesCmd errorCmd {headers {}}} {
variable serviceArr
set svcHeaders [dict get $serviceArr($serviceName) headers]
if {[llength $svcHeaders]} {
lappend headers $svcHeaders
set headers [concat $headers $svcHeaders]
}
::log::log debug "Entering ::WS::Client::DoAsyncRestCall [list $serviceName $objectName $operationName $argList $succesCmd $errorCmd $headers]"
::log::logsubst debug {Entering [info level 0]}
if {![info exists serviceArr($serviceName)]} {
return \
-code error \
-errorcode [list WS CLIENT UNKSRV $serviceName] \
"Unknown service '$serviceName'"
}
set serviceInfo $serviceArr($serviceName)
if {![dict exists $serviceInfo object $objectName operation $operationName]} {
return \
-code error \
-errorcode [list WS CLIENT UNKOPER [list $serviceName $objectName $operationName]] \
"Unknown operation '$operationName' for service '$serviceName'"
}
if {[dict exists $serviceInfo headers]} {
set headers [concat $headers [dict get $serviceInfo headers]]
}
set url [dict get $serviceInfo object $objectName location]
SaveAndSetOptions $serviceName
set query [buildRestCallquery $serviceName $objectName $operationName $url $argList]
if {[catch {set query [buildRestCallquery $serviceName $objectName $operationName $url $argList]} err]} {
RestoreSavedOptions $serviceName
return -code error -errorcode $::errorCode -errorinfo $::errorInfo $err
} else {
RestoreSavedOptions $serviceName
}
set largs {}
if {[llength $headers]} {
lappend largs -headers $headers
}
::http::geturl $url \
::log::logsubst info {::http::geturl $url \
-query $query \
-type text/xml \
-type [dict get $serviceInfo contentType] \
-headers $headers \
-command [list ::WS::Client::asyncRestCallDone $serviceName $operationName $succesCmd $errorCmd]
} else {
::http::geturl $url \
-command [list ::WS::Client::asyncRestCallDone $serviceName $operationName $succesCmd $errorCmd] \
-timeout [dict get $serviceInfo queryTimeout]\
{*}$largs}
::http::geturl $url \
-query $query \
-type text/xml \
-command [list ::WS::Client::asyncRestCallDone $serviceName $operationName $succesCmd $errorCmd]
}
-type [dict get $serviceInfo contentType] \
-headers $headers \
-command [list ::WS::Client::asyncRestCallDone $serviceName $operationName $succesCmd $errorCmd] \
-timeout [dict get $serviceInfo queryTimeout]\
{*}$largs
::log::log debug "Leaving ::WS::Client::DoAsyncRestCall"
return;
return
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
|
︙ | | |
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
|
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
|
-
+
-
-
-
+
+
+
-
+
+
+
-
-
+
-
-
+
+
-
+
-
+
|
# 1 07/06/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::buildRestCallquery {serviceName objectName operationName url argList} {
variable serviceArr
::log::log debug "Entering [info level 0]"
::log::logsubst debug {Entering [info level 0]}
set serviceInfo $serviceArr($serviceName)
set msgType [dict get $serviceInfo object $objectName operation $operationName inputs]
set xnsList [dict get $serviceInfo targetNamespace]
dom createDocument "request" doc
$doc documentElement body
$body setAttribute \
"method" $operationName
foreach xns $xnsList {
set tns [lindex $xns 0]
set target [lindex $xns 1]
foreach {tns target} $xnsList {
#set tns [lindex $xns 0]
#set target [lindex $xns 1]
$body setAttribute \
xmlns:$tns $target
}
set xns [dict get [::WS::Utils::GetServiceTypeDef Client $serviceName $msgType] xns]
::log::log debug "calling [list ::WS::Utils::convertDictToType Client $serviceName $doc $body $argList $msgType]"
::log::logsubst debug {calling [list ::WS::Utils::convertDictToType Client $serviceName $doc $body $argList $msgType]}
set options [::WS::Utils::SetOption]
::WS::Utils::SetOption UseNS 0
::WS::Utils::SetOption genOutAttr 1
::WS::Utils::SetOption valueAttr {}
::WS::Utils::convertDictToType Client $serviceName $doc $body $argList $msgType
set encoding [lindex [split [lindex [split [dict get $serviceInfo contentType] {;}] end] {=}] end]
foreach {option value} $options {
::WS::Utils::SetOption $option $value
}
append xml \
{<?xml version="1.0" encoding="utf-8"?>} \
set xml [format {<?xml version="1.0" encoding="%s"?>} $encoding]
"\n" \
[$doc asXML -indent none -doctypeDeclaration 0]
append xml "\n" [$doc asXML -indent none -doctypeDeclaration 0]
#regsub "<!DOCTYPE\[^>\]*>\n" [::dom::DOMImplementation serialize $doc] {} xml
$doc delete
set xml [encoding convertto $encoding $xml]
set inTransform [dict get $serviceInfo inTransform]
if {![string equal $inTransform {}]} {
if {$inTransform ne {}} {
set xml [$inTransform $serviceName $operationName REQUEST $xml $url $argList]
}
::log::log debug "Leaving ::::WS::Client::buildRestCallquery with {$xml}"
::log::logsubst debug {Leaving ::WS::Client::buildRestCallquery with {$xml}}
return $xml
}
###########################################################################
#
|
︙ | | |
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
|
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
|
-
+
-
-
+
+
|
# inXML - the XML returned by the operation
#
# Returns : A dictionary object representing the results
#
# Side-Effects : None
#
# Exception Conditions :
# WSCLIENT REMERR - The remote end raised an exception, the third element of
# WS CLIENT REMERR - The remote end raised an exception, the third element of
# the error code is the remote fault code.
# Error info is set to the remote fault details.
# The error message is the remote fault string;
# WSCLIENT BADREPLY - Badly formatted reply, the third element is a list of
# The error message is the remote fault string.
# WS CLIENT BADREPLY - Badly formatted reply, the third element is a list of
# what message type was received vs what was expected.
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
#
#>>END PRIVATE<<
|
︙ | | |
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
|
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
|
-
+
+
+
+
+
-
+
+
+
-
+
-
+
-
+
-
+
-
-
+
+
-
+
-
+
|
# 1 07/06/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::parseRestResults {serviceName objectName operationName inXML} {
variable serviceArr
::log::log debug "In parseResults $serviceName $operationName {$inXML}"
::log::logsubst debug {Entering [info level 0]}
set first [string first {<} $inXML]
if {$first > 0} {
set inXML [string range $inXML $first end]
}
set serviceInfo $serviceArr($serviceName)
set outTransform [dict get $serviceInfo outTransform]
if {![string equal $outTransform {}]} {
if {$outTransform ne {}} {
set inXML [$outTransform $serviceName $operationName REPLY $inXML]
}
set expectedMsgType [dict get $serviceInfo object $objectName operation $operationName outputs]
# save parsed xml handle in variable doc
dom parse $inXML doc
# save top node handle in variable top
$doc documentElement top
set xns {}
foreach tmp [dict get $serviceInfo targetNamespace] {
lappend xns [lindex $tmp 0] [lindex $tmp 1]
lappend xns $tmp
}
::log::log debug "Using namespaces {$xns}"
::log::logsubst debug {Using namespaces {$xns}}
set body $top
set status [$body getAttribute status]
##
## See if it is a standard error packet
##
if {![string equal $status {ok}]} {
if {$status ne {ok}} {
set faultstring {}
if {[catch {set faultstring [[$body selectNodes error] asText]}]} {
catch {set faultstring [[$body selectNodes error] asText]}
}
$doc delete
return \
-code error \
-errorcode [list WSCLIENT REMERR $status] \
-errorcode [list WS CLIENT REMERR $status] \
-errorinfo {} \
$faultstring
}
##
## Convert the packet to a dictionary
##
set results {}
set options [::WS::Utils::SetOption]
::WS::Utils::SetOption UseNS 0
::WS::Utils::SetOption parseInAttr 1
::log::log debug "Calling [list ::WS::Utils::convertTypeToDict Client $serviceName $body $expectedMsgType $body]"
if {![string equal $expectedMsgType {}]} {
::log::logsubst debug {Calling ::WS::Utils::convertTypeToDict Client $serviceName $body $expectedMsgType $body}
if {$expectedMsgType ne {}} {
set node [$body childNodes]
set nodeName [$node nodeName]
if {![string equal $objectName $nodeName]} {
if {$objectName ne $nodeName} {
return \
-code error \
-errorcode [list WSCLIENT BADRESPONSE [list $objectName $nodeName]] \
-errorcode [list WS CLIENT BADRESPONSE [list $objectName $nodeName]] \
-errorinfo {} \
"Unexpected message type {$nodeName}, expected {$objectName}"
}
set results [::WS::Utils::convertTypeToDict \
Client $serviceName $node $expectedMsgType $body]
}
foreach {option value} $options {
|
︙ | | |
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
|
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
|
-
+
+
-
-
-
+
+
+
-
+
+
-
+
+
+
+
+
+
|
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 07/06/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::asyncRestCallDone {serviceName objectName operationName succesCmd errorCmd token} {
::log::log debug "Entering ::WS::Client::asyncCallDone {$serviceName $objectName $operationName $succesCmd $errorCmd $token}"
::log::logsubst debug {Entering [info level 0]}
##
## Check for errors
##
set body [::http::data $token]
::log::logsubst info {\nReceived: $body}
if {![string equal [::http::status $token] ok] ||
([::http::ncode $token] != 200 && [string equal $body {}])} {
set errorCode [list WSCLIENT HTTPERROR [::http::code $token]]
if {[::http::status $token] ne {ok} ||
( [::http::ncode $token] != 200 && $body eq {} )} {
set errorCode [list WS CLIENT HTTPERROR [::http::code $token]]
set hadError 1
set errorInfo [::http::error $token]
set errorInfo [FormatHTTPError $token]
} else {
SaveAndSetOptions $serviceName
set hadError [catch {parseRestResults $serviceName $objectName $operationName $body} results]
if {[catch {set hadError [catch {parseRestResults $serviceName $objectName $operationName $body} results]} err]} {
RestoreSavedOptions $serviceName
return -code error -errorcode $::errorCode -errorinfo $::errorInfo $err
} else {
RestoreSavedOptions $serviceName
}
if {$hadError} {
set errorCode $::errorCode
set errorInfo $::errorInfo
}
}
##
|
︙ | | |
3141
3142
3143
3144
3145
3146
3147
3148
3149
|
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
|
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
lappend cmd $results
catch $cmd
##
## All done
##
::http::cleanup $token
return;
return
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Client::asyncRestobCallDone
#
# Description : Save the global options of the utilities package and
# set them for how this service needs them.
#
# Arguments :
# serviceName - the name of the service called
#
# Returns : Nothing
#
# Side-Effects : None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
#
#>>END PRIVATE<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 03/06/2012 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::SaveAndSetOptions {serviceName} {
variable serviceArr
variable utilsOptionsList
if {![info exists serviceArr($serviceName)]} {
return \
-code error \
-errorcode [list WS CLIENT UNKSRV $serviceName] \
"Unknown service '$serviceName'"
}
set serviceInfo $serviceArr($serviceName)
set savedDict {}
foreach item $utilsOptionsList {
if {[dict exists $serviceInfo $item] && [string length [set value [dict get $serviceInfo $item]]]} {
dict set savedDict $item [::WS::Utils::SetOption $item]
::WS::Utils::SetOption $item $value
}
}
dict set serviceArr($serviceName) UtilsSavedOptions $savedDict
return
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Client::RestoreSavedOptions
#
# Description : Restore the saved global options of the utilities package.
#
# Arguments :
# serviceName - the name of the service called
#
# Returns : Nothing
#
# Side-Effects : None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
#
#>>END PRIVATE<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 03/06/2012 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::RestoreSavedOptions {serviceName} {
variable serviceArr
if {![info exists serviceArr($serviceName)]} {
return \
-code error \
-errorcode [list WS CLIENT UNKSRV $serviceName] \
"Unknown service '$serviceName'"
}
set serviceInfo $serviceArr($serviceName)
set savedDict {}
foreach {item value} [dict get $serviceInfo UtilsSavedOptions] {
::WS::Utils::SetOption $item $value
}
dict set serviceArr($serviceName) UtilsSavedOptions {}
return
}
|
Changes to Embedded.tcl.
1
2
3
4
5
6
7
8
9
|
1
2
3
4
5
6
7
8
9
10
|
+
|
###############################################################################
## ##
## Copyright (c) 2016-2020, Harald Oehlmann ##
## Copyright (c) 2008, Gerald W. Lester ##
## All rights reserved. ##
## ##
## Redistribution and use in source and binary forms, with or without ##
## modification, are permitted provided that the following conditions ##
## are met: ##
## ##
|
︙ | | |
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
|
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
|
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
|
## CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT ##
## LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ##
## ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE ##
## POSSIBILITY OF SUCH DAMAGE. ##
## ##
###############################################################################
package require Tcl 8.6-
package require uri
package require base64
package require html
package require log
# Emulate the log::logsubst command introduced in log 1.4
if {![llength [info command ::log::logsubst]]} {
proc ::log::logsubst {level text} {
if {[::log::lvIsSuppressed $level]} {
return
}
::log::log $level [uplevel 1 [list subst $text]]
}
}
package provide WS::Embeded 1.4.0
package provide WS::Embeded 3.3.1
namespace eval ::WS::Embeded {
array set portInfo {}
set portList [list]
set forever {}
variable portInfo {}
variable handlerInfoDict {}
variable returnCodeText [dict create 200 OK 404 "Not Found" \
500 "Internal Server Error" 501 "Not Implemented"]
variable socketStateArray
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Embeded::AddHandler
#
# Description : Register a handler for a url on a port.
#
# Arguments :
# port -- The port to register the callback on
# url -- The URL to register the callback for
# urlPath -- The URL path to register the callback for
# callback -- The callback prefix, two additionally argumens are lappended
# the callback: (1) the socket (2) the null string
#
# Returns : Nothing
#
# Side-Effects :
# None
# method -- HTTP method: GET or POST
#
# Exception Conditions : None
#
# Pre-requisite Conditions : ::WS::Embeded::Listen must have been called for the port
#
# Original Author : Gerald W. Lester
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 03/28/2008 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Embeded::AddHandler {port url callback} {
variable portInfo
dict set portInfo($port,handlers) $url $callback
return;
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Embeded::AddHandlerAllPorts
#
# Description : Register a handler for a url on all "defined" ports.
#
# Arguments :
# url -- List of three elements:
# callback -- The callback prefix, two additionally argumens are lappended
# callback -- The callback prefix, two additionally arguments are lappended
# the callback: (1) the socket (2) the null string
#
# Returns : Nothing
#
# Side-Effects :
# None
#
|
︙ | | |
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
379
380
381
382
383
384
385
386
|
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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
|
+
+
+
-
-
+
+
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
-
-
-
-
-
-
+
+
+
+
-
-
+
-
-
-
-
-
+
-
-
-
+
+
-
-
-
-
+
+
+
+
+
-
-
+
-
-
-
-
-
-
-
+
+
+
-
-
+
-
-
+
+
+
-
-
+
-
-
-
+
+
+
+
-
-
+
+
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
+
+
-
+
-
+
-
+
+
-
+
-
+
-
-
-
+
-
+
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
-
-
+
+
+
+
+
-
-
-
-
+
-
+
+
-
+
+
+
|
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 03/28/2008 G.Lester Initial version
# 3.2.0 2021-03-17 H.Oehlmann Also pass method.
# 3.3.0 2021-03-19 H.Oehlmann Put handler info to own dict, so order of
# Listen and AddHandler call is not important.
#
#
###########################################################################
proc ::WS::Embeded::AddHandlerAllPorts {url callback} {
variable portList
proc ::WS::Embeded::AddHandler {port urlPath method callback} {
variable handlerInfoDict
foreach port $portList {
AddHandler $port $url $callback
}
return;
dict set handlerInfoDict $port $urlPath $method $callback
return
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Embeded::GetValue
#
# Description : Get a value found in this module
#
# Arguments :
# index -- type of value to get. Possible values:
# -- isHTTPS : true, if https protocol is used.
# port -- concerned port. May be ommitted, if not relevant for value.
#
# Returns : the distinct value
#
# Side-Effects :
# None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : ::WS::Embeded::Listen must have been called for the port
#
# Original Author : Harald Oehlmann
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 2.7.0 2020-10-26 H.Oehlmann Initial version
#
#
###########################################################################
proc ::WS::Embeded::GetValue {index {port ""}} {
variable portInfo
switch -exact -- $index {
isHTTPS { return [dict get $portInfo $port $index] }
default {return -code error "Unknown index '$index'"}
}
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Embeded::Listen
#
# Description : Instruct the module to listen on a Port, security information.
#
# Arguments :
# port -- Port number to listen on
# certfile -- Name of the certificate file
# keyfile -- Name of the key file
# userpwds -- A list of username and passwords
# realm -- The seucrity realm
# logger -- A logging routines for errors
# certfile -- Name of the certificate file or a pfx archive for twapi.
# Defaults to {}.
# keyfile -- Name of the key file. Defaults to {}.
# To use twapi TLS, specify a list with the following elements:
# -- "-twapi": Flag, that TWAPI TLS should be used
# -- password: password of PFX file passed by
# [::twapi::conceal]. The concealing makes sure that the
# password is not readable in the error stack trace
# -- ?subject?: optional search string in pfx file, if
# multiple certificates are included.
# userpwds -- A list of username:password. Defaults to {}.
# realm -- The security realm. Defaults to {}.
# timeout -- A time in ms the sender may use to send the request.
# If a sender sends wrong data (Example: TLS if no TLS is
# used), the process will just stand and a timeout is required
# to clear the connection. Set to 0 to not use a timeout.
# Default: 60000 (1 Minuit).
#
# Returns : Nothing
# Returns : socket handle
#
# Side-Effects :
# None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : ::WS::Embeded::Listen must have been called for the port
#
# Original Author : Gerald W. Lester
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 03/28/2008 G.Lester Initial version
# 3.0.0 2020-10-30 H.Oehlmann Add twapi tls support
# 3.3.0 2021-03-18 H.Oehlmann Add timeout option. Remove unused portList.
# Call Close, if we use the port already.
# Do not leave portInfo data, if open fails.
# 3.3.1 2021-03-23 H.Oehlmann Fix bug: pfx subject had added ")".
#
#
###########################################################################
proc ::WS::Embeded::Listen {port {certfile {}} {keyfile {}} {userpwds {}} {realm {}} {logger {::WS::Embeded::logger}}} {
proc ::WS::Embeded::Listen {port {certfile {}} {keyfile {}} {userpwds {}} {realm {}} {timeout 600000}} {
variable portInfo
variable portList
lappend portList $port
foreach key {port certfile keyfile userpwds realm logger} {
set portInfo($port,$key) [set $key]
}
if {![info exists portInfo($port,handlers)]} {
set portInfo($port,handlers) {}
}
foreach up $userpwds {
##
## Check if port already used by us. If yes, close it.
##
if {[dict exists $portInfo $port]} {
Close $port
}
##
## Check if HTTPS protocol is used
##
set isHTTPS [expr {$certfile ne ""}]
if {$isHTTPS } {
if { [string is list $keyfile] && [lindex $keyfile 0] eq "-twapi"} {
##
## Use TWAPI TLS
##
package require twapi_crypto
# Decode parameters
#
# certfile is the pfx file name
# keyfile is a list of:
# -twapi: fix element
# password of the pfx file, passed by twapi::conceal
# Optional Subject of the certificate, if there are multiple
# certificates contained.
# If not given, the first certificate is used.
set pfxpassword [lindex $keyfile 1]
set pfxsubject ""
if {[llength $keyfile] > 2} {
set pfxsubject [lindex $keyfile 2]
}
# Create certificate selection tring
if {$pfxsubject eq ""} {
set pfxselection any
} else {
lappend portInfo($port,auths) [base64::encode $up]]
}
if {$certfile ne ""} {
package require tls
set pfxselection [list subject_substring $pfxsubject]
}
set hFile [open $certfile rb]
set PFXCur [read $hFile]
close $hFile
# Set up the store containing the certificates
# Import the PFX file and search the certificate.
set certstore [twapi::cert_temporary_store -pfx $PFXCur \
-password $pfxpassword]
set servercert [twapi::cert_store_find_certificate $certstore \
{*}$pfxselection]
if {"" eq $servercert} {
# There was no certificate included in the pfx file
catch {twapi::cert_store_release $certstore}
return -code error "no certificate found in file '$certfile'"
}
# The following is catched to clean-up in case of any error
if {![catch {
# Start the TLS socket with the credentials
set creds [twapi::sspi_schannel_credentials \
-certificates [list $servercert] \
-protocols [list ssl3 tls1.1 tls1.2]]
set creds [twapi::sspi_acquire_credentials \
-credentials $creds -package unisp -role server]
set handle [::twapi::tls_socket \
-server [list ::WS::Embeded::accept $port] \
-credentials $creds $port]
} errormsg errordict]} {
# All ok, clear error flag
unset errormsg
}
# Clean up certificate and certificate store
if {[info exists servercert]} {
catch {twapi::cert_release $servercert}
}
catch {twapi::cert_store_release $certstore}
# Return error if happened above
if {[info exists errormsg]} {
dict unset errordict -level
return -options $errordict $errormsg
}
} else {
##
## Use TLS Package
##
package require tls
::tls::init \
-certfile $certfile \
-keyfile $keyfile \
::tls::init \
-certfile $certfile \
-keyfile $keyfile \
-ssl2 1 \
-ssl3 1 \
-tls1 0 \
-require 0 \
-request 0
::tls::socket -server [list ::WS::Embeded::accept $port] $port
-require 0 \
-request 0
set handle [::tls::socket -server [list ::WS::Embeded::accept $port] $port]
}
} else {
socket -server [list ::WS::Embeded::accept $port] $port
}
}
###########################################################################
#
##
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
## Use http protocol without encryption
##
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Embeded::ReturnData
#
::log::logsubst debug {socket -server [list ::WS::Embeded::accept $port] $port}
set handle [socket -server [list ::WS::Embeded::accept $port] $port]
}
# Description : Store the information to be returned.
#
##
# Arguments :
# socket -- Socket data is for
# type -- Mime type of data
# data -- Data
# code -- Status code
#
# Returns : Nothing
## Prepare basic authentication
##
set authlist {}
#
# Side-Effects :
foreach up $userpwds {
# None
#
lappend authlist [base64::encode $up]
}
# Exception Conditions : None
#
##
# Pre-requisite Conditions : A callback on the socket should be pending
#
# Original Author : Gerald W. Lester
## Save the port information dict entry
##
dict set portInfo $port [dict create\
port $port\
#
#>>END PUBLIC<<
realm $realm\
timeout $timeout\
#
# Maintenance History - as this file is modified, please be sure that you
auths $authlist\
isHTTPS $isHTTPS\
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 03/28/2008 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Embeded::ReturnData {sock type data code} {
upvar #0 ::WS::Embeded::Httpd$sock dataArray
handle $handle]
foreach var {type data code} {
dict set dataArray(reply) $var [set $var]
}
return;
return $handle
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Embeded::Start
# Procedure Name : ::WS::Embeded::Close
#
# Description : Start listening on all ports (i.e. enter the event loop).
# Description : End listening, close the port.
#
# Arguments : None
# Arguments :
# port -- Port number to listen on
#
# Returns : Value that event loop was exited with.
# Returns : none
#
# Side-Effects :
# None
#
# Exception Conditions : None
#
# Pre-requisite Conditions :
# Pre-requisite Conditions : None
# ::WS::Embeded::Listen should have been called for one or more port.
#
#
# Original Author : Gerald W. Lester
# Original Author : Harald Oehlmann
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 03/28/2008 G.Lester Initial version
# 3.3.0 2021-03-18 H.Oehlmann Initial version
#
#
###########################################################################
proc ::WS::Embeded::Start {} {
variable forever
set forever 0
vwait ::WS::Embeded::forever
return $forever
proc ::WS::Embeded::Close {port} {
variable socketStateArray
variable portInfo
# Check, if port exists
if {![dict exists $portInfo $port handle]} {return}
::log::log info "closing server socket for port $port"
# close server port
if {[catch {close [dict get $portInfo $port handle]} msg]} {
::log::log error "error closing server socket for port $port: $msg"
}
# close existing connections
foreach sock [array names socketStateArray] {
if {[dict get $socketStateArray($sock) port] eq $port} {
cleanup $sock
}
}
# remove registered data
dict unset portInfo $port
return
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Embeded::Stop
# Procedure Name : ::WS::Embeded::CloseAll
#
# Description : Exit dispatching request.
# Description : End listening, close all ports.
#
# Arguments :
# value -- Value that ::WS::Embedded::Start should return,
# port -- Port number to listen on
#
# Returns : Nothing
# Returns : none
#
# Side-Effects :
# None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
# Original Author : Harald Oehlmann
#
#>>END PUBLIC<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 03/28/2008 G.Lester Initial version
# 3.3.0 2021-03-18 H.Oehlmann Initial version
#
#
###########################################################################
proc ::WS::Embeded::Stop {{value 1}} {
vairable forever
proc ::WS::Embeded::CloseAll {} {
variable portInfo
foreach port [dict keys $portInfo] {
Close $port
}
set forever $value
vwait ::WS::Embeded::forever
return $forever
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Embeded::logger
# Procedure Name : ::WS::Embeded::respond
#
# Description : Stub for a logger.
# Description : Send response back to user.
#
# Arguments :
# sock -- Socket to send reply on
# args - not used
# code -- Code to send
# body -- HTML body to send
# head -- Additional HTML headers to send
#
# Returns :
# Nothing
#
# Side-Effects : None
#
# Exception Conditions : None
|
︙ | | |
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
|
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
|
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
+
-
+
-
-
-
|
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 03/28/2008 G.Lester Initial version
# 2.3.0 11/06/2012 H.Oehlmann Separate head and body,
# correct Content-length
#
#
###########################################################################
proc ::WS::Embeded::logger {args} {
puts $args
puts $::errorInfo
proc ::WS::Embeded::respond {sock code body {head ""}} {
set body [encoding convertto iso8859-1 $body\r\n]
if {[catch {
chan configure $sock -translation crlf
puts $sock "[httpreturncode $code]\nContent-Type: text/html; charset=ISO-8859-1\nConnection: close\nContent-length: [string length $body]"
if {"" ne $head} {
puts -nonewline $sock $head
}
# Separator head and body
puts $sock ""
chan configure $sock -translation binary
puts -nonewline $sock $body
close $sock
} msg]} {
log::log error "Error sending response: $msg"
cleanup $sock
} else {
cleanup $sock 1
}
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Embeded::httpreturncode
#
# Description : Format the first line of a http return including the status code
#
# Arguments :
# code -- numerical http return code
#
# Returns :
# Nothing
#
# Side-Effects : None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
#
#>>END PRIVATE<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 10/05/2012 H.Oehlmann Initial version
#
#
###########################################################################
proc ::WS::Embeded::httpreturncode {code} {
variable returnCodeText
if {[dict exist $returnCodeText $code]} {
set textCode [dict get $returnCodeText $code]
} else {
set textCode "???"
}
return "HTTP/1.0 $code $textCode"
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Embeded::respond
# Procedure Name : ::WS::Embeded::handler
#
# Description : Send response back to user.
# Description : Handle a request.
#
# Arguments :
# sock -- Socket to send reply on
# sock -- Incoming socket
# code -- Code to send
# body -- HTML body to send
# head -- HTML header to send
#
# Returns :
# Nothing
#
# Side-Effects : None
#
# Exception Conditions : None
|
︙ | | |
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
|
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
|
-
+
-
-
-
-
-
-
-
+
+
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
+
-
-
-
+
+
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-
-
+
+
+
-
-
+
+
-
-
+
+
-
-
-
-
+
+
+
+
-
-
+
+
-
-
-
+
+
+
-
-
-
-
-
+
+
+
+
+
-
-
-
-
-
-
-
-
+
+
-
-
-
-
+
-
-
-
-
-
-
-
-
-
+
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
+
+
-
-
-
-
+
+
+
-
+
-
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
+
+
+
+
+
+
-
+
-
-
+
+
+
+
-
-
-
+
+
+
+
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
|
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 03/28/2008 G.Lester Initial version
#
# 2.3.0 10/31/2012 G.Lester bug fix for [68310fe3bd] -- correct encoding and data length
#
###########################################################################
proc ::WS::Embeded::respond {sock code body {head ""}} {
puts -nonewline $sock "HTTP/1.0 $code ???\nContent-Type: text/html; charset=ISO-8859-1\nConnection: close\nContent-length: [string length $body]\n$head\n$body"
}
# 2.6.1 2020-10-22 H.Oehlmann Do not pass parameter reqstring.
# The corresponding value is found in global
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
# array anyway.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Embeded::checkauth
#
# Description : Check to see if the user is allowed.
#
# Arguments :
# port -- Port number
# sock -- Incoming socket
# ip -- Requester's IP address
# auth -- Authentication information
# Use charset handler of request decoding.
# 2.7.0 2020-10-26 H.Oehlmann Pass additional port parameter to handle
# functions. This helps to get isHTTPS
# status for WSDL.
# 3.1.0 2020-11-05 H.Oehlmann Pass additional port parameter with leading
# -port specifier to avoid clash with
# other parameters.
#
# Returns :
# Nothing
# 3.2.0 2021-03-17 H.Oehlmann Return the result directly by the call.
# Replace global parameter dict by parameter
# url and dataDict (for POST method).
# 3.3.0 2021-03-18 H.Oehlmann Use state array, move checks to Receive,
# do query recode here.
#
# Side-Effects : None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
#
#>>END PRIVATE<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 03/28/2008 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Embeded::checkauth {port sock ip auth} {
variable portInfo
proc ::WS::Embeded::handler {sock} {
variable socketStateArray
if {[info exists portInfo($port,auths)] && [llength $portInfo($port,auths)] && [lsearch -exact $portInfo($port,auths) $auth]==-1} {
set realm $portInfo($port,realm)
set cmd [dict get $socketStateArray($sock) cmd]
respond $sock 401 Unauthorized "WWW-Authenticate: Basic realm=\"$realm\"\n"
$portInfo($port,logger) "Unauthorized from $ip"
return -code error
if {[dict get $socketStateArray($sock) method] eq "POST"} {
# Recode the query data
}
}
dict set socketStateArray($sock) query [encoding convertfrom\
[dict get $socketStateArray($sock) requestEncoding]\
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Embeded::handler
#
# Description : Handle a request.
#
# Arguments :
# port -- Port number
# sock -- Incoming socket
# ip -- Requester's IP address
# reqstring -- Requester's message
# auth -- Authentication information
[dict get $socketStateArray($sock) query]]
# The following dict keys are attended: query, ipaddr, headers
if {[catch {
lassign [$cmd $sock -data $socketStateArray($sock)] type data code
} msg]} {
::log::log error "Return 404 due to post eval error: $msg"
tailcall respond $sock 404 "Error: $msg"
#
# Returns :
# Nothing
}
} else {
if {[catch {
#
# Side-Effects : None
lassign [$cmd $sock -port [dict get $socketStateArray($sock) port]] type data code
} msg]} {
#
# Exception Conditions : None
::log::log error "Return 404 due to get eval error: $msg"
tailcall respond $sock 404 "Error: $msg"
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
}
}
# This may modify the type variable, if encoding is not found
set encoding [contentTypeParse 0 type]
#
#>>END PRIVATE<<
set data [encoding convertto $encoding $data]
set reply "[httpreturncode $code]\n"
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
append reply "Content-Type: $type\n"
append reply "Connection: close\n"
append reply "Content-length: [string length $data]\n"
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 03/28/2008 G.Lester Initial version
# Note: to avoid delay, full buffering is used on the channel.
# In consequence, the data is sent in the background after the close.
# Socket errors may not be detected, but the event queue is free.
# This is specially important with the Edge browser, which sometimes delays
#
#
###########################################################################
proc ::WS::Embeded::handler {port sock ip reqstring auth} {
variable portInfo
upvar #0 ::WS::Embeded::Httpd$sock req
if {[catch {checkauth $port $sock $ip $auth}]} {
# data reception.
if {[catch {
$portInfo($port,logger) {Auth Failed}
return;
}
chan configure $sock -translation crlf
set ::errorInfo {}
array set req $reqstring
#foreach var {type data code} {
# dict set req(reply) $var [set $var]
#}
set path "/[string trim $req(path) /]"
if {[dict exists $portInfo($port,handlers) $path]} {
set cmd [dict get $portInfo($port,handlers) $path]
lappend cmd $sock {}
puts $sock $reply
puts "Calling {$cmd}"
if {[catch {eval $cmd} msg]} {
$portInfo($port,logger) [list 404 b $msg]
respond $sock 404 Error $msg
chan configure $sock -translation binary
} else {
set data [dict get $req(reply) data]
set reply "HTTP/1.0 [dict get $req(reply) code] ???\n"
append reply "Content-Type: [dict get $req(reply) type]; charset=UTF-8\n"
append reply "Connection: close\n"
append reply "Content-length: [string length $data]\n"
append reply "\n"
append reply $data
puts -nonewline $sock $reply
$portInfo($port,logger) ok
puts -nonewline $sock $data
close $sock
}
} else {
$portInfo($port,logger) {404 Error}
respond $sock 404 Error "Error"
} msg]} {
::log::log error "Error sending reply: $msg"
tailcall cleanup $sock
}
::log::log debug ok
return;
tailcall cleanup $sock 1
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Embeded::accept
#
# Description : Accept an incoming connection.
# Description : Accept an incoming connection and register callback.
#
# Arguments :
# port -- Port number
# sock -- Incoming socket
# ip -- Requester's IP address
# clientport -- Requester's port number
#
# Returns :
# Nothing
#
# Side-Effects : None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Gerald W. Lester
# Original Author : Harald Oehlmann
#
#>>END PRIVATE<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 3.3.0 2021-03-18 H.Oehlmann Initial version
#
#
###########################################################################
proc ::WS::Embeded::accept {port sock ip clientport} {
variable portInfo
variable socketStateArray
::log::logsubst info {Received request on $port for $ip:$clientport}
# Setup events
if {[catch {
chan configure $sock -blocking 0 -translation crlf
chan event $sock readable [list ::WS::Embeded::receive $sock]
} msg]} {
catch {chan close $sock}
::log::log error "Error installing accepted socket on ip '$ip': $msg"
return
}
# Prepare socket state dict
set stateDict [dict create port $port ip $ip phase request]
# Install timeout
if {0 < [dict get $portInfo $port timeout]} {
dict set stateDict timeoutHandle [after\
[dict get $portInfo $port timeout]\
[list ::WS::Embeded::timeout $sock]]
}
# Save state dict
set socketStateArray($sock) $stateDict
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Embeded::receive
#
# Description : handle a readable socket
#
# Arguments :
# sock -- Incoming socket
#
# Returns :
# Nothing
#
# Side-Effects : None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Harald Oehlmann
#
#>>END PRIVATE<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 3.3.0 2021-03-18 H.Oehlmann Initial version
#
#
###########################################################################
proc ::WS::Embeded::receive {sock} {
variable socketStateArray
variable portInfo
variable handlerInfoDict
##
## Make data read attempts in this read loop.
##
while 1 {
::log::logsubst debug {Top of loop with dict: $socketStateArray($sock)}
##
## Read data
##
if {[catch {
if {[dict get $socketStateArray($sock) phase] eq "body"} {
# Read binary data
set line [chan read $sock [dict get $socketStateArray($sock) readMax]]
} else {
# read line data
set line [chan gets $sock]
}
} msg]} {
::log::log error "Data read error: $msg"
tailcall cleanup $sock
}
::log::logsubst debug {Read: len [string length $line] eof [eof $sock] block [chan blocked $sock] data '$line'}
##
## Check for early EOF
##
if { [eof $sock] } {
::log::log warning {Connection closed from client}
tailcall cleanup $sock
}
##
## Check for no new data, so wait for next file event.
##
## For gets:
## This makes also the difference between empty data read (crlf
## terminated line) and no read (true).
## For read with limit:
## If not all characters could be read, block is flagged with data.
## So check the data length to 0 for this case.
##
if {[string length $line] == 0 && [chan blocked $sock]} {
return
}
##
## Handle the received data
##
switch -exact -- [dict get $socketStateArray($sock) phase] {
request {
##
## Handle Request line
##
if {![regexp {^([^ ]+) +([^ ]+) ([^ ]+)$} $line -> method url version]} {
::log::logsubst warning {Wrong request: $line}
tailcall cleanup $sock
}
if {$method ni {"GET" "POST"}} {
::log::logsubst warning {Unsupported method '$method'}
tailcall respond $sock 501 "Method not implemented"
}
# Check if we have a handler for this method and URL path
set urlPath "/[string trim [dict get [uri::split $url] path] /]"
set port [dict get $socketStateArray($sock) port]
if {![dict exists $handlerInfoDict $port $urlPath $method]} {
::log::log warning "404 Error: URL path '$urlPath' not found"
tailcall respond $sock 404 "URL not found"
}
# Save data and pass to header phase
dict set socketStateArray($sock) cmd [dict get $handlerInfoDict $port $urlPath $method]
dict set socketStateArray($sock) phase header
dict set socketStateArray($sock) method $method
dict set socketStateArray($sock) header ""
}
header {
##
## Handle Header lines
##
if {[string length $line] > 0} {
if {[regexp {^([^:]*):(.*)$} $line -> key data]} {
dict set socketStateArray($sock) header [string tolower $key] [string trim $data]
}
} else {
# End of header by empty line
##
## Get authorization failure condition
##
# Authorization is ok, if no authrization required
# Authorization fails, if:
# - no authentication in current request
# - or current credentials incorrect
set port [dict get $socketStateArray($sock) port]
if { 0 != [llength [dict get $portInfo $port auths]] &&
! ( [dict exists $socketStateArray($sock) header authorization] &&
[regexp -nocase {^basic +([^ ]+)$} \
[dict get $socketStateArray($sock) header authorization] -> auth] &&
$auth in [dict get $portInfo $port auths] )
} {
set realm [dict get $portInfo $port realm]
::log::log warning {Unauthorized}
tailcall respond $sock 401 "" "WWW-Authenticate: Basic realm=\"$realm\"\n"
}
# Within the GET method, we have all we need
if {[dict get $socketStateArray($sock) method] eq "GET"} {
tailcall handler $sock
}
# Post method requires content-encoding header
if {![dict exists $socketStateArray($sock) header content-type]} {
::log::logsubst warning {Header missing: 'Content-Type'}
tailcall cleanup $sock
}
set contentType [dict get $socketStateArray($sock) header content-type]
dict set socketStateArray($sock) requestEncoding [contentTypeParse 1 contentType]
# Post method requires query data
dict set socketStateArray($sock) query ""
set fChunked [expr {
[dict exists $socketStateArray($sock) header transfer-encoding] &&
[dict get $socketStateArray($sock) header transfer-encoding] eq "chunked"}]
dict set socketStateArray($sock) fChunked $fChunked
if {$fChunked} {
dict set socketStateArray($sock) phase chunk
} else {
# Check for content length
if { ! [dict exists $socketStateArray($sock) header content-length] ||
0 == [scan [dict get $socketStateArray($sock) header content-length] %d contentLength]
} {
::log::log warning "Header content-length missing"
tailcall cleanup $sock
}
dict set socketStateArray($sock) readMax $contentLength
dict set socketStateArray($sock) phase body
# Switch to binary data
if {[catch { chan configure $sock -translation binary } msg]} {
::log::log error "Channel config error: $msg"
tailcall cleanup $sock
}
}
}
}
body {
##
## Read body data
##
set query [dict get $socketStateArray($sock) query]
append query $line
dict set socketStateArray($sock) query $query
set readMax [expr {
[dict get $socketStateArray($sock) readMax] - [string length $line] } ]
if {$readMax > 0} {
# Data missing, so loop
dict set socketStateArray($sock) readMax $readMax
} else {
# We have all data
if {[dict get $socketStateArray($sock) fChunked]} {
# Chunk read
# Switch to line mode
if {[catch { chan configure $sock -translation crlf } msg]} {
::log::log error "Channel config error: $msg"
tailcall cleanup $sock
}
dict set socketStateArray($sock) phase chunk
} else {
# no chunk -> all data -> call handler
tailcall handler $sock
}
}
}
chunk {
##
## Handle chunk header
##
if {[scan $line %x length] != 1} {
::log::log warning "No chunk length in '$line'"
tailcall cleanup $sock
}
if {$length > 0} {
# Receive chunk data
# Switch to binary data
if {[catch { chan configure $sock -translation binary } msg]} {
::log::log error "Channel config error: $msg"
tailcall cleanup $sock
}
dict set socketStateArray($sock) readMax $length
dict set socketStateArray($sock) phase body
} else {
# We have all data
tailcall handler $sock
}
}
}
}
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Embeded::timeout
#
# Description : socket timeout fired
#
# Arguments :
# sock -- Incoming socket
#
# Returns :
# Nothing
#
# Side-Effects : None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Harald Oehlmann
#
#>>END PRIVATE<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 3.3.0 2021-03-18 H.Oehlmann Initial version
#
#
###########################################################################
proc ::WS::Embeded::timeout {sock} {
variable socketStateArray
# The timeout fired, so the cancel handle is not required any more
dict unset socketStateArray($sock) timeoutHandle
::log::log warning "Cancelling request due to timeout"
tailcall cleanup $sock
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Embeded::cleanup
#
# Description : cleanup a socket
#
# Arguments :
# sock -- Incoming socket
# fClosed -- Socket already closed
#
# Returns :
# Nothing
#
# Side-Effects : None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Harald Oehlmann
#
#>>END PRIVATE<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 3.3.0 2021-03-18 H.Oehlmann Initial version
#
#
###########################################################################
proc ::WS::Embeded::cleanup {sock {fClosed 0}} {
variable socketStateArray
if {!$fClosed} {
catch { chan close $sock }
}
if {[dict exists $socketStateArray($sock) timeoutHandle]} {
after cancel [dict get $socketStateArray($sock) timeoutHandle]
}
unset socketStateArray($sock)
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Embeded::contentTypeParse
#
# Description : Parse a content-type value and get the encoding.
# When receiving, only the encoding is required.
# When sending, we have to correct the encoding, if not known
# by TCL. Thus, the content-type string is changed.
#
# Arguments :
# fReceiving -- When receiving, we only need the extracted codepage.
# If sending, the content-type string must be modified,
# if the codepage is not found in tcl
# contentTypeName -- The variable containing the content type string.
#
# Returns :
# tcl encoding to apply
#
# Side-Effects : None
#
# Exception Conditions : None
#
# Pre-requisite Conditions : None
#
# Original Author : Harald Oehlmann
#
#>>END PRIVATE<<
#
# Maintenance History - as this file is modified, please be sure that you
# update this segment of the file header block by
# adding a complete entry at the bottom of the list.
#
# Version Date Programmer Comments / Changes / Reasons
# ------- ---------- ---------- -------------------------------------------
# 1 03/28/2008 G.Lester Initial version
# 2.6.1 2020-10-22 H.Oehlmann Initial version
#
#
###########################################################################
proc ::WS::Embeded::accept {port sock ip clientport} {
variable portInfo
proc ::WS::Embeded::contentTypeParse {fReceiving contentTypeName} {
upvar 1 $contentTypeName contentType
##
## Extract charset parameter from content-type header
##
if {[catch {
gets $sock line
set auth ""
# content-type example content: text/xml;charset=utf-8
set paramList [lassign [split $contentType ";"] typeOnly]
foreach parameterCur $paramList {
set parameterCur [string trim $parameterCur]
for {set c 0} {[gets $sock temp]>=0 && $temp ne "\r" && $temp ne ""} {incr c} {
regexp {Authorization: Basic ([^\r\n]+)} $temp -- auth
if {$c == 30} {
# Check for 'charset="<data>', where data may contain '\"'
if {[regexp -nocase {^charset\s*=\s*\"((?:[^""]|\\\")*)\"$} \
$parameterCur -> requestEncoding]
} {
$portInfo($port,logger) "Too many lines from $ip"
}
}
if {[eof $sock]} {
$portInfo($port,logger) "Connection closed from $ip"
}
foreach {method url version} $line { break }
switch -exact $method {
GET {
handler $port $sock $ip [uri::split $url] $auth
set requestEncoding [string map {{\"} \"} $requestEncoding]
break
} else {
# check for 'charset=<data>'
regexp -nocase {^charset\s*=\s*(\S+?)$} \
$parameterCur -> requestEncoding
break
}
}
##
## Find the corresponding TCL encoding name
##
if {[info exists requestEncoding]} {
if {[llength [info commands ::http::CharsetToEncoding]]} {
# Use private http package routine
set requestEncoding [::http::CharsetToEncoding $requestEncoding]
# Output is "binary" if not found
if {$requestEncoding eq "binary"} {
unset requestEncoding
}
} else {
# Reduced version of the http package version only honoring ISO8859-x
# and encoding names identical to tcl encoding names
set requestEncoding [string tolower $requestEncoding]
if {[regexp {iso-?8859-([0-9]+)} $requestEncoding -> num]} {
set requestEncoding "iso8859-$num"
}
if {$requestEncoding ni [encoding names]} {
default {
unset requestEncoding
$portInfo($port,logger) "Unsupported method '$method' from $ip"
}
}
}
} msg]} {
$portInfo($port,logger) "Error: $msg"
##
## Output found encoding and eventually content type
##
# If encoding was found, just return it
if {[info exists requestEncoding]} {
return $requestEncoding
}
# encoding was not found
if {$fReceiving} {
# This is the http default so use that
::log::logsubst info {Use default encoding as content type header has missing/unknown charset in '$contentType'}
return iso8859-1
}
catch {flush $sock}
catch {close $sock}
return;
# When sending, be sure to cover all characters, so use utf-8
# correct content-type string (upvar)
::log::logsubst info {Set send charset to utf-8 due missing/unknown charset in '$contentType'}
if {[info exists typeOnly]} {
set contentType "${typeOnly};charset=utf-8"
} else {
set contentType "text/xml;charset=utf-8"
}
return utf-8
}
|
Changes to Examples/Echo/CallEchoWebService.tcl.
Added Examples/Echo/EchoEmbeddedService.tcl.