lib/XmlRpcServer.php

   1 <?php
   2
   3 /* Copyright (C) 2002, Lawrence Akka <lakka@users.sourceforge.net>
   4  * Copyright (C) 2004,2005,2006,2007 $ThePhpWikiProgrammingTeam
   5  *
   6  * LICENCE
   7  * =======
   8  * This file is part of PhpWiki.
   9  *
  10  * PhpWiki is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * PhpWiki is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  *
  24  * LIBRARY USED - POSSIBLE PROBLEMS
  25  * ================================
  26  *
  27  * This file provides an XML-RPC interface for PhpWiki.
  28  * It checks for the existence of the xmlrpc-epi c library by Dan Libby
  29  * (see http://uk2.php.net/manual/en/ref.xmlrpc.php), and falls back to
  30  * the slower PHP counterpart XML-RPC library by Edd Dumbill.
  31  * See http://xmlrpc.usefulinc.com/php.html for details.
  32  *
  33  * INTERFACE SPECIFICTION
  34  * ======================
  35  *
  36  * The interface specification is that discussed at
  37  * http://www.ecyrd.com/JSPWiki/Wiki.jsp?page=WikiRPCInterface
  38  *
  39  * See also http://www.usemod.com/cgi-bin/mb.pl?XmlRpc
  40  * or http://www.devshed.com/c/a/PHP/Using-XMLRPC-with-PHP/
  41  *
  42  * Note: All XMLRPC methods are automatically prefixed with "wiki."
  43  *       eg. "wiki.getAllPages"
  44 */
  45
  46 /*
  47 ToDo:
  48     * Change to unit tests: XmlRpcTest v1, v2 and private
  49     * Return list of external links in listLinks
  50     * Support RSS2 cloud subscription: wiki.rssPleaseNotify, pingback.ping
  51
  52     * API v2 http://www.jspwiki.org/wiki/WikiRPCInterface2 :
  53
  54     * array listAttachments( utf8 page ) - Lists attachments on a given page.
  55             The array consists of utf8 attachment names that can be fed to getAttachment (or putAttachment).
  56     * base64 getAttachment( utf8 attachmentName ) - returns the content of an attachment.
  57     * putAttachment( utf8 attachmentName, base64 content ) - (over)writes an attachment.
  58     * array system.listMethods()
  59     * string system.methodHelp (string methodName)
  60     * array system.methodSignature (string methodName)
  61
  62 Done:
  63         Test hwiki.jar xmlrpc interface (java visualization plugin)
  64          Make use of the xmlrpc extension if found. http://xmlrpc-epi.sourceforge.net/
  65     Resolved namespace conflicts
  66     Added various phpwiki specific methods (mailPasswordToUser, getUploadedFileInfo,
  67     putPage, titleSearch, listPlugins, getPluginSynopsis, listRelations)
  68     Use client methods in inter-phpwiki calls: SyncWiki, tests/xmlrpc/
  69 */
  70
  71 // Intercept GET requests from confused users.  Only POST is allowed here!
  72 if (empty($GLOBALS['HTTP_SERVER_VARS']))
  73     $GLOBALS['HTTP_SERVER_VARS'] =& $_SERVER;
  74 if ($GLOBALS['HTTP_SERVER_VARS']['REQUEST_METHOD'] != "POST") {
  75     die('This is the address of the XML-RPC interface.' .
  76         '  You must use XML-RPC calls to access information here.');
  77 }
  78
  79 require_once 'lib/XmlRpcClient.php';
  80 if (loadPhpExtension('xmlrpc')) { // fast c lib
  81     require_once 'lib/XMLRPC/xmlrpcs_emu.inc';
  82 } else { // slow php lib
  83     global $_xmlrpcs_dmap;
  84     require_once 'lib/XMLRPC/xmlrpcs.inc';
  85 }
  86
  87 /**
  88  * Helper function:  Looks up a page revision (most recent by default) in the wiki database
  89  *
  90  * @param xmlrpcmsg $params :  string pagename [int version]
  91  * @return WikiDB _PageRevision object, or false if no such page
  92  */
  93
  94 function _getPageRevision($params)
  95 {
  96     global $request;
  97     $ParamPageName = $params->getParam(0);
  98     $ParamVersion = $params->getParam(1);
  99     $pagename = short_string_decode($ParamPageName->scalarval());
 100     $version = ($ParamVersion) ? ($ParamVersion->scalarval()) : (0);
 101     // FIXME:  test for version <=0 ??
 102     $dbh = $request->getDbh();
 103     if ($dbh->isWikiPage($pagename)) {
 104         $page = $dbh->getPage($pagename);
 105         if (!$version) {
 106             $revision = $page->getCurrentRevision();
 107         } else {
 108             $revision = $page->getRevision($version);
 109         }
 110         return $revision;
 111     }
 112     return false;
 113 }
 114
 115 /**
 116  * Get an xmlrpc "No such page" error message
 117  */
 118 function NoSuchPage($pagename = '')
 119 {
 120     global $xmlrpcerruser;
 121     return new xmlrpcresp(0, $xmlrpcerruser + 1, "No such page " . $pagename);
 122 }
 123
 124 // ****************************************************************************
 125 // Main API functions follow
 126 // ****************************************************************************
 127 global $wiki_dmap;
 128
 129 /**
 130  * int getRPCVersionSupported(): Returns 1 for this version of the API
 131  */
 132 $wiki_dmap['getRPCVersionSupported']
 133     = array('signature' => array(array($xmlrpcInt)),
 134     'documentation' => 'Get the version of the wiki API',
 135     'function' => 'getRPCVersionSupported');
 136
 137 // The function must be a function in the global scope which services the XML-RPC
 138 // method.
 139 function getRPCVersionSupported($params)
 140 {
 141     return new xmlrpcresp(new xmlrpcval((integer)WIKI_XMLRPC_VERSION, "int"));
 142 }
 143
 144 /**
 145  * array getRecentChanges(Date timestamp) : Get list of changed pages since
 146  * timestamp, which should be in UTC. The result is an array, where each element
 147  * is a struct:
 148  *     name (string)       : Name of the page. The name is UTF-8 with URL encoding to make it ASCII.
 149  *     lastModified (date) : Date of last modification, in UTC.
 150  *     author (string)     : Name of the author (if available). Again, name is UTF-8 with URL encoding.
 151  *     version (int)       : Current version.
 152  *     summary (string)    : UTF-8 with URL encoding.
 153  * A page MAY be specified multiple times. A page MAY NOT be specified multiple
 154  * times with the same modification date.
 155  * Additionally to API version 1 and 2 we added the summary field.
 156  */
 157 $wiki_dmap['getRecentChanges']
 158     = array('signature' => array(array($xmlrpcArray, $xmlrpcDateTime)),
 159     'documentation' => 'Get a list of changed pages since [timestamp]',
 160     'function' => 'getRecentChanges');
 161
 162 function getRecentChanges($params)
 163 {
 164     global $request;
 165     // Get the first parameter as an ISO 8601 date. Assume UTC
 166     $encoded_date = $params->getParam(0);
 167     $datetime = iso8601_decode($encoded_date->scalarval(), 1);
 168     $dbh = $request->getDbh();
 169     $pages = array();
 170     $iterator = $dbh->mostRecent(array('since' => $datetime));
 171     while ($page = $iterator->next()) {
 172         // $page contains a WikiDB_PageRevision object
 173         // no need to url encode $name, because it is already stored in that format ???
 174         $name = short_string($page->getPageName());
 175         $lastmodified = new xmlrpcval(iso8601_encode($page->get('mtime')), "dateTime.iso8601");
 176         $author = short_string($page->get('author'));
 177         $version = new xmlrpcval($page->getVersion(), 'int');
 178
 179         // Build an array of xmlrpc structs
 180         $pages[] = new xmlrpcval(array('name' => $name,
 181                 'lastModified' => $lastmodified,
 182                 'author' => $author,
 183                 'summary' => short_string($page->get('summary')),
 184                 'version' => $version),
 185             'struct');
 186     }
 187     return new xmlrpcresp(new xmlrpcval($pages, "array"));
 188 }
 189
 190 /**
 191  * base64 getPage( String pagename ): Get the raw Wiki text of page, latest version.
 192  * Page name must be UTF-8, with URL encoding. Returned value is a binary object,
 193  * with UTF-8 encoded page data.
 194  */
 195 $wiki_dmap['getPage']
 196     = array('signature' => array(array($xmlrpcBase64, $xmlrpcString)),
 197     'documentation' => 'Get the raw Wiki text of the current version of a page',
 198     'function' => 'getPage');
 199
 200 function getPage($params)
 201 {
 202     $revision = _getPageRevision($params);
 203
 204     if (!$revision) {
 205         $ParamPageName = $params->getParam(0);
 206         $pagename = short_string_decode($ParamPageName->scalarval());
 207         return NoSuchPage($pagename);
 208     }
 209
 210     return new xmlrpcresp(long_string($revision->getPackedContent()));
 211 }
 212
 213 /**
 214  * base64 getPageVersion( String pagename, int version ): Get the raw Wiki text of page.
 215  * Returns UTF-8, expects UTF-8 with URL encoding.
 216  */
 217 $wiki_dmap['getPageVersion']
 218     = array('signature' => array(array($xmlrpcBase64, $xmlrpcString, $xmlrpcInt)),
 219     'documentation' => 'Get the raw Wiki text of a page version',
 220     'function' => 'getPageVersion');
 221
 222 function getPageVersion($params)
 223 {
 224     // error checking is done in getPage
 225     return getPage($params);
 226 }
 227
 228 /**
 229  * base64 getPageHTML( String pagename ): Return page in rendered HTML.
 230  * Returns UTF-8, expects UTF-8 with URL encoding.
 231  */
 232
 233 $wiki_dmap['getPageHTML']
 234     = array('signature' => array(array($xmlrpcBase64, $xmlrpcString)),
 235     'documentation' => 'Get the current version of a page rendered in HTML',
 236     'function' => 'getPageHTML');
 237
 238 function getPageHTML($params)
 239 {
 240     $revision = _getPageRevision($params);
 241     if (!$revision)
 242         return NoSuchPage();
 243
 244     $content = $revision->getTransformedContent();
 245     $html = $content->asXML();
 246     // HACK: Get rid of outer <div class="wikitext">
 247     if (preg_match('/^\s*<div class="wikitext">/', $html, $m1)
 248         && preg_match('@</div>\s*$@', $html, $m2)
 249     ) {
 250         $html = substr($html, strlen($m1[0]), -strlen($m2[0]));
 251     }
 252
 253     return new xmlrpcresp(long_string($html));
 254 }
 255
 256 /**
 257  * base64 getPageHTMLVersion( String pagename, int version ): Return page in rendered HTML, UTF-8.
 258  */
 259 $wiki_dmap['getPageHTMLVersion']
 260     = array('signature' => array(array($xmlrpcBase64, $xmlrpcString, $xmlrpcInt)),
 261     'documentation' => 'Get a version of a page rendered in HTML',
 262     'function' => 'getPageHTMLVersion');
 263
 264 function getPageHTMLVersion($params)
 265 {
 266     return getPageHTML($params);
 267 }
 268
 269 /**
 270  * getAllPages(): Returns a list of all pages. The result is an array of strings.
 271  */
 272 $wiki_dmap['getAllPages']
 273     = array('signature' => array(array($xmlrpcArray)),
 274     'documentation' => 'Returns a list of all pages as an array of strings',
 275     'function' => 'getAllPages');
 276
 277 function getAllPages($params)
 278 {
 279     global $request;
 280     $dbh = $request->getDbh();
 281     $iterator = $dbh->getAllPages();
 282     $pages = array();
 283     while ($page = $iterator->next()) {
 284         $pages[] = short_string($page->getName());
 285     }
 286     return new xmlrpcresp(new xmlrpcval($pages, "array"));
 287 }
 288
 289 /**
 290  * struct getPageInfo( string pagename ) : returns a struct with elements:
 291  *   name (string): the canonical page name
 292  *   lastModified (date): Last modification date
 293  *   version (int): current version
 294  *   author (string): author name
 295  */
 296 $wiki_dmap['getPageInfo']
 297     = array('signature' => array(array($xmlrpcStruct, $xmlrpcString)),
 298     'documentation' => 'Gets info about the current version of a page',
 299     'function' => 'getPageInfo');
 300
 301 function getPageInfo($params)
 302 {
 303     $revision = _getPageRevision($params);
 304     if (!$revision)
 305         return NoSuchPage();
 306
 307     $name = short_string($revision->getPageName());
 308     $version = new xmlrpcval ($revision->getVersion(), "int");
 309     $lastmodified = new xmlrpcval(iso8601_encode($revision->get('mtime'), 0),
 310         "dateTime.iso8601");
 311     $author = short_string($revision->get('author'));
 312
 313     return new xmlrpcresp(new xmlrpcval(array('name' => $name,
 314             'lastModified' => $lastmodified,
 315             'version' => $version,
 316             'author' => $author),
 317         "struct"));
 318 }
 319
 320 /**
 321  * struct getPageInfoVersion( string pagename, int version ) : returns
 322  * a struct just like plain getPageInfo(), but this time for a
 323  * specific version.
 324  */
 325 $wiki_dmap['getPageInfoVersion']
 326     = array('signature' => array(array($xmlrpcStruct, $xmlrpcString, $xmlrpcInt)),
 327     'documentation' => 'Gets info about a page version',
 328     'function' => 'getPageInfoVersion');
 329
 330 function getPageInfoVersion($params)
 331 {
 332     return getPageInfo($params);
 333 }
 334
 335 /*  array listLinks( string pagename ): Lists all links for a given page. The
 336  *  returned array contains structs, with the following elements:
 337  *        name (string) : The page name or URL the link is to.
 338  *       type (int)    : The link type. Zero (0) for internal Wiki link,
 339  *                        one (1) for external link (URL - image link, whatever).
 340  */
 341 $wiki_dmap['listLinks']
 342     = array('signature' => array(array($xmlrpcArray, $xmlrpcString)),
 343     'documentation' => 'Lists all links for a given page',
 344     'function' => 'listLinks');
 345
 346 function listLinks($params)
 347 {
 348     global $request;
 349
 350     $ParamPageName = $params->getParam(0);
 351     $pagename = short_string_decode($ParamPageName->scalarval());
 352     $dbh = $request->getDbh();
 353     if (!$dbh->isWikiPage($pagename))
 354         return NoSuchPage($pagename);
 355
 356     $page = $dbh->getPage($pagename);
 357
 358     // The fast WikiDB method. below is the slow method which goes through the formatter
 359     // NB no clean way to extract a list of external links yet, so
 360     // only internal links returned.  i.e. all type 'local'.
 361     $linkiterator = $page->getPageLinks();
 362     $linkstruct = array();
 363     while ($currentpage = $linkiterator->next()) {
 364         $currentname = $currentpage->getName();
 365         // Compute URL to page
 366         $args = array();
 367         // How to check external links?
 368         if (!$currentpage->exists()) $args['action'] = 'edit';
 369
 370         // FIXME: Autodetected value of VIRTUAL_PATH wrong,
 371         // this make absolute URLs constructed by WikiURL wrong.
 372         // Also, if USE_PATH_INFO is false, WikiURL is wrong
 373         // due to its use of SCRIPT_NAME.
 374         //$use_abspath = USE_PATH_INFO && ! preg_match('/RPC2.php$/', VIRTUAL_PATH);
 375
 376         // USE_PATH_INFO must be defined in index.php or config.ini but not before,
 377         // otherwise it is ignored and xmlrpc urls are wrong.
 378         // SCRIPT_NAME here is always .../RPC2.php
 379         if (USE_PATH_INFO and !$args) {
 380             $url = preg_replace('/%2f/i', '/', rawurlencode($currentname));
 381         } elseif (!USE_PATH_INFO) {
 382             $url = str_replace("/RPC2.php", "/index.php", WikiURL($currentname, $args, true));
 383         } else {
 384             $url = WikiURL($currentname, $args);
 385         }
 386         $linkstruct[] = new xmlrpcval(array('page' => short_string($currentname),
 387                 'type' => new xmlrpcval('local', 'string'),
 388                 'href' => short_string($url)),
 389             "struct");
 390     }
 391
 392     /*
 393     $current = $page->getCurrentRevision();
 394     $content = $current->getTransformedContent();
 395     $links = $content->getLinkInfo();
 396     foreach ($links as $link) {
 397         // We used to give an href for unknown pages that
 398         // included action=edit.  I think that's probably the
 399         // wrong thing to do.
 400         $linkstruct[] = new xmlrpcval(array('page'=> short_string($link->page),
 401                                             'type'=> new xmlrpcval($link->type, 'string'),
 402                                             'href' => short_string($link->href),
 403                                             //'pageref' => short_string($link->pageref),
 404                                             ),
 405                                       "struct");
 406     }
 407     */
 408     return new xmlrpcresp(new xmlrpcval ($linkstruct, "array"));
 409 }
 410
 411 /* End of WikiXMLRpc API v1 */
 412 /* ======================================================================== */
 413 /* Start of partial WikiXMLRpc API v2 support */
 414
 415 /**
 416  * struct putPage(String pagename, String content, [String author[, String password]})
 417  * returns a struct with elements:
 418  *   code (int): 200 on success, 400 or 401 on failure
 419  *   message (string): success or failure message
 420  *   version (int): version of new page
 421  *
 422  * @author: Arnaud Fontaine, Reini Urban
 423  *
 424  * API notes: Contrary to the API v2 specs we dropped attributes and added author + password
 425  */
 426 $wiki_dmap['putPage']
 427     = array('signature' => array(array($xmlrpcStruct, $xmlrpcString, $xmlrpcString, $xmlrpcString, $xmlrpcString)),
 428     'documentation' => 'put the raw Wiki text into a page as new version',
 429     'function' => 'putPage');
 430
 431 function _getUser($userid = '')
 432 {
 433     global $request;
 434
 435     if (!$userid) {
 436         if (!isset($_SERVER))
 437             $_SERVER =& $GLOBALS['HTTP_SERVER_VARS'];
 438         if (!isset($_ENV))
 439             $_ENV =& $GLOBALS['HTTP_ENV_VARS'];
 440         if (isset($_SERVER['REMOTE_USER']))
 441             $userid = $_SERVER['REMOTE_USER'];
 442         elseif (isset($_ENV['REMOTE_USER']))
 443             $userid = $_ENV['REMOTE_USER']; elseif (isset($_SERVER['REMOTE_ADDR']))
 444             $userid = $_SERVER['REMOTE_ADDR']; elseif (isset($_ENV['REMOTE_ADDR']))
 445             $userid = $_ENV['REMOTE_ADDR']; elseif (isset($GLOBALS['REMOTE_ADDR']))
 446             $userid = $GLOBALS['REMOTE_ADDR'];
 447     }
 448
 449     if (ENABLE_USER_NEW) {
 450         return WikiUser($userid);
 451     } else {
 452         return new WikiUser($request, $userid);
 453     }
 454 }
 455
 456 function putPage($params)
 457 {
 458     global $request;
 459
 460     $ParamPageName = $params->getParam(0);
 461     $ParamContent = $params->getParam(1);
 462     $pagename = short_string_decode($ParamPageName->scalarval());
 463     $content = short_string_decode($ParamContent->scalarval());
 464     $passwd = '';
 465     if (count($params->params) > 2) {
 466         $ParamAuthor = $params->getParam(2);
 467         $userid = short_string_decode($ParamAuthor->scalarval());
 468         if (count($params->params) > 3) {
 469             $ParamPassword = $params->getParam(3);
 470             $passwd = short_string_decode($ParamPassword->scalarval());
 471         }
 472     } else {
 473         $userid = $request->_user->_userid;
 474     }
 475     $request->_user = _getUser($userid);
 476     $request->_user->_group = $request->getGroup();
 477     $request->_user->AuthCheck($userid, $passwd);
 478
 479     if (!mayAccessPage('edit', $pagename)) {
 480         return new xmlrpcresp(
 481             new xmlrpcval(
 482                 array('code' => new xmlrpcval(401, "int"),
 483                     'version' => new xmlrpcval(0, "int"),
 484                     'message' =>
 485                     short_string("no permission for "
 486                         . $request->_user->UserName())),
 487                 "struct"));
 488     }
 489
 490     $now = time();
 491     $dbh = $request->getDbh();
 492     $page = $dbh->getPage($pagename);
 493     $current = $page->getCurrentRevision();
 494     $content = trim($content);
 495     $version = $current->getVersion();
 496     // $version = -1 will force create a new version
 497     if ($current->getPackedContent() != $content) {
 498         $init_meta = array('ctime' => $now,
 499             'creator' => $userid,
 500             'creator_id' => $userid,
 501         );
 502         $version_meta = array('author' => $userid,
 503             'author_id' => $userid,
 504             'summary' => isset($summary) ? $summary : _("xml-rpc change"),
 505             'mtime' => $now,
 506             'pagetype' => 'wikitext',
 507             'wikitext' => $init_meta,
 508         );
 509         $version++;
 510         $res = $page->save($content, $version, $version_meta);
 511         if ($res)
 512             $message = "Page $pagename version $version created";
 513         else
 514             $message = "Problem creating version $version of page $pagename";
 515     } else {
 516         $res = 0;
 517         $message = $message = "Page $pagename unchanged";
 518     }
 519     return new xmlrpcresp(new xmlrpcval(array('code' => new xmlrpcval($res ? 200 : 400, "int"),
 520             'version' => new xmlrpcval($version, "int"),
 521             'message' => short_string($message)),
 522         "struct"));
 523 }
 524
 525 /* End of WikiXMLRpc API v2 */
 526 /* ======================================================================== */
 527 /* Start of private extensions */
 528
 529 /**
 530  * struct getUploadedFileInfo( string localpath ) : returns a struct with elements:
 531  *   lastModified (date): Last modification date
 532  *   size (int): current version
 533  * This is to sync uploaded files up to a remote master wiki. (SyncWiki)
 534  * Not existing files return both 0.
 535  *
 536  * API notes: API v2 specs have array listAttachments( utf8 page ),
 537  * base64 getAttachment( utf8 attachmentName ), putAttachment( utf8 attachmentName, base64 content )
 538  */
 539 $wiki_dmap['getUploadedFileInfo']
 540     = array('signature' => array(array($xmlrpcStruct, $xmlrpcString)),
 541     'documentation' => 'Gets date and size about an uploaded local file',
 542     'function' => 'getUploadedFileInfo');
 543
 544 function getUploadedFileInfo($params)
 545 {
 546     // localpath is the relative part after "Upload:"
 547     $ParamPath = $params->getParam(0);
 548     $localpath = short_string_decode($ParamPath->scalarval());
 549     preg_replace("/^[\\ \/ \.]/", "", $localpath); // strip hacks
 550     $file = getUploadFilePath() . $localpath;
 551     if (file_exists($file)) {
 552         $size = filesize($file);
 553         $lastmodified = filemtime($file);
 554     } else {
 555         $size = 0;
 556         $lastmodified = 0;
 557     }
 558     return new xmlrpcresp(new xmlrpcval
 559     (array('lastModified' => new xmlrpcval(iso8601_encode($lastmodified, 1),
 560             "dateTime.iso8601"),
 561             'size' => new xmlrpcval($size, "int")),
 562         "struct"));
 563 }
 564
 565 /**
 566  * Publish-Subscribe (not yet implemented)
 567  * Client subscribes to a RecentChanges-like channel, getting a short
 568  * callback notification on every change. Like PageChangeNotification, just shorter
 569  * and more complicated
 570  * RSS2 support (not yet), since radio userland's rss-0.92. now called RSS2.
 571  * BTW: Radio Userland deprecated this interface.
 572  *
 573  * boolean wiki.rssPleaseNotify ( notifyProcedure, port, path, protocol, urlList )
 574  *   returns: true or false
 575  *
 576  * Check of the channel behind the rssurl has a cloud element,
 577  * if the client has a direct IP connection (no NAT),
 578  * register the client on the WikiDB notification handler
 579  *
 580  * http://backend.userland.com/publishSubscribeWalkthrough
 581  * http://www.soapware.org/xmlStorageSystem#rssPleaseNotify
 582  * http://www.thetwowayweb.com/soapmeetsrss#rsscloudInterface
 583  */
 584 $wiki_dmap['rssPleaseNotify']
 585     = array('signature' => array(array($xmlrpcBoolean, $xmlrpcStruct)),
 586     'documentation' => 'RSS2 change notification subscriber channel',
 587     'function' => 'rssPleaseNotify');
 588
 589 function rssPleaseNotify($params)
 590 {
 591     // register the clients IP
 592     return new xmlrpcresp(new xmlrpcval (0, "boolean"));
 593 }
 594
 595 /*
 596  *  boolean wiki.mailPasswordToUser ( username )
 597  *  returns: true or false
 598
 599  */
 600 $wiki_dmap['mailPasswordToUser']
 601     = array('signature' => array(array($xmlrpcBoolean, $xmlrpcString)),
 602     'documentation' => 'RSS2 user management helper',
 603     'function' => 'mailPasswordToUser');
 604
 605 function mailPasswordToUser($params)
 606 {
 607     global $request;
 608     $ParamUserid = $params->getParam(0);
 609     $userid = short_string_decode($ParamUserid->scalarval());
 610     $request->_user = _getUser($userid);
 611     //$request->_prefs =& $request->_user->_prefs;
 612     $email = $request->getPref('email');
 613     $success = 0;
 614     if ($email) {
 615         $body = WikiURL('') . "\nPassword: " . $request->getPref('passwd');
 616         $success = mail($email, "[" . WIKI_NAME . "} Password Request",
 617             $body);
 618     }
 619     return new xmlrpcresp(new xmlrpcval ($success, "boolean"));
 620 }
 621
 622 /**
 623  * array wiki.titleSearch(String substring [, String option = "0"])
 624  * returns an array of matching pagenames.
 625  * TODO: standardize options
 626  *
 627  * @author: Reini Urban
 628  */
 629 $wiki_dmap['titleSearch']
 630     = array('signature' => array(array($xmlrpcArray, $xmlrpcString, $xmlrpcString)),
 631     'documentation' => "Return matching pagenames.
 632 Option 1: caseexact, 2: regex, 4: starts_with, 8: exact, 16: fallback",
 633     'function' => 'titleSearch');
 634
 635 function titleSearch($params)
 636 {
 637     global $request;
 638     $ParamPageName = $params->getParam(0);
 639     $searchstring = short_string_decode($ParamPageName->scalarval());
 640     if (count($params->params) > 1) {
 641         $ParamOption = $params->getParam(1);
 642         $option = (int)$ParamOption->scalarval();
 643     } else
 644         $option = 0;
 645     // default option: substring, case-inexact
 646
 647     $case_exact = $option & 1;
 648     $regex = $option & 2;
 649     $fallback = $option & 16;
 650     if (!$regex) {
 651         if ($option & 4) { // STARTS_WITH
 652             $regex = true;
 653             $searchstring = "^" . $searchstring;
 654         }
 655         if ($option & 8) { // EXACT
 656             $regex = true;
 657             $searchstring = "^" . $searchstring . "$";
 658         }
 659     } else {
 660         if ($option & 4 or $option & 8) {
 661             global $xmlrpcerruser;
 662             return new xmlrpcresp(0, $xmlrpcerruser + 1, "Invalid option");
 663         }
 664     }
 665     include_once 'lib/TextSearchQuery.php';
 666     $query = new TextSearchQuery($searchstring, $case_exact, $regex ? 'auto' : 'none');
 667     $dbh = $request->getDbh();
 668     $iterator = $dbh->titleSearch($query);
 669     $pages = array();
 670     while ($page = $iterator->next()) {
 671         $pages[] = short_string($page->getName());
 672     }
 673     // On failure try again broader (substring + case inexact)
 674     if ($fallback and empty($pages)) {
 675         $query = new TextSearchQuery(short_string_decode($ParamPageName->scalarval()), false,
 676             $regex ? 'auto' : 'none');
 677         $dbh = $request->getDbh();
 678         $iterator = $dbh->titleSearch($query);
 679         while ($page = $iterator->next()) {
 680             $pages[] = short_string($page->getName());
 681         }
 682     }
 683     return new xmlrpcresp(new xmlrpcval($pages, "array"));
 684 }
 685
 686 /**
 687  * array wiki.listPlugins()
 688  *
 689  * Returns an array of all available plugins.
 690  * For EditToolbar pluginPulldown via AJAX
 691  *
 692  * @author: Reini Urban
 693  */
 694 $wiki_dmap['listPlugins']
 695     = array('signature' => array(array($xmlrpcArray)),
 696     'documentation' => "Return names of all plugins",
 697     'function' => 'listPlugins');
 698
 699 function listPlugins($params)
 700 {
 701     $plugin_dir = 'lib/plugin';
 702     if (defined('PHPWIKI_DIR'))
 703         $plugin_dir = PHPWIKI_DIR . "/$plugin_dir";
 704     $pd = new fileSet($plugin_dir, '*.php');
 705     $plugins = $pd->getFiles();
 706     unset($pd);
 707     sort($plugins);
 708     $RetArray = array();
 709     if (!empty($plugins)) {
 710         require_once 'lib/WikiPlugin.php';
 711         $w = new WikiPluginLoader();
 712         foreach ($plugins as $plugin) {
 713             $pluginName = str_replace(".php", "", $plugin);
 714             $p = $w->getPlugin($pluginName, false); // second arg?
 715             // trap php files which aren't WikiPlugin~s: wikiplugin + wikiplugin_cached only
 716             if (strtolower(substr(get_parent_class($p), 0, 10)) == 'wikiplugin') {
 717                 $RetArray[] = short_string($pluginName);
 718             }
 719         }
 720     }
 721
 722     return new xmlrpcresp(new xmlrpcval($RetArray, "array"));
 723 }
 724
 725 /**
 726  * String wiki.getPluginSynopsis(String plugin)
 727  *
 728  * For EditToolbar pluginPulldown via AJAX
 729  *
 730  * @author: Reini Urban
 731  */
 732 $wiki_dmap['getPluginSynopsis']
 733     = array('signature' => array(array($xmlrpcArray, $xmlrpcString)),
 734     'documentation' => "Return plugin synopsis",
 735     'function' => 'getPluginSynopsis');
 736
 737 function getPluginSynopsis($params)
 738 {
 739     $ParamPlugin = $params->getParam(0);
 740     $pluginName = short_string_decode($ParamPlugin->scalarval());
 741
 742     require_once 'lib/WikiPlugin.php';
 743     $w = new WikiPluginLoader();
 744     $synopsis = '';
 745     $p = $w->getPlugin($pluginName, false); // second arg?
 746     // trap php files which aren't WikiPlugin~s: wikiplugin + wikiplugin_cached only
 747     if (strtolower(substr(get_parent_class($p), 0, 10)) == 'wikiplugin') {
 748         $plugin_args = '';
 749         $desc = $p->getArgumentsDescription();
 750         $src = array("\n", '"', "'", '|', '[', ']', '\\');
 751         $replace = array('%0A', '%22', '%27', '%7C', '%5B', '%5D', '%5C');
 752         $desc = str_replace("<br />", ' ', $desc->asXML());
 753         if ($desc)
 754             $plugin_args = '\n' . str_replace($src, $replace, $desc);
 755         $synopsis = "<?plugin " . $pluginName . $plugin_args . "?>"; // args?
 756     }
 757
 758     return new xmlrpcresp(short_string($synopsis));
 759 }
 760
 761 /**
 762  * array wiki.callPlugin(String name, String args)
 763  *
 764  * Returns an array of pages as returned by the plugins PageList call.
 765  * Only valid for plugins returning pagelists, e.g. BackLinks, AllPages, ...
 766  * For various AJAX or WikiFormRich calls.
 767  *
 768  * @author: Reini Urban
 769  */
 770 $wiki_dmap['callPlugin']
 771     = array('signature' => array(array($xmlrpcArray, $xmlrpcString, $xmlrpcString)),
 772     'documentation' => "Returns an array of pages as returned by the plugins PageList call",
 773     'function' => 'callPlugin');
 774
 775 function callPlugin($params)
 776 {
 777     global $request;
 778     $dbi = $request->getDbh();
 779     $ParamPlugin = $params->getParam(0);
 780     $pluginName = short_string_decode($ParamPlugin->scalarval());
 781     $ParamArgs = $params->getParam(1);
 782     $plugin_args = short_string_decode($ParamArgs->scalarval());
 783
 784     $basepage = ''; //$pluginName;
 785     require_once 'lib/WikiPlugin.php';
 786     $w = new WikiPluginLoader();
 787     $p = $w->getPlugin($pluginName, false); // second arg?
 788     $pagelist = $p->run($dbi, $plugin_args, $request, $basepage);
 789     $list = array();
 790     if (is_object($pagelist) and isa($pagelist, 'PageList')) {
 791         foreach ($pagelist->_pages as $page) {
 792             $list[] = $page->getName();
 793         }
 794     }
 795     return new xmlrpcresp(new xmlrpcval($list, "array"));
 796 }
 797
 798 /**
 799  * array wiki.listRelations([ Integer option = 1 ])
 800  *
 801  * Returns an array of all available relation names.
 802  *   option: 1 relations only ( with 0 also )
 803  *   option: 2 attributes only
 804  *   option: 3 both, all names of relations and attributes
 805  *   option: 4 unsorted, this might be added as bitvalue: 7 = 4+3. default: sorted
 806  * For some semanticweb autofill methods.
 807  *
 808  * @author: Reini Urban
 809  */
 810 $wiki_dmap['listRelations']
 811     = array('signature' => array(array($xmlrpcArray, $xmlrpcInt)),
 812     'documentation' => "Return names of all relations",
 813     'function' => 'listRelations');
 814
 815 function listRelations($params)
 816 {
 817     global $request;
 818     $dbh = $request->getDbh();
 819     if (count($params->params) > 0) {
 820         $ParamOption = $params->getParam(0);
 821         $option = (int)$ParamOption->scalarval();
 822     } else
 823         $option = 1;
 824     $also_attributes = $option & 2;
 825     $only_attributes = $option & 2 and !($option & 1);
 826     $sorted = !($option & 4);
 827     return new xmlrpcresp(new xmlrpcval($dbh->listRelations($also_attributes,
 828             $only_attributes,
 829             $sorted),
 830         "array"));
 831 }
 832
 833 /**
 834  * String pingback.ping(String sourceURI, String targetURI)
 835
 836 Spec: http://www.hixie.ch/specs/pingback/pingback
 837
 838 Parameters
 839 sourceURI of type string
 840 The absolute URI of the post on the source page containing the
 841 link to the target site.
 842 targetURI of type string
 843 The absolute URI of the target of the link, as given on the source page.
 844 Return Value
 845 A string, as described below.
 846 Faults
 847 If an error condition occurs, then the appropriate fault code from
 848 the following list should be used. Clients can quickly determine
 849 the kind of error from bits 5-8. 0x001x fault codes are used for
 850 problems with the source URI, 0x002x codes are for problems with
 851 the target URI, and 0x003x codes are used when the URIs are fine
 852 but the pingback cannot be acknowledged for some other reaon.
 853
 854 0
 855 A generic fault code. Servers MAY use this error code instead
 856 of any of the others if they do not have a way of determining
 857 the correct fault code.
 858 0x0010 (16)
 859 The source URI does not exist.
 860 0x0011 (17)
 861 The source URI does not contain a link to the target URI, and
 862 so cannot be used as a source.
 863 0x0020 (32)
 864 The specified target URI does not exist. This MUST only be
 865 used when the target definitely does not exist, rather than
 866 when the target may exist but is not recognised. See the next
 867 error.
 868 0x0021 (33)
 869 The specified target URI cannot be used as a target. It either
 870 doesn't exist, or it is not a pingback-enabled resource. For
 871 example, on a blog, typically only permalinks are
 872 pingback-enabled, and trying to pingback the home page, or a
 873 set of posts, will fail with this error.
 874 0x0030 (48)
 875 The pingback has already been registered.
 876 0x0031 (49)
 877 Access denied.
 878 0x0032 (50)
 879 The server could not communicate with an upstream server, or
 880 received an error from an upstream server, and therefore could
 881 not complete the request. This is similar to HTTP's 402 Bad
 882 Gateway error. This error SHOULD be used by pingback proxies
 883 when propagating errors.
 884
 885 In addition, [FaultCodes] defines some standard fault codes that
 886 servers MAY use to report higher level errors.
 887
 888 Servers MUST respond to this function call either with a single string
 889 or with a fault code.
 890
 891 If the pingback request is successful, then the return value MUST be a
 892 single string, containing as much information as the server deems
 893 useful. This string is only expected to be used for debugging
 894 purposes.
 895
 896 If the result is unsuccessful, then the server MUST respond with an
 897 RPC fault value. The fault code should be either one of the codes
 898 listed above, or the generic fault code zero if the server cannot
 899 determine the correct fault code.
 900
 901 Clients MAY ignore the return value, whether the request was
 902 successful or not. It is RECOMMENDED that clients do not show the
 903 result of successful requests to the user.
 904
 905 Upon receiving a request, servers MAY do what they like. However, the
 906 following steps are RECOMMENDED:
 907
 908 1. The server MAY attempt to fetch the source URI to verify that
 909 the source does indeed link to the target.
 910 2. The server MAY check its own data to ensure that the target
 911 exists and is a valid entry.
 912 3. The server MAY check that the pingback has not already been registered.
 913 4. The server MAY record the pingback.
 914 5. The server MAY regenerate the site's pages (if the pages are static).
 915  * @author: Reini Urban
 916  */
 917 $wiki_dmap['pingback.ping']
 918     = array('signature' => array(array($xmlrpcString, $xmlrpcString, $xmlrpcString)),
 919     'documentation' => "",
 920     'function' => 'pingBack');
 921 function pingBack($params)
 922 {
 923     global $request;
 924     $Param0 = $params->getParam(0);
 925     $sourceURI = short_string_decode($Param0->scalarval());
 926     $Param1 = $params->getParam(1);
 927     $targetURI = short_string_decode($Param1->scalarval());
 928     // TODO...
 929 }
 930
 931 /* End of private WikiXMLRpc API extensions */
 932 /* ======================================================================== */
 933
 934 /**
 935  * Construct the server instance, and set up the dispatch map,
 936  * which maps the XML-RPC methods on to the wiki functions.
 937  * Provide the "wiki." prefix to each function. Besides
 938  * the blog - pingback, ... - functions with a separate namespace.
 939  */
 940 class XmlRpcServer extends xmlrpc_server
 941 {
 942     function XmlRpcServer($request = false)
 943     {
 944         global $wiki_dmap;
 945         foreach ($wiki_dmap as $name => $val) {
 946             if ($name == 'pingback.ping') // non-wiki methods
 947                 $dmap[$name] = $val;
 948             else
 949                 $dmap['wiki.' . $name] = $val;
 950         }
 951
 952         $this->xmlrpc_server($dmap, 0 /* delay service*/);
 953     }
 954
 955     function service()
 956     {
 957         global $ErrorManager;
 958
 959         $ErrorManager->pushErrorHandler(new WikiMethodCb($this, '_errorHandler'));
 960         xmlrpc_server::service();
 961         $ErrorManager->popErrorHandler();
 962     }
 963
 964     function _errorHandler($e)
 965     {
 966         $msg = htmlspecialchars($e->asString());
 967         // '--' not allowed within xml comment
 968         $msg = str_replace('--', '&#45;&#45;', $msg);
 969         if (function_exists('xmlrpc_debugmsg'))
 970             xmlrpc_debugmsg($msg);
 971         return true;
 972     }
 973 }
 974
 975 // Local Variables:
 976 // mode: php
 977 // tab-width: 8
 978 // c-basic-offset: 4
 979 // c-hanging-comment-ender-p: nil
 980 // indent-tabs-mode: nil
 981 // End: