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