xref: /dokuwiki/inc/parser/xhtml.php (revision 5fb14d63b6a7de75860bd8a94caa8d2f2fe8ee5e) 
1<?php
2/**
3 * Renderer for XHTML output
4 *
5 * @author Harry Fuecks <hfuecks@gmail.com>
6 * @author Andreas Gohr <andi@splitbrain.org>
7 */
8
9if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
10
11if ( !defined('DOKU_LF') ) {
12    // Some whitespace to help View > Source
13    define ('DOKU_LF',"\n");
14}
15
16if ( !defined('DOKU_TAB') ) {
17    // Some whitespace to help View > Source
18    define ('DOKU_TAB',"\t");
19}
20
21require_once DOKU_INC . 'inc/parser/renderer.php';
22
23/**
24 * The Renderer
25 */
26class Doku_Renderer_xhtml extends Doku_Renderer {
27
28    var $doc = '';
29
30    var $headers = array();
31
32    var $footnotes = array();
33
34    var $acronyms = array();
35    var $smileys = array();
36    var $badwords = array();
37    var $entities = array();
38    var $interwiki = array();
39
40    var $lastsec = 0;
41
42    var $store = '';
43
44    function document_start() {
45    }
46
47    function document_end() {
48        // add button for last section if any and more than one
49        if($this->lastsec > 1) $this->_secedit($this->lastsec,'');
50
51        if ( count ($this->footnotes) > 0 ) {
52            $this->doc .= '<div class="footnotes">'.DOKU_LF;
53
54            $id = 0;
55            foreach ( $this->footnotes as $footnote ) {
56                $id++;   // the number of the current footnote
57
58                // check its not a placeholder that indicates actual footnote text is elsewhere
59                if (substr($footnote, 0, 5) != "@@FNT") {
60
61                    // open the footnote and set the anchor and backlink
62                    $this->doc .= '<div class="fn">';
63                    $this->doc .= '<a href="#fnt'.$id.'" id="fn'.$id.'" name="fn'.$id.'" class="fn_bot">';
64                    $this->doc .= $id.')</a> '.DOKU_LF;
65
66                    // get any other footnotes that use the same markup
67                    $alt = array_keys($this->footnotes, "@@FNT$id");
68
69                    if (count($alt)) {
70                      foreach ($alt as $ref) {
71                        // set anchor and backlink for the other footnotes
72                        $this->doc .= ', <a href="#fnt'.($ref+1).'" id="fn'.($ref+1).'" name="fn'.($ref+1).'" class="fn_bot">';
73                        $this->doc .= ($ref+1).')</a> '.DOKU_LF;
74                      }
75                    }
76
77                    // add footnote markup and close this footnote
78                    $this->doc .= $footnote;
79                    $this->doc .= '</div>' . DOKU_LF;
80                }
81            }
82            $this->doc .= '</div>'.DOKU_LF;
83        }
84    }
85
86    function toc_open() {
87        global $lang;
88        $this->doc .= '<div class="toc">'.DOKU_LF;
89        $this->doc .= '<div class="tocheader">';
90        $this->doc .= ' <script type="text/javascript">showTocToggle("+","-")</script>';
91        $this->doc .= $lang['toc'];
92        $this->doc .= '</div>'.DOKU_LF;
93        $this->doc .= '<div id="tocinside">'.DOKU_LF;
94    }
95
96    function tocbranch_open($level) {
97        $this->doc .= '<ul class="toc">'.DOKU_LF;
98    }
99
100    function tocitem_open($level, $empty = FALSE) {
101        if ( !$empty ) {
102            $this->doc .= '<li class="level'.$level.'">';
103        } else {
104            $this->doc .= '<li class="clear">';
105        }
106    }
107
108    function tocelement($level, $title) {
109        $this->doc .= '<span class="li"><a href="#'.$this->_headerToLink($title).'" class="toc">';
110        $this->doc .= $this->_xmlEntities($title);
111        $this->doc .= '</a></span>';
112    }
113
114    function tocitem_close($level) {
115        $this->doc .= '</li>'.DOKU_LF;
116    }
117
118    function tocbranch_close($level) {
119        $this->doc .= '</ul>'.DOKU_LF;
120    }
121
122    function toc_close() {
123        $this->doc .= '</div>'.DOKU_LF.'</div>'.DOKU_LF;
124    }
125
126    function header($text, $level, $pos) {
127        global $conf;
128        //handle section editing
129        if($level <= $conf['maxseclevel']){
130            // add button for last section if any
131            if($this->lastsec) $this->_secedit($this->lastsec,$pos-1);
132            // remember current position
133            $this->lastsec = $pos;
134        }
135
136        $this->doc .= DOKU_LF.'<a name="'.$this->_headerToLink($text).'"></a><h'.$level.'>';
137        $this->doc .= $this->_xmlEntities($text);
138        $this->doc .= "</h$level>".DOKU_LF;
139    }
140
141    function section_open($level) {
142        $this->doc .= "<div class=\"level$level\">".DOKU_LF;
143    }
144
145    function section_close() {
146        $this->doc .= DOKU_LF.'</div>'.DOKU_LF;
147    }
148
149    function cdata($text) {
150        $this->doc .= $this->_xmlEntities($text);
151    }
152
153    function p_open() {
154        $this->doc .= DOKU_LF.'<p>'.DOKU_LF;
155    }
156
157    function p_close() {
158        $this->doc .= DOKU_LF.'</p>'.DOKU_LF;
159    }
160
161    function linebreak() {
162        $this->doc .= '<br/>'.DOKU_LF;
163    }
164
165    function hr() {
166        $this->doc .= '<hr noshade="noshade" size="1" />'.DOKU_LF;
167    }
168
169    function strong_open() {
170        $this->doc .= '<strong>';
171    }
172
173    function strong_close() {
174        $this->doc .= '</strong>';
175    }
176
177    function emphasis_open() {
178        $this->doc .= '<em>';
179    }
180
181    function emphasis_close() {
182        $this->doc .= '</em>';
183    }
184
185    function underline_open() {
186        $this->doc .= '<u>';
187    }
188
189    function underline_close() {
190        $this->doc .= '</u>';
191    }
192
193    function monospace_open() {
194        $this->doc .= '<code>';
195    }
196
197    function monospace_close() {
198        $this->doc .= '</code>';
199    }
200
201    function subscript_open() {
202        $this->doc .= '<sub>';
203    }
204
205    function subscript_close() {
206        $this->doc .= '</sub>';
207    }
208
209    function superscript_open() {
210        $this->doc .= '<sup>';
211    }
212
213    function superscript_close() {
214        $this->doc .= '</sup>';
215    }
216
217    function deleted_open() {
218        $this->doc .= '<del>';
219    }
220
221    function deleted_close() {
222        $this->doc .= '</del>';
223    }
224
225    /**
226     * Callback for footnote start syntax
227     *
228     * All following content will go to the footnote instead of
229     * the document. To achieve this the previous rendered content
230     * is moved to $store and $doc is cleared
231     *
232     * @author Andreas Gohr <andi@splitbrain.org>
233     */
234    function footnote_open() {
235
236        // move current content to store and record footnote
237        $this->store = $this->doc;
238        $this->doc   = '';
239    }
240
241    /**
242     * Callback for footnote end syntax
243     *
244     * All rendered content is moved to the $footnotes array and the old
245     * content is restored from $store again
246     *
247     * @author Andreas Gohr
248     */
249    function footnote_close() {
250
251        // recover footnote into the stack and restore old content
252        $footnote = $this->doc;
253        $this->doc = $this->store;
254        $this->store = '';
255
256        // check to see if this footnote has been seen before
257        $i = array_search($footnote, $this->footnotes);
258
259        if ($i === false) {
260            // its a new footnote, add it to the $footnotes array
261            $id = count($this->footnotes)+1;
262            $this->footnotes[count($this->footnotes)] = $footnote;
263        } else {
264            // seen this one before, translate the index to an id and save a placeholder
265            $i++;
266            $id = count($this->footnotes)+1;
267            $this->footnotes[count($this->footnotes)] = "@@FNT".($i);
268        }
269
270        // output the footnote reference and link, incl. onmouseover for insitu footnote popup
271        $this->doc .= '<a href="#fn'.$id.'" name="fnt'.$id.'" class="fn_top" onmouseover="fnt(\''.$id.'\', this, event);">'.$id.')</a>';
272    }
273
274    function listu_open() {
275        $this->doc .= '<ul>'.DOKU_LF;
276    }
277
278    function listu_close() {
279        $this->doc .= '</ul>'.DOKU_LF;
280    }
281
282    function listo_open() {
283        $this->doc .= '<ol>'.DOKU_LF;
284    }
285
286    function listo_close() {
287        $this->doc .= '</ol>'.DOKU_LF;
288    }
289
290    function listitem_open($level) {
291        $this->doc .= '<li class="level'.$level.'">';
292    }
293
294    function listitem_close() {
295        $this->doc .= '</li>'.DOKU_LF;
296    }
297
298    function listcontent_open() {
299        $this->doc .= '<div class="li">';
300    }
301
302    function listcontent_close() {
303        $this->doc .= '</div>'.DOKU_LF;
304    }
305
306    function unformatted($text) {
307        $this->doc .= $this->_xmlEntities($text);
308    }
309
310    /**
311     * Execute PHP code if allowed
312     *
313     * @author Andreas Gohr <andi@splitbrain.org>
314     */
315    function php($text) {
316        global $conf;
317        if($conf['phpok']){
318            ob_start();
319            eval($text);
320            $this->doc .= ob_get_contents();
321            ob_end_clean();
322        }else{
323            $this->file($text);
324        }
325    }
326
327    /**
328     * Insert HTML if allowed
329     *
330     * @author Andreas Gohr <andi@splitbrain.org>
331     */
332    function html($text) {
333        global $conf;
334        if($conf['htmlok']){
335          $this->doc .= $text;
336        }else{
337          $this->file($text);
338        }
339    }
340
341    function preformatted($text) {
342        $this->doc .= '<pre class="code">' . $this->_xmlEntities($text) . '</pre>'. DOKU_LF;
343    }
344
345    function file($text) {
346        $this->doc .= '<pre class="file">' . $this->_xmlEntities($text). '</pre>'. DOKU_LF;
347    }
348
349    function quote_open() {
350        $this->doc .= '<blockquote>'.DOKU_LF;
351    }
352
353    function quote_close() {
354        $this->doc .= '</blockquote>'.DOKU_LF;
355    }
356
357    /**
358     * Callback for code text
359     *
360     * Uses GeSHi to highlight language syntax
361     *
362     * @author Andreas Gohr <andi@splitbrain.org>
363     */
364    function code($text, $language = NULL) {
365        global $conf;
366
367        if ( is_null($language) ) {
368            $this->preformatted($text);
369        } else {
370            //strip leading blank line
371            $text = preg_replace('/^\s*?\n/','',$text);
372            // Handle with Geshi here
373            require_once(DOKU_INC . 'inc/geshi.php');
374            $geshi = new GeSHi($text, strtolower($language), DOKU_INC . 'inc/geshi');
375            $geshi->set_encoding('utf-8');
376            $geshi->enable_classes();
377            $geshi->set_header_type(GESHI_HEADER_PRE);
378            $geshi->set_overall_class("code $language");
379            $geshi->set_link_target($conf['target']['extern']);
380
381            $text = $geshi->parse_code();
382            $this->doc .= $text;
383        }
384    }
385
386    function acronym($acronym) {
387
388        if ( array_key_exists($acronym, $this->acronyms) ) {
389
390            $title = $this->_xmlEntities($this->acronyms[$acronym]);
391
392            $this->doc .= '<acronym title="'.$title
393                .'">'.$this->_xmlEntities($acronym).'</acronym>';
394
395        } else {
396            $this->doc .= $this->_xmlEntities($acronym);
397        }
398    }
399
400    function smiley($smiley) {
401        if ( array_key_exists($smiley, $this->smileys) ) {
402            $title = $this->_xmlEntities($this->smileys[$smiley]);
403            $this->doc .= '<img src="'.DOKU_BASE.'lib/images/smileys/'.$this->smileys[$smiley].
404                '" align="middle" alt="'.
405                    $this->_xmlEntities($smiley).'" />';
406        } else {
407            $this->doc .= $this->_xmlEntities($smiley);
408        }
409    }
410
411    /*
412    * not used
413    function wordblock($word) {
414        if ( array_key_exists($word, $this->badwords) ) {
415            $this->doc .= '** BLEEP **';
416        } else {
417            $this->doc .= $this->_xmlEntities($word);
418        }
419    }
420    */
421
422    function entity($entity) {
423        if ( array_key_exists($entity, $this->entities) ) {
424            $this->doc .= $this->entities[$entity];
425        } else {
426            $this->doc .= $this->_xmlEntities($entity);
427        }
428    }
429
430    function multiplyentity($x, $y) {
431        $this->doc .= "$x&times;$y";
432    }
433
434    function singlequoteopening() {
435        $this->doc .= "&lsquo;";
436    }
437
438    function singlequoteclosing() {
439        $this->doc .= "&rsquo;";
440    }
441
442    function doublequoteopening() {
443        $this->doc .= "&ldquo;";
444    }
445
446    function doublequoteclosing() {
447        $this->doc .= "&rdquo;";
448    }
449
450    /**
451    */
452    function camelcaselink($link) {
453      $this->internallink($link,$link);
454    }
455
456
457    function locallink($hash, $name = NULL){
458        global $ID;
459        $name  = $this->_getLinkTitle($name, $hash, $isImage);
460        $hash  = $this->_headerToLink($hash);
461        $title = $ID.' &crarr;';
462        $this->doc .= '<a href="#'.$hash.'" title="'.$title.'" class="wikilink1">';
463        $this->doc .= $name;
464        $this->doc .= '</a>';
465    }
466
467    /**
468     * Render an internal Wiki Link
469     *
470     * $search and $returnonly are not for the renderer but are used
471     * elsewhere - no need to implement them in other renderers
472     *
473     * @author Andreas Gohr <andi@splitbrain.org>
474     */
475    function internallink($id, $name = NULL, $search=NULL,$returnonly=false) {
476        global $conf;
477        global $ID;
478        // default name is based on $id as given
479        $default = $this->_simpleTitle($id);
480        // now first resolve and clean up the $id
481        resolve_pageid(getNS($ID),$id,$exists);
482        $name = $this->_getLinkTitle($name, $default, $isImage, $id);
483        if ( !$isImage ) {
484            if ( $exists ) {
485                $class='wikilink1';
486            } else {
487                $class='wikilink2';
488            }
489        } else {
490            $class='media';
491        }
492
493        //keep hash anchor
494        list($id,$hash) = split('#',$id,2);
495
496        //prepare for formating
497        $link['target'] = $conf['target']['wiki'];
498        $link['style']  = '';
499        $link['pre']    = '';
500        $link['suf']    = '';
501        // highlight link to current page
502        if ($id == $ID) {
503            $link['pre']    = '<span class="curid">';
504            $link['suf']    = '</span>';
505        }
506        $link['more']   = '';
507        $link['class']  = $class;
508        $link['url']    = wl($id);
509        $link['name']   = $name;
510        $link['title']  = $id;
511        //add search string
512        if($search){
513            ($conf['userewrite']) ? $link['url'].='?s=' : $link['url'].='&amp;s=';
514            $link['url'] .= urlencode($search);
515        }
516
517        //keep hash
518        if($hash) $link['url'].='#'.$hash;
519
520        //output formatted
521        if($returnonly){
522            return $this->_formatLink($link);
523        }else{
524            $this->doc .= $this->_formatLink($link);
525        }
526    }
527
528    function externallink($url, $name = NULL) {
529        global $conf;
530
531        $name = $this->_getLinkTitle($name, $url, $isImage);
532
533        // add protocol on simple short URLs
534        if(substr($url,0,3) == 'ftp' && (substr($url,0,6) != 'ftp://')) $url = 'ftp://'.$url;
535        if(substr($url,0,3) == 'www') $url = 'http://'.$url;
536
537        if ( !$isImage ) {
538            $class='urlextern';
539        } else {
540            $class='media';
541        }
542
543        //prepare for formating
544        $link['target'] = $conf['target']['extern'];
545        $link['style']  = '';
546        $link['pre']    = '';
547        $link['suf']    = '';
548        $link['more']   = '';
549        $link['class']  = $class;
550        $link['url']    = $url;
551        $link['name']   = $name;
552        $link['title']  = $this->_xmlEntities($url);
553        if($conf['relnofollow']) $link['more'] .= ' rel="nofollow"';
554
555        //output formatted
556        $this->doc .= $this->_formatLink($link);
557    }
558
559    /**
560    */
561    function interwikilink($match, $name = NULL, $wikiName, $wikiUri) {
562        global $conf;
563
564        $link = array();
565        $link['target'] = $conf['target']['interwiki'];
566        $link['pre']    = '';
567        $link['suf']    = '';
568        $link['more']   = '';
569        $link['name']   = $this->_getLinkTitle($name, $wikiUri, $isImage);
570
571        //get interwiki URL
572        if ( isset($this->interwiki[$wikiName]) ) {
573            $url = $this->interwiki[$wikiName];
574        } else {
575            // Default to Google I'm feeling lucky
576            $url = 'http://www.google.com/search?q={URL}&amp;btnI=lucky';
577            $wikiName = 'go';
578        }
579
580        if ( !$isImage ) {
581            $class = preg_replace('/[^_\-a-z0-9]+/i','_',$wikiName);
582            $link['class'] = "interwiki iw_$class";
583        } else {
584            $link['class'] = 'media';
585        }
586
587        //do we stay at the same server? Use local target
588        if( strpos($url,DOKU_URL) === 0 ){
589            $link['target'] = $conf['target']['wiki'];
590        }
591
592        //split into hash and url part
593        list($wikiUri,$hash) = explode('#',$wikiUri,2);
594
595        //replace placeholder
596        if(preg_match('#\{(URL|NAME|SCHEME|HOST|PORT|PATH|QUERY)\}#',$url)){
597            //use placeholders
598            $url = str_replace('{URL}',urlencode($wikiUri),$url);
599            $url = str_replace('{NAME}',$wikiUri,$url);
600            $parsed = parse_url($wikiUri);
601            if(!$parsed['port']) $parsed['port'] = 80;
602            $url = str_replace('{SCHEME}',$parsed['scheme'],$url);
603            $url = str_replace('{HOST}',$parsed['host'],$url);
604            $url = str_replace('{PORT}',$parsed['port'],$url);
605            $url = str_replace('{PATH}',$parsed['path'],$url);
606            $url = str_replace('{QUERY}',$parsed['query'],$url);
607            $link['url'] = $url;
608        }else{
609            //default
610            $link['url'] = $url.urlencode($wikiUri);
611        }
612        if($hash) $link['url'] .= '#'.urlencode($hash);
613
614        $link['title'] = htmlspecialchars($link['url']);
615
616        //output formatted
617        $this->doc .= $this->_formatLink($link);
618    }
619
620    /**
621     */
622    function windowssharelink($url, $name = NULL) {
623        global $conf;
624        global $lang;
625        //simple setup
626        $link['target'] = $conf['target']['windows'];
627        $link['pre']    = '';
628        $link['suf']   = '';
629        $link['style']  = '';
630        //Display error on browsers other than IE
631        $link['more'] = 'onclick="if(document.all == null){alert(\''.
632                        $this->_xmlEntities($lang['nosmblinks'],ENT_QUOTES).
633                        '\');}" onkeypress="if(document.all == null){alert(\''.
634                        $this->_xmlEntities($lang['nosmblinks'],ENT_QUOTES).'\');}"';
635
636        $link['name'] = $this->_getLinkTitle($name, $url, $isImage);
637        if ( !$isImage ) {
638            $link['class'] = 'windows';
639        } else {
640            $link['class'] = 'media';
641        }
642
643
644        $link['title'] = $this->_xmlEntities($url);
645        $url = str_replace('\\','/',$url);
646        $url = 'file:///'.$url;
647        $link['url'] = $url;
648
649        //output formatted
650        $this->doc .= $this->_formatLink($link);
651    }
652
653    function emaillink($address, $name = NULL) {
654        global $conf;
655        //simple setup
656        $link = array();
657        $link['target'] = '';
658        $link['pre']    = '';
659        $link['suf']   = '';
660        $link['style']  = '';
661        $link['more']   = '';
662
663        //we just test for image here - we need to encode the title our self
664        $this->_getLinkTitle($name, $address, $isImage);
665        if ( !$isImage ) {
666            $link['class']='mail JSnocheck';
667        } else {
668            $link['class']='media JSnocheck';
669        }
670
671        $address = $this->_xmlEntities($address);
672        $address = obfuscate($address);
673        $title   = $address;
674        if(empty($name)){
675            $name = $address;
676        }else{
677            $name = $this->_xmlEntities($name);
678        }
679
680        if($conf['mailguard'] == 'visible') $address = rawurlencode($address);
681
682        $link['url']   = 'mailto:'.$address;
683        $link['name']  = $name;
684        $link['title'] = $title;
685
686        //output formatted
687        $this->doc .= $this->_formatLink($link);
688    }
689
690    function internalmedia ($src, $title=NULL, $align=NULL, $width=NULL,
691                            $height=NULL, $cache=NULL, $linking=NULL) {
692        global $conf;
693        global $ID;
694        resolve_mediaid(getNS($ID),$src, $exists);
695
696        $link = array();
697        $link['class']  = 'media';
698        $link['style']  = '';
699        $link['pre']    = '';
700        $link['suf']    = '';
701        $link['more']   = '';
702        $link['target'] = $conf['target']['media'];
703
704        $link['title']  = $this->_xmlEntities($src);
705        list($ext,$mime) = mimetype($src);
706        if(substr($mime,0,5) == 'image'){
707             $link['url'] = ml($src,array('id'=>$ID,'cache'=>$cache),($linking=='direct'));
708         }elseif($mime == 'application/x-shockwave-flash'){
709             // don't link flash movies
710             $noLink = TRUE;
711         }else{
712             // add file icons
713             $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
714             $link['class'] .= ' mediafile mf_'.$class;
715             $link['url'] = ml($src,array('id'=>$ID,'cache'=>$cache),true);
716         }
717         $link['name']   = $this->_media ($src, $title, $align, $width, $height, $cache);
718
719         //output formatted
720         if ($linking == 'nolink' || $noLink) $this->doc .= $link['name'];
721         else $this->doc .= $this->_formatLink($link);
722    }
723
724    /**
725     * @todo don't add link for flash
726     */
727    function externalmedia ($src, $title=NULL, $align=NULL, $width=NULL,
728                            $height=NULL, $cache=NULL, $linking=NULL) {
729        global $conf;
730
731        $link = array();
732        $link['class']  = 'media';
733        $link['style']  = '';
734        $link['pre']    = '';
735        $link['suf']    = '';
736        $link['more']   = '';
737        $link['target'] = $conf['target']['media'];
738
739        $link['title']  = $this->_xmlEntities($src);
740        $link['url']    = ml($src,array('cache'=>$cache));
741        $link['name']   = $this->_media ($src, $title, $align, $width, $height, $cache);
742
743
744        list($ext,$mime) = mimetype($src);
745        if(substr($mime,0,5) == 'image'){
746             // link only jpeg images
747             // if ($ext != 'jpg' && $ext != 'jpeg') $noLink = TRUE;
748        }elseif($mime == 'application/x-shockwave-flash'){
749             // don't link flash movies
750             $noLink = TRUE;
751        }else{
752             // add file icons
753             $link['class'] .= ' mediafile mf_'.$ext;
754         }
755
756        //output formatted
757        if ($linking == 'nolink' || $noLink) $this->doc .= $link['name'];
758        else $this->doc .= $this->_formatLink($link);
759    }
760
761    /**
762     * Renders an RSS feed using Magpie
763     *
764     * @author Andreas Gohr <andi@splitbrain.org>
765     */
766    function rss ($url){
767        global $lang;
768        define('MAGPIE_CACHE_ON', false); //we do our own caching
769        define('MAGPIE_DIR', DOKU_INC.'inc/magpie/');
770        define('MAGPIE_OUTPUT_ENCODING','UTF-8'); //return all feeds as UTF-8
771        require_once(MAGPIE_DIR.'/rss_fetch.inc');
772
773        //disable warning while fetching
774        $elvl = error_reporting(E_ERROR);
775        $rss  = fetch_rss($url);
776        error_reporting($elvl);
777
778        $this->doc .= '<ul class="rss">';
779        if($rss){
780            foreach ($rss->items as $item ) {
781                $this->doc .= '<li>';
782                $this->externallink($item['link'],$item['title']);
783                $this->doc .= '</li>';
784            }
785        }else{
786            $this->doc .= '<li>';
787            $this->doc .= '<em>'.$lang['rssfailed'].'</em>';
788            $this->externallink($url);
789            $this->doc .= '</li>';
790        }
791        $this->doc .= '</ul>';
792    }
793
794    // $numrows not yet implemented
795    function table_open($maxcols = NULL, $numrows = NULL){
796        $this->doc .= '<table class="inline">'.DOKU_LF;
797    }
798
799    function table_close(){
800        $this->doc .= '</table>'.DOKU_LF.'<br />'.DOKU_LF;
801    }
802
803    function tablerow_open(){
804        $this->doc .= DOKU_TAB . '<tr>' . DOKU_LF . DOKU_TAB . DOKU_TAB;
805    }
806
807    function tablerow_close(){
808        $this->doc .= DOKU_LF . DOKU_TAB . '</tr>' . DOKU_LF;
809    }
810
811    function tableheader_open($colspan = 1, $align = NULL){
812        $this->doc .= '<th';
813        if ( !is_null($align) ) {
814            $this->doc .= ' class="'.$align.'align"';
815        }
816        if ( $colspan > 1 ) {
817            $this->doc .= ' colspan="'.$colspan.'"';
818        }
819        $this->doc .= '>';
820    }
821
822    function tableheader_close(){
823        $this->doc .= '</th>';
824    }
825
826    function tablecell_open($colspan = 1, $align = NULL){
827        $this->doc .= '<td';
828        if ( !is_null($align) ) {
829            $this->doc .= ' class="'.$align.'align"';
830        }
831        if ( $colspan > 1 ) {
832            $this->doc .= ' colspan="'.$colspan.'"';
833        }
834        $this->doc .= '>';
835    }
836
837    function tablecell_close(){
838        $this->doc .= '</td>';
839    }
840
841    //----------------------------------------------------------
842    // Utils
843
844    /**
845     * Build a link
846     *
847     * Assembles all parts defined in $link returns HTML for the link
848     *
849     * @author Andreas Gohr <andi@splitbrain.org>
850     */
851    function _formatLink($link){
852        //make sure the url is XHTML compliant (skip mailto)
853        if(substr($link['url'],0,7) != 'mailto:'){
854            $link['url'] = str_replace('&','&amp;',$link['url']);
855            $link['url'] = str_replace('&amp;amp;','&amp;',$link['url']);
856        }
857        //remove double encodings in titles
858        $link['title'] = str_replace('&amp;amp;','&amp;',$link['title']);
859
860        // be sure there are no bad chars in url or title
861        // (we can't do this for name because it can contain an img tag)
862        $link['url']   = strtr($link['url'],array('>'=>'%3E','<'=>'%3C','"'=>'%22'));
863        $link['title'] = strtr($link['title'],array('>'=>'&gt;','<'=>'&lt;','"'=>'&quot;'));
864
865        $ret  = '';
866        $ret .= $link['pre'];
867        $ret .= '<a href="'.$link['url'].'"';
868        if($link['class'])  $ret .= ' class="'.$link['class'].'"';
869        if($link['target']) $ret .= ' target="'.$link['target'].'"';
870        if($link['title'])  $ret .= ' title="'.$link['title'].'"';
871        if($link['style'])  $ret .= ' style="'.$link['style'].'"';
872        if($link['more'])   $ret .= ' '.$link['more'];
873        $ret .= '>';
874        $ret .= $link['name'];
875        $ret .= '</a>';
876        $ret .= $link['suf'];
877        return $ret;
878    }
879
880    /**
881     * Removes any Namespace from the given name but keeps
882     * casing and special chars
883     *
884     * @author Andreas Gohr <andi@splitbrain.org>
885     */
886    function _simpleTitle($name){
887        global $conf;
888
889        if($conf['useslash']){
890            $nssep = '[:;/]';
891        }else{
892            $nssep = '[:;]';
893        }
894        $name = preg_replace('!.*'.$nssep.'!','',$name);
895        //if there is a hash we use the ancor name only
896        $name = preg_replace('!.*#!','',$name);
897        return $name;
898    }
899
900    /**
901     * Renders internal and external media
902     *
903     * @author Andreas Gohr <andi@splitbrain.org>
904     */
905    function _media ($src, $title=NULL, $align=NULL, $width=NULL,
906                      $height=NULL, $cache=NULL) {
907
908        $ret = '';
909
910        list($ext,$mime) = mimetype($src);
911        if(substr($mime,0,5) == 'image'){
912            //add image tag
913            $ret .= '<img src="'.ml($src,array('w'=>$width,'h'=>$height,'cache'=>$cache)).'"';
914            $ret .= ' class="media'.$align.'"';
915
916            if (!is_null($title)) {
917                $ret .= ' title="'.$this->_xmlEntities($title).'"';
918                $ret .= ' alt="'.$this->_xmlEntities($title).'"';
919            }elseif($ext == 'jpg' || $ext == 'jpeg'){
920                //try to use the caption from IPTC/EXIF
921                require_once(DOKU_INC.'inc/JpegMeta.php');
922                $jpeg =& new JpegMeta(mediaFN($src));
923                if($jpeg !== false) $cap = $jpeg->getTitle();
924                if($cap){
925                    $ret .= ' title="'.$this->_xmlEntities($cap).'"';
926                    $ret .= ' alt="'.$this->_xmlEntities($cap).'"';
927                }
928            }else{
929                $ret .= ' alt=""';
930            }
931
932            if ( !is_null($width) )
933                $ret .= ' width="'.$this->_xmlEntities($width).'"';
934
935            if ( !is_null($height) )
936                $ret .= ' height="'.$this->_xmlEntities($height).'"';
937
938            $ret .= ' />';
939
940        }elseif($mime == 'application/x-shockwave-flash'){
941            $ret .= '<object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"'.
942                    ' codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,40,0"';
943            if ( !is_null($width) ) $ret .= ' width="'.$this->_xmlEntities($width).'"';
944            if ( !is_null($height) ) $ret .= ' height="'.$this->_xmlEntities($height).'"';
945            $ret .= '>'.DOKU_LF;
946            $ret .= '<param name="movie" value="'.ml($src).'" />'.DOKU_LF;
947            $ret .= '<param name="quality" value="high" />'.DOKU_LF;
948            $ret .= '<embed src="'.ml($src).'"'.
949                    ' quality="high"';
950            if ( !is_null($width) ) $ret .= ' width="'.$this->_xmlEntities($width).'"';
951            if ( !is_null($height) ) $ret .= ' height="'.$this->_xmlEntities($height).'"';
952            $ret .= ' type="application/x-shockwave-flash"'.
953                    ' pluginspage="http://www.macromedia.com/go/getflashplayer"></embed>'.DOKU_LF;
954            $ret .= '</object>'.DOKU_LF;
955
956        }elseif(!is_null($title)){
957            // well at least we have a title to display
958            $ret .= $this->_xmlEntities($title);
959        }else{
960            // just show the sourcename
961            $ret .= $this->_xmlEntities(noNS($src));
962        }
963
964        return $ret;
965    }
966
967    function _xmlEntities($string) {
968        return htmlspecialchars($string);
969    }
970
971    function _headerToLink($title) {
972        return str_replace(':','',cleanID($title));
973    }
974
975    /**
976     * Adds code for section editing button
977     *
978     * This is just aplaceholder and gets replace by the button if
979     * section editing is allowed
980     *
981     * @author Andreas Gohr <andi@splitbrain.org>
982     */
983    function _secedit($f, $t){
984        $this->doc .= '<!-- SECTION ['.$f.'-'.$t.'] -->';
985    }
986
987    /**
988     * Construct a title and handle images in titles
989     *
990     * @author Harry Fuecks <hfuecks@gmail.com>
991     */
992    function _getLinkTitle($title, $default, & $isImage, $id=NULL) {
993        global $conf;
994
995        $isImage = FALSE;
996        if ( is_null($title) ) {
997            if ($conf['useheading'] && $id) {
998                $heading = p_get_first_heading($id);
999                if ($heading) {
1000                    return $this->_xmlEntities($heading);
1001                }
1002            }
1003            return $this->_xmlEntities($default);
1004        } else if ( is_string($title) ) {
1005            return $this->_xmlEntities($title);
1006        } else if ( is_array($title) ) {
1007            $isImage = TRUE;
1008            return $this->_imageTitle($title);
1009        }
1010    }
1011
1012    /**
1013     * Returns an HTML code for images used in link titles
1014     *
1015     * @todo Resolve namespace on internal images
1016     * @author Andreas Gohr <andi@splitbrain.org>
1017     */
1018    function _imageTitle($img) {
1019        return $this->_media($img['src'],
1020                              $img['title'],
1021                              $img['align'],
1022                              $img['width'],
1023                              $img['height'],
1024                              $img['cache']);
1025    }
1026}
1027
1028//Setup VIM: ex: et ts=4 enc=utf-8 :
1029