xref: /dokuwiki/inc/parser/xhtml.php (revision 9e7ed8c421085cfaaecbf7b65648c79c78e996ad) 
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     * @param  string   $wrapper   html element to wrap result if $conf['phpok'] is okff
308     *
309     * @author Andreas Gohr <andi@splitbrain.org>
310     */
311    function php($text, $wrapper='code') {
312        global $conf;
313
314        if($conf['phpok']){
315          ob_start();
316          eval($text);
317          $this->doc .= ob_get_contents();
318          ob_end_clean();
319        } else {
320          $this->doc .= p_xhtml_cached_geshi($text, 'php', $wrapper);
321        }
322    }
323
324    function phpblock($text) {
325        $this->php($text, 'pre');
326    }
327
328    /**
329     * Insert HTML if allowed
330     *
331     * @param  string   $wrapper   html element to wrap result if $conf['htmlok'] is okff
332     *
333     * @author Andreas Gohr <andi@splitbrain.org>
334     */
335    function html($text, $wrapper='code') {
336        global $conf;
337
338        if($conf['htmlok']){
339          $this->doc .= $text;
340        } else {
341          $this->doc .= p_xhtml_cached_geshi($text, 'html4strict', $wrapper);
342        }
343    }
344
345    function htmlblock($text) {
346        $this->html($text, 'pre');
347    }
348
349    function preformatted($text) {
350        $this->doc .= '<pre class="code">' . $this->_xmlEntities($text) . '</pre>'. DOKU_LF;
351    }
352
353    function file($text) {
354        $this->doc .= '<pre class="file">' . $this->_xmlEntities($text). '</pre>'. DOKU_LF;
355    }
356
357    function quote_open() {
358        $this->doc .= '<blockquote><div class="no">'.DOKU_LF;
359    }
360
361    function quote_close() {
362        $this->doc .= '</div></blockquote>'.DOKU_LF;
363    }
364
365    /**
366     * Callback for code text
367     *
368     * Uses GeSHi to highlight language syntax
369     *
370     * @author Andreas Gohr <andi@splitbrain.org>
371     */
372    function code($text, $language = NULL) {
373        global $conf;
374
375        if ( is_null($language) ) {
376            $this->preformatted($text);
377        } else {
378            $this->doc .= p_xhtml_cached_geshi($text, $language);
379        }
380    }
381
382    function acronym($acronym) {
383
384        if ( array_key_exists($acronym, $this->acronyms) ) {
385
386            $title = $this->_xmlEntities($this->acronyms[$acronym]);
387
388            $this->doc .= '<acronym title="'.$title
389                .'">'.$this->_xmlEntities($acronym).'</acronym>';
390
391        } else {
392            $this->doc .= $this->_xmlEntities($acronym);
393        }
394    }
395
396    function smiley($smiley) {
397        if ( array_key_exists($smiley, $this->smileys) ) {
398            $title = $this->_xmlEntities($this->smileys[$smiley]);
399            $this->doc .= '<img src="'.DOKU_BASE.'lib/images/smileys/'.$this->smileys[$smiley].
400                '" class="middle" alt="'.
401                    $this->_xmlEntities($smiley).'" />';
402        } else {
403            $this->doc .= $this->_xmlEntities($smiley);
404        }
405    }
406
407    /*
408    * not used
409    function wordblock($word) {
410        if ( array_key_exists($word, $this->badwords) ) {
411            $this->doc .= '** BLEEP **';
412        } else {
413            $this->doc .= $this->_xmlEntities($word);
414        }
415    }
416    */
417
418    function entity($entity) {
419        if ( array_key_exists($entity, $this->entities) ) {
420            $this->doc .= $this->entities[$entity];
421        } else {
422            $this->doc .= $this->_xmlEntities($entity);
423        }
424    }
425
426    function multiplyentity($x, $y) {
427        $this->doc .= "$x&times;$y";
428    }
429
430    function singlequoteopening() {
431        global $lang;
432        $this->doc .= $lang['singlequoteopening'];
433    }
434
435    function singlequoteclosing() {
436        global $lang;
437        $this->doc .= $lang['singlequoteclosing'];
438    }
439
440    function apostrophe() {
441        global $lang;
442        $this->doc .= $lang['apostrophe'];
443    }
444
445    function doublequoteopening() {
446        global $lang;
447        $this->doc .= $lang['doublequoteopening'];
448    }
449
450    function doublequoteclosing() {
451        global $lang;
452        $this->doc .= $lang['doublequoteclosing'];
453    }
454
455    /**
456    */
457    function camelcaselink($link) {
458      $this->internallink($link,$link);
459    }
460
461
462    function locallink($hash, $name = NULL){
463        global $ID;
464        $name  = $this->_getLinkTitle($name, $hash, $isImage);
465        $hash  = $this->_headerToLink($hash);
466        $title = $ID.' &crarr;';
467        $this->doc .= '<a href="#'.$hash.'" title="'.$title.'" class="wikilink1">';
468        $this->doc .= $name;
469        $this->doc .= '</a>';
470    }
471
472    /**
473     * Render an internal Wiki Link
474     *
475     * $search and $returnonly are not for the renderer but are used
476     * elsewhere - no need to implement them in other renderers
477     *
478     * @author Andreas Gohr <andi@splitbrain.org>
479     */
480    function internallink($id, $name = NULL, $search=NULL,$returnonly=false) {
481        global $conf;
482        global $ID;
483        // default name is based on $id as given
484        $default = $this->_simpleTitle($id);
485
486        // now first resolve and clean up the $id
487        resolve_pageid(getNS($ID),$id,$exists);
488        $name = $this->_getLinkTitle($name, $default, $isImage, $id);
489        if ( !$isImage ) {
490            if ( $exists ) {
491                $class='wikilink1';
492            } else {
493                $class='wikilink2';
494                $link['rel']='nofollow';
495            }
496        } else {
497            $class='media';
498        }
499
500        //keep hash anchor
501        list($id,$hash) = explode('#',$id,2);
502        if(!empty($hash)) $hash = $this->_headerToLink($hash);
503
504        //prepare for formating
505        $link['target'] = $conf['target']['wiki'];
506        $link['style']  = '';
507        $link['pre']    = '';
508        $link['suf']    = '';
509        // highlight link to current page
510        if ($id == $ID) {
511            $link['pre']    = '<span class="curid">';
512            $link['suf']    = '</span>';
513        }
514        $link['more']   = '';
515        $link['class']  = $class;
516        $link['url']    = wl($id);
517        $link['name']   = $name;
518        $link['title']  = $id;
519        //add search string
520        if($search){
521            ($conf['userewrite']) ? $link['url'].='?' : $link['url'].='&amp;';
522            if(is_array($search)){
523                $search = array_map('rawurlencode',$search);
524                $link['url'] .= 's[]='.join('&amp;s[]=',$search);
525            }else{
526                $link['url'] .= 's='.rawurlencode($search);
527            }
528        }
529
530        //keep hash
531        if($hash) $link['url'].='#'.$hash;
532
533        //output formatted
534        if($returnonly){
535            return $this->_formatLink($link);
536        }else{
537            $this->doc .= $this->_formatLink($link);
538        }
539    }
540
541    function externallink($url, $name = NULL) {
542        global $conf;
543
544        $name = $this->_getLinkTitle($name, $url, $isImage);
545
546        if ( !$isImage ) {
547            $class='urlextern';
548        } else {
549            $class='media';
550        }
551
552        //prepare for formating
553        $link['target'] = $conf['target']['extern'];
554        $link['style']  = '';
555        $link['pre']    = '';
556        $link['suf']    = '';
557        $link['more']   = '';
558        $link['class']  = $class;
559        $link['url']    = $url;
560
561        $link['name']   = $name;
562        $link['title']  = $this->_xmlEntities($url);
563        if($conf['relnofollow']) $link['more'] .= ' rel="nofollow"';
564
565        //output formatted
566        $this->doc .= $this->_formatLink($link);
567    }
568
569    /**
570    */
571    function interwikilink($match, $name = NULL, $wikiName, $wikiUri) {
572        global $conf;
573
574        $link = array();
575        $link['target'] = $conf['target']['interwiki'];
576        $link['pre']    = '';
577        $link['suf']    = '';
578        $link['more']   = '';
579        $link['name']   = $this->_getLinkTitle($name, $wikiUri, $isImage);
580
581        //get interwiki URL
582        $url = $this->_resolveInterWiki($wikiName,$wikiUri);
583
584        if ( !$isImage ) {
585            $class = preg_replace('/[^_\-a-z0-9]+/i','_',$wikiName);
586            $link['class'] = "interwiki iw_$class";
587        } else {
588            $link['class'] = 'media';
589        }
590
591        //do we stay at the same server? Use local target
592        if( strpos($url,DOKU_URL) === 0 ){
593            $link['target'] = $conf['target']['wiki'];
594        }
595
596        $link['url'] = $url;
597        $link['title'] = htmlspecialchars($link['url']);
598
599        //output formatted
600        $this->doc .= $this->_formatLink($link);
601    }
602
603    /**
604     */
605    function windowssharelink($url, $name = NULL) {
606        global $conf;
607        global $lang;
608        //simple setup
609        $link['target'] = $conf['target']['windows'];
610        $link['pre']    = '';
611        $link['suf']   = '';
612        $link['style']  = '';
613
614        $link['name'] = $this->_getLinkTitle($name, $url, $isImage);
615        if ( !$isImage ) {
616            $link['class'] = 'windows';
617        } else {
618            $link['class'] = 'media';
619        }
620
621
622        $link['title'] = $this->_xmlEntities($url);
623        $url = str_replace('\\','/',$url);
624        $url = 'file:///'.$url;
625        $link['url'] = $url;
626
627        //output formatted
628        $this->doc .= $this->_formatLink($link);
629    }
630
631    function emaillink($address, $name = NULL) {
632        global $conf;
633        //simple setup
634        $link = array();
635        $link['target'] = '';
636        $link['pre']    = '';
637        $link['suf']   = '';
638        $link['style']  = '';
639        $link['more']   = '';
640
641        $name = $this->_getLinkTitle($name, $address, $isImage);
642        if ( !$isImage ) {
643            $link['class']='mail JSnocheck';
644        } else {
645            $link['class']='media JSnocheck';
646        }
647
648        $address = $this->_xmlEntities($address);
649        $address = obfuscate($address);
650        $title   = $address;
651
652        if(empty($name)){
653            $name = $address;
654        }
655#elseif($isImage{
656#            $name = $this->_xmlEntities($name);
657#        }
658
659        if($conf['mailguard'] == 'visible') $address = rawurlencode($address);
660
661        $link['url']   = 'mailto:'.$address;
662        $link['name']  = $name;
663        $link['title'] = $title;
664
665        //output formatted
666        $this->doc .= $this->_formatLink($link);
667    }
668
669    function internalmedia ($src, $title=NULL, $align=NULL, $width=NULL,
670                            $height=NULL, $cache=NULL, $linking=NULL) {
671        global $ID;
672        resolve_mediaid(getNS($ID),$src, $exists);
673
674        $noLink = false;
675        $render = ($linking == 'linkonly') ? false : true;
676        $link = $this->_getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render);
677
678        list($ext,$mime) = mimetype($src);
679        if(substr($mime,0,5) == 'image' && $render){
680            $link['url'] = ml($src,array('id'=>$ID,'cache'=>$cache),($linking=='direct'));
681        }elseif($mime == 'application/x-shockwave-flash' && $render){
682            // don't link flash movies
683            $noLink = true;
684        }else{
685            // add file icons
686            $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
687            $link['class'] .= ' mediafile mf_'.$class;
688            $link['url'] = ml($src,array('id'=>$ID,'cache'=>$cache),true);
689        }
690
691        //markup non existing files
692        if (!$exists)
693          $link['class'] .= ' wikilink2';
694
695        //output formatted
696        if ($linking == 'nolink' || $noLink) $this->doc .= $link['name'];
697        else $this->doc .= $this->_formatLink($link);
698    }
699
700    function externalmedia ($src, $title=NULL, $align=NULL, $width=NULL,
701                            $height=NULL, $cache=NULL, $linking=NULL) {
702        $noLink = false;
703        $render = ($linking == 'linkonly') ? false : true;
704        $link = $this->_getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render);
705
706        $link['url']    = ml($src,array('cache'=>$cache));
707
708        list($ext,$mime) = mimetype($src);
709        if(substr($mime,0,5) == 'image' && $render){
710             // link only jpeg images
711             // if ($ext != 'jpg' && $ext != 'jpeg') $noLink = true;
712        }elseif($mime == 'application/x-shockwave-flash' && $render){
713             // don't link flash movies
714             $noLink = true;
715        }else{
716             // add file icons
717             $link['class'] .= ' mediafile mf_'.$ext;
718         }
719
720        //output formatted
721        if ($linking == 'nolink' || $noLink) $this->doc .= $link['name'];
722        else $this->doc .= $this->_formatLink($link);
723    }
724
725    /**
726     * Renders an RSS feed
727     *
728     * @author Andreas Gohr <andi@splitbrain.org>
729     */
730    function rss ($url,$params){
731        global $lang;
732        global $conf;
733
734        require_once(DOKU_INC.'inc/FeedParser.php');
735        $feed = new FeedParser();
736        $feed->set_feed_url($url);
737
738        //disable warning while fetching
739        if (!defined('DOKU_E_LEVEL')) { $elvl = error_reporting(E_ERROR); }
740        $rc = $feed->init();
741        if (!defined('DOKU_E_LEVEL')) { error_reporting($elvl); }
742
743        //decide on start and end
744        if($params['reverse']){
745            $mod = -1;
746            $start = $feed->get_item_quantity()-1;
747            $end   = $start - ($params['max']);
748            $end   = ($end < -1) ? -1 : $end;
749        }else{
750            $mod   = 1;
751            $start = 0;
752            $end   = $feed->get_item_quantity();
753            $end   = ($end > $params['max']) ? $params['max'] : $end;;
754        }
755
756        $this->doc .= '<ul class="rss">';
757        if($rc){
758            for ($x = $start; $x != $end; $x += $mod) {
759                $item = $feed->get_item($x);
760                $this->doc .= '<li><div class="li">';
761                // support feeds without links
762                $lnkurl = $item->get_permalink();
763                if($lnkurl){
764                    $this->externallink($item->get_permalink(),
765                                        $item->get_title());
766                }else{
767                    $this->doc .= ' '.$item->get_title();
768                }
769                if($params['author']){
770                    $author = $item->get_author(0);
771                    if($author){
772                        $name = $author->get_name();
773                        if(!$name) $name = $author->get_email();
774                        if($name) $this->doc .= ' '.$lang['by'].' '.$name;
775                    }
776                }
777                if($params['date']){
778                    $this->doc .= ' ('.$item->get_local_date($conf['dformat']).')';
779                }
780                if($params['details']){
781                    $this->doc .= '<div class="detail">';
782                    if($conf['htmlok']){
783                        $this->doc .= $item->get_description();
784                    }else{
785                        $this->doc .= strip_tags($item->get_description());
786                    }
787                    $this->doc .= '</div>';
788                }
789
790                $this->doc .= '</div></li>';
791            }
792        }else{
793            $this->doc .= '<li><div class="li">';
794            $this->doc .= '<em>'.$lang['rssfailed'].'</em>';
795            $this->externallink($url);
796            if($conf['allowdebug']){
797                $this->doc .= '<!--'.hsc($feed->error).'-->';
798            }
799            $this->doc .= '</div></li>';
800        }
801        $this->doc .= '</ul>';
802    }
803
804    // $numrows not yet implemented
805    function table_open($maxcols = NULL, $numrows = NULL){
806        // initialize the row counter used for classes
807        $this->_counter['row_counter'] = 0;
808        $this->doc .= '<table class="inline">'.DOKU_LF;
809    }
810
811    function table_close(){
812        $this->doc .= '</table>'.DOKU_LF;
813    }
814
815    function tablerow_open(){
816        // initialize the cell counter used for classes
817        $this->_counter['cell_counter'] = 0;
818        $class = 'row' . $this->_counter['row_counter']++;
819        $this->doc .= DOKU_TAB . '<tr class="'.$class.'">' . DOKU_LF . DOKU_TAB . DOKU_TAB;
820    }
821
822    function tablerow_close(){
823        $this->doc .= DOKU_LF . DOKU_TAB . '</tr>' . DOKU_LF;
824    }
825
826    function tableheader_open($colspan = 1, $align = NULL){
827        $class = 'class="col' . $this->_counter['cell_counter']++;
828        if ( !is_null($align) ) {
829            $class .= ' '.$align.'align';
830        }
831        $class .= '"';
832        $this->doc .= '<th ' . $class;
833        if ( $colspan > 1 ) {
834            $this->_counter['cell_counter'] += $colspan-1;
835            $this->doc .= ' colspan="'.$colspan.'"';
836        }
837        $this->doc .= '>';
838    }
839
840    function tableheader_close(){
841        $this->doc .= '</th>';
842    }
843
844    function tablecell_open($colspan = 1, $align = NULL){
845        $class = 'class="col' . $this->_counter['cell_counter']++;
846        if ( !is_null($align) ) {
847            $class .= ' '.$align.'align';
848        }
849        $class .= '"';
850        $this->doc .= '<td '.$class;
851        if ( $colspan > 1 ) {
852            $this->_counter['cell_counter'] += $colspan-1;
853            $this->doc .= ' colspan="'.$colspan.'"';
854        }
855        $this->doc .= '>';
856    }
857
858    function tablecell_close(){
859        $this->doc .= '</td>';
860    }
861
862    //----------------------------------------------------------
863    // Utils
864
865    /**
866     * Build a link
867     *
868     * Assembles all parts defined in $link returns HTML for the link
869     *
870     * @author Andreas Gohr <andi@splitbrain.org>
871     */
872    function _formatLink($link){
873        //make sure the url is XHTML compliant (skip mailto)
874        if(substr($link['url'],0,7) != 'mailto:'){
875            $link['url'] = str_replace('&','&amp;',$link['url']);
876            $link['url'] = str_replace('&amp;amp;','&amp;',$link['url']);
877        }
878        //remove double encodings in titles
879        $link['title'] = str_replace('&amp;amp;','&amp;',$link['title']);
880
881        // be sure there are no bad chars in url or title
882        // (we can't do this for name because it can contain an img tag)
883        $link['url']   = strtr($link['url'],array('>'=>'%3E','<'=>'%3C','"'=>'%22'));
884        $link['title'] = strtr($link['title'],array('>'=>'&gt;','<'=>'&lt;','"'=>'&quot;'));
885
886        $ret  = '';
887        $ret .= $link['pre'];
888        $ret .= '<a href="'.$link['url'].'"';
889        if(!empty($link['class']))  $ret .= ' class="'.$link['class'].'"';
890        if(!empty($link['target'])) $ret .= ' target="'.$link['target'].'"';
891        if(!empty($link['title']))  $ret .= ' title="'.$link['title'].'"';
892        if(!empty($link['style']))  $ret .= ' style="'.$link['style'].'"';
893        if(!empty($link['rel']))    $ret .= ' rel="'.$link['rel'].'"';
894        if(!empty($link['more']))   $ret .= ' '.$link['more'];
895        $ret .= '>';
896        $ret .= $link['name'];
897        $ret .= '</a>';
898        $ret .= $link['suf'];
899        return $ret;
900    }
901
902    /**
903     * Renders internal and external media
904     *
905     * @author Andreas Gohr <andi@splitbrain.org>
906     */
907    function _media ($src, $title=NULL, $align=NULL, $width=NULL,
908                      $height=NULL, $cache=NULL, $render = true) {
909
910        $ret = '';
911
912        list($ext,$mime) = mimetype($src);
913        if(substr($mime,0,5) == 'image'){
914            // first get the $title
915            if (!is_null($title)) {
916                $title  = $this->_xmlEntities($title);
917            }elseif($ext == 'jpg' || $ext == 'jpeg'){
918                //try to use the caption from IPTC/EXIF
919                require_once(DOKU_INC.'inc/JpegMeta.php');
920                $jpeg =& new JpegMeta(mediaFN($src));
921                if($jpeg !== false) $cap = $jpeg->getTitle();
922                if($cap){
923                    $title = $this->_xmlEntities($cap);
924                }
925            }
926            if (!$render) {
927                // if the picture is not supposed to be rendered
928                // return the title of the picture
929                if (!$title) {
930                    // just show the sourcename
931                    $title = $this->_xmlEntities(basename(noNS($src)));
932                }
933                return $title;
934            }
935            //add image tag
936            $ret .= '<img src="'.ml($src,array('w'=>$width,'h'=>$height,'cache'=>$cache)).'"';
937            $ret .= ' class="media'.$align.'"';
938
939            // make left/right alignment for no-CSS view work (feeds)
940            if($align == 'right') $ret .= ' align="right"';
941            if($align == 'left')  $ret .= ' align="left"';
942
943            if ($title) {
944                $ret .= ' title="' . $title . '"';
945                $ret .= ' alt="'   . $title .'"';
946            }else{
947                $ret .= ' alt=""';
948            }
949
950            if ( !is_null($width) )
951                $ret .= ' width="'.$this->_xmlEntities($width).'"';
952
953            if ( !is_null($height) )
954                $ret .= ' height="'.$this->_xmlEntities($height).'"';
955
956            $ret .= ' />';
957
958        }elseif($mime == 'application/x-shockwave-flash'){
959            if (!$render) {
960                // if the flash is not supposed to be rendered
961                // return the title of the flash
962                if (!$title) {
963                    // just show the sourcename
964                    $title = $this->_xmlEntities(basename(noNS($src)));
965                }
966                return $title;
967            }
968
969            $ret .= '<object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"'.
970                    ' codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,40,0"';
971            if ( !is_null($width) ) $ret .= ' width="'.$this->_xmlEntities($width).'"';
972            if ( !is_null($height) ) $ret .= ' height="'.$this->_xmlEntities($height).'"';
973            $ret .= '>'.DOKU_LF;
974            $ret .= '<param name="movie" value="'.ml($src).'" />'.DOKU_LF;
975            $ret .= '<param name="quality" value="high" />'.DOKU_LF;
976            $ret .= '<embed src="'.ml($src).'"'.
977                    ' quality="high"';
978            if ( !is_null($width) ) $ret .= ' width="'.$this->_xmlEntities($width).'"';
979            if ( !is_null($height) ) $ret .= ' height="'.$this->_xmlEntities($height).'"';
980            $ret .= ' type="application/x-shockwave-flash"'.
981                    ' pluginspage="http://www.macromedia.com/go/getflashplayer"></embed>'.DOKU_LF;
982            $ret .= '</object>'.DOKU_LF;
983
984        }elseif($title){
985            // well at least we have a title to display
986            $ret .= $this->_xmlEntities($title);
987        }else{
988            // just show the sourcename
989            $ret .= $this->_xmlEntities(basename(noNS($src)));
990        }
991
992        return $ret;
993    }
994
995    function _xmlEntities($string) {
996        return htmlspecialchars($string,ENT_QUOTES,'UTF-8');
997    }
998
999    /**
1000     * Creates a linkid from a headline
1001     *
1002     * @param string  $title   The headline title
1003     * @param boolean $create  Create a new unique ID?
1004     * @author Andreas Gohr <andi@splitbrain.org>
1005     */
1006    function _headerToLink($title,$create=false) {
1007        $title = str_replace(':','',cleanID($title));
1008        $title = ltrim($title,'0123456789._-');
1009        if(empty($title)) $title='section';
1010
1011        if($create){
1012            // make sure tiles are unique
1013            $num = '';
1014            while(in_array($title.$num,$this->headers)){
1015                ($num) ? $num++ : $num = 1;
1016            }
1017            $title = $title.$num;
1018            $this->headers[] = $title;
1019        }
1020
1021        return $title;
1022    }
1023
1024    /**
1025     * Construct a title and handle images in titles
1026     *
1027     * @author Harry Fuecks <hfuecks@gmail.com>
1028     */
1029    function _getLinkTitle($title, $default, & $isImage, $id=NULL) {
1030        global $conf;
1031
1032        $isImage = false;
1033        if ( is_null($title) || trim($title)=='') {
1034            if ($conf['useheading'] && $id) {
1035                $heading = p_get_first_heading($id,true);
1036                if ($heading) {
1037                    return $this->_xmlEntities($heading);
1038                }
1039            }
1040            return $this->_xmlEntities($default);
1041        } else if ( is_array($title) ) {
1042            $isImage = true;
1043            return $this->_imageTitle($title);
1044        } else {
1045            return $this->_xmlEntities($title);
1046        }
1047    }
1048
1049    /**
1050     * Returns an HTML code for images used in link titles
1051     *
1052     * @todo Resolve namespace on internal images
1053     * @author Andreas Gohr <andi@splitbrain.org>
1054     */
1055    function _imageTitle($img) {
1056        return $this->_media($img['src'],
1057                              $img['title'],
1058                              $img['align'],
1059                              $img['width'],
1060                              $img['height'],
1061                              $img['cache']);
1062    }
1063
1064    /**
1065     * _getMediaLinkConf is a helperfunction to internalmedia() and externalmedia()
1066     * which returns a basic link to a media.
1067     *
1068     * @author Pierre Spring <pierre.spring@liip.ch>
1069     * @param string $src
1070     * @param string $title
1071     * @param string $align
1072     * @param string $width
1073     * @param string $height
1074     * @param string $cache
1075     * @param string $render
1076     * @access protected
1077     * @return array
1078     */
1079    function _getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render)
1080    {
1081        global $conf;
1082
1083        $link = array();
1084        $link['class']  = 'media';
1085        $link['style']  = '';
1086        $link['pre']    = '';
1087        $link['suf']    = '';
1088        $link['more']   = '';
1089        $link['target'] = $conf['target']['media'];
1090        $link['title']  = $this->_xmlEntities($src);
1091        $link['name']   = $this->_media($src, $title, $align, $width, $height, $cache, $render);
1092
1093        return $link;
1094    }
1095}
1096
1097//Setup VIM: ex: et ts=4 enc=utf-8 :
1098