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