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 */ 10f71f4f53SAndreas Gohrdefine('DOKU_XMLRPC_API_VERSION',3); 11797c0d11SAndreas Gohr 12797c0d11SAndreas Gohrrequire_once(DOKU_INC.'inc/init.php'); 13797c0d11SAndreas Gohrrequire_once(DOKU_INC.'inc/common.php'); 14797c0d11SAndreas Gohrrequire_once(DOKU_INC.'inc/auth.php'); 15797c0d11SAndreas Gohrsession_write_close(); //close session 16593bf8f6SMichael Klier 173ee5b583SAndreas Gohrif(!$conf['xmlrpc']) die('XML-RPC server not enabled.'); 18593bf8f6SMichael Klier 19797c0d11SAndreas Gohrrequire_once(DOKU_INC.'inc/IXR_Library.php'); 20797c0d11SAndreas Gohr 21797c0d11SAndreas Gohr 22797c0d11SAndreas Gohr/** 23797c0d11SAndreas Gohr * Contains needed wrapper functions and registers all available 24797c0d11SAndreas Gohr * XMLRPC functions. 25797c0d11SAndreas Gohr */ 26797c0d11SAndreas Gohrclass dokuwiki_xmlrpc_server extends IXR_IntrospectionServer { 27797c0d11SAndreas Gohr var $methods = array(); 283ee5b583SAndreas Gohr var $public_methods = array(); 293ee5b583SAndreas Gohr 303ee5b583SAndreas Gohr /** 313ee5b583SAndreas Gohr * Checks if the current user is allowed to execute non anonymous methods 323ee5b583SAndreas Gohr */ 333ee5b583SAndreas Gohr function checkAuth(){ 343ee5b583SAndreas Gohr global $conf; 353ee5b583SAndreas Gohr global $USERINFO; 363ee5b583SAndreas Gohr 373ee5b583SAndreas Gohr if(!$conf['useacl']) return true; //no ACL - then no checks 383ee5b583SAndreas Gohr 393ee5b583SAndreas Gohr $allowed = explode(',',$conf['xmlrpcuser']); 403ee5b583SAndreas Gohr $allowed = array_map('trim', $allowed); 413ee5b583SAndreas Gohr $allowed = array_unique($allowed); 423ee5b583SAndreas Gohr $allowed = array_filter($allowed); 433ee5b583SAndreas Gohr 443ee5b583SAndreas Gohr if(!count($allowed)) return true; //no restrictions 453ee5b583SAndreas Gohr 463ee5b583SAndreas Gohr $user = $_SERVER['REMOTE_USER']; 473ee5b583SAndreas Gohr $groups = (array) $USERINFO['grps']; 483ee5b583SAndreas Gohr 493ee5b583SAndreas Gohr if(in_array($user,$allowed)) return true; //user explicitly mentioned 503ee5b583SAndreas Gohr 513ee5b583SAndreas Gohr //check group memberships 523ee5b583SAndreas Gohr foreach($groups as $group){ 533ee5b583SAndreas Gohr if(in_array('@'.$group,$allowed)) return true; 543ee5b583SAndreas Gohr } 553ee5b583SAndreas Gohr 563ee5b583SAndreas Gohr //still here? no access! 573ee5b583SAndreas Gohr return false; 583ee5b583SAndreas Gohr } 593ee5b583SAndreas Gohr 603ee5b583SAndreas Gohr /** 613ee5b583SAndreas Gohr * Adds a callback, extends parent method 623ee5b583SAndreas Gohr * 633ee5b583SAndreas Gohr * add another parameter to define if anonymous access to 643ee5b583SAndreas Gohr * this method should be granted. 653ee5b583SAndreas Gohr */ 663ee5b583SAndreas Gohr function addCallback($method, $callback, $args, $help, $public=false){ 673ee5b583SAndreas Gohr if($public) $this->public_methods[] = $method; 683ee5b583SAndreas Gohr return parent::addCallback($method, $callback, $args, $help); 693ee5b583SAndreas Gohr } 703ee5b583SAndreas Gohr 713ee5b583SAndreas Gohr /** 723ee5b583SAndreas Gohr * Execute a call, extends parent method 733ee5b583SAndreas Gohr * 743ee5b583SAndreas Gohr * Checks for authentication first 753ee5b583SAndreas Gohr */ 763ee5b583SAndreas Gohr function call($methodname, $args){ 773ee5b583SAndreas Gohr if(!in_array($methodname,$this->public_methods) && !$this->checkAuth()){ 783ee5b583SAndreas Gohr return new IXR_Error(-32603, 'server error. not authorized to call method "'.$methodname.'".'); 793ee5b583SAndreas Gohr } 803ee5b583SAndreas Gohr return parent::call($methodname, $args); 813ee5b583SAndreas Gohr } 82797c0d11SAndreas Gohr 83797c0d11SAndreas Gohr /** 84797c0d11SAndreas Gohr * Constructor. Register methods and run Server 85797c0d11SAndreas Gohr */ 86797c0d11SAndreas Gohr function dokuwiki_xmlrpc_server(){ 87797c0d11SAndreas Gohr $this->IXR_IntrospectionServer(); 88797c0d11SAndreas Gohr 89797c0d11SAndreas Gohr /* DokuWiki's own methods */ 90797c0d11SAndreas Gohr $this->addCallback( 91445e8084SAndreas Gohr 'dokuwiki.getXMLRPCAPIVersion', 92445e8084SAndreas Gohr 'this:getAPIVersion', 93445e8084SAndreas Gohr array('integer'), 943ee5b583SAndreas Gohr 'Returns the XMLRPC API version.', 953ee5b583SAndreas Gohr true 96445e8084SAndreas Gohr ); 97445e8084SAndreas Gohr 98445e8084SAndreas Gohr $this->addCallback( 99797c0d11SAndreas Gohr 'dokuwiki.getVersion', 100797c0d11SAndreas Gohr 'getVersion', 101797c0d11SAndreas Gohr array('string'), 1023ee5b583SAndreas Gohr 'Returns the running DokuWiki version.', 1033ee5b583SAndreas Gohr true 104797c0d11SAndreas Gohr ); 105797c0d11SAndreas Gohr 1061b11c097SAndreas Gohr $this->addCallback( 107445e8084SAndreas Gohr 'dokuwiki.login', 108445e8084SAndreas Gohr 'this:login', 109445e8084SAndreas Gohr array('integer','string','string'), 1103ee5b583SAndreas Gohr 'Tries to login with the given credentials and sets auth cookies.', 1113ee5b583SAndreas Gohr true 112445e8084SAndreas Gohr ); 113445e8084SAndreas Gohr 114445e8084SAndreas Gohr $this->addCallback( 1151b11c097SAndreas Gohr 'dokuwiki.getPagelist', 1161b11c097SAndreas Gohr 'this:readNamespace', 1171b11c097SAndreas Gohr array('struct','string','struct'), 1181b11c097SAndreas Gohr 'List all pages within the given namespace.' 1191b11c097SAndreas Gohr ); 1201b11c097SAndreas Gohr 1211b11c097SAndreas Gohr $this->addCallback( 122f71f4f53SAndreas Gohr 'dokuwiki.search', 123f71f4f53SAndreas Gohr 'this:search', 124f71f4f53SAndreas Gohr array('struct','string'), 125f71f4f53SAndreas Gohr 'Perform a fulltext search and return a list of matching pages' 126f71f4f53SAndreas Gohr ); 127f71f4f53SAndreas Gohr 128f71f4f53SAndreas Gohr $this->addCallback( 1291b11c097SAndreas Gohr 'dokuwiki.getTime', 1301b11c097SAndreas Gohr 'time', 1311b11c097SAndreas Gohr array('int'), 1321b11c097SAndreas Gohr 'Return the current time at the wiki server.' 1331b11c097SAndreas Gohr ); 1341b11c097SAndreas Gohr 13528ec3c76SAndreas Gohr $this->addCallback( 13628ec3c76SAndreas Gohr 'dokuwiki.setLocks', 13728ec3c76SAndreas Gohr 'this:setLocks', 13828ec3c76SAndreas Gohr array('struct','struct'), 13928ec3c76SAndreas Gohr 'Lock or unlock pages.' 14028ec3c76SAndreas Gohr ); 14128ec3c76SAndreas Gohr 142797c0d11SAndreas Gohr /* Wiki API v2 http://www.jspwiki.org/wiki/WikiRPCInterface2 */ 143797c0d11SAndreas Gohr $this->addCallback( 144797c0d11SAndreas Gohr 'wiki.getRPCVersionSupported', 145797c0d11SAndreas Gohr 'this:wiki_RPCVersion', 146797c0d11SAndreas Gohr array('int'), 1473ee5b583SAndreas Gohr 'Returns 2 with the supported RPC API version.', 1483ee5b583SAndreas Gohr true 149797c0d11SAndreas Gohr ); 150797c0d11SAndreas Gohr $this->addCallback( 151797c0d11SAndreas Gohr 'wiki.getPage', 152797c0d11SAndreas Gohr 'this:rawPage', 153797c0d11SAndreas Gohr array('string','string'), 154797c0d11SAndreas Gohr 'Get the raw Wiki text of page, latest version.' 155797c0d11SAndreas Gohr ); 156797c0d11SAndreas Gohr $this->addCallback( 157797c0d11SAndreas Gohr 'wiki.getPageVersion', 158797c0d11SAndreas Gohr 'this:rawPage', 159797c0d11SAndreas Gohr array('string','string','int'), 160797c0d11SAndreas Gohr 'Get the raw Wiki text of page.' 161797c0d11SAndreas Gohr ); 162797c0d11SAndreas Gohr $this->addCallback( 163797c0d11SAndreas Gohr 'wiki.getPageHTML', 164797c0d11SAndreas Gohr 'this:htmlPage', 165797c0d11SAndreas Gohr array('string','string'), 166797c0d11SAndreas Gohr 'Return page in rendered HTML, latest version.' 167797c0d11SAndreas Gohr ); 168797c0d11SAndreas Gohr $this->addCallback( 169797c0d11SAndreas Gohr 'wiki.getPageHTMLVersion', 170797c0d11SAndreas Gohr 'this:htmlPage', 171797c0d11SAndreas Gohr array('string','string','int'), 172797c0d11SAndreas Gohr 'Return page in rendered HTML.' 173797c0d11SAndreas Gohr ); 174797c0d11SAndreas Gohr $this->addCallback( 175797c0d11SAndreas Gohr 'wiki.getAllPages', 176797c0d11SAndreas Gohr 'this:listPages', 177797c0d11SAndreas Gohr array('struct'), 178797c0d11SAndreas Gohr 'Returns a list of all pages. The result is an array of utf8 pagenames.' 179797c0d11SAndreas Gohr ); 180797c0d11SAndreas Gohr $this->addCallback( 18126bec61eSMichael Klier 'wiki.getAttachments', 18226bec61eSMichael Klier 'this:listAttachments', 183c63d1645SGina Haeussge array('struct', 'string', 'struct'), 18426bec61eSMichael Klier 'Returns a list of all media files.' 18526bec61eSMichael Klier ); 18626bec61eSMichael Klier $this->addCallback( 187797c0d11SAndreas Gohr 'wiki.getBackLinks', 188797c0d11SAndreas Gohr 'this:listBackLinks', 189797c0d11SAndreas Gohr array('struct','string'), 190797c0d11SAndreas Gohr 'Returns the pages that link to this page.' 191797c0d11SAndreas Gohr ); 192797c0d11SAndreas Gohr $this->addCallback( 193797c0d11SAndreas Gohr 'wiki.getPageInfo', 194797c0d11SAndreas Gohr 'this:pageInfo', 195797c0d11SAndreas Gohr array('struct','string'), 196797c0d11SAndreas Gohr 'Returns a struct with infos about the page.' 197797c0d11SAndreas Gohr ); 198797c0d11SAndreas Gohr $this->addCallback( 199797c0d11SAndreas Gohr 'wiki.getPageInfoVersion', 200797c0d11SAndreas Gohr 'this:pageInfo', 201797c0d11SAndreas Gohr array('struct','string','int'), 202797c0d11SAndreas Gohr 'Returns a struct with infos about the page.' 203797c0d11SAndreas Gohr ); 2043a1dad2dSDennis Ploeger $this->addCallback( 20573056168SMichael Klier 'wiki.getPageVersions', 20673056168SMichael Klier 'this:pageVersions', 20773056168SMichael Klier array('struct','string','int'), 20873056168SMichael Klier 'Returns the available revisions of the page.' 20973056168SMichael Klier ); 21073056168SMichael Klier $this->addCallback( 2113a1dad2dSDennis Ploeger 'wiki.putPage', 2123a1dad2dSDennis Ploeger 'this:putPage', 213222572bfSMichael Klier array('int', 'string', 'string', 'struct'), 214fdd2e9d6SMichael Klier 'Saves a wiki page.' 2153a1dad2dSDennis Ploeger ); 216beccd742SMichael Klier $this->addCallback( 217beccd742SMichael Klier 'wiki.listLinks', 218beccd742SMichael Klier 'this:listLinks', 219beccd742SMichael Klier array('struct','string'), 220fdd2e9d6SMichael Klier 'Lists all links contained in a wiki page.' 221beccd742SMichael Klier ); 22263dd0d58SMichael Klier $this->addCallback( 22363dd0d58SMichael Klier 'wiki.getRecentChanges', 22463dd0d58SMichael Klier 'this:getRecentChanges', 22563dd0d58SMichael Klier array('struct','int'), 22699c8d7f2Smichael 'Returns a struct about all recent changes since given timestamp.' 22799c8d7f2Smichael ); 22899c8d7f2Smichael $this->addCallback( 22999c8d7f2Smichael 'wiki.getRecentMediaChanges', 23099c8d7f2Smichael 'this:getRecentMediaChanges', 23199c8d7f2Smichael array('struct','int'), 23299c8d7f2Smichael 'Returns a struct about all recent media changes since given timestamp.' 23363dd0d58SMichael Klier ); 234e62b9ea5SMichael Klier $this->addCallback( 235e62b9ea5SMichael Klier 'wiki.aclCheck', 236e62b9ea5SMichael Klier 'this:aclCheck', 237c63d1645SGina Haeussge array('int', 'string'), 238e62b9ea5SMichael Klier 'Returns the permissions of a given wiki page.' 239e62b9ea5SMichael Klier ); 2402aca132fSMichael Klier $this->addCallback( 2412aca132fSMichael Klier 'wiki.putAttachment', 2422aca132fSMichael Klier 'this:putAttachment', 2432aca132fSMichael Klier array('struct', 'string', 'base64', 'struct'), 2442aca132fSMichael Klier 'Upload a file to the wiki.' 2452aca132fSMichael Klier ); 246cfef3001SGina Haeussge $this->addCallback( 247f01ff8c1SGina Haeussge 'wiki.deleteAttachment', 248f01ff8c1SGina Haeussge 'this:deleteAttachment', 249f01ff8c1SGina Haeussge array('int', 'string'), 250f01ff8c1SGina Haeussge 'Delete a file from the wiki.' 251f01ff8c1SGina Haeussge ); 252f01ff8c1SGina Haeussge $this->addCallback( 253cfef3001SGina Haeussge 'wiki.getAttachment', 254cfef3001SGina Haeussge 'this:getAttachment', 255c63d1645SGina Haeussge array('base64', 'string'), 256cfef3001SGina Haeussge 'Download a file from the wiki.' 257cfef3001SGina Haeussge ); 2585672e868SGina Haeussge $this->addCallback( 2595672e868SGina Haeussge 'wiki.getAttachmentInfo', 2605672e868SGina Haeussge 'this:getAttachmentInfo', 261c63d1645SGina Haeussge array('struct', 'string'), 2625672e868SGina Haeussge 'Returns a struct with infos about the attachment.' 2635672e868SGina Haeussge ); 264797c0d11SAndreas Gohr 265bb32615dSMichael Klier /** 266bb32615dSMichael Klier * Trigger XMLRPC_CALLBACK_REGISTER, action plugins can use this event 267bb32615dSMichael Klier * to extend the XMLRPC interface and register their own callbacks. 268bb32615dSMichael Klier * 269bb32615dSMichael Klier * Event data: 270bb32615dSMichael Klier * The XMLRPC server object: 271bb32615dSMichael Klier * 272bb32615dSMichael Klier * $event->data->addCallback() - register a callback, the second 273bb32615dSMichael Klier * paramter has to be of the form "plugin:<pluginname>:<plugin 274bb32615dSMichael Klier * method>" 275bb32615dSMichael Klier * 276bb32615dSMichael Klier * $event->data->callbacks - an array which holds all awaylable 277bb32615dSMichael Klier * callbacks 278bb32615dSMichael Klier */ 279bb32615dSMichael Klier trigger_event('XMLRPC_CALLBACK_REGISTER', $this); 280bb32615dSMichael Klier 281797c0d11SAndreas Gohr $this->serve(); 282797c0d11SAndreas Gohr } 283797c0d11SAndreas Gohr 284797c0d11SAndreas Gohr /** 285797c0d11SAndreas Gohr * Return a raw wiki page 286797c0d11SAndreas Gohr */ 287797c0d11SAndreas Gohr function rawPage($id,$rev=''){ 288797c0d11SAndreas Gohr if(auth_quickaclcheck($id) < AUTH_READ){ 289797c0d11SAndreas Gohr return new IXR_Error(1, 'You are not allowed to read this page'); 290797c0d11SAndreas Gohr } 2912c176304SMichael Klier $text = rawWiki($id,$rev); 2922c176304SMichael Klier if(!$text) { 293*fe17917eSAdrian Lang return pageTemplate($id); 2942c176304SMichael Klier } else { 2952c176304SMichael Klier return $text; 2962c176304SMichael Klier } 297797c0d11SAndreas Gohr } 298797c0d11SAndreas Gohr 299797c0d11SAndreas Gohr /** 300cfef3001SGina Haeussge * Return a media file encoded in base64 301c63d1645SGina Haeussge * 302c63d1645SGina Haeussge * @author Gina Haeussge <osd@foosel.net> 303cfef3001SGina Haeussge */ 304cfef3001SGina Haeussge function getAttachment($id){ 305c63d1645SGina Haeussge $id = cleanID($id); 306cfef3001SGina Haeussge if (auth_quickaclcheck(getNS($id).':*') < AUTH_READ) 307cfef3001SGina Haeussge return new IXR_Error(1, 'You are not allowed to read this file'); 308cfef3001SGina Haeussge 309cfef3001SGina Haeussge $file = mediaFN($id); 310cfef3001SGina Haeussge if (!@ file_exists($file)) 311cfef3001SGina Haeussge return new IXR_Error(1, 'The requested file does not exist'); 312cfef3001SGina Haeussge 313cfef3001SGina Haeussge $data = io_readFile($file, false); 314cfef3001SGina Haeussge $base64 = base64_encode($data); 315cfef3001SGina Haeussge return $base64; 316cfef3001SGina Haeussge } 317cfef3001SGina Haeussge 318cfef3001SGina Haeussge /** 3195672e868SGina Haeussge * Return info about a media file 3205672e868SGina Haeussge * 3215672e868SGina Haeussge * @author Gina Haeussge <osd@foosel.net> 3225672e868SGina Haeussge */ 3235672e868SGina Haeussge function getAttachmentInfo($id){ 3245672e868SGina Haeussge $id = cleanID($id); 3255672e868SGina Haeussge $info = array( 3265672e868SGina Haeussge 'lastModified' => 0, 3275672e868SGina Haeussge 'size' => 0, 3285672e868SGina Haeussge ); 3295672e868SGina Haeussge 3305672e868SGina Haeussge $file = mediaFN($id); 3315672e868SGina Haeussge if ((auth_quickaclcheck(getNS($id).':*') >= AUTH_READ) && file_exists($file)){ 3325672e868SGina Haeussge $info['lastModified'] = new IXR_Date(filemtime($file)); 3335672e868SGina Haeussge $info['size'] = filesize($file); 3345672e868SGina Haeussge } 3355672e868SGina Haeussge 3365672e868SGina Haeussge return $info; 3375672e868SGina Haeussge } 3385672e868SGina Haeussge 3395672e868SGina Haeussge /** 340797c0d11SAndreas Gohr * Return a wiki page rendered to html 341797c0d11SAndreas Gohr */ 342797c0d11SAndreas Gohr function htmlPage($id,$rev=''){ 343797c0d11SAndreas Gohr if(auth_quickaclcheck($id) < AUTH_READ){ 344797c0d11SAndreas Gohr return new IXR_Error(1, 'You are not allowed to read this page'); 345797c0d11SAndreas Gohr } 346797c0d11SAndreas Gohr return p_wiki_xhtml($id,$rev,false); 347797c0d11SAndreas Gohr } 348797c0d11SAndreas Gohr 349797c0d11SAndreas Gohr /** 350797c0d11SAndreas Gohr * List all pages - we use the indexer list here 351797c0d11SAndreas Gohr */ 352797c0d11SAndreas Gohr function listPages(){ 353dfd13e55SMichael Klier global $conf; 354dfd13e55SMichael Klier 355dfd13e55SMichael Klier $list = array(); 356dfd13e55SMichael Klier $pages = file($conf['indexdir'] . '/page.idx'); 357dfd13e55SMichael Klier $pages = array_filter($pages, 'isVisiblePage'); 358dfd13e55SMichael Klier 359dfd13e55SMichael Klier foreach(array_keys($pages) as $idx) { 360dfd13e55SMichael Klier if(page_exists($pages[$idx])) { 361dfd13e55SMichael Klier $perm = auth_quickaclcheck($pages[$idx]); 362dfd13e55SMichael Klier if($perm >= AUTH_READ) { 363dfd13e55SMichael Klier $page = array(); 364dfd13e55SMichael Klier $page['id'] = trim($pages[$idx]); 365dfd13e55SMichael Klier $page['perms'] = $perm; 366dfd13e55SMichael Klier $page['size'] = @filesize(wikiFN($pages[$idx])); 367e070c6f3SGina Haeussge $page['lastModified'] = new IXR_Date(@filemtime(wikiFN($pages[$idx]))); 368dfd13e55SMichael Klier $list[] = $page; 369dfd13e55SMichael Klier } 370dfd13e55SMichael Klier } 371dfd13e55SMichael Klier } 372dfd13e55SMichael Klier 373dfd13e55SMichael Klier return $list; 374797c0d11SAndreas Gohr } 375797c0d11SAndreas Gohr 376797c0d11SAndreas Gohr /** 3771b11c097SAndreas Gohr * List all pages in the given namespace (and below) 3781b11c097SAndreas Gohr */ 3791b11c097SAndreas Gohr function readNamespace($ns,$opts){ 3801b11c097SAndreas Gohr global $conf; 3811b11c097SAndreas Gohr 3821b11c097SAndreas Gohr if(!is_array($opts)) $opts=array(); 3831b11c097SAndreas Gohr 3841b11c097SAndreas Gohr $ns = cleanID($ns); 3851b11c097SAndreas Gohr $dir = utf8_encodeFN(str_replace(':', '/', $ns)); 3861b11c097SAndreas Gohr $data = array(); 3871b11c097SAndreas Gohr require_once(DOKU_INC.'inc/search.php'); 3886fc3aa1aSAndreas Gohr $opts['skipacl'] = 0; // no ACL skipping for XMLRPC 3891b11c097SAndreas Gohr search($data, $conf['datadir'], 'search_allpages', $opts, $dir); 3901b11c097SAndreas Gohr return $data; 3911b11c097SAndreas Gohr } 3921b11c097SAndreas Gohr 3931b11c097SAndreas Gohr /** 394f71f4f53SAndreas Gohr * List all pages in the given namespace (and below) 395f71f4f53SAndreas Gohr */ 396f71f4f53SAndreas Gohr function search($query){ 397f71f4f53SAndreas Gohr require_once(DOKU_INC.'inc/fulltext.php'); 398f71f4f53SAndreas Gohr 399f71f4f53SAndreas Gohr $regex = ''; 400f71f4f53SAndreas Gohr $data = ft_pageSearch($query,$regex); 401f71f4f53SAndreas Gohr $pages = array(); 402f71f4f53SAndreas Gohr 403f71f4f53SAndreas Gohr // prepare additional data 404f71f4f53SAndreas Gohr $idx = 0; 405f71f4f53SAndreas Gohr foreach($data as $id => $score){ 406f71f4f53SAndreas Gohr $file = wikiFN($id); 407f71f4f53SAndreas Gohr 408f71f4f53SAndreas Gohr if($idx < FT_SNIPPET_NUMBER){ 409f71f4f53SAndreas Gohr $snippet = ft_snippet($id,$regex); 410f71f4f53SAndreas Gohr $idx++; 411f71f4f53SAndreas Gohr }else{ 412f71f4f53SAndreas Gohr $snippet = ''; 413f71f4f53SAndreas Gohr } 414f71f4f53SAndreas Gohr 415f71f4f53SAndreas Gohr $pages[] = array( 416f71f4f53SAndreas Gohr 'id' => $id, 417f71f4f53SAndreas Gohr 'score' => $score, 418f71f4f53SAndreas Gohr 'rev' => filemtime($file), 419f71f4f53SAndreas Gohr 'mtime' => filemtime($file), 420f71f4f53SAndreas Gohr 'size' => filesize($file), 421f71f4f53SAndreas Gohr 'snippet' => $snippet, 422f71f4f53SAndreas Gohr ); 423f71f4f53SAndreas Gohr } 424f71f4f53SAndreas Gohr return $data; 425f71f4f53SAndreas Gohr } 426f71f4f53SAndreas Gohr 427f71f4f53SAndreas Gohr 428f71f4f53SAndreas Gohr /** 42926bec61eSMichael Klier * List all media files. 4303275953aSGina Haeussge * 4313275953aSGina Haeussge * Available options are 'recursive' for also including the subnamespaces 4323275953aSGina Haeussge * in the listing, and 'pattern' for filtering the returned files against 4333275953aSGina Haeussge * a regular expression matching their name. 4343275953aSGina Haeussge * 4353275953aSGina Haeussge * @author Gina Haeussge <osd@foosel.net> 43626bec61eSMichael Klier */ 4373275953aSGina Haeussge function listAttachments($ns, $options = array()) { 43826bec61eSMichael Klier global $conf; 43926bec61eSMichael Klier global $lang; 44026bec61eSMichael Klier 44126bec61eSMichael Klier $ns = cleanID($ns); 44226bec61eSMichael Klier 4436fc3aa1aSAndreas Gohr if (!is_array($options)) $options = array(); 4446fc3aa1aSAndreas Gohr $options['skipacl'] = 0; // no ACL skipping for XMLRPC 4453275953aSGina Haeussge 4463275953aSGina Haeussge 44726bec61eSMichael Klier if(auth_quickaclcheck($ns.':*') >= AUTH_READ) { 44826bec61eSMichael Klier $dir = utf8_encodeFN(str_replace(':', '/', $ns)); 44926bec61eSMichael Klier 45026bec61eSMichael Klier $data = array(); 45126bec61eSMichael Klier require_once(DOKU_INC.'inc/search.php'); 452224122cfSAndreas Gohr search($data, $conf['mediadir'], 'search_media', $options, $dir); 453224122cfSAndreas Gohr $len = count($data); 454224122cfSAndreas Gohr if(!$len) return array(); 45526bec61eSMichael Klier 456224122cfSAndreas Gohr for($i=0; $i<$len; $i++) { 457224122cfSAndreas Gohr unset($data[$i]['meta']); 458224122cfSAndreas Gohr $data[$i]['lastModified'] = new IXR_Date($data[$i]['mtime']); 45926bec61eSMichael Klier } 460224122cfSAndreas Gohr return $data; 46126bec61eSMichael Klier } else { 46226bec61eSMichael Klier return new IXR_Error(1, 'You are not allowed to list media files.'); 46326bec61eSMichael Klier } 46426bec61eSMichael Klier } 46526bec61eSMichael Klier 46626bec61eSMichael Klier /** 467797c0d11SAndreas Gohr * Return a list of backlinks 468797c0d11SAndreas Gohr */ 469beccd742SMichael Klier function listBackLinks($id){ 470797c0d11SAndreas Gohr require_once(DOKU_INC.'inc/fulltext.php'); 471797c0d11SAndreas Gohr return ft_backlinks($id); 472797c0d11SAndreas Gohr } 473797c0d11SAndreas Gohr 474797c0d11SAndreas Gohr /** 47563dd0d58SMichael Klier * Return some basic data about a page 476797c0d11SAndreas Gohr */ 477797c0d11SAndreas Gohr function pageInfo($id,$rev=''){ 478797c0d11SAndreas Gohr if(auth_quickaclcheck($id) < AUTH_READ){ 479797c0d11SAndreas Gohr return new IXR_Error(1, 'You are not allowed to read this page'); 480797c0d11SAndreas Gohr } 481797c0d11SAndreas Gohr $file = wikiFN($id,$rev); 482797c0d11SAndreas Gohr $time = @filemtime($file); 483797c0d11SAndreas Gohr if(!$time){ 484797c0d11SAndreas Gohr return new IXR_Error(10, 'The requested page does not exist'); 485797c0d11SAndreas Gohr } 486797c0d11SAndreas Gohr 487797c0d11SAndreas Gohr $info = getRevisionInfo($id, $time, 1024); 488797c0d11SAndreas Gohr 489797c0d11SAndreas Gohr $data = array( 490797c0d11SAndreas Gohr 'name' => $id, 491797c0d11SAndreas Gohr 'lastModified' => new IXR_Date($time), 492797c0d11SAndreas Gohr 'author' => (($info['user']) ? $info['user'] : $info['ip']), 493797c0d11SAndreas Gohr 'version' => $time 494797c0d11SAndreas Gohr ); 49563dd0d58SMichael Klier 49663dd0d58SMichael Klier return ($data); 497797c0d11SAndreas Gohr } 498797c0d11SAndreas Gohr 499797c0d11SAndreas Gohr /** 5003a1dad2dSDennis Ploeger * Save a wiki page 501222572bfSMichael Klier * 502222572bfSMichael Klier * @author Michael Klier <chi@chimeric.de> 5033a1dad2dSDennis Ploeger */ 504222572bfSMichael Klier function putPage($id, $text, $params) { 5053a1dad2dSDennis Ploeger global $TEXT; 506a6a229ceSMichael Klier global $lang; 507593bf8f6SMichael Klier global $conf; 5083a1dad2dSDennis Ploeger 509222572bfSMichael Klier $id = cleanID($id); 51056523eecSAndreas Gohr $TEXT = cleanText($text); 511222572bfSMichael Klier $sum = $params['sum']; 512222572bfSMichael Klier $minor = $params['minor']; 513222572bfSMichael Klier 514222572bfSMichael Klier if(empty($id)) 515fdd2e9d6SMichael Klier return new IXR_Error(1, 'Empty page ID'); 516222572bfSMichael Klier 51756523eecSAndreas Gohr if(!page_exists($id) && trim($TEXT) == '' ) { 51851597811SMichael Klier return new IXR_ERROR(1, 'Refusing to write an empty new wiki page'); 51951597811SMichael Klier } 52051597811SMichael Klier 521055b0144SChris Smith if(auth_quickaclcheck($id) < AUTH_EDIT) 522222572bfSMichael Klier return new IXR_Error(1, 'You are not allowed to edit this page'); 5233a1dad2dSDennis Ploeger 5243a1dad2dSDennis Ploeger // Check, if page is locked 525222572bfSMichael Klier if(checklock($id)) 526222572bfSMichael Klier return new IXR_Error(1, 'The page is currently locked'); 527222572bfSMichael Klier 528a6a229ceSMichael Klier // SPAM check 5293a1dad2dSDennis Ploeger if(checkwordblock()) 530222572bfSMichael Klier return new IXR_Error(1, 'Positive wordblock check'); 5313a1dad2dSDennis Ploeger 532a6a229ceSMichael Klier // autoset summary on new pages 533a6a229ceSMichael Klier if(!page_exists($id) && empty($sum)) { 534a6a229ceSMichael Klier $sum = $lang['created']; 535a6a229ceSMichael Klier } 536a6a229ceSMichael Klier 537a6a229ceSMichael Klier // autoset summary on deleted pages 538a6a229ceSMichael Klier if(page_exists($id) && empty($TEXT) && empty($sum)) { 539a6a229ceSMichael Klier $sum = $lang['deleted']; 540a6a229ceSMichael Klier } 541a6a229ceSMichael Klier 542222572bfSMichael Klier lock($id); 5433a1dad2dSDennis Ploeger 544222572bfSMichael Klier saveWikiText($id,$TEXT,$sum,$minor); 5453a1dad2dSDennis Ploeger 546222572bfSMichael Klier unlock($id); 5473a1dad2dSDennis Ploeger 548593bf8f6SMichael Klier // run the indexer if page wasn't indexed yet 549593bf8f6SMichael Klier if(!@file_exists(metaFN($id, '.indexed'))) { 550593bf8f6SMichael Klier // try to aquire a lock 551593bf8f6SMichael Klier $lock = $conf['lockdir'].'/_indexer.lock'; 552593bf8f6SMichael Klier while(!@mkdir($lock,$conf['dmode'])){ 553593bf8f6SMichael Klier usleep(50); 554593bf8f6SMichael Klier if(time()-@filemtime($lock) > 60*5){ 555593bf8f6SMichael Klier // looks like a stale lock - remove it 556593bf8f6SMichael Klier @rmdir($lock); 557593bf8f6SMichael Klier }else{ 558593bf8f6SMichael Klier return false; 559593bf8f6SMichael Klier } 560593bf8f6SMichael Klier } 561593bf8f6SMichael Klier if($conf['dperm']) chmod($lock, $conf['dperm']); 562593bf8f6SMichael Klier 563593bf8f6SMichael Klier require_once(DOKU_INC.'inc/indexer.php'); 564593bf8f6SMichael Klier 565593bf8f6SMichael Klier // do the work 566593bf8f6SMichael Klier idx_addPage($id); 567593bf8f6SMichael Klier 568593bf8f6SMichael Klier // we're finished - save and free lock 569593bf8f6SMichael Klier io_saveFile(metaFN($id,'.indexed'),INDEXER_VERSION); 570593bf8f6SMichael Klier @rmdir($lock); 571593bf8f6SMichael Klier } 572593bf8f6SMichael Klier 5733a1dad2dSDennis Ploeger return 0; 574beccd742SMichael Klier } 5753a1dad2dSDennis Ploeger 576beccd742SMichael Klier /** 5772aca132fSMichael Klier * Uploads a file to the wiki. 5782aca132fSMichael Klier * 5792aca132fSMichael Klier * Michael Klier <chi@chimeric.de> 5802aca132fSMichael Klier */ 581f01ff8c1SGina Haeussge function putAttachment($id, $file, $params) { 5822aca132fSMichael Klier global $conf; 5832aca132fSMichael Klier global $lang; 5842aca132fSMichael Klier 585f01ff8c1SGina Haeussge $auth = auth_quickaclcheck(getNS($id).':*'); 5862aca132fSMichael Klier if($auth >= AUTH_UPLOAD) { 587f01ff8c1SGina Haeussge if(!isset($id)) { 5882aca132fSMichael Klier return new IXR_ERROR(1, 'Filename not given.'); 5892aca132fSMichael Klier } 5902aca132fSMichael Klier 591f01ff8c1SGina Haeussge $ftmp = $conf['tmpdir'] . '/' . $id; 5922aca132fSMichael Klier 5932aca132fSMichael Klier // save temporary file 5942aca132fSMichael Klier @unlink($ftmp); 5952aca132fSMichael Klier $buff = base64_decode($file); 5962aca132fSMichael Klier io_saveFile($ftmp, $buff); 5972aca132fSMichael Klier 5982aca132fSMichael Klier // get filename 599ecebf3a8SAndreas Gohr list($iext, $imime,$dl) = mimetype($id); 600f01ff8c1SGina Haeussge $id = cleanID($id); 6012aca132fSMichael Klier $fn = mediaFN($id); 6022aca132fSMichael Klier 6032aca132fSMichael Klier // get filetype regexp 6042aca132fSMichael Klier $types = array_keys(getMimeTypes()); 6052aca132fSMichael Klier $types = array_map(create_function('$q','return preg_quote($q,"/");'),$types); 6062aca132fSMichael Klier $regex = join('|',$types); 6072aca132fSMichael Klier 6082aca132fSMichael Klier // because a temp file was created already 6092aca132fSMichael Klier if(preg_match('/\.('.$regex.')$/i',$fn)) { 6102aca132fSMichael Klier //check for overwrite 61199c8d7f2Smichael $overwrite = @file_exists($fn); 61299c8d7f2Smichael if($overwrite && (!$params['ow'] || $auth < AUTH_DELETE)) { 613224122cfSAndreas Gohr return new IXR_ERROR(1, $lang['uploadexist'].'1'); 6142aca132fSMichael Klier } 6152aca132fSMichael Klier // check for valid content 6162aca132fSMichael Klier @require_once(DOKU_INC.'inc/media.php'); 6172aca132fSMichael Klier $ok = media_contentcheck($ftmp, $imime); 6182aca132fSMichael Klier if($ok == -1) { 619224122cfSAndreas Gohr return new IXR_ERROR(1, sprintf($lang['uploadexist'].'2', ".$iext")); 6202aca132fSMichael Klier } elseif($ok == -2) { 6212aca132fSMichael Klier return new IXR_ERROR(1, $lang['uploadspam']); 6222aca132fSMichael Klier } elseif($ok == -3) { 6232aca132fSMichael Klier return new IXR_ERROR(1, $lang['uploadxss']); 6242aca132fSMichael Klier } 6252aca132fSMichael Klier 6262aca132fSMichael Klier // prepare event data 6272aca132fSMichael Klier $data[0] = $ftmp; 6282aca132fSMichael Klier $data[1] = $fn; 6292aca132fSMichael Klier $data[2] = $id; 6302aca132fSMichael Klier $data[3] = $imime; 63199c8d7f2Smichael $data[4] = $overwrite; 6322aca132fSMichael Klier 6332aca132fSMichael Klier // trigger event 6342aca132fSMichael Klier require_once(DOKU_INC.'inc/events.php'); 6352aca132fSMichael Klier return trigger_event('MEDIA_UPLOAD_FINISH', $data, array($this, '_media_upload_action'), true); 6362aca132fSMichael Klier 6372aca132fSMichael Klier } else { 6382aca132fSMichael Klier return new IXR_ERROR(1, $lang['uploadwrong']); 6392aca132fSMichael Klier } 6402aca132fSMichael Klier } else { 6412aca132fSMichael Klier return new IXR_ERROR(1, "You don't have permissions to upload files."); 6422aca132fSMichael Klier } 6432aca132fSMichael Klier } 6442aca132fSMichael Klier 6452aca132fSMichael Klier /** 646f01ff8c1SGina Haeussge * Deletes a file from the wiki. 647f01ff8c1SGina Haeussge * 648f01ff8c1SGina Haeussge * @author Gina Haeussge <osd@foosel.net> 649f01ff8c1SGina Haeussge */ 650f01ff8c1SGina Haeussge function deleteAttachment($id){ 651f01ff8c1SGina Haeussge $auth = auth_quickaclcheck(getNS($id).':*'); 652f01ff8c1SGina Haeussge if($auth < AUTH_DELETE) return new IXR_ERROR(1, "You don't have permissions to delete files."); 653f01ff8c1SGina Haeussge global $conf; 654f01ff8c1SGina Haeussge global $lang; 655f01ff8c1SGina Haeussge 656f01ff8c1SGina Haeussge // check for references if needed 657f01ff8c1SGina Haeussge $mediareferences = array(); 658f01ff8c1SGina Haeussge if($conf['refcheck']){ 659f01ff8c1SGina Haeussge require_once(DOKU_INC.'inc/fulltext.php'); 660f01ff8c1SGina Haeussge $mediareferences = ft_mediause($id,$conf['refshow']); 661f01ff8c1SGina Haeussge } 662f01ff8c1SGina Haeussge 663f01ff8c1SGina Haeussge if(!count($mediareferences)){ 664f01ff8c1SGina Haeussge $file = mediaFN($id); 665f01ff8c1SGina Haeussge if(@unlink($file)){ 66699c8d7f2Smichael require_once(DOKU_INC.'inc/changelog.php'); 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 require_once(DOKU_INC.'inc/changelog.php'); 69399c8d7f2Smichael if ($data[4]) { 69499c8d7f2Smichael addMediaLogEntry(time(), $data[2], DOKU_CHANGE_TYPE_EDIT); 69599c8d7f2Smichael } else { 69699c8d7f2Smichael addMediaLogEntry(time(), $data[2], DOKU_CHANGE_TYPE_CREATE); 69799c8d7f2Smichael } 6982aca132fSMichael Klier return $data[2]; 6992aca132fSMichael Klier } else { 7002aca132fSMichael Klier return new IXR_ERROR(1, 'Upload failed.'); 7012aca132fSMichael Klier } 7022aca132fSMichael Klier } else { 7032aca132fSMichael Klier return new IXR_ERROR(1, 'Upload failed.'); 7042aca132fSMichael Klier } 7052aca132fSMichael Klier } 7062aca132fSMichael Klier 7072aca132fSMichael Klier /** 708e62b9ea5SMichael Klier * Returns the permissions of a given wiki page 709e62b9ea5SMichael Klier */ 710e62b9ea5SMichael Klier function aclCheck($id) { 711e62b9ea5SMichael Klier return auth_quickaclcheck($id); 712e62b9ea5SMichael Klier } 713e62b9ea5SMichael Klier 714e62b9ea5SMichael Klier /** 715beccd742SMichael Klier * Lists all links contained in a wiki page 71663dd0d58SMichael Klier * 71763dd0d58SMichael Klier * @author Michael Klier <chi@chimeric.de> 718beccd742SMichael Klier */ 719beccd742SMichael Klier function listLinks($id) { 720beccd742SMichael Klier if(auth_quickaclcheck($id) < AUTH_READ){ 721beccd742SMichael Klier return new IXR_Error(1, 'You are not allowed to read this page'); 722beccd742SMichael Klier } 723beccd742SMichael Klier $links = array(); 724beccd742SMichael Klier 725beccd742SMichael Klier // resolve page instructions 726beccd742SMichael Klier $ins = p_cached_instructions(wikiFN(cleanID($id))); 727beccd742SMichael Klier 728beccd742SMichael Klier // instantiate new Renderer - needed for interwiki links 729beccd742SMichael Klier include(DOKU_INC.'inc/parser/xhtml.php'); 730beccd742SMichael Klier $Renderer = new Doku_Renderer_xhtml(); 731beccd742SMichael Klier $Renderer->interwiki = getInterwiki(); 732beccd742SMichael Klier 733beccd742SMichael Klier // parse parse instructions 734beccd742SMichael Klier foreach($ins as $in) { 735beccd742SMichael Klier $link = array(); 736beccd742SMichael Klier switch($in[0]) { 737beccd742SMichael Klier case 'internallink': 738beccd742SMichael Klier $link['type'] = 'local'; 739beccd742SMichael Klier $link['page'] = $in[1][0]; 740beccd742SMichael Klier $link['href'] = wl($in[1][0]); 741beccd742SMichael Klier array_push($links,$link); 742beccd742SMichael Klier break; 743beccd742SMichael Klier case 'externallink': 744beccd742SMichael Klier $link['type'] = 'extern'; 745beccd742SMichael Klier $link['page'] = $in[1][0]; 746beccd742SMichael Klier $link['href'] = $in[1][0]; 747beccd742SMichael Klier array_push($links,$link); 748beccd742SMichael Klier break; 749beccd742SMichael Klier case 'interwikilink': 750beccd742SMichael Klier $url = $Renderer->_resolveInterWiki($in[1][2],$in[1][3]); 751beccd742SMichael Klier $link['type'] = 'extern'; 752beccd742SMichael Klier $link['page'] = $url; 753beccd742SMichael Klier $link['href'] = $url; 754beccd742SMichael Klier array_push($links,$link); 755beccd742SMichael Klier break; 756beccd742SMichael Klier } 757beccd742SMichael Klier } 758beccd742SMichael Klier 75963dd0d58SMichael Klier return ($links); 76063dd0d58SMichael Klier } 76163dd0d58SMichael Klier 76263dd0d58SMichael Klier /** 76363dd0d58SMichael Klier * Returns a list of recent changes since give timestamp 76463dd0d58SMichael Klier * 76599c8d7f2Smichael * @author Michael Hamann <michael@content-space.de> 76663dd0d58SMichael Klier * @author Michael Klier <chi@chimeric.de> 76763dd0d58SMichael Klier */ 76863dd0d58SMichael Klier function getRecentChanges($timestamp) { 76963dd0d58SMichael Klier if(strlen($timestamp) != 10) 77063dd0d58SMichael Klier return new IXR_Error(20, 'The provided value is not a valid timestamp'); 77163dd0d58SMichael Klier 77263dd0d58SMichael Klier require_once(DOKU_INC.'inc/changelog.php'); 77363dd0d58SMichael Klier require_once(DOKU_INC.'inc/pageutils.php'); 77463dd0d58SMichael Klier 77599c8d7f2Smichael $recents = getRecentsSince($timestamp); 77663dd0d58SMichael Klier 77799c8d7f2Smichael $changes = array(); 77863dd0d58SMichael Klier 77999c8d7f2Smichael foreach ($recents as $recent) { 78099c8d7f2Smichael $change = array(); 78199c8d7f2Smichael $change['name'] = $recent['id']; 78299c8d7f2Smichael $change['lastModified'] = new IXR_Date($recent['date']); 78399c8d7f2Smichael $change['author'] = $recent['user']; 78499c8d7f2Smichael $change['version'] = $recent['date']; 78599c8d7f2Smichael $change['perms'] = $recent['perms']; 78699c8d7f2Smichael $change['size'] = @filesize(wikiFN($recent['id'])); 78763dd0d58SMichael Klier array_push($changes, $change); 78899c8d7f2Smichael } 78999c8d7f2Smichael 79099c8d7f2Smichael if (!empty($changes)) { 79199c8d7f2Smichael return $changes; 79263dd0d58SMichael Klier } else { 79363dd0d58SMichael Klier // in case we still have nothing at this point 79463dd0d58SMichael Klier return new IXR_Error(30, 'There are no changes in the specified timeframe'); 7953a1dad2dSDennis Ploeger } 79699c8d7f2Smichael } 79799c8d7f2Smichael 79899c8d7f2Smichael /** 79999c8d7f2Smichael * Returns a list of recent media changes since give timestamp 80099c8d7f2Smichael * 80199c8d7f2Smichael * @author Michael Hamann <michael@content-space.de> 80299c8d7f2Smichael * @author Michael Klier <chi@chimeric.de> 80399c8d7f2Smichael */ 80499c8d7f2Smichael function getRecentMediaChanges($timestamp) { 80599c8d7f2Smichael if(strlen($timestamp) != 10) 80699c8d7f2Smichael return new IXR_Error(20, 'The provided value is not a valid timestamp'); 80799c8d7f2Smichael 80899c8d7f2Smichael require_once(DOKU_INC.'inc/changelog.php'); 80999c8d7f2Smichael require_once(DOKU_INC.'inc/pageutils.php'); 81099c8d7f2Smichael 81199c8d7f2Smichael $recents = getRecentsSince($timestamp, null, '', RECENTS_MEDIA_CHANGES); 81299c8d7f2Smichael 81399c8d7f2Smichael $changes = array(); 81499c8d7f2Smichael 81599c8d7f2Smichael foreach ($recents as $recent) { 81699c8d7f2Smichael $change = array(); 81799c8d7f2Smichael $change['name'] = $recent['id']; 81899c8d7f2Smichael $change['lastModified'] = new IXR_Date($recent['date']); 81999c8d7f2Smichael $change['author'] = $recent['user']; 82099c8d7f2Smichael $change['version'] = $recent['date']; 82199c8d7f2Smichael $change['perms'] = $recent['perms']; 822a4da2756Smichael $change['size'] = @filesize(mediaFN($recent['id'])); 82399c8d7f2Smichael array_push($changes, $change); 82499c8d7f2Smichael } 82599c8d7f2Smichael 82699c8d7f2Smichael if (!empty($changes)) { 82799c8d7f2Smichael return $changes; 82899c8d7f2Smichael } else { 82999c8d7f2Smichael // in case we still have nothing at this point 83099c8d7f2Smichael return new IXR_Error(30, 'There are no changes in the specified timeframe'); 83199c8d7f2Smichael } 83299c8d7f2Smichael } 8333a1dad2dSDennis Ploeger 8343a1dad2dSDennis Ploeger /** 83573056168SMichael Klier * Returns a list of available revisions of a given wiki page 83673056168SMichael Klier * 83773056168SMichael Klier * @author Michael Klier <chi@chimeric.de> 83873056168SMichael Klier */ 83973056168SMichael Klier function pageVersions($id, $first) { 84073056168SMichael Klier global $conf; 84173056168SMichael Klier 84273056168SMichael Klier $versions = array(); 84373056168SMichael Klier 84473056168SMichael Klier if(empty($id)) 84573056168SMichael Klier return new IXR_Error(1, 'Empty page ID'); 84673056168SMichael Klier 84773056168SMichael Klier require_once(DOKU_INC.'inc/changelog.php'); 84873056168SMichael Klier 84973056168SMichael Klier $revisions = getRevisions($id, $first, $conf['recent']+1); 85073056168SMichael Klier 85173056168SMichael Klier if(count($revisions)==0 && $first!=0) { 85273056168SMichael Klier $first=0; 85373056168SMichael Klier $revisions = getRevisions($id, $first, $conf['recent']+1); 85473056168SMichael Klier } 85573056168SMichael Klier 85645c63471SMichael Klier if(count($revisions)>0 && $first==0) { 85745c63471SMichael Klier array_unshift($revisions, ''); // include current revision 85845c63471SMichael Klier array_pop($revisions); // remove extra log entry 85945c63471SMichael Klier } 86045c63471SMichael Klier 86173056168SMichael Klier $hasNext = false; 86273056168SMichael Klier if(count($revisions)>$conf['recent']) { 86373056168SMichael Klier $hasNext = true; 86473056168SMichael Klier array_pop($revisions); // remove extra log entry 86573056168SMichael Klier } 86673056168SMichael Klier 86773056168SMichael Klier if(!empty($revisions)) { 86873056168SMichael Klier foreach($revisions as $rev) { 86973056168SMichael Klier $file = wikiFN($id,$rev); 87073056168SMichael Klier $time = @filemtime($file); 87145c63471SMichael Klier // we check if the page actually exists, if this is not the 87245c63471SMichael Klier // case this can lead to less pages being returned than 87345c63471SMichael Klier // specified via $conf['recent'] 87473056168SMichael Klier if($time){ 87573056168SMichael Klier $info = getRevisionInfo($id, $time, 1024); 87673056168SMichael Klier if(!empty($info)) { 87773056168SMichael Klier $data['user'] = $info['user']; 87873056168SMichael Klier $data['ip'] = $info['ip']; 87973056168SMichael Klier $data['type'] = $info['type']; 88073056168SMichael Klier $data['sum'] = $info['sum']; 88173056168SMichael Klier $data['modified'] = new IXR_Date($info['date']); 88273056168SMichael Klier $data['version'] = $info['date']; 88373056168SMichael Klier array_push($versions, $data); 88473056168SMichael Klier } 88573056168SMichael Klier } 88673056168SMichael Klier } 88773056168SMichael Klier return $versions; 88873056168SMichael Klier } else { 88973056168SMichael Klier return array(); 89073056168SMichael Klier } 89173056168SMichael Klier } 89273056168SMichael Klier 89373056168SMichael Klier /** 894797c0d11SAndreas Gohr * The version of Wiki RPC API supported 895797c0d11SAndreas Gohr */ 896797c0d11SAndreas Gohr function wiki_RPCVersion(){ 897797c0d11SAndreas Gohr return 2; 898797c0d11SAndreas Gohr } 8991b11c097SAndreas Gohr 90028ec3c76SAndreas Gohr 90128ec3c76SAndreas Gohr /** 90228ec3c76SAndreas Gohr * Locks or unlocks a given batch of pages 90328ec3c76SAndreas Gohr * 90428ec3c76SAndreas Gohr * Give an associative array with two keys: lock and unlock. Both should contain a 90528ec3c76SAndreas Gohr * list of pages to lock or unlock 90628ec3c76SAndreas Gohr * 90728ec3c76SAndreas Gohr * Returns an associative array with the keys locked, lockfail, unlocked and 90828ec3c76SAndreas Gohr * unlockfail, each containing lists of pages. 90928ec3c76SAndreas Gohr */ 91028ec3c76SAndreas Gohr function setLocks($set){ 91128ec3c76SAndreas Gohr $locked = array(); 91228ec3c76SAndreas Gohr $lockfail = array(); 91328ec3c76SAndreas Gohr $unlocked = array(); 91428ec3c76SAndreas Gohr $unlockfail = array(); 91528ec3c76SAndreas Gohr 91628ec3c76SAndreas Gohr foreach((array) $set['lock'] as $id){ 91728ec3c76SAndreas Gohr if(checklock($id)){ 91828ec3c76SAndreas Gohr $lockfail[] = $id; 91928ec3c76SAndreas Gohr }else{ 92028ec3c76SAndreas Gohr lock($id); 92128ec3c76SAndreas Gohr $locked[] = $id; 92228ec3c76SAndreas Gohr } 92328ec3c76SAndreas Gohr } 92428ec3c76SAndreas Gohr 92528ec3c76SAndreas Gohr foreach((array) $set['unlock'] as $id){ 92628ec3c76SAndreas Gohr if(unlock($id)){ 92728ec3c76SAndreas Gohr $unlocked[] = $id; 92828ec3c76SAndreas Gohr }else{ 92928ec3c76SAndreas Gohr $unlockfail[] = $id; 93028ec3c76SAndreas Gohr } 93128ec3c76SAndreas Gohr } 93228ec3c76SAndreas Gohr 93328ec3c76SAndreas Gohr return array( 93428ec3c76SAndreas Gohr 'locked' => $locked, 93528ec3c76SAndreas Gohr 'lockfail' => $lockfail, 93628ec3c76SAndreas Gohr 'unlocked' => $unlocked, 93728ec3c76SAndreas Gohr 'unlockfail' => $unlockfail, 93828ec3c76SAndreas Gohr ); 93928ec3c76SAndreas Gohr } 94028ec3c76SAndreas Gohr 941445e8084SAndreas Gohr function getAPIVersion(){ 942445e8084SAndreas Gohr return DOKU_XMLRPC_API_VERSION; 943445e8084SAndreas Gohr } 944445e8084SAndreas Gohr 945445e8084SAndreas Gohr function login($user,$pass){ 946445e8084SAndreas Gohr global $conf; 947445e8084SAndreas Gohr global $auth; 948445e8084SAndreas Gohr if(!$conf['useacl']) return 0; 949445e8084SAndreas Gohr if(!$auth) return 0; 950445e8084SAndreas Gohr if($auth->canDo('external')){ 951445e8084SAndreas Gohr return $auth->trustExternal($user,$pass,false); 952445e8084SAndreas Gohr }else{ 953445e8084SAndreas Gohr return auth_login($user,$pass,false,true); 954445e8084SAndreas Gohr } 955445e8084SAndreas Gohr } 9563ee5b583SAndreas Gohr 9573ee5b583SAndreas Gohr 958797c0d11SAndreas Gohr} 959797c0d11SAndreas Gohr 960797c0d11SAndreas Gohr$server = new dokuwiki_xmlrpc_server(); 961797c0d11SAndreas Gohr 9622aca132fSMichael Klier// vim:ts=4:sw=4:et:enc=utf-8: 963