The XmlPlusRpc (XML-RPC compatible) interface of ewiki allows to query information for the Wiki using a standardized interface (remote procedure calls) to access the database indirectly. Speaking of standards, there are two, and ewiki adheres to the *JspWiki:WikiRPCInterface, because that is believed to be more well-thought than the implementations in UseMod, *MoinMoin and of course TWiki (as usual).

All <string> and <base64> values passed back and forth are supposed to be UTF-8 encoded for compliant access (even if ewiki itself does not support it).

Interface methods so far:

wiki.getRPCVersionSupported()

returns (int) 1

wiki.getPage(pagename)

returns raw WikiSource for the given page (current version) in <base64>

wiki.getPageVersion(pagename, version)

returns raw WikiSource for the given page (given version) in <base64>

wiki.getPageHtml(pagename)

returns rendered WikiPage for the given name (current version) in <base64>

wiki.getPageHtmlVersion(pagename, version)

returns rendered WikiPage for the given name (specified version) in <base64>

wiki.getPageInfo(pagename)

returns .#MetaDataStruct for the WikiPage (current version),

wiki.getPageInfoVersion(pagename, version)

returns .#MetaDataStruct for the WikiPage (specified version)

wiki.getAllPages()

returns an array of page names

wiki.getRecentChanges(since_timestamp)

returns an array of .#MetaDataStructs

wiki.listLinks(pagename)

returns one .#ListLinksStruct for the given page (current version)

wiki.listLinksVersion(pagename, version)

returns one .#ListLinksStruct for the given page (requested version)

wiki.putPage(pagename, content)

not enabled (not implemented)

Coming soon. See the CVS module "extra" for it (won't be in the main package, too exotic).

Still need to standardize - *JspWiki:WikiRPCInterface or MetaWiki:XmlRpcToWiki. milky: I favour the *JspWiki one, because of the redundant (and stupid) URL encoding fluff being absent.

off-topic

milky: Knowing this being a completely waste of time() I'll attempt to revive the RFCication of the current XML-RPC practices, eventually calling it XmlPlusRpc (to reflect upcoming "application/rpc xml" MIME subtype, request for official IETF standard filed).

MetaDataStruct

The wiki.getPageInfo() and wiki.getRecentChanges() calls return a <struct> (or an array of) as follows:

  array(
    "name" => ... as <string>,
    "lastModified" => ... in <dateTime.iso8601>,
    "author" => ... as <string>,
    "version" => ... as <int>,
  )

Or the same in XmlPlusRpc notation:

<value>
  <struct>
     <member>
       <name>name</name>
       <value><string>*PageName</string></value>
     </member>
     <member>
       <name>lastModified</name>
       <value><dateTime.iso8601>20010909T01:46:40</dateTime.iso8601></value>
     </member>
     <member> 
        <name>author</name>
        <value><string>*AuthorNamePage</string></value>
     </member>
     <member>
        <name>version</name>
        <value><int>1</int></value>
     </member>
  </struct>
</value>

ListLinksStruct

Only the wiki.listLinks() method returns this result <struct>:

  array(
    "page" => URL or pagename <string>,
    "type" => "external" or "local" <string>,
    "href" => local (WikiLinks) or absolute URL <string>,
  )

Or in XmlPlusRpc notation:

<value><array>
   <data>
      <value><struct>
        <member>
            <name>page</name>
            <value><string>*PageName</string></value>
        </member>
        <member>
            <name>type</name>
            <value><string>local</string></value>
        </member>
        <member>
            <name>href</name>
            <value><string>/cgi-bin/wiki.cgi?*PageName</string></value>
        </member>
      </struct></value>
      <value><struct>
        <member>
            <name>page</name>
            <value><string>http://www.example.com/</string></value>;
        </member>
        <member>
            <name>type</name>
            <value><string>external</string></value>
        </member>
        <member>
            <name>href</name>
            <value><string>http://www.example.com/</string></value>;
        </member>
      </struct></value>
      ...
   </data>
</array></value>

known *WikiRpcImplementations

There are two differing standards for the Wiki XmlPlusRpc interface.

So all further occourences of <string> and <base64> actually mean an UTF-8 encoded string representation, that additionally is sometimes urlencoded().

the interface

The current version of the interface is 1, everything else should be considered as extension of the mentioned WikiWare.

All WikiXmlRpc methods have a class prefix of "wiki." to their methodName().