This file is indexed.

/usr/lib/python2.7/dist-packages/suds/wsdl.py is in python-suds 0.7~git20150727.94664dd-5.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

   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
# This program is free software; you can redistribute it and/or modify it under
# the terms of the (LGPL) GNU Lesser General Public License as published by the
# Free Software Foundation; either version 3 of the License, or (at your
# option) any later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU Library Lesser General Public License
# for more details at ( http://www.gnu.org/licenses/lgpl.html ).
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation, Inc.,
# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
# written by: Jeff Ortel ( jortel@redhat.com )

"""
The I{wsdl} module provides an objectification of the WSDL.

The primary class is I{Definitions}, representing the root element found in a
WSDL schema document.

"""

from suds import *
from suds.bindings.document import Document
from suds.bindings.rpc import RPC, Encoded
from suds.reader import DocumentReader
from suds.sax.element import Element
from suds.sudsobject import Object, Facade, Metadata
from suds.xsd import qualify, Namespace
from suds.xsd.query import ElementQuery
from suds.xsd.schema import Schema, SchemaCollection

import re
import soaparray
from urlparse import urljoin

from logging import getLogger
log = getLogger(__name__)


wsdlns = (None, "http://schemas.xmlsoap.org/wsdl/")
soapns = (None, "http://schemas.xmlsoap.org/wsdl/soap/")
soap12ns = (None, "http://schemas.xmlsoap.org/wsdl/soap12/")


class WObject(Object):
    """
    Base object for WSDL types.

    @ivar root: The XML I{root} element.
    @type root: L{Element}

    """

    def __init__(self, root):
        """
        @param root: An XML root element.
        @type root: L{Element}

        """
        Object.__init__(self)
        self.root = root
        pmd = Metadata()
        pmd.excludes = ["root"]
        pmd.wrappers = dict(qname=repr)
        self.__metadata__.__print__ = pmd
        self.__resolved = False

    def resolve(self, definitions):
        """
        Resolve named references to other WSDL objects.

        Can be safely called multiple times.

        @param definitions: A definitions object.
        @type definitions: L{Definitions}

        """
        if not self.__resolved:
            self.do_resolve(definitions)
            self.__resolved = True

    def do_resolve(self, definitions):
        """
        Internal worker resolving named references to other WSDL objects.

        May only be called once per instance.

        @param definitions: A definitions object.
        @type definitions: L{Definitions}

        """
        pass


class NamedObject(WObject):
    """
    A B{named} WSDL object.

    @ivar name: The name of the object.
    @type name: str
    @ivar qname: The I{qualified} name of the object.
    @type qname: (name, I{namespace-uri}).

    """

    def __init__(self, root, definitions):
        """
        @param root: An XML root element.
        @type root: L{Element}
        @param definitions: A definitions object.
        @type definitions: L{Definitions}

        """
        WObject.__init__(self, root)
        self.name = root.get("name")
        self.qname = (self.name, definitions.tns[1])
        pmd = self.__metadata__.__print__
        pmd.wrappers["qname"] = repr


