xref: /dokuwiki/inc/actions.php (revision fe17917e7668864526ec0f0ae65dd0787831d8a4) 
1<?php
2/**
3 * DokuWiki Actions
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     Andreas Gohr <andi@splitbrain.org>
7 */
8
9if(!defined('DOKU_INC')) die('meh.');
10require_once(DOKU_INC.'inc/template.php');
11
12
13/**
14 * Call the needed action handlers
15 *
16 * @author Andreas Gohr <andi@splitbrain.org>
17 * @triggers ACTION_ACT_PREPROCESS
18 * @triggers ACTION_HEADERS_SEND
19 */
20function act_dispatch(){
21    global $INFO;
22    global $ACT;
23    global $ID;
24    global $QUERY;
25    global $lang;
26    global $conf;
27    global $license;
28
29    $preact = $ACT;
30
31    // give plugins an opportunity to process the action
32    $evt = new Doku_Event('ACTION_ACT_PREPROCESS',$ACT);
33    if ($evt->advise_before()) {
34
35        //sanitize $ACT
36        $ACT = act_clean($ACT);
37
38        //check if searchword was given - else just show
39        $s = cleanID($QUERY);
40        if($ACT == 'search' && empty($s)){
41            $ACT = 'show';
42        }
43
44        //login stuff
45        if(in_array($ACT,array('login','logout'))){
46            $ACT = act_auth($ACT);
47        }
48
49        //check if user is asking to (un)subscribe a page
50        if($ACT == 'subscribe') {
51            try {
52                $ACT = act_subscription($ACT);
53            } catch (Exception $e) {
54                msg($e->getMessage(), -1);
55            }
56        }
57
58        //check permissions
59        $ACT = act_permcheck($ACT);
60
61        //register
62        $nil = array();
63        if($ACT == 'register' && $_POST['save'] && register()){
64            $ACT = 'login';
65        }
66
67        if ($ACT == 'resendpwd' && act_resendpwd()) {
68            $ACT = 'login';
69        }
70
71        //update user profile
72        if ($ACT == 'profile') {
73            if(!$_SERVER['REMOTE_USER']) {
74                $ACT = 'login';
75            } else {
76                if(updateprofile()) {
77                    msg($lang['profchanged'],1);
78                    $ACT = 'show';
79                }
80            }
81        }
82
83        //revert
84        if($ACT == 'revert'){
85            if(checkSecurityToken()){
86                $ACT = act_revert($ACT);
87            }else{
88                $ACT = 'show';
89            }
90        }
91
92        //save
93        if($ACT == 'save'){
94            if(checkSecurityToken()){
95                $ACT = act_save($ACT);
96            }else{
97                $ACT = 'show';
98            }
99        }
100
101        //cancel conflicting edit
102        if($ACT == 'cancel')
103            $ACT = 'show';
104
105        //draft deletion
106        if($ACT == 'draftdel')
107            $ACT = act_draftdel($ACT);
108
109        //draft saving on preview
110        if($ACT == 'preview')
111            $ACT = act_draftsave($ACT);
112
113        //edit
114        if(($ACT == 'edit' || $ACT == 'preview' || $ACT == 'recover') && $INFO['editable']){
115            $ACT = act_edit($ACT);
116        }else{
117            unlock($ID); //try to unlock
118        }
119
120        //handle export
121        if(substr($ACT,0,7) == 'export_')
122            $ACT = act_export($ACT);
123
124        //display some infos
125        if($ACT == 'check'){
126            check();
127            $ACT = 'show';
128        }
129
130        //handle admin tasks
131        if($ACT == 'admin'){
132            // retrieve admin plugin name from $_REQUEST['page']
133            if (!empty($_REQUEST['page'])) {
134                $pluginlist = plugin_list('admin');
135                if (in_array($_REQUEST['page'], $pluginlist)) {
136                    // attempt to load the plugin
137                    if ($plugin =& plugin_load('admin',$_REQUEST['page']) !== null)
138                        $plugin->handle();
139                }
140            }
141        }
142
143        // check permissions again - the action may have changed
144        $ACT = act_permcheck($ACT);
145    }  // end event ACTION_ACT_PREPROCESS default action
146    $evt->advise_after();
147    unset($evt);
148
149    // when action 'show', the intial not 'show' and POST, do a redirect
150    if($ACT == 'show' && $preact != 'show' && strtolower($_SERVER['REQUEST_METHOD']) == 'post'){
151        act_redirect($ID,$preact);
152    }
153
154    //call template FIXME: all needed vars available?
155    $headers[] = 'Content-Type: text/html; charset=utf-8';
156    trigger_event('ACTION_HEADERS_SEND',$headers,'act_sendheaders');
157
158    include(template('main.php'));
159    // output for the commands is now handled in inc/templates.php
160    // in function tpl_content()
161}
162
163function act_sendheaders($headers) {
164    foreach ($headers as $hdr) header($hdr);
165}
166
167/**
168 * Sanitize the action command
169 *
170 * Add all allowed commands here.
171 *
172 * @author Andreas Gohr <andi@splitbrain.org>
173 */
174function act_clean($act){
175    global $lang;
176    global $conf;
177
178    // check if the action was given as array key
179    if(is_array($act)){
180        list($act) = array_keys($act);
181    }
182
183    //remove all bad chars
184    $act = strtolower($act);
185    $act = preg_replace('/[^1-9a-z_]+/','',$act);
186
187    if($act == 'export_html') $act = 'export_xhtml';
188    if($act == 'export_htmlbody') $act = 'export_xhtmlbody';
189
190    // check if action is disabled
191    if(!actionOK($act)){
192        msg('Command disabled: '.htmlspecialchars($act),-1);
193        return 'show';
194    }
195
196    //disable all acl related commands if ACL is disabled
197    if(!$conf['useacl'] && in_array($act,array('login','logout','register','admin',
198                    'subscribe','unsubscribe','profile','revert',
199                    'resendpwd','subscribens','unsubscribens',))){
200        msg('Command unavailable: '.htmlspecialchars($act),-1);
201        return 'show';
202    }
203
204    if(!in_array($act,array('login','logout','register','save','cancel','edit','draft',
205                    'preview','search','show','check','index','revisions',
206                    'diff','recent','backlink','admin','subscribe','revert',
207                    'unsubscribe','profile','resendpwd','recover',
208                    'draftdel','subscribens','unsubscribens',)) && substr($act,0,7) != 'export_' ) {
209        msg('Command unknown: '.htmlspecialchars($act),-1);
210        return 'show';
211    }
212    return $act;
213}
214
215/**
216 * Run permissionchecks
217 *
218 * @author Andreas Gohr <andi@splitbrain.org>
219 */
220function act_permcheck($act){
221    global $INFO;
222    global $conf;
223
224    if(in_array($act,array('save','preview','edit','recover'))){
225        if($INFO['exists']){
226            if($act == 'edit'){
227                //the edit function will check again and do a source show
228                //when no AUTH_EDIT available
229                $permneed = AUTH_READ;
230            }else{
231                $permneed = AUTH_EDIT;
232            }
233        }else{
234            $permneed = AUTH_CREATE;
235        }
236    }elseif(in_array($act,array('login','search','recent','profile'))){
237        $permneed = AUTH_NONE;
238    }elseif($act == 'revert'){
239        $permneed = AUTH_ADMIN;
240        if($INFO['ismanager']) $permneed = AUTH_EDIT;
241    }elseif($act == 'register'){
242        $permneed = AUTH_NONE;
243    }elseif($act == 'resendpwd'){
244        $permneed = AUTH_NONE;
245    }elseif($act == 'admin'){
246        if($INFO['ismanager']){
247            // if the manager has the needed permissions for a certain admin
248            // action is checked later
249            $permneed = AUTH_READ;
250        }else{
251            $permneed = AUTH_ADMIN;
252        }
253    }else{
254        $permneed = AUTH_READ;
255    }
256    if($INFO['perm'] >= $permneed) return $act;
257
258    return 'denied';
259}
260
261/**
262 * Handle 'draftdel'
263 *
264 * Deletes the draft for the current page and user
265 */
266function act_draftdel($act){
267    global $INFO;
268    @unlink($INFO['draft']);
269    $INFO['draft'] = null;
270    return 'show';
271}
272
273/**
274 * Saves a draft on preview
275 *
276 * @todo this currently duplicates code from ajax.php :-/
277 */
278function act_draftsave($act){
279    global $INFO;
280    global $ID;
281    global $conf;
282    if($conf['usedraft'] && $_POST['wikitext']){
283        $draft = array('id'     => $ID,
284                'prefix' => $_POST['prefix'],
285                'text'   => $_POST['wikitext'],
286                'suffix' => $_POST['suffix'],
287                'date'   => $_POST['date'],
288                'client' => $INFO['client'],
289                );
290        $cname = getCacheName($draft['client'].$ID,'.draft');
291        if(io_saveFile($cname,serialize($draft))){
292            $INFO['draft'] = $cname;
293        }
294    }
295    return $act;
296}
297
298/**
299 * Handle 'save'
300 *
301 * Checks for spam and conflicts and saves the page.
302 * Does a redirect to show the page afterwards or
303 * returns a new action.
304 *
305 * @author Andreas Gohr <andi@splitbrain.org>
306 */
307function act_save($act){
308    global $ID;
309    global $DATE;
310    global $PRE;
311    global $TEXT;
312    global $SUF;
313    global $SUM;
314    global $lang;
315    global $INFO;
316
317    //spam check
318    if(checkwordblock()) {
319        msg($lang['wordblock'], -1);
320        return 'edit';
321    }
322    //conflict check
323    if($DATE != 0 && $INFO['meta']['date']['modified'] > $DATE )
324        return 'conflict';
325
326    //save it
327    saveWikiText($ID,con($PRE,$TEXT,$SUF,1),$SUM,$_REQUEST['minor']); //use pretty mode for con
328    //unlock it
329    unlock($ID);
330
331    //delete draft
332    act_draftdel($act);
333    session_write_close();
334
335    // when done, show page
336    return 'show';
337}
338
339/**
340 * Revert to a certain revision
341 *
342 * @author Andreas Gohr <andi@splitbrain.org>
343 */
344function act_revert($act){
345    global $ID;
346    global $REV;
347    global $lang;
348
349    // when no revision is given, delete current one
350    // FIXME this feature is not exposed in the GUI currently
351    $text = '';
352    $sum  = $lang['deleted'];
353    if($REV){
354        $text = rawWiki($ID,$REV);
355        if(!$text) return 'show'; //something went wrong
356        $sum  = $lang['restored'];
357    }
358
359    // spam check
360
361    if (checkwordblock($text)) {
362        msg($lang['wordblock'], -1);
363        return 'edit';
364    }
365
366    saveWikiText($ID,$text,$sum,false);
367    msg($sum,1);
368
369    //delete any draft
370    act_draftdel($act);
371    session_write_close();
372
373    // when done, show current page
374    $_SERVER['REQUEST_METHOD'] = 'post'; //should force a redirect
375    $REV = '';
376    return 'show';
377}
378
379/**
380 * Do a redirect after receiving post data
381 *
382 * Tries to add the section id as hash mark after section editing
383 */
384function act_redirect($id,$preact){
385    global $PRE;
386    global $TEXT;
387    global $MSG;
388
389    //are there any undisplayed messages? keep them in session for display
390    //on the next page
391    if(isset($MSG) && count($MSG)){
392        //reopen session, store data and close session again
393        @session_start();
394        $_SESSION[DOKU_COOKIE]['msg'] = $MSG;
395        session_write_close();
396    }
397
398    $opts = array(
399            'id'       => $id,
400            'preact'   => $preact
401            );
402    //get section name when coming from section edit
403    if($PRE && preg_match('/^\s*==+([^=\n]+)/',$TEXT,$match)){
404        $check = false; //Byref
405        $opts['fragment'] = sectionID($match[0], $check);
406    }
407
408    trigger_event('ACTION_SHOW_REDIRECT',$opts,'act_redirect_execute');
409}
410
411function act_redirect_execute($opts){
412    $go = wl($opts['id'],'',true);
413    if(isset($opts['fragment'])) $go .= '#'.$opts['fragment'];
414
415    //show it
416    send_redirect($go);
417}
418
419/**
420 * Handle 'login', 'logout'
421 *
422 * @author Andreas Gohr <andi@splitbrain.org>
423 */
424function act_auth($act){
425    global $ID;
426    global $INFO;
427
428    //already logged in?
429    if(isset($_SERVER['REMOTE_USER']) && $act=='login'){
430        return 'show';
431    }
432
433    //handle logout
434    if($act=='logout'){
435        $lockedby = checklock($ID); //page still locked?
436        if($lockedby == $_SERVER['REMOTE_USER'])
437            unlock($ID); //try to unlock
438
439        // do the logout stuff
440        auth_logoff();
441
442        // rebuild info array
443        $INFO = pageinfo();
444
445        act_redirect($ID,'login');
446    }
447
448    return $act;
449}
450
451/**
452 * Handle 'edit', 'preview', 'recover'
453 *
454 * @author Andreas Gohr <andi@splitbrain.org>
455 */
456function act_edit($act){
457    global $ID;
458    global $INFO;
459
460    global $TEXT;
461    global $RANGE;
462    global $PRE;
463    global $SUF;
464    global $REV;
465    global $SUM;
466    global $lang;
467    global $DATE;
468
469    if (!isset($TEXT)) {
470        if ($INFO['exists']) {
471            if ($RANGE) {
472                list($PRE,$TEXT,$SUF) = rawWikiSlices($RANGE,$ID,$REV);
473            } else {
474                $TEXT = rawWiki($ID,$REV);
475            }
476        } else {
477            $TEXT = pageTemplate($ID);
478        }
479    }
480
481    //set summary default
482    if(!$SUM){
483        if($REV){
484            $SUM = $lang['restored'];
485        }elseif(!$INFO['exists']){
486            $SUM = $lang['created'];
487        }
488    }
489
490    // Use the date of the newest revision, not of the revision we edit
491    // This is used for conflict detection
492    if(!$DATE) $DATE = $INFO['meta']['date']['modified'];
493
494    //check if locked by anyone - if not lock for my self
495    $lockedby = checklock($ID);
496    if($lockedby) return 'locked';
497
498    lock($ID);
499    return $act;
500}
501
502/**
503 * Export a wiki page for various formats
504 *
505 * Triggers ACTION_EXPORT_POSTPROCESS
506 *
507 *  Event data:
508 *    data['id']      -- page id
509 *    data['mode']    -- requested export mode
510 *    data['headers'] -- export headers
511 *    data['output']  -- export output
512 *
513 * @author Andreas Gohr <andi@splitbrain.org>
514 * @author Michael Klier <chi@chimeric.de>
515 */
516function act_export($act){
517    global $ID;
518    global $REV;
519    global $conf;
520    global $lang;
521
522    $pre = '';
523    $post = '';
524    $output = '';
525    $headers = array();
526
527    // search engines: never cache exported docs! (Google only currently)
528    $headers['X-Robots-Tag'] = 'noindex';
529
530    $mode = substr($act,7);
531    switch($mode) {
532        case 'raw':
533            $headers['Content-Type'] = 'text/plain; charset=utf-8';
534            $headers['Content-Disposition'] = 'attachment; filename='.noNS($ID).'.txt';
535            $output = rawWiki($ID,$REV);
536            break;
537        case 'xhtml':
538            $pre .= '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"' . DOKU_LF;
539            $pre .= ' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">' . DOKU_LF;
540            $pre .= '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="'.$conf['lang'].'"' . DOKU_LF;
541            $pre .= ' lang="'.$conf['lang'].'" dir="'.$lang['direction'].'">' . DOKU_LF;
542            $pre .= '<head>' . DOKU_LF;
543            $pre .= '  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />' . DOKU_LF;
544            $pre .= '  <title>'.$ID.'</title>' . DOKU_LF;
545
546            // get metaheaders
547            ob_start();
548            tpl_metaheaders();
549            $pre .= ob_get_clean();
550
551            $pre .= '</head>' . DOKU_LF;
552            $pre .= '<body>' . DOKU_LF;
553            $pre .= '<div class="dokuwiki export">' . DOKU_LF;
554
555            // get toc
556            $pre .= tpl_toc(true);
557
558            $headers['Content-Type'] = 'text/html; charset=utf-8';
559            $output = p_wiki_xhtml($ID,$REV,false);
560
561            $post .= '</div>' . DOKU_LF;
562            $post .= '</body>' . DOKU_LF;
563            $post .= '</html>' . DOKU_LF;
564            break;
565        case 'xhtmlbody':
566            $headers['Content-Type'] = 'text/html; charset=utf-8';
567            $output = p_wiki_xhtml($ID,$REV,false);
568            break;
569        default:
570            $output = p_cached_output(wikiFN($ID,$REV), $mode);
571            $headers = p_get_metadata($ID,"format $mode");
572            break;
573    }
574
575    // prepare event data
576    $data = array();
577    $data['id'] = $ID;
578    $data['mode'] = $mode;
579    $data['headers'] = $headers;
580    $data['output'] =& $output;
581
582    trigger_event('ACTION_EXPORT_POSTPROCESS', $data);
583
584    if(!empty($data['output'])){
585        if(is_array($data['headers'])) foreach($data['headers'] as $key => $val){
586            header("$key: $val");
587        }
588        print $pre.$data['output'].$post;
589        exit;
590    }
591    return 'show';
592}
593
594/**
595 * Handle page 'subscribe'
596 *
597 * Throws exception on error.
598 *
599 * @author Adrian Lang <lang@cosmocode.de>
600 */
601function act_subscription($act){
602    global $lang;
603    global $INFO;
604    global $ID;
605
606    // get and preprocess data.
607    $params = array();
608    foreach(array('target', 'style', 'action') as $param) {
609        if (isset($_REQUEST["sub_$param"])) {
610            $params[$param] = $_REQUEST["sub_$param"];
611        }
612    }
613
614    // any action given? if not just return and show the subscription page
615    if(!$params['action'] || !checkSecurityToken()) return $act;
616
617    // Handle POST data, may throw exception.
618    trigger_event('ACTION_HANDLE_SUBSCRIBE', $params, 'subscription_handle_post');
619
620    $target = $params['target'];
621    $style  = $params['style'];
622    $data   = $params['data'];
623    $action = $params['action'];
624
625    // Perform action.
626    require_once DOKU_INC . 'inc/subscription.php';
627    if (!subscription_set($_SERVER['REMOTE_USER'], $target, $style, $data)) {
628        throw new Exception(sprintf($lang["subscr_{$action}_error"],
629                                    hsc($INFO['userinfo']['name']),
630                                    prettyprint_id($target)));
631    }
632    msg(sprintf($lang["subscr_{$action}_success"], hsc($INFO['userinfo']['name']),
633                prettyprint_id($target)), 1);
634    act_redirect($ID, $act);
635
636    // Assure that we have valid data if act_redirect somehow fails.
637    $INFO['subscribed'] = get_info_subscribed();
638    return 'show';
639}
640
641/**
642 * Validate POST data
643 *
644 * Validates POST data for a subscribe or unsubscribe request. This is the
645 * default action for the event ACTION_HANDLE_SUBSCRIBE.
646 *
647 * @author Adrian Lang <lang@cosmocode.de>
648 */
649function subscription_handle_post(&$params) {
650    global $INFO;
651    global $lang;
652
653    // Get and validate parameters.
654    if (!isset($params['target'])) {
655        throw new Exception('no subscription target given');
656    }
657    $target = $params['target'];
658    $valid_styles = array('every', 'digest');
659    if (substr($target, -1, 1) === ':') {
660        // Allow “list” subscribe style since the target is a namespace.
661        $valid_styles[] = 'list';
662    }
663    $style  = valid_input_set('style', $valid_styles, $params,
664                              'invalid subscription style given');
665    $action = valid_input_set('action', array('subscribe', 'unsubscribe'),
666                              $params, 'invalid subscription action given');
667
668    // Check other conditions.
669    if ($action === 'subscribe') {
670        if ($INFO['userinfo']['mail'] === '') {
671            throw new Exception($lang['subscr_subscribe_noaddress']);
672        }
673    } elseif ($action === 'unsubscribe') {
674        $is = false;
675        foreach($INFO['subscribed'] as $subscr) {
676            if ($subscr['target'] === $target) {
677                $is = true;
678            }
679        }
680        if ($is === false) {
681            throw new Exception(sprintf($lang['subscr_not_subscribed'],
682                                        $_SERVER['REMOTE_USER'],
683                                        prettyprint_id($target)));
684        }
685        // subscription_set deletes a subscription if style = null.
686        $style = null;
687    }
688
689    $data = in_array($style, array('list', 'digest')) ? time() : null;
690    $params = compact('target', 'style', 'data', 'action');
691}
692
693//Setup VIM: ex: et ts=2 enc=utf-8 :
694