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