1 This file contains instructions for setting and and configuring the GForge
6 1. Extract the tar file into the root GForge directory. For example, if
7 your root diectory is /usr/share/gforge/www, then
9 cd /usr/share/gforge/www ; tar xvf {tarfile}
11 should work. This will create a soap directory underneath the root directory
12 and there should be 5 files plus one sub-directory:
14 README - this README file
15 SoapAPI.php - the PHP file that defines the SOAP functions
16 nusoap.php - the SOAP implementation provided by NuSOAP people (0.65)
17 pre_soap.php - The includes from GForge directory for access to GForge system
18 I couldn't use (and didn't want to use) the pre.php file
19 SoapAPI.wsdl - There is a bug in the nusoap WSDL generator so this file was
20 hand created for consumption by WSDL enabled tools (like Visual
22 api - The directory containing the TCL scripts. Currently one very short
23 but functional TCL script is provided to get you started
24 api/apiInit.tcl - The TCL script
26 Once these are set up, you can use the WSDL file to connect and test two of
27 the SOAP functions. One function is a simple string echo engine that echoes
28 back whatever you send it plus some extra text. The other function defined
29 in the WSDL file gives access to the User database in GForge. You pass in
30 an array of strings to the 'user' function and it will return an array of
31 strings back for each user in the input array. For example, passing in
32 the array 'bob','ted','mary' will return the user objects for these 3 users.
33 If you pass in an empty list, you will get back all users.
39 The command line is based on TCL so you will need to install several TCL
40 components beforehand.
46 http://sourceforge.net/projects/showfiles.php?group_id=131&release_id=127168
48 TclLib 1.0 <--------* Must be 1.0 Do not get higher versions !!!
49 http://prdownloads.sourceforge.net/tcllib/tcllib-1.0.tar.gz?download
52 http://sourceforge.net/projects/showfiles.php?group_id=25970&release_id=40865
55 Once these are installled properly, you should launch TCL from the shell.
56 At the 'tcl>' prompt, source in the TCL script with
58 tcl> source apiInit.tcl
60 (the 'tcl>' prompt is shown for clarity. You can enter full path to the
61 script file if you are not in the same directory as the script file
62 when you started the TCL interpreter.
64 The TCL script provides 3 functions,
68 hello {arg} Sends a SOAP 'hello' action to the soap server
73 user get {user-list} sends a SOAP 'user' request to the SOAP server with
74 a function code of 'get' followed by a list os unix_user_names to fetch
77 user get [list bob mary ted] # returns up to three users
78 user get [list ] # retruns all users
81 group get {group-list} sends a SOAP 'group' request to the SOAP server with
82 a function code of 'get' followed by a list of group_names to fetch
85 group get [list stats siteadmin]
88 (NOTE that the group function requires an arg list, cannot be empty list)