class Definitions(WObject):
    """
    I{Root} container for all the WSDL objects defined by <wsdl:definitions/>.

    @ivar id: The object id.
    @type id: str
    @ivar options: An options dictionary.
    @type options: L{options.Options}
    @ivar url: The URL used to load the object.
    @type url: str
    @ivar tns: The target namespace for the WSDL.
    @type tns: str
    @ivar schema: The collective WSDL schema object.
    @type schema: L{SchemaCollection}
    @ivar children: The raw list of child objects.
    @type children: [L{WObject},...]
    @ivar imports: The list of L{Import} children.
    @type imports: [L{Import},...]
    @ivar messages: The dictionary of L{Message} children keyed by I{qname}.
    @type messages: [L{Message},...]
    @ivar port_types: The dictionary of L{PortType} children keyed by I{qname}.
    @type port_types: [L{PortType},...]
    @ivar bindings: The dictionary of L{Binding} children keyed by I{qname}.
    @type bindings: [L{Binding},...]
    @ivar service: The service object.
    @type service: L{Service}

    """

    Tag = "definitions"

    def __init__(self, url, options, imported_definitions=None):
        """
        @param url: A URL to the WSDL.
        @type url: str
        @param options: An options dictionary.
        @type options: L{options.Options}

        """
        log.debug("reading WSDL at: %s ...", url)
        reader = DocumentReader(options)
        d = reader.open(url)
        root = d.root()
        WObject.__init__(self, root)
        self.id = objid(self)
        self.options = options
        self.url = url
        self.tns = self.mktns(root)
        self.types = []
        self.schema = None
        self.children = []
        self.imports = []
        self.messages = {}
        self.port_types = {}
        self.bindings = {}
        self.services = []
        self.add_children(self.root)
        self.children.sort()
        pmd = self.__metadata__.__print__
        pmd.excludes.append("children")
        pmd.excludes.append("wsdl")
        pmd.wrappers["schema"] = repr
        if imported_definitions is None:
            imported_definitions = {}
        imported_definitions[url] = self
        self.open_imports(imported_definitions)
        self.resolve()
        self.build_schema()
        self.set_wrapped()
        for s in self.services:
            self.add_methods(s)
        log.debug("WSDL at '%s' loaded:\n%s", url, self)

    def mktns(self, root):
        """Get/create the target namespace."""
        tns = root.get("targetNamespace")
        prefix = root.findPrefix(tns)
        if prefix is None:
            log.debug("warning: tns (%s), not mapped to prefix", tns)
            prefix = "tns"
        return (prefix, tns)

    def add_children(self, root):
        """Add child objects using the factory."""
        for c in root.getChildren(ns=wsdlns):
            child = Factory.create(c, self)
            if child is None: continue
            self.children.append(child)
            if isinstance(child, Import):
                self.imports.append(child)
                continue
            if isinstance(child, Types):
                self.types.append(child)
                continue
            if isinstance(child, Message):
                self.messages[child.qname] = child
                continue
            if isinstance(child, PortType):
                self.port_types[child.qname] = child
                continue
            if isinstance(child, Binding):
                self.bindings[child.qname] = child
                continue
            if isinstance(child, Service):
                self.services.append(child)
                continue

    def open_imports(self, imported_definitions):
        """Import the I{imported} WSDLs."""
        for imp in self.imports:
            imp.load(self, imported_definitions)

    def resolve(self):
        """Tell all children to resolve themselves."""
        for c in self.children:
            c.resolve(self)

    def build_schema(self):
        """Process L{Types} objects and create the schema collection."""
        loaded_schemata = {}
        container = SchemaCollection(self)
        for t in (t for t in self.types if t.local()):
            for root in t.contents():
                schema = Schema(root, self.url, self.options, loaded_schemata, container)
                container.add(schema)
        if not container:
            root = Element.buildPath(self.root, "types/schema")
            schema = Schema(root, self.url, self.options, loaded_schemata, container)
            container.add(schema)
        self.schema = container.load(self.options, loaded_schemata)
        #TODO: Recheck this XSD schema merging. XSD schema imports are not
        # supposed to be transitive. They only allow the importing schema to
        # reference entities from the imported schema, but do not include them
        # as their own content.
        for s in (t.schema() for t in self.types if t.imported()):
            self.schema.merge(s)
        return self.schema

    def add_methods(self, service):
        """Build method view for service."""
        bindings = {
            "document/literal": Document(self),
            "rpc/literal": RPC(self),
            "rpc/encoded": Encoded(self)}
        for p in service.ports:
            binding = p.binding
            ptype = p.binding.type
            operations = p.binding.type.operations.values()
            for name in (op.name for op in operations):
                m = Facade("Method")
                m.name = name
                m.location = p.location
                m.binding = Facade("binding")
                op = binding.operation(name)
                m.soap = op.soap
                key = "/".join((op.soap.style, op.soap.input.body.use))
                m.binding.input = bindings.get(key)
                key = "/".join((op.soap.style, op.soap.output.body.use))
                m.binding.output = bindings.get(key)
                p.methods[name] = m

    def set_wrapped(self):
        """Set (wrapped|bare) flag on messages."""
        for b in self.bindings.values():
            for op in b.operations.values():
                for body in (op.soap.input.body, op.soap.output.body):
                    body.wrapped = False
                    if not self.options.unwrap:
                        continue
                    if len(body.parts) != 1:
                        continue
                    for p in body.parts:
                        if p.element is None:
                            continue
                        query = ElementQuery(p.element)
                        pt = query.execute(self.schema)
                        if pt is None:
                            raise TypeNotFound(query.ref)
                        resolved = pt.resolve()
                        if resolved.builtin():
                            continue
                        body.wrapped = True

    def __getstate__(self):
        nopickle = ("options",)
        state = self.__dict__.copy()
        for k in nopickle:
            if k in state:
                del state[k]
        return state

    def __repr__(self):
        return "Definitions (id=%s)" % (self.id,)


