[r400]: branches / 0.71 / lib / SOAP / Lite.pm Maximize Restore History

Download this file

Lite.pm    5677 lines (4564 with data), 183.6 kB

   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
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
# ======================================================================
#
# Copyright (C) 2000-2005 Paul Kulchenko (paulclinger@yahoo.com)
# SOAP::Lite is free software; you can redistribute it
# and/or modify it under the same terms as Perl itself.
#
# $Id: Lite.pm 400 2012-03-10 16:45:03Z kutterma $
#
# ======================================================================
# Formatting hint:
# Target is the source code format laid out in Perl Best Practices (4 spaces
# indent, opening brace on condition line, no cuddled else).
#
# October 2007, Martin Kutter
package SOAP::Lite;
use 5.006; #weak references require perl 5.6
use strict;
our $VERSION = 0.714;
# ======================================================================
package SOAP::XMLSchemaApacheSOAP::Deserializer;
sub as_map {
my $self = shift;
return {
map {
my $hash = ($self->decode_object($_))[1];
($hash->{key} => $hash->{value})
} @{$_[3] || []}
};
}
sub as_Map; *as_Map = \&as_map;
# Thank to Kenneth Draper for this contribution
sub as_vector {
my $self = shift;
return [ map { scalar(($self->decode_object($_))[1]) } @{$_[3] || []} ];
}
sub as_Vector; *as_Vector = \&as_vector;
# ----------------------------------------------------------------------
package SOAP::XMLSchema::Serializer;
use vars qw(@ISA);
sub xmlschemaclass {
my $self = shift;
return $ISA[0] unless @_;
@ISA = (shift);
return $self;
}
# ----------------------------------------------------------------------
package SOAP::XMLSchema1999::Serializer;
use vars qw(@EXPORT $AUTOLOAD);
sub AUTOLOAD {
local($1,$2);
my($package, $method) = $AUTOLOAD =~ m/(?:(.+)::)([^:]+)$/;
return if $method eq 'DESTROY';
no strict 'refs';
my $export_var = $package . '::EXPORT';
my @export = @$export_var;
# Removed in 0.69 - this is a total hack. For some reason this is failing
# despite not being a fatal error condition.
# die "Type '$method' can't be found in a schema class '$package'\n"
# unless $method =~ s/^as_// && grep {$_ eq $method} @{$export_var};
# This was added in its place - it is still a hack, but it performs the
# necessary substitution. It just does not die.
if ($method =~ s/^as_// && grep {$_ eq $method} @{$export_var}) {
# print STDERR "method is now '$method'\n";
} else {
return;
}
$method =~ s/_/-/; # fix ur-type
*$AUTOLOAD = sub {
my $self = shift;
my($value, $name, $type, $attr) = @_;
return [$name, {'xsi:type' => "xsd:$method", %$attr}, $value];
};
goto &$AUTOLOAD;
}
BEGIN {
@EXPORT = qw(ur_type
float double decimal timeDuration recurringDuration uriReference
integer nonPositiveInteger negativeInteger long int short byte
nonNegativeInteger unsignedLong unsignedInt unsignedShort unsignedByte
positiveInteger timeInstant time timePeriod date month year century
recurringDate recurringDay language
base64 hex string boolean
);
# TODO: replace by symbol table operations...
# predeclare subs, so ->can check will be positive
foreach (@EXPORT) { eval "sub as_$_" }
}
sub nilValue { 'null' }
sub anyTypeValue { 'ur-type' }
sub as_base64 {
my ($self, $value, $name, $type, $attr) = @_;
# Fixes #30271 for 5.8 and above.
# Won't fix for 5.6 and below - perl can't handle unicode before
# 5.8, and applying pack() to everything is just a slowdown.
if (eval "require Encode; 1") {
if (Encode::is_utf8($value)) {
if (Encode->can('_utf8_off')) { # the quick way, but it may change in future Perl versions.
Encode::_utf8_off($value);
}
else {
$value = pack('C*',unpack('C*',$value)); # the slow but safe way,
# but this fallback works always.
}
}
}
require MIME::Base64;
return [
$name,
{
'xsi:type' => SOAP::Utils::qualify($self->encprefix => 'base64'),
%$attr
},
MIME::Base64::encode_base64($value,'')
];
}
sub as_hex {
my ($self, $value, $name, $type, $attr) = @_;
return [
$name,
{
'xsi:type' => 'xsd:hex', %$attr
},
join '', map {
uc sprintf "%02x", ord
} split '', $value
];
}
sub as_long {
my($self, $value, $name, $type, $attr) = @_;
return [
$name,
{'xsi:type' => 'xsd:long', %$attr},
$value
];
}
sub as_dateTime {
my ($self, $value, $name, $type, $attr) = @_;
return [$name, {'xsi:type' => 'xsd:dateTime', %$attr}, $value];
}
sub as_string {
my ($self, $value, $name, $type, $attr) = @_;
die "String value expected instead of @{[ref $value]} reference\n"
if ref $value;
return [
$name,
{'xsi:type' => 'xsd:string', %$attr},
SOAP::Utils::encode_data($value)
];
}
sub as_anyURI {
my($self, $value, $name, $type, $attr) = @_;
die "String value expected instead of @{[ref $value]} reference\n" if ref $value;
return [
$name,
{'xsi:type' => 'xsd:anyURI', %$attr},
SOAP::Utils::encode_data($value)
];
}
sub as_undef { $_[1] ? '1' : '0' }
sub as_boolean {
my $self = shift;
my($value, $name, $type, $attr) = @_;
# fix [ 1204279 ] Boolean serialization error
return [
$name,
{'xsi:type' => 'xsd:boolean', %$attr},
( $value && $value ne 'false' ) ? 'true' : 'false'
];
}
sub as_float {
my($self, $value, $name, $type, $attr) = @_;
return [
$name,
{'xsi:type' => 'xsd:float', %$attr},
$value
];
}
# ----------------------------------------------------------------------
package SOAP::XMLSchema2001::Serializer;
use vars qw(@EXPORT);
# no more warnings about "used only once"
*AUTOLOAD if 0;
*AUTOLOAD = \&SOAP::XMLSchema1999::Serializer::AUTOLOAD;
BEGIN {
@EXPORT = qw(anyType anySimpleType float double decimal dateTime
timePeriod gMonth gYearMonth gYear century
gMonthDay gDay duration recurringDuration anyURI
language integer nonPositiveInteger negativeInteger
long int short byte nonNegativeInteger unsignedLong
unsignedInt unsignedShort unsignedByte positiveInteger
date time string hex base64 boolean
QName
);
# Add QName to @EXPORT
# predeclare subs, so ->can check will be positive
foreach (@EXPORT) { eval "sub as_$_" }
}
sub nilValue { 'nil' }
sub anyTypeValue { 'anyType' }
sub as_long; *as_long = \&SOAP::XMLSchema1999::Serializer::as_long;
sub as_float; *as_float = \&SOAP::XMLSchema1999::Serializer::as_float;
sub as_string; *as_string = \&SOAP::XMLSchema1999::Serializer::as_string;
sub as_anyURI; *as_anyURI = \&SOAP::XMLSchema1999::Serializer::as_anyURI;
# TODO - QNames still don't work for 2001 schema!
sub as_QName; *as_QName = \&SOAP::XMLSchema1999::Serializer::as_string;
sub as_hex; *as_hex = \&as_hexBinary;
sub as_base64; *as_base64 = \&as_base64Binary;
sub as_timeInstant; *as_timeInstant = \&as_dateTime;
# only 0 and 1 allowed - that's easy...
sub as_undef {
$_[1]
? 'true'
: 'false'
}
sub as_hexBinary {
my ($self, $value, $name, $type, $attr) = @_;
return [
$name,
{'xsi:type' => 'xsd:hexBinary', %$attr},
join '', map {
uc sprintf "%02x", ord
} split '', $value
];
}
sub as_base64Binary {
my ($self, $value, $name, $type, $attr) = @_;
# Fixes #30271 for 5.8 and above.
# Won't fix for 5.6 and below - perl can't handle unicode before
# 5.8, and applying pack() to everything is just a slowdown.
if (eval "require Encode; 1") {
if (Encode::is_utf8($value)) {
if (Encode->can('_utf8_off')) { # the quick way, but it may change in future Perl versions.
Encode::_utf8_off($value);
}
else {
$value = pack('C*',unpack('C*',$value)); # the slow but safe way,
# but this fallback works always.
}
}
}
require MIME::Base64;
return [
$name,
{
'xsi:type' => 'xsd:base64Binary', %$attr
},
MIME::Base64::encode_base64($value,'')
];
}
sub as_boolean {
my ($self, $value, $name, $type, $attr) = @_;
# fix [ 1204279 ] Boolean serialization error
return [
$name,
{
'xsi:type' => 'xsd:boolean', %$attr
},
( $value && ($value ne 'false') )
? 'true'
: 'false'
];
}
# ======================================================================
package SOAP::Utils;
sub qualify {
$_[1]
? $_[1] =~ /:/
? $_[1]
: join(':', $_[0] || (), $_[1])
: defined $_[1]
? $_[0]
: ''
}
sub overqualify (&$) {
for ($_[1]) {
&{$_[0]};
s/^:|:$//g
}
}
sub disqualify {
(my $qname = shift) =~ s/^($SOAP::Constants::NSMASK?)://;
return $qname;
}
sub splitqname {
local($1,$2);
$_[0] =~ /^(?:([^:]+):)?(.+)$/;
return ($1,$2)
}
sub longname {
defined $_[0]
? sprintf('{%s}%s', $_[0], $_[1])
: $_[1]
}
sub splitlongname {
local($1,$2);
$_[0] =~ /^(?:\{(.*)\})?(.+)$/;
return ($1,$2)
}
# Q: why only '&' and '<' are encoded, but not '>'?
# A: because it is not required according to XML spec.
#
# [http://www.w3.org/TR/REC-xml#syntax]
# The ampersand character (&) and the left angle bracket (<) may appear in
# their literal form only when used as markup delimiters, or within a comment,
# a processing instruction, or a CDATA section. If they are needed elsewhere,
# they must be escaped using either numeric character references or the
# strings "&amp;" and "&lt;" respectively. The right angle bracket (>) may be
# represented using the string "&gt;", and must, for compatibility, be
# escaped using "&gt;" or a character reference when it appears in the
# string "]]>" in content, when that string is not marking the end of a
# CDATA section.
my %encode_attribute = ('&' => '&amp;', '>' => '&gt;', '<' => '&lt;', '"' => '&quot;');
sub encode_attribute { (my $e = $_[0]) =~ s/([&<>\"])/$encode_attribute{$1}/g; $e }
my %encode_data = ('&' => '&amp;', '>' => '&gt;', '<' => '&lt;', "\xd" => '&#xd;');
sub encode_data {
my $e = $_[0];
if ($e) {
$e =~ s/([&<>\015])/$encode_data{$1}/g;
$e =~ s/\]\]>/\]\]&gt;/g;
}
$e
}
# methods for internal tree (SOAP::Deserializer, SOAP::SOM and SOAP::Serializer)
sub o_qname { $_[0]->[0] }
sub o_attr { $_[0]->[1] }
sub o_child { ref $_[0]->[2] ? $_[0]->[2] : undef }
sub o_chars { ref $_[0]->[2] ? undef : $_[0]->[2] }
# $_[0]->[3] is not used. Serializer stores object ID there
sub o_value { $_[0]->[4] }
sub o_lname { $_[0]->[5] }
sub o_lattr { $_[0]->[6] }
sub format_datetime {
my ($s,$m,$h,$D,$M,$Y) = (@_)[0,1,2,3,4,5];
my $time = sprintf("%04d-%02d-%02dT%02d:%02d:%02d",($Y+1900),($M+1),$D,$h,$m,$s);
return $time;
}
# make bytelength that calculates length in bytes regardless of utf/byte settings
# either we can do 'use bytes' or length will count bytes already
BEGIN {
sub bytelength;
*bytelength = eval('use bytes; 1') # 5.6.0 and later?
? sub { use bytes; length(@_ ? $_[0] : $_) }
: sub { length(@_ ? $_[0] : $_) };
}
# ======================================================================
package SOAP::Cloneable;
sub clone {
my $self = shift;
return unless ref $self && UNIVERSAL::isa($self => __PACKAGE__);
my $clone = bless {} => ref($self) || $self;
for (keys %$self) {
my $value = $self->{$_};
$clone->{$_} = ref $value && UNIVERSAL::isa($value => __PACKAGE__) ? $value->clone : $value;
}
return $clone;
}
# ======================================================================
package SOAP::Transport;
use vars qw($AUTOLOAD @ISA);
@ISA = qw(SOAP::Cloneable);
use Class::Inspector;
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
return $self if ref $self;
my $class = ref($self) || $self;
SOAP::Trace::objects('()');
return bless {} => $class;
}
sub proxy {
my $self = shift;
$self = $self->new() if not ref $self;
my $class = ref $self;
return $self->{_proxy} unless @_;
$_[0] =~ /^(\w+):/ or die "proxy: transport protocol not specified\n";
my $protocol = uc "$1"; # untainted now
# HTTPS is handled by HTTP class
$protocol =~s/^HTTPS$/HTTP/;
(my $protocol_class = "${class}::$protocol") =~ s/-/_/g;
no strict 'refs';
unless (Class::Inspector->loaded("$protocol_class\::Client")
&& UNIVERSAL::can("$protocol_class\::Client" => 'new')
) {
eval "require $protocol_class";
die "Unsupported protocol '$protocol'\n"
if $@ =~ m!^Can\'t locate SOAP/Transport/!;
die if $@;
}
$protocol_class .= "::Client";
return $self->{_proxy} = $protocol_class->new(endpoint => shift, @_);
}
sub AUTOLOAD {
my $method = substr($AUTOLOAD, rindex($AUTOLOAD, '::') + 2);
return if $method eq 'DESTROY';
no strict 'refs';
*$AUTOLOAD = sub { shift->proxy->$method(@_) };
goto &$AUTOLOAD;
}
# ======================================================================
package SOAP::Fault;
use Carp ();
use overload fallback => 1, '""' => "stringify";
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
unless (ref $self) {
my $class = $self;
$self = bless {} => $class;
SOAP::Trace::objects('()');
}
Carp::carp "Odd (wrong?) number of parameters in new()"
if $^W && (@_ & 1);
no strict qw(refs);
while (@_) {
my $method = shift;
$self->$method(shift)
if $self->can($method)
}
return $self;
}
sub stringify {
my $self = shift;
return join ': ', $self->faultcode, $self->faultstring;
}
sub BEGIN {
no strict 'refs';
for my $method (qw(faultcode faultstring faultactor faultdetail)) {
my $field = '_' . $method;
*$method = sub {
my $self = UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new
: __PACKAGE__->new;
if (@_) {
$self->{$field} = shift;
return $self
}
return $self->{$field};
}
}
*detail = \&faultdetail;
}
# ======================================================================
package SOAP::Data;
use vars qw(@ISA @EXPORT_OK);
use Exporter;
use Carp ();
use SOAP::Lite::Deserializer::XMLSchemaSOAP1_2;
@ISA = qw(Exporter);
@EXPORT_OK = qw(name type attr value uri);
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
unless (ref $self) {
my $class = $self;
$self = bless {_attr => {}, _value => [], _signature => []} => $class;
SOAP::Trace::objects('()');
}
no strict qw(refs);
Carp::carp "Odd (wrong?) number of parameters in new()" if $^W && (@_ & 1);
while (@_) {
my $method = shift;
$self->$method(shift) if $self->can($method)
}
return $self;
}
sub name {
my $self = ref $_[0] ? shift : UNIVERSAL::isa($_[0] => __PACKAGE__) ? shift->new : __PACKAGE__->new;
if (@_) {
my $name = shift;
my ($uri, $prefix); # predeclare, because can't declare in assign
if ($name) {
($uri, $name) = SOAP::Utils::splitlongname($name);
unless (defined $uri) {
($prefix, $name) = SOAP::Utils::splitqname($name);
$self->prefix($prefix) if defined $prefix;
} else {
$self->uri($uri);
}
}
$self->{_name} = $name;
$self->value(@_) if @_;
return $self;
}
return $self->{_name};
}
sub attr {
my $self = ref $_[0]
? shift
: UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new();
if (@_) {
$self->{_attr} = shift;
return $self->value(@_) if @_;
return $self
}
return $self->{_attr};
}
sub type {
my $self = ref $_[0]
? shift
: UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new();
if (@_) {
$self->{_type} = shift;
$self->value(@_) if @_;
return $self;
}
if (!defined $self->{_type} && (my @types = grep {/^\{$SOAP::Constants::NS_XSI_ALL}type$/o} keys %{$self->{_attr}})) {
$self->{_type} = (SOAP::Utils::splitlongname(delete $self->{_attr}->{shift(@types)}))[1];
}
return $self->{_type};
}
BEGIN {
no strict 'refs';
for my $method (qw(root mustUnderstand)) {
my $field = '_' . $method;
*$method = sub {
my $attr = $method eq 'root'
? "{$SOAP::Constants::NS_ENC}$method"
: "{$SOAP::Constants::NS_ENV}$method";
my $self = UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new
: __PACKAGE__->new;
if (@_) {
$self->{_attr}->{$attr} = $self->{$field} = shift() ? 1 : 0;
$self->value(@_) if @_;
return $self;
}
$self->{$field} = SOAP::Lite::Deserializer::XMLSchemaSOAP1_2->as_boolean($self->{_attr}->{$attr})
if !defined $self->{$field} && defined $self->{_attr}->{$attr};
return $self->{$field};
}
}
for my $method (qw(actor encodingStyle)) {
my $field = '_' . $method;
*$method = sub {
my $attr = "{$SOAP::Constants::NS_ENV}$method";
my $self = UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new();
if (@_) {
$self->{_attr}->{$attr} = $self->{$field} = shift;
$self->value(@_) if @_;
return $self;
}
$self->{$field} = $self->{_attr}->{$attr}
if !defined $self->{$field} && defined $self->{_attr}->{$attr};
return $self->{$field};
}
}
}
sub prefix {
my $self = ref $_[0]
? shift
: UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new();
return $self->{_prefix} unless @_;
$self->{_prefix} = shift;
if (scalar @_) {
return $self->value(@_);
}
return $self;
}
sub uri {
my $self = ref $_[0]
? shift
: UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new();
return $self->{_uri} unless @_;
my $uri = $self->{_uri} = shift;
warn "Usage of '::' in URI ($uri) deprecated. Use '/' instead\n"
if defined $uri && $^W && $uri =~ /::/;
if (scalar @_) {
return $self->value(@_);
}
return $self;
}
sub set_value {
my $self = ref $_[0]
? shift
: UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new();
$self->{_value} = [@_];
return $self;
}
sub value {
my $self = ref $_[0] ? shift
: UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new;
if (@_) {
return $self->set_value(@_);
}
else {
return wantarray
? @{$self->{_value}}
: $self->{_value}->[0];
}
}
sub signature {
my $self = UNIVERSAL::isa($_[0] => __PACKAGE__)
? shift->new()
: __PACKAGE__->new();
(@_)
? ($self->{_signature} = shift, return $self)
: (return $self->{_signature});
}
# ======================================================================
package SOAP::Header;
use vars qw(@ISA);
@ISA = qw(SOAP::Data);
# ======================================================================
package SOAP::Serializer;
use SOAP::Lite::Utils;
use Carp ();
use vars qw(@ISA);
@ISA = qw(SOAP::Cloneable SOAP::XMLSchema::Serializer);
BEGIN {
# namespaces and anonymous data structures
my $ns = 0;
my $name = 0;
my $prefix = 'c-';
sub gen_ns { 'namesp' . ++$ns }
sub gen_name { join '', $prefix, 'gensym', ++$name }
sub prefix { $prefix =~ s/^[^\-]+-/$_[1]-/; $_[0]; }
}
sub BEGIN {
no strict 'refs';
__PACKAGE__->__mk_accessors(qw(readable level seen autotype attr maptype
namespaces multirefinplace encoding signature on_nonserialized context
ns_uri ns_prefix use_default_ns));
for my $method (qw(method fault freeform)) { # aliases for envelope
*$method = sub { shift->envelope($method => @_) }
}
# Is this necessary? Seems like work for nothing when a user could just use
# SOAP::Utils directly.
# for my $method (qw(qualify overqualify disqualify)) { # import from SOAP::Utils
# *$method = \&{'SOAP::Utils::'.$method};
# }
}
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
return $self if ref $self;
my $class = $self;
$self = bless {
_level => 0,
_autotype => 1,
_readable => 0,
_ns_uri => '',
_ns_prefix => '',
_use_default_ns => 1,
_multirefinplace => 0,
_seen => {},
_encoding => 'UTF-8',
_objectstack => {},
_signature => [],
_maptype => {},
_on_nonserialized => sub {Carp::carp "Cannot marshall @{[ref shift]} reference" if $^W; return},
_encodingStyle => $SOAP::Constants::NS_ENC,
_attr => {
"{$SOAP::Constants::NS_ENV}encodingStyle" => $SOAP::Constants::NS_ENC,
},
_namespaces => {},
_soapversion => SOAP::Lite->soapversion,
} => $class;
$self->typelookup({
'base64Binary' =>
[10, sub {$_[0] =~ /[^\x09\x0a\x0d\x20-\x7f]/ }, 'as_base64Binary'],
'zerostring' =>
[12, sub { $_[0] =~ /^0\d+$/ }, 'as_string'],
# int (and actually long too) are subtle: the negative range is one greater...
'int' =>
[20, sub {$_[0] =~ /^([+-]?\d+)$/ && ($1 <= 2147483647) && ($1 >= -2147483648); }, 'as_int'],
'long' =>
[25, sub {$_[0] =~ /^([+-]?\d+)$/ && $1 <= 9223372036854775807;}, 'as_long'],
'float' =>
[30, sub {$_[0] =~ /^(-?(?:\d+(?:\.\d*)?|\.\d+|NaN|INF)|([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?)$/}, 'as_float'],
'gMonth' =>
[35, sub { $_[0] =~ /^--\d\d--(-\d\d:\d\d)?$/; }, 'as_gMonth'],
'gDay' =>
[40, sub { $_[0] =~ /^---\d\d(-\d\d:\d\d)?$/; }, 'as_gDay'],
'gYear' =>
[45, sub { $_[0] =~ /^-?\d\d\d\d(-\d\d:\d\d)?$/; }, 'as_gYear'],
'gMonthDay' =>
[50, sub { $_[0] =~ /^-\d\d-\d\d(-\d\d:\d\d)?$/; }, 'as_gMonthDay'],
'gYearMonth' =>
[55, sub { $_[0] =~ /^-?\d\d\d\d-\d\d(Z|([+-]\d\d:\d\d))?$/; }, 'as_gYearMonth'],
'date' =>
[60, sub { $_[0] =~ /^-?\d\d\d\d-\d\d-\d\d(Z|([+-]\d\d:\d\d))?$/; }, 'as_date'],
'time' =>
[70, sub { $_[0] =~ /^\d\d:\d\d:\d\d(\.\d\d\d)?(Z|([+-]\d\d:\d\d))?$/; }, 'as_time'],
'dateTime' =>
[75, sub { $_[0] =~ /^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(\.\d\d\d)?(Z|([+-]\d\d:\d\d))?$/; }, 'as_dateTime'],
'duration' =>
[80, sub { $_[0] !~m{^-?PT?$} && $_[0] =~ m{^
-? # a optional - sign
P
(:? \d+Y )?
(:? \d+M )?
(:? \d+D )?
(:?
T(:?\d+H)?
(:?\d+M)?
(:?\d+S)?
)?
$
}x;
}, 'as_duration'],
'boolean' =>
[90, sub { $_[0] =~ /^(true|false)$/i; }, 'as_boolean'],
'anyURI' =>
[95, sub { $_[0] =~ /^(urn:|http:\/\/)/i; }, 'as_anyURI'],
'string' =>
[100, sub {1}, 'as_string'],
});
$self->register_ns($SOAP::Constants::NS_ENC,$SOAP::Constants::PREFIX_ENC);
$self->register_ns($SOAP::Constants::NS_ENV,$SOAP::Constants::PREFIX_ENV)
if $SOAP::Constants::PREFIX_ENV;
$self->xmlschema($SOAP::Constants::DEFAULT_XML_SCHEMA);
SOAP::Trace::objects('()');
no strict qw(refs);
Carp::carp "Odd (wrong?) number of parameters in new()" if $^W && (@_ & 1);
while (@_) { my $method = shift; $self->$method(shift) if $self->can($method) }
return $self;
}
sub typelookup {
my ($self, $lookup) = @_;
if (defined $lookup) {
$self->{ _typelookup } = $lookup;
$self->{ _typelookup_order } = [ sort { $lookup->{$a}->[0] <=> $lookup->{$b}->[0] } keys %{ $lookup } ];
return $self;
}
return $self->{ _typelookup };
}
sub ns {
my $self = shift;
$self = $self->new() if not ref $self;
if (@_) {
my ($u,$p) = @_;
my $prefix;
if ($p) {
$prefix = $p;
}
elsif (!$p && !($prefix = $self->find_prefix($u))) {
$prefix = gen_ns;
}
$self->{'_ns_uri'} = $u;
$self->{'_ns_prefix'} = $prefix;
$self->{'_use_default_ns'} = 0;
# $self->register_ns($u,$prefix);
$self->{'_namespaces'}->{$u} = $prefix;
return $self;
}
return $self->{'_ns_uri'};
}
sub default_ns {
my $self = shift;
$self = $self->new() if not ref $self;
if (@_) {
my ($u) = @_;
$self->{'_ns_uri'} = $u;
$self->{'_ns_prefix'} = '';
$self->{'_use_default_ns'} = 1;
return $self;
}
return $self->{'_ns_uri'};
}
sub use_prefix {
my $self = shift;
$self = $self->new() if not ref $self;
warn 'use_prefix has been deprecated. if you wish to turn off or on the '
. 'use of a default namespace, then please use either ns(uri) or default_ns(uri)';
if (@_) {
my $use = shift;
$self->{'_use_default_ns'} = !$use || 0;
return $self;
} else {
return $self->{'_use_default_ns'};
}
}
sub uri {
my $self = shift;
$self = $self->new() if not ref $self;
# warn 'uri has been deprecated. if you wish to set the namespace for the request, then please use either ns(uri) or default_ns(uri)';
if (@_) {
my $ns = shift;
if ($self->{_use_default_ns}) {
$self->default_ns($ns);
}
else {
$self->ns($ns);
}
# $self->{'_ns_uri'} = $ns;
# $self->register_ns($self->{'_ns_uri'}) if (!$self->{_use_default_ns});
return $self;
}
return $self->{'_ns_uri'};
}
sub encodingStyle {
my $self = shift;
$self = $self->new() if not ref $self;
return $self->{'_encodingStyle'} unless @_;
my $cur_style = $self->{'_encodingStyle'};
delete($self->{'_namespaces'}->{$cur_style});
my $new_style = shift;
if ($new_style eq "") {
delete($self->{'_attr'}->{"{$SOAP::Constants::NS_ENV}encodingStyle"});
}
else {
$self->{'_attr'}->{"{$SOAP::Constants::NS_ENV}encodingStyle"} = $new_style;
$self->{'_namespaces'}->{$new_style} = $SOAP::Constants::PREFIX_ENC;
}
}
# TODO - changing SOAP version can affect previously set encodingStyle
sub soapversion {
my $self = shift;
return $self->{_soapversion} unless @_;
return $self if $self->{_soapversion} eq SOAP::Lite->soapversion;
$self->{_soapversion} = shift;
$self->attr({
"{$SOAP::Constants::NS_ENV}encodingStyle" => $SOAP::Constants::NS_ENC,
});
$self->namespaces({
$SOAP::Constants::NS_ENC => $SOAP::Constants::PREFIX_ENC,
$SOAP::Constants::PREFIX_ENV ? ($SOAP::Constants::NS_ENV => $SOAP::Constants::PREFIX_ENV) : (),
});
$self->xmlschema($SOAP::Constants::DEFAULT_XML_SCHEMA);
return $self;
}
sub xmlschema {
my $self = shift->new;
return $self->{_xmlschema} unless @_;
my @schema;
if ($_[0]) {
@schema = grep {/XMLSchema/ && /$_[0]/} keys %SOAP::Constants::XML_SCHEMAS;
Carp::croak "More than one schema match parameter '$_[0]': @{[join ', ', @schema]}" if @schema > 1;
Carp::croak "No schema match parameter '$_[0]'" if @schema != 1;
}
# do nothing if current schema is the same as new
# return $self if $self->{_xmlschema} && $self->{_xmlschema} eq $schema[0];
my $ns = $self->namespaces;
# delete current schema from namespaces
if (my $schema = $self->{_xmlschema}) {
delete $ns->{$schema};
delete $ns->{"$schema-instance"};
}
# add new schema into namespaces
if (my $schema = $self->{_xmlschema} = shift @schema) {
$ns->{$schema} = 'xsd';
$ns->{"$schema-instance"} = 'xsi';
}
# and here is the class serializer should work with
my $class = exists $SOAP::Constants::XML_SCHEMAS{$self->{_xmlschema}}
? $SOAP::Constants::XML_SCHEMAS{$self->{_xmlschema}} . '::Serializer'
: $self;
$self->xmlschemaclass($class);
return $self;
}
sub envprefix {
my $self = shift->new();
return $self->namespaces->{$SOAP::Constants::NS_ENV} unless @_;
$self->namespaces->{$SOAP::Constants::NS_ENV} = shift;
return $self;
}
sub encprefix {
my $self = shift->new();
return $self->namespaces->{$SOAP::Constants::NS_ENC} unless @_;
$self->namespaces->{$SOAP::Constants::NS_ENC} = shift;
return $self;
}
sub gen_id { sprintf "%U", $_[1] }
sub multiref_object {
my ($self, $object) = @_;
my $id = $self->gen_id($object);
if (! exists $self->{ _seen }->{ $id }) {
$self->{ _seen }->{ $id } = {
count => 1,
multiref => 0,
value => $object,
recursive => 0
};
}
else {
my $id_seen = $self->{ _seen }->{ $id };
$id_seen->{count}++;
$id_seen->{multiref} = 1;
$id_seen->{value} = $object;
$id_seen->{recursive} ||= 0;
}
return $id;
}
sub recursive_object {
my $self = shift;
$self->seen->{$self->gen_id(shift)}->{recursive} = 1;
}
sub is_href {
my $self = shift;
my $seen = $self->seen->{shift || return} or return;
return 1 if $seen->{id};
return $seen->{multiref}
&& !($seen->{id} = (shift
|| $seen->{recursive}
|| $seen->{multiref} && $self->multirefinplace));
}
sub multiref_anchor {
my ($self, $id) = @_;
no warnings qw(uninitialized);
if ($self->{ _seen }->{ $id }->{multiref}) {
return "ref-$id"
}
else {
return undef;
}
}
sub encode_multirefs {
my $self = shift;
return if $self->multirefinplace();
my $seen = $self->seen();
map { $_->[1]->{_id} = 1; $_ }
map { $self->encode_object($seen->{$_}->{value}) }
grep { $seen->{$_}->{multiref} && !$seen->{$_}->{recursive} }
keys %$seen;
}
sub maptypetouri {
my($self, $type, $simple) = @_;
return $type unless defined $type;
my($prefix, $name) = SOAP::Utils::splitqname($type);
unless (defined $prefix) {
$name =~ s/__|\./::/g;
$self->maptype->{$name} = $simple
? die "Schema/namespace for type '$type' is not specified\n"
: $SOAP::Constants::NS_SL_PERLTYPE
unless exists $self->maptype->{$name};
$type = $self->maptype->{$name}
? SOAP::Utils::qualify($self->namespaces->{$self->maptype->{$name}} ||= gen_ns, $type)
: undef;
}
return $type;
}
sub encode_object {
my($self, $object, $name, $type, $attr) = @_;
$attr ||= {};
return $self->encode_scalar($object, $name, $type, $attr)
unless ref $object;
my $id = $self->multiref_object($object);
use vars '%objectstack'; # we'll play with symbol table
local %objectstack = %objectstack; # want to see objects ONLY in the current tree
# did we see this object in current tree? Seems to be recursive refs
$self->recursive_object($object) if ++$objectstack{$id} > 1;
# return if we already saw it twice. It should be already properly serialized
return if $objectstack{$id} > 2;
if (UNIVERSAL::isa($object => 'SOAP::Data')) {
# use $object->SOAP::Data:: to enable overriding name() and others in inherited classes
$object->SOAP::Data::name($name)
unless defined $object->SOAP::Data::name;
# apply ->uri() and ->prefix() which can modify name and attributes of
# element, but do not modify SOAP::Data itself
my($name, $attr) = $self->fixattrs($object);
$attr = $self->attrstoqname($attr);
my @realvalues = $object->SOAP::Data::value;
return [$name || gen_name, $attr] unless @realvalues;
my $method = "as_" . ($object->SOAP::Data::type || '-'); # dummy type if not defined
# try to call method specified for this type
no strict qw(refs);
my @values = map {
# store null/nil attribute if value is undef
local $attr->{SOAP::Utils::qualify(xsi => $self->xmlschemaclass->nilValue)} = $self->xmlschemaclass->as_undef(1)
unless defined;
$self->can($method) && $self->$method($_, $name || gen_name, $object->SOAP::Data::type, $attr)
|| $self->typecast($_, $name || gen_name, $object->SOAP::Data::type, $attr)
|| $self->encode_object($_, $name, $object->SOAP::Data::type, $attr)
} @realvalues;
$object->SOAP::Data::signature([map {join $;, $_->[0], SOAP::Utils::disqualify($_->[1]->{'xsi:type'} || '')} @values]) if @values;
return wantarray ? @values : $values[0];
}
my $class = ref $object;
if ($class !~ /^(?:SCALAR|ARRAY|HASH|REF)$/o) {
# we could also check for CODE|GLOB|LVALUE, but we cannot serialize
# them anyway, so they'll be cought by check below
$class =~ s/::/__/g;
$name = $class if !defined $name;
$type = $class if !defined $type && $self->autotype;
my $method = 'as_' . $class;
if ($self->can($method)) {
no strict qw(refs);
my $encoded = $self->$method($object, $name, $type, $attr);
return $encoded if ref $encoded;
# return only if handled, otherwise handle with default handlers
}
}
if (UNIVERSAL::isa($object => 'REF') || UNIVERSAL::isa($object => 'SCALAR')) {
return $self->encode_scalar($object, $name, $type, $attr);
}
elsif (UNIVERSAL::isa($object => 'ARRAY')) {
# Added in SOAP::Lite 0.65_6 to fix an XMLRPC bug
return $self->encodingStyle eq ""
|| $self->isa('XMLRPC::Serializer')
? $self->encode_array($object, $name, $type, $attr)
: $self->encode_literal_array($object, $name, $type, $attr);
}
elsif (UNIVERSAL::isa($object => 'HASH')) {
return $self->encode_hash($object, $name, $type, $attr);
}
else {
return $self->on_nonserialized->($object);
}
}
sub encode_scalar {
my($self, $value, $name, $type, $attr) = @_;
$name ||= gen_name;
my $schemaclass = $self->xmlschemaclass;
# null reference
return [$name, {%$attr, SOAP::Utils::qualify(xsi => $schemaclass->nilValue) => $schemaclass->as_undef(1)}] unless defined $value;
# object reference
return [$name, {'xsi:type' => $self->maptypetouri($type), %$attr}, [$self->encode_object($$value)], $self->gen_id($value)] if ref $value;
# autodefined type
if ($self->{ _autotype}) {
my $lookup = $self->{_typelookup};
no strict qw(refs);
#for (sort {$lookup->{$a}->[0] <=> $lookup->{$b}->[0]} keys %$lookup) {
for (@{ $self->{ _typelookup_order } }) {
my $method = $lookup->{$_}->[2];
return $self->can($method) && $self->$method($value, $name, $type, $attr)
|| $method->($value, $name, $type, $attr)
if $lookup->{$_}->[1]->($value);
}
}
# invariant
return [$name, $attr, $value];
}
sub encode_array {
my ($self, $array, $name, $type, $attr) = @_;
my $items = 'item';
# If typing is disabled, just serialize each of the array items
# with no type information, each using the specified name,
# and do not crete a wrapper array tag.
if (!$self->autotype) {
$name ||= gen_name;
return map {$self->encode_object($_, $name)} @$array;
}
# TODO: add support for multidimensional, partially transmitted and sparse arrays
my @items = map {$self->encode_object($_, $items)} @$array;
my $num = @items;
my($arraytype, %types) = '-';
for (@items) { $arraytype = $_->[1]->{'xsi:type'} || '-'; $types{$arraytype}++ }
$arraytype = sprintf "%s\[$num]", keys %types > 1 || $arraytype eq '-' ? SOAP::Utils::qualify(xsd => $self->xmlschemaclass->anyTypeValue) : $arraytype;
# $type = SOAP::Utils::qualify($self->encprefix => 'Array') if $self->autotype && !defined $type;
$type = qualify($self->encprefix => 'Array') if !defined $type;
return [$name || SOAP::Utils::qualify($self->encprefix => 'Array'),
{
SOAP::Utils::qualify($self->encprefix => 'arrayType') => $arraytype,
'xsi:type' => $self->maptypetouri($type), %$attr
},
[@items],
$self->gen_id($array)
];
}
# Will encode arrays using doc-literal style
sub encode_literal_array {
my($self, $array, $name, $type, $attr) = @_;
if ($self->autotype) {
my $items = 'item';
# TODO: add support for multidimensional, partially transmitted and sparse arrays
my @items = map {$self->encode_object($_, $items)} @$array;
my $num = @items;
my($arraytype, %types) = '-';
for (@items) {
$arraytype = $_->[1]->{'xsi:type'} || '-';
$types{$arraytype}++
}
$arraytype = sprintf "%s\[$num]", keys %types > 1 || $arraytype eq '-'
? SOAP::Utils::qualify(xsd => $self->xmlschemaclass->anyTypeValue)
: $arraytype;
$type = SOAP::Utils::qualify($self->encprefix => 'Array')
if !defined $type;
return [$name || SOAP::Utils::qualify($self->encprefix => 'Array'),
{
SOAP::Utils::qualify($self->encprefix => 'arrayType') => $arraytype,
'xsi:type' => $self->maptypetouri($type), %$attr
},
[ @items ],
$self->gen_id($array)
];
}
else {
#
# literal arrays are different - { array => [ 5,6 ] }
# results in <array>5</array><array>6</array>
# This means that if there's a literal inside the array (not a
# reference), we have to encode it this way. If there's only
# nested tags, encode as
# <array><foo>1</foo><foo>2</foo></array>
#
my $literal = undef;
my @items = map {
ref $_
? $self->encode_object($_)
: do {
$literal++;
$_
}
} @$array;
if ($literal) {
return map { [ $name , $attr , $_, $self->gen_id($array) ] } @items;
}
else {
return [$name || SOAP::Utils::qualify($self->encprefix => 'Array'),
$attr,
[ @items ],
$self->gen_id($array)
];
}
}
}
sub encode_hash {
my($self, $hash, $name, $type, $attr) = @_;
if ($self->autotype && grep {!/$SOAP::Constants::ELMASK/o} keys %$hash) {
warn qq!Cannot encode @{[$name ? "'$name'" : 'unnamed']} element as 'hash'. Will be encoded as 'map' instead\n! if $^W;
return $self->as_map($hash, $name || gen_name, $type, $attr);
}
$type = 'SOAPStruct'
if $self->autotype && !defined($type) && exists $self->maptype->{SOAPStruct};
return [$name || gen_name,
$self->autotype ? {'xsi:type' => $self->maptypetouri($type), %$attr} : { %$attr },
[map {$self->encode_object($hash->{$_}, $_)} keys %$hash],
$self->gen_id($hash)
];
}
sub as_ordered_hash {
my ($self, $value, $name, $type, $attr) = @_;
die "Not an ARRAY reference for 'ordered_hash' type" unless UNIVERSAL::isa($value => 'ARRAY');
return [ $name, $attr,
[map{$self->encode_object(@{$value}[2*$_+1,2*$_])} 0..$#$value/2 ],
$self->gen_id($value)
];
}
sub as_map {
my ($self, $value, $name, $type, $attr) = @_;
die "Not a HASH reference for 'map' type" unless UNIVERSAL::isa($value => 'HASH');
my $prefix = ($self->namespaces->{$SOAP::Constants::NS_APS} ||= 'apachens');
my @items = map {
$self->encode_object(
SOAP::Data->type(
ordered_hash => [
key => $_,
value => $value->{$_}
]
),
'item',
''
)} keys %$value;
return [
$name,
{'xsi:type' => "$prefix:Map", %$attr},
[@items],
$self->gen_id($value)
];
}
sub as_xml {
my $self = shift;
my($value, $name, $type, $attr) = @_;
return [$name, {'_xml' => 1}, $value];
}
sub typecast {
my $self = shift;
my($value, $name, $type, $attr) = @_;
return if ref $value; # skip complex object, caller knows how to deal with it
return if $self->autotype && !defined $type; # we don't know, autotype knows
return [$name,
{(defined $type && $type gt '' ? ('xsi:type' => $self->maptypetouri($type, 'simple type')) : ()), %$attr},
$value
];
}
sub register_ns {
my $self = shift->new();
my ($ns,$prefix) = @_;
$prefix = gen_ns if !$prefix;
$self->{'_namespaces'}->{$ns} = $prefix if $ns;
}
sub find_prefix {
my ($self, $ns) = @_;
return (exists $self->{'_namespaces'}->{$ns})
? $self->{'_namespaces'}->{$ns}
: ();
}
sub fixattrs {
my ($self, $data) = @_;
my ($name, $attr) = ($data->SOAP::Data::name, {%{$data->SOAP::Data::attr}});
my ($xmlns, $prefix) = ($data->uri, $data->prefix);
unless (defined($xmlns) || defined($prefix)) {
$self->register_ns($xmlns,$prefix) unless ($self->use_default_ns);
return ($name, $attr);
}
$name ||= gen_name(); # local name
$prefix = gen_ns() if !defined $prefix && $xmlns gt '';
$prefix = ''
if defined $xmlns && $xmlns eq ''
|| defined $prefix && $prefix eq '';
$attr->{join ':', xmlns => $prefix || ()} = $xmlns if defined $xmlns;
$name = join ':', $prefix, $name if $prefix;
$self->register_ns($xmlns,$prefix) unless ($self->use_default_ns);
return ($name, $attr);
}
sub toqname {
my $self = shift;
my $long = shift;
return $long unless $long =~ /^\{(.*)\}(.+)$/;
return SOAP::Utils::qualify $self->namespaces->{$1} ||= gen_ns, $2;
}
sub attrstoqname {
my $self = shift;
my $attrs = shift;
return {
map { /^\{(.*)\}(.+)$/
? ($self->toqname($_) => $2 eq 'type'
|| $2 eq 'arrayType'
? $self->toqname($attrs->{$_})
: $attrs->{$_})
: ($_ => $attrs->{$_})
} keys %$attrs
};
}
sub tag {
my ($self, $tag, $attrs, @values) = @_;
my $readable = $self->{ _readable };
my $value = join '', @values;
my $indent = $readable ? ' ' x (($self->{ _level }-1)*2) : '';
# check for special attribute
return "$indent$value" if exists $attrs->{_xml} && delete $attrs->{_xml};
die "Element '$tag' can't be allowed in valid XML message. Died."
if $tag !~ /^(?![xX][mM][lL])$SOAP::Constants::NSMASK$/o;
my $prolog = $readable ? "\n" : "";
my $epilog = $readable ? "\n" : "";
my $tagjoiner = " ";
if ($self->{ _level } == 1) {
my $namespaces = $self->namespaces;
foreach (keys %$namespaces) {
$attrs->{SOAP::Utils::qualify(xmlns => $namespaces->{$_})} = $_
}
$prolog = qq!<?xml version="1.0" encoding="@{[$self->encoding]}"?>!
if defined $self->encoding;
$prolog .= "\n" if $readable;
$tagjoiner = " \n".(' ' x 4 ) if $readable;
}
my $tagattrs = join($tagjoiner, '',
map { sprintf '%s="%s"', $_, SOAP::Utils::encode_attribute($attrs->{$_}) }
grep { $_ && defined $attrs->{$_} && ($_ ne 'xsi:type' || $attrs->{$_} ne '') }
keys %$attrs);
if ($value gt '') {
return sprintf("$prolog$indent<%s%s>%s%s</%s>$epilog",$tag,$tagattrs,$value,($value =~ /^\s*</ ? $indent : ""),$tag);
}
else {
return sprintf("$prolog$indent<%s%s />$epilog$indent",$tag,$tagattrs);
}
}
sub xmlize {
my $self = shift;
my($name, $attrs, $values, $id) = @{$_[0]};
$attrs ||= {};
local $self->{_level} = $self->{_level} + 1;
return $self->tag($name, $attrs)
unless defined $values;
return $self->tag($name, $attrs, $values)
unless ref $values eq "ARRAY";
return $self->tag($name, {%$attrs, href => '#'.$self->multiref_anchor($id)})
if $self->is_href($id, delete($attrs->{_id}));
# we have seen this element as a reference
if (defined $id && $self->{ _seen }->{ $id }->{ multiref}) {
return $self->tag($name,
{
%$attrs, id => $self->multiref_anchor($id)
},
map {$self->xmlize($_)} @$values
);
}
else {
return $self->tag($name, $attrs, map {$self->xmlize($_)} @$values);
}
}
sub uriformethod {
my $self = shift;
my $method_is_data = ref $_[0] && UNIVERSAL::isa($_[0] => 'SOAP::Data');
# drop prefix from method that could be string or SOAP::Data object
my($prefix, $method) = $method_is_data
? ($_[0]->prefix, $_[0]->name)
: SOAP::Utils::splitqname($_[0]);
my $attr = {reverse %{$self->namespaces}};
# try to define namespace that could be stored as
# a) method is SOAP::Data
# ? attribute in method's element as xmlns= or xmlns:${prefix}=
# : uri
# b) attribute in Envelope element as xmlns= or xmlns:${prefix}=
# c) no prefix or prefix equal serializer->envprefix
# ? '', but see coment below
# : die with error message
my $uri = $method_is_data
? ref $_[0]->attr && ($_[0]->attr->{$prefix ? "xmlns:$prefix" : 'xmlns'} || $_[0]->uri)
: $self->uri;
defined $uri or $uri = $attr->{$prefix || ''};
defined $uri or $uri = !$prefix || $prefix eq $self->envprefix
# still in doubts what should namespace be in this case
# but will keep it like this for now and be compatible with our server
? ( $method_is_data
&& $^W
&& warn("URI is not provided as an attribute for method ($method)\n"),
''
)
: die "Can't find namespace for method ($prefix:$method)\n";
return ($uri, $method);
}
sub serialize { SOAP::Trace::trace('()');
my $self = shift->new;
@_ == 1 or Carp::croak "serialize() method accepts one parameter";
$self->seen({}); # reinitialize multiref table
my($encoded) = $self->encode_object($_[0]);
# now encode multirefs if any
# v -------------- subelements of Envelope
push(@{$encoded->[2]}, $self->encode_multirefs) if ref $encoded->[2];
return $self->xmlize($encoded);
}
sub envelope {
SOAP::Trace::trace('()');
my $self = shift->new;
my $type = shift;
my(@parameters, @header);
for (@_) {
# Find all the SOAP Headers
if (defined($_) && ref($_) && UNIVERSAL::isa($_ => 'SOAP::Header')) {
push(@header, $_);
}
# Find all the SOAP Message Parts (attachments)
elsif (defined($_) && ref($_) && $self->context
&& $self->context->packager->is_supported_part($_)
) {
$self->context->packager->push_part($_);
}
# Find all the SOAP Body elements
else {
# proposed resolution for [ 1700326 ] encode_data called incorrectly in envelope
push(@parameters, $_);
# push (@parameters, SOAP::Utils::encode_data($_));
}
}
my $header = @header ? SOAP::Data->set_value(@header) : undef;
my($body,$parameters);
if ($type eq 'method' || $type eq 'response') {
SOAP::Trace::method(@parameters);
my $method = shift(@parameters);
# or die "Unspecified method for SOAP call\n";
$parameters = @parameters ? SOAP::Data->set_value(@parameters) : undef;
if (!defined($method)) {}
elsif (UNIVERSAL::isa($method => 'SOAP::Data')) {
$body = $method;
}
elsif ($self->use_default_ns) {
if ($self->{'_ns_uri'}) {
$body = SOAP::Data->name($method)
->attr({'xmlns' => $self->{'_ns_uri'} } );
}
else {
$body = SOAP::Data->name($method);
}
}
else {
# Commented out by Byrne on 1/4/2006 - to address default namespace problems
# $body = SOAP::Data->name($method)->uri($self->{'_ns_uri'});
# $body = $body->prefix($self->{'_ns_prefix'}) if ($self->{'_ns_prefix'});
# Added by Byrne on 1/4/2006 - to avoid the unnecessary creation of a new
# namespace
# Begin New Code (replaces code commented out above)
$body = SOAP::Data->name($method);
my $pre = $self->find_prefix($self->{'_ns_uri'});
$body = $body->prefix($pre) if ($self->{'_ns_prefix'});
# End new code
}
# This is breaking a unit test right now...
# proposed resolution for [ 1700326 ] encode_data called incorrectly in envelope
# $body->set_value(SOAP::Utils::encode_data($parameters ? \$parameters : ()))
# if $body;
# must call encode_data on nothing to enforce xsi:nil="true" to be set.
$body->set_value($parameters ? \$parameters : SOAP::Utils::encode_data()) if $body;
}
elsif ($type eq 'fault') {
SOAP::Trace::fault(@parameters);
# -> attr({'xmlns' => ''})
# Parameter order fixed thanks to Tom Fischer
$body = SOAP::Data-> name(SOAP::Utils::qualify($self->envprefix => 'Fault'))
-> value(\SOAP::Data->set_value(
SOAP::Data->name(faultcode => SOAP::Utils::qualify($self->envprefix => $parameters[0]))->type(""),
SOAP::Data->name(faultstring => SOAP::Utils::encode_data($parameters[1]))->type(""),
defined($parameters[3])
? SOAP::Data->name(faultactor => $parameters[3])->type("")
: (),
defined($parameters[2])
? SOAP::Data->name(detail => do{
my $detail = $parameters[2];
ref $detail
? \$detail
: SOAP::Utils::encode_data($detail)
})
: (),
));
}
elsif ($type eq 'freeform') {
SOAP::Trace::freeform(@parameters);
$body = SOAP::Data->set_value(@parameters);
}
elsif (!defined($type)) {
# This occurs when the Body is intended to be null. When no method has been
# passed in of any kind.
}
else {
die "Wrong type of envelope ($type) for SOAP call\n";
}
$self->{ _seen } = {}; # reinitialize multiref table
# Build the envelope
# Right now it is possible for $body to be a SOAP::Data element that has not
# XML escaped any values. How do you remedy this?
my($encoded) = $self->encode_object(
SOAP::Data->name(
SOAP::Utils::qualify($self->envprefix => 'Envelope') => \SOAP::Data->value(
($header
? SOAP::Data->name( SOAP::Utils::qualify($self->envprefix => 'Header') => \$header)
: ()
),
($body
? SOAP::Data->name(SOAP::Utils::qualify($self->envprefix => 'Body') => \$body)
: SOAP::Data->name(SOAP::Utils::qualify($self->envprefix => 'Body')) ),
)
)->attr($self->attr)
);
$self->signature($parameters->signature) if ref $parameters;
# IMHO multirefs should be encoded after Body, but only some
# toolkits understand this encoding, so we'll keep them for now (04/15/2001)
# as the last element inside the Body
# v -------------- subelements of Envelope
# vv -------- last of them (Body)
# v --- subelements
push(@{$encoded->[2]->[-1]->[2]}, $self->encode_multirefs) if ref $encoded->[2]->[-1]->[2];
# Sometimes SOAP::Serializer is invoked statically when there is no context.
# So first check to see if a context exists.
# TODO - a context needs to be initialized by a constructor?
if ($self->context && $self->context->packager->parts) {
# TODO - this needs to be called! Calling it though wraps the payload twice!
# return $self->context->packager->package($self->xmlize($encoded));
}
return $self->xmlize($encoded);
}
# ======================================================================
package SOAP::Parser;
sub DESTROY { SOAP::Trace::objects('()') }
sub xmlparser {
my $self = shift;
return eval {
$SOAP::Constants::DO_NOT_USE_XML_PARSER
? undef
: do {
require XML::Parser;
XML::Parser->new() }
}
|| eval { require XML::Parser::Lite; XML::Parser::Lite->new }
|| die "XML::Parser is not @{[$SOAP::Constants::DO_NOT_USE_XML_PARSER ? 'used' : 'available']} and ", $@;
}
sub parser {
my $self = shift->new;
@_
? do {
$self->{'_parser'} = shift;
return $self;
}
: return ($self->{'_parser'} ||= $self->xmlparser);
}
sub new {
my $self = shift;
return $self if ref $self;
my $class = $self;
SOAP::Trace::objects('()');
return bless {_parser => shift}, $class;
}
sub decode { SOAP::Trace::trace('()');
my $self = shift;
$self->parser->setHandlers(
Final => sub { shift; $self->final(@_) },
Start => sub { shift; $self->start(@_) },
End => sub { shift; $self->end(@_) },
Char => sub { shift; $self->char(@_) },
ExternEnt => sub { shift; die "External entity (pointing to '$_[1]') is not allowed" },
);
# my $parsed = $self->parser->parse($_[0]);
# return $parsed;
#
my $ret = undef;
eval {
$ret = $self->parser->parse($_[0]);
};
if ($@) {
$self->final; # Clean up in the event of an error
die $@; # Pass back the error
}
return $ret;
}
sub final {
my $self = shift;
# clean handlers, otherwise SOAP::Parser won't be deleted:
# it refers to XML::Parser which refers to subs from SOAP::Parser
# Thanks to Ryan Adams <iceman@mit.edu>
# and Craig Johnston <craig.johnston@pressplay.com>
# checked by number of tests in t/02-payload.t
undef $self->{_values};
$self->parser->setHandlers(
Final => undef,
Start => undef,
End => undef,
Char => undef,
ExternEnt => undef,
);
$self->{_done};
}
sub start { push @{shift->{_values}}, [shift, {@_}] }
# string concatenation changed to arrays which should improve performance
# for strings with many entity-encoded elements.
# Thanks to Mathieu Longtin <mrdamnfrenchy@yahoo.com>
sub char { push @{shift->{_values}->[-1]->[3]}, shift }
sub end {
my $self = shift;
my $done = pop @{$self->{_values}};
$done->[2] = defined $done->[3]
? join('',@{$done->[3]})
: '' unless ref $done->[2];
undef $done->[3];
@{$self->{_values}}
? (push @{$self->{_values}->[-1]->[2]}, $done)
: ($self->{_done} = $done);
}
# ======================================================================
package SOAP::SOM;
use Carp ();
use SOAP::Lite::Utils;
sub BEGIN {
no strict 'refs';
my %path = (
root => '/',
envelope => '/Envelope',
body => '/Envelope/Body',
header => '/Envelope/Header',
headers => '/Envelope/Header/[>0]',
fault => '/Envelope/Body/Fault',
faultcode => '/Envelope/Body/Fault/faultcode',
faultstring => '/Envelope/Body/Fault/faultstring',
faultactor => '/Envelope/Body/Fault/faultactor',
faultdetail => '/Envelope/Body/Fault/detail',
);
for my $method (keys %path) {
*$method = sub {
my $self = shift;
ref $self or return $path{$method};
Carp::croak "Method '$method' is readonly and doesn't accept any parameters" if @_;
return $self->valueof($path{$method});
};
}
my %results = (
method => '/Envelope/Body/[1]',
result => '/Envelope/Body/[1]/[1]',
freeform => '/Envelope/Body/[>0]',
paramsin => '/Envelope/Body/[1]/[>0]',
paramsall => '/Envelope/Body/[1]/[>0]',
paramsout => '/Envelope/Body/[1]/[>1]'
);
for my $method (keys %results) {
*$method = sub {
my $self = shift;
ref $self or return $results{$method};
Carp::croak "Method '$method' is readonly and doesn't accept any parameters" if @_;
defined $self->fault ? return : return $self->valueof($results{$method});
};
}
for my $method (qw(o_child o_value o_lname o_lattr o_qname)) { # import from SOAP::Utils
*$method = \&{'SOAP::Utils::'.$method};
}
__PACKAGE__->__mk_accessors('context');
}
# use object in boolean context return true/false on last match
# Ex.: $som->match('//Fault') ? 'SOAP call failed' : 'success';
use overload fallback => 1, 'bool' => sub { @{shift->{_current}} > 0 };
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
my $class = ref($self) || $self;
my $content = shift;
SOAP::Trace::objects('()');
return bless { _content => $content, _current => [$content] } => $class;
}
sub parts {
my $self = shift;
if (@_) {
$self->context->packager->parts(@_);
return $self;
}
else {
return $self->context->packager->parts;
}
}
sub is_multipart {
my $self = shift;
return defined($self->parts);
}
sub current {
my $self = shift;
$self->{_current} = [@_], return $self if @_;
return wantarray ? @{$self->{_current}} : $self->{_current}->[0];
}
sub valueof {
my $self = shift;
local $self->{_current} = $self->{_current};
$self->match(shift) if @_;
return wantarray
? map {o_value($_)} @{$self->{_current}}
: @{$self->{_current}} ? o_value($self->{_current}->[0]) : undef;
}
sub headerof { # SOAP::Header is the same as SOAP::Data, so just rebless it
wantarray
? map { bless $_ => 'SOAP::Header' } shift->dataof(@_)
: do { # header returned by ->dataof can be undef in scalar context
my $header = shift->dataof(@_);
ref $header ? bless($header => 'SOAP::Header') : undef;
};
}
sub dataof {
my $self = shift;
local $self->{_current} = $self->{_current};
$self->match(shift) if @_;
return wantarray
? map {$self->_as_data($_)} @{$self->{_current}}
: @{$self->{_current}}
? $self->_as_data($self->{_current}->[0])
: undef;
}
sub namespaceuriof {
my $self = shift;
local $self->{_current} = $self->{_current};
$self->match(shift) if @_;
return wantarray
? map {(SOAP::Utils::splitlongname(o_lname($_)))[0]} @{$self->{_current}}
: @{$self->{_current}} ? (SOAP::Utils::splitlongname(o_lname($self->{_current}->[0])))[0] : undef;
}
#sub _as_data {
# my $self = shift;
# my $pointer = shift;
#
# SOAP::Data
# -> new(prefix => '', name => o_qname($pointer), name => o_lname($pointer), attr => o_lattr($pointer))
# -> set_value(o_value($pointer));
#}
sub _as_data {
my $self = shift;
my $node = shift;
my $data = SOAP::Data->new( prefix => '',
# name => o_qname has side effect: sets namespace !
name => o_qname($node),
name => o_lname($node),
attr => o_lattr($node) );
if ( defined o_child($node) ) {
my @children;
foreach my $child ( @{ o_child($node) } ) {
push( @children, $self->_as_data($child) );
}
$data->set_value( \SOAP::Data->value(@children) );
}
else {
$data->set_value( o_value($node) );
}
return $data;
}
sub match {
my $self = shift;
my $path = shift;
$self->{_current} = [
$path =~ s!^/!! || !@{$self->{_current}}
? $self->_traverse($self->{_content}, 1 => split '/' => $path)
: map {$self->_traverse_tree(o_child($_), split '/' => $path)} @{$self->{_current}}
];
return $self;
}
sub _traverse {
my ($self, $pointer, $itself, $path, @path) = @_;
die "Incorrect parameter" unless $itself =~/^\d$/;
if ($path && substr($path, 0, 1) eq '{') {
$path = join '/', $path, shift @path while @path && $path !~ /}/;
}
my($op, $num) = $path =~ /^\[(<=|<|>=|>|=|!=?)?(\d+)\]$/ if defined $path;
return $pointer unless defined $path;
if (! $op) {
$op = '==';
}
elsif ($op eq '=' || $op eq '!') {
$op .= '=';
}
my $numok = defined $num && eval "$itself $op $num";
my $nameok = (o_lname($pointer) || '') =~ /(?:^|\})$path$/ if defined $path; # name can be with namespace
my $anynode = $path eq '';
unless ($anynode) {
if (@path) {
return if defined $num && !$numok || !defined $num && !$nameok;
}
else {
return $pointer if defined $num && $numok || !defined $num && $nameok;
return;
}
}
my @walk;
push @walk, $self->_traverse_tree([$pointer], @path) if $anynode;
push @walk, $self->_traverse_tree(o_child($pointer), $anynode ? ($path, @path) : @path);
return @walk;
}
sub _traverse_tree {
my ($self, $pointer, @path) = @_;
# can be list of children or value itself. Traverse only children
return unless ref $pointer eq 'ARRAY';
my $itself = 1;
grep {defined}
map {$self->_traverse($_, $itself++, @path)}
grep {!ref o_lattr($_) ||
!exists o_lattr($_)->{"{$SOAP::Constants::NS_ENC}root"} ||
o_lattr($_)->{"{$SOAP::Constants::NS_ENC}root"} ne '0'}
@$pointer;
}
# ======================================================================
package SOAP::Deserializer;
use vars qw(@ISA);
use SOAP::Lite::Utils;
use Class::Inspector;
@ISA = qw(SOAP::Cloneable);
sub DESTROY { SOAP::Trace::objects('()') }
sub BEGIN {
__PACKAGE__->__mk_accessors( qw(ids hrefs parts parser
base xmlschemas xmlschema context) );
}
# Cache (slow) Class::Inspector results
my %_class_loaded=();
sub new {
my $self = shift;
return $self if ref $self;
my $class = $self;
SOAP::Trace::objects('()');
return bless {
'_ids' => {},
'_hrefs' => {},
'_parser' => SOAP::Parser->new,
'_xmlschemas' => {
$SOAP::Constants::NS_APS => 'SOAP::XMLSchemaApacheSOAP::Deserializer',
# map {
# $_ => $SOAP::Constants::XML_SCHEMAS{$_} . '::Deserializer'
# } keys %SOAP::Constants::XML_SCHEMAS
map {
$_ => 'SOAP::Lite::Deserializer::' . $SOAP::Constants::XML_SCHEMA_OF{$_}
} keys %SOAP::Constants::XML_SCHEMA_OF
},
}, $class;
}
sub is_xml {
# Added check for envelope delivery. Fairly standard with MMDF and sendmail
# Thanks to Chris Davies <Chris.Davies@ManheimEurope.com>
$_[1] =~ /^\s*</ || $_[1] !~ /^(?:[\w-]+:|From )/;
}
sub baselocation {
my $self = shift;
my $location = shift;
if ($location) {
my $uri = URI->new($location);
# make absolute location if relative
$location = $uri->abs($self->base || 'thismessage:/')->as_string unless $uri->scheme;
}
return $location;
}
# Returns the envelope and populates SOAP::Packager with parts
sub decode_parts {
my $self = shift;
my $env = $self->context->packager->unpackage($_[0],$self->context);
my $body = $self->parser->decode($env);
# TODO - This shouldn't be here! This is packager specific!
# However this does need to pull out all the cid's
# to populate ids hash with.
foreach (@{$self->context->packager->parts}) {
my $data = $_->bodyhandle->as_string;
my $type = $_->head->mime_attr('Content-Type');
my $location = $_->head->mime_attr('Content-Location');
my $id = $_->head->mime_attr('Content-Id');
$location = $self->baselocation($location);
my $part = lc($type) eq 'text/xml' && !$SOAP::Constants::DO_NOT_PROCESS_XML_IN_MIME
? $self->parser->decode($data)
: ['mimepart', {}, $data];
# This below looks like unnecessary bloat!!!
# I should probably dereference the mimepart, provide a callback to get the string data
$id =~ s/^<([^>]*)>$/$1/; # string any leading and trailing brackets
$self->ids->{$id} = $part if $id;
$self->ids->{$location} = $part if $location;
}
return $body;
}
# decode returns a parsed body in the form of an ARRAY
# each element of the ARRAY is a HASH, ARRAY or SCALAR
sub decode {
my $self = shift->new; # this actually is important
return $self->is_xml($_[0])
? $self->parser->decode($_[0])
: $self->decode_parts($_[0]);
}
# deserialize returns a SOAP::SOM object and parses straight
# text as input
sub deserialize {
SOAP::Trace::trace('()');
my $self = shift->new;
# initialize
$self->hrefs({});
$self->ids({});
# If the document is XML, then ids will be empty
# If the document is MIME, then ids will hold a list of cids
my $parsed = $self->decode($_[0]);
# Having this code here makes multirefs in the Body work, but multirefs
# that reference XML fragments in a MIME part do not work.
if (keys %{$self->ids()}) {
$self->traverse_ids($parsed);
}
else {
# delay - set ids to be traversed later in decode_object, they only get
# traversed if an href is found that is referencing an id.
$self->ids($parsed);
}
$self->decode_object($parsed);
my $som = SOAP::SOM->new($parsed);
$som->context($self->context); # TODO - try removing this and see if it works!
return $som;
}
sub traverse_ids {
my $self = shift;
my $ref = shift;
my($undef, $attrs, $children) = @$ref;
# ^^^^^^ to fix nasty error on Mac platform (Carl K. Cunningham)
$self->ids->{$attrs->{'id'}} = $ref if exists $attrs->{'id'};
return unless ref $children;
for (@$children) {
$self->traverse_ids($_)
};
}
use constant _ATTRS => 6;
use constant _NAME => 5;
sub decode_object {
my $self = shift;
my $ref = shift;
my($name, $attrs_ref, $children, $value) = @$ref;
my %attrs = %{ $attrs_ref };
$ref->[ _ATTRS ] = \%attrs; # make a copy for long attributes
use vars qw(%uris);
local %uris = (%uris, map {
do { (my $ns = $_) =~ s/^xmlns:?//; $ns } => delete $attrs{$_}
} grep {/^xmlns(:|$)/} keys %attrs);
foreach (keys %attrs) {
next unless m/^($SOAP::Constants::NSMASK?):($SOAP::Constants::NSMASK)$/;
$1 =~ /^[xX][mM][lL]/ ||
$uris{$1} &&
do {
$attrs{SOAP::Utils::longname($uris{$1}, $2)} = do {
my $value = $attrs{$_};
$2 ne 'type' && $2 ne 'arrayType'
? $value
: SOAP::Utils::longname($value =~ m/^($SOAP::Constants::NSMASK?):(${SOAP::Constants::NSMASK}(?:\[[\d,]*\])*)/
? ($uris{$1} || die("Unresolved prefix '$1' for attribute value '$value'\n"), $2)
: ($uris{''} || die("Unspecified namespace for type '$value'\n"), $value)
);
};
1;
}
|| die "Unresolved prefix '$1' for attribute '$_'\n";
}
# and now check the element
my $ns = ($name =~ s/^($SOAP::Constants::NSMASK?):// ? $1 : '');
$ref->[ _NAME ] = SOAP::Utils::longname(
$ns
? ($uris{$ns} || die "Unresolved prefix '$ns' for element '$name'\n")
: (defined $uris{''} ? $uris{''} : undef),
$name
);
($children, $value) = (undef, $children) unless ref $children;
return $name => ($ref->[4] = $self->decode_value(
[$ref->[ _NAME ], \%attrs, $children, $value]
));
}
sub decode_value {
my $self = shift;
my($name, $attrs, $children, $value) = @{ $_[0] };
# check SOAP version if applicable
use vars '$level'; local $level = $level || 0;
if (++$level == 1) {
my($namespace, $envelope) = SOAP::Utils::splitlongname($name);
SOAP::Lite->soapversion($namespace) if $envelope eq 'Envelope' && $namespace;
}
if (exists $attrs->{"{$SOAP::Constants::NS_ENV}encodingStyle"}) {
# check encodingStyle
# future versions may bind deserializer to encodingStyle
my $encodingStyle = $attrs->{"{$SOAP::Constants::NS_ENV}encodingStyle"};
# TODO - SOAP 1.2 and 1.1 have different rules about valid encodingStyle values
# For example, in 1.1 - any http://schemas.xmlsoap.org/soap/encoding/*
# value is valid
if (defined $encodingStyle && length($encodingStyle)) {
my %styles = map { $_ => undef } @SOAP::Constants::SUPPORTED_ENCODING_STYLES;
my $found = 0;
foreach my $e (split(/ +/,$encodingStyle)) {
if (exists $styles{$e}) {
$found ++;
}
}
die "Unrecognized/unsupported value of encodingStyle attribute '$encodingStyle'"
if (! $found) && !(SOAP::Lite->soapversion == 1.1 && $encodingStyle =~ /(?:^|\b)$SOAP::Constants::NS_ENC/);
}
}
use vars '$arraytype'; # type of Array element specified on Array itself
# either specified with xsi:type, or <enc:name/> or array element
my ($type) = grep { defined }
map($attrs->{$_}, sort grep {/^\{$SOAP::Constants::NS_XSI_ALL\}type$/o} keys %$attrs),
$name =~ /^\{$SOAP::Constants::NS_ENC\}/ ? $name : $arraytype;
local $arraytype; # it's used only for one level, we don't need it anymore
# $name is not used here since type should be encoded as type, not as name
my ($schema, $class) = SOAP::Utils::splitlongname($type) if $type;
my $schemaclass = defined($schema) && $self->{ _xmlschemas }->{$schema}
|| $self;
if (! exists $_class_loaded{$schemaclass}) {
no strict qw(refs);
if (! Class::Inspector->loaded($schemaclass) ) {
eval "require $schemaclass" or die $@ if not ref $schemaclass;
}
$_class_loaded{$schemaclass} = undef;
}
# store schema that is used in parsed message
$self->{ _xmlschema } = $schema if ($schema) && $schema =~ /XMLSchema/;
# don't use class/type if anyType/ur-type is specified on wire
undef $class
if $schemaclass->can('anyTypeValue')
&& $schemaclass->anyTypeValue eq $class;
my $method = 'as_' . ($class || '-'); # dummy type if not defined
$class =~ s/__|\./::/g if $class;
my $id = $attrs->{id};
if (defined $id && exists $self->hrefs->{$id}) {
return $self->hrefs->{$id};
}
elsif (exists $attrs->{href}) {
(my $id = delete $attrs->{href}) =~ s/^(#|cid:|uuid:)?//;
# convert to absolute if not internal '#' or 'cid:'
$id = $self->baselocation($id) unless $1;
return $self->hrefs->{$id} if exists $self->hrefs->{$id};
# First time optimization. we don't traverse IDs unless asked for it.
# This is where traversing id's is delayed from before
# - the first time through - ids should contain a copy of the parsed XML
# structure! seems silly to make so many copies
my $ids = $self->ids;
if (ref($ids) ne 'HASH') {
$self->ids({}); # reset list of ids first time through
$self->traverse_ids($ids);
}
if (exists($self->ids->{$id})) {
my $obj = ($self->decode_object(delete($self->ids->{$id})))[1];
return $self->hrefs->{$id} = $obj;
}
else {
die "Unresolved (wrong?) href ($id) in element '$name'\n";
}
}
return undef if grep {
/^$SOAP::Constants::NS_XSI_NILS$/ && do {
my $class = $self->xmlschemas->{ $1 || $2 };
eval "require $class" or die @$;;
$class->as_undef($attrs->{$_})
}
} keys %$attrs;
# try to handle with typecasting
my $res = $self->typecast($value, $name, $attrs, $children, $type);
return $res if defined $res;
# ok, continue with others
if (exists $attrs->{"{$SOAP::Constants::NS_ENC}arrayType"}) {
my $res = [];
$self->hrefs->{$id} = $res if defined $id;
# check for arrayType which could be [1], [,2][5] or []
# [,][1] will NOT be allowed right now (multidimensional sparse array)
my($type, $multisize) = $attrs->{"{$SOAP::Constants::NS_ENC}arrayType"}
=~ /^(.+)\[(\d*(?:,\d+)*)\](?:\[(?:\d+(?:,\d+)*)\])*$/
or die qq!Unrecognized/unsupported format of arrayType attribute '@{[$attrs->{"{$SOAP::Constants::NS_ENC}arrayType"}]}'\n!;
my @dimensions = map { $_ || undef } split /,/, $multisize;
my $size = 1;
foreach (@dimensions) { $size *= $_ || 0 }
# TODO ��hm, shouldn't this local be my?
local $arraytype = $type;
# multidimensional
if ($multisize =~ /,/) {
@$res = splitarray(
[@dimensions],
[map { scalar(($self->decode_object($_))[1]) } @{$children || []}]
);
}
# normal
else {
@$res = map { scalar(($self->decode_object($_))[1]) } @{$children || []};
}
# sparse (position)
if (ref $children && exists SOAP::Utils::o_lattr($children->[0])->{"{$SOAP::Constants::NS_ENC}position"}) {
my @new;
for (my $pos = 0; $pos < @$children; $pos++) {
# TBD implement position in multidimensional array
my($position) = SOAP::Utils::o_lattr($children->[$pos])->{"{$SOAP::Constants::NS_ENC}position"} =~ /^\[(\d+)\]$/
or die "Position must be specified for all elements of sparse array\n";
$new[$position] = $res->[$pos];
}
@$res = @new;
}
# partially transmitted (offset)
# TBD implement offset in multidimensional array
my($offset) = $attrs->{"{$SOAP::Constants::NS_ENC}offset"} =~ /^\[(\d+)\]$/
if exists $attrs->{"{$SOAP::Constants::NS_ENC}offset"};
unshift(@$res, (undef) x $offset) if $offset;
die "Too many elements in array. @{[scalar@$res]} instead of claimed $multisize ($size)\n"
if $multisize && $size < @$res;
# extend the array if number of elements is specified
$#$res = $dimensions[0]-1 if defined $dimensions[0] && @$res < $dimensions[0];
return defined $class && $class ne 'Array' ? bless($res => $class) : $res;
}
elsif ($name =~ /^\{$SOAP::Constants::NS_ENC\}Struct$/
|| !$schemaclass->can($method)
&& (ref $children || defined $class && $value =~ /^\s*$/)) {
my $res = {};
$self->hrefs->{$id} = $res if defined $id;
# Patch code introduced in 0.65 - deserializes array properly
# Decode each element of the struct.
my %child_count_of = ();
foreach my $child (@{$children || []}) {
my ($child_name, $child_value) = $self->decode_object($child);
# Store the decoded element in the struct. If the element name is
# repeated, replace the previous scalar value with a new array
# containing both values.
if (not $child_count_of{$child_name}) {
# first time to see this value: use scalar
$res->{$child_name} = $child_value;
}
elsif ($child_count_of{$child_name} == 1) {
# second time to see this value: convert scalar to array
$res->{$child_name} = [ $res->{$child_name}, $child_value ];
}
else {
# already have an array: append to it
push @{$res->{$child_name}}, $child_value;
}
$child_count_of{$child_name}++;
}
# End patch code
return defined $class && $class ne 'SOAPStruct' ? bless($res => $class) : $res;
}
else {
my $res;
if (my $method_ref = $schemaclass->can($method)) {
$res = $method_ref->($self, $value, $name, $attrs, $children, $type);
}
else {
$res = $self->typecast($value, $name, $attrs, $children, $type);
$res = $class ? die "Unrecognized type '$type'\n" : $value
unless defined $res;
}
$self->hrefs->{$id} = $res if defined $id;
return $res;
}
}
sub splitarray {
my @sizes = @{+shift};
my $size = shift @sizes;
my $array = shift;
return splice(@$array, 0, $size) unless @sizes;
my @array = ();
push @array, [
splitarray([@sizes], $array)
] while @$array && (!defined $size || $size--);
return @array;
}
sub typecast { } # typecast is called for both objects AND scalar types
# check ref of the second parameter (first is the object)
# return undef if you don't want to handle it
# ======================================================================
package SOAP::Client;
use SOAP::Lite::Utils;
$VERSION = $SOAP::Lite::VERSION;
sub BEGIN {
__PACKAGE__->__mk_accessors(qw(endpoint code message
is_success status options));
}
# ======================================================================
package SOAP::Server::Object;
sub gen_id; *gen_id = \&SOAP::Serializer::gen_id;
my %alive;
my %objects;
sub objects_by_reference {
shift;
while (@_) {
@alive{shift()} = ref $_[0]
? shift
: sub {
$_[1]-$_[$_[5] ? 5 : 4] > $SOAP::Constants::OBJS_BY_REF_KEEPALIVE
}
}
keys %alive;
}
sub reference {
my $self = shift;
my $stamp = time;
my $object = shift;
my $id = $stamp . $self->gen_id($object);
# this is code for garbage collection
my $time = time;
my $type = ref $object;
my @objects = grep { $objects{$_}->[1] eq $type } keys %objects;
for (grep { $alive{$type}->(scalar @objects, $time, @{$objects{$_}}) } @objects) {
delete $objects{$_};
}
$objects{$id} = [$object, $type, $stamp];
bless { id => $id } => ref $object;
}
sub references {
my $self = shift;
return @_ unless %alive; # small optimization
return map {
ref($_) && exists $alive{ref $_}
? $self->reference($_)
: $_
} @_;
}
sub object {
my $self = shift;
my $class = ref($self) || $self;
my $object = shift;
return $object unless ref($object) && $alive{ref $object} && exists $object->{id};
my $reference = $objects{$object->{id}};
die "Object with specified id couldn't be found\n" unless ref $reference->[0];
$reference->[3] = time; # last access time
return $reference->[0]; # reference to actual object
}
sub objects {
my $self = shift;
return @_ unless %alive; # small optimization
return map {
ref($_) && exists $alive{ref $_} && exists $_->{id}
? $self->object($_)
: $_
} @_;
}
# ======================================================================
package SOAP::Server::Parameters;
sub byNameOrOrder {
unless (UNIVERSAL::isa($_[-1] => 'SOAP::SOM')) {
warn "Last parameter is expected to be envelope\n" if $^W;
pop;
return @_;
}
my $params = pop->method;
my @mandatory = ref $_[0] eq 'ARRAY'
? @{shift()}
: die "list of parameters expected as the first parameter for byName";
my $byname = 0;
my @res = map { $byname += exists $params->{$_}; $params->{$_} } @mandatory;
return $byname
? @res
: @_;
}
sub byName {
unless (UNIVERSAL::isa($_[-1] => 'SOAP::SOM')) {
warn "Last parameter is expected to be envelope\n" if $^W;
pop;
return @_;
}
return @{pop->method}{ref $_[0] eq 'ARRAY' ? @{shift()} : die "list of parameters expected as the first parameter for byName"};
}
# ======================================================================
package SOAP::Server;
use Carp ();
use Scalar::Util qw(weaken);
sub DESTROY { SOAP::Trace::objects('()') }
sub initialize {
return (
packager => SOAP::Packager::MIME->new,
transport => SOAP::Transport->new,
serializer => SOAP::Serializer->new,
deserializer => SOAP::Deserializer->new,
on_action => sub { ; },
on_dispatch => sub {
return;
},
);
}
sub new {
my $self = shift;
return $self if ref $self;
unless (ref $self) {
my $class = $self;
my(@params, @methods);
while (@_) {
my($method, $params) = splice(@_,0,2);
$class->can($method)
? push(@methods, $method, $params)
: $^W && Carp::carp "Unrecognized parameter '$method' in new()";
}
$self = bless {
_dispatch_to => [],
_dispatch_with => {},
_dispatched => [],
_action => '',
_options => {},
} => $class;
unshift(@methods, $self->initialize);
no strict qw(refs);
while (@methods) {
my($method, $params) = splice(@methods,0,2);
$self->$method(ref $params eq 'ARRAY' ? @$params : $params)
}
SOAP::Trace::objects('()');
}
Carp::carp "Odd (wrong?) number of parameters in new()"
if $^W && (@_ & 1);
no strict qw(refs);
while (@_) {
my($method, $params) = splice(@_,0,2);
$self->can($method)
? $self->$method(ref $params eq 'ARRAY' ? @$params : $params)
: $^W && Carp::carp "Unrecognized parameter '$method' in new()"
}
return $self;
}
sub init_context {
my $self = shift;
$self->{'_deserializer'}->{'_context'} = $self;
# weaken circular reference to avoid a memory hole
weaken($self->{'_deserializer'}->{'_context'});
$self->{'_serializer'}->{'_context'} = $self;
# weaken circular reference to avoid a memory hole
weaken($self->{'_serializer'}->{'_context'});
}
sub BEGIN {
no strict 'refs';
for my $method (qw(serializer deserializer transport)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new();
if (@_) {
my $context = $self->{$field}->{'_context'}; # save the old context
$self->{$field} = shift;
$self->{$field}->{'_context'} = $context; # restore the old context
return $self;
}
else {
return $self->{$field};
}
}
}
for my $method (qw(action myuri options dispatch_with packager)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new();
(@_)
? do {
$self->{$field} = shift;
return $self;
}
: return $self->{$field};
}
}
for my $method (qw(on_action on_dispatch)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new;
# my $self = shift;
return $self->{$field} unless @_;
local $@;
# commented out because that 'eval' was unsecure
# > ref $_[0] eq 'CODE' ? shift : eval shift;
# Am I paranoid enough?
$self->{$field} = shift;
Carp::croak $@ if $@;
Carp::croak "$method() expects subroutine (CODE) or string that evaluates into subroutine (CODE)"
unless ref $self->{$field} eq 'CODE';
return $self;
}
}
# __PACKAGE__->__mk_accessors( qw(dispatch_to) );
for my $method (qw(dispatch_to)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new;
# my $self = shift;
(@_)
? do {
$self->{$field} = [@_];
return $self;
}
: return @{ $self->{$field} };
}
}
}
sub objects_by_reference {
my $self = shift;
$self = $self->new() if not ref $self;
@_
? (SOAP::Server::Object->objects_by_reference(@_), return $self)
: SOAP::Server::Object->objects_by_reference;
}
sub dispatched {
my $self = shift;
$self = $self->new() if not ref $self;
@_
? (push(@{$self->{_dispatched}}, @_), return $self)
: return @{$self->{_dispatched}};
}
sub find_target {
my $self = shift;
my $request = shift;
# try to find URI/method from on_dispatch call first
my($method_uri, $method_name) = $self->on_dispatch->($request);
# if nothing there, then get it from envelope itself
$request->match((ref $request)->method);
($method_uri, $method_name) = ($request->namespaceuriof || '', $request->dataof->name)
unless $method_name;
$self->on_action->(my $action = $self->action, $method_uri, $method_name);
# check to avoid security vulnerability: Protected->Unprotected::method(@parameters)
# see for more details: http://www.phrack.org/phrack/58/p58-0x09
die "Denied access to method ($method_name)\n" unless $method_name =~ /^\w+$/;
my ($class, $static);
# try to bind directly
if (defined($class = $self->dispatch_with->{$method_uri}
|| $self->dispatch_with->{$action || ''}
|| (defined($action) && $action =~ /^"(.+)"$/
? $self->dispatch_with->{$1}
: undef))) {
# return object, nothing else to do here
return ($class, $method_uri, $method_name) if ref $class;
$static = 1;
}
else {
die "URI path shall map to class" unless defined ($class = URI->new($method_uri)->path);
for ($class) { s!^/|/$!!g; s!/!::!g; s/^$/main/; }
die "Failed to access class ($class)" unless $class =~ /^(\w[\w:]*)$/;
my $fullname = "$class\::$method_name";
foreach ($self->dispatch_to) {
return ($_, $method_uri, $method_name) if ref eq $class; # $OBJECT
next if ref; # skip other objects
# will ignore errors, because it may complain on
# d:\foo\bar, which is PATH and not regexp
eval {
$static ||= $class =~ /^$_$/ # MODULE
|| $fullname =~ /^$_$/ # MODULE::method
|| $method_name =~ /^$_$/ && ($class eq 'main'); # method ('main' assumed)
};
}
}
no strict 'refs';
# TODO - sort this mess out:
# The task is to test whether the class in question has already been loaded.
#
# SOAP::Lite 0.60:
# unless (defined %{"${class}::"}) {
# Patch to SOAP::Lite 0.60:
# The following patch does not work for packages defined within a BEGIN block
# unless (exists($INC{join '/', split /::/, $class.'.pm'})) {
# Combination of 0.60 and patch did not work reliably, either.
#
# Now we do the following: Check whether the class is main (always loaded)
# or the class implements the method in question
# or the package exists as file in %INC.
#
# This is still sort of a hack - but I don't know anything better
# If you have some idea, please help me out...
#
unless (($class eq 'main') || $class->can($method_name)
|| exists($INC{join '/', split /::/, $class . '.pm'})) {
# allow all for static and only specified path for dynamic bindings
local @INC = (($static ? @INC : ()), grep {!ref && m![/\\.]!} $self->dispatch_to());
eval 'local $^W; ' . "require $class";
die "Failed to access class ($class): $@" if $@;
$self->dispatched($class) unless $static;
}
die "Denied access to method ($method_name) in class ($class)"
unless $static || grep {/^$class$/} $self->dispatched;
return ($class, $method_uri, $method_name);
}
sub handle {
SOAP::Trace::trace('()');
my $self = shift;
$self = $self->new if !ref $self; # inits the server when called in a static context
$self->init_context();
# we want to restore it when we are done
local $SOAP::Constants::DEFAULT_XML_SCHEMA
= $SOAP::Constants::DEFAULT_XML_SCHEMA;
# SOAP version WILL NOT be restored when we are done.
# is it problem?
my $result = eval {
local $SIG{__DIE__};
# why is this here:
$self->serializer->soapversion(1.1);
my $request = eval { $self->deserializer->deserialize($_[0]) };
die SOAP::Fault
->faultcode($SOAP::Constants::FAULT_VERSION_MISMATCH)
->faultstring($@)
if $@ && $@ =~ /^$SOAP::Constants::WRONG_VERSION/;
die "Application failed during request deserialization: $@" if $@;
my $som = ref $request;
die "Can't find root element in the message"
unless $request->match($som->envelope);
$self->serializer->soapversion(SOAP::Lite->soapversion);
$self->serializer->xmlschema($SOAP::Constants::DEFAULT_XML_SCHEMA
= $self->deserializer->xmlschema)
if $self->deserializer->xmlschema;
die SOAP::Fault
->faultcode($SOAP::Constants::FAULT_MUST_UNDERSTAND)
->faultstring("Unrecognized header has mustUnderstand attribute set to 'true'")
if !$SOAP::Constants::DO_NOT_CHECK_MUSTUNDERSTAND &&
grep {
$_->mustUnderstand
&& (!$_->actor || $_->actor eq $SOAP::Constants::NEXT_ACTOR)
} $request->dataof($som->headers);
die "Can't find method element in the message"
unless $request->match($som->method);
# TODO - SOAP::Dispatcher plugs in here
# my $handler = $self->dispatcher->find_handler($request);
my($class, $method_uri, $method_name) = $self->find_target($request);
my @results = eval {
local $^W;
my @parameters = $request->paramsin;
# SOAP::Trace::dispatch($fullname);
SOAP::Trace::parameters(@parameters);
push @parameters, $request
if UNIVERSAL::isa($class => 'SOAP::Server::Parameters');
no strict qw(refs);
SOAP::Server::Object->references(
defined $parameters[0]
&& ref $parameters[0]
&& UNIVERSAL::isa($parameters[0] => $class)
? do {
my $object = shift @parameters;
SOAP::Server::Object->object(ref $class
? $class
: $object
)->$method_name(SOAP::Server::Object->objects(@parameters)),
# send object back as a header
# preserve name, specify URI
SOAP::Header
->uri($SOAP::Constants::NS_SL_HEADER => $object)
->name($request->dataof($som->method.'/[1]')->name)
} # end do block
# SOAP::Dispatcher will plug-in here as well
# $handler->dispatch(SOAP::Server::Object->objects(@parameters)
: $class->$method_name(SOAP::Server::Object->objects(@parameters)) );
}; # end eval block
SOAP::Trace::result(@results);
# let application errors pass through with 'Server' code
die ref $@
? $@
: $@ =~ /^Can\'t locate object method "$method_name"/
? "Failed to locate method ($method_name) in class ($class)"
: SOAP::Fault->faultcode($SOAP::Constants::FAULT_SERVER)->faultstring($@)
if $@;
my $result = $self->serializer
->prefix('s') # distinguish generated element names between client and server
->uri($method_uri)
->envelope(response => $method_name . 'Response', @results);
return $result;
};
# void context
return unless defined wantarray;
# normal result
return $result unless $@;
# check fails, something wrong with message
return $self->make_fault($SOAP::Constants::FAULT_CLIENT, $@) unless ref $@;
# died with SOAP::Fault
return $self->make_fault($@->faultcode || $SOAP::Constants::FAULT_SERVER,
$@->faultstring || 'Application error',
$@->faultdetail, $@->faultactor)
if UNIVERSAL::isa($@ => 'SOAP::Fault');
# died with complex detail
return $self->make_fault($SOAP::Constants::FAULT_SERVER, 'Application error' => $@);
} # end of handle()
sub make_fault {
my $self = shift;
my($code, $string, $detail, $actor) = @_;
$self->serializer->fault($code, $string, $detail, $actor || $self->myuri);
}
# ======================================================================
package SOAP::Trace;
use Carp ();
my @list = qw(
transport dispatch result
parameters headers objects
method fault freeform
trace debug);
{
no strict 'refs';
for (@list) {
*$_ = sub {}
}
}
sub defaultlog {
my $caller = (caller(1))[3]; # the 4th element returned by caller is the subroutine namea
$caller = (caller(2))[3] if $caller =~ /eval/;
chomp(my $msg = join ' ', @_);
printf STDERR "%s: %s\n", $caller, $msg;
}
sub import {
no strict 'refs';
local $^W;
my $pack = shift;
my(@notrace, @symbols);
for (@_) {
if (ref eq 'CODE') {
my $call = $_;
foreach (@symbols) { *$_ = sub { $call->(@_) } }
@symbols = ();
}
else {
local $_ = $_;
my $minus = s/^-//;
my $all = $_ eq 'all';
Carp::carp "Illegal symbol for tracing ($_)" unless $all || $pack->can($_);
$minus ? push(@notrace, $all ? @list : $_) : push(@symbols, $all ? @list : $_);
}
}
# TODO - I am getting a warning here about redefining a subroutine
foreach (@symbols) { *$_ = \&defaultlog }
foreach (@notrace) { *$_ = sub {} }
}
# ======================================================================
package SOAP::Custom::XML::Data;
use vars qw(@ISA $AUTOLOAD);
@ISA = qw(SOAP::Data);
use overload fallback => 1, '""' => sub { shift->value };
sub _compileit {
no strict 'refs';
my $method = shift;
*$method = sub {
return __PACKAGE__->SUPER::name($method => $_[0]->attr->{$method})
if exists $_[0]->attr->{$method};
my @elems = grep {
ref $_ && UNIVERSAL::isa($_ => __PACKAGE__)
&& $_->SUPER::name =~ /(^|:)$method$/
} $_[0]->value;
return wantarray? @elems : $elems[0];
};
}
sub BEGIN { foreach (qw(name type import use)) { _compileit($_) } }
sub AUTOLOAD {
my $method = substr($AUTOLOAD, rindex($AUTOLOAD, '::') + 2);
return if $method eq 'DESTROY';
_compileit($method);
goto &$AUTOLOAD;
}
# ======================================================================
package SOAP::Custom::XML::Deserializer;
use vars qw(@ISA);
@ISA = qw(SOAP::Deserializer);
sub decode_value {
my $self = shift;
my $ref = shift;
my($name, $attrs, $children, $value) = @$ref;
# base class knows what to do with it
return $self->SUPER::decode_value($ref) if exists $attrs->{href};
SOAP::Custom::XML::Data
-> SOAP::Data::name($name)
-> attr($attrs)
-> set_value(ref $children && @$children
? map(scalar(($self->decode_object($_))[1]), @$children)
: $value);
}
# ======================================================================
package SOAP::Schema::Deserializer;
use vars qw(@ISA);
@ISA = qw(SOAP::Custom::XML::Deserializer);
# ======================================================================
package SOAP::Schema::WSDL;
use vars qw(%imported @ISA);
@ISA = qw(SOAP::Schema);
sub new {
my $self = shift;
unless (ref $self) {
my $class = $self;
$self = $class->SUPER::new(@_);
}
return $self;
}
sub base {
my $self = shift->new;
@_
? ($self->{_base} = shift, return $self)
: return $self->{_base};
}
sub import {
my $self = shift->new;
my $s = shift;
my $base = shift || $self->base || die "Missing base argument for ", __PACKAGE__, "\n";
my @a = $s->import;
local %imported = %imported;
foreach (@a) {
next unless $_->location;
my $location = URI->new_abs($_->location->value, $base)->as_string;
if ($imported{$location}++) {
warn "Recursion loop detected in service description from '$location'. Ignored\n" if $^W;
return $s;
}
my $root = $self->import(
$self->deserializer->deserialize(
$self->access($location)
)->root, $location);
$root->SOAP::Data::name eq 'definitions' ? $s->set_value($s->value, $root->value) :
$root->SOAP::Data::name eq 'schema' ? do { # add <types> element if there is no one
$s->set_value($s->value, $self->deserializer->deserialize('<types></types>')->root) unless $s->types;
$s->types->set_value($s->types->value, $root) } :
die "Don't know what to do with '@{[$root->SOAP::Data::name]}' in schema imported from '$location'\n";
}
# return the parsed WSDL file
$s;
}
# TODO - This is woefully incomplete!
sub parse_schema_element {
my $element = shift;
# Current element is a complex type
if (defined($element->complexType)) {
my @elements = ();
if (defined($element->complexType->sequence)) {
foreach my $e ($element->complexType->sequence->element) {
push @elements,parse_schema_element($e);
}
}
return @elements;
}
elsif ($element->simpleType) {
}
else {
return $element;
}
}
sub parse {
my $self = shift->new;
my($s, $service, $port) = @_;
my @result;
# handle imports
$self->import($s);
# handle descriptions without <service>, aka tModel-type descriptions
my @services = $s->service;
my $tns = $s->{'_attr'}->{'targetNamespace'};
# if there is no <service> element we'll provide it
@services = $self->deserializer->deserialize(<<"FAKE")->root->service unless @services;
<definitions>
<service name="@{[$service || 'FakeService']}">
<port name="@{[$port || 'FakePort']}" binding="@{[$s->binding->name]}"/>
</service>
</definitions>
FAKE
my $has_warned = 0;
foreach (@services) {
my $name = $_->name;
next if $service && $service ne $name;
my %services;
foreach ($_->port) {
next if $port && $port ne $_->name;
my $binding = SOAP::Utils::disqualify($_->binding);
my $endpoint = ref $_->address ? $_->address->location : undef;
foreach ($s->binding) {
# is this a SOAP binding?
next unless grep { $_->uri eq 'http://schemas.xmlsoap.org/wsdl/soap/' } $_->binding;
next unless $_->name eq $binding;
my $default_style = $_->binding->style;
my $porttype = SOAP::Utils::disqualify($_->type);
foreach ($_->operation) {
my $opername = $_->name;
$services{$opername} = {}; # should be initialized in 5.7 and after
my $soapaction = $_->operation->soapAction;
my $invocationStyle = $_->operation->style || $default_style || "rpc";
my $encodingStyle = $_->input->body->use || "encoded";
my $namespace = $_->input->body->namespace || $tns;
my @parts;
foreach ($s->portType) {
next unless $_->name eq $porttype;
foreach ($_->operation) {
next unless $_->name eq $opername;
my $inputmessage = SOAP::Utils::disqualify($_->input->message);
foreach my $msg ($s->message) {
next unless $msg->name eq $inputmessage;
if ($invocationStyle eq "document" && $encodingStyle eq "literal") {
# warn "document/literal support is EXPERIMENTAL in SOAP::Lite"
# if !$has_warned && ($has_warned = 1);
my ($input_ns,$input_name) = SOAP::Utils::splitqname($msg->part->element);
foreach my $schema ($s->types->schema) {
foreach my $element ($schema->element) {
next unless $element->name eq $input_name;
push @parts,parse_schema_element($element);
}
$services{$opername}->{parameters} = [ @parts ];
}
}
else {
# TODO - support all combinations of doc|rpc/lit|enc.
#warn "$invocationStyle/$encodingStyle is not supported in this version of SOAP::Lite";
@parts = $msg->part;
$services{$opername}->{parameters} = [ @parts ];
}
}
}
for ($services{$opername}) {
$_->{endpoint} = $endpoint;
$_->{soapaction} = $soapaction;
$_->{namespace} = $namespace;
# $_->{parameters} = [@parts];
}
}
}
}
}
# fix nonallowed characters in package name, and add 's' if started with digit
for ($name) { s/\W+/_/g; s/^(\d)/s$1/ }
push @result, $name => \%services;
}
return @result;
}
# ======================================================================
# Naming? SOAP::Service::Schema?
package SOAP::Schema;
use Carp ();
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
return $self if ref $self;
unless (ref $self) {
my $class = $self;
require LWP::UserAgent;
$self = bless {
'_deserializer' => SOAP::Schema::Deserializer->new,
'_useragent' => LWP::UserAgent->new,
}, $class;
SOAP::Trace::objects('()');
}
Carp::carp "Odd (wrong?) number of parameters in new()" if $^W && (@_ & 1);
no strict qw(refs);
while (@_) {
my $method = shift;
$self->$method(shift) if $self->can($method)
}
return $self;
}
sub schema {
warn "SOAP::Schema->schema has been deprecated. "
. "Please use SOAP::Schema->schema_url instead.";
return shift->schema_url(@_);
}
sub BEGIN {
no strict 'refs';
for my $method (qw(deserializer schema_url services useragent stub cache_dir cache_ttl)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new;
@_ ? ($self->{$field} = shift, return $self) : return $self->{$field};
}
}
}
sub parse {
my $self = shift;
my $s = $self->deserializer->deserialize($self->access)->root;
# here should be something that defines what schema description we want to use
$self->services({SOAP::Schema::WSDL->base($self->schema_url)->parse($s, @_)});
}
sub refresh_cache {
my $self = shift;
my ($filename,$contents) = @_;
open CACHE,">$filename" or Carp::croak "Could not open cache file for writing: $!";
print CACHE $contents;
close CACHE;
}
sub load {
my $self = shift->new;
local $^W; # supress warnings about redefining
foreach (keys %{$self->services || Carp::croak 'Nothing to load. Schema is not specified'}) {
# TODO - check age of cached file, and delete if older than configured amount
if ($self->cache_dir) {
my $cached_file = File::Spec->catfile($self->cache_dir,$_.".pm");
my $ttl = $self->cache_ttl || $SOAP::Constants::DEFAULT_CACHE_TTL;
open (CACHE, "<$cached_file");
my @stat = stat($cached_file) unless eof(CACHE);
close CACHE;
if (@stat) {
# Cache exists
my $cache_lived = time() - $stat[9];
if ($ttl > 0 && $cache_lived > $ttl) {
$self->refresh_cache($cached_file,$self->generate_stub($_));
}
}
else {
# Cache doesn't exist
$self->refresh_cache($cached_file,$self->generate_stub($_));
}
push @INC,$self->cache_dir;
eval "require $_" or Carp::croak "Could not load cached file: $@";
}
else {
eval $self->generate_stub($_) or Carp::croak "Bad stub: $@";
}
}
$self;
}
sub access {
my $self = shift->new;
my $url = shift || $self->schema_url || Carp::croak 'Nothing to access. URL is not specified';
$self->useragent->env_proxy if $ENV{'HTTP_proxy'};
my $req = HTTP::Request->new(GET => $url);
$req->proxy_authorization_basic($ENV{'HTTP_proxy_user'}, $ENV{'HTTP_proxy_pass'})
if ($ENV{'HTTP_proxy_user'} && $ENV{'HTTP_proxy_pass'});
my $resp = $self->useragent->request($req);
$resp->is_success ? $resp->content : die "Service description '$url' can't be loaded: ", $resp->status_line, "\n";
}
sub generate_stub {
my $self = shift->new;
my $package = shift;
my $services = $self->services->{$package};
my $schema_url = $self->schema_url;
$self->{'_stub'} = <<"EOP";
package $package;
# Generated by SOAP::Lite (v$SOAP::Lite::VERSION) for Perl -- soaplite.com
# Copyright (C) 2000-2006 Paul Kulchenko, Byrne Reese
# -- generated at [@{[scalar localtime]}]
EOP
$self->{'_stub'} .= "# -- generated from $schema_url\n" if $schema_url;
$self->{'_stub'} .= 'my %methods = ('."\n";
foreach my $service (keys %$services) {
$self->{'_stub'} .= "$service => {\n";
foreach (qw(endpoint soapaction namespace)) {
$self->{'_stub'} .= " $_ => '".$services->{$service}{$_}."',\n";
}
$self->{'_stub'} .= " parameters => [\n";
foreach (@{$services->{$service}{parameters}}) {
# This is a workaround for https://sourceforge.net/tracker/index.php?func=detail&aid=2001592&group_id=66000&atid=513017
next unless ref $_;
$self->{'_stub'} .= " SOAP::Data->new(name => '".$_->name."', type => '".$_->type."', attr => {";
$self->{'_stub'} .= do {
my %attr = %{$_->attr};
join(', ', map {"'$_' => '$attr{$_}'"}
grep {/^xmlns:(?!-)/}
keys %attr);
};
$self->{'_stub'} .= "}),\n";
}
$self->{'_stub'} .= " ], # end parameters\n";
$self->{'_stub'} .= " }, # end $service\n";
}
$self->{'_stub'} .= "); # end my %methods\n";
$self->{'_stub'} .= <<'EOP';
use SOAP::Lite;
use Exporter;
use Carp ();
use vars qw(@ISA $AUTOLOAD @EXPORT_OK %EXPORT_TAGS);
@ISA = qw(Exporter SOAP::Lite);
@EXPORT_OK = (keys %methods);
%EXPORT_TAGS = ('all' => [@EXPORT_OK]);
sub _call {
my ($self, $method) = (shift, shift);
my $name = UNIVERSAL::isa($method => 'SOAP::Data') ? $method->name : $method;
my %method = %{$methods{$name}};
$self->proxy($method{endpoint} || Carp::croak "No server address (proxy) specified")
unless $self->proxy;
my @templates = @{$method{parameters}};
my @parameters = ();
foreach my $param (@_) {
if (@templates) {
my $template = shift @templates;
my ($prefix,$typename) = SOAP::Utils::splitqname($template->type);
my $method = 'as_'.$typename;
# TODO - if can('as_'.$typename) {...}
my $result = $self->serializer->$method($param, $template->name, $template->type, $template->attr);
push(@parameters, $template->value($result->[2]));
}
else {
push(@parameters, $param);
}
}
$self->endpoint($method{endpoint})
->ns($method{namespace})
->on_action(sub{qq!"$method{soapaction}"!});
EOP
my $namespaces = $self->deserializer->ids->[1];
foreach my $key (keys %{$namespaces}) {
my ($ns,$prefix) = SOAP::Utils::splitqname($key);
$self->{'_stub'} .= ' $self->serializer->register_ns("'.$namespaces->{$key}.'","'.$prefix.'");'."\n"
if ($ns eq "xmlns");
}
$self->{'_stub'} .= <<'EOP';
my $som = $self->SUPER::call($method => @parameters);
if ($self->want_som) {
return $som;
}
UNIVERSAL::isa($som => 'SOAP::SOM') ? wantarray ? $som->paramsall : $som->result : $som;
}
sub BEGIN {
no strict 'refs';
for my $method (qw(want_som)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new;
@_ ? ($self->{$field} = shift, return $self) : return $self->{$field};
}
}
}
no strict 'refs';
for my $method (@EXPORT_OK) {
my %method = %{$methods{$method}};
*$method = sub {
my $self = UNIVERSAL::isa($_[0] => __PACKAGE__)
? ref $_[0]
? shift # OBJECT
# CLASS, either get self or create new and assign to self
: (shift->self || __PACKAGE__->self(__PACKAGE__->new))
# function call, either get self or create new and assign to self
: (__PACKAGE__->self || __PACKAGE__->self(__PACKAGE__->new));
$self->_call($method, @_);
}
}
sub AUTOLOAD {
my $method = substr($AUTOLOAD, rindex($AUTOLOAD, '::') + 2);
return if $method eq 'DESTROY' || $method eq 'want_som';
die "Unrecognized method '$method'. List of available method(s): @EXPORT_OK\n";
}
1;
EOP
return $self->stub;
}
# ======================================================================
package SOAP;
use vars qw($AUTOLOAD);
require URI;
my $soap; # shared between SOAP and SOAP::Lite packages
{
no strict 'refs';
*AUTOLOAD = sub {
local($1,$2);
my($package, $method) = $AUTOLOAD =~ m/(?:(.+)::)([^:]+)$/;
return if $method eq 'DESTROY';
my $soap = ref $_[0] && UNIVERSAL::isa($_[0] => 'SOAP::Lite')
? $_[0]
: $soap
|| die "SOAP:: prefix shall only be used in combination with +autodispatch option\n";
my $uri = URI->new($soap->uri);
my $currenturi = $uri->path;
$package = ref $_[0] && UNIVERSAL::isa($_[0] => 'SOAP::Lite')
? $currenturi
: $package eq 'SOAP'
? ref $_[0] || ($_[0] eq 'SOAP'
? $currenturi || Carp::croak "URI is not specified for method call"
: $_[0])
: $package eq 'main'
? $currenturi || $package
: $package;
# drop first parameter if it's a class name
{
my $pack = $package;
for ($pack) { s!^/!!; s!/!::!g; }
shift @_ if @_ && !ref $_[0] && ($_[0] eq $pack || $_[0] eq 'SOAP')
|| ref $_[0] && UNIVERSAL::isa($_[0] => 'SOAP::Lite');
}
for ($package) { s!::!/!g; s!^/?!/!; }
$uri->path($package);
my $som = $soap->uri($uri->as_string)->call($method => @_);
UNIVERSAL::isa($som => 'SOAP::SOM')
? wantarray
? $som->paramsall
: $som->result
: $som;
};
}
# ======================================================================
package SOAP::Lite;
use vars qw($AUTOLOAD @ISA);
use Carp ();
use SOAP::Lite::Utils;
use SOAP::Constants;
use SOAP::Packager;
use Scalar::Util qw(weaken blessed);
@ISA = qw(SOAP::Cloneable);
# provide access to global/autodispatched object
sub self {
@_ > 1
? $soap = $_[1]
: $soap
}
# no more warnings about "used only once"
*UNIVERSAL::AUTOLOAD if 0;
sub autodispatched { \&{*UNIVERSAL::AUTOLOAD} eq \&{*SOAP::AUTOLOAD} };
sub soapversion {
my $self = shift;
my $version = shift or return $SOAP::Constants::SOAP_VERSION;
($version) = grep {
$SOAP::Constants::SOAP_VERSIONS{$_}->{NS_ENV} eq $version
} keys %SOAP::Constants::SOAP_VERSIONS
unless exists $SOAP::Constants::SOAP_VERSIONS{$version};
die qq!$SOAP::Constants::WRONG_VERSION Supported versions:\n@{[
join "\n", map {" $_ ($SOAP::Constants::SOAP_VERSIONS{$_}->{NS_ENV})"} keys %SOAP::Constants::SOAP_VERSIONS
]}\n!
unless defined($version) && defined(my $def = $SOAP::Constants::SOAP_VERSIONS{$version});
foreach (keys %$def) {
eval "\$SOAP::Constants::$_ = '$SOAP::Constants::SOAP_VERSIONS{$version}->{$_}'";
}
$SOAP::Constants::SOAP_VERSION = $version;
return $self;
}
BEGIN { SOAP::Lite->soapversion(1.1) }
sub import {
my $pkg = shift;
my $caller = caller;
no strict 'refs';
# emulate 'use SOAP::Lite 0.99' behavior
$pkg->require_version(shift) if defined $_[0] && $_[0] =~ /^\d/;
while (@_) {
my $command = shift;
my @parameters = UNIVERSAL::isa($_[0] => 'ARRAY')
? @{shift()}
: shift
if @_ && $command ne 'autodispatch';
if ($command eq 'autodispatch' || $command eq 'dispatch_from') {
$soap = ($soap||$pkg)->new;
no strict 'refs';
foreach ($command eq 'autodispatch'
? 'UNIVERSAL'
: @parameters
) {
my $sub = "${_}::AUTOLOAD";
defined &{*$sub}
? (\&{*$sub} eq \&{*SOAP::AUTOLOAD}
? ()
: Carp::croak "$sub already assigned and won't work with DISPATCH. Died")
: (*$sub = *SOAP::AUTOLOAD);
}
}
elsif ($command eq 'service') {
foreach (keys %{SOAP::Schema->schema_url(shift(@parameters))->parse(@parameters)->load->services}) {
$_->export_to_level(1, undef, ':all');
}
}
elsif ($command eq 'debug' || $command eq 'trace') {
SOAP::Trace->import(@parameters ? @parameters : 'all');
}
elsif ($command eq 'import') {
local $^W; # supress warnings about redefining
my $package = shift(@parameters);
$package->export_to_level(1, undef, @parameters ? @parameters : ':all') if $package;
}
else {
Carp::carp "Odd (wrong?) number of parameters in import(), still continue" if $^W && !(@parameters & 1);
$soap = ($soap||$pkg)->$command(@parameters);
}
}
}
sub DESTROY { SOAP::Trace::objects('()') }
sub new {
my $self = shift;
return $self if ref $self;
unless (ref $self) {
my $class = $self;
# Check whether we can clone. Only the SAME class allowed, no inheritance
$self = ref($soap) eq $class ? $soap->clone : {
_transport => SOAP::Transport->new,
_serializer => SOAP::Serializer->new,
_deserializer => SOAP::Deserializer->new,
_packager => SOAP::Packager::MIME->new,
_schema => undef,
_autoresult => 0,
_on_action => sub { sprintf '"%s#%s"', shift || '', shift },
_on_fault => sub {ref $_[1] ? return $_[1] : Carp::croak $_[0]->transport->is_success ? $_[1] : $_[0]->transport->status},
};
bless $self => $class;
$self->on_nonserialized($self->on_nonserialized || $self->serializer->on_nonserialized);
SOAP::Trace::objects('()');
}
Carp::carp "Odd (wrong?) number of parameters in new()" if $^W && (@_ & 1);
no strict qw(refs);
while (@_) {
my($method, $params) = splice(@_,0,2);
$self->can($method)
? $self->$method(ref $params eq 'ARRAY' ? @$params : $params)
: $^W && Carp::carp "Unrecognized parameter '$method' in new()"
}
return $self;
}
sub init_context {
my $self = shift->new;
$self->{'_deserializer'}->{'_context'} = $self;
# weaken circular reference to avoid a memory hole
weaken $self->{'_deserializer'}->{'_context'};
$self->{'_serializer'}->{'_context'} = $self;
# weaken circular reference to avoid a memory hole
weaken $self->{'_serializer'}->{'_context'};
}
# Naming? wsdl_parser
sub schema {
my $self = shift;
if (@_) {
$self->{'_schema'} = shift;
return $self;
}
else {
if (!defined $self->{'_schema'}) {
$self->{'_schema'} = SOAP::Schema->new;
}
return $self->{'_schema'};
}
}
sub BEGIN {
no strict 'refs';
for my $method (qw(serializer deserializer)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new;
if (@_) {
my $context = $self->{$field}->{'_context'}; # save the old context
$self->{$field} = shift;
$self->{$field}->{'_context'} = $context; # restore the old context
return $self;
}
else {
return $self->{$field};
}
}
}
__PACKAGE__->__mk_accessors(
qw(endpoint transport outputxml autoresult packager)
);
# for my $method () {
# my $field = '_' . $method;
# *$method = sub {
# my $self = shift->new;
# @_ ? ($self->{$field} = shift, return $self) : return $self->{$field};
# }
# }
for my $method (qw(on_action on_fault on_nonserialized)) {
my $field = '_' . $method;
*$method = sub {
my $self = shift->new;
return $self->{$field} unless @_;
local $@;
# commented out because that 'eval' was unsecure
# > ref $_[0] eq 'CODE' ? shift : eval shift;
# Am I paranoid enough?
$self->{$field} = shift;
Carp::croak $@ if $@;
Carp::croak "$method() expects subroutine (CODE) or string that evaluates into subroutine (CODE)"
unless ref $self->{$field} eq 'CODE';
return $self;
}
}
# SOAP::Transport Shortcuts
# TODO - deprecate proxy() in favor of new language endpoint_url()
no strict qw(refs);
for my $method (qw(proxy)) {
*$method = sub {
my $self = shift->new;
@_ ? ($self->transport->$method(@_), return $self) : return $self->transport->$method();
}
}
# SOAP::Seriailizer Shortcuts
for my $method (qw(autotype readable envprefix encodingStyle
encprefix multirefinplace encoding
typelookup header maptype xmlschema
uri ns_prefix ns_uri use_prefix use_default_ns
ns default_ns)) {
*$method = sub {
my $self = shift->new;
@_ ? ($self->serializer->$method(@_), return $self) : return $self->serializer->$method();
}
}
# SOAP::Schema Shortcuts
for my $method (qw(cache_dir cache_ttl)) {
*$method = sub {
my $self = shift->new;
@_ ? ($self->schema->$method(@_), return $self) : return $self->schema->$method();
}
}
}
sub parts {
my $self = shift;
$self->packager->parts(@_);
return $self;
}
# Naming? wsdl
sub service {
my $self = shift->new;
return $self->{'_service'} unless @_;
$self->schema->schema_url($self->{'_service'} = shift);
my %services = %{$self->schema->parse(@_)->load->services};
Carp::croak "More than one service in service description. Service and port names have to be specified\n"
if keys %services > 1;
my $service = (keys %services)[0]->new;
return $service;
}
sub AUTOLOAD {
my $method = substr($AUTOLOAD, rindex($AUTOLOAD, '::') + 2);
return if $method eq 'DESTROY';
ref $_[0] or Carp::croak qq!Can\'t locate class method "$method" via package \"! . __PACKAGE__ .'\"';
no strict 'refs';
*$AUTOLOAD = sub {
my $self = shift;
my $som = $self->call($method => @_);
return $self->autoresult && UNIVERSAL::isa($som => 'SOAP::SOM')
? wantarray ? $som->paramsall : $som->result
: $som;
};
goto &$AUTOLOAD;
}
sub call {
SOAP::Trace::trace('()');
my $self = shift;
die "A service address has not been specified either by using SOAP::Lite->proxy() or a service description)\n"
unless defined $self->proxy && UNIVERSAL::isa($self->proxy => 'SOAP::Client');
$self->init_context();
my $serializer = $self->serializer;
$serializer->on_nonserialized($self->on_nonserialized);
my $response = $self->transport->send_receive(
context => $self, # this is provided for context
endpoint => $self->endpoint,
action => scalar($self->on_action->($serializer->uriformethod($_[0]))),
# leave only parameters so we can later update them if required
envelope => $serializer->envelope(method => shift, @_),
encoding => $serializer->encoding,
parts => @{$self->packager->parts} ? $self->packager->parts : undef,
);
return $response if $self->outputxml;
my $result = eval { $self->deserializer->deserialize($response) }
if $response;
if (!$self->transport->is_success || # transport fault
$@ || # not deserializible
# fault message even if transport OK
# or no transport error (for example, fo TCP, POP3, IO implementations)
UNIVERSAL::isa($result => 'SOAP::SOM') && $result->fault) {
return ($self->on_fault->($self, $@
? $@ . ($response || '')
: $result)
|| $result
);
# ? # trick editors
}
# this might be trouble for connection close...
return unless $response; # nothing to do for one-ways
# little bit tricky part that binds in/out parameters
if (UNIVERSAL::isa($result => 'SOAP::SOM')
&& ($result->paramsout || $result->headers)
&& $serializer->signature) {
my $num = 0;
my %signatures = map {$_ => $num++} @{$serializer->signature};
for ($result->dataof(SOAP::SOM::paramsout), $result->dataof(SOAP::SOM::headers)) {
my $signature = join $;, $_->name, $_->type || '';
if (exists $signatures{$signature}) {
my $param = $signatures{$signature};
my($value) = $_->value; # take first value
# fillup parameters
UNIVERSAL::isa($_[$param] => 'SOAP::Data')
? $_[$param]->SOAP::Data::value($value)
: UNIVERSAL::isa($_[$param] => 'ARRAY')
? (@{$_[$param]} = @$value)
: UNIVERSAL::isa($_[$param] => 'HASH')
? (%{$_[$param]} = %$value)
: UNIVERSAL::isa($_[$param] => 'SCALAR')
? (${$_[$param]} = $$value)
: ($_[$param] = $value)
}
}
}
return $result;
} # end of call()
# ======================================================================
package SOAP::Lite::COM;
require SOAP::Lite;
sub required {
foreach (qw(
URI::_foreign URI::http URI::https
LWP::Protocol::http LWP::Protocol::https LWP::Authen::Basic LWP::Authen::Digest
HTTP::Daemon Compress::Zlib SOAP::Transport::HTTP
XMLRPC::Lite XMLRPC::Transport::HTTP
)) {
eval join ';', 'local $SIG{__DIE__}', "require $_";
}
}
sub new { required; SOAP::Lite->new(@_) }
sub create; *create = \&new; # make alias. Somewhere 'new' is registered keyword
sub soap; *soap = \&new; # also alias. Just to be consistent with .xmlrpc call
sub xmlrpc { required; XMLRPC::Lite->new(@_) }
sub server { required; shift->new(@_) }
sub data { SOAP::Data->new(@_) }
sub header { SOAP::Header->new(@_) }
sub hash { +{@_} }
sub instanceof {
my $class = shift;
die "Incorrect class name" unless $class =~ /^(\w[\w:]*)$/;
eval "require $class";
$class->new(@_);
}
# ======================================================================
1;
__END__
=pod
=head1 NAME
SOAP::Lite - Perl's Web Services Toolkit
=head1 DESCRIPTION
SOAP::Lite is a collection of Perl modules which provides a simple and
lightweight interface to the Simple Object Access Protocol (SOAP) both on
client and server side.
=head1 PERL VERSION WARNING
SOAP::Lite 0.71 will be the last version of SOAP::Lite running on perl 5.005
Future versions of SOAP::Lite will require at least perl 5.6.0
If you have not had the time to upgrad your perl, you should consider this
now.
=head1 OVERVIEW OF CLASSES AND PACKAGES
=over
=item F<lib/SOAP/Lite.pm>
L<SOAP::Lite> - Main class provides all logic
L<SOAP::Transport> - Transport backend
L<SOAP::Data> - Data objects
L<SOAP::Header> - Header Data Objects
L<SOAP::Serializer> - Serializes data structures to SOAP messages
L<SOAP::Deserializer> - Deserializes SOAP messages into SOAP::SOM objects
L<SOAP::SOM> - SOAP Message objects
L<SOAP::Constants> - Provides access to common constants and defaults
L<SOAP::Trace> - Tracing facilities
L<SOAP::Schema> - Provides access and stub(s) for schema(s)
L<SOAP::Schema::WSDL|SOAP::Schema/SOAP::Schema::WSDL> - WSDL implementation for SOAP::Schema
L<SOAP::Server> - Handles requests on server side
SOAP::Server::Object - Handles objects-by-reference
L<SOAP::Fault> - Provides support for Faults on server side
L<SOAP::Utils> - A set of private and public utility subroutines
=item F<lib/SOAP/Packager.pm>
L<SOAP::Packager> - Provides an abstract class for implementing custom packagers.
L<SOAP::Packager::MIME|SOAP::Packager/SOAP::Packager::MIME> - Provides MIME support to SOAP::Lite
L<SOAP::Packager::DIME|SOAP::Packager/SOAP::Packager::DIME> - Provides DIME support to SOAP::Lite
=item F<lib/SOAP/Transport/HTTP.pm>
L<SOAP::Transport::HTTP::Client|SOAP::Transport/SOAP::Transport::HTTP::Client> - Client interface to HTTP transport
L<SOAP::Transport::HTTP::Server|SOAP::Transport/SOAP::Transport::HTTP::Server> - Server interface to HTTP transport
L<SOAP::Transport::HTTP::CGI|SOAP::Transport/SOAP::Transport::HTTP::CGI> - CGI implementation of server interface
L<SOAP::Transport::HTTP::Daemon|SOAP::Transport/SOAP::Transport::HTTP::Daemon> - Daemon implementation of server interface
L<SOAP::Transport::HTTP::Apache|SOAP::Transport/SOAP::Transport::HTTP::Apache> - mod_perl implementation of server interface
=item F<lib/SOAP/Transport/POP3.pm>
L<SOAP::Transport::POP3::Server|SOAP::Transport/SOAP::Transport::POP3::Server> - Server interface to POP3 protocol
=item F<lib/SOAP/Transport/MAILTO.pm>
L<SOAP::Transport::MAILTO::Client|SOAP::Transport/SOAP::Transport::MAILTO::Client> - Client interface to SMTP/sendmail
=item F<lib/SOAP/Transport/LOCAL.pm>
L<SOAP::Transport::LOCAL::Client|SOAP::Transport/SOAP::Transport::LOCAL::Client> - Client interface to local transport
=item F<lib/SOAP/Transport/TCP.pm>
L<SOAP::Transport::TCP::Server|SOAP::Transport/SOAP::Transport::TCP::Server> - Server interface to TCP protocol
L<SOAP::Transport::TCP::Client|SOAP::Transport/SOAP::Transport::TCP::Client> - Client interface to TCP protocol
=item F<lib/SOAP/Transport/IO.pm>
L<SOAP::Transport::IO::Server|SOAP::Transport/SOAP::Transport::IO::Server> - Server interface to IO transport
=back
=head1 METHODS
All accessor methods return the current value when called with no arguments,
while returning the object reference itself when called with a new value.
This allows the set-attribute calls to be chained together.
=over
=item new(optional key/value pairs)
$client = SOAP::Lite->new(proxy => $endpoint)
Constructor. Many of the accessor methods defined here may be initialized at
creation by providing their name as a key, followed by the desired value.
The example provides the value for the proxy element of the client.
=item transport(optional transport object)
$transp = $client->transport( );
Gets or sets the transport object used for sending/receiving SOAP messages.
See L<SOAP::Transport> for details.
=item serializer(optional serializer object)
$serial = $client->serializer( )
Gets or sets the serializer object used for creating XML messages.
See L<SOAP::Serializer> for details.
=item packager(optional packager object)
$packager = $client->packager( )
Provides access to the C<SOAP::Packager> object that the client uses to manage
the use of attachments. The default packager is a MIME packager, but unless
you specify parts to send, no MIME formatting will be done.
See also: L<SOAP::Packager>.
=item proxy(endpoint, optional extra arguments)
$client->proxy('http://soap.xml.info/ endPoint');
The proxy is the server or endpoint to which the client is going to connect.
This method allows the setting of the endpoint, along with any extra
information that the transport object may need when communicating the request.
This method is actually an alias to the proxy method of L<SOAP::Transport>.
It is the same as typing:
$client->transport( )->proxy(...arguments);
Extra parameters can be passed to proxy() - see below.
=over
=item compress_threshold
See L<COMPRESSION|SOAP::Transport/"COMPRESSION"> in L<HTTP::Transport>.
=item All initialization options from the underlying transport layer
The options for HTTP(S) are the same as for LWP::UserAgent's new() method.
A common option is to create a instance of HTTP::Cookies and pass it as
cookie_jar option:
my $cookie_jar = HTTP::Cookies->new()
$client->proxy('http://www.example.org/webservice',
cookie_jar => $cookie_jar,
);
=back
For example, if you wish to set the HTTP timeout for a SOAP::Lite client to 5
seconds, use the following code:
my $soap = SOAP::Lite
->uri($uri)
->proxy($proxyUrl, timeout => 5 );
See L<LWP::UserAgent>.
=item endpoint(optional new endpoint address)
$client->endpoint('http://soap.xml.info/ newPoint')
It may be preferable to set a new endpoint without the additional work of
examining the new address for protocol information and checking to ensure the
support code is loaded and available. This method allows the caller to change
the endpoint that the client is currently set to connect to, without
reloading the relevant transport code. Note that the proxy method must have
been called before this method is used.
=item service(service URL)
$client->service('http://svc.perl.org/Svc.wsdl');
C<SOAP::Lite> offers some support for creating method stubs from service
descriptions. At present, only WSDL support is in place. This method loads
the specified WSDL schema and uses it as the basis for generating stubs.
=item outputxml(boolean)
$client->outputxml('true');
When set to a true value, the raw XML is returned by the call to a remote
method.
The default is to return the a L<SOAP::SOM> object (false).
=item autotype(boolean)
$client->autotype(0);
This method is a shortcut for:
$client->serializer->autotype(boolean);
By default, the serializer tries to automatically deduce types for the data
being sent in a message. Setting a false value with this method disables the
behavior.
=item readable(boolean)
$client->readable(1);
This method is a shortcut for:
$client->serializer->readable(boolean);
When this is used to set a true value for this property, the generated XML
sent to the endpoint has extra characters (spaces and new lines) added in to
make the XML itself more readable to human eyes (presumably for debugging).
The default is to not send any additional characters.
=item default_ns($uri)
Sets the default namespace for the request to the specified uri. This
overrides any previous namespace declaration that may have been set using a
previous call to C<ns()> or C<default_ns()>. Setting the default namespace
causes elements to be serialized without a namespace prefix, like this:
<soap:Envelope>
<soap:Body>
<myMethod xmlns="http://www.someuri.com">
<foo />
</myMethod>
</soap:Body>
</soap:Envelope>
Some .NET web services have been reported to require this XML namespace idiom.
=item ns($uri,$prefix=undef)
Sets the namespace uri and optionally the namespace prefix for the request to
the specified values. This overrides any previous namespace declaration that
may have been set using a previous call to C<ns()> or C<default_ns()>.
If a prefix is not specified, one will be generated for you automatically.
Setting the namespace causes elements to be serialized with a declared
namespace prefix, like this:
<soap:Envelope>
<soap:Body>
<my:myMethod xmlns:my="http://www.someuri.com">
<my:foo />
</my:myMethod>
</soap:Body>
</soap:Envelope>
=item use_prefix(boolean)
Deprecated. Use the C<ns()> and C<default_ns> methods described above.
Shortcut for C<< serializer->use_prefix() >>. This lets you turn on/off the
use of a namespace prefix for the children of the /Envelope/Body element.
Default is 'true'.
When use_prefix is set to 'true', serialized XML will look like this:
<SOAP-ENV:Envelope ...attributes skipped>
<SOAP-ENV:Body>
<namesp1:mymethod xmlns:namesp1="urn:MyURI" />
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
When use_prefix is set to 'false', serialized XML will look like this:
<SOAP-ENV:Envelope ...attributes skipped>
<SOAP-ENV:Body>
<mymethod xmlns="urn:MyURI" />
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Some .NET web services have been reported to require this XML namespace idiom.
=item soapversion(optional value)
$client->soapversion('1.2');
If no parameter is given, returns the current version of SOAP that is being
used by the client object to encode requests. If a parameter is given, the
method attempts to set that as the version of SOAP being used.
The value should be either 1.1 or 1.2.
=item envprefix(QName)
$client->envprefix('env');
This method is a shortcut for:
$client->serializer->envprefix(QName);
Gets or sets the namespace prefix for the SOAP namespace. The default is
SOAP.
The prefix itself has no meaning, but applications may wish to chose one
explicitly to denote different versions of SOAP or the like.
=item encprefix(QName)
$client->encprefix('enc');
This method is a shortcut for:
$client->serializer->encprefix(QName);
Gets or sets the namespace prefix for the encoding rules namespace.
The default value is SOAP-ENC.
=back
While it may seem to be an unnecessary operation to set a value that isn't
relevant to the message, such as the namespace labels for the envelope and
encoding URNs, the ability to set these labels explicitly can prove to be a
great aid in distinguishing and debugging messages on the server side of
operations.
=over
=item encoding(encoding URN)
$client->encoding($soap_12_encoding_URN);
This method is a shortcut for:
$client->serializer->encoding(args);
Where the earlier method dealt with the label used for the attributes related
to the SOAP encoding scheme, this method actually sets the URN to be specified
as the encoding scheme for the message. The default is to specify the encoding
for SOAP 1.1, so this is handy for applications that need to encode according
to SOAP 1.2 rules.
=item typelookup
$client->typelookup;
This method is a shortcut for:
$client->serializer->typelookup;
Gives the application access to the type-lookup table from the serializer
object. See the section on L<SOAP::Serializer>.
=item uri(service specifier)
Deprecated - the C<uri> subroutine is deprecated in order to provide a more
intuitive naming scheme for subroutines that set namespaces. In the future,
you will be required to use either the C<ns()> or C<default_ns()> subroutines
instead of C<uri()>.
$client->uri($service_uri);
This method is a shortcut for:
$client->serializer->uri(service);
The URI associated with this accessor on a client object is the
service-specifier for the request, often encoded for HTTP-based requests as
the SOAPAction header. While the names may seem confusing, this method
doesn't specify the endpoint itself. In most circumstances, the C<uri> refers
to the namespace used for the request.
Often times, the value may look like a valid URL. Despite this, it doesn't
have to point to an existing resource (and often doesn't). This method sets
and retrieves this value from the object. Note that no transport code is
triggered by this because it has no direct effect on the transport of the
object.
=item multirefinplace(boolean)
$client->multirefinplace(1);
This method is a shortcut for:
$client->serializer->multirefinplace(boolean);
Controls how the serializer handles values that have multiple references to
them. Recall from previous SOAP chapters that a value may be tagged with an
identifier, then referred to in several places. When this is the case for a
value, the serializer defaults to putting the data element towards the top of
the message, right after the opening tag of the method-specification. It is
serialized as a standalone entity with an ID that is then referenced at the
relevant places later on. If this method is used to set a true value, the
behavior is different. When the multirefinplace attribute is true, the data
is serialized at the first place that references it, rather than as a separate
element higher up in the body. This is more compact but may be harder to read
or trace in a debugging environment.
=item parts( ARRAY )
Used to specify an array of L<MIME::Entity>'s to be attached to the
transmitted SOAP message. Attachments that are returned in a response can be
accessed by C<SOAP::SOM::parts()>.
=item self
$ref = SOAP::Lite->self;
Returns an object reference to the default global object the C<SOAP::Lite>
package maintains. This is the object that processes many of the arguments
when provided on the use line.
=back
The following method isn't an accessor style of method but neither does it fit
with the group that immediately follows it:
=over
=item call(arguments)
$client->call($method => @arguments);
As has been illustrated in previous chapters, the C<SOAP::Lite> client objects
can manage remote calls with auto-dispatching using some of Perl's more
elaborate features. call is used when the application wants a greater degree
of control over the details of the call itself. The method may be built up
from a L<SOAP::Data> object, so as to allow full control over the namespace
associated with the tag, as well as other attributes like encoding. This is
also important for calling methods that contain characters not allowable in
Perl function names, such as A.B.C.
=back
The next four methods used in the C<SOAP::Lite> class are geared towards
handling the types of events than can occur during the message lifecycle. Each
of these sets up a callback for the event in question:
=over
=item on_action(callback)
$client->on_action(sub { qq("$_[0]") });
Triggered when the transport object sets up the SOAPAction header for an
HTTP-based call. The default is to set the header to the string, uri#method,
in which URI is the value set by the uri method described earlier, and method
is the name of the method being called. When called, the routine referenced
(or the closure, if specified as in the example) is given two arguments, uri
and method, in that order.
.NET web services usually expect C</> as separator for C<uri> and C<method>.
To change SOAP::Lite's behaviour to use uri/method as SOAPAction header, use
the following code:
$client->on_action( sub { join '/', @_ } );
=item on_fault(callback)
$client->on_fault(sub { popup_dialog($_[1]) });
Triggered when a method call results in a fault response from the server.
When it is called, the argument list is first the client object itself,
followed by the object that encapsulates the fault. In the example, the fault
object is passed (without the client object) to a hypothetical GUI function
that presents an error dialog with the text of fault extracted from the object
(which is covered shortly under the L<SOAP::SOM> methods).
=item on_nonserialized(callback)
$client->on_nonserialized(sub { die "$_[0]?!?" });
Occasionally, the serializer may be given data it can't turn into SOAP-savvy
XML; for example, if a program bug results in a code reference or something
similar being passed in as a parameter to method call. When that happens, this
callback is activated, with one argument. That argument is the data item that
could not be understood. It will be the only argument. If the routine returns,
the return value is pasted into the message as the serialization. Generally,
an error is in order, and this callback allows for control over signaling that
error.
=item on_debug(callback)
$client->on_debug(sub { print @_ });
Deprecated. Use the global +debug and +trace facilities described in
L<SOAP::Trace>
Note that this method will not work as expected: Instead of affecting the
debugging behaviour of the object called on, it will globally affect the
debugging behaviour for all objects of that class.
=back
=head1 WRITING A SOAP CLIENT
This chapter guides you to writing a SOAP client by example.
The SOAP service to be accessed is a simple variation of the well-known
hello world program. It accepts two parameters, a name and a given name,
and returns "Hello $given_name $name".
We will use "Martin Kutter" as the name for the call, so all variants will
print the following message on success:
Hello Martin Kutter!
=head2 SOAP message styles
There are three common (and one less common) variants of SOAP messages.
These address the message style (positional parameters vs. specified message
documents) and encoding (as-is vs. typed).
The different message styles are:
=over
=item * rpc/encoded
Typed, positional parameters. Widely used in scripting languages.
The type of the arguments is included in the message.
Arrays and the like may be encoded using SOAP encoding rules (or others).
=item * rpc/literal
As-is, positional parameters. The type of arguments is defined by some
pre-exchanged interface definition.
=item * document/encoded
Specified message with typed elements. Rarely used.
=item * document/literal
Specified message with as-is elements. The message specification and
element types are defined by some pre-exchanged interface definition.
=back
As of 2008, document/literal has become the predominant SOAP message
variant. rpc/literal and rpc/encoded are still in use, mainly with scripting
languages, while document/encoded is hardly used at all.
You will see clients for the rpc/encoded and document/literal SOAP variants in
this section.
=head2 Example implementations
=head3 RPC/ENCODED
Rpc/encoded is most popular with scripting languages like perl, php and python
without the use of a WSDL. Usual method descriptions look like this:
Method: sayHello(string, string)
Parameters:
name: string
givenName: string
Such a description usually means that you can call a method named "sayHello"
with two positional parameters, "name" and "givenName", which both are
strings.
The message corresponding to this description looks somewhat like this:
<sayHello xmlns="urn:HelloWorld">
<s-gensym01 xsi:type="xsd:string">Kutter</s-gensym01>
<s-gensym02 xsi:type="xsd:string">Martin</s-gensym02>
</sayHello>
Any XML tag names may be used instead of the "s-gensym01" stuff - parameters
are positional, the tag names have no meaning.
A client producing such a call is implemented like this:
use SOAP::Lite;
my $soap = SOAP::Lite->new( proxy => 'http://localhost:81/soap-wsdl-test/helloworld.pl');
$soap->default_ns('urn:HelloWorld');
my $som = $soap->call('sayHello', 'Kutter', 'Martin');
die $som->faultstring if ($som->fault);
print $som->result, "\n";
You can of course use a one-liner, too...
Sometimes, rpc/encoded interfaces are described with WSDL definitions.
A WSDL accepting "named" parameters with rpc/encoded looks like this:
<definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:s="http://www.w3.org/2001/XMLSchema"
xmlns:s0="urn:HelloWorld"
targetNamespace="urn:HelloWorld"
xmlns="http://schemas.xmlsoap.org/wsdl/">
<types>
<s:schema targetNamespace="urn:HelloWorld">
</s:schema>
</types>
<message name="sayHello">
<part name="name" type="s:string" />
<part name="givenName" type="s:string" />
</message>
<message name="sayHelloResponse">
<part name="sayHelloResult" type="s:string" />
</message>
<portType name="Service1Soap">
<operation name="sayHello">
<input message="s0:sayHello" />
<output message="s0:sayHelloResponse" />
</operation>
</portType>
<binding name="Service1Soap" type="s0:Service1Soap">
<soap:binding transport="http://schemas.xmlsoap.org/soap/http"
style="rpc" />
<operation name="sayHello">
<soap:operation soapAction="urn:HelloWorld#sayHello"/>
<input>
<soap:body use="encoded"
encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
</input>
<output>
<soap:body use="encoded"
encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
</output>
</operation>
</binding>
<service name="HelloWorld">
<port name="HelloWorldSoap" binding="s0:Service1Soap">
<soap:address location="http://localhost:81/soap-wsdl-test/helloworld.pl" />
</port>
</service>
</definitions>
The message corresponding to this schema looks like this:
<sayHello xmlns="urn:HelloWorld">
<name xsi:type="xsd:string">Kutter</name>
<givenName xsi:type="xsd:string">Martin</givenName>
</sayHello>
A web service client using this schema looks like this:
use SOAP::Lite;
my $soap = SOAP::Lite->service("file:say_hello_rpcenc.wsdl");
eval { my $result = $soap->sayHello('Kutter', 'Martin'); };
if ($@) {
die $@;
}
print $som->result();
You may of course also use the following one-liner:
perl -MSOAP::Lite -e 'print SOAP::Lite->service("file:say_hello_rpcenc.wsdl")\
->sayHello('Kutter', 'Martin'), "\n";'
A web service client (without a service description) looks like this.
use SOAP::Lite;
my $soap = SOAP::Lite->new( proxy => 'http://localhost:81/soap-wsdl-test/helloworld.pl');
$soap->default_ns('urn:HelloWorld');
my $som = $soap->call('sayHello',
SOAP::Data->name('name')->value('Kutter'),
SOAP::Data->name('givenName')->value('Martin')
);
die $som->faultstring if ($som->fault);
print $som->result, "\n";
=head3 RPC/LITERAL
SOAP web services using the document/literal message encoding are usually
described by some Web Service Definition. Our web service has the following
WSDL description:
<definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:s="http://www.w3.org/2001/XMLSchema"
xmlns:s0="urn:HelloWorld"
targetNamespace="urn:HelloWorld"
xmlns="http://schemas.xmlsoap.org/wsdl/">
<types>
<s:schema targetNamespace="urn:HelloWorld">
<s:complexType name="sayHello">
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="name"
type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="givenName"
type="s:string" nillable="1" />
</s:sequence>
</s:complexType>
<s:complexType name="sayHelloResponse">
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="sayHelloResult"
type="s:string" />
</s:sequence>
</s:complexType>
</s:schema>
</types>
<message name="sayHello">
<part name="parameters" type="s0:sayHello" />
</message>
<message name="sayHelloResponse">
<part name="parameters" type="s0:sayHelloResponse" />
</message>
<portType name="Service1Soap">
<operation name="sayHello">
<input message="s0:sayHello" />
<output message="s0:sayHelloResponse" />
</operation>
</portType>
<binding name="Service1Soap" type="s0:Service1Soap">
<soap:binding transport="http://schemas.xmlsoap.org/soap/http"
style="rpc" />
<operation name="sayHello">
<soap:operation soapAction="urn:HelloWorld#sayHello"/>
<input>
<soap:body use="literal" namespace="urn:HelloWorld"/>
</input>
<output>
<soap:body use="literal" namespace="urn:HelloWorld"/>
</output>
</operation>
</binding>
<service name="HelloWorld">
<port name="HelloWorldSoap" binding="s0:Service1Soap">
<soap:address location="http://localhost:80//helloworld.pl" />
</port>
</service>
</definitions>
The XML message (inside the SOAP Envelope) look like this:
<ns0:sayHello xmlns:ns0="urn:HelloWorld">
<parameters>
<name>Kutter</name>
<givenName>Martin</givenName>
</parameters>
</ns0:sayHello>
<sayHelloResponse xmlns:ns0="urn:HelloWorld">
<parameters>
<sayHelloResult>Hello Martin Kutter!</sayHelloResult>
</parameters>
</sayHelloResponse>
This is the SOAP::Lite implementation for the web service client:
use SOAP::Lite +trace;
my $soap = SOAP::Lite->new( proxy => 'http://localhost:80/helloworld.pl');
$soap->on_action( sub { "urn:HelloWorld#sayHello" });
$soap->autotype(0)->readable(1);
$soap->default_ns('urn:HelloWorld');
my $som = $soap->call('sayHello', SOAP::Data->name('parameters')->value(
\SOAP::Data->value([
SOAP::Data->name('name')->value( 'Kutter' ),
SOAP::Data->name('givenName')->value('Martin'),
]))
);
die $som->fault->{ faultstring } if ($som->fault);
print $som->result, "\n";
=head3 DOCUMENT/LITERAL
SOAP web services using the document/literal message encoding are usually
described by some Web Service Definition. Our web service has the following
WSDL description:
<definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:s="http://www.w3.org/2001/XMLSchema"
xmlns:s0="urn:HelloWorld"
targetNamespace="urn:HelloWorld"
xmlns="http://schemas.xmlsoap.org/wsdl/">
<types>
<s:schema targetNamespace="urn:HelloWorld">
<s:element name="sayHello">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="name" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="givenName" type="s:string" nillable="1" />
</s:sequence>
</s:complexType>
</s:element>
<s:element name="sayHelloResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="sayHelloResult" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
</types>
<message name="sayHelloSoapIn">
<part name="parameters" element="s0:sayHello" />
</message>
<message name="sayHelloSoapOut">
<part name="parameters" element="s0:sayHelloResponse" />
</message>
<portType name="Service1Soap">
<operation name="sayHello">
<input message="s0:sayHelloSoapIn" />
<output message="s0:sayHelloSoapOut" />
</operation>
</portType>
<binding name="Service1Soap" type="s0:Service1Soap">
<soap:binding transport="http://schemas.xmlsoap.org/soap/http"
style="document" />
<operation name="sayHello">
<soap:operation soapAction="urn:HelloWorld#sayHello"/>
<input>
<soap:body use="literal" />
</input>
<output>
<soap:body use="literal" />
</output>
</operation>
</binding>
<service name="HelloWorld">
<port name="HelloWorldSoap" binding="s0:Service1Soap">
<soap:address location="http://localhost:80//helloworld.pl" />
</port>
</service>
</definitions>
The XML message (inside the SOAP Envelope) look like this:
<sayHello xmlns="urn:HelloWorld">
<name>Kutter</name>
<givenName>Martin</givenName>
</sayHello>
<sayHelloResponse>
<sayHelloResult>Hello Martin Kutter!</sayHelloResult>
</sayHelloResponse>
You can call this web service with the following client code:
use SOAP::Lite;
my $soap = SOAP::Lite->new( proxy => 'http://localhost:80/helloworld.pl');
$soap->on_action( sub { "urn:HelloWorld#sayHello" });
$soap->autotype(0);
$soap->default_ns('urn:HelloWorld');
my $som = $soap->call("sayHello",
SOAP::Data->name('name')->value( 'Kutter' ),
SOAP::Data->name('givenName')->value('Martin'),
);
die $som->fault->{ faultstring } if ($som->fault);
print $som->result, "\n";
=head2 Differences between the implementations
You may have noticed that there's little difference between the rpc/encoded,
rpc/literal and the document/literal example's implementation. In fact, from
SOAP::Lite's point of view, the only differences between rpc/literal and
document/literal that parameters are always named.
In our example, the rpc/encoded variant already used named parameters (by
using two messages), so there's no difference at all.
You may have noticed the somewhat strange idiom for passing a list of named
paraneters in the rpc/literal example:
my $som = $soap->call('sayHello', SOAP::Data->name('parameters')->value(
\SOAP::Data->value([
SOAP::Data->name('name')->value( 'Kutter' ),
SOAP::Data->name('givenName')->value('Martin'),
]))
);
While SOAP::Data provides full control over the XML generated, passing
hash-like structures require additional coding.
=head1 WRITING A SOAP SERVER
See L<SOAP::Server>, or L<SOAP::Transport>.
=head1 FEATURES
=head2 ATTACHMENTS
C<SOAP::Lite> features support for the SOAP with Attachments specification.
Currently, SOAP::Lite only supports MIME based attachments. DIME based
attachments are yet to be fully functional.
=head3 EXAMPLES
=head4 Client sending an attachment
C<SOAP::Lite> clients can specify attachments to be sent along with a request
by using the C<SOAP::Lite::parts()> method, which takes as an argument an
ARRAY of C<MIME::Entity>'s.
use SOAP::Lite;
use MIME::Entity;
my $ent = build MIME::Entity
Type => "image/gif",
Encoding => "base64",
Path => "somefile.gif",
Filename => "saveme.gif",
Disposition => "attachment";
my $som = SOAP::Lite
->uri($SOME_NAMESPACE)
->parts([ $ent ])
->proxy($SOME_HOST)
->some_method(SOAP::Data->name("foo" => "bar"));
=head4 Client retrieving an attachment
A client accessing attachments that were returned in a response by using the
C<SOAP::SOM::parts()> accessor.
use SOAP::Lite;
use MIME::Entity;
my $soap = SOAP::Lite
->uri($NS)
->proxy($HOST);
my $som = $soap->foo();
foreach my $part (${$som->parts}) {
print $part->stringify;
}
=head4 Server receiving an attachment
Servers, like clients, use the S<SOAP::SOM> module to access attachments
transmitted to it.
package Attachment;
use SOAP::Lite;
use MIME::Entity;
use strict;
use vars qw(@ISA);
@ISA = qw(SOAP::Server::Parameters);
sub someMethod {
my $self = shift;
my $envelope = pop;
foreach my $part (@{$envelope->parts}) {
print "AttachmentService: attachment found! (".ref($part).")\n";
}
# do something
}
=head4 Server responding with an attachment
Servers wishing to return an attachment to the calling client need only return
C<MIME::Entity> objects along with SOAP::Data elements, or any other data
intended for the response.
package Attachment;
use SOAP::Lite;
use MIME::Entity;
use strict;
use vars qw(@ISA);
@ISA = qw(SOAP::Server::Parameters);
sub someMethod {
my $self = shift;
my $envelope = pop;
my $ent = build MIME::Entity
'Id' => "<1234>",
'Type' => "text/xml",
'Path' => "some.xml",
'Filename' => "some.xml",
'Disposition' => "attachment";
return SOAP::Data->name("foo" => "blah blah blah"),$ent;
}
=head2 DEFAULT SETTINGS
Though this feature looks similar to
L<autodispatch|/"IN/OUT, OUT PARAMETERS AND AUTOBINDING"> they have (almost)
nothing in common. This capability allows you specify default settings so that
all objects created after that will be initialized with the proper default
settings.
If you wish to provide common C<proxy()> or C<uri()> settings for all
C<SOAP::Lite> objects in your application you may do:
use SOAP::Lite
proxy => 'http://localhost/cgi-bin/soap.cgi',
uri => 'http://my.own.com/My/Examples';
my $soap1 = new SOAP::Lite; # will get the same proxy()/uri() as above
print $soap1->getStateName(1)->result;
my $soap2 = SOAP::Lite->new; # same thing as above
print $soap2->getStateName(2)->result;
# or you may override any settings you want
my $soap3 = SOAP::Lite->proxy('http://localhost/');
print $soap3->getStateName(1)->result;
B<Any> C<SOAP::Lite> properties can be propagated this way. Changes in object
copies will not affect global settings and you may still change global
settings with C<< SOAP::Lite->self >> call which returns reference to global
object. Provided parameter will update this object and you can even set it to
C<undef>:
SOAP::Lite->self(undef);
The C<use SOAP::Lite> syntax also lets you specify default event handlers for
your code. If you have different SOAP objects and want to share the same
C<on_action()> (or C<on_fault()> for that matter) handler. You can specify
C<on_action()> during initialization for every object, but you may also do:
use SOAP::Lite
on_action => sub {sprintf '%s#%s', @_};
and this handler will be the default handler for all your SOAP objects. You
can override it if you specify a handler for a particular object. See F<t/*.t>
for example of on_fault() handler.
Be warned, that since C<use ...> is executed at compile time B<all> C<use>
statements will be executed B<before> script execution that can make
unexpected results. Consider code:
use SOAP::Lite proxy => 'http://localhost/';
print SOAP::Lite->getStateName(1)->result;
use SOAP::Lite proxy => 'http://localhost/cgi-bin/soap.cgi';
print SOAP::Lite->getStateName(1)->result;
B<Both> SOAP calls will go to C<'http://localhost/cgi-bin/soap.cgi'>. If you
want to execute C<use> at run-time, put it in C<eval>:
eval "use SOAP::Lite proxy => 'http://localhost/cgi-bin/soap.cgi'; 1" or die;
Or alternatively,
SOAP::Lite->self->proxy('http://localhost/cgi-bin/soap.cgi');
=head2 SETTING MAXIMUM MESSAGE SIZE
One feature of C<SOAP::Lite> is the ability to control the maximum size of a
message a SOAP::Lite server will be allowed to process. To control this
feature simply define C<$SOAP::Constants::MAX_CONTENT_SIZE> in your code like
so:
use SOAP::Transport::HTTP;
use MIME::Entity;
$SOAP::Constants::MAX_CONTENT_SIZE = 10000;
SOAP::Transport::HTTP::CGI
->dispatch_to('TemperatureService')
->handle;
=head2 IN/OUT, OUT PARAMETERS AND AUTOBINDING
C<SOAP::Lite> gives you access to all parameters (both in/out and out) and
also does some additional work for you. Lets consider following example:
<mehodResponse>
<res1>name1</res1>
<res2>name2</res2>
<res3>name3</res3>
</mehodResponse>
In that case:
$result = $r->result; # gives you 'name1'
$paramout1 = $r->paramsout; # gives you 'name2', because of scalar context
$paramout1 = ($r->paramsout)[0]; # gives you 'name2' also
$paramout2 = ($r->paramsout)[1]; # gives you 'name3'
or
@paramsout = $r->paramsout; # gives you ARRAY of out parameters
$paramout1 = $paramsout[0]; # gives you 'res2', same as ($r->paramsout)[0]
$paramout2 = $paramsout[1]; # gives you 'res3', same as ($r->paramsout)[1]
Generally, if server returns C<return (1,2,3)> you will get C<1> as the result
and C<2> and C<3> as out parameters.
If the server returns C<return [1,2,3]> you will get an ARRAY reference from
C<result()> and C<undef> from C<paramsout()>.
Results can be arbitrary complex: they can be an array references, they can be
objects, they can be anything and still be returned by C<result()> . If only
one parameter is returned, C<paramsout()> will return C<undef>.
Furthermore, if you have in your output parameters a parameter with the same
signature (name+type) as in the input parameters this parameter will be mapped
into your input automatically. For example:
B<Server Code>:
sub mymethod {
shift; # object/class reference
my $param1 = shift;
my $param2 = SOAP::Data->name('myparam' => shift() * 2);
return $param1, $param2;
}
B<Client Code>:
$a = 10;
$b = SOAP::Data->name('myparam' => 12);
$result = $soap->mymethod($a, $b);
After that, C<< $result == 10 and $b->value == 24 >>! Magic? Sort of.
Autobinding gives it to you. That will work with objects also with one
difference: you do not need to worry about the name and the type of object
parameter. Consider the C<PingPong> example (F<examples/My/PingPong.pm>
and F<examples/pingpong.pl>):
B<Server Code>:
package My::PingPong;
sub new {
my $self = shift;
my $class = ref($self) || $self;
bless {_num=>shift} => $class;
}
sub next {
my $self = shift;
$self->{_num}++;
}
B<Client Code>:
use SOAP::Lite +autodispatch =>
uri => 'urn:',
proxy => 'http://localhost/';
my $p = My::PingPong->new(10); # $p->{_num} is 10 now, real object returned
print $p->next, "\n"; # $p->{_num} is 11 now!, object autobinded
=head2 STATIC AND DYNAMIC SERVICE DEPLOYMENT
Let us scrutinize the deployment process. When designing your SOAP server you
can consider two kind of deployment: B<static> and B<dynamic>. For both,
static and dynamic, you should specify C<MODULE>, C<MODULE::method>,
C<method> or C<PATH/> when creating C<use>ing the SOAP::Lite module. The
difference between static and dynamic deployment is that in case of 'dynamic',
any module which is not present will be loaded on demand. See the
L</"SECURITY"> section for detailed description.
When statically deploying a SOAP Server, you need to know all modules handling
SOAP requests before.
Dynamic deployment allows extending your SOAP Server's interface by just
installing another module into the dispatch_to path (see below).
=head3 STATIC DEPLOYMENT EXAMPLE
use SOAP::Transport::HTTP;
use My::Examples; # module is preloaded
SOAP::Transport::HTTP::CGI
# deployed module should be present here or client will get
# 'access denied'
-> dispatch_to('My::Examples')
-> handle;
For static deployment you should specify the MODULE name directly.
You should also use static binding when you have several different classes in
one file and want to make them available for SOAP calls.
=head3 DYNAMIC DEPLOYMENT EXAMPLE
use SOAP::Transport::HTTP;
# name is unknown, module will be loaded on demand
SOAP::Transport::HTTP::CGI
# deployed module should be present here or client will get 'access denied'
-> dispatch_to('/Your/Path/To/Deployed/Modules', 'My::Examples')
-> handle;
For dynamic deployment you can specify the name either directly (in that case
it will be C<require>d without any restriction) or indirectly, with a PATH. In
that case, the ONLY path that will be available will be the PATH given to the
dispatch_to() method). For information how to handle this situation see
L</"SECURITY"> section.
=head3 SUMMARY
dispatch_to(
# dynamic dispatch that allows access to ALL modules in specified directory
PATH/TO/MODULES
# 1. specifies directory
# -- AND --
# 2. gives access to ALL modules in this directory without limits
# static dispatch that allows access to ALL methods in particular MODULE
MODULE
# 1. gives access to particular module (all available methods)
# PREREQUISITES:
# module should be loaded manually (for example with 'use ...')
# -- OR --
# you can still specify it in PATH/TO/MODULES
# static dispatch that allows access to particular method ONLY
MODULE::method
# same as MODULE, but gives access to ONLY particular method,
# so there is not much sense to use both MODULE and MODULE::method
# for the same MODULE
);
In addition to this C<SOAP::Lite> also supports an experimental syntax that
allows you to bind a specific URL or SOAPAction to a CLASS/MODULE or object.
For example:
dispatch_with({
URI => MODULE, # 'http://www.soaplite.com/' => 'My::Class',
SOAPAction => MODULE, # 'http://www.soaplite.com/method' => 'Another::Class',
URI => object, # 'http://www.soaplite.com/obj' => My::Class->new,
})
C<URI> is checked before C<SOAPAction>. You may use both the C<dispatch_to()>
and C<dispatch_with()> methods in the same server, but note that
C<dispatch_with()> has a higher order of precedence. C<dispatch_to()> will be
checked only after C<URI> and C<SOAPAction> has been checked.
See also:
L<EXAMPLE APACHE::REGISTRY USAGE|SOAP::Transport/"EXAMPLE APACHE::REGISTRY USAGE">,
L</"SECURITY">
=head2 COMPRESSION
C<SOAP::Lite> provides you option to enable transparent compression over the
wire. Compression can be enabled by specifying a threshold value (in the form
of kilobytes) for compression on both the client and server sides:
I<Note: Compression currently only works for HTTP based servers and clients.>
B<Client Code>
print SOAP::Lite
->uri('http://localhost/My/Parameters')
->proxy('http://localhost/', options => {compress_threshold => 10000})
->echo(1 x 10000)
->result;
B<Server Code>
my $server = SOAP::Transport::HTTP::CGI
->dispatch_to('My::Parameters')
->options({compress_threshold => 10000})
->handle;
For more information see L<COMPRESSION|SOAP::Transport/"COMPRESSION"> in
L<HTTP::Transport>.
=head1 SECURITY
For security reasons, the exisiting path for Perl modules (C<@INC>) will be
disabled once you have chosen dynamic deployment and specified your own
C<PATH/>. If you wish to access other modules in your included package you
have several options:
=over 4
=item 1
Switch to static linking:
use MODULE;
$server->dispatch_to('MODULE');
Which can also be useful when you want to import something specific from the
deployed modules:
use MODULE qw(import_list);
=item 2
Change C<use> to C<require>. The path is only unavailable during the
initialization phase. It is available once more during execution. Therefore,
if you utilize C<require> somewhere in your package, it will work.
=item 3
Wrap C<use> in an C<eval> block:
eval 'use MODULE qw(import_list)'; die if $@;
=item 4
Set your include path in your package and then specify C<use>. Don't forget to
put C<@INC> in a C<BEGIN{}> block or it won't work. For example,
BEGIN { @INC = qw(my_directory); use MODULE }
=back
=head1 INTEROPERABILITY
=head2 Microsoft .NET client with SOAP::Lite Server
In order to use a .NET client with a SOAP::Lite server, be sure you use fully
qualified names for your return values. For example:
return SOAP::Data->name('myname')
->type('string')
->uri($MY_NAMESPACE)
->value($output);
In addition see comment about default incoding in .NET Web Services below.
=head2 SOAP::Lite client with a .NET server
If experiencing problems when using a SOAP::Lite client to call a .NET Web
service, it is recommended you check, or adhere to all of the following
recommendations:
=over 4
=item Declare a proper soapAction in your call
For example, use
C<on_action( sub { 'http://www.myuri.com/WebService.aspx#someMethod'; } )>.
=item Disable charset definition in Content-type header
Some users have said that Microsoft .NET prefers the value of
the Content-type header to be a mimetype exclusively, but SOAP::Lite specifies
a character set in addition to the mimetype. This results in an error similar
to:
Server found request content type to be 'text/xml; charset=utf-8',
but expected 'text/xml'
To turn off this behavior specify use the following code:
use SOAP::Lite;
$SOAP::Constants::DO_NOT_USE_CHARSET = 1;
# The rest of your code
=item Use fully qualified name for method parameters
For example, the following code is preferred:
SOAP::Data->name(Query => 'biztalk')
->uri('http://tempuri.org/')
As opposed to:
SOAP::Data->name('Query' => 'biztalk')
=item Place method in default namespace
For example, the following code is preferred:
my $method = SOAP::Data->name('add')
->attr({xmlns => 'http://tempuri.org/'});
my @rc = $soap->call($method => @parms)->result;
As opposed to:
my @rc = $soap->call(add => @parms)->result;
# -- OR --
my @rc = $soap->add(@parms)->result;
=item Disable use of explicit namespace prefixes
Some user's have reported that .NET will simply not parse messages that use
namespace prefixes on anything but SOAP elements themselves. For example, the
following XML would not be parsed:
<SOAP-ENV:Envelope ...attributes skipped>
<SOAP-ENV:Body>
<namesp1:mymethod xmlns:namesp1="urn:MyURI" />
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
SOAP::Lite allows users to disable the use of explicit namespaces through the
C<use_prefix()> method. For example, the following code:
$som = SOAP::Lite->uri('urn:MyURI')
->proxy($HOST)
->use_prefix(0)
->myMethod();
Will result in the following XML, which is more pallatable by .NET:
<SOAP-ENV:Envelope ...attributes skipped>
<SOAP-ENV:Body>
<mymethod xmlns="urn:MyURI" />
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
=item Modify your .NET server, if possible
Stefan Pharies <stefanph@microsoft.com>:
SOAP::Lite uses the SOAP encoding (section 5 of the soap 1.1 spec), and
the default for .NET Web Services is to use a literal encoding. So
elements in the request are unqualified, but your service expects them to
be qualified. .Net Web Services has a way for you to change the expected
message format, which should allow you to get your interop working.
At the top of your class in the asmx, add this attribute (for Beta 1):
[SoapService(Style=SoapServiceStyle.RPC)]
Another source said it might be this attribute (for Beta 2):
[SoapRpcService]
Full Web Service text may look like:
<%@ WebService Language="C#" Class="Test" %>
using System;
using System.Web.Services;
using System.Xml.Serialization;
[SoapService(Style=SoapServiceStyle.RPC)]
public class Test : WebService {
[WebMethod]
public int add(int a, int b) {
return a + b;
}
}
Another example from Kirill Gavrylyuk <kirillg@microsoft.com>:
"You can insert [SoapRpcService()] attribute either on your class or on
operation level".
<%@ WebService Language=CS class="DataType.StringTest"%>
namespace DataType {
using System;
using System.Web.Services;
using System.Web.Services.Protocols;
using System.Web.Services.Description;
[SoapRpcService()]
public class StringTest: WebService {
[WebMethod]
[SoapRpcMethod()]
public string RetString(string x) {
return(x);
}
}
}
Example from Yann Christensen <yannc@microsoft.com>:
using System;
using System.Web.Services;
using System.Web.Services.Protocols;
namespace Currency {
[WebService(Namespace="http://www.yourdomain.com/example")]
[SoapRpcService]
public class Exchange {
[WebMethod]
public double getRate(String country, String country2) {
return 122.69;
}
}
}
=back
Special thanks goes to the following people for providing the above
description and details on .NET interoperability issues:
Petr Janata <petr.janata@i.cz>,
Stefan Pharies <stefanph@microsoft.com>,
Brian Jepson <bjepson@jepstone.net>, and others
=head1 TROUBLESHOOTING
=over 4
=item SOAP::Lite serializes "18373" as an integer, but I want it to be a string!
SOAP::Lite guesses datatypes from the content provided, using a set of
common-sense rules. These rules are not 100% reliable, though they fit for
most data.
You may force the type by passing a SOAP::Data object with a type specified:
my $proxy = SOAP::Lite->proxy('http://www.example.org/soapservice');
my $som = $proxy->myMethod(
SOAP::Data->name('foo')->value(12345)->type('string')
);
You may also change the precedence of the type-guessing rules. Note that this
means fiddling with SOAP::Lite's internals - this may not work as
expected in future versions.
The example above forces everything to be encoded as string (this is because
the string test is normally last and allways returns true):
my @list = qw(-1 45 foo bar 3838);
my $proxy = SOAP::Lite->uri($uri)->proxy($proxyUrl);
my $lookup = $proxy->serializer->typelookup;
$lookup->{string}->[0] = 0;
$proxy->serializer->typelookup($lookup);
$proxy->myMethod(\@list);
See L<SOAP::Serializer|SOAP::Serializer/AUTOTYPING> for more details.
=item C<+autodispatch> doesn't work in Perl 5.8
There is a bug in Perl 5.8's C<UNIVERSAL::AUTOLOAD> functionality that
prevents the C<+autodispatch> functionality from working properly. The
workaround is to use C<dispatch_from> instead. Where you might normally do
something like this:
use Some::Module;
use SOAP::Lite +autodispatch =>
uri => 'urn:Foo'
proxy => 'http://...';
You would do something like this:
use SOAP::Lite dispatch_from(Some::Module) =>
uri => 'urn:Foo'
proxy => 'http://...';
=item Problems using SOAP::Lite's COM Interface
=over
=item Can't call method "server" on undefined value
You probably did not register F<Lite.dll> using C<regsvr32 Lite.dll>
=item Failed to load PerlCtrl Runtime
It is likely that you have install Perl in two different locations and the
location of ActiveState's Perl is not the first instance of Perl specified
in your PATH. To rectify, rename the directory in which the non-ActiveState
Perl is installed, or be sure the path to ActiveState's Perl is specified
prior to any other instance of Perl in your PATH.
=back
=item Dynamic libraries are not found
If you are using the Apache web server, and you are seeing something like the
following in your webserver log file:
Can't load '/usr/local/lib/perl5/site_perl/.../XML/Parser/Expat/Expat.so'
for module XML::Parser::Expat: dynamic linker: /usr/local/bin/perl:
libexpat.so.0 is NEEDED, but object does not exist at
/usr/local/lib/perl5/.../DynaLoader.pm line 200.
Then try placing the following into your F<httpd.conf> file and see if it
fixes your problem.
<IfModule mod_env.c>
PassEnv LD_LIBRARY_PATH
</IfModule>
=item SOAP client reports "500 unexpected EOF before status line seen
See L</"Apache is crashing with segfaults">
=item Apache is crashing with segfaults
Using C<SOAP::Lite> (or L<XML::Parser::Expat>) in combination with mod_perl
causes random segmentation faults in httpd processes. To fix, try configuring
Apache with the following:
RULE_EXPAT=no
If you are using Apache 1.3.20 and later, try configuring Apache with the
following option:
./configure --disable-rule=EXPAT
See http://archive.covalent.net/modperl/2000/04/0185.xml for more details and
lot of thanks to Robert Barta <rho@bigpond.net.au> for explaining this weird
behavior.
If this doesn't address the problem, you may wish to try C<-Uusemymalloc>,
or a similar option in order to instruct Perl to use the system's own C<malloc>.
Thanks to Tim Bunce <Tim.Bunce@pobox.com>.
=item CGI scripts do not work under Microsoft Internet Information Server (IIS)
CGI scripts may not work under IIS unless scripts use the C<.pl> extension,
opposed to C<.cgi>.
=item Java SAX parser unable to parse message composed by SOAP::Lite
In some cases SOAP messages created by C<SOAP::Lite> may not be parsed
properly by a SAX2/Java XML parser. This is due to a known bug in
C<org.xml.sax.helpers.ParserAdapter>. This bug manifests itself when an
attribute in an XML element occurs prior to the XML namespace declaration on
which it depends. However, according to the XML specification, the order of
these attributes is not significant.
http://www.megginson.com/SAX/index.html
Thanks to Steve Alpert (Steve_Alpert@idx.com) for pointing on it.
=back
=head1 PERFORMANCE
=over 4
=item Processing of XML encoded fragments
C<SOAP::Lite> is based on L<XML::Parser> which is basically wrapper around
James Clark's expat parser. Expat's behavior for parsing XML encoded string
can affect processing messages that have lot of encoded entities, like XML
fragments, encoded as strings. Providing low-level details, parser will call
char() callback for every portion of processed stream, but individually for
every processed entity or newline. It can lead to lot of calls and additional
memory manager expenses even for small messages. By contrast, XML messages
which are encoded as base64Binary, don't have this problem and difference in
processing time can be significant. For XML encoded string that has about 20
lines and 30 tags, number of call could be about 100 instead of one for
the same string encoded as base64Binary.
Since it is parser's feature there is NO fix for this behavior (let me know
if you find one), especially because you need to parse message you already
got (and you cannot control content of this message), however, if your are
in charge for both ends of processing you can switch encoding to base64 on
sender's side. It will definitely work with SOAP::Lite and it B<may> work with
other toolkits/implementations also, but obviously I cannot guarantee that.
If you want to encode specific string as base64, just do
C<< SOAP::Data->type(base64 => $string) >> either on client or on server
side. If you want change behavior for specific instance of SOAP::Lite, you
may subclass C<SOAP::Serializer>, override C<as_string()> method that is
responsible for string encoding (take a look into C<as_base64Binary()>) and
specify B<new> serializer class for your SOAP::Lite object with:
my $soap = new SOAP::Lite
serializer => My::Serializer->new,
..... other parameters
or on server side:
my $server = new SOAP::Transport::HTTP::Daemon # or any other server
serializer => My::Serializer->new,
..... other parameters
If you want to change this behavior for B<all> instances of SOAP::Lite, just
substitute C<as_string()> method with C<as_base64Binary()> somewhere in your
code B<after> C<use SOAP::Lite> and B<before> actual processing/sending:
*SOAP::Serializer::as_string = \&SOAP::XMLSchema2001::Serializer::as_base64Binary;
Be warned that last two methods will affect B<all> strings and convert them
into base64 encoded. It doesn't make any difference for SOAP::Lite, but it
B<may> make a difference for other toolkits.
=back
=head1 BUGS AND LIMITATIONS
=over 4
=item *
No support for multidimensional, partially transmitted and sparse arrays
(however arrays of arrays are supported, as well as any other data structures,
and you can add your own implementation with SOAP::Data).
=item *
Limited support for WSDL schema.
=item *
XML::Parser::Lite relies on Unicode support in Perl and doesn't do entity decoding.
=item *
Limited support for mustUnderstand and Actor attributes.
=back
=head1 PLATFORM SPECIFICS
=over 4
=item MacOS
Information about XML::Parser for MacPerl could be found here:
http://bumppo.net/lists/macperl-modules/1999/07/msg00047.html
Compiled XML::Parser for MacOS could be found here:
http://www.perl.com/CPAN-local/authors/id/A/AS/ASANDSTRM/XML-Parser-2.27-bin-1-MacOS.tgz
=back
=head1 RELATED MODULES
=head2 Transport Modules
SOAP::Lite allows to add support for additional transport protocols, or
server handlers, via separate modules implementing the SOAP::Transport::*
interface. The following modules are available from CPAN:
=over
=item * SOAP-Transport-HTTP-Nginx
L<SOAP::Transport::HTTP::Nginx|SOAP::Transport::HTTP::Nginx> provides a transport module for nginx (<http://nginx.net/>)
=back
=head1 AVAILABILITY
You can download the latest version SOAP::Lite for Unix or SOAP::Lite for
Win32 from the following sources:
* CPAN: http://search.cpan.org/search?dist=SOAP-Lite
* Sourceforge: http://sourceforge.net/projects/soaplite/
PPM packages are also available from sourceforge.
You are welcome to send e-mail to the maintainers of SOAP::Lite with your
comments, suggestions, bug reports and complaints.
=head1 ACKNOWLEDGEMENTS
Special thanks to Randy J. Ray, author of
I<Programming Web Services with Perl>, who has contributed greatly to the
documentation effort of SOAP::Lite.
Special thanks to O'Reilly publishing which has graciously allowed SOAP::Lite
to republish and redistribute the SOAP::Lite reference manual found in
Appendix B of I<Programming Web Services with Perl>.
And special gratitude to all the developers who have contributed patches,
ideas, time, energy, and help in a million different forms to the development
of this software.
=head1 HACKING
SOAP::Lite's development takes place on sourceforge.net.
There's a subversion repository set up at
https://soaplite.svn.sourceforge.net/svnroot/soaplite/
=head1 REPORTING BUGS
Please report all suspected SOAP::Lite bugs using Sourceforge. This ensures
proper tracking of the issue and allows you the reporter to know when something
gets fixed.
http://sourceforge.net/tracker/?group_id=66000&atid=513017
=head1 COPYRIGHT
Copyright (C) 2000-2007 Paul Kulchenko. All rights reserved.
Copyright (C) 2007-2008 Martin Kutter
=head1 LICENSE
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
This text and all associated documentation for this library is made available
under the Creative Commons Attribution-NoDerivs 2.0 license.
http://creativecommons.org/licenses/by-nd/2.0/
=head1 AUTHORS
Paul Kulchenko (paulclinger@yahoo.com)
Randy J. Ray (rjray@blackperl.com)
Byrne Reese (byrne@majordojo.com)
Martin Kutter (martin.kutter@fen-net.de)
=cut