Mercurial > cpython-lru_cache-weakref
annotate Lib/SimpleXMLRPCServer.py @ 32527:0da660e05e69 legacy-trunk
"#if WITH_THREAD" is incorrect; must be #ifdef instead; WITH_THREAD
isn't always set to an integer value when it's defined.
| author | Tim Peters <tim.peters@gmail.com> |
|---|---|
| date | Wed, 07 Jul 2004 20:42:07 +0000 |
| parents | 19bb1b2fb233 |
| children | 89faacd9ec76 |
| rev | line source |
|---|---|
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
1 """Simple XML-RPC Server. |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
2 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
3 This module can be used to create simple XML-RPC servers |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
4 by creating a server and either installing functions, a |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
5 class instance, or by extending the SimpleXMLRPCServer |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
6 class. |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
7 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
8 It can also be used to handle XML-RPC requests in a CGI |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
9 environment using CGIXMLRPCRequestHandler. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
10 |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
11 A list of possible usage patterns follows: |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
12 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
13 1. Install functions: |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
14 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
15 server = SimpleXMLRPCServer(("localhost", 8000)) |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
16 server.register_function(pow) |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
17 server.register_function(lambda x,y: x+y, 'add') |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
18 server.serve_forever() |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
19 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
20 2. Install an instance: |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
21 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
22 class MyFuncs: |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
23 def __init__(self): |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
24 # make all of the string functions available through |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
25 # string.func_name |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
26 import string |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
27 self.string = string |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
28 def _listMethods(self): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
29 # implement this method so that system.listMethods |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
30 # knows to advertise the strings methods |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
31 return list_public_methods(self) + \ |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
32 ['string.' + method for method in list_public_methods(self.string)] |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
33 def pow(self, x, y): return pow(x, y) |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
34 def add(self, x, y) : return x + y |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
35 |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
36 server = SimpleXMLRPCServer(("localhost", 8000)) |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
37 server.register_introspection_functions() |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
38 server.register_instance(MyFuncs()) |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
39 server.serve_forever() |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
40 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
41 3. Install an instance with custom dispatch method: |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
42 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
43 class Math: |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
44 def _listMethods(self): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
45 # this method must be present for system.listMethods |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
46 # to work |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
47 return ['add', 'pow'] |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
48 def _methodHelp(self, method): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
49 # this method must be present for system.methodHelp |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
50 # to work |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
51 if method == 'add': |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
52 return "add(2,3) => 5" |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
53 elif method == 'pow': |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
54 return "pow(x, y[, z]) => number" |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
55 else: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
56 # By convention, return empty |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
57 # string if no help is available |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
58 return "" |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
59 def _dispatch(self, method, params): |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
60 if method == 'pow': |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
61 return pow(*params) |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
62 elif method == 'add': |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
63 return params[0] + params[1] |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
64 else: |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
65 raise 'bad method' |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
66 |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
67 server = SimpleXMLRPCServer(("localhost", 8000)) |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
68 server.register_introspection_functions() |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
69 server.register_instance(Math()) |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
70 server.serve_forever() |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
71 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
72 4. Subclass SimpleXMLRPCServer: |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
73 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
74 class MathServer(SimpleXMLRPCServer): |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
75 def _dispatch(self, method, params): |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
76 try: |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
77 # We are forcing the 'export_' prefix on methods that are |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
78 # callable through XML-RPC to prevent potential security |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
79 # problems |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
80 func = getattr(self, 'export_' + method) |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
81 except AttributeError: |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
82 raise Exception('method "%s" is not supported' % method) |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
83 else: |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
84 return func(*params) |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
85 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
86 def export_add(self, x, y): |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
87 return x + y |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
88 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
89 server = MathServer(("localhost", 8000)) |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
90 server.serve_forever() |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
91 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
92 5. CGI script: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
93 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
94 server = CGIXMLRPCRequestHandler() |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
95 server.register_function(pow) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
96 server.handle_request() |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
97 """ |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
98 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
99 # Written by Brian Quinlan (brian@sweetapp.com). |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
100 # Based on code written by Fredrik Lundh. |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
101 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
102 import xmlrpclib |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
103 from xmlrpclib import Fault |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
104 import SocketServer |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
105 import BaseHTTPServer |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
106 import sys |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
107 import os |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
108 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
109 def resolve_dotted_attribute(obj, attr): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
110 """resolve_dotted_attribute(a, 'b.c.d') => a.b.c.d |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
111 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
112 Resolves a dotted attribute name to an object. Raises |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
113 an AttributeError if any attribute in the chain starts with a '_'. |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
114 """ |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
115 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
116 for i in attr.split('.'): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
117 if i.startswith('_'): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
118 raise AttributeError( |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
119 'attempt to access private attribute "%s"' % i |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
120 ) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
121 else: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
122 obj = getattr(obj,i) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
123 return obj |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
124 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
125 def list_public_methods(obj): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
126 """Returns a list of attribute strings, found in the specified |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
127 object, which represent callable attributes""" |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
128 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
129 return [member for member in dir(obj) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
130 if not member.startswith('_') and |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
131 callable(getattr(obj, member))] |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
132 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
133 def remove_duplicates(lst): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
134 """remove_duplicates([2,2,2,1,3,3]) => [3,1,2] |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
135 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
136 Returns a copy of a list without duplicates. Every list |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
137 item must be hashable and the order of the items in the |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
138 resulting list is not defined. |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
139 """ |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
140 u = {} |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
141 for x in lst: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
142 u[x] = 1 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
143 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
144 return u.keys() |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
145 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
146 class SimpleXMLRPCDispatcher: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
147 """Mix-in class that dispatches XML-RPC requests. |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
148 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
149 This class is used to register XML-RPC method handlers |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
150 and then to dispatch them. There should never be any |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
151 reason to instantiate this class directly. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
152 """ |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
153 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
154 def __init__(self): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
155 self.funcs = {} |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
156 self.instance = None |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
157 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
158 def register_instance(self, instance): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
159 """Registers an instance to respond to XML-RPC requests. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
160 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
161 Only one instance can be installed at a time. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
162 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
163 If the registered instance has a _dispatch method then that |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
164 method will be called with the name of the XML-RPC method and |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
165 it's parameters as a tuple |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
166 e.g. instance._dispatch('add',(2,3)) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
167 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
168 If the registered instance does not have a _dispatch method |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
169 then the instance will be searched to find a matching method |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
170 and, if found, will be called. Methods beginning with an '_' |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
171 are considered private and will not be called by |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
172 SimpleXMLRPCServer. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
173 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
174 If a registered function matches a XML-RPC request, then it |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
175 will be called instead of the registered instance. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
176 """ |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
177 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
178 self.instance = instance |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
179 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
180 def register_function(self, function, name = None): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
181 """Registers a function to respond to XML-RPC requests. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
182 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
183 The optional name argument can be used to set a Unicode name |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
184 for the function. |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
185 """ |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
186 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
187 if name is None: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
188 name = function.__name__ |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
189 self.funcs[name] = function |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
190 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
191 def register_introspection_functions(self): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
192 """Registers the XML-RPC introspection methods in the system |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
193 namespace. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
194 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
195 see http://xmlrpc.usefulinc.com/doc/reserved.html |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
196 """ |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
197 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
198 self.funcs.update({'system.listMethods' : self.system_listMethods, |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
199 'system.methodSignature' : self.system_methodSignature, |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
200 'system.methodHelp' : self.system_methodHelp}) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
201 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
202 def register_multicall_functions(self): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
203 """Registers the XML-RPC multicall method in the system |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
204 namespace. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
205 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
206 see http://www.xmlrpc.com/discuss/msgReader$1208""" |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
207 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
208 self.funcs.update({'system.multicall' : self.system_multicall}) |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
209 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
210 def _marshaled_dispatch(self, data, dispatch_method = None): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
211 """Dispatches an XML-RPC method from marshalled (XML) data. |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
212 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
213 XML-RPC methods are dispatched from the marshalled (XML) data |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
214 using the _dispatch method and the result is returned as |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
215 marshalled data. For backwards compatibility, a dispatch |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
216 function can be provided as an argument (see comment in |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
217 SimpleXMLRPCRequestHandler.do_POST) but overriding the |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
218 existing method through subclassing is the prefered means |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
219 of changing method dispatch behavior. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
220 """ |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
221 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
222 params, method = xmlrpclib.loads(data) |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
223 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
224 # generate response |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
225 try: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
226 if dispatch_method is not None: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
227 response = dispatch_method(method, params) |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
228 else: |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
229 response = self._dispatch(method, params) |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
230 # wrap response in a singleton tuple |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
231 response = (response,) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
232 response = xmlrpclib.dumps(response, methodresponse=1) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
233 except Fault, fault: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
234 response = xmlrpclib.dumps(fault) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
235 except: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
236 # report exception back to server |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
237 response = xmlrpclib.dumps( |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
238 xmlrpclib.Fault(1, "%s:%s" % (sys.exc_type, sys.exc_value)) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
239 ) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
240 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
241 return response |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
242 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
243 def system_listMethods(self): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
244 """system.listMethods() => ['add', 'subtract', 'multiple'] |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
245 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
246 Returns a list of the methods supported by the server.""" |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
247 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
248 methods = self.funcs.keys() |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
249 if self.instance is not None: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
250 # Instance can implement _listMethod to return a list of |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
251 # methods |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
252 if hasattr(self.instance, '_listMethods'): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
253 methods = remove_duplicates( |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
254 methods + self.instance._listMethods() |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
255 ) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
256 # if the instance has a _dispatch method then we |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
257 # don't have enough information to provide a list |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
258 # of methods |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
259 elif not hasattr(self.instance, '_dispatch'): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
260 methods = remove_duplicates( |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
261 methods + list_public_methods(self.instance) |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
262 ) |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
263 methods.sort() |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
264 return methods |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
265 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
266 def system_methodSignature(self, method_name): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
267 """system.methodSignature('add') => [double, int, int] |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
268 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
269 Returns a list describing the signiture of the method. In the |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
270 above example, the add method takes two integers as arguments |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
271 and returns a double result. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
272 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
273 This server does NOT support system.methodSignature.""" |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
274 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
275 # See http://xmlrpc.usefulinc.com/doc/sysmethodsig.html |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
276 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
277 return 'signatures not supported' |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
278 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
279 def system_methodHelp(self, method_name): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
280 """system.methodHelp('add') => "Adds two integers together" |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
281 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
282 Returns a string containing documentation for the specified method.""" |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
283 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
284 method = None |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
285 if self.funcs.has_key(method_name): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
286 method = self.funcs[method_name] |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
287 elif self.instance is not None: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
288 # Instance can implement _methodHelp to return help for a method |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
289 if hasattr(self.instance, '_methodHelp'): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
290 return self.instance._methodHelp(method_name) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
291 # if the instance has a _dispatch method then we |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
292 # don't have enough information to provide help |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
293 elif not hasattr(self.instance, '_dispatch'): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
294 try: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
295 method = resolve_dotted_attribute( |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
296 self.instance, |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
297 method_name |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
298 ) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
299 except AttributeError: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
300 pass |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
301 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
302 # Note that we aren't checking that the method actually |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
303 # be a callable object of some kind |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
304 if method is None: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
305 return "" |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
306 else: |
|
29655
f9b8d4bf08fb
fix problems found by pychecker
Neal Norwitz <nnorwitz@gmail.com>
parents:
28912
diff
changeset
|
307 import pydoc |
|
29659
69619542a916
whitespace normalization
Neal Norwitz <nnorwitz@gmail.com>
parents:
29655
diff
changeset
|
308 return pydoc.getdoc(method) |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
309 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
310 def system_multicall(self, call_list): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
311 """system.multicall([{'methodName': 'add', 'params': [2, 2]}, ...]) => \ |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
312 [[4], ...] |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
313 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
314 Allows the caller to package multiple XML-RPC calls into a single |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
315 request. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
316 |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
317 See http://www.xmlrpc.com/discuss/msgReader$1208 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
318 """ |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
319 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
320 results = [] |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
321 for call in call_list: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
322 method_name = call['methodName'] |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
323 params = call['params'] |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
324 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
325 try: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
326 # XXX A marshalling error in any response will fail the entire |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
327 # multicall. If someone cares they should fix this. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
328 results.append([self._dispatch(method_name, params)]) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
329 except Fault, fault: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
330 results.append( |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
331 {'faultCode' : fault.faultCode, |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
332 'faultString' : fault.faultString} |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
333 ) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
334 except: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
335 results.append( |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
336 {'faultCode' : 1, |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
337 'faultString' : "%s:%s" % (sys.exc_type, sys.exc_value)} |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
338 ) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
339 return results |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
340 |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
341 def _dispatch(self, method, params): |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
342 """Dispatches the XML-RPC method. |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
343 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
344 XML-RPC calls are forwarded to a registered function that |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
345 matches the called XML-RPC method name. If no such function |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
346 exists then the call is forwarded to the registered instance, |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
347 if available. |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
348 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
349 If the registered instance has a _dispatch method then that |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
350 method will be called with the name of the XML-RPC method and |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
351 it's parameters as a tuple |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
352 e.g. instance._dispatch('add',(2,3)) |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
353 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
354 If the registered instance does not have a _dispatch method |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
355 then the instance will be searched to find a matching method |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
356 and, if found, will be called. |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
357 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
358 Methods beginning with an '_' are considered private and will |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
359 not be called. |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
360 """ |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
361 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
362 func = None |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
363 try: |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
364 # check to see if a matching function has been registered |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
365 func = self.funcs[method] |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
366 except KeyError: |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
367 if self.instance is not None: |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
368 # check for a _dispatch method |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
369 if hasattr(self.instance, '_dispatch'): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
370 return self.instance._dispatch(method, params) |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
371 else: |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
372 # call instance method directly |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
373 try: |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
374 func = resolve_dotted_attribute( |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
375 self.instance, |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
376 method |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
377 ) |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
378 except AttributeError: |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
379 pass |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
380 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
381 if func is not None: |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
382 return func(*params) |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
383 else: |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
384 raise Exception('method "%s" is not supported' % method) |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
385 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
386 class SimpleXMLRPCRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
387 """Simple XML-RPC request handler class. |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
388 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
389 Handles all HTTP POST requests and attempts to decode them as |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
390 XML-RPC requests. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
391 """ |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
392 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
393 def do_POST(self): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
394 """Handles the HTTP POST request. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
395 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
396 Attempts to interpret all HTTP POST requests as XML-RPC calls, |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
397 which are forwarded to the server's _dispatch method for handling. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
398 """ |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
399 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
400 try: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
401 # get arguments |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
402 data = self.rfile.read(int(self.headers["content-length"])) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
403 # In previous versions of SimpleXMLRPCServer, _dispatch |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
404 # could be overridden in this class, instead of in |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
405 # SimpleXMLRPCDispatcher. To maintain backwards compatibility, |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
406 # check to see if a subclass implements _dispatch and dispatch |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
407 # using that method if present. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
408 response = self.server._marshaled_dispatch( |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
409 data, getattr(self, '_dispatch', None) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
410 ) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
411 except: # This should only happen if the module is buggy |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
412 # internal error, report as HTTP server error |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
413 self.send_response(500) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
414 self.end_headers() |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
415 else: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
416 # got a valid XML RPC response |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
417 self.send_response(200) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
418 self.send_header("Content-type", "text/xml") |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
419 self.send_header("Content-length", str(len(response))) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
420 self.end_headers() |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
421 self.wfile.write(response) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
422 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
423 # shut down the connection |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
424 self.wfile.flush() |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
425 self.connection.shutdown(1) |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
426 |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
427 def log_request(self, code='-', size='-'): |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
428 """Selectively log an accepted request.""" |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
429 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
430 if self.server.logRequests: |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
431 BaseHTTPServer.BaseHTTPRequestHandler.log_request(self, code, size) |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
432 |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
433 class SimpleXMLRPCServer(SocketServer.TCPServer, |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
434 SimpleXMLRPCDispatcher): |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
435 """Simple XML-RPC server. |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
436 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
437 Simple XML-RPC server that allows functions and a single instance |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
438 to be installed to handle requests. The default implementation |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
439 attempts to dispatch XML-RPC calls to the functions or instance |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
440 installed in the server. Override the _dispatch method inhereted |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
441 from SimpleXMLRPCDispatcher to change this behavior. |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
442 """ |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
443 |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
444 def __init__(self, addr, requestHandler=SimpleXMLRPCRequestHandler, |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
445 logRequests=1): |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
446 self.logRequests = logRequests |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
447 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
448 SimpleXMLRPCDispatcher.__init__(self) |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
449 SocketServer.TCPServer.__init__(self, addr, requestHandler) |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
450 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
451 class CGIXMLRPCRequestHandler(SimpleXMLRPCDispatcher): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
452 """Simple handler for XML-RPC data passed through CGI.""" |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
453 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
454 def __init__(self): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
455 SimpleXMLRPCDispatcher.__init__(self) |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
456 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
457 def handle_xmlrpc(self, request_text): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
458 """Handle a single XML-RPC request""" |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
459 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
460 response = self._marshaled_dispatch(request_text) |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
461 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
462 print 'Content-Type: text/xml' |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
463 print 'Content-Length: %d' % len(response) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
464 print |
|
28912
4ef108f8181f
Patch #727805: Remove extra line ending from CGI responses.
Martin v. Löwis <martin@v.loewis.de>
parents:
27507
diff
changeset
|
465 sys.stdout.write(response) |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
466 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
467 def handle_get(self): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
468 """Handle a single HTTP GET request. |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
469 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
470 Default implementation indicates an error because |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
471 XML-RPC uses the POST method. |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
472 """ |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
473 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
474 code = 400 |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
475 message, explain = \ |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
476 BaseHTTPServer.BaseHTTPRequestHandler.responses[code] |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
477 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
478 response = BaseHTTPServer.DEFAULT_ERROR_MESSAGE % \ |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
479 { |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
480 'code' : code, |
|
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
481 'message' : message, |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
482 'explain' : explain |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
483 } |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
484 print 'Status: %d %s' % (code, message) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
485 print 'Content-Type: text/html' |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
486 print 'Content-Length: %d' % len(response) |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
487 print |
|
29655
f9b8d4bf08fb
fix problems found by pychecker
Neal Norwitz <nnorwitz@gmail.com>
parents:
28912
diff
changeset
|
488 sys.stdout.write(response) |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
489 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
490 def handle_request(self, request_text = None): |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
491 """Handle a single XML-RPC request passed through a CGI post method. |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
492 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
493 If no XML data is given then it is read from stdin. The resulting |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
494 XML-RPC response is printed to stdout along with the correct HTTP |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
495 headers. |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
496 """ |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
497 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
498 if request_text is None and \ |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
499 os.environ.get('REQUEST_METHOD', None) == 'GET': |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
500 self.handle_get() |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
501 else: |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
502 # POST data is normally available through stdin |
|
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
503 if request_text is None: |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
504 request_text = sys.stdin.read() |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
505 |
|
27249
7c34e5bf2e22
Patch #473586: Implement CGIXMLRPCRequestHandler.
Martin v. Löwis <martin@v.loewis.de>
parents:
20174
diff
changeset
|
506 self.handle_xmlrpc(request_text) |
|
27507
d9d57f5f98cd
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
27249
diff
changeset
|
507 |
|
19937
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
508 if __name__ == '__main__': |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
509 server = SimpleXMLRPCServer(("localhost", 8000)) |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
510 server.register_function(pow) |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
511 server.register_function(lambda x,y: x+y, 'add') |
|
896f2d1e2f46
Brian Quinlan's XML-RPC server framework.
Fredrik Lundh <fredrik@pythonware.com>
parents:
diff
changeset
|
512 server.serve_forever() |