class Import(WObject):
    """
    Represents the <wsdl:import/>.

    @ivar location: The value of the I{location} attribute.
    @type location: str
    @ivar ns: The value of the I{namespace} attribute.
    @type ns: str
    @ivar imported: The imported object.
    @type imported: L{Definitions}

    """

    def __init__(self, root, definitions):
        """
        @param root: An XML root element.
        @type root: L{Element}
        @param definitions: A definitions object.
        @type definitions: L{Definitions}

        """
        WObject.__init__(self, root)
        self.location = root.get("location")
        self.ns = root.get("namespace")
        self.imported = None
        pmd = self.__metadata__.__print__
        pmd.wrappers["imported"] = repr

    def load(self, definitions, imported_definitions):
        """Load the object by opening the URL."""
        url = self.location
        log.debug("importing (%s)", url)
        if "://" not in url:
            url = urljoin(definitions.url, url)
        d = imported_definitions.get(url)
        if not d:
            d = Definitions(url, definitions.options, imported_definitions)
        if d.root.match(Definitions.Tag, wsdlns):
            self.import_definitions(definitions, d)
            return
        if d.root.match(Schema.Tag, Namespace.xsdns):
            self.import_schema(definitions, d)
            return
        raise Exception("document at '%s' is unknown" % url)

    def import_definitions(self, definitions, d):
        """Import/merge WSDL definitions."""
        definitions.types += d.types
        definitions.messages.update(d.messages)
        definitions.port_types.update(d.port_types)
        definitions.bindings.update(d.bindings)
        self.imported = d
        log.debug("imported (WSDL):\n%s", d)

    def import_schema(self, definitions, d):
        """Import schema as <types/> content."""
        if not definitions.types:
            root = Element("types", ns=wsdlns)
            definitions.root.insert(root)
            types = Types(root, definitions)
            definitions.types.append(types)
        else:
            types = definitions.types[-1]
        types.root.append(d.root)
        log.debug("imported (XSD):\n%s", d.root)

    def __gt__(self, other):
        return False


class Types(WObject):
    """Represents <types><schema/></types>."""

    def __init__(self, root, definitions):
        """
        @param root: An XML root element.
        @type root: L{Element}
        @param definitions: A definitions object.
        @type definitions: L{Definitions}

        """
        WObject.__init__(self, root)
        self.definitions = definitions

    def contents(self):
        return self.root.getChildren("schema", Namespace.xsdns)

    def schema(self):
        return self.definitions.schema

    def local(self):
        return self.definitions.schema is None

    def imported(self):
        return not self.local()

    def __gt__(self, other):
        return isinstance(other, Import)


class Part(NamedObject):
    """
    Represents <message><part/></message>.

    @ivar element: The value of the {element} attribute. Stored as a I{qref} as
        converted by L{suds.xsd.qualify}.
    @type element: str
    @ivar type: The value of the {type} attribute. Stored as a I{qref} as
        converted by L{suds.xsd.qualify}.
    @type type: str

    """

    def __init__(self, root, definitions):
        """
        @param root: An XML root element.
        @type root: L{Element}
        @param definitions: A definitions object.
        @type definitions: L{Definitions}

        """
        NamedObject.__init__(self, root, definitions)
        pmd = Metadata()
        pmd.wrappers = dict(element=repr, type=repr)
        self.__metadata__.__print__ = pmd
        tns = definitions.tns
        self.element = self.__getref("element", tns)
        self.type = self.__getref("type", tns)

    def __getref(self, a, tns):
        """Get the qualified value of attribute named 'a'."""
        s = self.root.get(a)
        if s is not None:
            return qualify(s, self.root, tns)


class Message(NamedObject):
    """
    Represents <message/>.

    @ivar parts: A list of message parts.
    @type parts: [I{Part},...]

    """

    def __init__(self, root, definitions):
        """
        @param root: An XML root element.
        @type root: L{Element}
        @param definitions: A definitions object.
        @type definitions: L{Definitions}

        """
        NamedObject.__init__(self, root, definitions)
        self.parts = []
        for p in root.getChildren("part"):
            part = Part(p, definitions)
            self.parts.append(part)

    def __gt__(self, other):
        return isinstance(other, (Import, Types))


