xref: /dokuwiki/inc/parser/xhtml.php (revision 1c2d1019f48fa6b2dbc154f7534341ad0869a5d7) 
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            $link['class'] = "interwiki iw_$wikiName";
582        } else {
583            $link['class'] = 'media';
584        }
585
586        //do we stay at the same server? Use local target
587        if( strpos($url,DOKU_URL) === 0 ){
588            $link['target'] = $conf['target']['wiki'];
589        }
590
591        //split into hash and url part
592        list($wikiUri,$hash) = explode('#',$wikiUri,2);
593
594        //replace placeholder
595        if(preg_match('#\{(URL|NAME|SCHEME|HOST|PORT|PATH|QUERY)\}#',$url)){
596            //use placeholders
597            $url = str_replace('{URL}',urlencode($wikiUri),$url);
598            $url = str_replace('{NAME}',$wikiUri,$url);
599            $parsed = parse_url($wikiUri);
600            if(!$parsed['port']) $parsed['port'] = 80;
601            $url = str_replace('{SCHEME}',$parsed['scheme'],$url);
602            $url = str_replace('{HOST}',$parsed['host'],$url);
603            $url = str_replace('{PORT}',$parsed['port'],$url);
604            $url = str_replace('{PATH}',$parsed['path'],$url);
605            $url = str_replace('{QUERY}',$parsed['query'],$url);
606            $link['url'] = $url;
607        }else{
608            //default
609            $link['url'] = $url.urlencode($wikiUri);
610        }
611        if($hash) $link['url'] .= '#'.urlencode($hash);
612
613        $link['title'] = htmlspecialchars($link['url']);
614
615        //output formatted
616        $this->doc .= $this->_formatLink($link);
617    }
618
619    /**
620     */
621    function windowssharelink($url, $name = NULL) {
622        global $conf;
623        global $lang;
624        //simple setup
625        $link['target'] = $conf['target']['windows'];
626        $link['pre']    = '';
627        $link['suf']   = '';
628        $link['style']  = '';
629        //Display error on browsers other than IE
630        $link['more'] = 'onclick="if(document.all == null){alert(\''.
631                        $this->_xmlEntities($lang['nosmblinks'],ENT_QUOTES).
632                        '\');}" onkeypress="if(document.all == null){alert(\''.
633                        $this->_xmlEntities($lang['nosmblinks'],ENT_QUOTES).'\');}"';
634
635        $link['name'] = $this->_getLinkTitle($name, $url, $isImage);
636        if ( !$isImage ) {
637            $link['class'] = 'windows';
638        } else {
639            $link['class'] = 'media';
640        }
641
642
643        $link['title'] = $this->_xmlEntities($url);
644        $url = str_replace('\\','/',$url);
645        $url = 'file:///'.$url;
646        $link['url'] = $url;
647
648        //output formatted
649        $this->doc .= $this->_formatLink($link);
650    }
651
652    function emaillink($address, $name = NULL) {
653        global $conf;
654        //simple setup
655        $link = array();
656        $link['target'] = '';
657        $link['pre']    = '';
658        $link['suf']   = '';
659        $link['style']  = '';
660        $link['more']   = '';
661
662        //we just test for image here - we need to encode the title our self
663        $this->_getLinkTitle($name, $address, $isImage);
664        if ( !$isImage ) {
665            $link['class']='mail JSnocheck';
666        } else {
667            $link['class']='media JSnocheck';
668        }
669
670        $address = $this->_xmlEntities($address);
671        $address = obfuscate($address);
672        $title   = $address;
673        if(empty($name)){
674            $name = $address;
675        }else{
676            $name = $this->_xmlEntities($name);
677        }
678
679        if($conf['mailguard'] == 'visible') $address = rawurlencode($address);
680
681        $link['url']   = 'mailto:'.$address;
682        $link['name']  = $name;
683        $link['title'] = $title;
684
685        //output formatted
686        $this->doc .= $this->_formatLink($link);
687    }
688
689    function internalmedia ($src, $title=NULL, $align=NULL, $width=NULL,
690                            $height=NULL, $cache=NULL, $linking=NULL) {
691        global $conf;
692        global $ID;
693        resolve_mediaid(getNS($ID),$src, $exists);
694
695        $link = array();
696        $link['class']  = 'media';
697        $link['style']  = '';
698        $link['pre']    = '';
699        $link['suf']    = '';
700        $link['more']   = '';
701        $link['target'] = $conf['target']['media'];
702
703        $link['title']  = $this->_xmlEntities($src);
704        list($ext,$mime) = mimetype($src);
705        if(substr($mime,0,5) == 'image'){
706             // link only jpeg images
707             // if ($ext != 'jpg' && $ext != 'jpeg') $noLink = TRUE;
708             $link['url'] = ml($src,array('id'=>$ID,'cache'=>$cache),($linking=='direct'));
709         }elseif($mime == 'application/x-shockwave-flash'){
710             // don't link flash movies
711             $noLink = TRUE;
712         }else{
713             // add file icons
714             $link['class'] = 'urlextern';
715             if(@file_exists(DOKU_INC.'lib/images/fileicons/'.$ext.'.png')){
716                 $link['style']='background-image: url('.DOKU_BASE.'lib/images/fileicons/'.$ext.'.png)';
717             }elseif(@file_exists(DOKU_INC.'lib/images/fileicons/'.$ext.'.gif')){
718                 $link['style']='background-image: url('.DOKU_BASE.'lib/images/fileicons/'.$ext.'.gif)';
719             }else{
720                 $link['style']='background-image: url('.DOKU_BASE.'lib/images/fileicons/file.png)';
721             }
722             $link['url'] = ml($src,array('id'=>$ID,'cache'=>$cache),true);
723         }
724         $link['name']   = $this->_media ($src, $title, $align, $width, $height, $cache);
725
726         //output formatted
727         if ($linking == 'nolink' || $noLink) $this->doc .= $link['name'];
728         else $this->doc .= $this->_formatLink($link);
729    }
730
731    /**
732     * @todo don't add link for flash
733     */
734    function externalmedia ($src, $title=NULL, $align=NULL, $width=NULL,
735                            $height=NULL, $cache=NULL, $linking=NULL) {
736        global $conf;
737
738        $link = array();
739        $link['class']  = 'media';
740        $link['style']  = '';
741        $link['pre']    = '';
742        $link['suf']    = '';
743        $link['more']   = '';
744        $link['target'] = $conf['target']['media'];
745
746        $link['title']  = $this->_xmlEntities($src);
747        $link['url']    = ml($src,array('cache'=>$cache));
748        $link['name']   = $this->_media ($src, $title, $align, $width, $height, $cache);
749
750
751        list($ext,$mime) = mimetype($src);
752        if(substr($mime,0,5) == 'image'){
753             // link only jpeg images
754             // if ($ext != 'jpg' && $ext != 'jpeg') $noLink = TRUE;
755        }elseif($mime == 'application/x-shockwave-flash'){
756             // don't link flash movies
757             $noLink = TRUE;
758        }else{
759             // add file icons
760             $link['class'] = 'urlextern';
761             if(@file_exists(DOKU_INC.'lib/images/fileicons/'. $ext.'.png')){
762                 $link['style']='background-image: url('.DOKU_BASE.'lib/images/fileicons/'.$ext.'.png)';
763             }elseif(@file_exists(DOKU_INC.'lib/images/fileicons/'.$ext.'.gif')){
764                 $link['style']='background-image: url('.DOKU_BASE.'lib/images/fileicons/'.$ext.'.gif)';
765             }else{
766                 $link['style']='background-image: url('.DOKU_BASE.'lib/images/fileicons/file.png)';
767             }
768         }
769
770        //output formatted
771        if ($linking == 'nolink' || $noLink) $this->doc .= $link['name'];
772        else $this->doc .= $this->_formatLink($link);
773    }
774
775    /**
776     * Renders an RSS feed using Magpie
777     *
778     * @author Andreas Gohr <andi@splitbrain.org>
779     */
780    function rss ($url){
781        global $lang;
782        define('MAGPIE_CACHE_ON', false); //we do our own caching
783        define('MAGPIE_DIR', DOKU_INC.'inc/magpie/');
784        define('MAGPIE_OUTPUT_ENCODING','UTF-8'); //return all feeds as UTF-8
785        require_once(MAGPIE_DIR.'/rss_fetch.inc');
786
787        //disable warning while fetching
788        $elvl = error_reporting(E_ERROR);
789        $rss  = fetch_rss($url);
790        error_reporting($elvl);
791
792        $this->doc .= '<ul class="rss">';
793        if($rss){
794            foreach ($rss->items as $item ) {
795                $this->doc .= '<li>';
796                $this->externallink($item['link'],$item['title']);
797                $this->doc .= '</li>';
798            }
799        }else{
800            $this->doc .= '<li>';
801            $this->doc .= '<em>'.$lang['rssfailed'].'</em>';
802            $this->externallink($url);
803            $this->doc .= '</li>';
804        }
805        $this->doc .= '</ul>';
806    }
807
808    // $numrows not yet implemented
809    function table_open($maxcols = NULL, $numrows = NULL){
810        $this->doc .= '<table class="inline">'.DOKU_LF;
811    }
812
813    function table_close(){
814        $this->doc .= '</table>'.DOKU_LF.'<br />'.DOKU_LF;
815    }
816
817    function tablerow_open(){
818        $this->doc .= DOKU_TAB . '<tr>' . DOKU_LF . DOKU_TAB . DOKU_TAB;
819    }
820
821    function tablerow_close(){
822        $this->doc .= DOKU_LF . DOKU_TAB . '</tr>' . DOKU_LF;
823    }
824
825    function tableheader_open($colspan = 1, $align = NULL){
826        $this->doc .= '<th';
827        if ( !is_null($align) ) {
828            $this->doc .= ' class="'.$align.'align"';
829        }
830        if ( $colspan > 1 ) {
831            $this->doc .= ' colspan="'.$colspan.'"';
832        }
833        $this->doc .= '>';
834    }
835
836    function tableheader_close(){
837        $this->doc .= '</th>';
838    }
839
840    function tablecell_open($colspan = 1, $align = NULL){
841        $this->doc .= '<td';
842        if ( !is_null($align) ) {
843            $this->doc .= ' class="'.$align.'align"';
844        }
845        if ( $colspan > 1 ) {
846            $this->doc .= ' colspan="'.$colspan.'"';
847        }
848        $this->doc .= '>';
849    }
850
851    function tablecell_close(){
852        $this->doc .= '</td>';
853    }
854
855    //----------------------------------------------------------
856    // Utils
857
858    /**
859     * Build a link
860     *
861     * Assembles all parts defined in $link returns HTML for the link
862     *
863     * @author Andreas Gohr <andi@splitbrain.org>
864     */
865    function _formatLink($link){
866        //make sure the url is XHTML compliant (skip mailto)
867        if(substr($link['url'],0,7) != 'mailto:'){
868            $link['url'] = str_replace('&','&amp;',$link['url']);
869            $link['url'] = str_replace('&amp;amp;','&amp;',$link['url']);
870        }
871        //remove double encodings in titles
872        $link['title'] = str_replace('&amp;amp;','&amp;',$link['title']);
873
874        // be sure there are no bad chars in url or title
875        // (we can't do this for name because it can contain an img tag)
876        $link['url']   = strtr($link['url'],array('>'=>'%3E','<'=>'%3C','"'=>'%22'));
877        $link['title'] = strtr($link['title'],array('>'=>'&gt;','<'=>'&lt;','"'=>'&quot;'));
878
879        $ret  = '';
880        $ret .= $link['pre'];
881        $ret .= '<a href="'.$link['url'].'"';
882        if($link['class'])  $ret .= ' class="'.$link['class'].'"';
883        if($link['target']) $ret .= ' target="'.$link['target'].'"';
884        if($link['title'])  $ret .= ' title="'.$link['title'].'"';
885        if($link['style'])  $ret .= ' style="'.$link['style'].'"';
886        if($link['more'])   $ret .= ' '.$link['more'];
887        $ret .= '>';
888        $ret .= $link['name'];
889        $ret .= '</a>';
890        $ret .= $link['suf'];
891        return $ret;
892    }
893
894    /**
895     * Removes any Namespace from the given name but keeps
896     * casing and special chars
897     *
898     * @author Andreas Gohr <andi@splitbrain.org>
899     */
900    function _simpleTitle($name){
901        global $conf;
902
903        if($conf['useslash']){
904            $nssep = '[:;/]';
905        }else{
906            $nssep = '[:;]';
907        }
908        $name = preg_replace('!.*'.$nssep.'!','',$name);
909        //if there is a hash we use the ancor name only
910        $name = preg_replace('!.*#!','',$name);
911        return $name;
912    }
913
914    /**
915     * Renders internal and external media
916     *
917     * @author Andreas Gohr <andi@splitbrain.org>
918     */
919    function _media ($src, $title=NULL, $align=NULL, $width=NULL,
920                      $height=NULL, $cache=NULL) {
921
922        $ret = '';
923
924        list($ext,$mime) = mimetype($src);
925        if(substr($mime,0,5) == 'image'){
926            //add image tag
927            $ret .= '<img src="'.ml($src,array('w'=>$width,'h'=>$height,'cache'=>$cache)).'"';
928            $ret .= ' class="media'.$align.'"';
929
930            if (!is_null($title)) {
931                $ret .= ' title="'.$this->_xmlEntities($title).'"';
932                $ret .= ' alt="'.$this->_xmlEntities($title).'"';
933            }elseif($ext == 'jpg' || $ext == 'jpeg'){
934                //try to use the caption from IPTC/EXIF
935                require_once(DOKU_INC.'inc/JpegMeta.php');
936                $jpeg =& new JpegMeta(mediaFN($src));
937                if($jpeg !== false) $cap = $jpeg->getTitle();
938                if($cap){
939                    $ret .= ' title="'.$this->_xmlEntities($cap).'"';
940                    $ret .= ' alt="'.$this->_xmlEntities($cap).'"';
941                }
942            }else{
943                $ret .= ' alt=""';
944            }
945
946            if ( !is_null($width) )
947                $ret .= ' width="'.$this->_xmlEntities($width).'"';
948
949            if ( !is_null($height) )
950                $ret .= ' height="'.$this->_xmlEntities($height).'"';
951
952            $ret .= ' />';
953
954        }elseif($mime == 'application/x-shockwave-flash'){
955            $ret .= '<object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"'.
956                    ' codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,40,0"';
957            if ( !is_null($width) ) $ret .= ' width="'.$this->_xmlEntities($width).'"';
958            if ( !is_null($height) ) $ret .= ' height="'.$this->_xmlEntities($height).'"';
959            $ret .= '>'.DOKU_LF;
960            $ret .= '<param name="movie" value="'.ml($src).'" />'.DOKU_LF;
961            $ret .= '<param name="quality" value="high" />'.DOKU_LF;
962            $ret .= '<embed src="'.ml($src).'"'.
963                    ' quality="high"';
964            if ( !is_null($width) ) $ret .= ' width="'.$this->_xmlEntities($width).'"';
965            if ( !is_null($height) ) $ret .= ' height="'.$this->_xmlEntities($height).'"';
966            $ret .= ' type="application/x-shockwave-flash"'.
967                    ' pluginspage="http://www.macromedia.com/go/getflashplayer"></embed>'.DOKU_LF;
968            $ret .= '</object>'.DOKU_LF;
969
970        }elseif(!is_null($title)){
971            // well at least we have a title to display
972            $ret .= $this->_xmlEntities($title);
973        }else{
974            // just show the sourcename
975            $ret .= $this->_xmlEntities(noNS($src));
976        }
977
978        return $ret;
979    }
980
981    function _xmlEntities($string) {
982        return htmlspecialchars($string);
983    }
984
985    function _headerToLink($title) {
986        return str_replace(':','',cleanID($title));
987    }
988
989    /**
990     * Adds code for section editing button
991     *
992     * This is just aplaceholder and gets replace by the button if
993     * section editing is allowed
994     *
995     * @author Andreas Gohr <andi@splitbrain.org>
996     */
997    function _secedit($f, $t){
998        $this->doc .= '<!-- SECTION ['.$f.'-'.$t.'] -->';
999    }
1000
1001    /**
1002     * Construct a title and handle images in titles
1003     *
1004     * @author Harry Fuecks <hfuecks@gmail.com>
1005     */
1006    function _getLinkTitle($title, $default, & $isImage, $id=NULL) {
1007        global $conf;
1008
1009        $isImage = FALSE;
1010        if ( is_null($title) ) {
1011            if ($conf['useheading'] && $id) {
1012                $heading = p_get_first_heading($id);
1013                if ($heading) {
1014                    return $this->_xmlEntities($heading);
1015                }
1016            }
1017            return $this->_xmlEntities($default);
1018        } else if ( is_string($title) ) {
1019            return $this->_xmlEntities($title);
1020        } else if ( is_array($title) ) {
1021            $isImage = TRUE;
1022            return $this->_imageTitle($title);
1023        }
1024    }
1025
1026    /**
1027     * Returns an HTML code for images used in link titles
1028     *
1029     * @todo Resolve namespace on internal images
1030     * @author Andreas Gohr <andi@splitbrain.org>
1031     */
1032    function _imageTitle($img) {
1033        return $this->_media($img['src'],
1034                              $img['title'],
1035                              $img['align'],
1036                              $img['width'],
1037                              $img['height'],
1038                              $img['cache']);
1039    }
1040}
1041
1042//Setup VIM: ex: et ts=4 enc=utf-8 :
1043