xmlrpc0.3/ 40755 452 144 0 7271050333 11027 5ustar ericusersxmlrpc0.3/CHANGES100644 452 144 607 7271047751 12114 0ustar ericusers4-20-2001: -can handle lines ending with \r\n (windows) -xmlrpc::call can be in a catch statement and it will catch errors (had a problem with catching fileevent errors that get raised in the background) -fixed the test example to call the right function 3-15-2001: -fixed the case where the non-blocking read call reached EOF prematurely -added "catches" around the close of socket calls xmlrpc0.3/INSTALL100644 452 144 1412 7271050073 12154 0ustar ericusersTcl searches for packages from the auto_path variable. To see what this is currently set to, start tclsh and enter: puts $auto_path On my system, it prints: /usr/lib/tcl8.0 /usr/lib In any of the directories in $auto_path, type: tar -zxf xmlrpctcl.gz Note: You may need to be root to do this. This will create a directory called xmlrpc0.3 Then start tclsh again, and type: pkg_mkIndex directory where directory is the full path to the xmlrpc0.3 directory just created. Inside xmlrpc0.3, you should now see a "pkgIndex.tcl" file. If all is well, in a tclsh you should now be able to type: package require xmlrpc Documentation: Documentation can be found in the source(xmlrpc.tcl). Samples: To try the samples provided, just start testserver.tcl and then run testclient.tcl. xmlrpc0.3/gpl.txt100644 452 144 43131 7254170165 12500 0ustar ericusers GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 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 General Public License for more details. You should have received a copy of the GNU 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 Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. xmlrpc0.3/testclient.tcl100755 452 144 302 7271047760 13776 0ustar ericusers#!/usr/bin/env tclsh package require xmlrpc if {[catch {set res [xmlrpc::call "http://localhost:5555" "test" {{int 1} {string b}}]}]} { puts "xmlrpc call failed" } else { puts "res: $res." } xmlrpc0.3/testserver.tcl100755 452 144 177 7271047762 14042 0ustar ericusers#!/usr/bin/env tclsh package require xmlrpc xmlrpc::serve 5555 proc test {a b} { return [list string $a$b] } vwait forever xmlrpc0.3/xmlrpc.tcl100644 452 144 51062 7271050015 13156 0ustar ericusers# xmlrpc0.3 # Written by Eric Yeh # # Server API: # xmlrpc::serve # Note: all callable functions should be defined in the global scope # # Client API: # xmlrpc::call url methodName params # url is of the form "http://hostname:port" # methodName is the name of the method to call # and params is a list of arguments to the method # where each argument is a "typed tcl" value defined below # xmlrpc::buildRequest # return an XML-RPC client request # xmlrpc::marshall # return a marshalled "typed tcl" value # xmlrpc::unmarshall # return an unmarshalled "typed tcl" value # xmlrpc::assoc # return a cons of a list if the key matches # # Typed Tcl values: # Because Tcl has no types for variables, all values will be represented # as a 2 element tuple of the form: # {type, value} where value is the original value # and type is a string describing its type. # Valid types (case sensitive, must be lowercase): # int # boolean # string # double # dateTime.iso8601 # base64 # struct # array # Note: # When marshalling dictionaries(tcl arrays), tcl has no # way of creating unnamed dictionaries. Therefore, # the way to use a dictionary is to create it as normal, # and refer to its name in the "tcl type". # For example: # set dict(first) {string eric} # xmlrpc::marshall {struct dict} # # the marshall procedure will attempt to "find" dict # using upvar(yuck!) and checking the global scope. # # Unmarshalling of a dictionary results in a 2 element # list of the form (remaining, alist) # where remaining is unused marshalled data (should be empty) # and alist is an A-list. # An A-list has the form: # {key, datum} where key is the key and datum is its value. # The method "assoc" is provided to access information from # this data structure. It behaves like the LISP assoc, in that # it will return the (key, datum) pair if a match is found. # TODO: # -currently server functions can't return dictionaries # -add more error handling # -Check for [{}] in unmarshalling # -Empty dictionaries package provide xmlrpc 0.3 namespace eval xmlrpc { namespace export call buildRequest marshall unmarshall assoc namespace export serve variable READSIZE 4096; # read size variable WS "\[ |\n|\t\|\r]"; # WhiteSpace variable W "\[^ |\n|\t\]"; # a word with no spaces variable DIGIT "\[0-9\]"; # Digit variable response ""; # response to return variable acceptfd ""; # socket to listen on variable DEBUG 1; # debug } # Given a port, create a new socket # and start listening on it # proc xmlrpc::serve {port} { variable acceptfd set acceptfd [socket -server xmlrpc::serveOnce $port] } # Accept a new connection # proc xmlrpc::serveOnce {sock addr port} { variable READSIZE debug "in serveOnce: addr: $addr" debug "in serveOnce: port: $port" fconfigure $sock -translation {lf lf} -buffersize $READSIZE fconfigure $sock -blocking off fileevent $sock readable [list xmlrpc::doRequest $sock] } # Given a socket, # Handle an XML-RPC request # proc xmlrpc::doRequest {sock} { variable WS set res [readHeader $sock] set headerStatus [lindex $res 0]; # Header + Status set body [lindex $res 1]; # Body, if any set RE "\[^\n\]+\n(.*)" if {![regexp $RE $headerStatus {} header]} { return [errReturn "Malformed Request"] } set body [getBody $sock $header $body] set RE "<\?xml.version=."; # xml version append RE "\[^\?\]+.\?>$WS*"; # version number append RE "$WS*"; # methodCall tag append RE ""; # methodName tag append RE "(\[a-zA-Z0-9_:\/\\.\]+)"; # method Name append RE "$WS*"; # end methodName tag append RE "(.*)"; # parameters, if any append RE ".*"; # end methodCall tag if {![regexp $RE $body {} mname params]} { return [errReturn "Malformed methodCall"] } set args {} set param [string range $params 8 end] set param [string trim $param] while {[string range $param 0 6] == ""} { set param [string range $param 7 end] set param [string trim $param] set res [unmarshall $param] set param [lindex $res 0] set el [lindex $res 1] lappend args $el if {[string range $param 0 7] != ""} { return [errReturn "Invalid End Param"] } set param [string range $param 8 end] set param [string trim $param] } if {$param != ""} { return [errReturn "Invalid End Params"] } if {[catch {set result [eval ::$mname $args]}]} { set response [buildFault 100 "eval() failed"] } else { set response [buildResponse $result] } debug "in doRequest: response:\n$response" puts -nonewline $sock $response flush $sock catch {close $sock} } # Given a "typed tcl" value, # build an XML-RPC response # proc buildResponse {result} { # build the body set body "\n" append body "\n" append body "\t\n" append body "\t\t\n" append body [xmlrpc::marshall $result 3 2] append body "\n\t\t\n" append body "\t\n" append body "\n" set lenbod [string length $body] # build the header set header "HTTP/1.1 200 OK\n" append header "Content-Type: text/xml\n" append header "Content-length: $lenbod\n" set response "$header\n$body" return $response #return [string trim $response] } # Given an error code (integer) # and an errmsg (string) # build an XML-RPC fault # proc buildFault {errcode errmsg} { set err(faultCode) [list int $errcode] set err(faultString) [list string $errmsg] # build the body set body "\n" append body "\n" append body "\t\n" append body [xmlrpc::marshall {struct err} 2] append body "\t\n" append body "\n" set lenbod [string length $body] # build the header set header "HTTP/1.1 200 OK\n" append header "Content-Type: text/xml\n" append header "Content-length: $lenbod\n" set response "$header\n$body" return [string trim $response] } # send an XML-RPC request # proc xmlrpc::call {url methodName params {ntabs 4} {distance 3}} { variable READSIZE variable response global readdone global xmlcall set readdone 0 set xmlcall 1 set RE {http://([^:]+):([0-9]+)} if {![regexp $RE $url {} host port]} { return [errReturn "Malformed URL"] } set sock [socket $host $port] fconfigure $sock -translation {lf lf} -buffersize $READSIZE fconfigure $sock -blocking off if {[catch {set request [buildRequest $methodName $params $ntabs $distance]}]} { return } puts -nonewline $sock $request flush $sock fileevent $sock readable [list xmlrpc::getResponse $sock] vwait readdone catch {close $sock} if {$readdone > 0} { return $response } else { return [errReturn "xmlrpc::call failed"] } } # Given a socket to read on, # get and parse the response from the server # proc xmlrpc::getResponse {sock} { variable response global readdone set res [readHeader $sock] set headerStatus [lindex $res 0]; # Header + Status set body [lindex $res 1]; # Body, if any set header [parseHTTPCode $headerStatus] set body [getBody $sock $header $body] set response [parseResponse $body] set readdone 1 } # Given a socket to read on, # a string of header information # and a string, body, # return a string representing the entire body # proc xmlrpc::getBody {sock header body} { set res [parseHTTPHeaders $header] set headersl [lindex $res 1]; # A-list of headers set expLenl [assoc "Content-Length" $headersl] if {$expLenl == {}} { set expLenl [assoc "Content-length" $headersl] if {$expLenl == {}} { return [errReturn "No Content-length found"] } } set expLen [lindex $expLenl 1] set body [readBody $body $expLen $sock] return $body } # Given a socket to read on, # Return a 2 element list of the form: # {header, body} where both are strings # Note: header will include the first line which is the status # proc xmlrpc::readHeader {sock} { set buffer "" while {1} { if {[catch {set buff [nbRead $sock]}]} { return [errReturn "Premature eof"] } append buffer $buff set nindex [string first "\n\n" $buffer] if {$nindex > 0} { break } set bindex [string first "\r\n\r\n" $buffer] if {$bindex > 0} { break } } if {$nindex > 0} { set header [string range $buffer 0 [expr $nindex - 1]] set body [string range $buffer [expr $nindex + 2] end] } elseif {$bindex > 0} { set header [string range $buffer 0 [expr $bindex - 1]] set body [string range $buffer [expr $bindex + 4] end] } return [list $header $body] } # Given the body buffer, # the number of bytes expected in the body (Content-Length) # and a socket to read on, # return the entire body buffer # proc xmlrpc::readBody {body expLen sock} { set newbody $body while {1} { if {[catch {set buff [nbRead $sock]}]} { return [errReturn "Premature eof"] } append newbody $buff set bodLen [string length $newbody] if {$bodLen == $expLen} { break } elseif {$bodLen > $expLen} { return [errReturn "Content-length:$expLen does not match Body Length:$bodLen"] } } return $newbody } # Given a string, str, # check the HTTP status # and return the unused portion of str # proc xmlrpc::parseHTTPCode {str} { variable DIGIT set RE "HTTP/"; # HTTP message append RE "($DIGIT+\\.*$DIGIT*)."; # version append RE "($DIGIT+)."; # status code append RE "(\[^\n\]+)\n(.*)"; # status message if {![regexp $RE $str {} vern status code rest]} { return [errReturn "Unrecognized HTTP code:\n$str"] } if {$status != "200"} { return [errReturn "Bad HTTP status: $status"] } return $rest } # Given a string, str, # return a 2 element list of the form: # {remaining, alist} # where remaining is the unused portion of str # and alist is an A-list of header information # proc xmlrpc::parseHTTPHeaders {str} { set headers {} set remain {} set remainp 0 set RE {([^:]+):(.*)} set parts [split $str "\n"] foreach {part} $parts { if {$part == "" && !$remainp} { set remainp 1 continue } if {$remainp} { lappend remain $part continue } if {![regexp $RE $part {} key value]} { return [errReturn "Unrecognized HTTP Header format: $part"] } set value [string trim $value] lappend headers [list $key $value] } set rest [join $remain "\n"] return [list $rest $headers] } # Given a string, str # parse the response from the server # returning the unmarshalled data # proc xmlrpc::parseResponse {str} { variable WS set RE "<\?xml.version=."; # xml version append RE "(\[^\?\]+).\?>$WS*"; # version number append RE "$WS*"; # method response tag append RE "$WS*"; # params tag append RE "$WS*"; # param tag append RE "(.*)"; # value append RE "$WS*"; # end param tag append RE "$WS*"; # end params tag append RE ""; # end method response tag if {![regexp $RE $str {} vern value]} { set RE "<\?xml.version=."; # xml version append RE "(\[^\?\]+).\?>$WS*"; # version number append RE "$WS*"; # method response tag append RE "$WS*"; # fault tag append RE "(.*)$WS*"; # fault values append RE "$WS*"; # end fault tag append RE ""; # end method response tag if {![regexp $RE $str {} vern value]} { return [errReturn "Unrecognized response from server"] } } set result [unmarshall $value] return $result } # Given a non-blocking file descriptor, fd # do a read # proc xmlrpc::nbRead {fd} { variable READSIZE fileevent $fd readable "" set buffer "" while {1} { if {[eof $fd]} { catch {close $fd} break } set temp [read $fd $READSIZE] if {$temp == ""} { break } append buffer $temp } return $buffer } # Given a methodName, # and a list of parameters, # return an XML-RPC request # proc xmlrpc::buildRequest {methodName params {ntabs 4} {distance 2}} { # build the body set body "\n" append body "\n" append body "\t$methodName\n" if {$params != {}} { append body "\t\t\n" foreach {param} $params { append body "\t\t\t\n" append body [xmlrpc::marshall $param $ntabs $distance] append body "\n\t\t\t\n" } append body "\t\t\n" } append body "\n" set lenbod [string length $body] # build the header set header "POST /RPC2 HTTP/1.0\n" append header "Content-Type: text/xml\n" append header "Content-length: $lenbod\n" set request "$header\n$body" return $request } # Given a "typed tcl" value # return the marshalled representation # proc xmlrpc::marshall {param {ntabs 0} {distance 1}} { if {![validParam $param]} { return [errReturn "Malformed Parameter: $param"] } set strtabs "" for {set x 0} {$x < $ntabs} {incr x} { append strtabs "\t" } set type [lindex $param 0] set val [lindex $param 1] if {$type == "int"} { return "$strtabs$val" } elseif {$type == "i4"} { return "$strtabs$val" } elseif {$type == "boolean"} { return "$strtabs$val" } elseif {$type == "string"} { return "$strtabs$val" } elseif {$type == "double"} { return "$strtabs$val" } elseif {$type == "dateTime.iso8601"} { return "$strtabs$val" } elseif {$type == "base64"} { return "$strtabs$val" } elseif {$type == "struct"} { # get the original caller's scope upvar $distance $val dict # try the global scope if {![array exists dict]} { upvar #0 $val dict } set str "$strtabs\n" append str "$strtabs\t\n" foreach {k v} [array get dict] { append str "$strtabs\t\t\n" append str "$strtabs\t\t\t$k\n" append str [marshall $v [expr $ntabs + 3] [expr $distance + 1]] append str "\n$strtabs\t\t\n" } append str "$strtabs\t\n" append str "$strtabs\n" return $str } elseif {$type == "array"} { set str "$strtabs\n" append str "$strtabs\t\n" append str "$strtabs\t\t\n" foreach el $val { append str [marshall $el [expr $ntabs + 3] [expr $distance + 1]] append str "\n" } append str "$strtabs\t\t\n" append str "$strtabs\t\n" append str "$strtabs\n" return $str } else { return [errReturn "Unknown type: $type"] } } # Given a value param, # return 1 if it a valid parameter # return 0 if not # A valid parameter is a 2 element tuple # proc xmlrpc::validParam {param} { if {[llength $param] != 2} { return 0 } return 1 } # Given a marshalled value, # unmarshall it and return it # proc xmlrpc::unmarshall {str} { set str [string trim $str] if {[string range $str 0 6] != ""} { return [errReturn "Bad value tag"] } set str [string range $str 7 end] set str [string trimleft $str] set RE {<([^>]+)>} if {![regexp $RE $str {} btag]} { return [errReturn "No beginning tag found: $str"] } if {$btag == "int" || $btag == "i4"} { set res [umInt $str] } elseif {$btag== "boolean"} { set res [umBool $str] } elseif {$btag == "string"} { set res [umString $str] } elseif {$btag == "double"} { set res [umDouble $str] } elseif {$btag == "dateTime.iso8601"} { set res [umDateTime $str] } elseif {$btag == "base64"} { set res [umBase64 $str] } elseif {$btag == "array"} { set res [umArray $str] } elseif {$btag == "struct"} { set res [umStruct $str] } else { return [errReturn "Unknown type: $str"] } set rest [lindex $res 0] set val [lindex $res 1] if {[string range $rest 0 7] != ""} { return [errReturn "Invalid close of value tag"] } set rest [string range $rest 8 end] set rest [string trim $rest] return [list $rest $val] } proc xmlrpc::umInt {str} { variable WS variable DIGIT set RE "<(int|i4)>$WS*"; # int tag append RE "(-*)($DIGIT+)$WS*"; # int value append RE "$WS*"; # end int tag append RE "(.*)"; # leftover if {![regexp $RE $str {} tag negp digits engtag rest]} { return [errReturn "Invalid Integer"] } if {$negp != ""} { set digits [expr -1 * $digits] } else { set digits [expr 1 * $digits] } set rest [string trim $rest] return [list $rest $digits] } proc xmlrpc::umBool {str} { variable WS set RE "$WS*"; # boolean tag append RE "(0|1)$WS*"; # boolean value append RE "$WS*"; # end boolean tag append RE "(.*)"; # leftover if {![regexp $RE $str {} bool rest]} { return [errReturn "Invalid Boolean"] } set rest [string trim $rest] return [list $rest $bool] } proc xmlrpc::umString {str} { variable WS set RE ""; # string tag append RE "(\[^<\]*)"; # string value append RE "$WS*"; # end string tag append RE "(.*)"; # leftover if {![regexp $RE $str {} s rest]} { return [errReturn "Invalid String"] } set rest [string trim $rest] return [list $rest $s] } proc xmlrpc::umDouble {str} { variable WS variable DIGIT set RE "$WS*"; # double tag append RE "(-*)($DIGIT*\.?$DIGIT*)$WS*"; # double value append RE "$WS*"; # end double tag append RE "(.*)"; # leftover if {![regexp $RE $str {} negp d rest]} { return [errReturn "Invalid Double"] } if {$negp != ""} { set d [expr -1 * $d] } else { set d [expr 1 * $d] } set rest [string trim $rest] return [list $rest $d] } proc xmlrpc::umDateTime {str} { variable WS variable DIGIT set RE "$WS*"; # dateTime tag append RE "($DIGIT+T$DIGIT+:$DIGIT+:$DIGIT+)$WS*"; # dateTime value append RE "$WS*"; # end string tag append RE "(.*)"; # leftover if {![regexp $RE $str {} dateTime rest]} { return [errReturn "Invalid DateTime"] } set rest [string trim $rest] return [list $rest $dateTime] } proc xmlrpc::umBase64 {str} { variable WS set RE ""; # string tag append RE "(\[^<\]*)"; # string value append RE "$WS*"; # end string tag append RE "(.*)"; # leftover if {![regexp $RE $str {} s rest]} { return [errReturn "Invalid Base64"] } set rest [string trim $rest] return [list $rest $s] } proc xmlrpc::umArray {str} { variable WS set RE "$WS*"; # array tag append RE "$WS*"; # data tag append RE "(.*)"; # leftover if {![regexp $RE $str {} rest]} { return [errReturn "Invalid Array"] } set l {} while {[string range $rest 0 6] == ""} { set res [unmarshall $rest] set rest [lindex $res 0] set el [lindex $res 1] lappend l $el } set REAREND "$WS*"; # end data tag append REAREND "$WS*"; # end array tag append REAREND "(.*)"; # leftover if {![regexp $REAREND $rest {} leftover]} { return [errReturn "Invalid End Array"] } return [list $leftover $l] } proc xmlrpc::umStruct {str} { variable WS variable W if {[string range $str 0 7] != ""} { return [errReturn "Invalid Struct"] } set RE "$WS*"; # name tag append RE "($W+)$WS*"; # key append RE "$WS*"; # end name tag append RE "(.*)"; # value tag set l {} set str [string range $str 8 end] set str [string trim $str] while {[string range $str 0 7] == ""} { set str [string range $str 8 end] set str [string trim $str] if {![regexp $RE $str {} key val]} { return [errReturn "Invalid Struct Member"] } set res [unmarshall $val] set str [lindex $res 0] set el [lindex $res 1] lappend l [list $key $el] if {[string range $str 0 8] != ""} { return [errReturn "Invalid End Struct Member"] } set str [string range $str 9 end] set str [string trim $str] } if {[string range $str 0 8] != ""} { return [errReturn "Invalid End Struct"] } set str [string range $str 9 end] set str [string trim $str] return [list $str $l] } # Given a key, and a list of elements where each element is of the form: # {key, datum}, return {key, datum} if the requested key matches # a key in the list. # Returns the first match found in the list. # Return {} on failure # proc xmlrpc::assoc {key list} { foreach {cons} $list { set tkey [lindex $cons 0] if {$key == $tkey} { return $cons } } return {} } proc xmlrpc::warn {msg} { puts stderr $msg } proc xmlrpc::debug {msg} { variable DEBUG if {$DEBUG} { puts "$msg" } } proc xmlrpc::errReturn {msg} { warn $msg return -code error } proc xmlrpc::test {} { set person(first) {string "eric m"} set person(last) {string yeh} set employed(programmer) {struct person} #set xml [marshall {struct employed}] #set w [list {int 1}] #set q [list "array \{$w\}" {int 2} {string eric}] #puts [marshall "array \{$q\}"] #set xml [marshall {array {{int 1} {string {hello everybody}}}}] set xml [marshall {struct person}] debug "xml:\n$xml" set data [unmarshall $xml] debug "data: $data" set data [lindex $data 1] debug "data: $data" puts [assoc "first" $data] } proc bgerror {error} { global xmlcall if {$xmlcall} { global readdone set readdone -1 set xmlcall 0 } } #xmlrpc::test