class PortType(NamedObject):
    """
    Represents <portType/>.

    @ivar operations: A list of contained operations.
    @type operations: list

    """

    def __init__(self, root, definitions):
        """
        @param root: An XML root element.
        @type root: L{Element}
        @param definitions: A definitions object.
        @type definitions: L{Definitions}

        """
        NamedObject.__init__(self, root, definitions)
        self.operations = {}
        for c in root.getChildren("operation"):
            op = Facade("Operation")
            op.name = c.get("name")
            op.tns = definitions.tns
            input = c.getChild("input")
            if input is None:
                op.input = None
            else:
                op.input = input.get("message")
            output = c.getChild("output")
            if output is None:
                op.output = None
            else:
                op.output = output.get("message")
            faults = []
            for fault in c.getChildren("fault"):
                f = Facade("Fault")
                f.name = fault.get("name")
                f.message = fault.get("message")
                faults.append(f)
            op.faults = faults
            self.operations[op.name] = op

    def do_resolve(self, definitions):
        """
        Resolve named references to other WSDL objects.

        @param definitions: A definitions object.
        @type definitions: L{Definitions}

        """
        for op in self.operations.values():
            if op.input is None:
                op.input = Message(Element("no-input"), definitions)
            else:
                qref = qualify(op.input, self.root, definitions.tns)
                msg = definitions.messages.get(qref)
                if msg is None:
                    raise Exception("msg '%s', not-found" % (op.input,))
                op.input = msg
            if op.output is None:
                op.output = Message(Element("no-output"), definitions)
            else:
                qref = qualify(op.output, self.root, definitions.tns)
                msg = definitions.messages.get(qref)
                if msg is None:
                    raise Exception("msg '%s', not-found" % (op.output,))
                op.output = msg
            for f in op.faults:
                qref = qualify(f.message, self.root, definitions.tns)
                msg = definitions.messages.get(qref)
                if msg is None:
                    raise Exception("msg '%s', not-found" % (f.message,))
                f.message = msg

    def operation(self, name):
        """
        Shortcut used to get a contained operation by name.

        @param name: An operation name.
        @type name: str
        @return: The named operation.
        @rtype: Operation
        @raise L{MethodNotFound}: When not found.

        """
        try:
            return self.operations[name]
        except Exception, e:
            raise MethodNotFound(name)

    def __gt__(self, other):
        return isinstance(other, (Import, Types, Message))


