xref: /dokuwiki/inc/parser/xhtml.php (revision 3641199a253e8f92f378f03926af80724ef04146) 
1<?php
2/**
3 * Renderer for XHTML output
4 *
5 * @author Harry Fuecks <hfuecks@gmail.com>
6 * @author Andreas Gohr <andi@splitbrain.org>
7 */
8if(!defined('DOKU_INC')) die('meh.');
9
10if ( !defined('DOKU_LF') ) {
11    // Some whitespace to help View > Source
12    define ('DOKU_LF',"\n");
13}
14
15if ( !defined('DOKU_TAB') ) {
16    // Some whitespace to help View > Source
17    define ('DOKU_TAB',"\t");
18}
19
20require_once DOKU_INC . 'inc/parser/renderer.php';
21require_once DOKU_INC . 'inc/html.php';
22
23/**
24 * The Renderer
25 */
26class Doku_Renderer_xhtml extends Doku_Renderer {
27
28    // @access public
29    var $doc = '';        // will contain the whole document
30    var $toc = array();   // will contain the Table of Contents
31
32    var $sectionedits = array(); // A stack of section edit data
33    private $lastsecid = 0; // last section edit id, used by startSectionEdit
34
35    var $headers = array();
36    /** @var array a list of footnotes, list starts at 1! */
37    var $footnotes = array();
38    var $lastlevel = 0;
39    var $node = array(0,0,0,0,0);
40    var $store = '';
41
42    var $_counter   = array(); // used as global counter, introduced for table classes
43    var $_codeblock = 0; // counts the code and file blocks, used to provide download links
44
45    /**
46     * Register a new edit section range
47     *
48     * @param $type  string The section type identifier
49     * @param $title string The section title
50     * @param $start int    The byte position for the edit start
51     * @return string A marker class for the starting HTML element
52     * @author Adrian Lang <lang@cosmocode.de>
53     */
54    public function startSectionEdit($start, $type, $title = null) {
55        $this->sectionedits[] = array(++$this->lastsecid, $start, $type, $title);
56        return 'sectionedit' . $this->lastsecid;
57    }
58
59    /**
60     * Finish an edit section range
61     *
62     * @param $end int The byte position for the edit end; null for the rest of
63     *                 the page
64     * @author Adrian Lang <lang@cosmocode.de>
65     */
66    public function finishSectionEdit($end = null) {
67        list($id, $start, $type, $title) = array_pop($this->sectionedits);
68        if (!is_null($end) && $end <= $start) {
69            return;
70        }
71        $this->doc .= "<!-- EDIT$id " . strtoupper($type) . ' ';
72        if (!is_null($title)) {
73            $this->doc .= '"' . str_replace('"', '', $title) . '" ';
74        }
75        $this->doc .= "[$start-" . (is_null($end) ? '' : $end) . '] -->';
76    }
77
78    function getFormat(){
79        return 'xhtml';
80    }
81
82
83    function document_start() {
84        //reset some internals
85        $this->toc     = array();
86        $this->headers = array();
87    }
88
89    function document_end() {
90        // Finish open section edits.
91        while (count($this->sectionedits) > 0) {
92            if ($this->sectionedits[count($this->sectionedits) - 1][1] <= 1) {
93                // If there is only one section, do not write a section edit
94                // marker.
95                array_pop($this->sectionedits);
96            } else {
97                $this->finishSectionEdit();
98            }
99        }
100
101        if ( count ($this->footnotes) > 0 ) {
102            $this->doc .= '<div class="footnotes">'.DOKU_LF;
103
104            foreach ( $this->footnotes as $id => $footnote ) {
105                // check its not a placeholder that indicates actual footnote text is elsewhere
106                if (substr($footnote, 0, 5) != "@@FNT") {
107
108                    // open the footnote and set the anchor and backlink
109                    $this->doc .= '<div class="fn">';
110                    $this->doc .= '<sup><a href="#fnt__'.$id.'" id="fn__'.$id.'" class="fn_bot">';
111                    $this->doc .= $id.')</a></sup> '.DOKU_LF;
112
113                    // get any other footnotes that use the same markup
114                    $alt = array_keys($this->footnotes, "@@FNT$id");
115
116                    if (count($alt)) {
117                        foreach ($alt as $ref) {
118                            // set anchor and backlink for the other footnotes
119                            $this->doc .= ', <sup><a href="#fnt__'.($ref).'" id="fn__'.($ref).'" class="fn_bot">';
120                            $this->doc .= ($ref).')</a></sup> '.DOKU_LF;
121                        }
122                    }
123
124                    // add footnote markup and close this footnote
125                    $this->doc .= $footnote;
126                    $this->doc .= '</div>' . DOKU_LF;
127                }
128            }
129            $this->doc .= '</div>'.DOKU_LF;
130        }
131
132        // Prepare the TOC
133        global $conf;
134        if($this->info['toc'] && is_array($this->toc) && $conf['tocminheads'] && count($this->toc) >= $conf['tocminheads']){
135            global $TOC;
136            $TOC = $this->toc;
137        }
138
139        // make sure there are no empty paragraphs
140        $this->doc = preg_replace('#<p>\s*</p>#','',$this->doc);
141    }
142
143    function toc_additem($id, $text, $level) {
144        global $conf;
145
146        //handle TOC
147        if($level >= $conf['toptoclevel'] && $level <= $conf['maxtoclevel']){
148            $this->toc[] = html_mktocitem($id, $text, $level-$conf['toptoclevel']+1);
149        }
150    }
151
152    function header($text, $level, $pos) {
153        global $conf;
154
155        if(!$text) return; //skip empty headlines
156
157        $hid = $this->_headerToLink($text,true);
158
159        //only add items within configured levels
160        $this->toc_additem($hid, $text, $level);
161
162        // adjust $node to reflect hierarchy of levels
163        $this->node[$level-1]++;
164        if ($level < $this->lastlevel) {
165            for ($i = 0; $i < $this->lastlevel-$level; $i++) {
166                $this->node[$this->lastlevel-$i-1] = 0;
167            }
168        }
169        $this->lastlevel = $level;
170
171        if ($level <= $conf['maxseclevel'] &&
172            count($this->sectionedits) > 0 &&
173            $this->sectionedits[count($this->sectionedits) - 1][2] === 'section') {
174            $this->finishSectionEdit($pos - 1);
175        }
176
177        // write the header
178        $this->doc .= DOKU_LF.'<h'.$level;
179        if ($level <= $conf['maxseclevel']) {
180            $this->doc .= ' class="' . $this->startSectionEdit($pos, 'section', $text) . '"';
181        }
182        $this->doc .= ' id="'.$hid.'">';
183        $this->doc .= $this->_xmlEntities($text);
184        $this->doc .= "</h$level>".DOKU_LF;
185    }
186
187    function section_open($level) {
188        $this->doc .= '<div class="level' . $level . '">' . DOKU_LF;
189    }
190
191    function section_close() {
192        $this->doc .= DOKU_LF.'</div>'.DOKU_LF;
193    }
194
195    function cdata($text) {
196        $this->doc .= $this->_xmlEntities($text);
197    }
198
199    function p_open() {
200        $this->doc .= DOKU_LF.'<p>'.DOKU_LF;
201    }
202
203    function p_close() {
204        $this->doc .= DOKU_LF.'</p>'.DOKU_LF;
205    }
206
207    function linebreak() {
208        $this->doc .= '<br/>'.DOKU_LF;
209    }
210
211    function hr() {
212        $this->doc .= '<hr />'.DOKU_LF;
213    }
214
215    function strong_open() {
216        $this->doc .= '<strong>';
217    }
218
219    function strong_close() {
220        $this->doc .= '</strong>';
221    }
222
223    function emphasis_open() {
224        $this->doc .= '<em>';
225    }
226
227    function emphasis_close() {
228        $this->doc .= '</em>';
229    }
230
231    function underline_open() {
232        $this->doc .= '<em class="u">';
233    }
234
235    function underline_close() {
236        $this->doc .= '</em>';
237    }
238
239    function monospace_open() {
240        $this->doc .= '<code>';
241    }
242
243    function monospace_close() {
244        $this->doc .= '</code>';
245    }
246
247    function subscript_open() {
248        $this->doc .= '<sub>';
249    }
250
251    function subscript_close() {
252        $this->doc .= '</sub>';
253    }
254
255    function superscript_open() {
256        $this->doc .= '<sup>';
257    }
258
259    function superscript_close() {
260        $this->doc .= '</sup>';
261    }
262
263    function deleted_open() {
264        $this->doc .= '<del>';
265    }
266
267    function deleted_close() {
268        $this->doc .= '</del>';
269    }
270
271    /**
272     * Callback for footnote start syntax
273     *
274     * All following content will go to the footnote instead of
275     * the document. To achieve this the previous rendered content
276     * is moved to $store and $doc is cleared
277     *
278     * @author Andreas Gohr <andi@splitbrain.org>
279     */
280    function footnote_open() {
281
282        // move current content to store and record footnote
283        $this->store = $this->doc;
284        $this->doc   = '';
285    }
286
287    /**
288     * Callback for footnote end syntax
289     *
290     * All rendered content is moved to the $footnotes array and the old
291     * content is restored from $store again
292     *
293     * @author Andreas Gohr
294     */
295    function footnote_close() {
296        /** @var $fnid int takes track of seen footnotes, assures they are unique even across multiple docs FS#2841 */
297        static $fnid = 0;
298        // assign new footnote id (we start at 1)
299        $fnid++;
300
301        // recover footnote into the stack and restore old content
302        $footnote = $this->doc;
303        $this->doc = $this->store;
304        $this->store = '';
305
306        // check to see if this footnote has been seen before
307        $i = array_search($footnote, $this->footnotes);
308
309        if ($i === false) {
310            // its a new footnote, add it to the $footnotes array
311            $this->footnotes[$fnid] = $footnote;
312        } else {
313            // seen this one before, save a placeholder
314            $this->footnotes[$fnid] = "@@FNT".($i);
315        }
316
317        // output the footnote reference and link
318        $this->doc .= '<sup><a href="#fn__'.$fnid.'" id="fnt__'.$fnid.'" class="fn_top">'.$fnid.')</a></sup>';
319    }
320
321    function listu_open() {
322        $this->doc .= '<ul>'.DOKU_LF;
323    }
324
325    function listu_close() {
326        $this->doc .= '</ul>'.DOKU_LF;
327    }
328
329    function listo_open() {
330        $this->doc .= '<ol>'.DOKU_LF;
331    }
332
333    function listo_close() {
334        $this->doc .= '</ol>'.DOKU_LF;
335    }
336
337    function listitem_open($level) {
338        $this->doc .= '<li class="level'.$level.'">';
339    }
340
341    function listitem_close() {
342        $this->doc .= '</li>'.DOKU_LF;
343    }
344
345    function listcontent_open() {
346        $this->doc .= '<div class="li">';
347    }
348
349    function listcontent_close() {
350        $this->doc .= '</div>'.DOKU_LF;
351    }
352
353    function unformatted($text) {
354        $this->doc .= $this->_xmlEntities($text);
355    }
356
357    /**
358     * Execute PHP code if allowed
359     *
360     * @param  string   $text      PHP code that is either executed or printed
361     * @param  string   $wrapper   html element to wrap result if $conf['phpok'] is okff
362     *
363     * @author Andreas Gohr <andi@splitbrain.org>
364     */
365    function php($text, $wrapper='code') {
366        global $conf;
367
368        if($conf['phpok']){
369            ob_start();
370            eval($text);
371            $this->doc .= ob_get_contents();
372            ob_end_clean();
373        } else {
374            $this->doc .= p_xhtml_cached_geshi($text, 'php', $wrapper);
375        }
376    }
377
378    function phpblock($text) {
379        $this->php($text, 'pre');
380    }
381
382    /**
383     * Insert HTML if allowed
384     *
385     * @param  string   $text      html text
386     * @param  string   $wrapper   html element to wrap result if $conf['htmlok'] is okff
387     *
388     * @author Andreas Gohr <andi@splitbrain.org>
389     */
390    function html($text, $wrapper='code') {
391        global $conf;
392
393        if($conf['htmlok']){
394            $this->doc .= $text;
395        } else {
396            $this->doc .= p_xhtml_cached_geshi($text, 'html4strict', $wrapper);
397        }
398    }
399
400    function htmlblock($text) {
401        $this->html($text, 'pre');
402    }
403
404    function quote_open() {
405        $this->doc .= '<blockquote><div class="no">'.DOKU_LF;
406    }
407
408    function quote_close() {
409        $this->doc .= '</div></blockquote>'.DOKU_LF;
410    }
411
412    function preformatted($text) {
413        $this->doc .= '<pre class="code">' . trim($this->_xmlEntities($text),"\n\r") . '</pre>'. DOKU_LF;
414    }
415
416    function file($text, $language=null, $filename=null) {
417        $this->_highlight('file',$text,$language,$filename);
418    }
419
420    function code($text, $language=null, $filename=null) {
421        $this->_highlight('code',$text,$language,$filename);
422    }
423
424    /**
425     * Use GeSHi to highlight language syntax in code and file blocks
426     *
427     * @author Andreas Gohr <andi@splitbrain.org>
428     */
429    function _highlight($type, $text, $language=null, $filename=null) {
430        global $conf;
431        global $ID;
432        global $lang;
433
434        if($filename){
435            // add icon
436            list($ext) = mimetype($filename,false);
437            $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
438            $class = 'mediafile mf_'.$class;
439
440            $this->doc .= '<dl class="'.$type.'">'.DOKU_LF;
441            $this->doc .= '<dt><a href="'.exportlink($ID,'code',array('codeblock'=>$this->_codeblock)).'" title="'.$lang['download'].'" class="'.$class.'">';
442            $this->doc .= hsc($filename);
443            $this->doc .= '</a></dt>'.DOKU_LF.'<dd>';
444        }
445
446        if ($text{0} == "\n") {
447            $text = substr($text, 1);
448        }
449        if (substr($text, -1) == "\n") {
450            $text = substr($text, 0, -1);
451        }
452
453        if ( is_null($language) ) {
454            $this->doc .= '<pre class="'.$type.'">'.$this->_xmlEntities($text).'</pre>'.DOKU_LF;
455        } else {
456            $class = 'code'; //we always need the code class to make the syntax highlighting apply
457            if($type != 'code') $class .= ' '.$type;
458
459            $this->doc .= "<pre class=\"$class $language\">".p_xhtml_cached_geshi($text, $language, '').'</pre>'.DOKU_LF;
460        }
461
462        if($filename){
463            $this->doc .= '</dd></dl>'.DOKU_LF;
464        }
465
466        $this->_codeblock++;
467    }
468
469    function acronym($acronym) {
470
471        if ( array_key_exists($acronym, $this->acronyms) ) {
472
473            $title = $this->_xmlEntities($this->acronyms[$acronym]);
474
475            $this->doc .= '<abbr title="'.$title
476                .'">'.$this->_xmlEntities($acronym).'</abbr>';
477
478        } else {
479            $this->doc .= $this->_xmlEntities($acronym);
480        }
481    }
482
483    function smiley($smiley) {
484        if ( array_key_exists($smiley, $this->smileys) ) {
485            $title = $this->_xmlEntities($this->smileys[$smiley]);
486            $this->doc .= '<img src="'.DOKU_BASE.'lib/images/smileys/'.$this->smileys[$smiley].
487                '" class="icon" alt="'.
488                    $this->_xmlEntities($smiley).'" />';
489        } else {
490            $this->doc .= $this->_xmlEntities($smiley);
491        }
492    }
493
494    /*
495    * not used
496    function wordblock($word) {
497        if ( array_key_exists($word, $this->badwords) ) {
498            $this->doc .= '** BLEEP **';
499        } else {
500            $this->doc .= $this->_xmlEntities($word);
501        }
502    }
503    */
504
505    function entity($entity) {
506        if ( array_key_exists($entity, $this->entities) ) {
507            $this->doc .= $this->entities[$entity];
508        } else {
509            $this->doc .= $this->_xmlEntities($entity);
510        }
511    }
512
513    function multiplyentity($x, $y) {
514        $this->doc .= "$x&times;$y";
515    }
516
517    function singlequoteopening() {
518        global $lang;
519        $this->doc .= $lang['singlequoteopening'];
520    }
521
522    function singlequoteclosing() {
523        global $lang;
524        $this->doc .= $lang['singlequoteclosing'];
525    }
526
527    function apostrophe() {
528        global $lang;
529        $this->doc .= $lang['apostrophe'];
530    }
531
532    function doublequoteopening() {
533        global $lang;
534        $this->doc .= $lang['doublequoteopening'];
535    }
536
537    function doublequoteclosing() {
538        global $lang;
539        $this->doc .= $lang['doublequoteclosing'];
540    }
541
542    /**
543     */
544    function camelcaselink($link) {
545        $this->internallink($link,$link);
546    }
547
548
549    function locallink($hash, $name = null){
550        global $ID;
551        $name  = $this->_getLinkTitle($name, $hash, $isImage);
552        $hash  = $this->_headerToLink($hash);
553        $title = $ID.' ↵';
554        $this->doc .= '<a href="#'.$hash.'" title="'.$title.'" class="wikilink1">';
555        $this->doc .= $name;
556        $this->doc .= '</a>';
557    }
558
559    /**
560     * Render an internal Wiki Link
561     *
562     * $search,$returnonly & $linktype are not for the renderer but are used
563     * elsewhere - no need to implement them in other renderers
564     *
565     * @author Andreas Gohr <andi@splitbrain.org>
566     */
567    function internallink($id, $name = null, $search=null,$returnonly=false,$linktype='content') {
568        global $conf;
569        global $ID;
570        global $INFO;
571
572        $params = '';
573        $parts = explode('?', $id, 2);
574        if (count($parts) === 2) {
575            $id = $parts[0];
576            $params = $parts[1];
577        }
578
579        // For empty $id we need to know the current $ID
580        // We need this check because _simpleTitle needs
581        // correct $id and resolve_pageid() use cleanID($id)
582        // (some things could be lost)
583        if ($id === '') {
584            $id = $ID;
585        }
586
587        // default name is based on $id as given
588        $default = $this->_simpleTitle($id);
589
590        // now first resolve and clean up the $id
591        resolve_pageid(getNS($ID),$id,$exists);
592
593        $name = $this->_getLinkTitle($name, $default, $isImage, $id, $linktype);
594        if ( !$isImage ) {
595            if ( $exists ) {
596                $class='wikilink1';
597            } else {
598                $class='wikilink2';
599                $link['rel']='nofollow';
600            }
601        } else {
602            $class='media';
603        }
604
605        //keep hash anchor
606        list($id,$hash) = explode('#',$id,2);
607        if(!empty($hash)) $hash = $this->_headerToLink($hash);
608
609        //prepare for formating
610        $link['target'] = $conf['target']['wiki'];
611        $link['style']  = '';
612        $link['pre']    = '';
613        $link['suf']    = '';
614        // highlight link to current page
615        if ($id == $INFO['id']) {
616            $link['pre']    = '<span class="curid">';
617            $link['suf']    = '</span>';
618        }
619        $link['more']   = '';
620        $link['class']  = $class;
621        $link['url']    = wl($id, $params);
622        $link['name']   = $name;
623        $link['title']  = $id;
624        //add search string
625        if($search){
626            ($conf['userewrite']) ? $link['url'].='?' : $link['url'].='&amp;';
627            if(is_array($search)){
628                $search = array_map('rawurlencode',$search);
629                $link['url'] .= 's[]='.join('&amp;s[]=',$search);
630            }else{
631                $link['url'] .= 's='.rawurlencode($search);
632            }
633        }
634
635        //keep hash
636        if($hash) $link['url'].='#'.$hash;
637
638        //output formatted
639        if($returnonly){
640            return $this->_formatLink($link);
641        }else{
642            $this->doc .= $this->_formatLink($link);
643        }
644    }
645
646    function externallink($url, $name = null) {
647        global $conf;
648
649        $name = $this->_getLinkTitle($name, $url, $isImage);
650
651        // url might be an attack vector, only allow registered protocols
652        if(is_null($this->schemes)) $this->schemes = getSchemes();
653        list($scheme) = explode('://',$url);
654        $scheme = strtolower($scheme);
655        if(!in_array($scheme,$this->schemes)) $url = '';
656
657        // is there still an URL?
658        if(!$url){
659            $this->doc .= $name;
660            return;
661        }
662
663        // set class
664        if ( !$isImage ) {
665            $class='urlextern';
666        } else {
667            $class='media';
668        }
669
670        //prepare for formating
671        $link['target'] = $conf['target']['extern'];
672        $link['style']  = '';
673        $link['pre']    = '';
674        $link['suf']    = '';
675        $link['more']   = '';
676        $link['class']  = $class;
677        $link['url']    = $url;
678
679        $link['name']   = $name;
680        $link['title']  = $this->_xmlEntities($url);
681        if($conf['relnofollow']) $link['more'] .= ' rel="nofollow"';
682
683        //output formatted
684        $this->doc .= $this->_formatLink($link);
685    }
686
687    /**
688    */
689    function interwikilink($match, $name = null, $wikiName, $wikiUri) {
690        global $conf;
691
692        $link = array();
693        $link['target'] = $conf['target']['interwiki'];
694        $link['pre']    = '';
695        $link['suf']    = '';
696        $link['more']   = '';
697        $link['name']   = $this->_getLinkTitle($name, $wikiUri, $isImage);
698
699        //get interwiki URL
700        $url = $this->_resolveInterWiki($wikiName,$wikiUri);
701
702        if ( !$isImage ) {
703            $class = preg_replace('/[^_\-a-z0-9]+/i','_',$wikiName);
704            $link['class'] = "interwiki iw_$class";
705        } else {
706            $link['class'] = 'media';
707        }
708
709        //do we stay at the same server? Use local target
710        if( strpos($url,DOKU_URL) === 0 ){
711            $link['target'] = $conf['target']['wiki'];
712        }
713
714        $link['url'] = $url;
715        $link['title'] = htmlspecialchars($link['url']);
716
717        //output formatted
718        $this->doc .= $this->_formatLink($link);
719    }
720
721    /**
722     */
723    function windowssharelink($url, $name = null) {
724        global $conf;
725        global $lang;
726        //simple setup
727        $link['target'] = $conf['target']['windows'];
728        $link['pre']    = '';
729        $link['suf']   = '';
730        $link['style']  = '';
731
732        $link['name'] = $this->_getLinkTitle($name, $url, $isImage);
733        if ( !$isImage ) {
734            $link['class'] = 'windows';
735        } else {
736            $link['class'] = 'media';
737        }
738
739        $link['title'] = $this->_xmlEntities($url);
740        $url = str_replace('\\','/',$url);
741        $url = 'file:///'.$url;
742        $link['url'] = $url;
743
744        //output formatted
745        $this->doc .= $this->_formatLink($link);
746    }
747
748    function emaillink($address, $name = null) {
749        global $conf;
750        //simple setup
751        $link = array();
752        $link['target'] = '';
753        $link['pre']    = '';
754        $link['suf']   = '';
755        $link['style']  = '';
756        $link['more']   = '';
757
758        $name = $this->_getLinkTitle($name, '', $isImage);
759        if ( !$isImage ) {
760            $link['class']='mail';
761        } else {
762            $link['class']='media';
763        }
764
765        $address = $this->_xmlEntities($address);
766        $address = obfuscate($address);
767        $title   = $address;
768
769        if(empty($name)){
770            $name = $address;
771        }
772
773        if($conf['mailguard'] == 'visible') $address = rawurlencode($address);
774
775        $link['url']   = 'mailto:'.$address;
776        $link['name']  = $name;
777        $link['title'] = $title;
778
779        //output formatted
780        $this->doc .= $this->_formatLink($link);
781    }
782
783    function internalmedia ($src, $title=null, $align=null, $width=null,
784                            $height=null, $cache=null, $linking=null, $return=NULL) {
785        global $ID;
786        list($src,$hash) = explode('#',$src,2);
787        resolve_mediaid(getNS($ID),$src, $exists);
788
789        $noLink = false;
790        $render = ($linking == 'linkonly') ? false : true;
791        $link = $this->_getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render);
792
793        list($ext,$mime,$dl) = mimetype($src,false);
794        if(substr($mime,0,5) == 'image' && $render){
795            $link['url'] = ml($src,array('id'=>$ID,'cache'=>$cache),($linking=='direct'));
796        }elseif(($mime == 'application/x-shockwave-flash' || media_supportedav($mime)) && $render){
797            // don't link movies
798            $noLink = true;
799        }else{
800            // add file icons
801            $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
802            $link['class'] .= ' mediafile mf_'.$class;
803            $link['url'] = ml($src,array('id'=>$ID,'cache'=>$cache),true);
804            if ($exists) $link['title'] .= ' (' . filesize_h(filesize(mediaFN($src))).')';
805        }
806
807        if($hash) $link['url'] .= '#'.$hash;
808
809        //markup non existing files
810        if (!$exists) {
811            $link['class'] .= ' wikilink2';
812        }
813
814        //output formatted
815        if ($return) {
816            if ($linking == 'nolink' || $noLink) return $link['name'];
817            else return $this->_formatLink($link);
818        } else {
819            if ($linking == 'nolink' || $noLink) $this->doc .= $link['name'];
820            else $this->doc .= $this->_formatLink($link);
821        }
822    }
823
824    function externalmedia ($src, $title=null, $align=null, $width=null,
825                            $height=null, $cache=null, $linking=null) {
826        list($src,$hash) = explode('#',$src,2);
827        $noLink = false;
828        $render = ($linking == 'linkonly') ? false : true;
829        $link = $this->_getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render);
830
831        $link['url']    = ml($src,array('cache'=>$cache));
832
833        list($ext,$mime,$dl) = mimetype($src,false);
834        if(substr($mime,0,5) == 'image' && $render){
835            // link only jpeg images
836            // if ($ext != 'jpg' && $ext != 'jpeg') $noLink = true;
837        }elseif(($mime == 'application/x-shockwave-flash' || media_supportedav($mime)) && $render){
838            // don't link movies
839            $noLink = true;
840        }else{
841            // add file icons
842            $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
843            $link['class'] .= ' mediafile mf_'.$class;
844        }
845
846        if($hash) $link['url'] .= '#'.$hash;
847
848        //output formatted
849        if ($linking == 'nolink' || $noLink) $this->doc .= $link['name'];
850        else $this->doc .= $this->_formatLink($link);
851    }
852
853    /**
854     * Renders an RSS feed
855     *
856     * @author Andreas Gohr <andi@splitbrain.org>
857     */
858    function rss ($url,$params){
859        global $lang;
860        global $conf;
861
862        require_once(DOKU_INC.'inc/FeedParser.php');
863        $feed = new FeedParser();
864        $feed->set_feed_url($url);
865
866        //disable warning while fetching
867        if (!defined('DOKU_E_LEVEL')) { $elvl = error_reporting(E_ERROR); }
868        $rc = $feed->init();
869        if (!defined('DOKU_E_LEVEL')) { error_reporting($elvl); }
870
871        //decide on start and end
872        if($params['reverse']){
873            $mod = -1;
874            $start = $feed->get_item_quantity()-1;
875            $end   = $start - ($params['max']);
876            $end   = ($end < -1) ? -1 : $end;
877        }else{
878            $mod   = 1;
879            $start = 0;
880            $end   = $feed->get_item_quantity();
881            $end   = ($end > $params['max']) ? $params['max'] : $end;
882        }
883
884        $this->doc .= '<ul class="rss">';
885        if($rc){
886            for ($x = $start; $x != $end; $x += $mod) {
887                $item = $feed->get_item($x);
888                $this->doc .= '<li><div class="li">';
889                // support feeds without links
890                $lnkurl = $item->get_permalink();
891                if($lnkurl){
892                    // title is escaped by SimplePie, we unescape here because it
893                    // is escaped again in externallink() FS#1705
894                    $this->externallink($item->get_permalink(),
895                                        html_entity_decode($item->get_title(), ENT_QUOTES, 'UTF-8'));
896                }else{
897                    $this->doc .= ' '.$item->get_title();
898                }
899                if($params['author']){
900                    $author = $item->get_author(0);
901                    if($author){
902                        $name = $author->get_name();
903                        if(!$name) $name = $author->get_email();
904                        if($name) $this->doc .= ' '.$lang['by'].' '.$name;
905                    }
906                }
907                if($params['date']){
908                    $this->doc .= ' ('.$item->get_local_date($conf['dformat']).')';
909                }
910                if($params['details']){
911                    $this->doc .= '<div class="detail">';
912                    if($conf['htmlok']){
913                        $this->doc .= $item->get_description();
914                    }else{
915                        $this->doc .= strip_tags($item->get_description());
916                    }
917                    $this->doc .= '</div>';
918                }
919
920                $this->doc .= '</div></li>';
921            }
922        }else{
923            $this->doc .= '<li><div class="li">';
924            $this->doc .= '<em>'.$lang['rssfailed'].'</em>';
925            $this->externallink($url);
926            if($conf['allowdebug']){
927                $this->doc .= '<!--'.hsc($feed->error).'-->';
928            }
929            $this->doc .= '</div></li>';
930        }
931        $this->doc .= '</ul>';
932    }
933
934    // $numrows not yet implemented
935    function table_open($maxcols = null, $numrows = null, $pos = null){
936        global $lang;
937        // initialize the row counter used for classes
938        $this->_counter['row_counter'] = 0;
939        $class = 'table';
940        if ($pos !== null) {
941            $class .= ' ' . $this->startSectionEdit($pos, 'table');
942        }
943        $this->doc .= '<div class="' . $class . '"><table class="inline">' .
944                      DOKU_LF;
945    }
946
947    function table_close($pos = null){
948        $this->doc .= '</table></div>'.DOKU_LF;
949        if ($pos !== null) {
950            $this->finishSectionEdit($pos);
951        }
952    }
953
954    function tablerow_open(){
955        // initialize the cell counter used for classes
956        $this->_counter['cell_counter'] = 0;
957        $class = 'row' . $this->_counter['row_counter']++;
958        $this->doc .= DOKU_TAB . '<tr class="'.$class.'">' . DOKU_LF . DOKU_TAB . DOKU_TAB;
959    }
960
961    function tablerow_close(){
962        $this->doc .= DOKU_LF . DOKU_TAB . '</tr>' . DOKU_LF;
963    }
964
965    function tableheader_open($colspan = 1, $align = null, $rowspan = 1){
966        $class = 'class="col' . $this->_counter['cell_counter']++;
967        if ( !is_null($align) ) {
968            $class .= ' '.$align.'align';
969        }
970        $class .= '"';
971        $this->doc .= '<th ' . $class;
972        if ( $colspan > 1 ) {
973            $this->_counter['cell_counter'] += $colspan-1;
974            $this->doc .= ' colspan="'.$colspan.'"';
975        }
976        if ( $rowspan > 1 ) {
977            $this->doc .= ' rowspan="'.$rowspan.'"';
978        }
979        $this->doc .= '>';
980    }
981
982    function tableheader_close(){
983        $this->doc .= '</th>';
984    }
985
986    function tablecell_open($colspan = 1, $align = null, $rowspan = 1){
987        $class = 'class="col' . $this->_counter['cell_counter']++;
988        if ( !is_null($align) ) {
989            $class .= ' '.$align.'align';
990        }
991        $class .= '"';
992        $this->doc .= '<td '.$class;
993        if ( $colspan > 1 ) {
994            $this->_counter['cell_counter'] += $colspan-1;
995            $this->doc .= ' colspan="'.$colspan.'"';
996        }
997        if ( $rowspan > 1 ) {
998            $this->doc .= ' rowspan="'.$rowspan.'"';
999        }
1000        $this->doc .= '>';
1001    }
1002
1003    function tablecell_close(){
1004        $this->doc .= '</td>';
1005    }
1006
1007    //----------------------------------------------------------
1008    // Utils
1009
1010    /**
1011     * Build a link
1012     *
1013     * Assembles all parts defined in $link returns HTML for the link
1014     *
1015     * @author Andreas Gohr <andi@splitbrain.org>
1016     */
1017    function _formatLink($link){
1018        //make sure the url is XHTML compliant (skip mailto)
1019        if(substr($link['url'],0,7) != 'mailto:'){
1020            $link['url'] = str_replace('&','&amp;',$link['url']);
1021            $link['url'] = str_replace('&amp;amp;','&amp;',$link['url']);
1022        }
1023        //remove double encodings in titles
1024        $link['title'] = str_replace('&amp;amp;','&amp;',$link['title']);
1025
1026        // be sure there are no bad chars in url or title
1027        // (we can't do this for name because it can contain an img tag)
1028        $link['url']   = strtr($link['url'],array('>'=>'%3E','<'=>'%3C','"'=>'%22'));
1029        $link['title'] = strtr($link['title'],array('>'=>'&gt;','<'=>'&lt;','"'=>'&quot;'));
1030
1031        $ret  = '';
1032        $ret .= $link['pre'];
1033        $ret .= '<a href="'.$link['url'].'"';
1034        if(!empty($link['class']))  $ret .= ' class="'.$link['class'].'"';
1035        if(!empty($link['target'])) $ret .= ' target="'.$link['target'].'"';
1036        if(!empty($link['title']))  $ret .= ' title="'.$link['title'].'"';
1037        if(!empty($link['style']))  $ret .= ' style="'.$link['style'].'"';
1038        if(!empty($link['rel']))    $ret .= ' rel="'.$link['rel'].'"';
1039        if(!empty($link['more']))   $ret .= ' '.$link['more'];
1040        $ret .= '>';
1041        $ret .= $link['name'];
1042        $ret .= '</a>';
1043        $ret .= $link['suf'];
1044        return $ret;
1045    }
1046
1047    /**
1048     * Renders internal and external media
1049     *
1050     * @author Andreas Gohr <andi@splitbrain.org>
1051     */
1052    function _media ($src, $title=null, $align=null, $width=null,
1053                      $height=null, $cache=null, $render = true) {
1054
1055        $ret = '';
1056
1057        list($ext,$mime,$dl) = mimetype($src);
1058        if(substr($mime,0,5) == 'image'){
1059            // first get the $title
1060            if (!is_null($title)) {
1061                $title  = $this->_xmlEntities($title);
1062            }elseif($ext == 'jpg' || $ext == 'jpeg'){
1063                //try to use the caption from IPTC/EXIF
1064                require_once(DOKU_INC.'inc/JpegMeta.php');
1065                $jpeg =new JpegMeta(mediaFN($src));
1066                if($jpeg !== false) $cap = $jpeg->getTitle();
1067                if($cap){
1068                    $title = $this->_xmlEntities($cap);
1069                }
1070            }
1071            if (!$render) {
1072                // if the picture is not supposed to be rendered
1073                // return the title of the picture
1074                if (!$title) {
1075                    // just show the sourcename
1076                    $title = $this->_xmlEntities(utf8_basename(noNS($src)));
1077                }
1078                return $title;
1079            }
1080            //add image tag
1081            $ret .= '<img src="'.ml($src,array('w'=>$width,'h'=>$height,'cache'=>$cache)).'"';
1082            $ret .= ' class="media'.$align.'"';
1083
1084            if ($title) {
1085                $ret .= ' title="' . $title . '"';
1086                $ret .= ' alt="'   . $title .'"';
1087            }else{
1088                $ret .= ' alt=""';
1089            }
1090
1091            if ( !is_null($width) )
1092                $ret .= ' width="'.$this->_xmlEntities($width).'"';
1093
1094            if ( !is_null($height) )
1095                $ret .= ' height="'.$this->_xmlEntities($height).'"';
1096
1097            $ret .= ' />';
1098
1099        }elseif(media_supportedav($mime, 'video')){
1100            // first get the $title
1101            if (!is_null($title)) {
1102                $title  = $this->_xmlEntities($title);
1103            }
1104            if (!$title) {
1105                // just show the sourcename
1106                $title = $this->_xmlEntities(utf8_basename(noNS($src)));
1107            }
1108            if (!$render) {
1109                // if the video is not supposed to be rendered
1110                // return the title of the video
1111                return $title;
1112            }
1113
1114            $att = array();
1115            $att['class'] = "media$align";
1116
1117            //add video(s)
1118            $ret .= $this->_video($src, $width, $height, $att);
1119
1120        }elseif(media_supportedav($mime, 'audio')){
1121            // first get the $title
1122            if (!is_null($title)) {
1123                $title  = $this->_xmlEntities($title);
1124            }
1125            if (!$title) {
1126                // just show the sourcename
1127                $title = $this->_xmlEntities(utf8_basename(noNS($src)));
1128            }
1129            if (!$render) {
1130                // if the video is not supposed to be rendered
1131                // return the title of the video
1132                return $title;
1133            }
1134
1135            $att = array();
1136            $att['class'] = "media$align";
1137
1138            //add audio
1139            $ret .= $this->_audio($src, $att);
1140
1141        }elseif($mime == 'application/x-shockwave-flash'){
1142            if (!$render) {
1143                // if the flash is not supposed to be rendered
1144                // return the title of the flash
1145                if (!$title) {
1146                    // just show the sourcename
1147                    $title = utf8_basename(noNS($src));
1148                }
1149                return $this->_xmlEntities($title);
1150            }
1151
1152            $att = array();
1153            $att['class'] = "media$align";
1154            if($align == 'right') $att['align'] = 'right';
1155            if($align == 'left')  $att['align'] = 'left';
1156            $ret .= html_flashobject(ml($src,array('cache'=>$cache),true,'&'),$width,$height,
1157                                     array('quality' => 'high'),
1158                                     null,
1159                                     $att,
1160                                     $this->_xmlEntities($title));
1161        }elseif($title){
1162            // well at least we have a title to display
1163            $ret .= $this->_xmlEntities($title);
1164        }else{
1165            // just show the sourcename
1166            $ret .= $this->_xmlEntities(utf8_basename(noNS($src)));
1167        }
1168
1169        return $ret;
1170    }
1171
1172    function _xmlEntities($string) {
1173        return htmlspecialchars($string,ENT_QUOTES,'UTF-8');
1174    }
1175
1176    /**
1177     * Creates a linkid from a headline
1178     *
1179     * @param string  $title   The headline title
1180     * @param boolean $create  Create a new unique ID?
1181     * @author Andreas Gohr <andi@splitbrain.org>
1182     */
1183    function _headerToLink($title,$create=false) {
1184        if($create){
1185            return sectionID($title,$this->headers);
1186        }else{
1187            $check = false;
1188            return sectionID($title,$check);
1189        }
1190    }
1191
1192    /**
1193     * Construct a title and handle images in titles
1194     *
1195     * @author Harry Fuecks <hfuecks@gmail.com>
1196     */
1197    function _getLinkTitle($title, $default, & $isImage, $id=null, $linktype='content') {
1198        global $conf;
1199
1200        $isImage = false;
1201        if ( is_array($title) ) {
1202            $isImage = true;
1203            return $this->_imageTitle($title);
1204        } elseif ( is_null($title) || trim($title)=='') {
1205            if (useHeading($linktype) && $id) {
1206                $heading = p_get_first_heading($id);
1207                if ($heading) {
1208                    return $this->_xmlEntities($heading);
1209                }
1210            }
1211            return $this->_xmlEntities($default);
1212        } else {
1213            return $this->_xmlEntities($title);
1214        }
1215    }
1216
1217    /**
1218     * Returns an HTML code for images used in link titles
1219     *
1220     * @todo Resolve namespace on internal images
1221     * @author Andreas Gohr <andi@splitbrain.org>
1222     */
1223    function _imageTitle($img) {
1224        global $ID;
1225
1226        // some fixes on $img['src']
1227        // see internalmedia() and externalmedia()
1228        list($img['src'],$hash) = explode('#',$img['src'],2);
1229        if ($img['type'] == 'internalmedia') {
1230            resolve_mediaid(getNS($ID),$img['src'],$exists);
1231        }
1232
1233        return $this->_media($img['src'],
1234                              $img['title'],
1235                              $img['align'],
1236                              $img['width'],
1237                              $img['height'],
1238                              $img['cache']);
1239    }
1240
1241    /**
1242     * _getMediaLinkConf is a helperfunction to internalmedia() and externalmedia()
1243     * which returns a basic link to a media.
1244     *
1245     * @author Pierre Spring <pierre.spring@liip.ch>
1246     * @param string $src
1247     * @param string $title
1248     * @param string $align
1249     * @param string $width
1250     * @param string $height
1251     * @param string $cache
1252     * @param string $render
1253     * @access protected
1254     * @return array
1255     */
1256    function _getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render) {
1257        global $conf;
1258
1259        $link = array();
1260        $link['class']  = 'media';
1261        $link['style']  = '';
1262        $link['pre']    = '';
1263        $link['suf']    = '';
1264        $link['more']   = '';
1265        $link['target'] = $conf['target']['media'];
1266        $link['title']  = $this->_xmlEntities($src);
1267        $link['name']   = $this->_media($src, $title, $align, $width, $height, $cache, $render);
1268
1269        return $link;
1270    }
1271
1272
1273    /**
1274     * Embed video(s) in HTML
1275     *
1276     * @author Anika Henke <anika@selfthinker.org>
1277     *
1278     * @param string $src      - ID of video to embed
1279     * @param int $width       - width of the video in pixels
1280     * @param int $height      - height of the video in pixels
1281     * @param array $atts      - additional attributes for the <video> tag
1282     * @return string
1283     */
1284    function _video($src,$width,$height,$atts=null){
1285
1286        // prepare width and height
1287        if(is_null($atts)) $atts = array();
1288        $atts['width']  = (int) $width;
1289        $atts['height'] = (int) $height;
1290        if(!$atts['width'])  $atts['width']  = 320;
1291        if(!$atts['height']) $atts['height'] = 240;
1292
1293        // prepare alternative formats
1294        $extensions = array('webm', 'ogv', 'mp4');
1295        $alternatives = media_alternativefiles($src, $extensions);
1296        $poster = media_alternativefiles($src, array('jpg', 'png'), true);
1297        $posterUrl = '';
1298        if (!empty($poster)) {
1299            $posterUrl = ml(reset($poster),array('cache'=>$cache),true,'&');
1300        }
1301
1302        $out = '';
1303        // open video tag
1304        $out .= '<video '.buildAttributes($atts).' controls="controls"';
1305        if ($posterUrl) $out .= ' poster="'.hsc($posterUrl).'"';
1306        $out .= '>'.NL;
1307        $fallback = '';
1308
1309        // output source for each alternative video format
1310        foreach($alternatives as $mime => $file) {
1311            $url = ml($file,array('cache'=>$cache),true,'&');
1312            $title = $this->_xmlEntities(utf8_basename(noNS($file)));
1313
1314            $out .= '<source src="'.hsc($url).'" type="'.$mime.'" />'.NL;
1315            // alternative content (just a link to the file)
1316            $fallback .= $this->internalmedia($file, $title, NULL, NULL, NULL, $cache=NULL, $linking='linkonly', $return=true);
1317        }
1318
1319        // finish
1320        $out .= $fallback;
1321        $out .= '</video>'.NL;
1322        return $out;
1323    }
1324
1325    /**
1326     * Embed audio in HTML
1327     *
1328     * @author Anika Henke <anika@selfthinker.org>
1329     *
1330     * @param string $src      - ID of audio to embed
1331     * @param array $atts      - additional attributes for the <audio> tag
1332     * @return string
1333     */
1334    function _audio($src,$atts=null){
1335
1336        // prepare alternative formats
1337        $extensions = array('ogg', 'mp3', 'wav');
1338        $alternatives = media_alternativefiles($src, $extensions);
1339
1340        $out = '';
1341        // open audio tag
1342        $out .= '<audio '.buildAttributes($atts).' controls="controls">'.NL;
1343        $fallback = '';
1344
1345        // output source for each alternative audio format
1346        foreach($alternatives as $mime => $file) {
1347            $url = ml($file,array('cache'=>$cache),true,'&');
1348            $title = $this->_xmlEntities(utf8_basename(noNS($file)));
1349
1350            $out .= '<source src="'.hsc($url).'" type="'.$mime.'" />'.NL;
1351            // alternative content (just a link to the file)
1352            $fallback .= $this->internalmedia($file, $title, NULL, NULL, NULL, $cache=NULL, $linking='linkonly', $return=true);
1353        }
1354
1355        // finish
1356        $out .= $fallback;
1357        $out .= '</audio>'.NL;
1358        return $out;
1359    }
1360
1361}
1362
1363//Setup VIM: ex: et ts=4 :
1364