1797c0d11SAndreas Gohr<?php 27aec69d1SGuy Brandif(!defined('DOKU_INC')) define('DOKU_INC',dirname(__FILE__).'/../../'); 3797c0d11SAndreas Gohr 4797c0d11SAndreas Gohr// fix when '<?xml' isn't on the very first line 5797c0d11SAndreas Gohrif(isset($HTTP_RAW_POST_DATA)) $HTTP_RAW_POST_DATA = trim($HTTP_RAW_POST_DATA); 6797c0d11SAndreas Gohr 7445e8084SAndreas Gohr/** 8445e8084SAndreas Gohr * Increased whenever the API is changed 9445e8084SAndreas Gohr */ 10e6f4c9d4SGeorges-Etienne Legendredefine('DOKU_XMLRPC_API_VERSION',4); 11797c0d11SAndreas Gohr 12797c0d11SAndreas Gohrrequire_once(DOKU_INC.'inc/init.php'); 13797c0d11SAndreas Gohrsession_write_close(); //close session 14593bf8f6SMichael Klier 153ee5b583SAndreas Gohrif(!$conf['xmlrpc']) die('XML-RPC server not enabled.'); 16593bf8f6SMichael Klier 17797c0d11SAndreas Gohr/** 18797c0d11SAndreas Gohr * Contains needed wrapper functions and registers all available 19797c0d11SAndreas Gohr * XMLRPC functions. 20797c0d11SAndreas Gohr */ 21797c0d11SAndreas Gohrclass dokuwiki_xmlrpc_server extends IXR_IntrospectionServer { 22797c0d11SAndreas Gohr var $methods = array(); 233ee5b583SAndreas Gohr var $public_methods = array(); 243ee5b583SAndreas Gohr 253ee5b583SAndreas Gohr /** 263ee5b583SAndreas Gohr * Checks if the current user is allowed to execute non anonymous methods 273ee5b583SAndreas Gohr */ 283ee5b583SAndreas Gohr function checkAuth(){ 293ee5b583SAndreas Gohr global $conf; 303ee5b583SAndreas Gohr global $USERINFO; 313ee5b583SAndreas Gohr 323ee5b583SAndreas Gohr if(!$conf['useacl']) return true; //no ACL - then no checks 333ee5b583SAndreas Gohr 343ee5b583SAndreas Gohr $allowed = explode(',',$conf['xmlrpcuser']); 353ee5b583SAndreas Gohr $allowed = array_map('trim', $allowed); 363ee5b583SAndreas Gohr $allowed = array_unique($allowed); 373ee5b583SAndreas Gohr $allowed = array_filter($allowed); 383ee5b583SAndreas Gohr 393ee5b583SAndreas Gohr if(!count($allowed)) return true; //no restrictions 403ee5b583SAndreas Gohr 413ee5b583SAndreas Gohr $user = $_SERVER['REMOTE_USER']; 423ee5b583SAndreas Gohr $groups = (array) $USERINFO['grps']; 433ee5b583SAndreas Gohr 443ee5b583SAndreas Gohr if(in_array($user,$allowed)) return true; //user explicitly mentioned 453ee5b583SAndreas Gohr 463ee5b583SAndreas Gohr //check group memberships 473ee5b583SAndreas Gohr foreach($groups as $group){ 483ee5b583SAndreas Gohr if(in_array('@'.$group,$allowed)) return true; 493ee5b583SAndreas Gohr } 503ee5b583SAndreas Gohr 513ee5b583SAndreas Gohr //still here? no access! 523ee5b583SAndreas Gohr return false; 533ee5b583SAndreas Gohr } 543ee5b583SAndreas Gohr 553ee5b583SAndreas Gohr /** 563ee5b583SAndreas Gohr * Adds a callback, extends parent method 573ee5b583SAndreas Gohr * 583ee5b583SAndreas Gohr * add another parameter to define if anonymous access to 593ee5b583SAndreas Gohr * this method should be granted. 603ee5b583SAndreas Gohr */ 613ee5b583SAndreas Gohr function addCallback($method, $callback, $args, $help, $public=false){ 623ee5b583SAndreas Gohr if($public) $this->public_methods[] = $method; 633ee5b583SAndreas Gohr return parent::addCallback($method, $callback, $args, $help); 643ee5b583SAndreas Gohr } 653ee5b583SAndreas Gohr 663ee5b583SAndreas Gohr /** 673ee5b583SAndreas Gohr * Execute a call, extends parent method 683ee5b583SAndreas Gohr * 693ee5b583SAndreas Gohr * Checks for authentication first 703ee5b583SAndreas Gohr */ 713ee5b583SAndreas Gohr function call($methodname, $args){ 723ee5b583SAndreas Gohr if(!in_array($methodname,$this->public_methods) && !$this->checkAuth()){ 733ee5b583SAndreas Gohr return new IXR_Error(-32603, 'server error. not authorized to call method "'.$methodname.'".'); 743ee5b583SAndreas Gohr } 753ee5b583SAndreas Gohr return parent::call($methodname, $args); 763ee5b583SAndreas Gohr } 77797c0d11SAndreas Gohr 78797c0d11SAndreas Gohr /** 79797c0d11SAndreas Gohr * Constructor. Register methods and run Server 80797c0d11SAndreas Gohr */ 81797c0d11SAndreas Gohr function dokuwiki_xmlrpc_server(){ 82797c0d11SAndreas Gohr $this->IXR_IntrospectionServer(); 83797c0d11SAndreas Gohr 84797c0d11SAndreas Gohr /* DokuWiki's own methods */ 85797c0d11SAndreas Gohr $this->addCallback( 86445e8084SAndreas Gohr 'dokuwiki.getXMLRPCAPIVersion', 87445e8084SAndreas Gohr 'this:getAPIVersion', 88445e8084SAndreas Gohr array('integer'), 893ee5b583SAndreas Gohr 'Returns the XMLRPC API version.', 903ee5b583SAndreas Gohr true 91445e8084SAndreas Gohr ); 92445e8084SAndreas Gohr 93445e8084SAndreas Gohr $this->addCallback( 94797c0d11SAndreas Gohr 'dokuwiki.getVersion', 95797c0d11SAndreas Gohr 'getVersion', 96797c0d11SAndreas Gohr array('string'), 973ee5b583SAndreas Gohr 'Returns the running DokuWiki version.', 983ee5b583SAndreas Gohr true 99797c0d11SAndreas Gohr ); 100797c0d11SAndreas Gohr 1011b11c097SAndreas Gohr $this->addCallback( 102445e8084SAndreas Gohr 'dokuwiki.login', 103445e8084SAndreas Gohr 'this:login', 104445e8084SAndreas Gohr array('integer','string','string'), 1053ee5b583SAndreas Gohr 'Tries to login with the given credentials and sets auth cookies.', 1063ee5b583SAndreas Gohr true 107445e8084SAndreas Gohr ); 108445e8084SAndreas Gohr 109445e8084SAndreas Gohr $this->addCallback( 1101b11c097SAndreas Gohr 'dokuwiki.getPagelist', 1111b11c097SAndreas Gohr 'this:readNamespace', 1121b11c097SAndreas Gohr array('struct','string','struct'), 1131b11c097SAndreas Gohr 'List all pages within the given namespace.' 1141b11c097SAndreas Gohr ); 1151b11c097SAndreas Gohr 1161b11c097SAndreas Gohr $this->addCallback( 117f71f4f53SAndreas Gohr 'dokuwiki.search', 118f71f4f53SAndreas Gohr 'this:search', 119f71f4f53SAndreas Gohr array('struct','string'), 120f71f4f53SAndreas Gohr 'Perform a fulltext search and return a list of matching pages' 121f71f4f53SAndreas Gohr ); 122f71f4f53SAndreas Gohr 123f71f4f53SAndreas Gohr $this->addCallback( 1241b11c097SAndreas Gohr 'dokuwiki.getTime', 1251b11c097SAndreas Gohr 'time', 1261b11c097SAndreas Gohr array('int'), 1271b11c097SAndreas Gohr 'Return the current time at the wiki server.' 1281b11c097SAndreas Gohr ); 1291b11c097SAndreas Gohr 13028ec3c76SAndreas Gohr $this->addCallback( 13128ec3c76SAndreas Gohr 'dokuwiki.setLocks', 13228ec3c76SAndreas Gohr 'this:setLocks', 13328ec3c76SAndreas Gohr array('struct','struct'), 13428ec3c76SAndreas Gohr 'Lock or unlock pages.' 13528ec3c76SAndreas Gohr ); 13628ec3c76SAndreas Gohr 137e6f4c9d4SGeorges-Etienne Legendre 138e6f4c9d4SGeorges-Etienne Legendre $this->addCallback( 139e6f4c9d4SGeorges-Etienne Legendre 'dokuwiki.getTitle', 140e6f4c9d4SGeorges-Etienne Legendre 'this:getTitle', 141e6f4c9d4SGeorges-Etienne Legendre array('string'), 142e6f4c9d4SGeorges-Etienne Legendre 'Returns the wiki title.', 143e6f4c9d4SGeorges-Etienne Legendre true 144e6f4c9d4SGeorges-Etienne Legendre ); 145e6f4c9d4SGeorges-Etienne Legendre 146797c0d11SAndreas Gohr /* Wiki API v2 http://www.jspwiki.org/wiki/WikiRPCInterface2 */ 147797c0d11SAndreas Gohr $this->addCallback( 148797c0d11SAndreas Gohr 'wiki.getRPCVersionSupported', 149797c0d11SAndreas Gohr 'this:wiki_RPCVersion', 150797c0d11SAndreas Gohr array('int'), 1513ee5b583SAndreas Gohr 'Returns 2 with the supported RPC API version.', 1523ee5b583SAndreas Gohr true 153797c0d11SAndreas Gohr ); 154797c0d11SAndreas Gohr $this->addCallback( 155797c0d11SAndreas Gohr 'wiki.getPage', 156797c0d11SAndreas Gohr 'this:rawPage', 157797c0d11SAndreas Gohr array('string','string'), 158797c0d11SAndreas Gohr 'Get the raw Wiki text of page, latest version.' 159797c0d11SAndreas Gohr ); 160797c0d11SAndreas Gohr $this->addCallback( 161797c0d11SAndreas Gohr 'wiki.getPageVersion', 162797c0d11SAndreas Gohr 'this:rawPage', 163797c0d11SAndreas Gohr array('string','string','int'), 164797c0d11SAndreas Gohr 'Get the raw Wiki text of page.' 165797c0d11SAndreas Gohr ); 166797c0d11SAndreas Gohr $this->addCallback( 167797c0d11SAndreas Gohr 'wiki.getPageHTML', 168797c0d11SAndreas Gohr 'this:htmlPage', 169797c0d11SAndreas Gohr array('string','string'), 170797c0d11SAndreas Gohr 'Return page in rendered HTML, latest version.' 171797c0d11SAndreas Gohr ); 172797c0d11SAndreas Gohr $this->addCallback( 173797c0d11SAndreas Gohr 'wiki.getPageHTMLVersion', 174797c0d11SAndreas Gohr 'this:htmlPage', 175797c0d11SAndreas Gohr array('string','string','int'), 176797c0d11SAndreas Gohr 'Return page in rendered HTML.' 177797c0d11SAndreas Gohr ); 178797c0d11SAndreas Gohr $this->addCallback( 179797c0d11SAndreas Gohr 'wiki.getAllPages', 180797c0d11SAndreas Gohr 'this:listPages', 181797c0d11SAndreas Gohr array('struct'), 182797c0d11SAndreas Gohr 'Returns a list of all pages. The result is an array of utf8 pagenames.' 183797c0d11SAndreas Gohr ); 184797c0d11SAndreas Gohr $this->addCallback( 18526bec61eSMichael Klier 'wiki.getAttachments', 18626bec61eSMichael Klier 'this:listAttachments', 187c63d1645SGina Haeussge array('struct', 'string', 'struct'), 18826bec61eSMichael Klier 'Returns a list of all media files.' 18926bec61eSMichael Klier ); 19026bec61eSMichael Klier $this->addCallback( 191797c0d11SAndreas Gohr 'wiki.getBackLinks', 192797c0d11SAndreas Gohr 'this:listBackLinks', 193797c0d11SAndreas Gohr array('struct','string'), 194797c0d11SAndreas Gohr 'Returns the pages that link to this page.' 195797c0d11SAndreas Gohr ); 196797c0d11SAndreas Gohr $this->addCallback( 197797c0d11SAndreas Gohr 'wiki.getPageInfo', 198797c0d11SAndreas Gohr 'this:pageInfo', 199797c0d11SAndreas Gohr array('struct','string'), 200797c0d11SAndreas Gohr 'Returns a struct with infos about the page.' 201797c0d11SAndreas Gohr ); 202797c0d11SAndreas Gohr $this->addCallback( 203797c0d11SAndreas Gohr 'wiki.getPageInfoVersion', 204797c0d11SAndreas Gohr 'this:pageInfo', 205797c0d11SAndreas Gohr array('struct','string','int'), 206797c0d11SAndreas Gohr 'Returns a struct with infos about the page.' 207797c0d11SAndreas Gohr ); 2083a1dad2dSDennis Ploeger $this->addCallback( 20973056168SMichael Klier 'wiki.getPageVersions', 21073056168SMichael Klier 'this:pageVersions', 21173056168SMichael Klier array('struct','string','int'), 21273056168SMichael Klier 'Returns the available revisions of the page.' 21373056168SMichael Klier ); 21473056168SMichael Klier $this->addCallback( 2153a1dad2dSDennis Ploeger 'wiki.putPage', 2163a1dad2dSDennis Ploeger 'this:putPage', 217222572bfSMichael Klier array('int', 'string', 'string', 'struct'), 218fdd2e9d6SMichael Klier 'Saves a wiki page.' 2193a1dad2dSDennis Ploeger ); 220beccd742SMichael Klier $this->addCallback( 221beccd742SMichael Klier 'wiki.listLinks', 222beccd742SMichael Klier 'this:listLinks', 223beccd742SMichael Klier array('struct','string'), 224fdd2e9d6SMichael Klier 'Lists all links contained in a wiki page.' 225beccd742SMichael Klier ); 22663dd0d58SMichael Klier $this->addCallback( 22763dd0d58SMichael Klier 'wiki.getRecentChanges', 22863dd0d58SMichael Klier 'this:getRecentChanges', 22963dd0d58SMichael Klier array('struct','int'), 23099c8d7f2Smichael 'Returns a struct about all recent changes since given timestamp.' 23199c8d7f2Smichael ); 23299c8d7f2Smichael $this->addCallback( 23399c8d7f2Smichael 'wiki.getRecentMediaChanges', 23499c8d7f2Smichael 'this:getRecentMediaChanges', 23599c8d7f2Smichael array('struct','int'), 23699c8d7f2Smichael 'Returns a struct about all recent media changes since given timestamp.' 23763dd0d58SMichael Klier ); 238e62b9ea5SMichael Klier $this->addCallback( 239e62b9ea5SMichael Klier 'wiki.aclCheck', 240e62b9ea5SMichael Klier 'this:aclCheck', 241c63d1645SGina Haeussge array('int', 'string'), 242e62b9ea5SMichael Klier 'Returns the permissions of a given wiki page.' 243e62b9ea5SMichael Klier ); 2442aca132fSMichael Klier $this->addCallback( 2452aca132fSMichael Klier 'wiki.putAttachment', 2462aca132fSMichael Klier 'this:putAttachment', 2472aca132fSMichael Klier array('struct', 'string', 'base64', 'struct'), 2482aca132fSMichael Klier 'Upload a file to the wiki.' 2492aca132fSMichael Klier ); 250cfef3001SGina Haeussge $this->addCallback( 251f01ff8c1SGina Haeussge 'wiki.deleteAttachment', 252f01ff8c1SGina Haeussge 'this:deleteAttachment', 253f01ff8c1SGina Haeussge array('int', 'string'), 254f01ff8c1SGina Haeussge 'Delete a file from the wiki.' 255f01ff8c1SGina Haeussge ); 256f01ff8c1SGina Haeussge $this->addCallback( 257cfef3001SGina Haeussge 'wiki.getAttachment', 258cfef3001SGina Haeussge 'this:getAttachment', 259c63d1645SGina Haeussge array('base64', 'string'), 260cfef3001SGina Haeussge 'Download a file from the wiki.' 261cfef3001SGina Haeussge ); 2625672e868SGina Haeussge $this->addCallback( 2635672e868SGina Haeussge 'wiki.getAttachmentInfo', 2645672e868SGina Haeussge 'this:getAttachmentInfo', 265c63d1645SGina Haeussge array('struct', 'string'), 2665672e868SGina Haeussge 'Returns a struct with infos about the attachment.' 2675672e868SGina Haeussge ); 268797c0d11SAndreas Gohr 269bb32615dSMichael Klier /** 270bb32615dSMichael Klier * Trigger XMLRPC_CALLBACK_REGISTER, action plugins can use this event 271bb32615dSMichael Klier * to extend the XMLRPC interface and register their own callbacks. 272bb32615dSMichael Klier * 273bb32615dSMichael Klier * Event data: 274bb32615dSMichael Klier * The XMLRPC server object: 275bb32615dSMichael Klier * 276bb32615dSMichael Klier * $event->data->addCallback() - register a callback, the second 277bb32615dSMichael Klier * paramter has to be of the form "plugin:<pluginname>:<plugin 278bb32615dSMichael Klier * method>" 279bb32615dSMichael Klier * 280bb32615dSMichael Klier * $event->data->callbacks - an array which holds all awaylable 281bb32615dSMichael Klier * callbacks 282bb32615dSMichael Klier */ 283bb32615dSMichael Klier trigger_event('XMLRPC_CALLBACK_REGISTER', $this); 284bb32615dSMichael Klier 285797c0d11SAndreas Gohr $this->serve(); 286797c0d11SAndreas Gohr } 287797c0d11SAndreas Gohr 288797c0d11SAndreas Gohr /** 289797c0d11SAndreas Gohr * Return a raw wiki page 290797c0d11SAndreas Gohr */ 291797c0d11SAndreas Gohr function rawPage($id,$rev=''){ 292797c0d11SAndreas Gohr if(auth_quickaclcheck($id) < AUTH_READ){ 293797c0d11SAndreas Gohr return new IXR_Error(1, 'You are not allowed to read this page'); 294797c0d11SAndreas Gohr } 2952c176304SMichael Klier $text = rawWiki($id,$rev); 2962c176304SMichael Klier if(!$text) { 297fe17917eSAdrian Lang return pageTemplate($id); 2982c176304SMichael Klier } else { 2992c176304SMichael Klier return $text; 3002c176304SMichael Klier } 301797c0d11SAndreas Gohr } 302797c0d11SAndreas Gohr 303797c0d11SAndreas Gohr /** 304cfef3001SGina Haeussge * Return a media file encoded in base64 305c63d1645SGina Haeussge * 306c63d1645SGina Haeussge * @author Gina Haeussge <osd@foosel.net> 307cfef3001SGina Haeussge */ 308cfef3001SGina Haeussge function getAttachment($id){ 309c63d1645SGina Haeussge $id = cleanID($id); 310cfef3001SGina Haeussge if (auth_quickaclcheck(getNS($id).':*') < AUTH_READ) 311cfef3001SGina Haeussge return new IXR_Error(1, 'You are not allowed to read this file'); 312cfef3001SGina Haeussge 313cfef3001SGina Haeussge $file = mediaFN($id); 314cfef3001SGina Haeussge if (!@ file_exists($file)) 315cfef3001SGina Haeussge return new IXR_Error(1, 'The requested file does not exist'); 316cfef3001SGina Haeussge 317cfef3001SGina Haeussge $data = io_readFile($file, false); 318cfef3001SGina Haeussge $base64 = base64_encode($data); 319cfef3001SGina Haeussge return $base64; 320cfef3001SGina Haeussge } 321cfef3001SGina Haeussge 322cfef3001SGina Haeussge /** 3235672e868SGina Haeussge * Return info about a media file 3245672e868SGina Haeussge * 3255672e868SGina Haeussge * @author Gina Haeussge <osd@foosel.net> 3265672e868SGina Haeussge */ 3275672e868SGina Haeussge function getAttachmentInfo($id){ 3285672e868SGina Haeussge $id = cleanID($id); 3295672e868SGina Haeussge $info = array( 3305672e868SGina Haeussge 'lastModified' => 0, 3315672e868SGina Haeussge 'size' => 0, 3325672e868SGina Haeussge ); 3335672e868SGina Haeussge 3345672e868SGina Haeussge $file = mediaFN($id); 3355672e868SGina Haeussge if ((auth_quickaclcheck(getNS($id).':*') >= AUTH_READ) && file_exists($file)){ 3365672e868SGina Haeussge $info['lastModified'] = new IXR_Date(filemtime($file)); 3375672e868SGina Haeussge $info['size'] = filesize($file); 3385672e868SGina Haeussge } 3395672e868SGina Haeussge 3405672e868SGina Haeussge return $info; 3415672e868SGina Haeussge } 3425672e868SGina Haeussge 3435672e868SGina Haeussge /** 344797c0d11SAndreas Gohr * Return a wiki page rendered to html 345797c0d11SAndreas Gohr */ 346797c0d11SAndreas Gohr function htmlPage($id,$rev=''){ 347797c0d11SAndreas Gohr if(auth_quickaclcheck($id) < AUTH_READ){ 348797c0d11SAndreas Gohr return new IXR_Error(1, 'You are not allowed to read this page'); 349797c0d11SAndreas Gohr } 350797c0d11SAndreas Gohr return p_wiki_xhtml($id,$rev,false); 351797c0d11SAndreas Gohr } 352797c0d11SAndreas Gohr 353797c0d11SAndreas Gohr /** 354797c0d11SAndreas Gohr * List all pages - we use the indexer list here 355797c0d11SAndreas Gohr */ 356797c0d11SAndreas Gohr function listPages(){ 357dfd13e55SMichael Klier $list = array(); 358*a0070b52SAdrian Lang $pages = array_filter(array_filter(idx_getIndex('page', ''), 359*a0070b52SAdrian Lang 'isVisiblePage'), 360*a0070b52SAdrian Lang 'page_exists'); 361dfd13e55SMichael Klier 362dfd13e55SMichael Klier foreach(array_keys($pages) as $idx) { 363dfd13e55SMichael Klier $perm = auth_quickaclcheck($pages[$idx]); 364*a0070b52SAdrian Lang if($perm < AUTH_READ) { 365*a0070b52SAdrian Lang continue; 366*a0070b52SAdrian Lang } 367dfd13e55SMichael Klier $page = array(); 368dfd13e55SMichael Klier $page['id'] = trim($pages[$idx]); 369dfd13e55SMichael Klier $page['perms'] = $perm; 370dfd13e55SMichael Klier $page['size'] = @filesize(wikiFN($pages[$idx])); 371e070c6f3SGina Haeussge $page['lastModified'] = new IXR_Date(@filemtime(wikiFN($pages[$idx]))); 372dfd13e55SMichael Klier $list[] = $page; 373dfd13e55SMichael Klier } 374dfd13e55SMichael Klier 375dfd13e55SMichael Klier return $list; 376797c0d11SAndreas Gohr } 377797c0d11SAndreas Gohr 378797c0d11SAndreas Gohr /** 3791b11c097SAndreas Gohr * List all pages in the given namespace (and below) 3801b11c097SAndreas Gohr */ 3811b11c097SAndreas Gohr function readNamespace($ns,$opts){ 3821b11c097SAndreas Gohr global $conf; 3831b11c097SAndreas Gohr 3841b11c097SAndreas Gohr if(!is_array($opts)) $opts=array(); 3851b11c097SAndreas Gohr 3861b11c097SAndreas Gohr $ns = cleanID($ns); 3871b11c097SAndreas Gohr $dir = utf8_encodeFN(str_replace(':', '/', $ns)); 3881b11c097SAndreas Gohr $data = array(); 3896fc3aa1aSAndreas Gohr $opts['skipacl'] = 0; // no ACL skipping for XMLRPC 3901b11c097SAndreas Gohr search($data, $conf['datadir'], 'search_allpages', $opts, $dir); 3911b11c097SAndreas Gohr return $data; 3921b11c097SAndreas Gohr } 3931b11c097SAndreas Gohr 3941b11c097SAndreas Gohr /** 395f71f4f53SAndreas Gohr * List all pages in the given namespace (and below) 396f71f4f53SAndreas Gohr */ 397f71f4f53SAndreas Gohr function search($query){ 398f71f4f53SAndreas Gohr require_once(DOKU_INC.'inc/fulltext.php'); 399f71f4f53SAndreas Gohr 400f71f4f53SAndreas Gohr $regex = ''; 401f71f4f53SAndreas Gohr $data = ft_pageSearch($query,$regex); 402f71f4f53SAndreas Gohr $pages = array(); 403f71f4f53SAndreas Gohr 404f71f4f53SAndreas Gohr // prepare additional data 405f71f4f53SAndreas Gohr $idx = 0; 406f71f4f53SAndreas Gohr foreach($data as $id => $score){ 407f71f4f53SAndreas Gohr $file = wikiFN($id); 408f71f4f53SAndreas Gohr 409f71f4f53SAndreas Gohr if($idx < FT_SNIPPET_NUMBER){ 410f71f4f53SAndreas Gohr $snippet = ft_snippet($id,$regex); 411f71f4f53SAndreas Gohr $idx++; 412f71f4f53SAndreas Gohr }else{ 413f71f4f53SAndreas Gohr $snippet = ''; 414f71f4f53SAndreas Gohr } 415f71f4f53SAndreas Gohr 416f71f4f53SAndreas Gohr $pages[] = array( 417f71f4f53SAndreas Gohr 'id' => $id, 418f71f4f53SAndreas Gohr 'score' => $score, 419f71f4f53SAndreas Gohr 'rev' => filemtime($file), 420f71f4f53SAndreas Gohr 'mtime' => filemtime($file), 421f71f4f53SAndreas Gohr 'size' => filesize($file), 422f71f4f53SAndreas Gohr 'snippet' => $snippet, 423f71f4f53SAndreas Gohr ); 424f71f4f53SAndreas Gohr } 425ac1ffddeSGeorges-Etienne Legendre return $pages; 426f71f4f53SAndreas Gohr } 427f71f4f53SAndreas Gohr 428e6f4c9d4SGeorges-Etienne Legendre /** 429e6f4c9d4SGeorges-Etienne Legendre * Returns the wiki title. 430e6f4c9d4SGeorges-Etienne Legendre */ 431e6f4c9d4SGeorges-Etienne Legendre function getTitle(){ 432e6f4c9d4SGeorges-Etienne Legendre global $conf; 433e6f4c9d4SGeorges-Etienne Legendre return $conf['title']; 434e6f4c9d4SGeorges-Etienne Legendre } 435f71f4f53SAndreas Gohr 436f71f4f53SAndreas Gohr /** 43726bec61eSMichael Klier * List all media files. 4383275953aSGina Haeussge * 4393275953aSGina Haeussge * Available options are 'recursive' for also including the subnamespaces 4403275953aSGina Haeussge * in the listing, and 'pattern' for filtering the returned files against 4413275953aSGina Haeussge * a regular expression matching their name. 4423275953aSGina Haeussge * 4433275953aSGina Haeussge * @author Gina Haeussge <osd@foosel.net> 44426bec61eSMichael Klier */ 4453275953aSGina Haeussge function listAttachments($ns, $options = array()) { 44626bec61eSMichael Klier global $conf; 44726bec61eSMichael Klier global $lang; 44826bec61eSMichael Klier 44926bec61eSMichael Klier $ns = cleanID($ns); 45026bec61eSMichael Klier 4516fc3aa1aSAndreas Gohr if (!is_array($options)) $options = array(); 4526fc3aa1aSAndreas Gohr $options['skipacl'] = 0; // no ACL skipping for XMLRPC 4533275953aSGina Haeussge 4543275953aSGina Haeussge 45526bec61eSMichael Klier if(auth_quickaclcheck($ns.':*') >= AUTH_READ) { 45626bec61eSMichael Klier $dir = utf8_encodeFN(str_replace(':', '/', $ns)); 45726bec61eSMichael Klier 45826bec61eSMichael Klier $data = array(); 459224122cfSAndreas Gohr search($data, $conf['mediadir'], 'search_media', $options, $dir); 460224122cfSAndreas Gohr $len = count($data); 461224122cfSAndreas Gohr if(!$len) return array(); 46226bec61eSMichael Klier 463224122cfSAndreas Gohr for($i=0; $i<$len; $i++) { 464224122cfSAndreas Gohr unset($data[$i]['meta']); 465224122cfSAndreas Gohr $data[$i]['lastModified'] = new IXR_Date($data[$i]['mtime']); 46626bec61eSMichael Klier } 467224122cfSAndreas Gohr return $data; 46826bec61eSMichael Klier } else { 46926bec61eSMichael Klier return new IXR_Error(1, 'You are not allowed to list media files.'); 47026bec61eSMichael Klier } 47126bec61eSMichael Klier } 47226bec61eSMichael Klier 47326bec61eSMichael Klier /** 474797c0d11SAndreas Gohr * Return a list of backlinks 475797c0d11SAndreas Gohr */ 476beccd742SMichael Klier function listBackLinks($id){ 47786228f10SDominik Eckelmann return ft_backlinks(cleanID($id)); 478797c0d11SAndreas Gohr } 479797c0d11SAndreas Gohr 480797c0d11SAndreas Gohr /** 48163dd0d58SMichael Klier * Return some basic data about a page 482797c0d11SAndreas Gohr */ 483797c0d11SAndreas Gohr function pageInfo($id,$rev=''){ 484797c0d11SAndreas Gohr if(auth_quickaclcheck($id) < AUTH_READ){ 485797c0d11SAndreas Gohr return new IXR_Error(1, 'You are not allowed to read this page'); 486797c0d11SAndreas Gohr } 487797c0d11SAndreas Gohr $file = wikiFN($id,$rev); 488797c0d11SAndreas Gohr $time = @filemtime($file); 489797c0d11SAndreas Gohr if(!$time){ 490797c0d11SAndreas Gohr return new IXR_Error(10, 'The requested page does not exist'); 491797c0d11SAndreas Gohr } 492797c0d11SAndreas Gohr 493797c0d11SAndreas Gohr $info = getRevisionInfo($id, $time, 1024); 494797c0d11SAndreas Gohr 495797c0d11SAndreas Gohr $data = array( 496797c0d11SAndreas Gohr 'name' => $id, 497797c0d11SAndreas Gohr 'lastModified' => new IXR_Date($time), 498797c0d11SAndreas Gohr 'author' => (($info['user']) ? $info['user'] : $info['ip']), 499797c0d11SAndreas Gohr 'version' => $time 500797c0d11SAndreas Gohr ); 50163dd0d58SMichael Klier 50263dd0d58SMichael Klier return ($data); 503797c0d11SAndreas Gohr } 504797c0d11SAndreas Gohr 505797c0d11SAndreas Gohr /** 5063a1dad2dSDennis Ploeger * Save a wiki page 507222572bfSMichael Klier * 508222572bfSMichael Klier * @author Michael Klier <chi@chimeric.de> 5093a1dad2dSDennis Ploeger */ 510222572bfSMichael Klier function putPage($id, $text, $params) { 5113a1dad2dSDennis Ploeger global $TEXT; 512a6a229ceSMichael Klier global $lang; 513593bf8f6SMichael Klier global $conf; 5143a1dad2dSDennis Ploeger 515222572bfSMichael Klier $id = cleanID($id); 51656523eecSAndreas Gohr $TEXT = cleanText($text); 517222572bfSMichael Klier $sum = $params['sum']; 518222572bfSMichael Klier $minor = $params['minor']; 519222572bfSMichael Klier 520222572bfSMichael Klier if(empty($id)) 521fdd2e9d6SMichael Klier return new IXR_Error(1, 'Empty page ID'); 522222572bfSMichael Klier 52356523eecSAndreas Gohr if(!page_exists($id) && trim($TEXT) == '' ) { 52451597811SMichael Klier return new IXR_ERROR(1, 'Refusing to write an empty new wiki page'); 52551597811SMichael Klier } 52651597811SMichael Klier 527055b0144SChris Smith if(auth_quickaclcheck($id) < AUTH_EDIT) 528222572bfSMichael Klier return new IXR_Error(1, 'You are not allowed to edit this page'); 5293a1dad2dSDennis Ploeger 5303a1dad2dSDennis Ploeger // Check, if page is locked 531222572bfSMichael Klier if(checklock($id)) 532222572bfSMichael Klier return new IXR_Error(1, 'The page is currently locked'); 533222572bfSMichael Klier 534a6a229ceSMichael Klier // SPAM check 5353a1dad2dSDennis Ploeger if(checkwordblock()) 536222572bfSMichael Klier return new IXR_Error(1, 'Positive wordblock check'); 5373a1dad2dSDennis Ploeger 538a6a229ceSMichael Klier // autoset summary on new pages 539a6a229ceSMichael Klier if(!page_exists($id) && empty($sum)) { 540a6a229ceSMichael Klier $sum = $lang['created']; 541a6a229ceSMichael Klier } 542a6a229ceSMichael Klier 543a6a229ceSMichael Klier // autoset summary on deleted pages 544a6a229ceSMichael Klier if(page_exists($id) && empty($TEXT) && empty($sum)) { 545a6a229ceSMichael Klier $sum = $lang['deleted']; 546a6a229ceSMichael Klier } 547a6a229ceSMichael Klier 548222572bfSMichael Klier lock($id); 5493a1dad2dSDennis Ploeger 550222572bfSMichael Klier saveWikiText($id,$TEXT,$sum,$minor); 5513a1dad2dSDennis Ploeger 552222572bfSMichael Klier unlock($id); 5533a1dad2dSDennis Ploeger 554593bf8f6SMichael Klier // run the indexer if page wasn't indexed yet 555593bf8f6SMichael Klier if(!@file_exists(metaFN($id, '.indexed'))) { 556593bf8f6SMichael Klier // try to aquire a lock 557593bf8f6SMichael Klier $lock = $conf['lockdir'].'/_indexer.lock'; 558593bf8f6SMichael Klier while(!@mkdir($lock,$conf['dmode'])){ 559593bf8f6SMichael Klier usleep(50); 560593bf8f6SMichael Klier if(time()-@filemtime($lock) > 60*5){ 561593bf8f6SMichael Klier // looks like a stale lock - remove it 562593bf8f6SMichael Klier @rmdir($lock); 563593bf8f6SMichael Klier }else{ 564593bf8f6SMichael Klier return false; 565593bf8f6SMichael Klier } 566593bf8f6SMichael Klier } 567593bf8f6SMichael Klier if($conf['dperm']) chmod($lock, $conf['dperm']); 568593bf8f6SMichael Klier 569593bf8f6SMichael Klier // do the work 570593bf8f6SMichael Klier idx_addPage($id); 571593bf8f6SMichael Klier 572593bf8f6SMichael Klier // we're finished - save and free lock 573593bf8f6SMichael Klier io_saveFile(metaFN($id,'.indexed'),INDEXER_VERSION); 574593bf8f6SMichael Klier @rmdir($lock); 575593bf8f6SMichael Klier } 576593bf8f6SMichael Klier 5773a1dad2dSDennis Ploeger return 0; 578beccd742SMichael Klier } 5793a1dad2dSDennis Ploeger 580beccd742SMichael Klier /** 5812aca132fSMichael Klier * Uploads a file to the wiki. 5822aca132fSMichael Klier * 5832aca132fSMichael Klier * Michael Klier <chi@chimeric.de> 5842aca132fSMichael Klier */ 585f01ff8c1SGina Haeussge function putAttachment($id, $file, $params) { 5862aca132fSMichael Klier global $conf; 5872aca132fSMichael Klier global $lang; 5882aca132fSMichael Klier 589f01ff8c1SGina Haeussge $auth = auth_quickaclcheck(getNS($id).':*'); 5902aca132fSMichael Klier if($auth >= AUTH_UPLOAD) { 591f01ff8c1SGina Haeussge if(!isset($id)) { 5922aca132fSMichael Klier return new IXR_ERROR(1, 'Filename not given.'); 5932aca132fSMichael Klier } 5942aca132fSMichael Klier 595c77fa67bSMichael Hamann $ftmp = $conf['tmpdir'] . '/' . md5($id.clientIP()); 5962aca132fSMichael Klier 5972aca132fSMichael Klier // save temporary file 5982aca132fSMichael Klier @unlink($ftmp); 5992aca132fSMichael Klier $buff = base64_decode($file); 6002aca132fSMichael Klier io_saveFile($ftmp, $buff); 6012aca132fSMichael Klier 6022aca132fSMichael Klier // get filename 603ecebf3a8SAndreas Gohr list($iext, $imime,$dl) = mimetype($id); 604f01ff8c1SGina Haeussge $id = cleanID($id); 6052aca132fSMichael Klier $fn = mediaFN($id); 6062aca132fSMichael Klier 6072aca132fSMichael Klier // get filetype regexp 6082aca132fSMichael Klier $types = array_keys(getMimeTypes()); 6092aca132fSMichael Klier $types = array_map(create_function('$q','return preg_quote($q,"/");'),$types); 6102aca132fSMichael Klier $regex = join('|',$types); 6112aca132fSMichael Klier 6122aca132fSMichael Klier // because a temp file was created already 6132aca132fSMichael Klier if(preg_match('/\.('.$regex.')$/i',$fn)) { 6142aca132fSMichael Klier //check for overwrite 61599c8d7f2Smichael $overwrite = @file_exists($fn); 61699c8d7f2Smichael if($overwrite && (!$params['ow'] || $auth < AUTH_DELETE)) { 617224122cfSAndreas Gohr return new IXR_ERROR(1, $lang['uploadexist'].'1'); 6182aca132fSMichael Klier } 6192aca132fSMichael Klier // check for valid content 6202aca132fSMichael Klier $ok = media_contentcheck($ftmp, $imime); 6212aca132fSMichael Klier if($ok == -1) { 622224122cfSAndreas Gohr return new IXR_ERROR(1, sprintf($lang['uploadexist'].'2', ".$iext")); 6232aca132fSMichael Klier } elseif($ok == -2) { 6242aca132fSMichael Klier return new IXR_ERROR(1, $lang['uploadspam']); 6252aca132fSMichael Klier } elseif($ok == -3) { 6262aca132fSMichael Klier return new IXR_ERROR(1, $lang['uploadxss']); 6272aca132fSMichael Klier } 6282aca132fSMichael Klier 6292aca132fSMichael Klier // prepare event data 6302aca132fSMichael Klier $data[0] = $ftmp; 6312aca132fSMichael Klier $data[1] = $fn; 6322aca132fSMichael Klier $data[2] = $id; 6332aca132fSMichael Klier $data[3] = $imime; 63499c8d7f2Smichael $data[4] = $overwrite; 6352aca132fSMichael Klier 6362aca132fSMichael Klier // trigger event 6372aca132fSMichael Klier return trigger_event('MEDIA_UPLOAD_FINISH', $data, array($this, '_media_upload_action'), true); 6382aca132fSMichael Klier 6392aca132fSMichael Klier } else { 6402aca132fSMichael Klier return new IXR_ERROR(1, $lang['uploadwrong']); 6412aca132fSMichael Klier } 6422aca132fSMichael Klier } else { 6432aca132fSMichael Klier return new IXR_ERROR(1, "You don't have permissions to upload files."); 6442aca132fSMichael Klier } 6452aca132fSMichael Klier } 6462aca132fSMichael Klier 6472aca132fSMichael Klier /** 648f01ff8c1SGina Haeussge * Deletes a file from the wiki. 649f01ff8c1SGina Haeussge * 650f01ff8c1SGina Haeussge * @author Gina Haeussge <osd@foosel.net> 651f01ff8c1SGina Haeussge */ 652f01ff8c1SGina Haeussge function deleteAttachment($id){ 653f01ff8c1SGina Haeussge $auth = auth_quickaclcheck(getNS($id).':*'); 654f01ff8c1SGina Haeussge if($auth < AUTH_DELETE) return new IXR_ERROR(1, "You don't have permissions to delete files."); 655f01ff8c1SGina Haeussge global $conf; 656f01ff8c1SGina Haeussge global $lang; 657f01ff8c1SGina Haeussge 658f01ff8c1SGina Haeussge // check for references if needed 659f01ff8c1SGina Haeussge $mediareferences = array(); 660f01ff8c1SGina Haeussge if($conf['refcheck']){ 661f01ff8c1SGina Haeussge $mediareferences = ft_mediause($id,$conf['refshow']); 662f01ff8c1SGina Haeussge } 663f01ff8c1SGina Haeussge 664f01ff8c1SGina Haeussge if(!count($mediareferences)){ 665f01ff8c1SGina Haeussge $file = mediaFN($id); 666f01ff8c1SGina Haeussge if(@unlink($file)){ 66799c8d7f2Smichael addMediaLogEntry(time(), $id, DOKU_CHANGE_TYPE_DELETE); 668f01ff8c1SGina Haeussge io_sweepNS($id,'mediadir'); 669f01ff8c1SGina Haeussge return 0; 670f01ff8c1SGina Haeussge } 671f01ff8c1SGina Haeussge //something went wrong 672f01ff8c1SGina Haeussge return new IXR_ERROR(1, 'Could not delete file'); 673f01ff8c1SGina Haeussge } else { 674f01ff8c1SGina Haeussge return new IXR_ERROR(1, 'File is still referenced'); 675f01ff8c1SGina Haeussge } 676f01ff8c1SGina Haeussge } 677f01ff8c1SGina Haeussge 678f01ff8c1SGina Haeussge /** 6792aca132fSMichael Klier * Moves the temporary file to its final destination. 6802aca132fSMichael Klier * 6812aca132fSMichael Klier * Michael Klier <chi@chimeric.de> 6822aca132fSMichael Klier */ 6832aca132fSMichael Klier function _media_upload_action($data) { 6842aca132fSMichael Klier global $conf; 6852aca132fSMichael Klier 68699c8d7f2Smichael if(is_array($data) && count($data)===5) { 6872aca132fSMichael Klier io_createNamespace($data[2], 'media'); 6882aca132fSMichael Klier if(rename($data[0], $data[1])) { 6892aca132fSMichael Klier chmod($data[1], $conf['fmode']); 6902aca132fSMichael Klier media_notify($data[2], $data[1], $data[3]); 69199c8d7f2Smichael // add a log entry to the media changelog 69299c8d7f2Smichael if ($data[4]) { 69399c8d7f2Smichael addMediaLogEntry(time(), $data[2], DOKU_CHANGE_TYPE_EDIT); 69499c8d7f2Smichael } else { 69599c8d7f2Smichael addMediaLogEntry(time(), $data[2], DOKU_CHANGE_TYPE_CREATE); 69699c8d7f2Smichael } 6972aca132fSMichael Klier return $data[2]; 6982aca132fSMichael Klier } else { 6992aca132fSMichael Klier return new IXR_ERROR(1, 'Upload failed.'); 7002aca132fSMichael Klier } 7012aca132fSMichael Klier } else { 7022aca132fSMichael Klier return new IXR_ERROR(1, 'Upload failed.'); 7032aca132fSMichael Klier } 7042aca132fSMichael Klier } 7052aca132fSMichael Klier 7062aca132fSMichael Klier /** 707e62b9ea5SMichael Klier * Returns the permissions of a given wiki page 708e62b9ea5SMichael Klier */ 709e62b9ea5SMichael Klier function aclCheck($id) { 710e62b9ea5SMichael Klier return auth_quickaclcheck($id); 711e62b9ea5SMichael Klier } 712e62b9ea5SMichael Klier 713e62b9ea5SMichael Klier /** 714beccd742SMichael Klier * Lists all links contained in a wiki page 71563dd0d58SMichael Klier * 71663dd0d58SMichael Klier * @author Michael Klier <chi@chimeric.de> 717beccd742SMichael Klier */ 718beccd742SMichael Klier function listLinks($id) { 719beccd742SMichael Klier if(auth_quickaclcheck($id) < AUTH_READ){ 720beccd742SMichael Klier return new IXR_Error(1, 'You are not allowed to read this page'); 721beccd742SMichael Klier } 722beccd742SMichael Klier $links = array(); 723beccd742SMichael Klier 724beccd742SMichael Klier // resolve page instructions 725beccd742SMichael Klier $ins = p_cached_instructions(wikiFN(cleanID($id))); 726beccd742SMichael Klier 727beccd742SMichael Klier // instantiate new Renderer - needed for interwiki links 728beccd742SMichael Klier include(DOKU_INC.'inc/parser/xhtml.php'); 729beccd742SMichael Klier $Renderer = new Doku_Renderer_xhtml(); 730beccd742SMichael Klier $Renderer->interwiki = getInterwiki(); 731beccd742SMichael Klier 732beccd742SMichael Klier // parse parse instructions 733beccd742SMichael Klier foreach($ins as $in) { 734beccd742SMichael Klier $link = array(); 735beccd742SMichael Klier switch($in[0]) { 736beccd742SMichael Klier case 'internallink': 737beccd742SMichael Klier $link['type'] = 'local'; 738beccd742SMichael Klier $link['page'] = $in[1][0]; 739beccd742SMichael Klier $link['href'] = wl($in[1][0]); 740beccd742SMichael Klier array_push($links,$link); 741beccd742SMichael Klier break; 742beccd742SMichael Klier case 'externallink': 743beccd742SMichael Klier $link['type'] = 'extern'; 744beccd742SMichael Klier $link['page'] = $in[1][0]; 745beccd742SMichael Klier $link['href'] = $in[1][0]; 746beccd742SMichael Klier array_push($links,$link); 747beccd742SMichael Klier break; 748beccd742SMichael Klier case 'interwikilink': 749beccd742SMichael Klier $url = $Renderer->_resolveInterWiki($in[1][2],$in[1][3]); 750beccd742SMichael Klier $link['type'] = 'extern'; 751beccd742SMichael Klier $link['page'] = $url; 752beccd742SMichael Klier $link['href'] = $url; 753beccd742SMichael Klier array_push($links,$link); 754beccd742SMichael Klier break; 755beccd742SMichael Klier } 756beccd742SMichael Klier } 757beccd742SMichael Klier 75863dd0d58SMichael Klier return ($links); 75963dd0d58SMichael Klier } 76063dd0d58SMichael Klier 76163dd0d58SMichael Klier /** 76263dd0d58SMichael Klier * Returns a list of recent changes since give timestamp 76363dd0d58SMichael Klier * 76499c8d7f2Smichael * @author Michael Hamann <michael@content-space.de> 76563dd0d58SMichael Klier * @author Michael Klier <chi@chimeric.de> 76663dd0d58SMichael Klier */ 76763dd0d58SMichael Klier function getRecentChanges($timestamp) { 76863dd0d58SMichael Klier if(strlen($timestamp) != 10) 76963dd0d58SMichael Klier return new IXR_Error(20, 'The provided value is not a valid timestamp'); 77063dd0d58SMichael Klier 77199c8d7f2Smichael $recents = getRecentsSince($timestamp); 77263dd0d58SMichael Klier 77399c8d7f2Smichael $changes = array(); 77463dd0d58SMichael Klier 77599c8d7f2Smichael foreach ($recents as $recent) { 77699c8d7f2Smichael $change = array(); 77799c8d7f2Smichael $change['name'] = $recent['id']; 77899c8d7f2Smichael $change['lastModified'] = new IXR_Date($recent['date']); 77999c8d7f2Smichael $change['author'] = $recent['user']; 78099c8d7f2Smichael $change['version'] = $recent['date']; 78199c8d7f2Smichael $change['perms'] = $recent['perms']; 78299c8d7f2Smichael $change['size'] = @filesize(wikiFN($recent['id'])); 78363dd0d58SMichael Klier array_push($changes, $change); 78499c8d7f2Smichael } 78599c8d7f2Smichael 78699c8d7f2Smichael if (!empty($changes)) { 78799c8d7f2Smichael return $changes; 78863dd0d58SMichael Klier } else { 78963dd0d58SMichael Klier // in case we still have nothing at this point 79063dd0d58SMichael Klier return new IXR_Error(30, 'There are no changes in the specified timeframe'); 7913a1dad2dSDennis Ploeger } 79299c8d7f2Smichael } 79399c8d7f2Smichael 79499c8d7f2Smichael /** 79599c8d7f2Smichael * Returns a list of recent media changes since give timestamp 79699c8d7f2Smichael * 79799c8d7f2Smichael * @author Michael Hamann <michael@content-space.de> 79899c8d7f2Smichael * @author Michael Klier <chi@chimeric.de> 79999c8d7f2Smichael */ 80099c8d7f2Smichael function getRecentMediaChanges($timestamp) { 80199c8d7f2Smichael if(strlen($timestamp) != 10) 80299c8d7f2Smichael return new IXR_Error(20, 'The provided value is not a valid timestamp'); 80399c8d7f2Smichael 80499c8d7f2Smichael $recents = getRecentsSince($timestamp, null, '', RECENTS_MEDIA_CHANGES); 80599c8d7f2Smichael 80699c8d7f2Smichael $changes = array(); 80799c8d7f2Smichael 80899c8d7f2Smichael foreach ($recents as $recent) { 80999c8d7f2Smichael $change = array(); 81099c8d7f2Smichael $change['name'] = $recent['id']; 81199c8d7f2Smichael $change['lastModified'] = new IXR_Date($recent['date']); 81299c8d7f2Smichael $change['author'] = $recent['user']; 81399c8d7f2Smichael $change['version'] = $recent['date']; 81499c8d7f2Smichael $change['perms'] = $recent['perms']; 815a4da2756Smichael $change['size'] = @filesize(mediaFN($recent['id'])); 81699c8d7f2Smichael array_push($changes, $change); 81799c8d7f2Smichael } 81899c8d7f2Smichael 81999c8d7f2Smichael if (!empty($changes)) { 82099c8d7f2Smichael return $changes; 82199c8d7f2Smichael } else { 82299c8d7f2Smichael // in case we still have nothing at this point 82399c8d7f2Smichael return new IXR_Error(30, 'There are no changes in the specified timeframe'); 82499c8d7f2Smichael } 82599c8d7f2Smichael } 8263a1dad2dSDennis Ploeger 8273a1dad2dSDennis Ploeger /** 82873056168SMichael Klier * Returns a list of available revisions of a given wiki page 82973056168SMichael Klier * 83073056168SMichael Klier * @author Michael Klier <chi@chimeric.de> 83173056168SMichael Klier */ 83273056168SMichael Klier function pageVersions($id, $first) { 83373056168SMichael Klier global $conf; 83473056168SMichael Klier 83573056168SMichael Klier $versions = array(); 83673056168SMichael Klier 83773056168SMichael Klier if(empty($id)) 83873056168SMichael Klier return new IXR_Error(1, 'Empty page ID'); 83973056168SMichael Klier 84073056168SMichael Klier $revisions = getRevisions($id, $first, $conf['recent']+1); 84173056168SMichael Klier 84273056168SMichael Klier if(count($revisions)==0 && $first!=0) { 84373056168SMichael Klier $first=0; 84473056168SMichael Klier $revisions = getRevisions($id, $first, $conf['recent']+1); 84573056168SMichael Klier } 84673056168SMichael Klier 84745c63471SMichael Klier if(count($revisions)>0 && $first==0) { 84845c63471SMichael Klier array_unshift($revisions, ''); // include current revision 84945c63471SMichael Klier array_pop($revisions); // remove extra log entry 85045c63471SMichael Klier } 85145c63471SMichael Klier 85273056168SMichael Klier $hasNext = false; 85373056168SMichael Klier if(count($revisions)>$conf['recent']) { 85473056168SMichael Klier $hasNext = true; 85573056168SMichael Klier array_pop($revisions); // remove extra log entry 85673056168SMichael Klier } 85773056168SMichael Klier 85873056168SMichael Klier if(!empty($revisions)) { 85973056168SMichael Klier foreach($revisions as $rev) { 86073056168SMichael Klier $file = wikiFN($id,$rev); 86173056168SMichael Klier $time = @filemtime($file); 86245c63471SMichael Klier // we check if the page actually exists, if this is not the 86345c63471SMichael Klier // case this can lead to less pages being returned than 86445c63471SMichael Klier // specified via $conf['recent'] 86573056168SMichael Klier if($time){ 86673056168SMichael Klier $info = getRevisionInfo($id, $time, 1024); 86773056168SMichael Klier if(!empty($info)) { 86873056168SMichael Klier $data['user'] = $info['user']; 86973056168SMichael Klier $data['ip'] = $info['ip']; 87073056168SMichael Klier $data['type'] = $info['type']; 87173056168SMichael Klier $data['sum'] = $info['sum']; 87273056168SMichael Klier $data['modified'] = new IXR_Date($info['date']); 87373056168SMichael Klier $data['version'] = $info['date']; 87473056168SMichael Klier array_push($versions, $data); 87573056168SMichael Klier } 87673056168SMichael Klier } 87773056168SMichael Klier } 87873056168SMichael Klier return $versions; 87973056168SMichael Klier } else { 88073056168SMichael Klier return array(); 88173056168SMichael Klier } 88273056168SMichael Klier } 88373056168SMichael Klier 88473056168SMichael Klier /** 885797c0d11SAndreas Gohr * The version of Wiki RPC API supported 886797c0d11SAndreas Gohr */ 887797c0d11SAndreas Gohr function wiki_RPCVersion(){ 888797c0d11SAndreas Gohr return 2; 889797c0d11SAndreas Gohr } 8901b11c097SAndreas Gohr 89128ec3c76SAndreas Gohr 89228ec3c76SAndreas Gohr /** 89328ec3c76SAndreas Gohr * Locks or unlocks a given batch of pages 89428ec3c76SAndreas Gohr * 89528ec3c76SAndreas Gohr * Give an associative array with two keys: lock and unlock. Both should contain a 89628ec3c76SAndreas Gohr * list of pages to lock or unlock 89728ec3c76SAndreas Gohr * 89828ec3c76SAndreas Gohr * Returns an associative array with the keys locked, lockfail, unlocked and 89928ec3c76SAndreas Gohr * unlockfail, each containing lists of pages. 90028ec3c76SAndreas Gohr */ 90128ec3c76SAndreas Gohr function setLocks($set){ 90228ec3c76SAndreas Gohr $locked = array(); 90328ec3c76SAndreas Gohr $lockfail = array(); 90428ec3c76SAndreas Gohr $unlocked = array(); 90528ec3c76SAndreas Gohr $unlockfail = array(); 90628ec3c76SAndreas Gohr 90728ec3c76SAndreas Gohr foreach((array) $set['lock'] as $id){ 90828ec3c76SAndreas Gohr if(checklock($id)){ 90928ec3c76SAndreas Gohr $lockfail[] = $id; 91028ec3c76SAndreas Gohr }else{ 91128ec3c76SAndreas Gohr lock($id); 91228ec3c76SAndreas Gohr $locked[] = $id; 91328ec3c76SAndreas Gohr } 91428ec3c76SAndreas Gohr } 91528ec3c76SAndreas Gohr 91628ec3c76SAndreas Gohr foreach((array) $set['unlock'] as $id){ 91728ec3c76SAndreas Gohr if(unlock($id)){ 91828ec3c76SAndreas Gohr $unlocked[] = $id; 91928ec3c76SAndreas Gohr }else{ 92028ec3c76SAndreas Gohr $unlockfail[] = $id; 92128ec3c76SAndreas Gohr } 92228ec3c76SAndreas Gohr } 92328ec3c76SAndreas Gohr 92428ec3c76SAndreas Gohr return array( 92528ec3c76SAndreas Gohr 'locked' => $locked, 92628ec3c76SAndreas Gohr 'lockfail' => $lockfail, 92728ec3c76SAndreas Gohr 'unlocked' => $unlocked, 92828ec3c76SAndreas Gohr 'unlockfail' => $unlockfail, 92928ec3c76SAndreas Gohr ); 93028ec3c76SAndreas Gohr } 93128ec3c76SAndreas Gohr 932445e8084SAndreas Gohr function getAPIVersion(){ 933445e8084SAndreas Gohr return DOKU_XMLRPC_API_VERSION; 934445e8084SAndreas Gohr } 935445e8084SAndreas Gohr 936445e8084SAndreas Gohr function login($user,$pass){ 937445e8084SAndreas Gohr global $conf; 938445e8084SAndreas Gohr global $auth; 939445e8084SAndreas Gohr if(!$conf['useacl']) return 0; 940445e8084SAndreas Gohr if(!$auth) return 0; 941445e8084SAndreas Gohr if($auth->canDo('external')){ 942445e8084SAndreas Gohr return $auth->trustExternal($user,$pass,false); 943445e8084SAndreas Gohr }else{ 944445e8084SAndreas Gohr return auth_login($user,$pass,false,true); 945445e8084SAndreas Gohr } 946445e8084SAndreas Gohr } 9473ee5b583SAndreas Gohr 9483ee5b583SAndreas Gohr 949797c0d11SAndreas Gohr} 950797c0d11SAndreas Gohr 951797c0d11SAndreas Gohr$server = new dokuwiki_xmlrpc_server(); 952797c0d11SAndreas Gohr 9532aca132fSMichael Klier// vim:ts=4:sw=4:et:enc=utf-8: 954