xref: /dokuwiki/inc/html.php (revision b838050e5828b5cbf32b9e82ce11c9cc54592809) 
1<?php
2/**
3 * HTML output functions
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.');
10if(!defined('NL')) define('NL',"\n");
11
12/**
13 * Convenience function to quickly build a wikilink
14 *
15 * @author Andreas Gohr <andi@splitbrain.org>
16 */
17function html_wikilink($id,$name=null,$search=''){
18    static $xhtml_renderer = null;
19    if(is_null($xhtml_renderer)){
20        $xhtml_renderer = p_get_renderer('xhtml');
21    }
22
23    return $xhtml_renderer->internallink($id,$name,$search,true,'navigation');
24}
25
26/**
27 * Helps building long attribute lists
28 *
29 * @deprecated Use buildAttributes instead
30 * @author Andreas Gohr <andi@splitbrain.org>
31 */
32function html_attbuild($attributes){
33    $ret = '';
34    foreach ( $attributes as $key => $value ) {
35        $ret .= $key.'="'.formText($value).'" ';
36    }
37    return trim($ret);
38}
39
40/**
41 * The loginform
42 *
43 * @author   Andreas Gohr <andi@splitbrain.org>
44 */
45function html_login(){
46    global $lang;
47    global $conf;
48    global $ID;
49
50    print p_locale_xhtml('login');
51    print '<div class="centeralign">'.NL;
52    $form = new Doku_Form(array('id' => 'dw__login'));
53    $form->startFieldset($lang['btn_login']);
54    $form->addHidden('id', $ID);
55    $form->addHidden('do', 'login');
56    $form->addElement(form_makeTextField('u', ((!$_REQUEST['http_credentials']) ? $_REQUEST['u'] : ''), $lang['user'], 'focus__this', 'block'));
57    $form->addElement(form_makePasswordField('p', $lang['pass'], '', 'block'));
58    if($conf['rememberme']) {
59        $form->addElement(form_makeCheckboxField('r', '1', $lang['remember'], 'remember__me', 'simple'));
60    }
61    $form->addElement(form_makeButton('submit', '', $lang['btn_login']));
62    $form->endFieldset();
63
64    if(actionOK('register')){
65        $form->addElement('<p>'.$lang['reghere'].': '.tpl_actionlink('register','','','',true).'</p>');
66    }
67
68    if (actionOK('resendpwd')) {
69        $form->addElement('<p>'.$lang['pwdforget'].': '.tpl_actionlink('resendpwd','','','',true).'</p>');
70    }
71
72    html_form('login', $form);
73    print '</div>'.NL;
74}
75
76/**
77 * inserts section edit buttons if wanted or removes the markers
78 *
79 * @author Andreas Gohr <andi@splitbrain.org>
80 */
81function html_secedit($text,$show=true){
82    global $INFO;
83
84    $regexp = '#<!-- EDIT(\d+) ([A-Z_]+) (?:"([^"]*)" )?\[(\d+-\d*)\] -->#';
85
86    if(!$INFO['writable'] || !$show || $INFO['rev']){
87        return preg_replace($regexp,'',$text);
88    }
89
90    return preg_replace_callback($regexp,
91                'html_secedit_button', $text);
92}
93
94/**
95 * prepares section edit button data for event triggering
96 * used as a callback in html_secedit
97 *
98 * @triggers HTML_SECEDIT_BUTTON
99 * @author Andreas Gohr <andi@splitbrain.org>
100 */
101function html_secedit_button($matches){
102    $data = array('secid'  => $matches[1],
103                  'target' => strtolower($matches[2]),
104                  'range'  => $matches[count($matches) - 1]);
105    if (count($matches) === 5) {
106        $data['name'] = $matches[3];
107    }
108
109    return trigger_event('HTML_SECEDIT_BUTTON', $data,
110                         'html_secedit_get_button');
111}
112
113/**
114 * prints a section editing button
115 * used as default action form HTML_SECEDIT_BUTTON
116 *
117 * @author Adrian Lang <lang@cosmocode.de>
118 */
119function html_secedit_get_button($data) {
120    global $ID;
121    global $INFO;
122
123    if (!isset($data['name']) || $data['name'] === '') return;
124
125    $name = $data['name'];
126    unset($data['name']);
127
128    $secid = $data['secid'];
129    unset($data['secid']);
130
131    return "<div class='secedit editbutton_" . $data['target'] .
132                       " editbutton_" . $secid . "'>" .
133           html_btn('secedit', $ID, '',
134                    array_merge(array('do'  => 'edit',
135                                      'rev' => $INFO['lastmod'],
136                                      'summary' => '['.$name.'] '), $data),
137                    'post', $name) . '</div>';
138}
139
140/**
141 * Just the back to top button (in its own form)
142 *
143 * @author Andreas Gohr <andi@splitbrain.org>
144 */
145function html_topbtn(){
146    global $lang;
147
148    $ret  = '';
149    $ret  = '<a class="nolink" href="#dokuwiki__top"><input type="button" class="button" value="'.$lang['btn_top'].'" onclick="window.scrollTo(0, 0)" title="'.$lang['btn_top'].'" /></a>';
150
151    return $ret;
152}
153
154/**
155 * Displays a button (using its own form)
156 * If tooltip exists, the access key tooltip is replaced.
157 *
158 * @author Andreas Gohr <andi@splitbrain.org>
159 */
160function html_btn($name,$id,$akey,$params,$method='get',$tooltip='',$label=false){
161    global $conf;
162    global $lang;
163
164    if (!$label)
165        $label = $lang['btn_'.$name];
166
167    $ret = '';
168    $tip = '';
169
170    //filter id (without urlencoding)
171    $id = idfilter($id,false);
172
173    //make nice URLs even for buttons
174    if($conf['userewrite'] == 2){
175        $script = DOKU_BASE.DOKU_SCRIPT.'/'.$id;
176    }elseif($conf['userewrite']){
177        $script = DOKU_BASE.$id;
178    }else{
179        $script = DOKU_BASE.DOKU_SCRIPT;
180        $params['id'] = $id;
181    }
182
183    $ret .= '<form class="button btn_'.$name.'" method="'.$method.'" action="'.$script.'"><div class="no">';
184
185    if(is_array($params)){
186        reset($params);
187        while (list($key, $val) = each($params)) {
188            $ret .= '<input type="hidden" name="'.$key.'" ';
189            $ret .= 'value="'.htmlspecialchars($val).'" />';
190        }
191    }
192
193    if ($tooltip!='') {
194        $tip = htmlspecialchars($tooltip);
195    }else{
196        $tip = htmlspecialchars($label);
197    }
198
199    $ret .= '<input type="submit" value="'.hsc($label).'" class="button" ';
200    if($akey){
201        $tip .= ' ['.strtoupper($akey).']';
202        $ret .= 'accesskey="'.$akey.'" ';
203    }
204    $ret .= 'title="'.$tip.'" ';
205    $ret .= '/>';
206    $ret .= '</div></form>';
207
208    return $ret;
209}
210
211/**
212 * show a wiki page
213 *
214 * @author Andreas Gohr <andi@splitbrain.org>
215 */
216function html_show($txt=null){
217    global $ID;
218    global $REV;
219    global $HIGH;
220    global $INFO;
221    //disable section editing for old revisions or in preview
222    if($txt || $REV){
223        $secedit = false;
224    }else{
225        $secedit = true;
226    }
227
228    if (!is_null($txt)){
229        //PreviewHeader
230        echo '<br id="scroll__here" />';
231        echo p_locale_xhtml('preview');
232        echo '<div class="preview">';
233        $html = html_secedit(p_render('xhtml',p_get_instructions($txt),$info),$secedit);
234        if($INFO['prependTOC']) $html = tpl_toc(true).$html;
235        echo $html;
236        echo '<div class="clearer"></div>';
237        echo '</div>';
238
239    }else{
240        if ($REV) print p_locale_xhtml('showrev');
241        $html = p_wiki_xhtml($ID,$REV,true);
242        $html = html_secedit($html,$secedit);
243        if($INFO['prependTOC']) $html = tpl_toc(true).$html;
244        $html = html_hilight($html,$HIGH);
245        echo $html;
246    }
247}
248
249/**
250 * ask the user about how to handle an exisiting draft
251 *
252 * @author Andreas Gohr <andi@splitbrain.org>
253 */
254function html_draft(){
255    global $INFO;
256    global $ID;
257    global $lang;
258    global $conf;
259    $draft = unserialize(io_readFile($INFO['draft'],false));
260    $text  = cleanText(con($draft['prefix'],$draft['text'],$draft['suffix'],true));
261
262    print p_locale_xhtml('draft');
263    $form = new Doku_Form(array('id' => 'dw__editform'));
264    $form->addHidden('id', $ID);
265    $form->addHidden('date', $draft['date']);
266    $form->addElement(form_makeWikiText($text, array('readonly'=>'readonly')));
267    $form->addElement(form_makeOpenTag('div', array('id'=>'draft__status')));
268    $form->addElement($lang['draftdate'].' '. dformat(filemtime($INFO['draft'])));
269    $form->addElement(form_makeCloseTag('div'));
270    $form->addElement(form_makeButton('submit', 'recover', $lang['btn_recover'], array('tabindex'=>'1')));
271    $form->addElement(form_makeButton('submit', 'draftdel', $lang['btn_draftdel'], array('tabindex'=>'2')));
272    $form->addElement(form_makeButton('submit', 'show', $lang['btn_cancel'], array('tabindex'=>'3')));
273    html_form('draft', $form);
274}
275
276/**
277 * Highlights searchqueries in HTML code
278 *
279 * @author Andreas Gohr <andi@splitbrain.org>
280 * @author Harry Fuecks <hfuecks@gmail.com>
281 */
282function html_hilight($html,$phrases){
283    $phrases = array_filter((array) $phrases);
284    $regex = join('|',array_map('ft_snippet_re_preprocess', array_map('preg_quote_cb',$phrases)));
285
286    if ($regex === '') return $html;
287    if (!utf8_check($regex)) return $html;
288    $html = @preg_replace_callback("/((<[^>]*)|$regex)/ui",'html_hilight_callback',$html);
289    return $html;
290}
291
292/**
293 * Callback used by html_hilight()
294 *
295 * @author Harry Fuecks <hfuecks@gmail.com>
296 */
297function html_hilight_callback($m) {
298    $hlight = unslash($m[0]);
299    if ( !isset($m[2])) {
300        $hlight = '<span class="search_hit">'.$hlight.'</span>';
301    }
302    return $hlight;
303}
304
305/**
306 * Run a search and display the result
307 *
308 * @author Andreas Gohr <andi@splitbrain.org>
309 */
310function html_search(){
311    global $conf;
312    global $QUERY;
313    global $ID;
314    global $lang;
315
316    $intro = p_locale_xhtml('searchpage');
317    // allow use of placeholder in search intro
318    $intro = str_replace(
319                array('@QUERY@','@SEARCH@'),
320                array(hsc(rawurlencode($QUERY)),hsc($QUERY)),
321                $intro);
322    echo $intro;
323    flush();
324
325    //show progressbar
326    print '<div class="centeralign" id="dw__loading">'.NL;
327    print '<script type="text/javascript" charset="utf-8"><!--//--><![CDATA[//><!--'.NL;
328    print 'showLoadBar();'.NL;
329    print '//--><!]]></script>'.NL;
330    print '<br /></div>'.NL;
331    flush();
332
333    //do quick pagesearch
334    $data = array();
335
336    $data = ft_pageLookup($QUERY,true,useHeading('navigation'));
337    if(count($data)){
338        print '<div class="search_quickresult">';
339        print '<h3>'.$lang['quickhits'].':</h3>';
340        print '<ul class="search_quickhits">';
341        foreach($data as $id => $title){
342            print '<li> ';
343            if (useHeading('navigation')) {
344                $name = $title;
345            }else{
346                $ns = getNS($id);
347                if($ns){
348                    $name = shorten(noNS($id), ' ('.$ns.')',30);
349                }else{
350                    $name = $id;
351                }
352            }
353            print html_wikilink(':'.$id,$name);
354            print '</li> ';
355        }
356        print '</ul> ';
357        //clear float (see http://www.complexspiral.com/publications/containing-floats/)
358        print '<div class="clearer"></div>';
359        print '</div>';
360    }
361    flush();
362
363    //do fulltext search
364    $data = ft_pageSearch($QUERY,$regex);
365    if(count($data)){
366        $num = 1;
367        foreach($data as $id => $cnt){
368            print '<div class="search_result">';
369            print html_wikilink(':'.$id,useHeading('navigation')?null:$id,$regex);
370            if($cnt !== 0){
371                print ': <span class="search_cnt">'.$cnt.' '.$lang['hits'].'</span><br />';
372                if($num < FT_SNIPPET_NUMBER){ // create snippets for the first number of matches only
373                    print '<div class="search_snippet">'.ft_snippet($id,$regex).'</div>';
374                }
375                $num++;
376            }
377            print '</div>';
378            flush();
379        }
380    }else{
381        print '<div class="nothing">'.$lang['nothingfound'].'</div>';
382    }
383
384    //hide progressbar
385    print '<script type="text/javascript" charset="utf-8"><!--//--><![CDATA[//><!--'.NL;
386    print 'hideLoadBar("dw__loading");'.NL;
387    print '//--><!]]></script>'.NL;
388    flush();
389}
390
391/**
392 * Display error on locked pages
393 *
394 * @author Andreas Gohr <andi@splitbrain.org>
395 */
396function html_locked(){
397    global $ID;
398    global $conf;
399    global $lang;
400    global $INFO;
401
402    $locktime = filemtime(wikiLockFN($ID));
403    $expire = dformat($locktime + $conf['locktime']);
404    $min    = round(($conf['locktime'] - (time() - $locktime) )/60);
405
406    print p_locale_xhtml('locked');
407    print '<ul>';
408    print '<li><div class="li"><strong>'.$lang['lockedby'].':</strong> '.editorinfo($INFO['locked']).'</div></li>';
409    print '<li><div class="li"><strong>'.$lang['lockexpire'].':</strong> '.$expire.' ('.$min.' min)</div></li>';
410    print '</ul>';
411}
412
413/**
414 * list old revisions
415 *
416 * @author Andreas Gohr <andi@splitbrain.org>
417 * @author Ben Coburn <btcoburn@silicodon.net>
418 */
419function html_revisions($first=0){
420    global $ID;
421    global $INFO;
422    global $conf;
423    global $lang;
424    /* we need to get one additionally log entry to be able to
425     * decide if this is the last page or is there another one.
426     * see html_recent()
427     */
428    $revisions = getRevisions($ID, $first, $conf['recent']+1);
429    if(count($revisions)==0 && $first!=0){
430        $first=0;
431        $revisions = getRevisions($ID, $first, $conf['recent']+1);;
432    }
433    $hasNext = false;
434    if (count($revisions)>$conf['recent']) {
435        $hasNext = true;
436        array_pop($revisions); // remove extra log entry
437    }
438
439    $date = dformat($INFO['lastmod']);
440
441    print p_locale_xhtml('revisions');
442
443    $form = new Doku_Form(array('id' => 'page__revisions'));
444    $form->addElement(form_makeOpenTag('ul'));
445    if($INFO['exists'] && $first==0){
446        if (isset($INFO['meta']) && isset($INFO['meta']['last_change']) && $INFO['meta']['last_change']['type']===DOKU_CHANGE_TYPE_MINOR_EDIT)
447            $form->addElement(form_makeOpenTag('li', array('class' => 'minor')));
448        else
449            $form->addElement(form_makeOpenTag('li'));
450        $form->addElement(form_makeOpenTag('div', array('class' => 'li')));
451        $form->addElement(form_makeTag('input', array(
452                        'type' => 'checkbox',
453                        'name' => 'rev2[]',
454                        'value' => 'current')));
455
456        $form->addElement(form_makeOpenTag('span', array('class' => 'date')));
457        $form->addElement($date);
458        $form->addElement(form_makeCloseTag('span'));
459
460        $form->addElement('<img src="'.DOKU_BASE.'lib/images/blank.gif" width="15" height="11" alt="" />');
461
462        $form->addElement(form_makeOpenTag('a', array(
463                        'class' => 'wikilink1',
464                        'href'  => wl($ID))));
465        $form->addElement($ID);
466        $form->addElement(form_makeCloseTag('a'));
467
468        $form->addElement(form_makeOpenTag('span', array('class' => 'sum')));
469        $form->addElement(' &ndash; ');
470        $form->addElement(htmlspecialchars($INFO['sum']));
471        $form->addElement(form_makeCloseTag('span'));
472
473        $form->addElement(form_makeOpenTag('span', array('class' => 'user')));
474        $form->addElement((empty($INFO['editor']))?('('.$lang['external_edit'].')'):editorinfo($INFO['editor']));
475        $form->addElement(form_makeCloseTag('span'));
476
477        $form->addElement('('.$lang['current'].')');
478        $form->addElement(form_makeCloseTag('div'));
479        $form->addElement(form_makeCloseTag('li'));
480    }
481
482    foreach($revisions as $rev){
483        $date   = dformat($rev);
484        $info   = getRevisionInfo($ID,$rev,true);
485        $exists = page_exists($ID,$rev);
486
487        if ($info['type']===DOKU_CHANGE_TYPE_MINOR_EDIT)
488            $form->addElement(form_makeOpenTag('li', array('class' => 'minor')));
489        else
490            $form->addElement(form_makeOpenTag('li'));
491        $form->addElement(form_makeOpenTag('div', array('class' => 'li')));
492        if($exists){
493            $form->addElement(form_makeTag('input', array(
494                            'type' => 'checkbox',
495                            'name' => 'rev2[]',
496                            'value' => $rev)));
497        }else{
498            $form->addElement('<img src="'.DOKU_BASE.'lib/images/blank.gif" width="15" height="11" alt="" />');
499        }
500
501        $form->addElement(form_makeOpenTag('span', array('class' => 'date')));
502        $form->addElement($date);
503        $form->addElement(form_makeCloseTag('span'));
504
505        if($exists){
506            $form->addElement(form_makeOpenTag('a', array('href' => wl($ID,"rev=$rev,do=diff", false, '&'), 'class' => 'diff_link')));
507            $form->addElement(form_makeTag('img', array(
508                            'src'    => DOKU_BASE.'lib/images/diff.png',
509                            'width'  => 15,
510                            'height' => 11,
511                            'title'  => $lang['diff'],
512                            'alt'    => $lang['diff'])));
513            $form->addElement(form_makeCloseTag('a'));
514
515            $form->addElement(form_makeOpenTag('a', array('href' => wl($ID,"rev=$rev",false,'&'), 'class' => 'wikilink1')));
516            $form->addElement($ID);
517            $form->addElement(form_makeCloseTag('a'));
518        }else{
519            $form->addElement('<img src="'.DOKU_BASE.'lib/images/blank.gif" width="15" height="11" alt="" />');
520            $form->addElement($ID);
521        }
522
523        $form->addElement(form_makeOpenTag('span', array('class' => 'sum')));
524        $form->addElement(' &ndash; ');
525        $form->addElement(htmlspecialchars($info['sum']));
526        $form->addElement(form_makeCloseTag('span'));
527
528        $form->addElement(form_makeOpenTag('span', array('class' => 'user')));
529        if($info['user']){
530            $form->addElement(editorinfo($info['user']));
531            if(auth_ismanager()){
532                $form->addElement(' ('.$info['ip'].')');
533            }
534        }else{
535            $form->addElement($info['ip']);
536        }
537        $form->addElement(form_makeCloseTag('span'));
538
539        $form->addElement(form_makeCloseTag('div'));
540        $form->addElement(form_makeCloseTag('li'));
541    }
542    $form->addElement(form_makeCloseTag('ul'));
543    $form->addElement(form_makeButton('submit', 'diff', $lang['diff2']));
544    html_form('revisions', $form);
545
546    print '<div class="pagenav">';
547    $last = $first + $conf['recent'];
548    if ($first > 0) {
549        $first -= $conf['recent'];
550        if ($first < 0) $first = 0;
551        print '<div class="pagenav-prev">';
552        print html_btn('newer',$ID,"p",array('do' => 'revisions', 'first' => $first));
553        print '</div>';
554    }
555    if ($hasNext) {
556        print '<div class="pagenav-next">';
557        print html_btn('older',$ID,"n",array('do' => 'revisions', 'first' => $last));
558        print '</div>';
559    }
560    print '</div>';
561
562}
563
564/**
565 * display recent changes
566 *
567 * @author Andreas Gohr <andi@splitbrain.org>
568 * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
569 * @author Ben Coburn <btcoburn@silicodon.net>
570 */
571function html_recent($first=0){
572    global $conf;
573    global $lang;
574    global $ID;
575    /* we need to get one additionally log entry to be able to
576     * decide if this is the last page or is there another one.
577     * This is the cheapest solution to get this information.
578     */
579    $recents = getRecents($first,$conf['recent'] + 1,getNS($ID));
580    if(count($recents) == 0 && $first != 0){
581        $first=0;
582        $recents = getRecents($first,$conf['recent'] + 1,getNS($ID));
583    }
584    $hasNext = false;
585    if (count($recents)>$conf['recent']) {
586        $hasNext = true;
587        array_pop($recents); // remove extra log entry
588    }
589
590    print p_locale_xhtml('recent');
591
592    if (getNS($ID) != '')
593        print '<div class="level1"><p>' . sprintf($lang['recent_global'], getNS($ID), wl('', 'do=recent')) . '</p></div>';
594
595    $form = new Doku_Form(array('id' => 'dw__recent', 'method' => 'GET'));
596    $form->addHidden('sectok', null);
597    $form->addHidden('do', 'recent');
598    $form->addHidden('id', $ID);
599    $form->addElement(form_makeOpenTag('ul'));
600
601    foreach($recents as $recent){
602        $date = dformat($recent['date']);
603        if ($recent['type']===DOKU_CHANGE_TYPE_MINOR_EDIT)
604            $form->addElement(form_makeOpenTag('li', array('class' => 'minor')));
605        else
606            $form->addElement(form_makeOpenTag('li'));
607
608        $form->addElement(form_makeOpenTag('div', array('class' => 'li')));
609
610        $form->addElement(form_makeOpenTag('span', array('class' => 'date')));
611        $form->addElement($date);
612        $form->addElement(form_makeCloseTag('span'));
613
614        $form->addElement(form_makeOpenTag('a', array('class' => 'diff_link', 'href' => wl($recent['id'],"do=diff", false, '&'))));
615        $form->addElement(form_makeTag('img', array(
616                        'src'   => DOKU_BASE.'lib/images/diff.png',
617                        'width' => 15,
618                        'height'=> 11,
619                        'title' => $lang['diff'],
620                        'alt'   => $lang['diff']
621                        )));
622        $form->addElement(form_makeCloseTag('a'));
623
624        $form->addElement(form_makeOpenTag('a', array('class' => 'revisions_link', 'href' => wl($recent['id'],"do=revisions",false,'&'))));
625        $form->addElement(form_makeTag('img', array(
626                        'src'   => DOKU_BASE.'lib/images/history.png',
627                        'width' => 12,
628                        'height'=> 14,
629                        'title' => $lang['btn_revs'],
630                        'alt'   => $lang['btn_revs']
631                        )));
632        $form->addElement(form_makeCloseTag('a'));
633
634        $form->addElement(html_wikilink(':'.$recent['id'],useHeading('navigation')?null:$recent['id']));
635
636        $form->addElement(form_makeOpenTag('span', array('class' => 'sum')));
637        $form->addElement(' &ndash; '.htmlspecialchars($recent['sum']));
638        $form->addElement(form_makeCloseTag('span'));
639
640        $form->addElement(form_makeOpenTag('span', array('class' => 'user')));
641        if($recent['user']){
642            $form->addElement(editorinfo($recent['user']));
643            if(auth_ismanager()){
644                $form->addElement(' ('.$recent['ip'].')');
645            }
646        }else{
647            $form->addElement($recent['ip']);
648        }
649        $form->addElement(form_makeCloseTag('span'));
650
651        $form->addElement(form_makeCloseTag('div'));
652        $form->addElement(form_makeCloseTag('li'));
653    }
654    $form->addElement(form_makeCloseTag('ul'));
655
656    $form->addElement(form_makeOpenTag('div', array('class' => 'pagenav')));
657    $last = $first + $conf['recent'];
658    if ($first > 0) {
659        $first -= $conf['recent'];
660        if ($first < 0) $first = 0;
661        $form->addElement(form_makeOpenTag('div', array('class' => 'pagenav-prev')));
662        $form->addElement(form_makeTag('input', array(
663                    'type'  => 'submit',
664                    'name'  => 'first['.$first.']',
665                    'value' => $lang['btn_newer'],
666                    'accesskey' => 'n',
667                    'title' => $lang['btn_newer'].' [N]',
668                    'class' => 'button'
669                    )));
670        $form->addElement(form_makeCloseTag('div'));
671    }
672    if ($hasNext) {
673        $form->addElement(form_makeOpenTag('div', array('class' => 'pagenav-next')));
674        $form->addElement(form_makeTag('input', array(
675                        'type'  => 'submit',
676                        'name'  => 'first['.$last.']',
677                        'value' => $lang['btn_older'],
678                        'accesskey' => 'p',
679                        'title' => $lang['btn_older'].' [P]',
680                        'class' => 'button'
681                        )));
682        $form->addElement(form_makeCloseTag('div'));
683    }
684    $form->addElement(form_makeCloseTag('div'));
685    html_form('recent', $form);
686}
687
688/**
689 * Display page index
690 *
691 * @author Andreas Gohr <andi@splitbrain.org>
692 */
693function html_index($ns){
694    global $conf;
695    global $ID;
696    $dir = $conf['datadir'];
697    $ns  = cleanID($ns);
698    #fixme use appropriate function
699    if(empty($ns)){
700        $ns = dirname(str_replace(':','/',$ID));
701        if($ns == '.') $ns ='';
702    }
703    $ns  = utf8_encodeFN(str_replace(':','/',$ns));
704
705    echo p_locale_xhtml('index');
706    echo '<div id="index__tree">';
707
708    $data = array();
709    search($data,$conf['datadir'],'search_index',array('ns' => $ns));
710    echo html_buildlist($data,'idx','html_list_index','html_li_index');
711
712    echo '</div>';
713}
714
715/**
716 * Index item formatter
717 *
718 * User function for html_buildlist()
719 *
720 * @author Andreas Gohr <andi@splitbrain.org>
721 */
722function html_list_index($item){
723    global $ID;
724    $ret = '';
725    $base = ':'.$item['id'];
726    $base = substr($base,strrpos($base,':')+1);
727    if($item['type']=='d'){
728        $ret .= '<a href="'.wl($ID,'idx='.rawurlencode($item['id'])).'" class="idx_dir"><strong>';
729        $ret .= $base;
730        $ret .= '</strong></a>';
731    }else{
732        $ret .= html_wikilink(':'.$item['id']);
733    }
734    return $ret;
735}
736
737/**
738 * Index List item
739 *
740 * This user function is used in html_buildlist to build the
741 * <li> tags for namespaces when displaying the page index
742 * it gives different classes to opened or closed "folders"
743 *
744 * @author Andreas Gohr <andi@splitbrain.org>
745 */
746function html_li_index($item){
747    if($item['type'] == "f"){
748        return '<li class="level'.$item['level'].'">';
749    }elseif($item['open']){
750        return '<li class="open">';
751    }else{
752        return '<li class="closed">';
753    }
754}
755
756/**
757 * Default List item
758 *
759 * @author Andreas Gohr <andi@splitbrain.org>
760 */
761function html_li_default($item){
762    return '<li class="level'.$item['level'].'">';
763}
764
765/**
766 * Build an unordered list
767 *
768 * Build an unordered list from the given $data array
769 * Each item in the array has to have a 'level' property
770 * the item itself gets printed by the given $func user
771 * function. The second and optional function is used to
772 * print the <li> tag. Both user function need to accept
773 * a single item.
774 *
775 * Both user functions can be given as array to point to
776 * a member of an object.
777 *
778 * @author Andreas Gohr <andi@splitbrain.org>
779 */
780function html_buildlist($data,$class,$func,$lifunc='html_li_default'){
781    if (count($data) === 0) {
782        return '';
783    }
784
785    $start_level = $data[0]['level'];
786    $ret   = '';
787
788    if ($start_level < 2) {
789        // Trigger building a wrapper ul if the first level is
790        // 0 (we have a root object) or 1 (just the root content)
791        --$start_level;
792    }
793
794    $level = $start_level;
795
796    foreach ($data as $item){
797
798        if( $item['level'] > $level ){
799            //open new list
800            for($i=0; $i<($item['level'] - $level); $i++){
801                if ($i) $ret .= "<li class=\"clear\">\n";
802                $ret .= "\n<ul class=\"$class\">\n";
803            }
804        }elseif( $item['level'] < $level ){
805            //close last item
806            $ret .= "</li>\n";
807            for ($i=0; $i<($level - $item['level']); $i++){
808                //close higher lists
809                $ret .= "</ul>\n</li>\n";
810            }
811        } elseif ($ret !== '') {
812            //close last item
813            $ret .= "</li>\n";
814        }
815
816        //remember current level
817        $level = $item['level'];
818
819        //print item
820        $ret .= call_user_func($lifunc,$item);
821        $ret .= '<div class="li">';
822
823        $ret .= call_user_func($func,$item);
824        $ret .= '</div>';
825    }
826
827    //close remaining items and lists
828    while(--$level >= $start_level) {
829        $ret .= "</li></ul>\n";
830    }
831
832    return $ret;
833}
834
835/**
836 * display backlinks
837 *
838 * @author Andreas Gohr <andi@splitbrain.org>
839 * @author Michael Klier <chi@chimeric.de>
840 */
841function html_backlinks(){
842    global $ID;
843    global $conf;
844    global $lang;
845
846    print p_locale_xhtml('backlinks');
847
848    $data = ft_backlinks($ID);
849
850    if(!empty($data)) {
851        print '<ul class="idx">';
852        foreach($data as $blink){
853            print '<li><div class="li">';
854            print html_wikilink(':'.$blink,useHeading('navigation')?null:$blink);
855            print '</div></li>';
856        }
857        print '</ul>';
858    } else {
859        print '<div class="level1"><p>' . $lang['nothingfound'] . '</p></div>';
860    }
861}
862
863/**
864 * show diff
865 *
866 * @author Andreas Gohr <andi@splitbrain.org>
867 * @param  string $text - compare with this text with most current version
868 * @param  bool   $intr - display the intro text
869 */
870function html_diff($text='',$intro=true,$type=null){
871    global $ID;
872    global $REV;
873    global $lang;
874    global $conf;
875
876    if(!$type) $type = $_REQUEST['difftype'];
877    if($type != 'inline') $type = 'sidebyside';
878
879    // we're trying to be clever here, revisions to compare can be either
880    // given as rev and rev2 parameters, with rev2 being optional. Or in an
881    // array in rev2.
882    $rev1 = $REV;
883
884    if(is_array($_REQUEST['rev2'])){
885        $rev1 = (int) $_REQUEST['rev2'][0];
886        $rev2 = (int) $_REQUEST['rev2'][1];
887
888        if(!$rev1){
889            $rev1 = $rev2;
890            unset($rev2);
891        }
892    }else{
893        $rev2 = (int) $_REQUEST['rev2'];
894    }
895
896    $r_minor = '';
897    $l_minor = '';
898
899    if($text){                      // compare text to the most current revision
900        $l_rev   = '';
901        $l_text  = rawWiki($ID,'');
902        $l_head  = '<a class="wikilink1" href="'.wl($ID).'">'.
903            $ID.' '.dformat((int) @filemtime(wikiFN($ID))).'</a> '.
904            $lang['current'];
905
906        $r_rev   = '';
907        $r_text  = cleanText($text);
908        $r_head  = $lang['yours'];
909    }else{
910        if($rev1 && $rev2){            // two specific revisions wanted
911            // make sure order is correct (older on the left)
912            if($rev1 < $rev2){
913                $l_rev = $rev1;
914                $r_rev = $rev2;
915            }else{
916                $l_rev = $rev2;
917                $r_rev = $rev1;
918            }
919        }elseif($rev1){                // single revision given, compare to current
920            $r_rev = '';
921            $l_rev = $rev1;
922        }else{                        // no revision was given, compare previous to current
923            $r_rev = '';
924            $revs = getRevisions($ID, 0, 1);
925            $l_rev = $revs[0];
926            $REV = $l_rev; // store revision back in $REV
927        }
928
929        // when both revisions are empty then the page was created just now
930        if(!$l_rev && !$r_rev){
931            $l_text = '';
932        }else{
933            $l_text = rawWiki($ID,$l_rev);
934        }
935        $r_text = rawWiki($ID,$r_rev);
936
937        if(!$l_rev){
938            $l_head = '&mdash;';
939        }else{
940            $l_info   = getRevisionInfo($ID,$l_rev,true);
941            if($l_info['user']){
942                $l_user = editorinfo($l_info['user']);
943                if(auth_ismanager()) $l_user .= ' ('.$l_info['ip'].')';
944            } else {
945                $l_user = $l_info['ip'];
946            }
947            $l_user  = '<span class="user">'.$l_user.'</span>';
948            $l_sum   = ($l_info['sum']) ? '<span class="sum">'.hsc($l_info['sum']).'</span>' : '';
949            if ($l_info['type']===DOKU_CHANGE_TYPE_MINOR_EDIT) $l_minor = 'class="minor"';
950
951            $l_head = '<a class="wikilink1" href="'.wl($ID,"rev=$l_rev").'">'.
952            $ID.' ['.dformat($l_rev).']</a>'.
953            '<br />'.$l_user.' '.$l_sum;
954        }
955
956        if($r_rev){
957            $r_info   = getRevisionInfo($ID,$r_rev,true);
958            if($r_info['user']){
959                $r_user = editorinfo($r_info['user']);
960                if(auth_ismanager()) $r_user .= ' ('.$r_info['ip'].')';
961            } else {
962                $r_user = $r_info['ip'];
963            }
964            $r_user = '<span class="user">'.$r_user.'</span>';
965            $r_sum  = ($r_info['sum']) ? '<span class="sum">'.hsc($r_info['sum']).'</span>' : '';
966            if ($r_info['type']===DOKU_CHANGE_TYPE_MINOR_EDIT) $r_minor = 'class="minor"';
967
968            $r_head = '<a class="wikilink1" href="'.wl($ID,"rev=$r_rev").'">'.
969            $ID.' ['.dformat($r_rev).']</a>'.
970            '<br />'.$r_user.' '.$r_sum;
971        }elseif($_rev = @filemtime(wikiFN($ID))){
972            $_info   = getRevisionInfo($ID,$_rev,true);
973            if($_info['user']){
974                $_user = editorinfo($_info['user']);
975                if(auth_ismanager()) $_user .= ' ('.$_info['ip'].')';
976            } else {
977                $_user = $_info['ip'];
978            }
979            $_user = '<span class="user">'.$_user.'</span>';
980            $_sum  = ($_info['sum']) ? '<span class="sum">'.hsc($_info['sum']).'</span>' : '';
981            if ($_info['type']===DOKU_CHANGE_TYPE_MINOR_EDIT) $r_minor = 'class="minor"';
982
983            $r_head  = '<a class="wikilink1" href="'.wl($ID).'">'.
984            $ID.' ['.dformat($_rev).']</a> '.
985            '('.$lang['current'].')'.
986            '<br />'.$_user.' '.$_sum;
987        }else{
988            $r_head = '&mdash; ('.$lang['current'].')';
989        }
990    }
991
992    $df = new Diff(explode("\n",htmlspecialchars($l_text)),
993        explode("\n",htmlspecialchars($r_text)));
994
995    if($type == 'inline'){
996        $tdf = new InlineDiffFormatter();
997    } else {
998        $tdf = new TableDiffFormatter();
999    }
1000
1001
1002
1003    if($intro) print p_locale_xhtml('diff');
1004
1005    if (!$text) {
1006        ptln('<div class="diffoptions">');
1007
1008        $form = new Doku_Form(array('action'=>wl()));
1009        $form->addHidden('id',$ID);
1010        $form->addHidden('rev2[0]',$l_rev);
1011        $form->addHidden('rev2[1]',$r_rev);
1012        $form->addHidden('do','diff');
1013        $form->addElement(form_makeListboxField(
1014                            'difftype',
1015                            array(
1016                                'sidebyside' => $lang['diff_side'],
1017                                'inline'     => $lang['diff_inline']),
1018                            $type,
1019                            $lang['diff_type'],
1020                            '','',
1021                            array('class'=>'quickselect')));
1022        $form->addElement(form_makeButton('submit', 'diff','Go'));
1023        $form->printForm();
1024
1025
1026        $diffurl = wl($ID, array(
1027                        'do'       => 'diff',
1028                        'rev2[0]'  => $l_rev,
1029                        'rev2[1]'  => $r_rev,
1030                        'difftype' => $type,
1031                      ));
1032        ptln('<p><a class="wikilink1" href="'.$diffurl.'">'.$lang['difflink'].'</a></p>');
1033        ptln('</div>');
1034    }
1035    ?>
1036    <table class="diff diff_<?php echo $type?>">
1037    <tr>
1038    <th colspan="2" <?php echo $l_minor?>>
1039    <?php echo $l_head?>
1040    </th>
1041    <th colspan="2" <?php echo $r_minor?>>
1042    <?php echo $r_head?>
1043    </th>
1044    </tr>
1045    <?php echo $tdf->format($df)?>
1046    </table>
1047    <?php
1048}
1049
1050/**
1051 * show warning on conflict detection
1052 *
1053 * @author Andreas Gohr <andi@splitbrain.org>
1054 */
1055function html_conflict($text,$summary){
1056    global $ID;
1057    global $lang;
1058
1059    print p_locale_xhtml('conflict');
1060    $form = new Doku_Form(array('id' => 'dw__editform'));
1061    $form->addHidden('id', $ID);
1062    $form->addHidden('wikitext', $text);
1063    $form->addHidden('summary', $summary);
1064    $form->addElement(form_makeButton('submit', 'save', $lang['btn_save'], array('accesskey'=>'s')));
1065    $form->addElement(form_makeButton('submit', 'cancel', $lang['btn_cancel']));
1066    html_form('conflict', $form);
1067    print '<br /><br /><br /><br />'.NL;
1068}
1069
1070/**
1071 * Prints the global message array
1072 *
1073 * @author Andreas Gohr <andi@splitbrain.org>
1074 */
1075function html_msgarea(){
1076    global $MSG, $MSG_shown;
1077    // store if the global $MSG has already been shown and thus HTML output has been started
1078    $MSG_shown = true;
1079
1080    if(!isset($MSG)) return;
1081
1082    $shown = array();
1083    foreach($MSG as $msg){
1084        $hash = md5($msg['msg']);
1085        if(isset($shown[$hash])) continue; // skip double messages
1086        print '<div class="'.$msg['lvl'].'">';
1087        print $msg['msg'];
1088        print '</div>';
1089        $shown[$hash] = 1;
1090    }
1091
1092    unset($GLOBALS['MSG']);
1093}
1094
1095/**
1096 * Prints the registration form
1097 *
1098 * @author Andreas Gohr <andi@splitbrain.org>
1099 */
1100function html_register(){
1101    global $lang;
1102    global $conf;
1103    global $ID;
1104
1105    print p_locale_xhtml('register');
1106    print '<div class="centeralign">'.NL;
1107    $form = new Doku_Form(array('id' => 'dw__register'));
1108    $form->startFieldset($lang['btn_register']);
1109    $form->addHidden('do', 'register');
1110    $form->addHidden('save', '1');
1111    $form->addElement(form_makeTextField('login', $_POST['login'], $lang['user'], '', 'block', array('size'=>'50')));
1112    if (!$conf['autopasswd']) {
1113        $form->addElement(form_makePasswordField('pass', $lang['pass'], '', 'block', array('size'=>'50')));
1114        $form->addElement(form_makePasswordField('passchk', $lang['passchk'], '', 'block', array('size'=>'50')));
1115    }
1116    $form->addElement(form_makeTextField('fullname', $_POST['fullname'], $lang['fullname'], '', 'block', array('size'=>'50')));
1117    $form->addElement(form_makeTextField('email', $_POST['email'], $lang['email'], '', 'block', array('size'=>'50')));
1118    $form->addElement(form_makeButton('submit', '', $lang['btn_register']));
1119    $form->endFieldset();
1120    html_form('register', $form);
1121
1122    print '</div>'.NL;
1123}
1124
1125/**
1126 * Print the update profile form
1127 *
1128 * @author Christopher Smith <chris@jalakai.co.uk>
1129 * @author Andreas Gohr <andi@splitbrain.org>
1130 */
1131function html_updateprofile(){
1132    global $lang;
1133    global $conf;
1134    global $ID;
1135    global $INFO;
1136    global $auth;
1137
1138    print p_locale_xhtml('updateprofile');
1139
1140    if (empty($_POST['fullname'])) $_POST['fullname'] = $INFO['userinfo']['name'];
1141    if (empty($_POST['email'])) $_POST['email'] = $INFO['userinfo']['mail'];
1142    print '<div class="centeralign">'.NL;
1143    $form = new Doku_Form(array('id' => 'dw__register'));
1144    $form->startFieldset($lang['profile']);
1145    $form->addHidden('do', 'profile');
1146    $form->addHidden('save', '1');
1147    $form->addElement(form_makeTextField('fullname', $_SERVER['REMOTE_USER'], $lang['user'], '', 'block', array('size'=>'50', 'disabled'=>'disabled')));
1148    $attr = array('size'=>'50');
1149    if (!$auth->canDo('modName')) $attr['disabled'] = 'disabled';
1150    $form->addElement(form_makeTextField('fullname', $_POST['fullname'], $lang['fullname'], '', 'block', $attr));
1151    $attr = array('size'=>'50');
1152    if (!$auth->canDo('modMail')) $attr['disabled'] = 'disabled';
1153    $form->addElement(form_makeTextField('email', $_POST['email'], $lang['email'], '', 'block', $attr));
1154    $form->addElement(form_makeTag('br'));
1155    if ($auth->canDo('modPass')) {
1156        $form->addElement(form_makePasswordField('newpass', $lang['newpass'], '', 'block', array('size'=>'50')));
1157        $form->addElement(form_makePasswordField('passchk', $lang['passchk'], '', 'block', array('size'=>'50')));
1158    }
1159    if ($conf['profileconfirm']) {
1160        $form->addElement(form_makeTag('br'));
1161        $form->addElement(form_makePasswordField('oldpass', $lang['oldpass'], '', 'block', array('size'=>'50')));
1162    }
1163    $form->addElement(form_makeButton('submit', '', $lang['btn_save']));
1164    $form->addElement(form_makeButton('reset', '', $lang['btn_reset']));
1165    $form->endFieldset();
1166    html_form('updateprofile', $form);
1167    print '</div>'.NL;
1168}
1169
1170/**
1171 * Preprocess edit form data
1172 *
1173 * @author   Andreas Gohr <andi@splitbrain.org>
1174 *
1175 * @triggers HTML_EDITFORM_OUTPUT
1176 */
1177function html_edit(){
1178    global $ID;
1179    global $REV;
1180    global $DATE;
1181    global $PRE;
1182    global $SUF;
1183    global $INFO;
1184    global $SUM;
1185    global $lang;
1186    global $conf;
1187    global $TEXT;
1188    global $RANGE;
1189
1190    if (isset($_REQUEST['changecheck'])) {
1191        $check = $_REQUEST['changecheck'];
1192    } elseif(!$INFO['exists']){
1193        // $TEXT has been loaded from page template
1194        $check = md5('');
1195    } else {
1196        $check = md5($TEXT);
1197    }
1198    $mod = md5($TEXT) !== $check;
1199
1200    $wr = $INFO['writable'] && !$INFO['locked'];
1201    $include = 'edit';
1202    if($wr){
1203        if ($REV) $include = 'editrev';
1204    }else{
1205        // check pseudo action 'source'
1206        if(!actionOK('source')){
1207            msg('Command disabled: source',-1);
1208            return;
1209        }
1210        $include = 'read';
1211    }
1212
1213    global $license;
1214
1215    $form = new Doku_Form(array('id' => 'dw__editform'));
1216    $form->addHidden('id', $ID);
1217    $form->addHidden('rev', $REV);
1218    $form->addHidden('date', $DATE);
1219    $form->addHidden('prefix', $PRE . '.');
1220    $form->addHidden('suffix', $SUF);
1221    $form->addHidden('changecheck', $check);
1222
1223    $data = array('form' => $form,
1224                  'wr'   => $wr,
1225                  'media_manager' => true,
1226                  'target' => (isset($_REQUEST['target']) && $wr &&
1227                               $RANGE !== '') ? $_REQUEST['target'] : 'section',
1228                  'intro_locale' => $include);
1229
1230    if ($data['target'] !== 'section') {
1231        // Only emit event if page is writable, section edit data is valid and
1232        // edit target is not section.
1233        trigger_event('HTML_EDIT_FORMSELECTION', $data, 'html_edit_form', true);
1234    } else {
1235        html_edit_form($data);
1236    }
1237    if (isset($data['intro_locale'])) {
1238        echo p_locale_xhtml($data['intro_locale']);
1239    }
1240
1241    $form->addHidden('target', $data['target']);
1242    $form->addElement(form_makeOpenTag('div', array('id'=>'wiki__editbar')));
1243    $form->addElement(form_makeOpenTag('div', array('id'=>'size__ctl')));
1244    $form->addElement(form_makeCloseTag('div'));
1245    if ($wr) {
1246        $form->addElement(form_makeOpenTag('div', array('class'=>'editButtons')));
1247        $form->addElement(form_makeButton('submit', 'save', $lang['btn_save'], array('id'=>'edbtn__save', 'accesskey'=>'s', 'tabindex'=>'4')));
1248        $form->addElement(form_makeButton('submit', 'preview', $lang['btn_preview'], array('id'=>'edbtn__preview', 'accesskey'=>'p', 'tabindex'=>'5')));
1249        $form->addElement(form_makeButton('submit', 'draftdel', $lang['btn_cancel'], array('tabindex'=>'6')));
1250        $form->addElement(form_makeCloseTag('div'));
1251        $form->addElement(form_makeOpenTag('div', array('class'=>'summary')));
1252        $form->addElement(form_makeTextField('summary', $SUM, $lang['summary'], 'edit__summary', 'nowrap', array('size'=>'50', 'tabindex'=>'2')));
1253        $elem = html_minoredit();
1254        if ($elem) $form->addElement($elem);
1255        $form->addElement(form_makeCloseTag('div'));
1256    }
1257    $form->addElement(form_makeCloseTag('div'));
1258    if($wr && $conf['license']){
1259        $form->addElement(form_makeOpenTag('div', array('class'=>'license')));
1260        $out  = $lang['licenseok'];
1261        $out .= ' <a href="'.$license[$conf['license']]['url'].'" rel="license" class="urlextern"';
1262        if($conf['target']['extern']) $out .= ' target="'.$conf['target']['extern'].'"';
1263        $out .= '>'.$license[$conf['license']]['name'].'</a>';
1264        $form->addElement($out);
1265        $form->addElement(form_makeCloseTag('div'));
1266    }
1267
1268    if ($wr) {
1269        // sets changed to true when previewed
1270        echo '<script type="text/javascript" charset="utf-8"><!--//--><![CDATA[//><!--'. NL;
1271        echo 'textChanged = ' . ($mod ? 'true' : 'false');
1272        echo '//--><!]]></script>' . NL;
1273    } ?>
1274    <div style="width:99%;">
1275
1276    <div class="toolbar">
1277    <div id="draft__status"><?php if(!empty($INFO['draft'])) echo $lang['draftdate'].' '.dformat();?></div>
1278    <div id="tool__bar"><?php if ($wr && $data['media_manager']){?><a href="<?php echo DOKU_BASE?>lib/exe/mediamanager.php?ns=<?php echo $INFO['namespace']?>"
1279        target="_blank"><?php echo $lang['mediaselect'] ?></a><?php }?></div>
1280
1281    </div>
1282    <?php
1283
1284    html_form('edit', $form);
1285    print '</div>'.NL;
1286}
1287
1288/**
1289 * Display the default edit form
1290 *
1291 * Is the default action for HTML_EDIT_FORMSELECTION.
1292 */
1293function html_edit_form($param) {
1294    global $TEXT;
1295
1296    if ($param['target'] !== 'section') {
1297        msg('No editor for edit target ' . $param['target'] . ' found.', -1);
1298    }
1299
1300    $attr = array('tabindex'=>'1');
1301    if (!$param['wr']) $attr['readonly'] = 'readonly';
1302
1303    $param['form']->addElement(form_makeWikiText($TEXT, $attr));
1304}
1305
1306/**
1307 * Adds a checkbox for minor edits for logged in users
1308 *
1309 * @author Andreas Gohr <andi@splitbrain.org>
1310 */
1311function html_minoredit(){
1312    global $conf;
1313    global $lang;
1314    // minor edits are for logged in users only
1315    if(!$conf['useacl'] || !$_SERVER['REMOTE_USER']){
1316        return false;
1317    }
1318
1319    $p = array();
1320    $p['tabindex'] = 3;
1321    if(!empty($_REQUEST['minor'])) $p['checked']='checked';
1322    return form_makeCheckboxField('minor', '1', $lang['minoredit'], 'minoredit', 'nowrap', $p);
1323}
1324
1325/**
1326 * prints some debug info
1327 *
1328 * @author Andreas Gohr <andi@splitbrain.org>
1329 */
1330function html_debug(){
1331    global $conf;
1332    global $lang;
1333    global $auth;
1334    global $INFO;
1335
1336    //remove sensitive data
1337    $cnf = $conf;
1338    debug_guard($cnf);
1339    $nfo = $INFO;
1340    debug_guard($nfo);
1341    $ses = $_SESSION;
1342    debug_guard($ses);
1343
1344    print '<html><body>';
1345
1346    print '<p>When reporting bugs please send all the following ';
1347    print 'output as a mail to andi@splitbrain.org ';
1348    print 'The best way to do this is to save this page in your browser</p>';
1349
1350    print '<b>$INFO:</b><pre>';
1351    print_r($nfo);
1352    print '</pre>';
1353
1354    print '<b>$_SERVER:</b><pre>';
1355    print_r($_SERVER);
1356    print '</pre>';
1357
1358    print '<b>$conf:</b><pre>';
1359    print_r($cnf);
1360    print '</pre>';
1361
1362    print '<b>DOKU_BASE:</b><pre>';
1363    print DOKU_BASE;
1364    print '</pre>';
1365
1366    print '<b>abs DOKU_BASE:</b><pre>';
1367    print DOKU_URL;
1368    print '</pre>';
1369
1370    print '<b>rel DOKU_BASE:</b><pre>';
1371    print dirname($_SERVER['PHP_SELF']).'/';
1372    print '</pre>';
1373
1374    print '<b>PHP Version:</b><pre>';
1375    print phpversion();
1376    print '</pre>';
1377
1378    print '<b>locale:</b><pre>';
1379    print setlocale(LC_ALL,0);
1380    print '</pre>';
1381
1382    print '<b>encoding:</b><pre>';
1383    print $lang['encoding'];
1384    print '</pre>';
1385
1386    if($auth){
1387        print '<b>Auth backend capabilities:</b><pre>';
1388        print_r($auth->cando);
1389        print '</pre>';
1390    }
1391
1392    print '<b>$_SESSION:</b><pre>';
1393    print_r($ses);
1394    print '</pre>';
1395
1396    print '<b>Environment:</b><pre>';
1397    print_r($_ENV);
1398    print '</pre>';
1399
1400    print '<b>PHP settings:</b><pre>';
1401    $inis = ini_get_all();
1402    print_r($inis);
1403    print '</pre>';
1404
1405    print '</body></html>';
1406}
1407
1408/**
1409 * List available Administration Tasks
1410 *
1411 * @author Andreas Gohr <andi@splitbrain.org>
1412 * @author Håkan Sandell <hakan.sandell@home.se>
1413 */
1414function html_admin(){
1415    global $ID;
1416    global $INFO;
1417    global $lang;
1418    global $conf;
1419    global $auth;
1420
1421    // build menu of admin functions from the plugins that handle them
1422    $pluginlist = plugin_list('admin');
1423    $menu = array();
1424    foreach ($pluginlist as $p) {
1425        if($obj =& plugin_load('admin',$p) === null) continue;
1426
1427        // check permissions
1428        if($obj->forAdminOnly() && !$INFO['isadmin']) continue;
1429
1430        $menu[$p] = array('plugin' => $p,
1431                'prompt' => $obj->getMenuText($conf['lang']),
1432                'sort' => $obj->getMenuSort()
1433                );
1434    }
1435
1436    // data security check
1437    // @todo: could be checked and only displayed if $conf['savedir'] is under the web root
1438    echo '<a style="border:none; float:right;"
1439            href="http://www.dokuwiki.org/security#web_access_security">
1440            <img src="data/security.png" alt="Your data directory seems to be protected properly."
1441             onerror="this.parentNode.style.display=\'none\'" /></a>';
1442
1443    print p_locale_xhtml('admin');
1444
1445    // Admin Tasks
1446    if($INFO['isadmin']){
1447        ptln('<ul class="admin_tasks">');
1448
1449        if($menu['usermanager'] && $auth && $auth->canDo('getUsers')){
1450            ptln('  <li class="admin_usermanager"><div class="li">'.
1451                    '<a href="'.wl($ID, array('do' => 'admin','page' => 'usermanager')).'">'.
1452                    $menu['usermanager']['prompt'].'</a></div></li>');
1453        }
1454        unset($menu['usermanager']);
1455
1456        if($menu['acl']){
1457            ptln('  <li class="admin_acl"><div class="li">'.
1458                    '<a href="'.wl($ID, array('do' => 'admin','page' => 'acl')).'">'.
1459                    $menu['acl']['prompt'].'</a></div></li>');
1460        }
1461        unset($menu['acl']);
1462
1463        if($menu['plugin']){
1464            ptln('  <li class="admin_plugin"><div class="li">'.
1465                    '<a href="'.wl($ID, array('do' => 'admin','page' => 'plugin')).'">'.
1466                    $menu['plugin']['prompt'].'</a></div></li>');
1467        }
1468        unset($menu['plugin']);
1469
1470        if($menu['config']){
1471            ptln('  <li class="admin_config"><div class="li">'.
1472                    '<a href="'.wl($ID, array('do' => 'admin','page' => 'config')).'">'.
1473                    $menu['config']['prompt'].'</a></div></li>');
1474        }
1475        unset($menu['config']);
1476    }
1477    ptln('</ul>');
1478
1479    // Manager Tasks
1480    ptln('<ul class="admin_tasks">');
1481
1482    if($menu['revert']){
1483        ptln('  <li class="admin_revert"><div class="li">'.
1484                '<a href="'.wl($ID, array('do' => 'admin','page' => 'revert')).'">'.
1485                $menu['revert']['prompt'].'</a></div></li>');
1486    }
1487    unset($menu['revert']);
1488
1489    if($menu['popularity']){
1490        ptln('  <li class="admin_popularity"><div class="li">'.
1491                '<a href="'.wl($ID, array('do' => 'admin','page' => 'popularity')).'">'.
1492                $menu['popularity']['prompt'].'</a></div></li>');
1493    }
1494    unset($menu['popularity']);
1495
1496    // print DokuWiki version:
1497    ptln('</ul>');
1498    echo '<div id="admin__version">';
1499    echo getVersion();
1500    echo '</div>';
1501
1502    // print the rest as sorted list
1503    if(count($menu)){
1504        usort($menu, 'p_sort_modes');
1505        // output the menu
1506        ptln('<div class="clearer"></div>');
1507        print p_locale_xhtml('adminplugins');
1508        ptln('<ul>');
1509        foreach ($menu as $item) {
1510            if (!$item['prompt']) continue;
1511            ptln('  <li><div class="li"><a href="'.wl($ID, 'do=admin&amp;page='.$item['plugin']).'">'.$item['prompt'].'</a></div></li>');
1512        }
1513        ptln('</ul>');
1514    }
1515}
1516
1517/**
1518 * Form to request a new password for an existing account
1519 *
1520 * @author Benoit Chesneau <benoit@bchesneau.info>
1521 */
1522function html_resendpwd() {
1523    global $lang;
1524    global $conf;
1525    global $ID;
1526
1527    print p_locale_xhtml('resendpwd');
1528    print '<div class="centeralign">'.NL;
1529    $form = new Doku_Form(array('id' => 'dw__resendpwd'));
1530    $form->startFieldset($lang['resendpwd']);
1531    $form->addHidden('do', 'resendpwd');
1532    $form->addHidden('save', '1');
1533    $form->addElement(form_makeTag('br'));
1534    $form->addElement(form_makeTextField('login', $_POST['login'], $lang['user'], '', 'block'));
1535    $form->addElement(form_makeTag('br'));
1536    $form->addElement(form_makeTag('br'));
1537    $form->addElement(form_makeButton('submit', '', $lang['btn_resendpwd']));
1538    $form->endFieldset();
1539    html_form('resendpwd', $form);
1540    print '</div>'.NL;
1541}
1542
1543/**
1544 * Return the TOC rendered to XHTML
1545 *
1546 * @author Andreas Gohr <andi@splitbrain.org>
1547 */
1548function html_TOC($toc){
1549    if(!count($toc)) return '';
1550    global $lang;
1551    $out  = '<!-- TOC START -->'.DOKU_LF;
1552    $out .= '<div class="toc">'.DOKU_LF;
1553    $out .= '<div class="tocheader toctoggle" id="toc__header">';
1554    $out .= $lang['toc'];
1555    $out .= '</div>'.DOKU_LF;
1556    $out .= '<div id="toc__inside">'.DOKU_LF;
1557    $out .= html_buildlist($toc,'toc','html_list_toc');
1558    $out .= '</div>'.DOKU_LF.'</div>'.DOKU_LF;
1559    $out .= '<!-- TOC END -->'.DOKU_LF;
1560    return $out;
1561}
1562
1563/**
1564 * Callback for html_buildlist
1565 */
1566function html_list_toc($item){
1567    if(isset($item['hid'])){
1568        $link = '#'.$item['hid'];
1569    }else{
1570        $link = $item['link'];
1571    }
1572
1573    return '<span class="li"><a href="'.$link.'" class="toc">'.
1574        hsc($item['title']).'</a></span>';
1575}
1576
1577/**
1578 * Helper function to build TOC items
1579 *
1580 * Returns an array ready to be added to a TOC array
1581 *
1582 * @param string $link  - where to link (if $hash set to '#' it's a local anchor)
1583 * @param string $text  - what to display in the TOC
1584 * @param int    $level - nesting level
1585 * @param string $hash  - is prepended to the given $link, set blank if you want full links
1586 */
1587function html_mktocitem($link, $text, $level, $hash='#'){
1588    global $conf;
1589    return  array( 'link'  => $hash.$link,
1590            'title' => $text,
1591            'type'  => 'ul',
1592            'level' => $level);
1593}
1594
1595/**
1596 * Output a Doku_Form object.
1597 * Triggers an event with the form name: HTML_{$name}FORM_OUTPUT
1598 *
1599 * @author Tom N Harris <tnharris@whoopdedo.org>
1600 */
1601function html_form($name, &$form) {
1602    // Safety check in case the caller forgets.
1603    $form->endFieldset();
1604    trigger_event('HTML_'.strtoupper($name).'FORM_OUTPUT', $form, 'html_form_output', false);
1605}
1606
1607/**
1608 * Form print function.
1609 * Just calls printForm() on the data object.
1610 */
1611function html_form_output($data) {
1612    $data->printForm();
1613}
1614
1615/**
1616 * Embed a flash object in HTML
1617 *
1618 * This will create the needed HTML to embed a flash movie in a cross browser
1619 * compatble way using valid XHTML
1620 *
1621 * The parameters $params, $flashvars and $atts need to be associative arrays.
1622 * No escaping needs to be done for them. The alternative content *has* to be
1623 * escaped because it is used as is. If no alternative content is given
1624 * $lang['noflash'] is used.
1625 *
1626 * @author Andreas Gohr <andi@splitbrain.org>
1627 * @link   http://latrine.dgx.cz/how-to-correctly-insert-a-flash-into-xhtml
1628 *
1629 * @param string $swf      - the SWF movie to embed
1630 * @param int $width       - width of the flash movie in pixels
1631 * @param int $height      - height of the flash movie in pixels
1632 * @param array $params    - additional parameters (<param>)
1633 * @param array $flashvars - parameters to be passed in the flashvar parameter
1634 * @param array $atts      - additional attributes for the <object> tag
1635 * @param string $alt      - alternative content (is NOT automatically escaped!)
1636 * @returns string         - the XHTML markup
1637 */
1638function html_flashobject($swf,$width,$height,$params=null,$flashvars=null,$atts=null,$alt=''){
1639    global $lang;
1640
1641    $out = '';
1642
1643    // prepare the object attributes
1644    if(is_null($atts)) $atts = array();
1645    $atts['width']  = (int) $width;
1646    $atts['height'] = (int) $height;
1647    if(!$atts['width'])  $atts['width']  = 425;
1648    if(!$atts['height']) $atts['height'] = 350;
1649
1650    // add object attributes for standard compliant browsers
1651    $std = $atts;
1652    $std['type'] = 'application/x-shockwave-flash';
1653    $std['data'] = $swf;
1654
1655    // add object attributes for IE
1656    $ie  = $atts;
1657    $ie['classid'] = 'clsid:D27CDB6E-AE6D-11cf-96B8-444553540000';
1658
1659    // open object (with conditional comments)
1660    $out .= '<!--[if !IE]> -->'.NL;
1661    $out .= '<object '.buildAttributes($std).'>'.NL;
1662    $out .= '<!-- <![endif]-->'.NL;
1663    $out .= '<!--[if IE]>'.NL;
1664    $out .= '<object '.buildAttributes($ie).'>'.NL;
1665    $out .= '    <param name="movie" value="'.hsc($swf).'" />'.NL;
1666    $out .= '<!--><!-- -->'.NL;
1667
1668    // print params
1669    if(is_array($params)) foreach($params as $key => $val){
1670        $out .= '  <param name="'.hsc($key).'" value="'.hsc($val).'" />'.NL;
1671    }
1672
1673    // add flashvars
1674    if(is_array($flashvars)){
1675        $out .= '  <param name="FlashVars" value="'.buildURLparams($flashvars).'" />'.NL;
1676    }
1677
1678    // alternative content
1679    if($alt){
1680        $out .= $alt.NL;
1681    }else{
1682        $out .= $lang['noflash'].NL;
1683    }
1684
1685    // finish
1686    $out .= '</object>'.NL;
1687    $out .= '<!-- <![endif]-->'.NL;
1688
1689    return $out;
1690}
1691
1692