xref: /dokuwiki/inc/parser/xhtml.php (revision 6d4af72aa6e7a34b426f494eedb8a93cf2ce097a) 
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 $footnotes = array();
37    var $lastlevel = 0;
38    var $node = array(0,0,0,0,0);
39    var $store = '';
40
41    var $_counter   = array(); // used as global counter, introduced for table classes
42    var $_codeblock = 0; // counts the code and file blocks, used to provide download links
43
44    /**
45     * Register a new edit section range
46     *
47     * @param $type  string The section type identifier
48     * @param $title string The section title
49     * @param $start int    The byte position for the edit start
50     * @return string A marker class for the starting HTML element
51     * @author Adrian Lang <lang@cosmocode.de>
52     */
53    public function startSectionEdit($start, $type, $title = null) {
54        $this->sectionedits[] = array(++$this->lastsecid, $start, $type, $title);
55        return 'sectionedit' . $this->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.'" 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).'" 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 .= ' id="'.$hid.'">';
185        $this->doc .= $this->_xmlEntities($text);
186        $this->doc .= "</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.'" 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   $text      PHP code that is either executed or printed
362     * @param  string   $wrapper   html element to wrap result if $conf['phpok'] is okff
363     *
364     * @author Andreas Gohr <andi@splitbrain.org>
365     */
366    function php($text, $wrapper='code') {
367        global $conf;
368
369        if($conf['phpok']){
370          ob_start();
371          eval($text);
372          $this->doc .= ob_get_contents();
373          ob_end_clean();
374        } else {
375          $this->doc .= p_xhtml_cached_geshi($text, 'php', $wrapper);
376        }
377    }
378
379    function phpblock($text) {
380        $this->php($text, 'pre');
381    }
382
383    /**
384     * Insert HTML if allowed
385     *
386     * @param  string   $text      html text
387     * @param  string   $wrapper   html element to wrap result if $conf['htmlok'] is okff
388     *
389     * @author Andreas Gohr <andi@splitbrain.org>
390     */
391    function html($text, $wrapper='code') {
392        global $conf;
393
394        if($conf['htmlok']){
395          $this->doc .= $text;
396        } else {
397          $this->doc .= p_xhtml_cached_geshi($text, 'html4strict', $wrapper);
398        }
399    }
400
401    function htmlblock($text) {
402        $this->html($text, 'pre');
403    }
404
405    function quote_open() {
406        $this->doc .= '<blockquote><div class="no">'.DOKU_LF;
407    }
408
409    function quote_close() {
410        $this->doc .= '</div></blockquote>'.DOKU_LF;
411    }
412
413    function preformatted($text) {
414        $this->doc .= '<pre class="code">' . trim($this->_xmlEntities($text),"\n\r") . '</pre>'. DOKU_LF;
415    }
416
417    function file($text, $language=null, $filename=null) {
418        $this->_highlight('file',$text,$language,$filename);
419    }
420
421    function code($text, $language=null, $filename=null) {
422        $this->_highlight('code',$text,$language,$filename);
423    }
424
425    /**
426     * Use GeSHi to highlight language syntax in code and file blocks
427     *
428     * @author Andreas Gohr <andi@splitbrain.org>
429     */
430    function _highlight($type, $text, $language=null, $filename=null) {
431        global $conf;
432        global $ID;
433        global $lang;
434
435        if($filename){
436            // add icon
437            list($ext) = mimetype($filename,false);
438            $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
439            $class = 'mediafile mf_'.$class;
440
441            $this->doc .= '<dl class="'.$type.'">'.DOKU_LF;
442            $this->doc .= '<dt><a href="'.exportlink($ID,'code',array('codeblock'=>$this->_codeblock)).'" title="'.$lang['download'].'" class="'.$class.'">';
443            $this->doc .= hsc($filename);
444            $this->doc .= '</a></dt>'.DOKU_LF.'<dd>';
445        }
446
447        if ($text{0} == "\n") {
448            $text = substr($text, 1);
449        }
450        if (substr($text, -1) == "\n") {
451            $text = substr($text, 0, -1);
452        }
453
454        if ( is_null($language) ) {
455            $this->doc .= '<pre class="'.$type.'">'.$this->_xmlEntities($text).'</pre>'.DOKU_LF;
456        } else {
457            $class = 'code'; //we always need the code class to make the syntax highlighting apply
458            if($type != 'code') $class .= ' '.$type;
459
460            $this->doc .= "<pre class=\"$class $language\">".p_xhtml_cached_geshi($text, $language, '').'</pre>'.DOKU_LF;
461        }
462
463        if($filename){
464            $this->doc .= '</dd></dl>'.DOKU_LF;
465        }
466
467        $this->_codeblock++;
468    }
469
470    function acronym($acronym) {
471
472        if ( array_key_exists($acronym, $this->acronyms) ) {
473
474            $title = $this->_xmlEntities($this->acronyms[$acronym]);
475
476            $this->doc .= '<abbr title="'.$title
477                .'">'.$this->_xmlEntities($acronym).'</abbr>';
478
479        } else {
480            $this->doc .= $this->_xmlEntities($acronym);
481        }
482    }
483
484    function smiley($smiley) {
485        if ( array_key_exists($smiley, $this->smileys) ) {
486            $title = $this->_xmlEntities($this->smileys[$smiley]);
487            $this->doc .= '<img src="'.DOKU_BASE.'lib/images/smileys/'.$this->smileys[$smiley].
488                '" class="icon" alt="'.
489                    $this->_xmlEntities($smiley).'" />';
490        } else {
491            $this->doc .= $this->_xmlEntities($smiley);
492        }
493    }
494
495    /*
496    * not used
497    function wordblock($word) {
498        if ( array_key_exists($word, $this->badwords) ) {
499            $this->doc .= '** BLEEP **';
500        } else {
501            $this->doc .= $this->_xmlEntities($word);
502        }
503    }
504    */
505
506    function entity($entity) {
507        if ( array_key_exists($entity, $this->entities) ) {
508            $this->doc .= $this->entities[$entity];
509        } else {
510            $this->doc .= $this->_xmlEntities($entity);
511        }
512    }
513
514    function multiplyentity($x, $y) {
515        $this->doc .= "$x&times;$y";
516    }
517
518    function singlequoteopening() {
519        global $lang;
520        $this->doc .= $lang['singlequoteopening'];
521    }
522
523    function singlequoteclosing() {
524        global $lang;
525        $this->doc .= $lang['singlequoteclosing'];
526    }
527
528    function apostrophe() {
529        global $lang;
530        $this->doc .= $lang['apostrophe'];
531    }
532
533    function doublequoteopening() {
534        global $lang;
535        $this->doc .= $lang['doublequoteopening'];
536    }
537
538    function doublequoteclosing() {
539        global $lang;
540        $this->doc .= $lang['doublequoteclosing'];
541    }
542
543    /**
544    */
545    function camelcaselink($link) {
546      $this->internallink($link,$link);
547    }
548
549
550    function locallink($hash, $name = NULL){
551        global $ID;
552        $name  = $this->_getLinkTitle($name, $hash, $isImage);
553        $hash  = $this->_headerToLink($hash);
554        $title = $ID.' ↵';
555        $this->doc .= '<a href="#'.$hash.'" title="'.$title.'" class="wikilink1">';
556        $this->doc .= $name;
557        $this->doc .= '</a>';
558    }
559
560    /**
561     * Render an internal Wiki Link
562     *
563     * $search,$returnonly & $linktype are not for the renderer but are used
564     * elsewhere - no need to implement them in other renderers
565     *
566     * @author Andreas Gohr <andi@splitbrain.org>
567     */
568    function internallink($id, $name = NULL, $search=NULL,$returnonly=false,$linktype='content') {
569        global $conf;
570        global $ID;
571        global $INFO;
572
573        $params = '';
574        $parts = explode('?', $id, 2);
575        if (count($parts) === 2) {
576            $id = $parts[0];
577            $params = $parts[1];
578        }
579
580        // For empty $id we need to know the current $ID
581        // We need this check because _simpleTitle needs
582        // correct $id and resolve_pageid() use cleanID($id)
583        // (some things could be lost)
584        if ($id === '') {
585            $id = $ID;
586        }
587
588        // default name is based on $id as given
589        $default = $this->_simpleTitle($id);
590
591        // now first resolve and clean up the $id
592        resolve_pageid(getNS($ID),$id,$exists);
593
594        $name = $this->_getLinkTitle($name, $default, $isImage, $id, $linktype);
595        if ( !$isImage ) {
596            if ( $exists ) {
597                $class='wikilink1';
598            } else {
599                $class='wikilink2';
600                $link['rel']='nofollow';
601            }
602        } else {
603            $class='media';
604        }
605
606        //keep hash anchor
607        list($id,$hash) = explode('#',$id,2);
608        if(!empty($hash)) $hash = $this->_headerToLink($hash);
609
610        //prepare for formating
611        $link['target'] = $conf['target']['wiki'];
612        $link['style']  = '';
613        $link['pre']    = '';
614        $link['suf']    = '';
615        // highlight link to current page
616        if ($id == $INFO['id']) {
617            $link['pre']    = '<span class="curid">';
618            $link['suf']    = '</span>';
619        }
620        $link['more']   = '';
621        $link['class']  = $class;
622        $link['url']    = wl($id, $params);
623        $link['name']   = $name;
624        $link['title']  = $id;
625        //add search string
626        if($search){
627            ($conf['userewrite']) ? $link['url'].='?' : $link['url'].='&amp;';
628            if(is_array($search)){
629                $search = array_map('rawurlencode',$search);
630                $link['url'] .= 's[]='.join('&amp;s[]=',$search);
631            }else{
632                $link['url'] .= 's='.rawurlencode($search);
633            }
634        }
635
636        //keep hash
637        if($hash) $link['url'].='#'.$hash;
638
639        //output formatted
640        if($returnonly){
641            return $this->_formatLink($link);
642        }else{
643            $this->doc .= $this->_formatLink($link);
644        }
645    }
646
647    function externallink($url, $name = NULL) {
648        global $conf;
649
650        $name = $this->_getLinkTitle($name, $url, $isImage);
651
652        // url might be an attack vector, only allow registered protocols
653        if(is_null($this->schemes)) $this->schemes = getSchemes();
654        list($scheme) = explode('://',$url);
655        $scheme = strtolower($scheme);
656        if(!in_array($scheme,$this->schemes)) $url = '';
657
658        // is there still an URL?
659        if(!$url){
660            $this->doc .= $name;
661            return;
662        }
663
664        // set class
665        if ( !$isImage ) {
666            $class='urlextern';
667        } else {
668            $class='media';
669        }
670
671        //prepare for formating
672        $link['target'] = $conf['target']['extern'];
673        $link['style']  = '';
674        $link['pre']    = '';
675        $link['suf']    = '';
676        $link['more']   = '';
677        $link['class']  = $class;
678        $link['url']    = $url;
679
680        $link['name']   = $name;
681        $link['title']  = $this->_xmlEntities($url);
682        if($conf['relnofollow']) $link['more'] .= ' rel="nofollow"';
683
684        //output formatted
685        $this->doc .= $this->_formatLink($link);
686    }
687
688    /**
689    */
690    function interwikilink($match, $name = NULL, $wikiName, $wikiUri) {
691        global $conf;
692
693        $link = array();
694        $link['target'] = $conf['target']['interwiki'];
695        $link['pre']    = '';
696        $link['suf']    = '';
697        $link['more']   = '';
698        $link['name']   = $this->_getLinkTitle($name, $wikiUri, $isImage);
699
700        //get interwiki URL
701        $url = $this->_resolveInterWiki($wikiName,$wikiUri);
702
703        if ( !$isImage ) {
704            $class = preg_replace('/[^_\-a-z0-9]+/i','_',$wikiName);
705            $link['class'] = "interwiki iw_$class";
706        } else {
707            $link['class'] = 'media';
708        }
709
710        //do we stay at the same server? Use local target
711        if( strpos($url,DOKU_URL) === 0 ){
712            $link['target'] = $conf['target']['wiki'];
713        }
714
715        $link['url'] = $url;
716        $link['title'] = htmlspecialchars($link['url']);
717
718        //output formatted
719        $this->doc .= $this->_formatLink($link);
720    }
721
722    /**
723     */
724    function windowssharelink($url, $name = NULL) {
725        global $conf;
726        global $lang;
727        //simple setup
728        $link['target'] = $conf['target']['windows'];
729        $link['pre']    = '';
730        $link['suf']   = '';
731        $link['style']  = '';
732
733        $link['name'] = $this->_getLinkTitle($name, $url, $isImage);
734        if ( !$isImage ) {
735            $link['class'] = 'windows';
736        } else {
737            $link['class'] = 'media';
738        }
739
740
741        $link['title'] = $this->_xmlEntities($url);
742        $url = str_replace('\\','/',$url);
743        $url = 'file:///'.$url;
744        $link['url'] = $url;
745
746        //output formatted
747        $this->doc .= $this->_formatLink($link);
748    }
749
750    function emaillink($address, $name = NULL) {
751        global $conf;
752        //simple setup
753        $link = array();
754        $link['target'] = '';
755        $link['pre']    = '';
756        $link['suf']   = '';
757        $link['style']  = '';
758        $link['more']   = '';
759
760        $name = $this->_getLinkTitle($name, '', $isImage);
761        if ( !$isImage ) {
762            $link['class']='mail';
763        } else {
764            $link['class']='media';
765        }
766
767        $address = $this->_xmlEntities($address);
768        $address = obfuscate($address);
769        $title   = $address;
770
771        if(empty($name)){
772            $name = $address;
773        }
774
775        if($conf['mailguard'] == 'visible') $address = rawurlencode($address);
776
777        $link['url']   = 'mailto:'.$address;
778        $link['name']  = $name;
779        $link['title'] = $title;
780
781        //output formatted
782        $this->doc .= $this->_formatLink($link);
783    }
784
785    function internalmedia ($src, $title=NULL, $align=NULL, $width=NULL,
786                            $height=NULL, $cache=NULL, $linking=NULL) {
787        global $ID;
788        list($src,$hash) = explode('#',$src,2);
789        resolve_mediaid(getNS($ID),$src, $exists);
790
791        $noLink = false;
792        $render = ($linking == 'linkonly') ? false : true;
793        $link = $this->_getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render);
794
795        list($ext,$mime,$dl) = mimetype($src,false);
796        if(substr($mime,0,5) == 'image' && $render){
797            $link['url'] = ml($src,array('id'=>$ID,'cache'=>$cache),($linking=='direct'));
798        }elseif(($mime == 'application/x-shockwave-flash' || substr($mime,0,5) == 'video') && $render){
799            // don't link movies
800            $noLink = true;
801        }else{
802            // add file icons
803            $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
804            $link['class'] .= ' mediafile mf_'.$class;
805            $link['url'] = ml($src,array('id'=>$ID,'cache'=>$cache),true);
806            if ($exists) $link['title'] .= ' (' . filesize_h(filesize(mediaFN($src))).')';
807        }
808
809        if($hash) $link['url'] .= '#'.$hash;
810
811        //markup non existing files
812        if (!$exists) {
813            $link['class'] .= ' wikilink2';
814        }
815
816        //output formatted
817        if ($linking == 'nolink' || $noLink) $this->doc .= $link['name'];
818        else $this->doc .= $this->_formatLink($link);
819    }
820
821    function externalmedia ($src, $title=NULL, $align=NULL, $width=NULL,
822                            $height=NULL, $cache=NULL, $linking=NULL) {
823        list($src,$hash) = explode('#',$src,2);
824        $noLink = false;
825        $render = ($linking == 'linkonly') ? false : true;
826        $link = $this->_getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render);
827
828        $link['url']    = ml($src,array('cache'=>$cache));
829
830        list($ext,$mime,$dl) = mimetype($src,false);
831        if(substr($mime,0,5) == 'image' && $render){
832            // link only jpeg images
833            // if ($ext != 'jpg' && $ext != 'jpeg') $noLink = true;
834        }elseif(($mime == 'application/x-shockwave-flash' || substr($mime,0,5) == 'video') && $render){
835            // don't link movies
836            $noLink = true;
837        }else{
838            // add file icons
839            $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
840            $link['class'] .= ' mediafile mf_'.$class;
841        }
842
843        if($hash) $link['url'] .= '#'.$hash;
844
845        //output formatted
846        if ($linking == 'nolink' || $noLink) $this->doc .= $link['name'];
847        else $this->doc .= $this->_formatLink($link);
848    }
849
850    /**
851     * Renders an RSS feed
852     *
853     * @author Andreas Gohr <andi@splitbrain.org>
854     */
855    function rss ($url,$params){
856        global $lang;
857        global $conf;
858
859        require_once(DOKU_INC.'inc/FeedParser.php');
860        $feed = new FeedParser();
861        $feed->set_feed_url($url);
862
863        //disable warning while fetching
864        if (!defined('DOKU_E_LEVEL')) { $elvl = error_reporting(E_ERROR); }
865        $rc = $feed->init();
866        if (!defined('DOKU_E_LEVEL')) { error_reporting($elvl); }
867
868        //decide on start and end
869        if($params['reverse']){
870            $mod = -1;
871            $start = $feed->get_item_quantity()-1;
872            $end   = $start - ($params['max']);
873            $end   = ($end < -1) ? -1 : $end;
874        }else{
875            $mod   = 1;
876            $start = 0;
877            $end   = $feed->get_item_quantity();
878            $end   = ($end > $params['max']) ? $params['max'] : $end;;
879        }
880
881        $this->doc .= '<ul class="rss">';
882        if($rc){
883            for ($x = $start; $x != $end; $x += $mod) {
884                $item = $feed->get_item($x);
885                $this->doc .= '<li><div class="li">';
886                // support feeds without links
887                $lnkurl = $item->get_permalink();
888                if($lnkurl){
889                    // title is escaped by SimplePie, we unescape here because it
890                    // is escaped again in externallink() FS#1705
891                    $this->externallink($item->get_permalink(),
892                                        html_entity_decode($item->get_title(), ENT_QUOTES, 'UTF-8'));
893                }else{
894                    $this->doc .= ' '.$item->get_title();
895                }
896                if($params['author']){
897                    $author = $item->get_author(0);
898                    if($author){
899                        $name = $author->get_name();
900                        if(!$name) $name = $author->get_email();
901                        if($name) $this->doc .= ' '.$lang['by'].' '.$name;
902                    }
903                }
904                if($params['date']){
905                    $this->doc .= ' ('.$item->get_local_date($conf['dformat']).')';
906                }
907                if($params['details']){
908                    $this->doc .= '<div class="detail">';
909                    if($conf['htmlok']){
910                        $this->doc .= $item->get_description();
911                    }else{
912                        $this->doc .= strip_tags($item->get_description());
913                    }
914                    $this->doc .= '</div>';
915                }
916
917                $this->doc .= '</div></li>';
918            }
919        }else{
920            $this->doc .= '<li><div class="li">';
921            $this->doc .= '<em>'.$lang['rssfailed'].'</em>';
922            $this->externallink($url);
923            if($conf['allowdebug']){
924                $this->doc .= '<!--'.hsc($feed->error).'-->';
925            }
926            $this->doc .= '</div></li>';
927        }
928        $this->doc .= '</ul>';
929    }
930
931    // $numrows not yet implemented
932    function table_open($maxcols = null, $numrows = null, $pos = null){
933        global $lang;
934        // initialize the row counter used for classes
935        $this->_counter['row_counter'] = 0;
936        $class = 'table';
937        if ($pos !== null) {
938            $class .= ' ' . $this->startSectionEdit($pos, 'table');
939        }
940        $this->doc .= '<div class="' . $class . '"><table class="inline">' .
941                      DOKU_LF;
942    }
943
944    function table_close($pos = null){
945        $this->doc .= '</table></div>'.DOKU_LF;
946        if ($pos !== null) {
947            $this->finishSectionEdit($pos);
948        }
949    }
950
951    function tablerow_open(){
952        // initialize the cell counter used for classes
953        $this->_counter['cell_counter'] = 0;
954        $class = 'row' . $this->_counter['row_counter']++;
955        $this->doc .= DOKU_TAB . '<tr class="'.$class.'">' . DOKU_LF . DOKU_TAB . DOKU_TAB;
956    }
957
958    function tablerow_close(){
959        $this->doc .= DOKU_LF . DOKU_TAB . '</tr>' . DOKU_LF;
960    }
961
962    function tableheader_open($colspan = 1, $align = NULL, $rowspan = 1){
963        $class = 'class="col' . $this->_counter['cell_counter']++;
964        if ( !is_null($align) ) {
965            $class .= ' '.$align.'align';
966        }
967        $class .= '"';
968        $this->doc .= '<th ' . $class;
969        if ( $colspan > 1 ) {
970            $this->_counter['cell_counter'] += $colspan-1;
971            $this->doc .= ' colspan="'.$colspan.'"';
972        }
973        if ( $rowspan > 1 ) {
974            $this->doc .= ' rowspan="'.$rowspan.'"';
975        }
976        $this->doc .= '>';
977    }
978
979    function tableheader_close(){
980        $this->doc .= '</th>';
981    }
982
983    function tablecell_open($colspan = 1, $align = NULL, $rowspan = 1){
984        $class = 'class="col' . $this->_counter['cell_counter']++;
985        if ( !is_null($align) ) {
986            $class .= ' '.$align.'align';
987        }
988        $class .= '"';
989        $this->doc .= '<td '.$class;
990        if ( $colspan > 1 ) {
991            $this->_counter['cell_counter'] += $colspan-1;
992            $this->doc .= ' colspan="'.$colspan.'"';
993        }
994        if ( $rowspan > 1 ) {
995            $this->doc .= ' rowspan="'.$rowspan.'"';
996        }
997        $this->doc .= '>';
998    }
999
1000    function tablecell_close(){
1001        $this->doc .= '</td>';
1002    }
1003
1004    //----------------------------------------------------------
1005    // Utils
1006
1007    /**
1008     * Build a link
1009     *
1010     * Assembles all parts defined in $link returns HTML for the link
1011     *
1012     * @author Andreas Gohr <andi@splitbrain.org>
1013     */
1014    function _formatLink($link){
1015        //make sure the url is XHTML compliant (skip mailto)
1016        if(substr($link['url'],0,7) != 'mailto:'){
1017            $link['url'] = str_replace('&','&amp;',$link['url']);
1018            $link['url'] = str_replace('&amp;amp;','&amp;',$link['url']);
1019        }
1020        //remove double encodings in titles
1021        $link['title'] = str_replace('&amp;amp;','&amp;',$link['title']);
1022
1023        // be sure there are no bad chars in url or title
1024        // (we can't do this for name because it can contain an img tag)
1025        $link['url']   = strtr($link['url'],array('>'=>'%3E','<'=>'%3C','"'=>'%22'));
1026        $link['title'] = strtr($link['title'],array('>'=>'&gt;','<'=>'&lt;','"'=>'&quot;'));
1027
1028        $ret  = '';
1029        $ret .= $link['pre'];
1030        $ret .= '<a href="'.$link['url'].'"';
1031        if(!empty($link['class']))  $ret .= ' class="'.$link['class'].'"';
1032        if(!empty($link['target'])) $ret .= ' target="'.$link['target'].'"';
1033        if(!empty($link['title']))  $ret .= ' title="'.$link['title'].'"';
1034        if(!empty($link['style']))  $ret .= ' style="'.$link['style'].'"';
1035        if(!empty($link['rel']))    $ret .= ' rel="'.$link['rel'].'"';
1036        if(!empty($link['more']))   $ret .= ' '.$link['more'];
1037        $ret .= '>';
1038        $ret .= $link['name'];
1039        $ret .= '</a>';
1040        $ret .= $link['suf'];
1041        return $ret;
1042    }
1043
1044    /**
1045     * Renders internal and external media
1046     *
1047     * @author Andreas Gohr <andi@splitbrain.org>
1048     */
1049    function _media ($src, $title=NULL, $align=NULL, $width=NULL,
1050                      $height=NULL, $cache=NULL, $render = true) {
1051
1052        $ret = '';
1053
1054        list($ext,$mime,$dl) = mimetype($src);
1055        if(substr($mime,0,5) == 'image'){
1056            // first get the $title
1057            if (!is_null($title)) {
1058                $title  = $this->_xmlEntities($title);
1059            }elseif($ext == 'jpg' || $ext == 'jpeg'){
1060                //try to use the caption from IPTC/EXIF
1061                require_once(DOKU_INC.'inc/JpegMeta.php');
1062                $jpeg =new JpegMeta(mediaFN($src));
1063                if($jpeg !== false) $cap = $jpeg->getTitle();
1064                if($cap){
1065                    $title = $this->_xmlEntities($cap);
1066                }
1067            }
1068            if (!$render) {
1069                // if the picture is not supposed to be rendered
1070                // return the title of the picture
1071                if (!$title) {
1072                    // just show the sourcename
1073                    $title = $this->_xmlEntities(utf8_basename(noNS($src)));
1074                }
1075                return $title;
1076            }
1077            //add image tag
1078            $ret .= '<img src="'.ml($src,array('w'=>$width,'h'=>$height,'cache'=>$cache)).'"';
1079            $ret .= ' class="media'.$align.'"';
1080
1081            if ($title) {
1082                $ret .= ' title="' . $title . '"';
1083                $ret .= ' alt="'   . $title .'"';
1084            }else{
1085                $ret .= ' alt=""';
1086            }
1087
1088            if ( !is_null($width) )
1089                $ret .= ' width="'.$this->_xmlEntities($width).'"';
1090
1091            if ( !is_null($height) )
1092                $ret .= ' height="'.$this->_xmlEntities($height).'"';
1093
1094            $ret .= ' />';
1095
1096        }elseif($mime == 'video/webm' || $mime == 'video/ogg' || $mime == 'video/mp4' ){
1097            // first get the $title
1098            if (!is_null($title)) {
1099                $title  = $this->_xmlEntities($title);
1100            }
1101            if (!$title) {
1102                // just show the sourcename
1103                $title = $this->_xmlEntities(utf8_basename(noNS($src)));
1104            }
1105            if (!$render) {
1106                // if the video is not supposed to be rendered
1107                // return the title of the video
1108                return $title;
1109            }
1110
1111            $att = array();
1112            $att['class'] = "media$align";
1113
1114            //add video(s)
1115            $ret .= $this->_video($src, $width, $height, $att);
1116
1117        }elseif($mime == 'audio/ogg' || $mime == 'audio/mpeg' || $mime == 'audio/wav' ){
1118            // first get the $title
1119            if (!is_null($title)) {
1120                $title  = $this->_xmlEntities($title);
1121            }
1122            if (!$title) {
1123                // just show the sourcename
1124                $title = $this->_xmlEntities(utf8_basename(noNS($src)));
1125            }
1126            if (!$render) {
1127                // if the video is not supposed to be rendered
1128                // return the title of the video
1129                return $title;
1130            }
1131
1132            $att = array();
1133            $att['class'] = "media$align";
1134
1135            //add audio
1136            $ret .= $this->_audio($src, $att);
1137
1138        }elseif($mime == 'application/x-shockwave-flash'){
1139            if (!$render) {
1140                // if the flash is not supposed to be rendered
1141                // return the title of the flash
1142                if (!$title) {
1143                    // just show the sourcename
1144                    $title = utf8_basename(noNS($src));
1145                }
1146                return $this->_xmlEntities($title);
1147            }
1148
1149            $att = array();
1150            $att['class'] = "media$align";
1151            if($align == 'right') $att['align'] = 'right';
1152            if($align == 'left')  $att['align'] = 'left';
1153            $ret .= html_flashobject(ml($src,array('cache'=>$cache),true,'&'),$width,$height,
1154                                     array('quality' => 'high'),
1155                                     null,
1156                                     $att,
1157                                     $this->_xmlEntities($title));
1158        }elseif($title){
1159            // well at least we have a title to display
1160            $ret .= $this->_xmlEntities($title);
1161        }else{
1162            // just show the sourcename
1163            $ret .= $this->_xmlEntities(utf8_basename(noNS($src)));
1164        }
1165
1166        return $ret;
1167    }
1168
1169    function _xmlEntities($string) {
1170        return htmlspecialchars($string,ENT_QUOTES,'UTF-8');
1171    }
1172
1173    /**
1174     * Creates a linkid from a headline
1175     *
1176     * @param string  $title   The headline title
1177     * @param boolean $create  Create a new unique ID?
1178     * @author Andreas Gohr <andi@splitbrain.org>
1179     */
1180    function _headerToLink($title,$create=false) {
1181        if($create){
1182            return sectionID($title,$this->headers);
1183        }else{
1184            $check = false;
1185            return sectionID($title,$check);
1186        }
1187    }
1188
1189    /**
1190     * Construct a title and handle images in titles
1191     *
1192     * @author Harry Fuecks <hfuecks@gmail.com>
1193     */
1194    function _getLinkTitle($title, $default, & $isImage, $id=NULL, $linktype='content') {
1195        global $conf;
1196
1197        $isImage = false;
1198        if ( is_array($title) ) {
1199            $isImage = true;
1200            return $this->_imageTitle($title);
1201        } elseif ( is_null($title) || trim($title)=='') {
1202            if (useHeading($linktype) && $id) {
1203                $heading = p_get_first_heading($id);
1204                if ($heading) {
1205                    return $this->_xmlEntities($heading);
1206                }
1207            }
1208            return $this->_xmlEntities($default);
1209        } else {
1210            return $this->_xmlEntities($title);
1211        }
1212    }
1213
1214    /**
1215     * Returns an HTML code for images used in link titles
1216     *
1217     * @todo Resolve namespace on internal images
1218     * @author Andreas Gohr <andi@splitbrain.org>
1219     */
1220    function _imageTitle($img) {
1221        global $ID;
1222
1223        // some fixes on $img['src']
1224        // see internalmedia() and externalmedia()
1225        list($img['src'],$hash) = explode('#',$img['src'],2);
1226        if ($img['type'] == 'internalmedia') {
1227            resolve_mediaid(getNS($ID),$img['src'],$exists);
1228        }
1229
1230        return $this->_media($img['src'],
1231                              $img['title'],
1232                              $img['align'],
1233                              $img['width'],
1234                              $img['height'],
1235                              $img['cache']);
1236    }
1237
1238    /**
1239     * _getMediaLinkConf is a helperfunction to internalmedia() and externalmedia()
1240     * which returns a basic link to a media.
1241     *
1242     * @author Pierre Spring <pierre.spring@liip.ch>
1243     * @param string $src
1244     * @param string $title
1245     * @param string $align
1246     * @param string $width
1247     * @param string $height
1248     * @param string $cache
1249     * @param string $render
1250     * @access protected
1251     * @return array
1252     */
1253    function _getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render)
1254    {
1255        global $conf;
1256
1257        $link = array();
1258        $link['class']  = 'media';
1259        $link['style']  = '';
1260        $link['pre']    = '';
1261        $link['suf']    = '';
1262        $link['more']   = '';
1263        $link['target'] = $conf['target']['media'];
1264        $link['title']  = $this->_xmlEntities($src);
1265        $link['name']   = $this->_media($src, $title, $align, $width, $height, $cache, $render);
1266
1267        return $link;
1268    }
1269
1270
1271    /**
1272     * Embed video(s) in HTML
1273     *
1274     * @author Anika Henke <anika@selfthinker.org>
1275     *
1276     * @param string $src      - ID of video to embed
1277     * @param int $width       - width of the video in pixels
1278     * @param int $height      - height of the video in pixels
1279     * @param array $atts      - additional attributes for the <video> tag
1280     */
1281    function _video($src,$width,$height,$atts=null){
1282
1283        // prepare width and height
1284        if(is_null($atts)) $atts = array();
1285        $atts['width']  = (int) $width;
1286        $atts['height'] = (int) $height;
1287        if(!$atts['width'])  $atts['width']  = 320;
1288        if(!$atts['height']) $atts['height'] = 240;
1289
1290        // prepare alternative formats
1291        $extensions = array('webm', 'ogv', 'mp4');
1292        $alternatives = media_alternativefiles($src, $extensions);
1293        $poster = media_alternativefiles($src, array('jpg', 'png'), true);
1294        $posterUrl = '';
1295        if (!empty($poster)) {
1296            $posterUrl = ml(reset($poster),array('cache'=>$cache),true,'&');
1297        }
1298
1299        // open video tag
1300        $this->doc .= '<video '.buildAttributes($atts).' controls="controls"';
1301        if ($posterUrl) $this->doc .= ' poster="'.$posterUrl.'"';
1302        $this->doc .= '>'.NL;
1303
1304        // output source for each alternative video format
1305        foreach($alternatives as $mime => $file) {
1306            $url = ml($file,array('cache'=>$cache),true,'&');
1307            $title = $this->_xmlEntities(utf8_basename(noNS($file)));
1308
1309            $this->doc .= '<source src="'.hsc($url).'" type="'.$mime.'" />'.NL;
1310            // alternative content (just a link to the file)
1311            $this->internalmedia($file, $title, NULL, NULL, NULL, $cache=NULL, $linking='linkonly');
1312        }
1313
1314        // finish
1315        $this->doc .= '</video>'.NL;
1316    }
1317
1318    /**
1319     * Embed audio in HTML
1320     *
1321     * @author Anika Henke <anika@selfthinker.org>
1322     *
1323     * @param string $src      - ID of audio to embed
1324     * @param array $atts      - additional attributes for the <audio> tag
1325     */
1326    function _audio($src,$atts=null){
1327
1328        // prepare alternative formats
1329        $extensions = array('ogg', 'mp3', 'wav');
1330        $alternatives = media_alternativefiles($src, $extensions);
1331
1332        // open audio tag
1333        $this->doc .= '<audio '.buildAttributes($atts).' controls="controls">'.NL;
1334
1335        // output source for each alternative audio format
1336        foreach($alternatives as $mime => $file) {
1337            $url = ml($file,array('cache'=>$cache),true,'&');
1338            $title = $this->_xmlEntities(utf8_basename(noNS($file)));
1339
1340            $this->doc .= '<source src="'.hsc($url).'" type="'.$mime.'" />'.NL;
1341            // alternative content (just a link to the file)
1342            $this->internalmedia($file, $title, NULL, NULL, NULL, $cache=NULL, $linking='linkonly');
1343        }
1344
1345        // finish
1346        $this->doc .= '</audio>'.NL;
1347    }
1348
1349}
1350
1351//Setup VIM: ex: et ts=4 :
1352