xref: /dokuwiki/inc/html.php (revision c1482d1c08360e6401534a1391da2b650c37d34d) 
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 */
8use dokuwiki\Ui\MediaRevisions;
9use dokuwiki\Form\Form;
10use dokuwiki\Action\Denied;
11use dokuwiki\Action\Locked;
12use dokuwiki\ChangeLog\PageChangeLog;
13use dokuwiki\Extension\AuthPlugin;
14use dokuwiki\Extension\Event;
15use dokuwiki\Ui\Backlinks;
16use dokuwiki\Ui\Editor;
17use dokuwiki\Ui\Index;
18use dokuwiki\Ui\Login;
19use dokuwiki\Ui\PageConflict;
20use dokuwiki\Ui\PageDiff;
21use dokuwiki\Ui\PageDraft;
22use dokuwiki\Ui\PageRevisions;
23use dokuwiki\Ui\PageView;
24use dokuwiki\Ui\Recent;
25use dokuwiki\Ui\UserProfile;
26use dokuwiki\Ui\UserRegister;
27use dokuwiki\Ui\UserResendPwd;
28use dokuwiki\Utf8\Clean;
29
30if (!defined('SEC_EDIT_PATTERN')) {
31    define('SEC_EDIT_PATTERN', '#<!-- EDIT({.*?}) -->#');
32}
33
34
35/**
36 * Convenience function to quickly build a wikilink
37 *
38 * @author Andreas Gohr <andi@splitbrain.org>
39 * @param string  $id      id of the target page
40 * @param string  $name    the name of the link, i.e. the text that is displayed
41 * @param string|array  $search  search string(s) that shall be highlighted in the target page
42 * @return string the HTML code of the link
43 */
44function html_wikilink($id, $name = null, $search = '') {
45    /** @var Doku_Renderer_xhtml $xhtml_renderer */
46    static $xhtml_renderer = null;
47    if (is_null($xhtml_renderer)) {
48        $xhtml_renderer = p_get_renderer('xhtml');
49    }
50
51    return $xhtml_renderer->internallink($id, $name, $search, true, 'navigation');
52}
53
54/**
55 * The loginform
56 *
57 * @author   Andreas Gohr <andi@splitbrain.org>
58 *
59 * @param bool $svg Whether to show svg icons in the register and resendpwd links or not
60 * @deprecated 2020-07-18
61 */
62function html_login($svg = false) {
63    dbg_deprecated(Login::class .'::show()');
64    (new Login($svg))->show();
65}
66
67
68/**
69 * Denied page content
70 *
71 * @deprecated 2020-07-18 not called anymore, see inc/Action/Denied::tplContent()
72 */
73function html_denied() {
74    dbg_deprecated(Denied::class .'::showBanner()');
75    (new Denied())->showBanner();
76}
77
78/**
79 * inserts section edit buttons if wanted or removes the markers
80 *
81 * @author Andreas Gohr <andi@splitbrain.org>
82 *
83 * @param string $text
84 * @param bool   $show show section edit buttons?
85 * @return string
86 */
87function html_secedit($text, $show = true) {
88    global $INFO;
89
90    if ((isset($INFO) && !$INFO['writable']) || !$show || (isset($INFO) && $INFO['rev'])) {
91        return preg_replace(SEC_EDIT_PATTERN, '', $text);
92    }
93
94    return preg_replace_callback(SEC_EDIT_PATTERN,
95                'html_secedit_button', $text);
96}
97
98/**
99 * prepares section edit button data for event triggering
100 * used as a callback in html_secedit
101 *
102 * @author Andreas Gohr <andi@splitbrain.org>
103 *
104 * @param array $matches matches with regexp
105 * @return string
106 * @triggers HTML_SECEDIT_BUTTON
107 */
108function html_secedit_button($matches){
109    $json = htmlspecialchars_decode($matches[1], ENT_QUOTES);
110    $data = json_decode($json, true, 512, JSON_THROW_ON_ERROR);
111    if ($data === null) {
112        return '';
113    }
114    $data['target'] = strtolower($data['target']);
115    $data['hid'] = strtolower($data['hid'] ?? '');
116
117    return Event::createAndTrigger(
118        'HTML_SECEDIT_BUTTON',
119        $data,
120        'html_secedit_get_button'
121    );
122}
123
124/**
125 * prints a section editing button
126 * used as default action form HTML_SECEDIT_BUTTON
127 *
128 * @author Adrian Lang <lang@cosmocode.de>
129 *
130 * @param array $data name, section id and target
131 * @return string html
132 */
133function html_secedit_get_button($data) {
134    global $ID;
135    global $INFO;
136
137    if (!isset($data['name']) || $data['name'] === '') return '';
138
139    $name = $data['name'];
140    unset($data['name']);
141
142    $secid = $data['secid'];
143    unset($data['secid']);
144
145    $params = array_merge(
146           ['do'  => 'edit', 'rev' => $INFO['lastmod'], 'summary' => '['.$name.'] '],
147           $data
148    );
149
150    $html = '<div class="secedit editbutton_'.$data['target'] .' editbutton_'.$secid .'">';
151    $html.= html_btn('secedit', $ID, '', $params, 'post', $name);
152    $html.= '</div>';
153    return $html;
154}
155
156/**
157 * Just the back to top button (in its own form)
158 *
159 * @author Andreas Gohr <andi@splitbrain.org>
160 *
161 * @return string html
162 */
163function html_topbtn() {
164    global $lang;
165
166    return '<a class="nolink" href="#dokuwiki__top">'
167        .'<button class="button" onclick="window.scrollTo(0, 0)" title="'. $lang['btn_top'] .'">'
168        . $lang['btn_top']
169        .'</button></a>';
170}
171
172/**
173 * Displays a button (using its own form)
174 * If tooltip exists, the access key tooltip is replaced.
175 *
176 * @author Andreas Gohr <andi@splitbrain.org>
177 *
178 * @param string         $name
179 * @param string         $id
180 * @param string         $akey   access key
181 * @param string[]       $params key-value pairs added as hidden inputs
182 * @param string         $method
183 * @param string         $tooltip
184 * @param bool|string    $label  label text, false: lookup btn_$name in localization
185 * @param string         $svg (optional) svg code, inserted into the button
186 * @return string
187 */
188function html_btn($name, $id, $akey, $params, $method = 'get', $tooltip = '', $label = false, $svg = null) {
189    global $conf;
190    global $lang;
191
192    if (!$label)
193        $label = $lang['btn_'.$name];
194
195    //filter id (without urlencoding)
196    $id = idfilter($id, false);
197
198    //make nice URLs even for buttons
199    if ($conf['userewrite'] == 2) {
200        $script = DOKU_BASE.DOKU_SCRIPT.'/'.$id;
201    } elseif ($conf['userewrite']) {
202        $script = DOKU_BASE.$id;
203    } else {
204        $script = DOKU_BASE.DOKU_SCRIPT;
205        $params['id'] = $id;
206    }
207
208    $html = '<form class="button btn_'.$name.'" method="'.$method.'" action="'.$script.'"><div class="no">';
209
210    if (is_array($params)) {
211        foreach ($params as $key => $val) {
212            $html .= '<input type="hidden" name="'.$key.'" value="'.hsc($val).'" />';
213        }
214    }
215
216    $tip = empty($tooltip) ? hsc($label) : hsc($tooltip);
217
218    $html .= '<button type="submit" ';
219    if ($akey) {
220        $tip  .= ' ['.strtoupper($akey).']';
221        $html .= 'accesskey="'.$akey.'" ';
222    }
223    $html .= 'title="'.$tip.'">';
224    if ($svg) {
225        $html .= '<span>'. hsc($label) .'</span>'. inlineSVG($svg);
226    } else {
227        $html .= hsc($label);
228    }
229    $html .= '</button>';
230    $html .= '</div></form>';
231
232    return $html;
233}
234/**
235 * show a revision warning
236 *
237 * @author Szymon Olewniczak <dokuwiki@imz.re>
238 * @deprecated 2020-07-18
239 */
240function html_showrev() {
241    dbg_deprecated(PageView::class .'::showrev()');
242}
243
244/**
245 * Show a wiki page
246 *
247 * @author Andreas Gohr <andi@splitbrain.org>
248 *
249 * @param null|string $txt wiki text or null for showing $ID
250 * @deprecated 2020-07-18
251 */
252function html_show($txt=null) {
253    dbg_deprecated(PageView::class .'::show()');
254    (new PageView($txt))->show();
255}
256
257/**
258 * ask the user about how to handle an exisiting draft
259 *
260 * @author Andreas Gohr <andi@splitbrain.org>
261 * @deprecated 2020-07-18
262 */
263function html_draft() {
264    dbg_deprecated(PageDraft::class .'::show()');
265    (new PageDraft)->show();
266}
267
268/**
269 * Highlights searchqueries in HTML code
270 *
271 * @author Andreas Gohr <andi@splitbrain.org>
272 * @author Harry Fuecks <hfuecks@gmail.com>
273 *
274 * @param string $html
275 * @param array|string $phrases
276 * @return string html
277 */
278function html_hilight($html, $phrases) {
279    $phrases = (array) $phrases;
280    $phrases = array_map('preg_quote_cb', $phrases);
281    $phrases = array_map('ft_snippet_re_preprocess', $phrases);
282    $phrases = array_filter($phrases);
283
284    $regex = implode('|', $phrases);
285
286    if ($regex === '') return $html;
287    if (!Clean::isUtf8($regex)) return $html;
288
289    return @preg_replace_callback("/((<[^>]*)|$regex)/ui", function ($match) {
290        $hlight = unslash($match[0]);
291        if (!isset($match[2])) {
292            $hlight = '<span class="search_hit">'.$hlight.'</span>';
293        }
294        return $hlight;
295    }, $html);
296}
297
298/**
299 * Display error on locked pages
300 *
301 * @author Andreas Gohr <andi@splitbrain.org>
302 * @deprecated 2020-07-18 not called anymore, see inc/Action/Locked::tplContent()
303 */
304function html_locked() {
305    dbg_deprecated(Locked::class .'::showBanner()');
306    (new Locked())->showBanner();
307}
308
309/**
310 * list old revisions
311 *
312 * @author Andreas Gohr <andi@splitbrain.org>
313 * @author Ben Coburn <btcoburn@silicodon.net>
314 * @author Kate Arzamastseva <pshns@ukr.net>
315 *
316 * @param int $first skip the first n changelog lines
317 * @param string $media_id id of media, or empty for current page
318 * @deprecated 2020-07-18
319 */
320function html_revisions($first = -1, $media_id = '') {
321    dbg_deprecated(PageRevisions::class .'::show()');
322    if ($media_id) {
323        (new MediaRevisions($media_id))->show($first);
324    } else {
325        global $INFO;
326        (new PageRevisions($INFO['id']))->show($first);
327    }
328}
329
330/**
331 * display recent changes
332 *
333 * @author Andreas Gohr <andi@splitbrain.org>
334 * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
335 * @author Ben Coburn <btcoburn@silicodon.net>
336 * @author Kate Arzamastseva <pshns@ukr.net>
337 *
338 * @param int $first
339 * @param string $show_changes
340 * @deprecated 2020-07-18
341 */
342function html_recent($first = 0, $show_changes = 'both') {
343    dbg_deprecated(Recent::class .'::show()');
344    (new Recent($first, $show_changes))->show();
345}
346
347/**
348 * Display page index
349 *
350 * @author Andreas Gohr <andi@splitbrain.org>
351 *
352 * @param string $ns
353 * @deprecated 2020-07-18
354 */
355function html_index($ns) {
356    dbg_deprecated(Index::class .'::show()');
357    (new Index($ns))->show();
358}
359
360/**
361 * Index tree item formatter for html_buildlist()
362 *
363 * User function for html_buildlist()
364 *
365 * @author Andreas Gohr <andi@splitbrain.org>
366 *
367 * @param array $item
368 * @return string
369 * @deprecated 2020-07-18
370 */
371function html_list_index($item) {
372    dbg_deprecated(Index::class .'::formatListItem()');
373    return (new Index)->formatListItem($item);
374}
375
376/**
377 * Index list item formatter for html_buildlist()
378 *
379 * This user function is used in html_buildlist to build the
380 * <li> tags for namespaces when displaying the page index
381 * it gives different classes to opened or closed "folders"
382 *
383 * @author Andreas Gohr <andi@splitbrain.org>
384 *
385 * @param array $item
386 * @return string html
387 * @deprecated 2020-07-18
388 */
389function html_li_index($item) {
390    dbg_deprecated(Index::class .'::tagListItem()');
391    return (new Index)->tagListItem($item);
392}
393
394/**
395 * Default list item formatter for html_buildlist()
396 *
397 * @author Andreas Gohr <andi@splitbrain.org>
398 *
399 * @param array $item
400 * @return string html
401 * @deprecated 2020-07-18
402 */
403function html_li_default($item){
404    return '<li class="level'.$item['level'].'">';
405}
406
407/**
408 * Build an unordered list
409 *
410 * Build an unordered list from the given $data array
411 * Each item in the array has to have a 'level' property
412 * the item itself gets printed by the given $func user
413 * function. The second and optional function is used to
414 * print the <li> tag. Both user function need to accept
415 * a single item.
416 *
417 * Both user functions can be given as array to point to
418 * a member of an object.
419 *
420 * @author Andreas Gohr <andi@splitbrain.org>
421 *
422 * @param array    $data  array with item arrays
423 * @param string   $class class of ul wrapper
424 * @param callable $func  callback to print an list item
425 * @param callable $lifunc (optional) callback to the opening li tag
426 * @param bool     $forcewrapper (optional) Trigger building a wrapper ul if the first level is
427 *                               0 (we have a root object) or 1 (just the root content)
428 * @return string html of an unordered list
429 */
430function html_buildlist($data, $class, $func, $lifunc = null, $forcewrapper = false) {
431    if ($data === []) {
432        return '';
433    }
434
435    $firstElement = reset($data);
436    $start_level = $firstElement['level'];
437    $level = $start_level;
438    $html  = '';
439    $open  = 0;
440
441    // set callback function to build the <li> tag, formerly defined as html_li_default()
442    if (!is_callable($lifunc)) {
443       $lifunc = static fn($item) => '<li class="level'.$item['level'].'">';
444    }
445
446    foreach ($data as $item) {
447        if ($item['level'] > $level) {
448            //open new list
449            for ($i = 0; $i < ($item['level'] - $level); $i++) {
450                if ($i) $html .= '<li class="clear">';
451                $html .= "\n".'<ul class="'.$class.'">'."\n";
452                $open++;
453            }
454            $level = $item['level'];
455
456        } elseif ($item['level'] < $level) {
457            //close last item
458            $html .= '</li>'."\n";
459            while ($level > $item['level'] && $open > 0 ) {
460                //close higher lists
461                $html .= '</ul>'."\n".'</li>'."\n";
462                $level--;
463                $open--;
464            }
465        } elseif ($html !== '') {
466            //close previous item
467            $html .= '</li>'."\n";
468        }
469
470        //print item
471        $html .= call_user_func($lifunc, $item);
472        $html .= '<div class="li">';
473
474        $html .= call_user_func($func, $item);
475        $html .= '</div>';
476    }
477
478    //close remaining items and lists
479    $html .= '</li>'."\n";
480    while ($open-- > 0) {
481        $html .= '</ul></li>'."\n";
482    }
483
484    if ($forcewrapper || $start_level < 2) {
485        // Trigger building a wrapper ul if the first level is
486        // 0 (we have a root object) or 1 (just the root content)
487        $html = "\n".'<ul class="'.$class.'">'."\n".$html.'</ul>'."\n";
488    }
489
490    return $html;
491}
492
493/**
494 * display backlinks
495 *
496 * @author Andreas Gohr <andi@splitbrain.org>
497 * @author Michael Klier <chi@chimeric.de>
498 * @deprecated 2020-07-18
499 */
500function html_backlinks() {
501    dbg_deprecated(Backlinks::class .'::show()');
502    (new Backlinks)->show();
503}
504
505/**
506 * Get header of diff HTML
507 *
508 * @param string $l_rev   Left revisions
509 * @param string $r_rev   Right revision
510 * @param string $id      Page id, if null $ID is used
511 * @param bool   $media   If it is for media files
512 * @param bool   $inline  Return the header on a single line
513 * @return string[] HTML snippets for diff header
514 * @deprecated 2020-07-18
515 */
516function html_diff_head($l_rev, $r_rev, $id = null, $media = false, $inline = false) {
517    dbg_deprecated('see '. PageDiff::class .'::buildDiffHead()');
518    return ['', '', '', ''];
519}
520
521/**
522 * Show diff
523 * between current page version and provided $text
524 * or between the revisions provided via GET or POST
525 *
526 * @author Andreas Gohr <andi@splitbrain.org>
527 * @param  string $text  when non-empty: compare with this text with most current version
528 * @param  bool   $intro display the intro text
529 * @param  string $type  type of the diff (inline or sidebyside)
530 * @deprecated 2020-07-18
531 */
532function html_diff($text = '', $intro = true, $type = null) {
533    dbg_deprecated(PageDiff::class .'::show()');
534    global $INFO;
535    (new PageDiff($INFO['id']))->compareWith($text)->preference([
536        'showIntro' => $intro,
537        'difftype'  => $type,
538    ])->show();
539}
540
541/**
542 * Create html for revision navigation
543 *
544 * @param PageChangeLog $pagelog changelog object of current page
545 * @param string        $type    inline vs sidebyside
546 * @param int           $l_rev   left revision timestamp
547 * @param int           $r_rev   right revision timestamp
548 * @return string[] html of left and right navigation elements
549 * @deprecated 2020-07-18
550 */
551function html_diff_navigation($pagelog, $type, $l_rev, $r_rev) {
552    dbg_deprecated('see '. PageDiff::class .'::buildRevisionsNavigation()');
553    return ['', ''];
554}
555
556/**
557 * Create html link to a diff defined by two revisions
558 *
559 * @param string $difftype display type
560 * @param string $linktype
561 * @param int $lrev oldest revision
562 * @param int $rrev newest revision or null for diff with current revision
563 * @return string html of link to a diff
564 * @deprecated 2020-07-18
565 */
566function html_diff_navigationlink($difftype, $linktype, $lrev, $rrev = null) {
567    dbg_deprecated('see '. PageDiff::class .'::diffViewlink()');
568    return '';
569}
570
571/**
572 * Insert soft breaks in diff html
573 *
574 * @param string $diffhtml
575 * @return string
576 * @deprecated 2020-07-18
577 */
578function html_insert_softbreaks($diffhtml) {
579    dbg_deprecated(PageDiff::class .'::insertSoftbreaks()');
580    return (new PageDiff)->insertSoftbreaks($diffhtml);
581}
582
583/**
584 * show warning on conflict detection
585 *
586 * @author Andreas Gohr <andi@splitbrain.org>
587 *
588 * @param string $text
589 * @param string $summary
590 * @deprecated 2020-07-18
591 */
592function html_conflict($text, $summary) {
593    dbg_deprecated(PageConflict::class .'::show()');
594    (new PageConflict($text, $summary))->show();
595}
596
597/**
598 * Prints the global message array
599 *
600 * @author Andreas Gohr <andi@splitbrain.org>
601 */
602function html_msgarea() {
603    global $MSG, $MSG_shown;
604    /** @var array $MSG */
605    // store if the global $MSG has already been shown and thus HTML output has been started
606    $MSG_shown = true;
607
608    if (!isset($MSG)) return;
609
610    $shown = [];
611    foreach ($MSG as $msg) {
612        $hash = md5($msg['msg']);
613        if (isset($shown[$hash])) continue; // skip double messages
614        if (info_msg_allowed($msg)) {
615            print '<div class="'.$msg['lvl'].'">';
616            print $msg['msg'];
617            print '</div>';
618        }
619        $shown[$hash] = 1;
620    }
621
622    unset($GLOBALS['MSG']);
623}
624
625/**
626 * Prints the registration form
627 *
628 * @author Andreas Gohr <andi@splitbrain.org>
629 * @deprecated 2020-07-18
630 */
631function html_register() {
632    dbg_deprecated(UserRegister::class .'::show()');
633    (new UserRegister)->show();
634}
635
636/**
637 * Print the update profile form
638 *
639 * @author Christopher Smith <chris@jalakai.co.uk>
640 * @author Andreas Gohr <andi@splitbrain.org>
641 * @deprecated 2020-07-18
642 */
643function html_updateprofile() {
644    dbg_deprecated(UserProfile::class .'::show()');
645    (new UserProfile)->show();
646}
647
648/**
649 * Preprocess edit form data
650 *
651 * @author   Andreas Gohr <andi@splitbrain.org>
652 *
653 * @deprecated 2020-07-18
654 */
655function html_edit() {
656    dbg_deprecated(Editor::class .'::show()');
657    (new Editor)->show();
658}
659
660/**
661 * Display the default edit form
662 *
663 * Is the default action for HTML_EDIT_FORMSELECTION.
664 *
665 * @param array $param
666 * @deprecated 2020-07-18
667 */
668function html_edit_form($param) {
669    dbg_deprecated(Editor::class .'::addTextarea()');
670    (new Editor)->addTextarea($param);
671}
672
673/**
674 * prints some debug info
675 *
676 * @author Andreas Gohr <andi@splitbrain.org>
677 */
678function html_debug() {
679    global $conf;
680    global $lang;
681    /** @var AuthPlugin $auth */
682    global $auth;
683    global $INFO;
684
685    //remove sensitive data
686    $cnf = $conf;
687    debug_guard($cnf);
688    $nfo = $INFO;
689    debug_guard($nfo);
690    $ses = $_SESSION;
691    debug_guard($ses);
692
693    print '<html><body>';
694
695    print '<p>When reporting bugs please send all the following ';
696    print 'output as a mail to andi@splitbrain.org ';
697    print 'The best way to do this is to save this page in your browser</p>';
698
699    print '<b>$INFO:</b><pre>';
700    print_r($nfo);
701    print '</pre>';
702
703    print '<b>$_SERVER:</b><pre>';
704    print_r($_SERVER);
705    print '</pre>';
706
707    print '<b>$conf:</b><pre>';
708    print_r($cnf);
709    print '</pre>';
710
711    print '<b>DOKU_BASE:</b><pre>';
712    print DOKU_BASE;
713    print '</pre>';
714
715    print '<b>abs DOKU_BASE:</b><pre>';
716    print DOKU_URL;
717    print '</pre>';
718
719    print '<b>rel DOKU_BASE:</b><pre>';
720    print dirname($_SERVER['PHP_SELF']).'/';
721    print '</pre>';
722
723    print '<b>PHP Version:</b><pre>';
724    print phpversion();
725    print '</pre>';
726
727    print '<b>locale:</b><pre>';
728    print setlocale(LC_ALL, 0);
729    print '</pre>';
730
731    print '<b>encoding:</b><pre>';
732    print $lang['encoding'];
733    print '</pre>';
734
735    if ($auth) {
736        print '<b>Auth backend capabilities:</b><pre>';
737        foreach ($auth->getCapabilities() as $cando) {
738            print '   '.str_pad($cando, 16) .' => '. (int)$auth->canDo($cando) . DOKU_LF;
739        }
740        print '</pre>';
741    }
742
743    print '<b>$_SESSION:</b><pre>';
744    print_r($ses);
745    print '</pre>';
746
747    print '<b>Environment:</b><pre>';
748    print_r($_ENV);
749    print '</pre>';
750
751    print '<b>PHP settings:</b><pre>';
752    $inis = ini_get_all();
753    print_r($inis);
754    print '</pre>';
755
756    if (function_exists('apache_get_version')) {
757        $apache = [];
758        $apache['version'] = apache_get_version();
759
760        if (function_exists('apache_get_modules')) {
761            $apache['modules'] = apache_get_modules();
762        }
763        print '<b>Apache</b><pre>';
764        print_r($apache);
765        print '</pre>';
766    }
767
768    print '</body></html>';
769}
770
771/**
772 * Form to request a new password for an existing account
773 *
774 * @author Benoit Chesneau <benoit@bchesneau.info>
775 * @author Andreas Gohr <gohr@cosmocode.de>
776 * @deprecated 2020-07-18
777 */
778function html_resendpwd() {
779    dbg_deprecated(UserResendPwd::class .'::show()');
780    (new UserResendPwd)->show();
781}
782
783/**
784 * Return the TOC rendered to XHTML
785 *
786 * @author Andreas Gohr <andi@splitbrain.org>
787 *
788 * @param array $toc
789 * @return string html
790 */
791function html_TOC($toc) {
792    if ($toc === []) return '';
793    global $lang;
794    $out  = '<!-- TOC START -->'.DOKU_LF;
795    $out .= '<div id="dw__toc" class="dw__toc">'.DOKU_LF;
796    $out .= '<h3 class="toggle">';
797    $out .= $lang['toc'];
798    $out .= '</h3>'.DOKU_LF;
799    $out .= '<div>'.DOKU_LF;
800    $out .= html_buildlist($toc, 'toc', 'html_list_toc', null, true);
801    $out .= '</div>'.DOKU_LF.'</div>'.DOKU_LF;
802    $out .= '<!-- TOC END -->'.DOKU_LF;
803    return $out;
804}
805
806/**
807 * Callback for html_buildlist
808 *
809 * @param array $item
810 * @return string html
811 */
812function html_list_toc($item) {
813    if (isset($item['hid'])){
814        $link = '#'.$item['hid'];
815    } else {
816        $link = $item['link'];
817    }
818
819    return '<a href="'.$link.'">'.hsc($item['title']).'</a>';
820}
821
822/**
823 * Helper function to build TOC items
824 *
825 * Returns an array ready to be added to a TOC array
826 *
827 * @param string $link  - where to link (if $hash set to '#' it's a local anchor)
828 * @param string $text  - what to display in the TOC
829 * @param int    $level - nesting level
830 * @param string $hash  - is prepended to the given $link, set blank if you want full links
831 * @return array the toc item
832 */
833function html_mktocitem($link, $text, $level, $hash='#') {
834    return  [
835        'link'  => $hash.$link,
836        'title' => $text,
837        'type'  => 'ul',
838        'level' => $level
839    ];
840}
841
842/**
843 * Output a Doku_Form object.
844 * Triggers an event with the form name: HTML_{$name}FORM_OUTPUT
845 *
846 * @author Tom N Harris <tnharris@whoopdedo.org>
847 *
848 * @param string     $name The name of the form
849 * @param Doku_Form  $form The form
850 * @return void
851 * @deprecated 2020-07-18
852 */
853function html_form($name, $form) {
854    dbg_deprecated('use dokuwiki\Form\Form instead of Doku_Form');
855    // Safety check in case the caller forgets.
856    $form->endFieldset();
857    Event::createAndTrigger('HTML_'.strtoupper($name).'FORM_OUTPUT', $form, 'html_form_output', false);
858}
859
860/**
861 * Form print function.
862 * Just calls printForm() on the form object.
863 *
864 * @param Doku_Form $form The form
865 * @return void
866 * @deprecated 2020-07-18
867 */
868function html_form_output($form) {
869    dbg_deprecated('use ' . Form::class . '::toHTML()');
870    $form->printForm();
871}
872
873/**
874 * Embed a flash object in HTML
875 *
876 * This will create the needed HTML to embed a flash movie in a cross browser
877 * compatble way using valid XHTML
878 *
879 * The parameters $params, $flashvars and $atts need to be associative arrays.
880 * No escaping needs to be done for them. The alternative content *has* to be
881 * escaped because it is used as is. If no alternative content is given
882 * $lang['noflash'] is used.
883 *
884 * @author Andreas Gohr <andi@splitbrain.org>
885 * @link   http://latrine.dgx.cz/how-to-correctly-insert-a-flash-into-xhtml
886 *
887 * @param string $swf      - the SWF movie to embed
888 * @param int $width       - width of the flash movie in pixels
889 * @param int $height      - height of the flash movie in pixels
890 * @param array $params    - additional parameters (<param>)
891 * @param array $flashvars - parameters to be passed in the flashvar parameter
892 * @param array $atts      - additional attributes for the <object> tag
893 * @param string $alt      - alternative content (is NOT automatically escaped!)
894 * @return string         - the XHTML markup
895 */
896function html_flashobject($swf,$width,$height,$params=null,$flashvars=null,$atts=null,$alt=''){
897    global $lang;
898
899    $out = '';
900
901    // prepare the object attributes
902    if(is_null($atts)) $atts = [];
903    $atts['width']  = (int) $width;
904    $atts['height'] = (int) $height;
905    if(!$atts['width'])  $atts['width']  = 425;
906    if(!$atts['height']) $atts['height'] = 350;
907
908    // add object attributes for standard compliant browsers
909    $std = $atts;
910    $std['type'] = 'application/x-shockwave-flash';
911    $std['data'] = $swf;
912
913    // add object attributes for IE
914    $ie  = $atts;
915    $ie['classid'] = 'clsid:D27CDB6E-AE6D-11cf-96B8-444553540000';
916
917    // open object (with conditional comments)
918    $out .= '<!--[if !IE]> -->'.NL;
919    $out .= '<object '.buildAttributes($std).'>'.NL;
920    $out .= '<!-- <![endif]-->'.NL;
921    $out .= '<!--[if IE]>'.NL;
922    $out .= '<object '.buildAttributes($ie).'>'.NL;
923    $out .= '    <param name="movie" value="'.hsc($swf).'" />'.NL;
924    $out .= '<!--><!-- -->'.NL;
925
926    // print params
927    if(is_array($params)) foreach($params as $key => $val){
928        $out .= '  <param name="'.hsc($key).'" value="'.hsc($val).'" />'.NL;
929    }
930
931    // add flashvars
932    if(is_array($flashvars)){
933        $out .= '  <param name="FlashVars" value="'.buildURLparams($flashvars).'" />'.NL;
934    }
935
936    // alternative content
937    if($alt){
938        $out .= $alt.NL;
939    }else{
940        $out .= $lang['noflash'].NL;
941    }
942
943    // finish
944    $out .= '</object>'.NL;
945    $out .= '<!-- <![endif]-->'.NL;
946
947    return $out;
948}
949
950/**
951 * Prints HTML code for the given tab structure
952 *
953 * @param array  $tabs        tab structure
954 * @param string $current_tab the current tab id
955 * @return void
956 */
957function html_tabs($tabs, $current_tab = null) {
958    echo '<ul class="tabs">'.NL;
959
960    foreach ($tabs as $id => $tab) {
961        html_tab($tab['href'], $tab['caption'], $id === $current_tab);
962    }
963
964    echo '</ul>'.NL;
965}
966
967/**
968 * Prints a single tab
969 *
970 * @author Kate Arzamastseva <pshns@ukr.net>
971 * @author Adrian Lang <mail@adrianlang.de>
972 *
973 * @param string $href - tab href
974 * @param string $caption - tab caption
975 * @param boolean $selected - is tab selected
976 * @return void
977 */
978
979function html_tab($href, $caption, $selected = false) {
980    $tab = '<li>';
981    if ($selected) {
982        $tab .= '<strong>';
983    } else {
984        $tab .= '<a href="' . hsc($href) . '">';
985    }
986    $tab .= hsc($caption)
987         .  '</' . ($selected ? 'strong' : 'a') . '>'
988         .  '</li>'.NL;
989    echo $tab;
990}
991
992/**
993 * Display size change
994 *
995 * @param int $sizechange - size of change in Bytes
996 * @param Doku_Form $form - (optional) form to add elements to
997 * @return void|string
998 */
999function html_sizechange($sizechange, $form = null) {
1000    if (isset($sizechange)) {
1001        $class = 'sizechange';
1002        $value = filesize_h(abs($sizechange));
1003        if ($sizechange > 0) {
1004            $class .= ' positive';
1005            $value = '+' . $value;
1006        } elseif ($sizechange < 0) {
1007            $class .= ' negative';
1008            $value = '-' . $value;
1009        } else {
1010            $value = '±' . $value;
1011        }
1012        if (!isset($form)) {
1013            return '<span class="'.$class.'">'.$value.'</span>';
1014        } else { // Doku_Form
1015            $form->addElement(form_makeOpenTag('span', ['class' => $class]));
1016            $form->addElement($value);
1017            $form->addElement(form_makeCloseTag('span'));
1018        }
1019    }
1020}
1021