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 */ 10ba9418bcSHakan Sandelldefine('DOKU_XMLRPC_API_VERSION',5); 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 146ba9418bcSHakan Sandell $this->addCallback( 147ba9418bcSHakan Sandell 'dokuwiki.appendPage', 148ba9418bcSHakan Sandell 'this:appendPage', 149ba9418bcSHakan Sandell array('int', 'string', 'string', 'struct'), 150ba9418bcSHakan Sandell 'Append text to a wiki page.' 151ba9418bcSHakan Sandell ); 152ba9418bcSHakan Sandell 153797c0d11SAndreas Gohr /* Wiki API v2 http://www.jspwiki.org/wiki/WikiRPCInterface2 */ 154797c0d11SAndreas Gohr $this->addCallback( 155797c0d11SAndreas Gohr 'wiki.getRPCVersionSupported', 156797c0d11SAndreas Gohr 'this:wiki_RPCVersion', 157797c0d11SAndreas Gohr array('int'), 1583ee5b583SAndreas Gohr 'Returns 2 with the supported RPC API version.', 1593ee5b583SAndreas Gohr true 160797c0d11SAndreas Gohr ); 161797c0d11SAndreas Gohr $this->addCallback( 162797c0d11SAndreas Gohr 'wiki.getPage', 163797c0d11SAndreas Gohr 'this:rawPage', 164797c0d11SAndreas Gohr array('string','string'), 165797c0d11SAndreas Gohr 'Get the raw Wiki text of page, latest version.' 166797c0d11SAndreas Gohr ); 167797c0d11SAndreas Gohr $this->addCallback( 168797c0d11SAndreas Gohr 'wiki.getPageVersion', 169797c0d11SAndreas Gohr 'this:rawPage', 170797c0d11SAndreas Gohr array('string','string','int'), 171797c0d11SAndreas Gohr 'Get the raw Wiki text of page.' 172797c0d11SAndreas Gohr ); 173797c0d11SAndreas Gohr $this->addCallback( 174797c0d11SAndreas Gohr 'wiki.getPageHTML', 175797c0d11SAndreas Gohr 'this:htmlPage', 176797c0d11SAndreas Gohr array('string','string'), 177797c0d11SAndreas Gohr 'Return page in rendered HTML, latest version.' 178797c0d11SAndreas Gohr ); 179797c0d11SAndreas Gohr $this->addCallback( 180797c0d11SAndreas Gohr 'wiki.getPageHTMLVersion', 181797c0d11SAndreas Gohr 'this:htmlPage', 182797c0d11SAndreas Gohr array('string','string','int'), 183797c0d11SAndreas Gohr 'Return page in rendered HTML.' 184797c0d11SAndreas Gohr ); 185797c0d11SAndreas Gohr $this->addCallback( 186797c0d11SAndreas Gohr 'wiki.getAllPages', 187797c0d11SAndreas Gohr 'this:listPages', 188797c0d11SAndreas Gohr array('struct'), 189797c0d11SAndreas Gohr 'Returns a list of all pages. The result is an array of utf8 pagenames.' 190797c0d11SAndreas Gohr ); 191797c0d11SAndreas Gohr $this->addCallback( 19226bec61eSMichael Klier 'wiki.getAttachments', 19326bec61eSMichael Klier 'this:listAttachments', 194c63d1645SGina Haeussge array('struct', 'string', 'struct'), 19526bec61eSMichael Klier 'Returns a list of all media files.' 19626bec61eSMichael Klier ); 19726bec61eSMichael Klier $this->addCallback( 198797c0d11SAndreas Gohr 'wiki.getBackLinks', 199797c0d11SAndreas Gohr 'this:listBackLinks', 200797c0d11SAndreas Gohr array('struct','string'), 201797c0d11SAndreas Gohr 'Returns the pages that link to this page.' 202797c0d11SAndreas Gohr ); 203797c0d11SAndreas Gohr $this->addCallback( 204797c0d11SAndreas Gohr 'wiki.getPageInfo', 205797c0d11SAndreas Gohr 'this:pageInfo', 206797c0d11SAndreas Gohr array('struct','string'), 207797c0d11SAndreas Gohr 'Returns a struct with infos about the page.' 208797c0d11SAndreas Gohr ); 209797c0d11SAndreas Gohr $this->addCallback( 210797c0d11SAndreas Gohr 'wiki.getPageInfoVersion', 211797c0d11SAndreas Gohr 'this:pageInfo', 212797c0d11SAndreas Gohr array('struct','string','int'), 213797c0d11SAndreas Gohr 'Returns a struct with infos about the page.' 214797c0d11SAndreas Gohr ); 2153a1dad2dSDennis Ploeger $this->addCallback( 21673056168SMichael Klier 'wiki.getPageVersions', 21773056168SMichael Klier 'this:pageVersions', 21873056168SMichael Klier array('struct','string','int'), 21973056168SMichael Klier 'Returns the available revisions of the page.' 22073056168SMichael Klier ); 22173056168SMichael Klier $this->addCallback( 2223a1dad2dSDennis Ploeger 'wiki.putPage', 2233a1dad2dSDennis Ploeger 'this:putPage', 224222572bfSMichael Klier array('int', 'string', 'string', 'struct'), 225fdd2e9d6SMichael Klier 'Saves a wiki page.' 2263a1dad2dSDennis Ploeger ); 227beccd742SMichael Klier $this->addCallback( 228beccd742SMichael Klier 'wiki.listLinks', 229beccd742SMichael Klier 'this:listLinks', 230beccd742SMichael Klier array('struct','string'), 231fdd2e9d6SMichael Klier 'Lists all links contained in a wiki page.' 232beccd742SMichael Klier ); 23363dd0d58SMichael Klier $this->addCallback( 23463dd0d58SMichael Klier 'wiki.getRecentChanges', 23563dd0d58SMichael Klier 'this:getRecentChanges', 23663dd0d58SMichael Klier array('struct','int'), 23799c8d7f2Smichael 'Returns a struct about all recent changes since given timestamp.' 23899c8d7f2Smichael ); 23999c8d7f2Smichael $this->addCallback( 24099c8d7f2Smichael 'wiki.getRecentMediaChanges', 24199c8d7f2Smichael 'this:getRecentMediaChanges', 24299c8d7f2Smichael array('struct','int'), 24399c8d7f2Smichael 'Returns a struct about all recent media changes since given timestamp.' 24463dd0d58SMichael Klier ); 245e62b9ea5SMichael Klier $this->addCallback( 246e62b9ea5SMichael Klier 'wiki.aclCheck', 247e62b9ea5SMichael Klier 'this:aclCheck', 248c63d1645SGina Haeussge array('int', 'string'), 249e62b9ea5SMichael Klier 'Returns the permissions of a given wiki page.' 250e62b9ea5SMichael Klier ); 2512aca132fSMichael Klier $this->addCallback( 2522aca132fSMichael Klier 'wiki.putAttachment', 2532aca132fSMichael Klier 'this:putAttachment', 2542aca132fSMichael Klier array('struct', 'string', 'base64', 'struct'), 2552aca132fSMichael Klier 'Upload a file to the wiki.' 2562aca132fSMichael Klier ); 257cfef3001SGina Haeussge $this->addCallback( 258f01ff8c1SGina Haeussge 'wiki.deleteAttachment', 259f01ff8c1SGina Haeussge 'this:deleteAttachment', 260f01ff8c1SGina Haeussge array('int', 'string'), 261f01ff8c1SGina Haeussge 'Delete a file from the wiki.' 262f01ff8c1SGina Haeussge ); 263f01ff8c1SGina Haeussge $this->addCallback( 264cfef3001SGina Haeussge 'wiki.getAttachment', 265cfef3001SGina Haeussge 'this:getAttachment', 266c63d1645SGina Haeussge array('base64', 'string'), 267cfef3001SGina Haeussge 'Download a file from the wiki.' 268cfef3001SGina Haeussge ); 2695672e868SGina Haeussge $this->addCallback( 2705672e868SGina Haeussge 'wiki.getAttachmentInfo', 2715672e868SGina Haeussge 'this:getAttachmentInfo', 272c63d1645SGina Haeussge array('struct', 'string'), 2735672e868SGina Haeussge 'Returns a struct with infos about the attachment.' 2745672e868SGina Haeussge ); 275797c0d11SAndreas Gohr 276bb32615dSMichael Klier /** 277bb32615dSMichael Klier * Trigger XMLRPC_CALLBACK_REGISTER, action plugins can use this event 278bb32615dSMichael Klier * to extend the XMLRPC interface and register their own callbacks. 279bb32615dSMichael Klier * 280bb32615dSMichael Klier * Event data: 281bb32615dSMichael Klier * The XMLRPC server object: 282bb32615dSMichael Klier * 283bb32615dSMichael Klier * $event->data->addCallback() - register a callback, the second 284bb32615dSMichael Klier * paramter has to be of the form "plugin:<pluginname>:<plugin 285bb32615dSMichael Klier * method>" 286bb32615dSMichael Klier * 287bb32615dSMichael Klier * $event->data->callbacks - an array which holds all awaylable 288bb32615dSMichael Klier * callbacks 289bb32615dSMichael Klier */ 290bb32615dSMichael Klier trigger_event('XMLRPC_CALLBACK_REGISTER', $this); 291bb32615dSMichael Klier 292797c0d11SAndreas Gohr $this->serve(); 293797c0d11SAndreas Gohr } 294797c0d11SAndreas Gohr 295797c0d11SAndreas Gohr /** 296797c0d11SAndreas Gohr * Return a raw wiki page 297797c0d11SAndreas Gohr */ 298797c0d11SAndreas Gohr function rawPage($id,$rev=''){ 299*eff795acSMichael Hamann $id = cleanID($id); 300797c0d11SAndreas Gohr if(auth_quickaclcheck($id) < AUTH_READ){ 301797c0d11SAndreas Gohr return new IXR_Error(1, 'You are not allowed to read this page'); 302797c0d11SAndreas Gohr } 3032c176304SMichael Klier $text = rawWiki($id,$rev); 3042c176304SMichael Klier if(!$text) { 305fe17917eSAdrian Lang return pageTemplate($id); 3062c176304SMichael Klier } else { 3072c176304SMichael Klier return $text; 3082c176304SMichael Klier } 309797c0d11SAndreas Gohr } 310797c0d11SAndreas Gohr 311797c0d11SAndreas Gohr /** 312cfef3001SGina Haeussge * Return a media file encoded in base64 313c63d1645SGina Haeussge * 314c63d1645SGina Haeussge * @author Gina Haeussge <osd@foosel.net> 315cfef3001SGina Haeussge */ 316cfef3001SGina Haeussge function getAttachment($id){ 317c63d1645SGina Haeussge $id = cleanID($id); 318cfef3001SGina Haeussge if (auth_quickaclcheck(getNS($id).':*') < AUTH_READ) 319cfef3001SGina Haeussge return new IXR_Error(1, 'You are not allowed to read this file'); 320cfef3001SGina Haeussge 321cfef3001SGina Haeussge $file = mediaFN($id); 322cfef3001SGina Haeussge if (!@ file_exists($file)) 323cfef3001SGina Haeussge return new IXR_Error(1, 'The requested file does not exist'); 324cfef3001SGina Haeussge 325cfef3001SGina Haeussge $data = io_readFile($file, false); 326cfef3001SGina Haeussge $base64 = base64_encode($data); 327cfef3001SGina Haeussge return $base64; 328cfef3001SGina Haeussge } 329cfef3001SGina Haeussge 330cfef3001SGina Haeussge /** 3315672e868SGina Haeussge * Return info about a media file 3325672e868SGina Haeussge * 3335672e868SGina Haeussge * @author Gina Haeussge <osd@foosel.net> 3345672e868SGina Haeussge */ 3355672e868SGina Haeussge function getAttachmentInfo($id){ 3365672e868SGina Haeussge $id = cleanID($id); 3375672e868SGina Haeussge $info = array( 3385672e868SGina Haeussge 'lastModified' => 0, 3395672e868SGina Haeussge 'size' => 0, 3405672e868SGina Haeussge ); 3415672e868SGina Haeussge 3425672e868SGina Haeussge $file = mediaFN($id); 3435672e868SGina Haeussge if ((auth_quickaclcheck(getNS($id).':*') >= AUTH_READ) && file_exists($file)){ 3445672e868SGina Haeussge $info['lastModified'] = new IXR_Date(filemtime($file)); 3455672e868SGina Haeussge $info['size'] = filesize($file); 3465672e868SGina Haeussge } 3475672e868SGina Haeussge 3485672e868SGina Haeussge return $info; 3495672e868SGina Haeussge } 3505672e868SGina Haeussge 3515672e868SGina Haeussge /** 352797c0d11SAndreas Gohr * Return a wiki page rendered to html 353797c0d11SAndreas Gohr */ 354797c0d11SAndreas Gohr function htmlPage($id,$rev=''){ 355*eff795acSMichael Hamann $id = cleanID($id); 356797c0d11SAndreas Gohr if(auth_quickaclcheck($id) < AUTH_READ){ 357797c0d11SAndreas Gohr return new IXR_Error(1, 'You are not allowed to read this page'); 358797c0d11SAndreas Gohr } 359797c0d11SAndreas Gohr return p_wiki_xhtml($id,$rev,false); 360797c0d11SAndreas Gohr } 361797c0d11SAndreas Gohr 362797c0d11SAndreas Gohr /** 363797c0d11SAndreas Gohr * List all pages - we use the indexer list here 364797c0d11SAndreas Gohr */ 365797c0d11SAndreas Gohr function listPages(){ 366dfd13e55SMichael Klier $list = array(); 367a0070b52SAdrian Lang $pages = array_filter(array_filter(idx_getIndex('page', ''), 368a0070b52SAdrian Lang 'isVisiblePage'), 369a0070b52SAdrian Lang 'page_exists'); 370dfd13e55SMichael Klier 371dfd13e55SMichael Klier foreach(array_keys($pages) as $idx) { 372dfd13e55SMichael Klier $perm = auth_quickaclcheck($pages[$idx]); 373a0070b52SAdrian Lang if($perm < AUTH_READ) { 374a0070b52SAdrian Lang continue; 375a0070b52SAdrian Lang } 376dfd13e55SMichael Klier $page = array(); 377dfd13e55SMichael Klier $page['id'] = trim($pages[$idx]); 378dfd13e55SMichael Klier $page['perms'] = $perm; 379dfd13e55SMichael Klier $page['size'] = @filesize(wikiFN($pages[$idx])); 380e070c6f3SGina Haeussge $page['lastModified'] = new IXR_Date(@filemtime(wikiFN($pages[$idx]))); 381dfd13e55SMichael Klier $list[] = $page; 382dfd13e55SMichael Klier } 383dfd13e55SMichael Klier 384dfd13e55SMichael Klier return $list; 385797c0d11SAndreas Gohr } 386797c0d11SAndreas Gohr 387797c0d11SAndreas Gohr /** 3881b11c097SAndreas Gohr * List all pages in the given namespace (and below) 3891b11c097SAndreas Gohr */ 3901b11c097SAndreas Gohr function readNamespace($ns,$opts){ 3911b11c097SAndreas Gohr global $conf; 3921b11c097SAndreas Gohr 3931b11c097SAndreas Gohr if(!is_array($opts)) $opts=array(); 3941b11c097SAndreas Gohr 3951b11c097SAndreas Gohr $ns = cleanID($ns); 3961b11c097SAndreas Gohr $dir = utf8_encodeFN(str_replace(':', '/', $ns)); 3971b11c097SAndreas Gohr $data = array(); 3986fc3aa1aSAndreas Gohr $opts['skipacl'] = 0; // no ACL skipping for XMLRPC 3991b11c097SAndreas Gohr search($data, $conf['datadir'], 'search_allpages', $opts, $dir); 4001b11c097SAndreas Gohr return $data; 4011b11c097SAndreas Gohr } 4021b11c097SAndreas Gohr 4031b11c097SAndreas Gohr /** 404f71f4f53SAndreas Gohr * List all pages in the given namespace (and below) 405f71f4f53SAndreas Gohr */ 406f71f4f53SAndreas Gohr function search($query){ 407f71f4f53SAndreas Gohr require_once(DOKU_INC.'inc/fulltext.php'); 408f71f4f53SAndreas Gohr 409f71f4f53SAndreas Gohr $regex = ''; 410f71f4f53SAndreas Gohr $data = ft_pageSearch($query,$regex); 411f71f4f53SAndreas Gohr $pages = array(); 412f71f4f53SAndreas Gohr 413f71f4f53SAndreas Gohr // prepare additional data 414f71f4f53SAndreas Gohr $idx = 0; 415f71f4f53SAndreas Gohr foreach($data as $id => $score){ 416f71f4f53SAndreas Gohr $file = wikiFN($id); 417f71f4f53SAndreas Gohr 418f71f4f53SAndreas Gohr if($idx < FT_SNIPPET_NUMBER){ 419f71f4f53SAndreas Gohr $snippet = ft_snippet($id,$regex); 420f71f4f53SAndreas Gohr $idx++; 421f71f4f53SAndreas Gohr }else{ 422f71f4f53SAndreas Gohr $snippet = ''; 423f71f4f53SAndreas Gohr } 424f71f4f53SAndreas Gohr 425f71f4f53SAndreas Gohr $pages[] = array( 426f71f4f53SAndreas Gohr 'id' => $id, 427f71f4f53SAndreas Gohr 'score' => $score, 428f71f4f53SAndreas Gohr 'rev' => filemtime($file), 429f71f4f53SAndreas Gohr 'mtime' => filemtime($file), 430f71f4f53SAndreas Gohr 'size' => filesize($file), 431f71f4f53SAndreas Gohr 'snippet' => $snippet, 432f71f4f53SAndreas Gohr ); 433f71f4f53SAndreas Gohr } 434ac1ffddeSGeorges-Etienne Legendre return $pages; 435f71f4f53SAndreas Gohr } 436f71f4f53SAndreas Gohr 437e6f4c9d4SGeorges-Etienne Legendre /** 438e6f4c9d4SGeorges-Etienne Legendre * Returns the wiki title. 439e6f4c9d4SGeorges-Etienne Legendre */ 440e6f4c9d4SGeorges-Etienne Legendre function getTitle(){ 441e6f4c9d4SGeorges-Etienne Legendre global $conf; 442e6f4c9d4SGeorges-Etienne Legendre return $conf['title']; 443e6f4c9d4SGeorges-Etienne Legendre } 444f71f4f53SAndreas Gohr 445f71f4f53SAndreas Gohr /** 44626bec61eSMichael Klier * List all media files. 4473275953aSGina Haeussge * 4483275953aSGina Haeussge * Available options are 'recursive' for also including the subnamespaces 4493275953aSGina Haeussge * in the listing, and 'pattern' for filtering the returned files against 4503275953aSGina Haeussge * a regular expression matching their name. 4513275953aSGina Haeussge * 4523275953aSGina Haeussge * @author Gina Haeussge <osd@foosel.net> 45326bec61eSMichael Klier */ 4543275953aSGina Haeussge function listAttachments($ns, $options = array()) { 45526bec61eSMichael Klier global $conf; 45626bec61eSMichael Klier global $lang; 45726bec61eSMichael Klier 45826bec61eSMichael Klier $ns = cleanID($ns); 45926bec61eSMichael Klier 4606fc3aa1aSAndreas Gohr if (!is_array($options)) $options = array(); 4616fc3aa1aSAndreas Gohr $options['skipacl'] = 0; // no ACL skipping for XMLRPC 4623275953aSGina Haeussge 4633275953aSGina Haeussge 46426bec61eSMichael Klier if(auth_quickaclcheck($ns.':*') >= AUTH_READ) { 46526bec61eSMichael Klier $dir = utf8_encodeFN(str_replace(':', '/', $ns)); 46626bec61eSMichael Klier 46726bec61eSMichael Klier $data = array(); 468224122cfSAndreas Gohr search($data, $conf['mediadir'], 'search_media', $options, $dir); 469224122cfSAndreas Gohr $len = count($data); 470224122cfSAndreas Gohr if(!$len) return array(); 47126bec61eSMichael Klier 472224122cfSAndreas Gohr for($i=0; $i<$len; $i++) { 473224122cfSAndreas Gohr unset($data[$i]['meta']); 474224122cfSAndreas Gohr $data[$i]['lastModified'] = new IXR_Date($data[$i]['mtime']); 47526bec61eSMichael Klier } 476224122cfSAndreas Gohr return $data; 47726bec61eSMichael Klier } else { 47826bec61eSMichael Klier return new IXR_Error(1, 'You are not allowed to list media files.'); 47926bec61eSMichael Klier } 48026bec61eSMichael Klier } 48126bec61eSMichael Klier 48226bec61eSMichael Klier /** 483797c0d11SAndreas Gohr * Return a list of backlinks 484797c0d11SAndreas Gohr */ 485beccd742SMichael Klier function listBackLinks($id){ 48686228f10SDominik Eckelmann return ft_backlinks(cleanID($id)); 487797c0d11SAndreas Gohr } 488797c0d11SAndreas Gohr 489797c0d11SAndreas Gohr /** 49063dd0d58SMichael Klier * Return some basic data about a page 491797c0d11SAndreas Gohr */ 492797c0d11SAndreas Gohr function pageInfo($id,$rev=''){ 493*eff795acSMichael Hamann $id = cleanID($id); 494797c0d11SAndreas Gohr if(auth_quickaclcheck($id) < AUTH_READ){ 495797c0d11SAndreas Gohr return new IXR_Error(1, 'You are not allowed to read this page'); 496797c0d11SAndreas Gohr } 497797c0d11SAndreas Gohr $file = wikiFN($id,$rev); 498797c0d11SAndreas Gohr $time = @filemtime($file); 499797c0d11SAndreas Gohr if(!$time){ 500797c0d11SAndreas Gohr return new IXR_Error(10, 'The requested page does not exist'); 501797c0d11SAndreas Gohr } 502797c0d11SAndreas Gohr 503797c0d11SAndreas Gohr $info = getRevisionInfo($id, $time, 1024); 504797c0d11SAndreas Gohr 505797c0d11SAndreas Gohr $data = array( 506797c0d11SAndreas Gohr 'name' => $id, 507797c0d11SAndreas Gohr 'lastModified' => new IXR_Date($time), 508797c0d11SAndreas Gohr 'author' => (($info['user']) ? $info['user'] : $info['ip']), 509797c0d11SAndreas Gohr 'version' => $time 510797c0d11SAndreas Gohr ); 51163dd0d58SMichael Klier 51263dd0d58SMichael Klier return ($data); 513797c0d11SAndreas Gohr } 514797c0d11SAndreas Gohr 515797c0d11SAndreas Gohr /** 5163a1dad2dSDennis Ploeger * Save a wiki page 517222572bfSMichael Klier * 518222572bfSMichael Klier * @author Michael Klier <chi@chimeric.de> 5193a1dad2dSDennis Ploeger */ 520222572bfSMichael Klier function putPage($id, $text, $params) { 5213a1dad2dSDennis Ploeger global $TEXT; 522a6a229ceSMichael Klier global $lang; 523593bf8f6SMichael Klier global $conf; 5243a1dad2dSDennis Ploeger 525222572bfSMichael Klier $id = cleanID($id); 52656523eecSAndreas Gohr $TEXT = cleanText($text); 527222572bfSMichael Klier $sum = $params['sum']; 528222572bfSMichael Klier $minor = $params['minor']; 529222572bfSMichael Klier 530222572bfSMichael Klier if(empty($id)) 531fdd2e9d6SMichael Klier return new IXR_Error(1, 'Empty page ID'); 532222572bfSMichael Klier 53356523eecSAndreas Gohr if(!page_exists($id) && trim($TEXT) == '' ) { 53451597811SMichael Klier return new IXR_ERROR(1, 'Refusing to write an empty new wiki page'); 53551597811SMichael Klier } 53651597811SMichael Klier 537055b0144SChris Smith if(auth_quickaclcheck($id) < AUTH_EDIT) 538222572bfSMichael Klier return new IXR_Error(1, 'You are not allowed to edit this page'); 5393a1dad2dSDennis Ploeger 5403a1dad2dSDennis Ploeger // Check, if page is locked 541222572bfSMichael Klier if(checklock($id)) 542222572bfSMichael Klier return new IXR_Error(1, 'The page is currently locked'); 543222572bfSMichael Klier 544a6a229ceSMichael Klier // SPAM check 5453a1dad2dSDennis Ploeger if(checkwordblock()) 546222572bfSMichael Klier return new IXR_Error(1, 'Positive wordblock check'); 5473a1dad2dSDennis Ploeger 548a6a229ceSMichael Klier // autoset summary on new pages 549a6a229ceSMichael Klier if(!page_exists($id) && empty($sum)) { 550a6a229ceSMichael Klier $sum = $lang['created']; 551a6a229ceSMichael Klier } 552a6a229ceSMichael Klier 553a6a229ceSMichael Klier // autoset summary on deleted pages 554a6a229ceSMichael Klier if(page_exists($id) && empty($TEXT) && empty($sum)) { 555a6a229ceSMichael Klier $sum = $lang['deleted']; 556a6a229ceSMichael Klier } 557a6a229ceSMichael Klier 558222572bfSMichael Klier lock($id); 5593a1dad2dSDennis Ploeger 560222572bfSMichael Klier saveWikiText($id,$TEXT,$sum,$minor); 5613a1dad2dSDennis Ploeger 562222572bfSMichael Klier unlock($id); 5633a1dad2dSDennis Ploeger 564593bf8f6SMichael Klier // run the indexer if page wasn't indexed yet 565593bf8f6SMichael Klier if(!@file_exists(metaFN($id, '.indexed'))) { 566593bf8f6SMichael Klier // try to aquire a lock 567593bf8f6SMichael Klier $lock = $conf['lockdir'].'/_indexer.lock'; 568593bf8f6SMichael Klier while(!@mkdir($lock,$conf['dmode'])){ 569593bf8f6SMichael Klier usleep(50); 570593bf8f6SMichael Klier if(time()-@filemtime($lock) > 60*5){ 571593bf8f6SMichael Klier // looks like a stale lock - remove it 572593bf8f6SMichael Klier @rmdir($lock); 573593bf8f6SMichael Klier }else{ 574593bf8f6SMichael Klier return false; 575593bf8f6SMichael Klier } 576593bf8f6SMichael Klier } 577593bf8f6SMichael Klier if($conf['dperm']) chmod($lock, $conf['dperm']); 578593bf8f6SMichael Klier 579593bf8f6SMichael Klier // do the work 580593bf8f6SMichael Klier idx_addPage($id); 581593bf8f6SMichael Klier 582593bf8f6SMichael Klier // we're finished - save and free lock 583593bf8f6SMichael Klier io_saveFile(metaFN($id,'.indexed'),INDEXER_VERSION); 584593bf8f6SMichael Klier @rmdir($lock); 585593bf8f6SMichael Klier } 586593bf8f6SMichael Klier 5873a1dad2dSDennis Ploeger return 0; 588beccd742SMichael Klier } 5893a1dad2dSDennis Ploeger 590beccd742SMichael Klier /** 591ba9418bcSHakan Sandell * Appends text to a wiki page. 592ba9418bcSHakan Sandell */ 593ba9418bcSHakan Sandell function appendPage($id, $text, $params) { 594ba9418bcSHakan Sandell $currentpage = $this->rawPage($id); 595ba9418bcSHakan Sandell if (!is_string($currentpage)) { 596ba9418bcSHakan Sandell return $currentpage; 597ba9418bcSHakan Sandell } 598ba9418bcSHakan Sandell return $this->putPage($id, $currentpage.$text, $params); 599ba9418bcSHakan Sandell } 600ba9418bcSHakan Sandell 601ba9418bcSHakan Sandell /** 6022aca132fSMichael Klier * Uploads a file to the wiki. 6032aca132fSMichael Klier * 6042aca132fSMichael Klier * Michael Klier <chi@chimeric.de> 6052aca132fSMichael Klier */ 606f01ff8c1SGina Haeussge function putAttachment($id, $file, $params) { 607*eff795acSMichael Hamann $id = cleanID($id); 6082aca132fSMichael Klier global $conf; 6092aca132fSMichael Klier global $lang; 6102aca132fSMichael Klier 611f01ff8c1SGina Haeussge $auth = auth_quickaclcheck(getNS($id).':*'); 6122aca132fSMichael Klier if($auth >= AUTH_UPLOAD) { 613f01ff8c1SGina Haeussge if(!isset($id)) { 6142aca132fSMichael Klier return new IXR_ERROR(1, 'Filename not given.'); 6152aca132fSMichael Klier } 6162aca132fSMichael Klier 617c77fa67bSMichael Hamann $ftmp = $conf['tmpdir'] . '/' . md5($id.clientIP()); 6182aca132fSMichael Klier 6192aca132fSMichael Klier // save temporary file 6202aca132fSMichael Klier @unlink($ftmp); 6212aca132fSMichael Klier $buff = base64_decode($file); 6222aca132fSMichael Klier io_saveFile($ftmp, $buff); 6232aca132fSMichael Klier 6242aca132fSMichael Klier // get filename 625ecebf3a8SAndreas Gohr list($iext, $imime,$dl) = mimetype($id); 626f01ff8c1SGina Haeussge $id = cleanID($id); 6272aca132fSMichael Klier $fn = mediaFN($id); 6282aca132fSMichael Klier 6292aca132fSMichael Klier // get filetype regexp 6302aca132fSMichael Klier $types = array_keys(getMimeTypes()); 6312aca132fSMichael Klier $types = array_map(create_function('$q','return preg_quote($q,"/");'),$types); 6322aca132fSMichael Klier $regex = join('|',$types); 6332aca132fSMichael Klier 6342aca132fSMichael Klier // because a temp file was created already 6352aca132fSMichael Klier if(preg_match('/\.('.$regex.')$/i',$fn)) { 6362aca132fSMichael Klier //check for overwrite 63799c8d7f2Smichael $overwrite = @file_exists($fn); 63899c8d7f2Smichael if($overwrite && (!$params['ow'] || $auth < AUTH_DELETE)) { 639224122cfSAndreas Gohr return new IXR_ERROR(1, $lang['uploadexist'].'1'); 6402aca132fSMichael Klier } 6412aca132fSMichael Klier // check for valid content 6422aca132fSMichael Klier $ok = media_contentcheck($ftmp, $imime); 6432aca132fSMichael Klier if($ok == -1) { 644224122cfSAndreas Gohr return new IXR_ERROR(1, sprintf($lang['uploadexist'].'2', ".$iext")); 6452aca132fSMichael Klier } elseif($ok == -2) { 6462aca132fSMichael Klier return new IXR_ERROR(1, $lang['uploadspam']); 6472aca132fSMichael Klier } elseif($ok == -3) { 6482aca132fSMichael Klier return new IXR_ERROR(1, $lang['uploadxss']); 6492aca132fSMichael Klier } 6502aca132fSMichael Klier 6512aca132fSMichael Klier // prepare event data 6522aca132fSMichael Klier $data[0] = $ftmp; 6532aca132fSMichael Klier $data[1] = $fn; 6542aca132fSMichael Klier $data[2] = $id; 6552aca132fSMichael Klier $data[3] = $imime; 65699c8d7f2Smichael $data[4] = $overwrite; 6572aca132fSMichael Klier 6582aca132fSMichael Klier // trigger event 6592aca132fSMichael Klier return trigger_event('MEDIA_UPLOAD_FINISH', $data, array($this, '_media_upload_action'), true); 6602aca132fSMichael Klier 6612aca132fSMichael Klier } else { 6622aca132fSMichael Klier return new IXR_ERROR(1, $lang['uploadwrong']); 6632aca132fSMichael Klier } 6642aca132fSMichael Klier } else { 6652aca132fSMichael Klier return new IXR_ERROR(1, "You don't have permissions to upload files."); 6662aca132fSMichael Klier } 6672aca132fSMichael Klier } 6682aca132fSMichael Klier 6692aca132fSMichael Klier /** 670f01ff8c1SGina Haeussge * Deletes a file from the wiki. 671f01ff8c1SGina Haeussge * 672f01ff8c1SGina Haeussge * @author Gina Haeussge <osd@foosel.net> 673f01ff8c1SGina Haeussge */ 674f01ff8c1SGina Haeussge function deleteAttachment($id){ 675*eff795acSMichael Hamann $id = cleanID($id); 676f01ff8c1SGina Haeussge $auth = auth_quickaclcheck(getNS($id).':*'); 677f01ff8c1SGina Haeussge if($auth < AUTH_DELETE) return new IXR_ERROR(1, "You don't have permissions to delete files."); 678f01ff8c1SGina Haeussge global $conf; 679f01ff8c1SGina Haeussge global $lang; 680f01ff8c1SGina Haeussge 681f01ff8c1SGina Haeussge // check for references if needed 682f01ff8c1SGina Haeussge $mediareferences = array(); 683f01ff8c1SGina Haeussge if($conf['refcheck']){ 684f01ff8c1SGina Haeussge $mediareferences = ft_mediause($id,$conf['refshow']); 685f01ff8c1SGina Haeussge } 686f01ff8c1SGina Haeussge 687f01ff8c1SGina Haeussge if(!count($mediareferences)){ 688f01ff8c1SGina Haeussge $file = mediaFN($id); 689f01ff8c1SGina Haeussge if(@unlink($file)){ 69099c8d7f2Smichael addMediaLogEntry(time(), $id, DOKU_CHANGE_TYPE_DELETE); 691f01ff8c1SGina Haeussge io_sweepNS($id,'mediadir'); 692f01ff8c1SGina Haeussge return 0; 693f01ff8c1SGina Haeussge } 694f01ff8c1SGina Haeussge //something went wrong 695f01ff8c1SGina Haeussge return new IXR_ERROR(1, 'Could not delete file'); 696f01ff8c1SGina Haeussge } else { 697f01ff8c1SGina Haeussge return new IXR_ERROR(1, 'File is still referenced'); 698f01ff8c1SGina Haeussge } 699f01ff8c1SGina Haeussge } 700f01ff8c1SGina Haeussge 701f01ff8c1SGina Haeussge /** 7022aca132fSMichael Klier * Moves the temporary file to its final destination. 7032aca132fSMichael Klier * 7042aca132fSMichael Klier * Michael Klier <chi@chimeric.de> 7052aca132fSMichael Klier */ 7062aca132fSMichael Klier function _media_upload_action($data) { 7072aca132fSMichael Klier global $conf; 7082aca132fSMichael Klier 70999c8d7f2Smichael if(is_array($data) && count($data)===5) { 7102aca132fSMichael Klier io_createNamespace($data[2], 'media'); 7112aca132fSMichael Klier if(rename($data[0], $data[1])) { 7122aca132fSMichael Klier chmod($data[1], $conf['fmode']); 7132aca132fSMichael Klier media_notify($data[2], $data[1], $data[3]); 71499c8d7f2Smichael // add a log entry to the media changelog 71599c8d7f2Smichael if ($data[4]) { 71699c8d7f2Smichael addMediaLogEntry(time(), $data[2], DOKU_CHANGE_TYPE_EDIT); 71799c8d7f2Smichael } else { 71899c8d7f2Smichael addMediaLogEntry(time(), $data[2], DOKU_CHANGE_TYPE_CREATE); 71999c8d7f2Smichael } 7202aca132fSMichael Klier return $data[2]; 7212aca132fSMichael Klier } else { 7222aca132fSMichael Klier return new IXR_ERROR(1, 'Upload failed.'); 7232aca132fSMichael Klier } 7242aca132fSMichael Klier } else { 7252aca132fSMichael Klier return new IXR_ERROR(1, 'Upload failed.'); 7262aca132fSMichael Klier } 7272aca132fSMichael Klier } 7282aca132fSMichael Klier 7292aca132fSMichael Klier /** 730e62b9ea5SMichael Klier * Returns the permissions of a given wiki page 731e62b9ea5SMichael Klier */ 732e62b9ea5SMichael Klier function aclCheck($id) { 733*eff795acSMichael Hamann $id = cleanID($id); 734e62b9ea5SMichael Klier return auth_quickaclcheck($id); 735e62b9ea5SMichael Klier } 736e62b9ea5SMichael Klier 737e62b9ea5SMichael Klier /** 738beccd742SMichael Klier * Lists all links contained in a wiki page 73963dd0d58SMichael Klier * 74063dd0d58SMichael Klier * @author Michael Klier <chi@chimeric.de> 741beccd742SMichael Klier */ 742beccd742SMichael Klier function listLinks($id) { 743*eff795acSMichael Hamann $id = cleanID($id); 744beccd742SMichael Klier if(auth_quickaclcheck($id) < AUTH_READ){ 745beccd742SMichael Klier return new IXR_Error(1, 'You are not allowed to read this page'); 746beccd742SMichael Klier } 747beccd742SMichael Klier $links = array(); 748beccd742SMichael Klier 749beccd742SMichael Klier // resolve page instructions 750*eff795acSMichael Hamann $ins = p_cached_instructions(wikiFN($id)); 751beccd742SMichael Klier 752beccd742SMichael Klier // instantiate new Renderer - needed for interwiki links 753beccd742SMichael Klier include(DOKU_INC.'inc/parser/xhtml.php'); 754beccd742SMichael Klier $Renderer = new Doku_Renderer_xhtml(); 755beccd742SMichael Klier $Renderer->interwiki = getInterwiki(); 756beccd742SMichael Klier 757beccd742SMichael Klier // parse parse instructions 758beccd742SMichael Klier foreach($ins as $in) { 759beccd742SMichael Klier $link = array(); 760beccd742SMichael Klier switch($in[0]) { 761beccd742SMichael Klier case 'internallink': 762beccd742SMichael Klier $link['type'] = 'local'; 763beccd742SMichael Klier $link['page'] = $in[1][0]; 764beccd742SMichael Klier $link['href'] = wl($in[1][0]); 765beccd742SMichael Klier array_push($links,$link); 766beccd742SMichael Klier break; 767beccd742SMichael Klier case 'externallink': 768beccd742SMichael Klier $link['type'] = 'extern'; 769beccd742SMichael Klier $link['page'] = $in[1][0]; 770beccd742SMichael Klier $link['href'] = $in[1][0]; 771beccd742SMichael Klier array_push($links,$link); 772beccd742SMichael Klier break; 773beccd742SMichael Klier case 'interwikilink': 774beccd742SMichael Klier $url = $Renderer->_resolveInterWiki($in[1][2],$in[1][3]); 775beccd742SMichael Klier $link['type'] = 'extern'; 776beccd742SMichael Klier $link['page'] = $url; 777beccd742SMichael Klier $link['href'] = $url; 778beccd742SMichael Klier array_push($links,$link); 779beccd742SMichael Klier break; 780beccd742SMichael Klier } 781beccd742SMichael Klier } 782beccd742SMichael Klier 78363dd0d58SMichael Klier return ($links); 78463dd0d58SMichael Klier } 78563dd0d58SMichael Klier 78663dd0d58SMichael Klier /** 78763dd0d58SMichael Klier * Returns a list of recent changes since give timestamp 78863dd0d58SMichael Klier * 78999c8d7f2Smichael * @author Michael Hamann <michael@content-space.de> 79063dd0d58SMichael Klier * @author Michael Klier <chi@chimeric.de> 79163dd0d58SMichael Klier */ 79263dd0d58SMichael Klier function getRecentChanges($timestamp) { 79363dd0d58SMichael Klier if(strlen($timestamp) != 10) 79463dd0d58SMichael Klier return new IXR_Error(20, 'The provided value is not a valid timestamp'); 79563dd0d58SMichael Klier 79699c8d7f2Smichael $recents = getRecentsSince($timestamp); 79763dd0d58SMichael Klier 79899c8d7f2Smichael $changes = array(); 79963dd0d58SMichael Klier 80099c8d7f2Smichael foreach ($recents as $recent) { 80199c8d7f2Smichael $change = array(); 80299c8d7f2Smichael $change['name'] = $recent['id']; 80399c8d7f2Smichael $change['lastModified'] = new IXR_Date($recent['date']); 80499c8d7f2Smichael $change['author'] = $recent['user']; 80599c8d7f2Smichael $change['version'] = $recent['date']; 80699c8d7f2Smichael $change['perms'] = $recent['perms']; 80799c8d7f2Smichael $change['size'] = @filesize(wikiFN($recent['id'])); 80863dd0d58SMichael Klier array_push($changes, $change); 80999c8d7f2Smichael } 81099c8d7f2Smichael 81199c8d7f2Smichael if (!empty($changes)) { 81299c8d7f2Smichael return $changes; 81363dd0d58SMichael Klier } else { 81463dd0d58SMichael Klier // in case we still have nothing at this point 81563dd0d58SMichael Klier return new IXR_Error(30, 'There are no changes in the specified timeframe'); 8163a1dad2dSDennis Ploeger } 81799c8d7f2Smichael } 81899c8d7f2Smichael 81999c8d7f2Smichael /** 82099c8d7f2Smichael * Returns a list of recent media changes since give timestamp 82199c8d7f2Smichael * 82299c8d7f2Smichael * @author Michael Hamann <michael@content-space.de> 82399c8d7f2Smichael * @author Michael Klier <chi@chimeric.de> 82499c8d7f2Smichael */ 82599c8d7f2Smichael function getRecentMediaChanges($timestamp) { 82699c8d7f2Smichael if(strlen($timestamp) != 10) 82799c8d7f2Smichael return new IXR_Error(20, 'The provided value is not a valid timestamp'); 82899c8d7f2Smichael 82999c8d7f2Smichael $recents = getRecentsSince($timestamp, null, '', RECENTS_MEDIA_CHANGES); 83099c8d7f2Smichael 83199c8d7f2Smichael $changes = array(); 83299c8d7f2Smichael 83399c8d7f2Smichael foreach ($recents as $recent) { 83499c8d7f2Smichael $change = array(); 83599c8d7f2Smichael $change['name'] = $recent['id']; 83699c8d7f2Smichael $change['lastModified'] = new IXR_Date($recent['date']); 83799c8d7f2Smichael $change['author'] = $recent['user']; 83899c8d7f2Smichael $change['version'] = $recent['date']; 83999c8d7f2Smichael $change['perms'] = $recent['perms']; 840a4da2756Smichael $change['size'] = @filesize(mediaFN($recent['id'])); 84199c8d7f2Smichael array_push($changes, $change); 84299c8d7f2Smichael } 84399c8d7f2Smichael 84499c8d7f2Smichael if (!empty($changes)) { 84599c8d7f2Smichael return $changes; 84699c8d7f2Smichael } else { 84799c8d7f2Smichael // in case we still have nothing at this point 84899c8d7f2Smichael return new IXR_Error(30, 'There are no changes in the specified timeframe'); 84999c8d7f2Smichael } 85099c8d7f2Smichael } 8513a1dad2dSDennis Ploeger 8523a1dad2dSDennis Ploeger /** 85373056168SMichael Klier * Returns a list of available revisions of a given wiki page 85473056168SMichael Klier * 85573056168SMichael Klier * @author Michael Klier <chi@chimeric.de> 85673056168SMichael Klier */ 85773056168SMichael Klier function pageVersions($id, $first) { 858*eff795acSMichael Hamann $id = cleanID($id); 859*eff795acSMichael Hamann if(auth_quickaclcheck($id) < AUTH_READ){ 860*eff795acSMichael Hamann return new IXR_Error(1, 'You are not allowed to read this page'); 861*eff795acSMichael Hamann } 86273056168SMichael Klier global $conf; 86373056168SMichael Klier 86473056168SMichael Klier $versions = array(); 86573056168SMichael Klier 86673056168SMichael Klier if(empty($id)) 86773056168SMichael Klier return new IXR_Error(1, 'Empty page ID'); 86873056168SMichael Klier 86973056168SMichael Klier $revisions = getRevisions($id, $first, $conf['recent']+1); 87073056168SMichael Klier 87173056168SMichael Klier if(count($revisions)==0 && $first!=0) { 87273056168SMichael Klier $first=0; 87373056168SMichael Klier $revisions = getRevisions($id, $first, $conf['recent']+1); 87473056168SMichael Klier } 87573056168SMichael Klier 87645c63471SMichael Klier if(count($revisions)>0 && $first==0) { 87745c63471SMichael Klier array_unshift($revisions, ''); // include current revision 87845c63471SMichael Klier array_pop($revisions); // remove extra log entry 87945c63471SMichael Klier } 88045c63471SMichael Klier 88173056168SMichael Klier $hasNext = false; 88273056168SMichael Klier if(count($revisions)>$conf['recent']) { 88373056168SMichael Klier $hasNext = true; 88473056168SMichael Klier array_pop($revisions); // remove extra log entry 88573056168SMichael Klier } 88673056168SMichael Klier 88773056168SMichael Klier if(!empty($revisions)) { 88873056168SMichael Klier foreach($revisions as $rev) { 88973056168SMichael Klier $file = wikiFN($id,$rev); 89073056168SMichael Klier $time = @filemtime($file); 89145c63471SMichael Klier // we check if the page actually exists, if this is not the 89245c63471SMichael Klier // case this can lead to less pages being returned than 89345c63471SMichael Klier // specified via $conf['recent'] 89473056168SMichael Klier if($time){ 89573056168SMichael Klier $info = getRevisionInfo($id, $time, 1024); 89673056168SMichael Klier if(!empty($info)) { 89773056168SMichael Klier $data['user'] = $info['user']; 89873056168SMichael Klier $data['ip'] = $info['ip']; 89973056168SMichael Klier $data['type'] = $info['type']; 90073056168SMichael Klier $data['sum'] = $info['sum']; 90173056168SMichael Klier $data['modified'] = new IXR_Date($info['date']); 90273056168SMichael Klier $data['version'] = $info['date']; 90373056168SMichael Klier array_push($versions, $data); 90473056168SMichael Klier } 90573056168SMichael Klier } 90673056168SMichael Klier } 90773056168SMichael Klier return $versions; 90873056168SMichael Klier } else { 90973056168SMichael Klier return array(); 91073056168SMichael Klier } 91173056168SMichael Klier } 91273056168SMichael Klier 91373056168SMichael Klier /** 914797c0d11SAndreas Gohr * The version of Wiki RPC API supported 915797c0d11SAndreas Gohr */ 916797c0d11SAndreas Gohr function wiki_RPCVersion(){ 917797c0d11SAndreas Gohr return 2; 918797c0d11SAndreas Gohr } 9191b11c097SAndreas Gohr 92028ec3c76SAndreas Gohr 92128ec3c76SAndreas Gohr /** 92228ec3c76SAndreas Gohr * Locks or unlocks a given batch of pages 92328ec3c76SAndreas Gohr * 92428ec3c76SAndreas Gohr * Give an associative array with two keys: lock and unlock. Both should contain a 92528ec3c76SAndreas Gohr * list of pages to lock or unlock 92628ec3c76SAndreas Gohr * 92728ec3c76SAndreas Gohr * Returns an associative array with the keys locked, lockfail, unlocked and 92828ec3c76SAndreas Gohr * unlockfail, each containing lists of pages. 92928ec3c76SAndreas Gohr */ 93028ec3c76SAndreas Gohr function setLocks($set){ 93128ec3c76SAndreas Gohr $locked = array(); 93228ec3c76SAndreas Gohr $lockfail = array(); 93328ec3c76SAndreas Gohr $unlocked = array(); 93428ec3c76SAndreas Gohr $unlockfail = array(); 93528ec3c76SAndreas Gohr 93628ec3c76SAndreas Gohr foreach((array) $set['lock'] as $id){ 937*eff795acSMichael Hamann $id = cleanID($id); 938*eff795acSMichael Hamann if(auth_quickaclcheck($id) < AUTH_EDIT || checklock($id)){ 93928ec3c76SAndreas Gohr $lockfail[] = $id; 94028ec3c76SAndreas Gohr }else{ 94128ec3c76SAndreas Gohr lock($id); 94228ec3c76SAndreas Gohr $locked[] = $id; 94328ec3c76SAndreas Gohr } 94428ec3c76SAndreas Gohr } 94528ec3c76SAndreas Gohr 94628ec3c76SAndreas Gohr foreach((array) $set['unlock'] as $id){ 947*eff795acSMichael Hamann $id = cleanID($id); 948*eff795acSMichael Hamann if(auth_quickaclcheck($id) < AUTH_EDIT || !unlock($id)){ 94928ec3c76SAndreas Gohr $unlockfail[] = $id; 950*eff795acSMichael Hamann }else{ 951*eff795acSMichael Hamann $unlocked[] = $id; 95228ec3c76SAndreas Gohr } 95328ec3c76SAndreas Gohr } 95428ec3c76SAndreas Gohr 95528ec3c76SAndreas Gohr return array( 95628ec3c76SAndreas Gohr 'locked' => $locked, 95728ec3c76SAndreas Gohr 'lockfail' => $lockfail, 95828ec3c76SAndreas Gohr 'unlocked' => $unlocked, 95928ec3c76SAndreas Gohr 'unlockfail' => $unlockfail, 96028ec3c76SAndreas Gohr ); 96128ec3c76SAndreas Gohr } 96228ec3c76SAndreas Gohr 963445e8084SAndreas Gohr function getAPIVersion(){ 964445e8084SAndreas Gohr return DOKU_XMLRPC_API_VERSION; 965445e8084SAndreas Gohr } 966445e8084SAndreas Gohr 967445e8084SAndreas Gohr function login($user,$pass){ 968445e8084SAndreas Gohr global $conf; 969445e8084SAndreas Gohr global $auth; 970445e8084SAndreas Gohr if(!$conf['useacl']) return 0; 971445e8084SAndreas Gohr if(!$auth) return 0; 972445e8084SAndreas Gohr if($auth->canDo('external')){ 973445e8084SAndreas Gohr return $auth->trustExternal($user,$pass,false); 974445e8084SAndreas Gohr }else{ 975445e8084SAndreas Gohr return auth_login($user,$pass,false,true); 976445e8084SAndreas Gohr } 977445e8084SAndreas Gohr } 9783ee5b583SAndreas Gohr 9793ee5b583SAndreas Gohr 980797c0d11SAndreas Gohr} 981797c0d11SAndreas Gohr 982797c0d11SAndreas Gohr$server = new dokuwiki_xmlrpc_server(); 983797c0d11SAndreas Gohr 984e3776c06SMichael Hamann// vim:ts=4:sw=4:et: 985