class Binding(NamedObject):
    """
    Represents <binding/>.

    @ivar operations: A list of contained operations.
    @type operations: list

    """

    def __init__(self, root, definitions):
        """
        @param root: An XML root element.
        @type root: L{Element}
        @param definitions: A definitions object.
        @type definitions: L{Definitions}

        """
        NamedObject.__init__(self, root, definitions)
        self.operations = {}
        self.type = root.get("type")
        sr = self.soaproot()
        if sr is None:
            self.soap = None
            log.debug("binding: '%s' not a SOAP binding", self.name)
            return
        soap = Facade("soap")
        self.soap = soap
        self.soap.style = sr.get("style", default="document")
        self.add_operations(self.root, definitions)

    def soaproot(self):
        """Get the soap:binding."""
        for ns in (soapns, soap12ns):
            sr = self.root.getChild("binding", ns=ns)
            if sr is not None:
                return sr

    def add_operations(self, root, definitions):
        """Add <operation/> children."""
        dsop = Element("operation", ns=soapns)
        for c in root.getChildren("operation"):
            op = Facade("Operation")
            op.name = c.get("name")
            sop = c.getChild("operation", default=dsop)
            soap = Facade("soap")
            soap.action = '"%s"' % (sop.get("soapAction", default=""),)
            soap.style = sop.get("style", default=self.soap.style)
            soap.input = Facade("Input")
            soap.input.body = Facade("Body")
            soap.input.headers = []
            soap.output = Facade("Output")
            soap.output.body = Facade("Body")
            soap.output.headers = []
            op.soap = soap
            input = c.getChild("input")
            if input is None:
                input = Element("input", ns=wsdlns)
            body = input.getChild("body")
            self.body(definitions, soap.input.body, body)
            for header in input.getChildren("header"):
                self.header(definitions, soap.input, header)
            output = c.getChild("output")
            if output is None:
                output = Element("output", ns=wsdlns)
            body = output.getChild("body")
            self.body(definitions, soap.output.body, body)
            for header in output.getChildren("header"):
                self.header(definitions, soap.output, header)
            faults = []
            for fault in c.getChildren("fault"):
                sf = fault.getChild("fault")
                if sf is None:
                    continue
                fn = fault.get("name")
                f = Facade("Fault")
                f.name = sf.get("name", default=fn)
                f.use = sf.get("use", default="literal")
                faults.append(f)
            soap.faults = faults
            self.operations[op.name] = op

    def body(self, definitions, body, root):
        """Add the input/output body properties."""
        if root is None:
            body.use = "literal"
            body.namespace = definitions.tns
            body.parts = ()
            return
        parts = root.get("parts")
        if parts is None:
            body.parts = ()
        else:
            body.parts = re.split("[\s,]", parts)
        body.use = root.get("use", default="literal")
        ns = root.get("namespace")
        if ns is None:
            body.namespace = definitions.tns
        else:
            prefix = root.findPrefix(ns, "b0")
            body.namespace = (prefix, ns)

    def header(self, definitions, parent, root):
        """Add the input/output header properties."""
        if root is None:
            return
        header = Facade("Header")
        parent.headers.append(header)
        header.use = root.get("use", default="literal")
        ns = root.get("namespace")
        if ns is None:
            header.namespace = definitions.tns
        else:
            prefix = root.findPrefix(ns, "h0")
            header.namespace = (prefix, ns)
        msg = root.get("message")
        if msg is not None:
            header.message = msg
        part = root.get("part")
        if part is not None:
            header.part = part

    def do_resolve(self, definitions):
        """
        Resolve named references to other WSDL objects. This includes
        cross-linking information (from) the portType (to) the I{SOAP} protocol
        information on the binding for each operation.

        @param definitions: A definitions object.
        @type definitions: L{Definitions}

        """
        self.__resolveport(definitions)
        for op in self.operations.values():
            self.__resolvesoapbody(definitions, op)
            self.__resolveheaders(definitions, op)
            self.__resolvefaults(definitions, op)

    def __resolveport(self, definitions):
        """
        Resolve port_type reference.

        @param definitions: A definitions object.
        @type definitions: L{Definitions}

        """
        ref = qualify(self.type, self.root, definitions.tns)
        port_type = definitions.port_types.get(ref)
        if port_type is None:
            raise Exception("portType '%s', not-found" % (self.type,))
        # Later on we will require access to the message data referenced by
        # this port_type instance, and in order for those data references to be
        # available, port_type first needs to dereference its message
        # identification string. The only scenario where the port_type might
        # possibly not have already resolved its references, and where this
        # explicit resolve() call is required, is if we are dealing with a
        # recursive WSDL import chain.
        port_type.resolve(definitions)
        self.type = port_type

    def __resolvesoapbody(self, definitions, op):
        """
        Resolve SOAP body I{message} parts by cross-referencing with operation
        defined in port type.

        @param definitions: A definitions object.
        @type definitions: L{Definitions}
        @param op: An I{operation} object.
        @type op: I{operation}

        """
        ptop = self.type.operation(op.name)
        if ptop is None:
            raise Exception("operation '%s' not defined in portType" % (
                op.name,))
        soap = op.soap
        parts = soap.input.body.parts
        if parts:
            pts = []
            for p in ptop.input.parts:
                if p.name in parts:
                    pts.append(p)
            soap.input.body.parts = pts
        else:
            soap.input.body.parts = ptop.input.parts
        parts = soap.output.body.parts
        if parts:
            pts = []
            for p in ptop.output.parts:
                if p.name in parts:
                    pts.append(p)
            soap.output.body.parts = pts
        else:
            soap.output.body.parts = ptop.output.parts

    def __resolveheaders(self, definitions, op):
        """
        Resolve SOAP header I{message} references.

        @param definitions: A definitions object.
        @type definitions: L{Definitions}
        @param op: An I{operation} object.
        @type op: I{operation}

        """
        soap = op.soap
        headers = soap.input.headers + soap.output.headers
        for header in headers:
            mn = header.message
            ref = qualify(mn, self.root, definitions.tns)
            message = definitions.messages.get(ref)
            if message is None:
                raise Exception("message '%s', not-found" % (mn,))
            pn = header.part
            for p in message.parts:
                if p.name == pn:
                    header.part = p
                    break
            if pn == header.part:
                raise Exception("message '%s' has not part named '%s'" % (
                    ref, pn))

    def __resolvefaults(self, definitions, op):
        """
        Resolve SOAP fault I{message} references by cross-referencing with
        operations defined in the port type.

        @param definitions: A definitions object.
        @type definitions: L{Definitions}
        @param op: An I{operation} object.
        @type op: I{operation}

        """
        ptop = self.type.operation(op.name)
        if ptop is None:
            raise Exception("operation '%s' not defined in portType" % (
                op.name,))
        soap = op.soap
        for fault in soap.faults:
            for f in ptop.faults:
                if f.name == fault.name:
                    fault.parts = f.message.parts
                    continue
            if hasattr(fault, "parts"):
                continue
            raise Exception("fault '%s' not defined in portType '%s'" % (
                fault.name, self.type.name))

    def operation(self, name):
        """
        Shortcut used to get a contained operation by name.

        @param name: An operation name.
        @type name: str
        @return: The named operation.
        @rtype: Operation
        @raise L{MethodNotFound}: When not found.

        """
        try:
            return self.operations[name]
        except Exception:
            raise MethodNotFound(name)

    def __gt__(self, other):
        return not isinstance(other, Service)


