lib/XmlRpcServer.php

   1 <?php
   2 // $Id: XmlRpcServer.php,v 1.5 2003-02-21 04:12:05 dairiki Exp $
   3 /* Copyright (C) 2002, Lawrence Akka <lakka@users.sourceforge.net>
   4  *
   5  * LICENCE
   6  * =======
   7  * This file is part of PhpWiki.
   8  *
   9  * PhpWiki is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * PhpWiki is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with PhpWiki; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  *
  23  * LIBRARY USED - POSSIBLE PROBLEMS
  24  * ================================
  25  *
  26  * This file provides an XML-RPC interface for PhpWiki.  It uses the XML-RPC
  27  * library for PHP by Edd Dumbill - see http://xmlrpc.usefulinc.com/php.html
  28  * for details.
  29  *
  30  * PHP >= 4.1.0 includes experimental support for the xmlrpc-epi c library
  31  * written by Dan Libby (see http://uk2.php.net/manual/en/ref.xmlrpc.php).  This
  32  * is not compiled into PHP by default.  If it *is* compiled into your installation
  33  * (ie you have --with-xmlrpc) there may well be namespace conflicts with the xml-rpc
  34  * library used by this code, and you will get errors.
  35  *
  36  * INTERFACE SPECIFICTION
  37  * ======================
  38  *
  39  * The interface specification is that discussed at
  40  * http://www.ecyrd.com/JSPWiki/Wiki.jsp?page=WikiRPCInterface
  41  *
  42  * See also http://www.usemod.com/cgi-bin/mb.pl?XmlRpc
  43  *
  44  * NB:  All XMLRPC methods should be prefixed with "wiki."
  45  * eg  wiki.getAllPages
  46  *
  47 */
  48
  49 // ToDo:
  50 //        Remove all warnings from xmlrpc.inc
  51 //        Return list of external links in listLinks
  52
  53
  54 // Intercept GET requests from confused users.  Only POST is allowed here!
  55 // There is some indication that $HTTP_SERVER_VARS is deprecated in php > 4.1.0
  56 // in favour of $_Server, but as far as I know, it still works.
  57 if ($GLOBALS['HTTP_SERVER_VARS']['REQUEST_METHOD'] != "POST")
  58 {
  59     die('This is the address of the XML-RPC interface.' .
  60         '  You must use XML-RPC calls to access information here');
  61 }
  62
  63 // Include the php XML-RPC library
  64
  65 // All these global declarations make it so that this file
  66 // (XmlRpcServer.php) can be included within a function body
  67 // (not in global scope), and things will still work....
  68
  69 global $xmlrpcI4, $xmlrpcInt, $xmlrpcBoolean, $xmlrpcDouble, $xmlrpcString;
  70 global $xmlrpcDateTime, $xmlrpcBase64, $xmlrpcArray, $xmlrpcStruct;
  71 global $xmlrpcTypes;
  72 global $xmlEntities;
  73 global $xmlrpcerr, $xmlrpcstr;
  74 global $xmlrpc_defencoding;
  75 global $xmlrpcName, $xmlrpcVersion;
  76 global $xmlrpcerruser, $xmlrpcerrxml;
  77 global $xmlrpc_backslash;
  78 global $_xh;
  79 include_once("lib/XMLRPC/xmlrpc.inc");
  80
  81 global $_xmlrpcs_dmap;
  82 global $_xmlrpcs_debug;
  83 include_once("lib/XMLRPC/xmlrpcs.inc");
  84
  85 //  API version
  86 define ("WIKI_XMLRPC_VERSION", 1);
  87
  88 /**
  89  * Helper function:  Looks up a page revision (most recent by default) in the wiki database
  90  *
  91  * @param xmlrpcmsg $params :  string pagename [int version]
  92  * @return WikiDB _PageRevision object, or false if no such page
  93  */
  94
  95 function _getPageRevision ($params)
  96 {
  97     global $request;
  98     $ParamPageName = $params->getParam(0);
  99     $ParamVersion = $params->getParam(1);
 100     $pagename = short_string_decode($ParamPageName->scalarval());
 101     $version =  ($ParamVersion) ? ($ParamVersion->scalarval()):(0);
 102     // FIXME:  test for version <=0 ??
 103     $dbh = $request->getDbh();
 104     if ($dbh->isWikiPage($pagename)) {
 105         $page = $dbh->getPage($pagename);
 106         if (!$version) {
 107             $revision = $page->getCurrentRevision();
 108         } else {
 109             $revision = $page->getRevision($version);
 110         }
 111         return $revision;
 112     }
 113     return false;
 114 }
 115
 116 /*
 117  * Helper functions for encoding/decoding strings.
 118  *
 119  * According to WikiRPC spec, all returned strings take one of either
 120  * two forms.  Short strings (page names, and authors) are converted to
 121  * UTF-8, then rawurlencode()d, and returned as XML-RPC <code>strings</code>.
 122  * Long strings (page content) are converted to UTF-8 then returned as
 123  * XML-RPC <code>base64</code> binary objects.
 124  */
 125
 126 /**
 127  * Urlencode ASCII control characters.
 128  *
 129  * (And control characters...)
 130  *
 131  * @param string $str
 132  * @return string
 133  * @see urlencode
 134  */
 135 function UrlencodeControlCharacters($str) {
 136     return preg_replace('/([\x00-\x1F])/e', "urlencode('\\1')", $str);
 137 }
 138
 139 /**
 140  * Convert a short string (page name, author) to xmlrpcval.
 141  */
 142 function short_string ($str) {
 143     return new xmlrpcval(UrlencodeControlCharacters(utf8_encode($str)), 'string');
 144 }
 145
 146 /**
 147  * Convert a large string (page content) to xmlrpcval.
 148  */
 149 function long_string ($str) {
 150     return new xmlrpcval(utf8_encode($str), 'base64');
 151 }
 152
 153 /**
 154  * Decode a short string (e.g. page name)
 155  */
 156 function short_string_decode ($str) {
 157     return utf8_decode(urldecode($str));
 158 }
 159
 160 /**
 161  * Get an xmlrpc "No such page" error message
 162  */
 163 function NoSuchPage ()
 164 {
 165     global $xmlrpcerruser;
 166     return new xmlrpcresp(0, $xmlrpcerruser + 1, "No such page");
 167 }
 168
 169
 170 // ****************************************************************************
 171 // Main API functions follow
 172 // ****************************************************************************
 173 global $wiki_dmap;
 174
 175 /**
 176  * int getRPCVersionSupported(): Returns 1 for this version of the API
 177  */
 178 $wiki_dmap['getRPCVersionSupported']
 179 = array('signature'     => array(array($xmlrpcInt)),
 180         'documentation' => 'Get the version of the wiki API',
 181         'function'      => 'getRPCVersionSupported');
 182
 183 // The function must be a function in the global scope which services the XML-RPC
 184 // method.
 185 function getRPCVersionSupported($params)
 186 {
 187     return new xmlrpcresp(new xmlrpcval(WIKI_XMLRPC_VERSION, "int"));
 188 }
 189
 190 /**
 191  * array getRecentChanges(Date timestamp) : Get list of changed pages since
 192  * timestamp, which should be in UTC. The result is an array, where each element
 193  * is a struct:
 194  *     name (string) : Name of the page. The name is UTF-8 with URL encoding to make it ASCII.
 195  *     lastModified (date) : Date of last modification, in UTC.
 196  *     author (string) : Name of the author (if available). Again, name is UTF-8 with URL encoding.
 197  *         version (int) : Current version.
 198  * A page MAY be specified multiple times. A page MAY NOT be specified multiple
 199  * times with the same modification date.
 200  */
 201 $wiki_dmap['getRecentChanges']
 202 = array('signature'     => array(array($xmlrpcArray, $xmlrpcDateTime)),
 203         'documentation' => 'Get a list of changed pages since [timestamp]',
 204         'function'      => 'getRecentChanges');
 205
 206 function getRecentChanges($params)
 207 {
 208     global $request;
 209     // Get the first parameter as an ISO 8601 date.  Assume UTC
 210     $encoded_date = $params->getParam(0);
 211     $datetime = iso8601_decode($encoded_date->scalarval(), 1);
 212     $dbh = $request->getDbh();
 213     $pages = array();
 214     $iterator = $dbh->mostRecent(array('since' => $datetime));
 215     while ($page = $iterator->next()) {
 216         // $page contains a WikiDB_PageRevision object
 217         // no need to url encode $name, because it is already stored in that format ???
 218         $name = short_string($page->getPageName());
 219         $lastmodified = new xmlrpcval(iso8601_encode($page->get('mtime')), "dateTime.iso8601");
 220         $author = short_string($page->get('author'));
 221         $version = new xmlrpcval($page->getVersion(), 'int');
 222
 223         // Build an array of xmlrpc structs
 224         $pages[] = new xmlrpcval(array('name'=>$name,
 225                                        'lastModified'=>$lastmodified,
 226                                        'author'=>$author,
 227                                        'version'=>$version),
 228                                  'struct');
 229     }
 230     return new xmlrpcresp(new xmlrpcval($pages, "array"));
 231 }
 232
 233
 234 /**
 235  * base64 getPage( String pagename ): Get the raw Wiki text of page, latest version.
 236  * Page name must be UTF-8, with URL encoding. Returned value is a binary object,
 237  * with UTF-8 encoded page data.
 238  */
 239 $wiki_dmap['getPage']
 240 = array('signature'     => array(array($xmlrpcBase64, $xmlrpcString)),
 241         'documentation' => 'Get the raw Wiki text of the current version of a page',
 242         'function'      => 'getPage');
 243
 244 function getPage($params)
 245 {
 246     $revision = _getPageRevision($params);
 247
 248     if (! $revision)
 249         return NoSuchPage();
 250
 251     return new xmlrpcresp(long_string($revision->getPackedContent()));
 252 }
 253
 254
 255 /**
 256  * base64 getPageVersion( String pagename, int version ): Get the raw Wiki text of page.
 257  * Returns UTF-8, expects UTF-8 with URL encoding.
 258  */
 259 $wiki_dmap['getPageVersion']
 260 = array('signature'     => array(array($xmlrpcBase64, $xmlrpcString, $xmlrpcInt)),
 261         'documentation' => 'Get the raw Wiki text of a page version',
 262         'function'      => 'getPageVersion');
 263
 264 function getPageVersion($params)
 265 {
 266     // error checking is done in getPage
 267     return getPage($params);
 268 }
 269
 270 /**
 271  * base64 getPageHTML( String pagename ): Return page in rendered HTML.
 272  * Returns UTF-8, expects UTF-8 with URL encoding.
 273  */
 274
 275 $wiki_dmap['getPageHTML']
 276 = array('signature'     => array(array($xmlrpcBase64, $xmlrpcString)),
 277         'documentation' => 'Get the current version of a page rendered in HTML',
 278         'function'      => 'getPageHTML');
 279
 280 function getPageHTML($params)
 281 {
 282     $revision = _getPageRevision($params);
 283     if (!$revision)
 284         return NoSuchPage();
 285
 286     $content = $revision->getTransformedContent();
 287     $html = $content->asXML();
 288     // HACK: Get rid of outer <div class="wikitext">
 289     if (preg_match('/^\s*<div class="wikitext">/', $html, $m1)
 290         && preg_match('@</div>\s*$@', $html, $m2)) {
 291         $html = substr($html, strlen($m1[0]), -strlen($m2[0]));
 292     }
 293
 294     return new xmlrpcresp(long_string($html));
 295 }
 296
 297 /**
 298  * base64 getPageHTMLVersion( String pagename, int version ): Return page in rendered HTML, UTF-8.
 299  */
 300 $wiki_dmap['getPageHTMLVersion']
 301 = array('signature'     => array(array($xmlrpcBase64, $xmlrpcString, $xmlrpcInt)),
 302         'documentation' => 'Get a version of a page rendered in HTML',
 303         'function'      => 'getPageHTMLVersion');
 304
 305 function getPageHTMLVersion($params)
 306 {
 307     return getPageHTML($params);
 308 }
 309
 310 /**
 311  * getAllPages(): Returns a list of all pages. The result is an array of strings.
 312  */
 313 $wiki_dmap['getAllPages']
 314 = array('signature'     => array(array($xmlrpcArray)),
 315         'documentation' => 'Returns a list of all pages as an array of strings',
 316         'function'      => 'getAllPages');
 317
 318 function getAllPages($params)
 319 {
 320     global $request;
 321     $dbh = $request->getDbh();
 322     $iterator = $dbh->getAllPages();
 323     $pages = array();
 324     while ($page = $iterator->next()) {
 325         $pages[] = short_string($page->getName());
 326     }
 327     return new xmlrpcresp(new xmlrpcval($pages, "array"));
 328 }
 329
 330 /**
 331  * struct getPageInfo( string pagename ) : returns a struct with elements:
 332  *   name (string): the canonical page name
 333  *   lastModified (date): Last modification date
 334  *   version (int): current version
 335  *       author (string): author name
 336  */
 337 $wiki_dmap['getPageInfo']
 338 = array('signature'     => array(array($xmlrpcStruct, $xmlrpcString)),
 339         'documentation' => 'Gets info about the current version of a page',
 340         'function'      => 'getPageInfo');
 341
 342 function getPageInfo($params)
 343 {
 344     $revision = _getPageRevision($params);
 345     if (!$revision)
 346         return NoSuchPage();
 347
 348     $name = short_string($revision->getPageName());
 349     $version = new xmlrpcval ($revision->getVersion(), "int");
 350     $lastmodified = new xmlrpcval(iso8601_encode($revision->get('mtime'), 0),
 351                                   "dateTime.iso8601");
 352     $author = short_string($revision->get('author'));
 353
 354     return new xmlrpcresp(new xmlrpcval(array('name' => $name,
 355                                               'lastModified' => $lastmodified,
 356                                               'version' => $version,
 357                                               'author' => $author),
 358                                         "struct"));
 359 }
 360
 361 /**
 362  * struct getPageInfoVersion( string pagename, int version ) : returns
 363  * a struct just like plain getPageInfo(), but this time for a
 364  * specific version.
 365  */
 366 $wiki_dmap['getPageInfoVersion']
 367 = array('signature'     => array(array($xmlrpcStruct, $xmlrpcString, $xmlrpcInt)),
 368         'documentation' => 'Gets info about a page version',
 369         'function'      => 'getPageInfoVersion');
 370
 371 function getPageInfoVersion($params)
 372 {
 373     return getPageInfo($params);
 374 }
 375
 376
 377 /*  array listLinks( string pagename ): Lists all links for a given page. The
 378  *  returned array contains structs, with the following elements:
 379  *       name (string) : The page name or URL the link is to.
 380  *       type (int) : The link type. Zero (0) for internal Wiki link,
 381  *         one (1) for external link (URL - image link, whatever).
 382  */
 383 $wiki_dmap['listLinks']
 384 = array('signature'     => array(array($xmlrpcArray, $xmlrpcString)),
 385         'documentation' => 'Lists all links for a given page',
 386         'function'      => 'listLinks');
 387
 388 function listLinks($params)
 389 {
 390     global $request;
 391
 392     $ParamPageName = $params->getParam(0);
 393     $pagename = short_string_decode($ParamPageName->scalarval());
 394     $dbh = $request->getDbh();
 395     if (! $dbh->isWikiPage($pagename))
 396         return NoSuchPage();
 397
 398     $page = $dbh->getPage($pagename);
 399     /*
 400     $linkiterator = $page->getLinks(false);
 401     $linkstruct = array();
 402     while ($currentpage = $linkiterator->next()) {
 403         $currentname = $currentpage->getName();
 404         $name = short_string($currentname);
 405         // NB no clean way to extract a list of external links yet, so
 406         // only internal links returned.  ie all type 'local'.
 407         $type = new xmlrpcval('local');
 408
 409         // Compute URL to page
 410         $args = array();
 411         $currentrev = $currentpage->getCurrentRevision();
 412         if ($currentrev->hasDefaultContents())
 413             $args['action'] = 'edit';
 414
 415         // FIXME: Autodetected value of VIRTUAL_PATH wrong,
 416         // this make absolute URLs contstructed by WikiURL wrong.
 417         // Also, if USE_PATH_INFO is false, WikiURL is wrong
 418         // due to its use of SCRIPT_NAME.
 419         $use_abspath = USE_PATH_INFO && ! preg_match('/RPC2.php$/', VIRTUAL_PATH);
 420         $href = new xmlrpcval(WikiURL($currentname, $args, $use_abspath));
 421
 422         $linkstruct[] = new xmlrpcval(array('name'=> $name,
 423                                             'type'=> $type,
 424                                             'href' => $href),
 425                                       "struct");
 426     }
 427     */
 428
 429     $current = $page->getCurrentRevision();
 430     $content = $current->getTransformedContent();
 431     $links = $content->getLinkInfo();
 432
 433     foreach ($links as $link) {
 434         // We used to give an href for unknown pages that
 435         // included action=edit.  I think that's probably the
 436         // wrong thing to do.
 437         $linkstruct[] = new xmlrpcval(array('name'=> short_string($link->page),
 438                                             'type'=> new xmlrpcval($link->type),
 439                                             'href' => short_string($link->href)),
 440                                       "struct");
 441     }
 442
 443     return new xmlrpcresp(new xmlrpcval ($linkstruct, "array"));
 444 }
 445
 446 // Construct the server instance, and set up the despatch map, which maps
 447 // the XML-RPC methods onto the wiki functions
 448 class XmlRpcServer extends xmlrpc_server
 449 {
 450     function XmlRpcServer ($request = false) {
 451         global $wiki_dmap;
 452         foreach ($wiki_dmap as $name => $val)
 453             $dmap['wiki.' . $name] = $val;
 454
 455         $this->xmlrpc_server($dmap, 0 /* delay service*/);
 456     }
 457
 458     function service () {
 459         global $ErrorManager;
 460
 461         $ErrorManager->pushErrorHandler(new WikiMethodCb($this, '_errorHandler'));
 462         xmlrpc_server::service();
 463         $ErrorManager->popErrorHandler();
 464     }
 465
 466     function _errorHandler ($e) {
 467         $msg = htmlspecialchars($e->asString());
 468         // '--' not allowed within xml comment
 469         $msg = str_replace('--', '&#45;&#45;', $msg);
 470         xmlrpc_debugmsg($msg);
 471         return true;
 472     }
 473 }
 474
 475
 476 // (c-file-style: "gnu")
 477 // Local Variables:
 478 // mode: php
 479 // tab-width: 8
 480 // c-basic-offset: 4
 481 // c-hanging-comment-ender-p: nil
 482 // indent-tabs-mode: nil
 483 // End:
 484 ?>