XML-RPC

experimental

DokuWiki has an experimental XML-RPC API which can be used to access/interact with your wiki from other applications. The API implements the Wiki RPC Interface 2.0 Specifications in the wiki.* namespace and adds additional DokuWiki specific calls in the dokuwiki.* namespace.

Questions and suggestions to extend and improve the API should be directed to the mailinglist.

1. You need at least the 2008-03-31 release of DokuWiki.
2. Enable the XML-RPC interface in the “Advanced Options” section
3. Set the xmlrpcuser option
4. For security reasons it's safer to allow access to the XML-RPC over HTTPS only. The .htaccess.dist in the development version of DokuWiki contains some rewrite rules to do that.

You can access the XML-RPC interface via the following URL:

http://<your wiki/domain/ip>/lib/exe/xmlrpc.php
https://<your wiki/domain/ip>/lib/exe/xmlrpc.php

Here is an example of how to post to the API:

POST /RPC2 HTTP/1.0
User-Agent: Frontier/5.1.2 (WinNT)
Host: betty.userland.com
Content-Type: text/xml
Content-length: 181

<?xml version="1.0"?>
  <methodCall>
    <methodName>examples.getStateName</methodName>
    <params>
      <param> 
        <value>
          <i4>41</i4>
        </value>
      </param> 
    </params> 
  </methodCall> 

  <?xml version="1.0"?>
    <methodCall>
      <methodName>dokuwiki.getVersion</methodName>
    </methodCall>

Functions are listed in the following format:

This simple example will pull the version information from the given Dokuwiki.

• You need to download and install the library XML-RPC for PHP for this example.
• The URL of the DW-Server must be given without the procotol (http://).

<?php
include('lib/xmlrpc.inc');  // or whereever you have downloaded and put the XML-RPC for PHP libraries
 
// create a new client instance
$c = new xmlrpc_client('/lib/exe/xmlrpc.php', 'adminwiki.kreisbote.de', 80);
 
// enable debugging to see more infos :-) (well, not for production code)
$c->setDebug(1);
 
// create the XML message to send
$m = new xmlrpcmsg('dokuwiki.getVersion');
 
// send the message and wait for response
$r = $c->send($m);
if($r == false) die('error');
if(!$r->faultCode()){
  // seems good. Now do whatever you want with the data
  $v = php_xmlrpc_decode($r->value());
  echo "$v";
}

<?php
 
include('/lib/xmlrpc.inc');
 
$c = new xmlrpc_client('/lib/exe/xmlrpc.php', 'localhost', 80);
$c->setDebug = 1;
 
$m = new xmlrpcmsg('wiki.putAttachment');
$m->addParam(new xmlrpcval("file.png", "string"));
$m->addParam(new xmlrpcval("iVBORw0KGgoAAAANSUhEUgAAADAAAAAwC.....<base64 string here>...", "base64"));
$m->addParam(new xmlrpcval(array("ow" => new xmlrpcval(true, "boolean")), "struct"));
 
$r = $c->send($m);
if($r == false) die('foo!');
 
// Output the response object
// var_dump($r);
$r = $c->send($m);
 
if(!$r->faultCode()) {
    $v = php_xmlrpc_decode($r->value());
    echo $v;
} else {
    echo $r->faultString();
}
 
?>

DokuWiki has it's own XMLRPC library which could also be used. A simple client using that library could look like this:

<?php                                                                                                                   
require_once('inc/init.php');                                                                                           
 
$client = new IXR_Client('http://localhost/devel/dokuwiki/lib/exe/xmlrpc.php');
$client->debug = 1; // enable for debugging
$ok = $client->query('dokuwiki.login','admin','pass');
if($ok) echo $client->query('wiki.getPage','wiki:syntax');

This simple example will pull the version information from the given Dokuwiki. No plugin required(in the Windows default package).

require "xmlrpc/client"
server = XMLRPC::Client.new( "localhost","/dokuwiki/lib/exe/xmlrpc.php")
begin
	puts server.call("dokuwiki.getVersion")
rescue XMLRPC::FaultException => e
	puts "Error:"
	puts e.faultCode
	puts e.faultString
end

var xml='<?xml version="1.0"?><methodCall><methodName>wiki.getRPCVersionSupported</methodName><params></params></methodCall>';
 $.ajax({
   url: "http://<your wiki>/wiki/lib/exe/xmlrpc.php",
   data: xml,
   contentType:"text/xml",
   type:"post"
 });

A python module for DokuWikis XML-RPC API can be found at the Python package index.

My AutoIt3 client is mainly a proof of concept:

#cs ----------------------------------------------------------------------------
 
 AutoIt Version: 3.2.12.1
 Author:         Hugo Bossard
 
 Script Function:
	Xmlrpc sample client AutoIt3 script.
 
#ce ----------------------------------------------------------------------------
 
; this script uses the UDF WinHttp
#include "WinHTTP.au3"
 
; get the info from page 'wiki:syntax' using wiki.getPageInfo()
$Xml = '<?xml version="1.0"?>' 
$Xml = $Xml  & @CRLF & '<methodCall>'
$Xml = $Xml  & @CRLF & '<methodName>wiki.getPageInfo</methodName>'
$Xml = $Xml  & @CRLF & '<params>'
$Xml = $Xml  & @CRLF & '<param>' 
$Xml = $Xml  & @CRLF & '<value>'
$Xml = $Xml  & @CRLF & '<string>wiki:syntax</string>'
$Xml = $Xml  & @CRLF & '</value>'
$Xml = $Xml  & @CRLF & '</param>' 
$Xml = $Xml  & @CRLF & '</params>' 
$Xml = $Xml  & @CRLF & '</methodCall>'
$XmlSize = StringLen($Xml)
 
; initializes the use of WinHTTP functions and returns a WinHTTP-session handle.
$hw_open = _WinHttpOpen()
 
; creates a HTTP request handle to a lokal DokuWikiStick installation on port 8800
$hw_connect = _WinHttpConnect($hw_open, "localhost", 8800)
 
; creates a HTTP request handle
$h_openRequest = _WinHttpOpenRequest($hw_connect, "POST", "/lib/exe/xmlrpc.php", "/RPC2 HTTP/1.0", "localhost", "text/xml")
 
; sends the specified request to the HTTP server
_WinHttpSendRequest($h_openRequest, "", $Xml, $XmlSize)
 
; waits to receive the response to a HTTP request initiated by WinHttpSendRequest().
_WinHttpReceiveResponse($h_openRequest)
 
$Data = ""
Do
  ; reads data from a handle opened by the _WinHttpOpenRequest() function.
  $Data&=_WinHttpReadData($h_openRequest)
Until @error
 
; close connection and clean up
_WinHttpCloseHandle($h_openRequest)
_WinHttpCloseHandle($hw_connect)
_WinHttpCloseHandle($hw_open)
 
; show error number and resulting data
MsgBox(4096,"Error: " & @error, $Data)