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