1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
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
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
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
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
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
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
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
1448
1449
1450
1451
1452
1453
1454
1455
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
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
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
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
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
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
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
2133
2134
2135
2136
2137
2138
2139
2140
2141
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
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
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
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
2818
2819
2820
2821
2822
2823
2824
2825
2826
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
2876
2877
2878
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
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
2961
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
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
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
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
| ###############################################################################
## ##
## Copyright (c) 2006-2008, 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. ##
## ##
## Redistribution and use in source and binary forms, with or without ##
## modification, are permitted provided that the following conditions ##
## are met: ##
## ##
## * Redistributions of source code must retain the above copyright ##
## notice, this list of conditions and the following disclaimer. ##
## * Redistributions in binary form must reproduce the above ##
## copyright notice, this list of conditions and the following ##
## disclaimer in the documentation and/or other materials provided ##
## with the distribution. ##
## * Neither the name of the Visiprise Software, Inc nor the names ##
## of its contributors may be used to endorse or promote products ##
## derived from this software without specific prior written ##
## permission. ##
## ##
## THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ##
## "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT ##
## LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS ##
## FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ##
## COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, ##
## INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, ##
## BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; ##
## LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER ##
## 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 1.4.0
#package require Tcl 8.5
if {![llength [info command dict]]} {
package require dict
}
# Until we get the package ready
if {![llength [info command dom]]} {
set ext [info sharedlibextension]
if {[catch {uplevel #0 load $::hms::home/publiclib/tdom$ext} retResult]} {
return -code error $retResult
}
}
#package require tdom 0.8
package require http 2
package require log
package require uri
catch {
package require tls
http::register https 443 ::tls::socket
}
package provide WS::Client 1.4.0
namespace eval ::WS::Client {
##
## 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
## types - dictionary of types
## service - dictionary containing general information about the service, formatted:
## name -- the name of the service
## location -- the url
## style -- style of call (e.g. rpc/encoded, document/literal)
##
## For style of rpc/encoded, document/literal
## operations - dictionary with information about the operations. The key
## is the operations name and each with the following structure:
## soapRequestHeader -- list of SOAP Request Headers
## soapReplyHeader -- list of SOAP Reply Headers
## action -- SOAP Action Header
## inputs -- list of fields with type info
## outputs -- return type
## style -- style of call (e.g. rpc/encoded, document/literal)
##
## For style of rest
## object - dictionary with informat about objects. The key is the object
## name each with the following strucutre:
## operations -- dictionary with information about the operations. The key
## 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 ::WS::Client::serviceArr {}
set ::WS::Client::currentBaseUrl {}
array set ::WS::Client::options {
skipLevelWhenActionPresent 0
suppressTargetNS 0
}
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::CreateService
#
# Description : Define a service
#
# Arguments :
# serviceName - Service name to add namespace to
# type - The type of service, currently only REST is supported
# url - URL of namespace file to import
# args - Optional arguments:
# -header httpHeaderList
#
# Returns : The local alias (tns)
#
# 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
#
#
###########################################################################
proc ::WS::Client::CreateService {serviceName type url args} {
variable serviceArr
variable options
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 tns1 $url
dict set serviceArr($serviceName) name $serviceName
dict set serviceArr($serviceName) location $url
dict set serviceArr($serviceName) style $type
dict set serviceArr($serviceName) inTransform {}
dict set serviceArr($serviceName) outTransform {}
dict set serviceArr($serviceName) skipLevelWhenActionPresent $options(skipLevelWhenActionPresent)
dict set serviceArr($serviceName) suppressTargetNS $options(suppressTargetNS)
foreach {name value} $args {
set name [string trimleft $name {-}]
dict set serviceArr($serviceName) $name $value
}
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 $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
# item - The item to configure
# value - Optional, the new value
#
# 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/14/2009 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::Config {serviceName item {value {}}} {
variable serviceArr
set serviceInfo $serviceArr($serviceName)
switch -exact -- $item {
suppressTargetNS -
skipLevelWhenActionPresent -
location -
targetNamespace {
##
## Valid, so do nothing
##
}
default {
return -code error "Uknown option '$item'"
}
}
if {![string equal $value {}]} {
dict set serviceInfo $item $value
set serviceArr($serviceName) $serviceInfo
}
return [dict get $serviceInfo $item]
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::SetServiceTransforms
#
# Description : Define a service's transforms
# Transform signature is:
# cmd serviceName operationName transformType xml {url {}} {argList {}}
# where transformType is REQUEST or REPLY
# and url and argList will only be present for transformType == REQUEST
#
# Arguments :
# serviceName - Service name to add namespace to
# inTransform - Input transform, defaults to {}
# outTransform - Output transform, defaults to {}
#
# Returns : None
#
# 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
#
#
###########################################################################
proc ::WS::Client::SetServiceTransforms {serviceName {inTransform {}} {outTransform {}}} {
variable serviceArr
dict set serviceArr($serviceName) inTransform $inTransform
dict set serviceArr($serviceName) outTransform $outTransform
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::GetServiceTransforms
#
# Description : Define a service's transforms
#
# Arguments :
# serviceName - Service name to add namespace to
#
# Returns : List of two elements: inTransform outTransform
#
# 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
#
#
###########################################################################
proc ::WS::Client::GetServiceTransforms {serviceName} {
variable serviceArr
set inTransform [dict get serviceArr($serviceName) inTransform]
set outTransform [dict get serviceArr($serviceName) outTransform]
return [list $inTransform $outTransform]
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>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
# definition is of the format: name typeInfo
# 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
#
# 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
#
#
###########################################################################
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
}
if {![llength $location]} {
set location [dict get $serviceArr($serviceName) location]
}
if {![string equal $inputArgs {}]} {
set inType $objectName.$operationName.Request
::WS::Utils::ServiceTypeDef Client $serviceName $inType $inputArgs
} else {
set inType {}
}
if {![string equal $returnType {}]} {
set outType $objectName.$operationName.Results
::WS::Utils::ServiceTypeDef Client $serviceName $outType $returnType
} else {
set outType {}
}
dict set serviceArr($serviceName) object $objectName location $location
dict set serviceArr($serviceName) object $objectName operation $operationName inputs $inType
dict set serviceArr($serviceName) object $objectName operation $operationName outputs $outType
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::ImportNamespace
#
# Description : Import and additional namespace into the service
#
# Arguments :
# serviceName - Service name to add namespace to
# url - URL of namespace file to import
#
# Returns : The local alias (tns)
#
# 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 01/30/2009 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::ImportNamespace {serviceName url} {
variable serviceArr
switch -exact -- [dict get [::uri::split $url] scheme] {
file {
upvar #0 [::uri::geturl $url] token
set xml $token(data)
unset token
}
http {
set token [::http::geturl $url]
::http::wait $token
set ncode [::http::ncode $token]
set xml [::http::data $token]
::http::cleanup $token
if {$ncode != 200} {
return \
-code error \
-errorcode [list WS CLIENT HTTPFAIL $url] \
"HTTP get of import file failed '$url'"
}
}
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)
::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]
}
}
return $result
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::GetOperationList
#
# Description : Import and additional namespace into the service
#
# Arguments :
# serviceName - Service name to add namespace to
#
# Returns : A list of operations names.
#
# 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 01/30/2009 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::GetOperationList {serviceName {object {}}} {
variable serviceArr
if {[string equal $object {}]} {
return [dict get $serviceArr($serviceName) operList]
} else {
return [dict get $serviceArr($serviceName) operation $object inputs]
}
}
###########################################################################
#
# 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
# 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
#
# 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 01/30/2009 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::AddInputHeader {serviceName operationName headerType {attrList {}}} {
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 ;
}
###########################################################################
#
# 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
#
# 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
#
# Returns : Nothing
#
# 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 01/30/2009 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::AddOutputHeader {serviceName operation headerType} {
variable serviceArr
set serviceInfo $serviceArr($serviceName)
set soapReplyHeader [dict get $serviceInfo operation $operationName soapReplyHeader]
lappend soapReplyHeader $headerType
dict set serviceInfo operation $operationName 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::LoadParsedWsdl
#
# Description : Load a saved service definition in
#
# Arguments :
# serviceInfo - parsed service definition, as returned from
# ::WS::Client::ParseWsdl or ::WS::Client::GetAndParseWsdl
# 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.
#
# Returns : The name of the service loaded
#
# 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
#
#
###########################################################################
proc ::WS::Client::LoadParsedWsdl {serviceInfo {headers {}} {serviceAlias {}}} {
variable serviceArr
if {[string length $serviceAlias]} {
set serviceName $serviceAlias
} else {
set serviceName [dict get $serviceInfo name]
}
if {[llength $headers]} {
dict set serviceInfo headers $headers
}
set serviceArr($serviceName) $serviceInfo
if {[dict exists $serviceInfo types]} {
foreach {typeName partList} [dict get $serviceInfo types] {
set definition [dict get $partList definition]
set xns [dict get $partList xns]
if {[string equal [lindex [split $typeName {:}] 1] {}]} {
::WS::Utils::ServiceTypeDef Client $serviceName $typeName $definition tns1
} else {
#set typeName [lindex [split $typeName {:}] 1]
::WS::Utils::ServiceTypeDef Client $serviceName $typeName $definition $xns
}
}
}
if {[dict exists $serviceInfo simpletypes]} {
foreach partList [dict get $serviceInfo simpletypes] {
lassign $partList typeName definition
if {[string equal [lindex [split $typeName {:}] 1] {}]} {
::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 $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
# 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.
#
# 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
#
#
###########################################################################
proc ::WS::Client::GetAndParseWsdl {url {headers {}} {serviceAlias {}}} {
variable currentBaseUrl
set currentBaseUrl $url
switch -exact -- [dict get [::uri::split $url] scheme] {
file {
upvar #0 [::uri::geturl $url] token
set wsdlInfo [ParseWsdl $token(data) -headers $headers -serviceAlias $serviceAlias]
unset token
}
http -
https {
if {[llength $headers]} {
set token [::http::geturl $url -headers $headers]
} else {
set token [::http::geturl $url]
}
::http::wait $token
set wsdlInfo [ParseWsdl [::http::data $token] -headers $headers -serviceAlias $serviceAlias]
::http::cleanup $token
}
default {
return \
-code error \
-errorcode [list WS CLIENT UNKURLTYP $url] \
"Unknown URL type '$url'"
}
}
set currentBaseUrl {}
return $wsdlInfo
}
###########################################################################
#
# 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
#
# 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.
#
# 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
#
#
###########################################################################
proc ::WS::Client::ParseWsdl {wsdlXML args} {
variable serviceArr
array set defaults {
-createStubs 0
-headers {}
-serviceAlias {}
}
array set defaults $args
dom parse $wsdlXML tmpdoc
$tmpdoc xslt $::WS::Utils::xsltSchemaDom wsdlDoc
$tmpdoc delete
$wsdlDoc documentElement wsdlNode
set nsCount 1
set targetNs [$wsdlNode getAttribute targetNamespace]
dict set nsDict url $targetNs tns$nsCount
foreach itemList [$wsdlNode attributes xmlns:*] {
set ns [lindex $itemList 0]
set url [$wsdlNode 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
}
dict set nsDict tns $ns $tns
}
$wsdlDoc selectNodesNamespaces {
w http://schemas.xmlsoap.org/wsdl/
d http://schemas.xmlsoap.org/wsdl/soap/
xs http://www.w3.org/2001/XMLSchema
}
if {[string length $defaults(-serviceAlias)]} {
set serviceAlias $defaults(-serviceAlias)
} else {
set serviceAlias {}
}
set serviceInfo {}
foreach serviceInfo [buildServiceInfo $wsdlNode $nsDict $serviceInfo $serviceAlias] {
set serviceName [dict get $serviceInfo name]
if {[llength $defaults(-headers)]} {
dict set serviceInfo headers $defaults(-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)} {
catch {namespace delete $serviceName}
namespace eval $serviceName {}
CreateStubs $serviceName
}
}
$wsdlDoc delete
return $serviceInfo
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::CreateStubs
#
# Description : Create stubs routines to make calls to Webservice Operations.
# All routines will be create in a namespace that is the same
# as the service name. The procedure name will be the same
# as the operation name.
#
# NOTE -- Webservice arguments are position independent, thus
# the proc arguments will be defined in alphabetical order.
#
# Arguments :
# serviceName - The service to create stubs for
#
# Returns : A string describing the created procedures.
#
# Side-Effects : Existing namespace is deleted.
#
# Exception Conditions : None
#
# 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
#
#
###########################################################################
proc ::WS::Client::CreateStubs {serviceName} {
variable serviceArr
namespace eval [format {::%s::} $serviceName] {}
if {![info exists serviceArr($serviceName)]} {
return \
-code error \
-errorcode [list WS CLIENT UNKSRV $serviceName] \
"Unknown service '$serviceName'"
}
set serviceInfo $serviceArr($serviceName)
set procList {}
foreach operationName [dict get $serviceInfo operList] {
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 {}]} {
continue
}
set headerTypeInfo [::WS::Utils::GetServiceTypeDef Client $serviceName $inputHeaderType]
set headerFields [dict keys [dict get $headerTypeInfo definition]]
if {![string equal $headerFields {}]} {
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"
set inputFields {}
}
if {![string equal $inputFields {}]} {
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]
::WS::Client::DoCall $serviceName $operationName $argList
}
proc $procName $argList $body
append procList "\n\t[list $procName $argList]"
}
return "$procList\n"
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# 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.
# 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
#
# 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
#
#
###########################################################################
proc ::WS::Client::DoRawCall {serviceName operationName argList {headers {}}} {
variable serviceArr
::log::log debug "Entering ::WS::Client::DoRawCall {$serviceName $operationName $argList}"
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'"
}
set url [dict get $serviceInfo location]
set query [buildCallquery $serviceName $operationName $url $argList]
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]
}
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
##
if {![string equal [::http::status $token] ok] || [::http::ncode $token] != 200} {
set errorCode [list WSCLIENT HTTPERROR [::http::code $token]]
set errorInfo {}
set results [::http::error $token]
set hadError 1
} else {
set hadError 0
set results [::http::data $token]
}
::http::cleanup $token
if {$hadError} {
::log::log debug "Leaving (error) ::WS::Client::DoRawCall"
return \
-code error \
-errorcode $errorCode \
-errorinfo $errorInfo \
$results
} else {
::log::log debug "Leaving ::WS::Client::DoRawCall 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::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
# 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
# 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
#
#
###########################################################################
proc ::WS::Client::DoCall {serviceName operationName argList {headers {}}} {
variable serviceArr
::log::log debug "Entering ::WS::Client::DoCall {$serviceName $operationName $argList}"
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'"
}
set url [dict get $serviceInfo location]
set query [buildCallquery $serviceName $operationName $url $argList]
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]
}
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]
} else {
::log::log debug [list ::http::geturl $url -query $query -type text/xml]
set token [::http::geturl $url -query $query -type text/xml]
}
::http::wait $token
##
## Check for errors
##
set httpStatus [::http::status $token]
if {{![string equal $httpStatus ok] && [::http::ncode $token] == 500} {
set body [::http::data $token]
::log::log debug "\tReceived: $body"
set outTransform [dict get $serviceInfo outTransform]
if {![string equal $outTransform {}]} {
set body [$outTransform $serviceName $operationName REPLY $body]
}
set hadError [catch {parseResults $serviceName $operationName $body} results]
if {$hadError} {
lassign $::errorCode mainError subError
if {[string equal $mainError WSCLIENT] && [string equal $subError NOSOAP]} {
::log::log debug "\tHTTP error $body"
set results $body
set errorCode [list WSCLIENT HTTPERROR $body]
set errorInfo {}
set hadError 1
} else {
::log::log debug "Reply was $body"
set errorCode $::errorCode
set errorInfo $::errorInfo
}
}
} elseif {![string equal $httpStatus ok] || [::http::ncode $token] != 200} {
::log::log debug "\tHTTP error [array get $token]"
set results [::http::error $token]
set errorCode [list WSCLIENT HTTPERROR [::http::code $token]]
set errorInfo {}
set hadError 1
} else {
set body [::http::data $token]
::log::log debug "\tReceived: $body"
set outTransform [dict get $serviceInfo outTransform]
if {![string equal $outTransform {}]} {
set body [$outTransform $serviceName $operationName REPLY $body]
}
set hadError [catch {parseResults $serviceName $operationName $body} results]
if {$hadError} {
::log::log 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}"
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::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
# 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.
# errorCmd - A command prefix to be called if the operations
# raises an error. The error code and stack trace
# are concatinated 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
# 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
#
#
###########################################################################
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]"
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]
set query [buildCallquery $serviceName $operationName $url $argList]
if {[llength $headers]} {
::http::geturl $url \
-query $query \
-type text/xml \
-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;
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::List
#
# Description : List a Webservice's Operations.
#
# NOTE -- Webservice arguments are position independent, thus
# the proc arguments will be defined in alphabetical order.
#
# Arguments :
# serviceName - The service to create stubs for
#
# Returns : A string describing the operations.
#
# Side-Effects : Existing namespace is deleted.
#
# Exception Conditions : None
#
# 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 10/11/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::List {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 procList {}
foreach operationName [dict get $serviceInfo operList] {
set procName $operationName
set argList {}
foreach inputHeaderTypeItem [dict get $serviceInfo operation $operationName soapRequestHeader] {
set inputHeaderType [lindex $inputHeaderTypeItem 0]
if {[string equal $inputHeaderType {}]} {
continue
}
set headerTypeInfo [::WS::Utils::GetServiceTypeDef Client $serviceName $inputHeaderType]
set headerFields [dict keys [dict get $headerTypeInfo definition]]
if {![string equal $headerFields {}]} {
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 {}]} {
lappend argList [lsort -dictionary $inputFields]
}
set argList [join $argList]
append procList "\n\t$procName $argList"
}
return "$procList\n"
}
###########################################################################
#
# Public Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PUBLIC<<
#
# Procedure Name : ::WS::Client::ListRest
#
# Description : List a Webservice's Operations.
#
# NOTE -- Webservice arguments are position independent, thus
# the proc arguments will be defined in alphabetical order.
#
# Arguments :
# serviceName - The service to create stubs for
#
# Returns : A string describing the operations.
#
# Side-Effects : Existing namespace is deleted.
#
# Exception Conditions : None
#
# 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 10/11/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::ListRest {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 procList {}
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 {}]} {
continue
}
set headerTypeInfo [::WS::Utils::GetServiceTypeDef Client $serviceName $inputHeaderType]
set headerFields [dict keys [dict get $headerTypeInfo definition]]
if {![string equal $headerFields {}]} {
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 {}]} {
lappend argList [lsort -dictionary $inputFields]
}
set argList [join $argList]
append procList "\n\t$object $procName $argList"
}
}
return "$procList\n"
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Client::asyncCallDone
#
# Description : Called when an asynchronous call is complete. This routine
# will call either the success or error callback depending on
# if the operation succeeded or failed -- assuming the callback
# is defined.
#
# Arguments :
# serviceName - the name of the service called
# operationName - the name of the operation called
# succesCmd - the command prefix to call if no error
# errorCmd - the command prefix to call on an error
# token - the token from the HTTP request
#
# 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 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}"
##
## Check for errors
##
if {![string equal [::http::status $token] ok] || [::http::ncode $token] != 200} {
set errorCode [list WSCLIENT HTTPERROR [::http::code $token]]
set hadError 1
set errorInfo [::http::error $token]
} else {
set body [::http::data $token]
set hadError [catch {parseResults $serviceName $operationName $body} results]
if {$hadError} {
set errorCode $::errorCode
set errorInfo $::errorInfo
}
}
##
## Call the appropriate callback
##
if {$hadError} {
set cmd $errorCmd
lappend cmd $errorCode $errorInfo
} else {
set cmd $succesCmd
}
lappend cmd $results
catch $cmd
##
## All done
##
::http::cleanup $token
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::parseResults
#
# Description : Convert the returned XML into a dictionary object
#
# Arguments :
# serviceName - the name of the service called
# operationName - the name of the operation called
# 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
# 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
# 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
#
#
###########################################################################
proc ::WS::Client::parseResults {serviceName operationName inXML} {
variable serviceArr
::log::log debug "In parseResults $serviceName $operationName {$inXML}"
set serviceInfo $serviceArr($serviceName)
set expectedMsgType [dict get $serviceInfo operation $operationName outputs]
set expectedMsgTypeBase [lindex [split $expectedMsgType {:}] end]
dom parse $inXML doc
$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]
}
::log::log debug "Using namespaces {$xns}"
$doc selectNodesNamespaces $xns
set body [$top selectNodes ENV:Body]
##
## Validated that we have a SOAP mes
##
if {![llength $body]} {
$doc delete
return \
-code error \
-errorcode [list WSCLIENT NOSOAP $inXML] \
"Did not receive a SOAP message"
}
set rootNode [$body childNodes]
::log::log debug "Have [llength $rootNode]"
if {[llength $rootNode] > 1} {
foreach tmp $rootNode {
#puts "\t Got {[$tmp localName]} looking for {$expectedMsgTypeBase}"
if {[string equal [$tmp localName] $expectedMsgTypeBase] ||
[string equal [$tmp nodeName] $expectedMsgTypeBase] ||
[string equal [$tmp localName] Fault] ||
[string equal [$tmp nodeName] Fault]} {
set rootNode $tmp
break
}
}
}
if {([llength $rootNode] == 1) && ![string equal $rootNode {}]} {
set rootName [$rootNode localName]
if {[string equal $rootName {}]} {
set rootName [$rootNode nodeName]
}
} else {
set rootName {}
}
::log::log debug "root name is {$rootName}"
##
## See if it is a standard error packet
##
if {[string equal $rootName {Fault}]} {
set faultcode {}
set faultstring {}
set detail {}
foreach item {faultcode faultstring detail} {
set tmpNode [$rootNode selectNodes ENV:$item]
if {[string equal $tmpNode {}]} {
set tmpNode [$rootNode selectNodes $item]
}
if {![string equal $tmpNode {}]} {
if {[$tmpNode hasAttribute href]} {
set tmpNode [GetReferenceNode $top [$tmpNode getAttribute href]]
}
set $item [$tmpNode asText]
}
}
$doc delete
return \
-code error \
-errorcode [list WSCLIENT REMERR $faultcode] \
-errorinfo $detail \
$faultstring
}
##
## Validated that it is the expected packet type
##
if {![string equal $rootName $expectedMsgTypeBase]} {
$doc delete
return \
-code error \
-errorcode [list WSCLIENT BADREPLY [list $rootName $expectedMsgTypeBase]] \
"Bad reply type, received '$rootName; but expected '$expectedMsgTypeBase'."
}
##
## Convert the packet to a dictionary
##
set results {}
set headerRootNode [$top selectNodes ENV:Header]
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
}
::log::log debug "Calling [list ::WS::Utils::convertTypeToDict Client $serviceName $node $outHeaderType $headerRootNode]"
lappend results [::WS::Utils::convertTypeToDict Client $serviceName $node $outHeaderType $headerRootNode]
}
::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]
}
set results [join $results]
$doc delete
set ::errorCode {}
set ::errorInfo {}
return $results
}
###########################################################################
#
# Private Procedure Header - as this procedure is modified, please be sure
# that you update this header block. Thanks.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Client::buildCallquery
#
# Description : Build the XML request message for the call
#
# Arguments :
# serviceName - the name of the service called
# operationName - the name of the operation called
# url - the URL of the operation
# argList - a dictionary object of the calling arguments
#
# Returns : The XML for the call
#
# 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 07/06/2006 G.Lester Initial version
#
#
###########################################################################
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]
if {$suppressTargetNS} {
::WS::Utils::SetOption suppressNS tns1
} else {
::WS::Utils::SetOption suppressNS {}
}
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 {}
set inTransform [dict get $serviceInfo inTransform]
if {![string equal $inTransform {}]} {
set query [$inTransform $serviceName $operationName REQUEST $xml $url $argList]
}
::log::log debug "Leaving ::::WS::Client::buildCallquery with {$xml}"
return $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::buildDocLiteralCallquery
#
# Description : Build the XML request message for the call
#
# Arguments :
# serviceName - the name of the service called
# operationName - the name of the operation called
# url - the URL of the operation
# argList - a dictionary object of the calling arguments
# This is for both the Soap Header and Body messages.
#
# Returns : The XML for the call
#
# 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 07/06/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::buildDocLiteralCallquery {serviceName operationName url argList} {
variable serviceArr
::log::log 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]
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]
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 {}]} {
continue
}
set xns [dict get [::WS::Utils::GetServiceTypeDef Client $serviceName $inputHeaderType] xns]
if {[info exists tnsArray($xns)]} {
set xns $tnsArray($xns)
}
if {$firstHeader} {
$env appendChild [$doc createElement "SOAP-ENV:Header" header]
set firstHeader 0
}
$header appendChild [$doc createElement $xns:$inputHeaderType headerData]
if {[llength $attrList]} {
::WS::Utils::setAttr $headerData $attrList
}
::WS::Utils::convertDictToType Client $serviceName $doc $headerData $argList $inputHeaderType
}
$env appendChild [$doc createElement "SOAP-ENV:Body" bod]
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]
}
if {[dict get $serviceInfo skipLevelWhenActionPresent] && [dict exists $serviceInfo operation $operationName action]} {
set reply $bod
} else {
::log::log debug [list $bod appendChild \[$doc createElement $xns:$msgType reply\]]
$bod appendChild [$doc createElement $xns:$msgType reply]
}
::WS::Utils::convertDictToType Client $serviceName $doc $reply $argList $xns:$msgType
append xml \
{<?xml version="1.0" encoding="utf-8"?>} \
"\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}"
return $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::buildRpcEncodedCallquery
#
# Description : Build the XML request message for the call
#
# Arguments :
# serviceName - the name of the service called
# operationName - the name of the operation called
# url - the URL of the operation
# argList - a dictionary object of the calling arguments
# This is for both the Soap Header and Body messages.
#
# Returns : The XML for the call
#
# 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 07/06/2006 G.Lester Initial version
#
#
###########################################################################
proc ::WS::Client::buildRpcEncodedCallquery {serviceName operationName url argList} {
variable serviceArr
::log::log 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]
set target [lindex $xns 1]
puts stdout [list $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 {}]} {
continue
}
set xns [dict get [::WS::Utils::GetServiceTypeDef Client $serviceName $inputHeaderType] xns]
if {$firstHeader} {
$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 callXns [dict get $serviceInfo operation $operationName xns]
if {![string is space $callXns]} {
$bod appendChild [$doc createElement $callXns:$operationName reply]
} else {
$bod appendChild [$doc createElement $operationName 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"?>} \
"\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}"
return $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.
# serviceAlias - Alias (unique) name for service.
# This is an optional argument and defaults to the name of the
# service in serviceInfo.
#
# 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
#
#
###########################################################################
proc ::WS::Client::buildServiceInfo {wsdlNode tnsDict {serviceInfo {}} {serviceAlias {}}} {
##
## 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"
##
## Parse Service information
##
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} {
return \
-code error \
-errorcode [list WS CLIENT NOSVC] \
"WSDL does not define any services"
}
foreach serviceNode $serviceNameList {
lappend serviceInfo [parseService $wsdlNode $serviceNode $serviceAlias $tnsDict]
}
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
#
# 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
#
#
###########################################################################
proc ::WS::Client::parseService {wsdlNode serviceNode serviceAlias tnsDict} {
variable serviceArr
variable options
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} {
set addressNode [lindex $addressNodeList 0]
set portNode [$addressNode parentNode]
set location [$addressNode getAttribute location]
} else {
foreach addressNode $addressNodeList {
set portNode [$addressNode parentNode]
if {[$addressNode hasAttribute location]} {
set location [$addressNode getAttribute location]
break
}
}
}
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]
}
CreateService $serviceName WSDL $location 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)
set serviceArr($serviceName) $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::parseTypes
#
# Description : Parse the types for a service from a WSDL into
# our internal representation
#
# Arguments :
# wsdlNode - The top node of the WSDL
# serviceNode - The DOM node for the service.
# serviceInfoVar - The name of the dictionary containing the partially
# parsed service.
#
# Returns : Nothing
#
# 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
#
#
###########################################################################
proc ::WS::Client::parseTypes {wsdlNode serviceName serviceInfoVar} {
::log:::log debug "Entering [info level 0]"
upvar 1 $serviceInfoVar serviceInfo
set tnsCount [llength [dict keys [dict get $serviceInfo tnsList url]]]
set baseUrl [dict get $serviceInfo location]
foreach schemaNode [$wsdlNode selectNodes w:types/xs:schema] {
::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.
#
#>>BEGIN PRIVATE<<
#
# Procedure Name : ::WS::Client::parseBinding
#
# Description : Parse the bindings for a service from a WSDL into our
# internal representation
#
# Arguments :
# wsdlNode - The top node of the WSDL
# serviceName - The name service.
# bindingName - The name binding we are to parse.
# serviceInfoVar - The name of the dictionary containing the partially
# parsed service.
#
# Returns : Nothing
#
# 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
#
#
###########################################################################
proc ::WS::Client::parseBinding {wsdlNode serviceName bindingName serviceInfoVar} {
::log:::log debug "Entering [info level 0]"
upvar 1 $serviceInfoVar serviceInfo
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 {}]} {
##
## 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])} {
::log:::log debug "Leaving [lindex [info level 0] 0] with error @1"
return \
-code error \
-errorcode [list WSCLIENT 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])} {
::log:::log debug "Leaving [lindex [info level 0] 0] with error @2"
return \
-code error \
-errorcode [list WSCLIENT UNSMODE $use] \
"Unsupported mode: $style/$use"
}
}
}
##
## Process each operation
##
foreach oper $operList {
set operName [$oper getAttribute name]
::log:::log debug "\t Processing operation '$operName'"
dict lappend serviceInfo operList $operName
#puts "Processing operation $operName"
set actionNode [$oper selectNodes d:operation]
if {[string equal $actionNode {}]} {
::log:::log debug "Skiping operation with no action [$oper asXML]"
continue
}
dict set serviceInfo operation $operName style $style/$use
catch {
set action [$actionNode getAttribute soapAction]
dict set serviceInfo operation $operName action $action
}
##
## 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]} {
::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!'"
}
set msgName [$inHeader getAttribute message]
::log:::log debug [list messageToType $wsdlNode $serviceName $operName $msgName serviceInfo]
set type [messageToType $wsdlNode $serviceName $operName $msgName serviceInfo]
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]} {
::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!'"
}
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]
lappend soapReplyHeaderList $type
}
dict set serviceInfo operation $operName soapReplyHeader $soapReplyHeaderList
##
## Validate that the input and output uses
##
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]} {
::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!'"
}
}
set typeList [getTypesForPort $wsdlNode $serviceName $operName $portName serviceInfo]
::log:::log debug "\t Messages are {$typeList}"
foreach type $typeList mode {inputs outputs} {
dict set serviceInfo operation $operName $mode $type
}
##
## Handle target namespace defined at WSDL level for older RPC/Encoded
##
if {![dict exists $serviceInfo targetNamespace]} {
catch {
#puts "attempting to get tragetNamespace"
dict set serviceInfo targetNamespace tns1 [[$oper selectNodes w:input/d:body] getAttribute namespace]
}
}
set xns tns1
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.
# serviceInfoVar - The name of the dictionary containing the partially
# parsed service.
#
# Returns : A list containing the input and output types
#
# 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
#
#
###########################################################################
proc ::WS::Client::getTypesForPort {wsdlNode serviceName operName portName serviceInfoVar} {
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 inputMsg [lindex [split $inputMsgPath {:}] end]
set inType [messageToType $wsdlNode $serviceName $operName $inputMsg serviceInfo]
}
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]
}
##
## Return the types
##
return [list $inType $outType]
}
###########################################################################
#
# 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.
#
# Returns : The requested type name
#
# 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
#
#
###########################################################################
proc ::WS::Client::messageToType {wsdlNode serviceName operName msgName serviceInfoVar} {
upvar 1 $serviceInfoVar serviceInfo
#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]
switch -exact -- $style {
document/literal {
set partNode [$msg selectNodes w:part]
set partNodeCount [llength $partNode]
if {$partNodeCount == 1} {
if {[$partNode hasAttribute element]} {
set type [::WS::Utils::getQualifiedType $serviceInfo [$partNode getAttribute element] tns1]
}
}
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 [$part getAttribute type]
} else {
set partType [$part getAttribute element]
}
lappend tmpType $partName [list type [::WS::Utils::getQualifiedType $serviceInfo $partType tns1] comment {}]
}
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 [$part getAttribute type]
} else {
set partType [$part getAttribute element]
}
lappend tmpType $partName [list type [::WS::Utils::getQualifiedType $serviceInfo $partType tns1] comment {}]
}
set type tns1:$msgName
dict set serviceInfo types $type $tmpType
::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"
}
}
##
## Return the type name
##
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.
# 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
#
# 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
#
#
###########################################################################
proc ::WS::Client::DoRawRestCall {serviceName objectName operationName argList {headers {}} {location {}}} {
variable serviceArr
::log::log 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 {}]} {
set url $location
} else {
set url [dict get $serviceInfo object $objectName location]
}
set query [buildRestCallquery $serviceName $objectName $operationName $url $argList]
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
##
if {![string equal [::http::status $token] ok] || [::http::ncode $token] != 200} {
set errorCode [list WSCLIENT HTTPERROR [::http::code $token]]
set errorInfo {}
set results [::http::error $token]
set hadError 1
} else {
set hadError 0
set results [::http::data $token]
}
::http::cleanup $token
if {$hadError} {
::log::log debug "Leaving (error) ::WS::Client::DoRawRestCall"
return \
-code error \
-errorcode $errorCode \
-errorinfo $errorInfo \
$results
} else {
::log::log debug "Leaving ::WS::Client::DoRawRestCall 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::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
# 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
# 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
#
#
###########################################################################
proc ::WS::Client::DoRestCall {serviceName objectName operationName argList {headers {}} {location {}}} {
variable serviceArr
::log::log 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 {}]} {
set url $location
} else {
set url [dict get $serviceInfo object $objectName location]
}
set query [buildRestCallquery $serviceName $objectName $operationName $url $argList]
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
##
set httpStatus [::http::status $token]
set hadError 0
set results {}
if {![string equal $httpStatus ok] || [::http::ncode $token] != 200} {
::log::log debug "\tHTTP error [array get $token]"
set results [::http::error $token]
set errorCode [list WSCLIENT HTTPERROR [::http::code $token]]
set errorInfo {}
set hadError 1
} else {
set body [::http::data $token]
::log::log debug "\tReceived: $body"
set hadError [catch {parseRestResults $serviceName $objectName $operationName $body} results]
if {$hadError} {
::log::log debug "Reply was [::http::data $token]"
set errorCode $::errorCode
set errorInfo $::errorInfo
}
}
::http::cleanup $token
if {$hadError} {
::log::log debug "Leaving (error) ::WS::Client::DoRestCall"
return \
-code error \
-errorcode $errorCode \
-errorinfo $errorInfo \
$results
} else {
::log::log 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
# 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.
# errorCmd - A command prefix to be called if the operations
# raises an error. The error code and stack trace
# are concatinated 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
# 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
#
#
###########################################################################
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
}
::log::log debug "Entering ::WS::Client::DoAsyncRestCall [list $serviceName $objectName $operationName $argList $succesCmd $errorCmd $headers]"
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]
set query [buildRestCallquery $serviceName $objectName $operationName $url $argList]
if {[llength $headers]} {
::http::geturl $url \
-query $query \
-type text/xml \
-headers $headers \
-command [list ::WS::Client::asyncRestCallDone $serviceName $operationName $succesCmd $errorCmd]
} else {
::http::geturl $url \
-query $query \
-type text/xml \
-command [list ::WS::Client::asyncRestCallDone $serviceName $operationName $succesCmd $errorCmd]
}
::log::log debug "Leaving ::WS::Client::DoAsyncRestCall"
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::buildRestCallquery
#
# Description : Build the XML request message for the call
#
# Arguments :
# serviceName - the name of the service called
# operationName - the name of the operation called
# url - the URL of the operation
# argList - a dictionary object of the calling arguments
# This is for both the Soap Header and Body messages.
#
# Returns : The XML for the call
#
# 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 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]"
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]
$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]"
set options [::WS::Utils::SetOption]
::WS::Utils::SetOption UseNS 0
::WS::Utils::SetOption genOutAttr 1
::WS::Utils::convertDictToType Client $serviceName $doc $body $argList $msgType
foreach {option value} $options {
::WS::Utils::SetOption $option $value
}
append xml \
{<?xml version="1.0" encoding="utf-8"?>} \
"\n" \
[$doc asXML -indent none -doctypeDeclaration 0]
#regsub "<!DOCTYPE\[^>\]*>\n" [::dom::DOMImplementation serialize $doc] {} xml
$doc delete
set inTransform [dict get $serviceInfo inTransform]
if {![string equal $inTransform {}]} {
set xml [$inTransform $serviceName $operationName REQUEST $xml $url $argList]
}
::log::log debug "Leaving ::::WS::Client::buildRestCallquery with {$xml}"
return $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::parseRestResults
#
# Description : Convert the returned XML into a dictionary object
#
# Arguments :
# serviceName - the name of the service called
# operationName - the name of the operation called
# 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
# 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
# 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
#
#
###########################################################################
proc ::WS::Client::parseRestResults {serviceName objectName operationName inXML} {
variable serviceArr
::log::log debug "In parseResults $serviceName $operationName {$inXML}"
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 object $objectName operation $operationName outputs]
dom parse $inXML doc
$doc documentElement top
set xns {}
foreach tmp [dict get $serviceInfo targetNamespace] {
lappend xns [lindex $tmp 0] [lindex $tmp 1]
}
::log::log 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}]} {
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] \
-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 {}]} {
set node [$body childNodes]
set nodeName [$node nodeName]
if {![string equal $objectName $nodeName]} {
return \
-code error \
-errorcode [list WSCLIENT 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 {
::WS::Utils::SetOption $option $value
}
$doc delete
return $results
}
###########################################################################
#
# 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 : Called when an asynchronous call is complete. This routine
# will call either the success or error callback depending on
# if the operation succeeded or failed -- assuming the callback
# is defined.
#
# Arguments :
# serviceName - the name of the service called
# operationName - the name of the operation called
# succesCmd - the command prefix to call if no error
# errorCmd - the command prefix to call on an error
# token - the token from the HTTP request
#
# 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 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}"
##
## Check for errors
##
if {![string equal [::http::status $token] ok] || [::http::ncode $token] != 200} {
set errorCode [list WSCLIENT HTTPERROR [::http::code $token]]
set hadError 1
set errorInfo [::http::error $token]
} else {
set body [::http::data $token]
set hadError [catch {parseRestResults $serviceName $objectName $operationName $body} results]
if {$hadError} {
set errorCode $::errorCode
set errorInfo $::errorInfo
}
}
##
## Call the appropriate callback
##
if {$hadError} {
set cmd $errorCmd
lappend cmd $errorCode $errorInfo
} else {
set cmd $succesCmd
}
lappend cmd $results
catch $cmd
##
## All done
##
::http::cleanup $token
return;
}
|