class Port(NamedObject):
    """
    Represents a service port.

    @ivar service: A service.
    @type service: L{Service}
    @ivar binding: A binding name.
    @type binding: str
    @ivar location: The service location (URL).
    @type location: str

    """

    def __init__(self, root, definitions, service):
        """
        @param root: An XML root element.
        @type root: L{Element}
        @param definitions: A definitions object.
        @type definitions: L{Definitions}
        @param service: A service object.
        @type service: L{Service}

        """
        NamedObject.__init__(self, root, definitions)
        self.__service = service
        self.binding = root.get("binding")
        address = root.getChild("address")
        self.location = address is not None and address.get("location")
        self.methods = {}

    def method(self, name):
        """
        Get a method defined in this portType by name.

        @param name: A method name.
        @type name: str
        @return: The requested method object.
        @rtype: I{Method}

        """
        return self.methods.get(name)


class Service(NamedObject):
    """
    Represents <service/>.

    @ivar port: The contained ports.
    @type port: [Port,..]
    @ivar methods: The contained methods for all ports.
    @type methods: [Method,..]

    """

    def __init__(self, root, definitions):
        """
        @param root: An XML root element.
        @type root: L{Element}
        @param definitions: A definitions object.
        @type definitions: L{Definitions}

        """
        NamedObject.__init__(self, root, definitions)
        self.ports = []
        for p in root.getChildren("port"):
            port = Port(p, definitions, self)
            self.ports.append(port)

    def port(self, name):
        """
        Locate a port by name.

        @param name: A port name.
        @type name: str
        @return: The port object.
        @rtype: L{Port}

        """
        for p in self.ports:
            if p.name == name:
                return p

    def setlocation(self, url, names=None):
        """
        Override the invocation location (URL) for service method.

        @param url: A URL location.
        @type url: A URL.
        @param names:  A list of method names. None=ALL
        @type names: [str,..]

        """
        for p in self.ports:
            for m in p.methods.values():
                if names is None or m.name in names:
                    m.location = url

    def do_resolve(self, definitions):
        """
        Resolve named references to other WSDL objects. Ports without SOAP
        bindings are discarded.

        @param definitions: A definitions object.
        @type definitions: L{Definitions}

        """
        filtered = []
        for p in self.ports:
            ref = qualify(p.binding, self.root, definitions.tns)
            binding = definitions.bindings.get(ref)
            if binding is None:
                raise Exception("binding '%s', not-found" % (p.binding,))
            if binding.soap is None:
                log.debug("binding '%s' - not a SOAP binding, discarded",
                    binding.name)
                continue
            # After we have been resolved, our caller will expect that the
            # binding we are referencing has been fully constructed, i.e.
            # resolved, as well. The only scenario where the operations binding
            # might possibly not have already resolved its references, and
            # where this explicit resolve() call is required, is if we are
            # dealing with a recursive WSDL import chain.
            binding.resolve(definitions)
            p.binding = binding
            filtered.append(p)
        self.ports = filtered

    def __gt__(self, other):
        return True


class Factory:
    """
    Simple WSDL object factory.

    @cvar tags: Dictionary of tag-->constructor mappings.
    @type tags: dict

    """

    tags = {
        "import": Import,
        "types": Types,
        "message": Message,
        "portType": PortType,
        "binding": Binding,
        "service": Service}

    @classmethod
    def create(cls, root, definitions):
        """
        Create an object based on the root tag name.

        @param root: An XML root element.
        @type root: L{Element}
        @param definitions: A definitions object.
        @type definitions: L{Definitions}
        @return: The created object.
        @rtype: L{WObject}

        """
        fn = cls.tags.get(root.name)
        if fn is not None:
            return fn(root, definitions)