* @author Andreas Gohr */ if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/'); if ( !defined('DOKU_LF') ) { // Some whitespace to help View > Source define ('DOKU_LF',"\n"); } if ( !defined('DOKU_TAB') ) { // Some whitespace to help View > Source define ('DOKU_TAB',"\t"); } require_once DOKU_INC . 'inc/parser/renderer.php'; require_once DOKU_INC . 'inc/pluginutils.php'; /** * The Renderer */ class Doku_Renderer_xhtml extends Doku_Renderer { var $doc = ''; var $headers = array(); var $footnotes = array(); var $acronyms = array(); var $smileys = array(); var $badwords = array(); var $entities = array(); var $interwiki = array(); var $lastsec = 0; var $store = ''; function document_start() { } function document_end() { // add button for last section if any and more than one if($this->lastsec > 1) $this->_secedit($this->lastsec,''); if ( count ($this->footnotes) > 0 ) { $this->doc .= '
'.DOKU_LF; foreach ( $this->footnotes as $footnote ) { $this->doc .= $footnote; } $this->doc .= '
'.DOKU_LF; } } //handles plugin rendering function plugin($name,$data){ $plugin = null; if(plugin_load('syntax',$name,$plugin)){ $plugin->render('xhtml',$this,$data); } } function toc_open() { global $lang; $this->doc .= '
'.DOKU_LF; $this->doc .= '
'; $this->doc .= ' '; $this->doc .= $lang['toc']; $this->doc .= '
'.DOKU_LF; $this->doc .= '
'.DOKU_LF; } function tocbranch_open($level) { $this->doc .= '
    '.DOKU_LF; } function tocitem_open($level, $empty = FALSE) { if ( !$empty ) { $this->doc .= '
  • '; } else { $this->doc .= '
  • '; } } function tocelement($level, $title) { $this->doc .= ''; $this->doc .= $this->_xmlEntities($title); $this->doc .= ''; } function tocitem_close($level) { $this->doc .= '
  • '.DOKU_LF; } function tocbranch_close($level) { $this->doc .= '
'.DOKU_LF; } function toc_close() { $this->doc .= '
'.DOKU_LF.'
'.DOKU_LF; } function header($text, $level, $pos) { global $conf; //handle section editing if($level <= $conf['maxseclevel']){ // add button for last section if any if($this->lastsec) $this->_secedit($this->lastsec,$pos-1); // remember current position $this->lastsec = $pos; } $this->doc .= DOKU_LF.''; $this->doc .= $this->_xmlEntities($text); $this->doc .= "".DOKU_LF; } function section_open($level) { $this->doc .= "
".DOKU_LF; } function section_close() { $this->doc .= DOKU_LF.'
'.DOKU_LF; } function cdata($text) { $this->doc .= $this->_xmlEntities($text); } function p_open() { $this->doc .= DOKU_LF.'

'.DOKU_LF; } function p_close() { $this->doc .= DOKU_LF.'

'.DOKU_LF; } function linebreak() { $this->doc .= '
'.DOKU_LF; } function hr() { $this->doc .= '
'.DOKU_LF; } function strong_open() { $this->doc .= ''; } function strong_close() { $this->doc .= ''; } function emphasis_open() { $this->doc .= ''; } function emphasis_close() { $this->doc .= ''; } function underline_open() { $this->doc .= ''; } function underline_close() { $this->doc .= ''; } function monospace_open() { $this->doc .= ''; } function monospace_close() { $this->doc .= ''; } function subscript_open() { $this->doc .= ''; } function subscript_close() { $this->doc .= ''; } function superscript_open() { $this->doc .= ''; } function superscript_close() { $this->doc .= ''; } function deleted_open() { $this->doc .= ''; } function deleted_close() { $this->doc .= ''; } /** * Callback for footnote start syntax * * All following content will go to the footnote instead of * the document. To achive this the previous rendered content * is moved to $store and $doc is cleared * * @author Andreas Gohr */ function footnote_open() { #$id = $this->_newFootnoteId(); $id = count($this->footnotes)+1; $this->doc .= ''.$id.')'; // move current content to store and record footnote $this->store = $this->doc; $this->doc = ''; $this->doc .= '
'; $this->doc .= ''; $this->doc .= $id.') '.DOKU_LF; } /** * Callback for footnote end syntax * * All rendered content is moved to the $footnotes array and the old * content is restored from $store again * * @author Andreas Gohr */ function footnote_close() { $this->doc .= '
' . DOKU_LF; // put recorded footnote into the stack and restore old content $this->footnotes[count($this->footnotes)] = $this->doc; $this->doc = $this->store; $this->store = ''; } function listu_open() { $this->doc .= '
    '.DOKU_LF; } function listu_close() { $this->doc .= '
'.DOKU_LF; } function listo_open() { $this->doc .= '
    '.DOKU_LF; } function listo_close() { $this->doc .= '
'.DOKU_LF; } function listitem_open($level) { $this->doc .= '
  • '; } function listitem_close() { $this->doc .= '
  • '.DOKU_LF; } function listcontent_open() { $this->doc .= '
    '; } function listcontent_close() { $this->doc .= '
    '.DOKU_LF; } function unformatted($text) { $this->doc .= $this->_xmlEntities($text); } /** * Execute PHP code if allowed * * @author Andreas Gohr */ function php($text) { global $conf; if($conf['phpok']){ ob_start(); eval($text); $this->doc .= ob_get_contents(); ob_end_clean(); }else{ $this->file($text); } } /** * Insert HTML if allowed * * @author Andreas Gohr */ function html($text) { global $conf; if($conf['htmlok']){ $this->doc .= $text; }else{ $this->file($text); } } function preformatted($text) { $this->doc .= '
    ' . $this->_xmlEntities($text) . '
    '. DOKU_LF; } function file($text) { $this->doc .= '
    ' . $this->_xmlEntities($text). '
    '. DOKU_LF; } function quote_open() { $this->doc .= '
    '.DOKU_LF; } function quote_close() { $this->doc .= '
    '.DOKU_LF; } /** * Callback for code text * * Uses GeSHi to highlight language syntax * * @author Andreas Gohr */ function code($text, $language = NULL) { global $conf; if ( is_null($language) ) { $this->preformatted($text); } else { //strip leading blank line $text = preg_replace('/^\s*?\n/','',$text); // Handle with Geshi here require_once(DOKU_INC . 'inc/geshi.php'); $geshi = new GeSHi($text, strtolower($language), DOKU_INC . 'inc/geshi'); $geshi->set_encoding('utf-8'); $geshi->enable_classes(); $geshi->set_header_type(GESHI_HEADER_PRE); $geshi->set_overall_class("code $language"); $geshi->set_link_target($conf['target']['extern']); $text = $geshi->parse_code(); $this->doc .= $text; } } function acronym($acronym) { if ( array_key_exists($acronym, $this->acronyms) ) { $title = $this->_xmlEntities($this->acronyms[$acronym]); $this->doc .= ''.$this->_xmlEntities($acronym).''; } else { $this->doc .= $this->_xmlEntities($acronym); } } function smiley($smiley) { if ( array_key_exists($smiley, $this->smileys) ) { $title = $this->_xmlEntities($this->smileys[$smiley]); $this->doc .= ''.
                    $this->_xmlEntities($smiley).''; } else { $this->doc .= $this->_xmlEntities($smiley); } } /* * not used function wordblock($word) { if ( array_key_exists($word, $this->badwords) ) { $this->doc .= '** BLEEP **'; } else { $this->doc .= $this->_xmlEntities($word); } } */ function entity($entity) { if ( array_key_exists($entity, $this->entities) ) { $this->doc .= $this->entities[$entity]; } else { $this->doc .= $this->_xmlEntities($entity); } } function multiplyentity($x, $y) { $this->doc .= "$x×$y"; } function singlequoteopening() { $this->doc .= "‘"; } function singlequoteclosing() { $this->doc .= "’"; } function doublequoteopening() { $this->doc .= "“"; } function doublequoteclosing() { $this->doc .= "”"; } /** */ function camelcaselink($link) { $this->internallink($link,$link); } function locallink($hash, $name = NULL){ global $ID; $name = $this->_getLinkTitle($name, $hash, $isImage); $hash = $this->_headerToLink($hash); $title = $ID.' ↵'; $this->doc .= ''; $this->doc .= $name; $this->doc .= ''; } /** * Render an internal Wiki Link * * $search and $returnonly are not for the renderer but are used * elsewhere - no need to implement them in other renderers * * @author Andreas Gohr */ function internallink($id, $name = NULL, $search=NULL,$returnonly=false) { global $conf; global $ID; // default name is based on $id as given $default = $this->_simpleTitle($id); // now first resolve and clean up the $id resolve_pageid(getNS($ID),$id,$exists); $name = $this->_getLinkTitle($name, $default, $isImage, $id); if ( !$isImage ) { if ( $exists ) { $class='wikilink1'; } else { $class='wikilink2'; } } else { $class='media'; } //keep hash anchor list($id,$hash) = split('#',$id,2); //prepare for formating $link['target'] = $conf['target']['wiki']; $link['style'] = ''; $link['pre'] = ''; $link['suf'] = ''; // highlight link to current page if ($id == $ID) { $link['pre'] = ''; $link['suf'] = ''; } $link['more'] = 'onclick="return svchk()" onkeypress="return svchk()"'; $link['class'] = $class; $link['url'] = wl($id); $link['name'] = $name; $link['title'] = $id; //add search string if($search){ ($conf['userewrite']) ? $link['url'].='?s=' : $link['url'].='&s='; $link['url'] .= urlencode($search); } //keep hash if($hash) $link['url'].='#'.$hash; //output formatted if($returnonly){ return $this->_formatLink($link); }else{ $this->doc .= $this->_formatLink($link); } } function externallink($url, $name = NULL) { global $conf; $name = $this->_getLinkTitle($name, $url, $isImage); // add protocol on simple short URLs if(substr($url,0,3) == 'ftp' && (substr($url,0,6) != 'ftp://')) $url = 'ftp://'.$url; if(substr($url,0,3) == 'www') $url = 'http://'.$url; if ( !$isImage ) { $class='urlextern'; } else { $class='media'; } //prepare for formating $link['target'] = $conf['target']['extern']; $link['style'] = ''; $link['pre'] = ''; $link['suf'] = ''; $link['more'] = 'onclick="return svchk()" onkeypress="return svchk()"'; $link['class'] = $class; $link['url'] = $url; $link['name'] = $name; $link['title'] = $this->_xmlEntities($url); if($conf['relnofollow']) $link['more'] .= ' rel="nofollow"'; //output formatted $this->doc .= $this->_formatLink($link); } /** */ function interwikilink($match, $name = NULL, $wikiName, $wikiUri) { global $conf; $link = array(); $link['target'] = $conf['target']['interwiki']; $link['pre'] = ''; $link['suf'] = ''; $link['more'] = 'onclick="return svchk()" onkeypress="return svchk()"'; $link['name'] = $this->_getLinkTitle($name, $wikiUri, $isImage); if ( !$isImage ) { $link['class'] = 'interwiki'; } else { $link['class'] = 'media'; } //get interwiki URL if ( isset($this->interwiki[$wikiName]) ) { $url = $this->interwiki[$wikiName]; } else { // Default to Google I'm feeling lucky $url = 'http://www.google.com/search?q={URL}&btnI=lucky'; $wikiName = 'go'; } if(!$isImage){ //if ico exists set additional style if(@file_exists(DOKU_INC.'lib/images/interwiki/'.$wikiName.'.png')){ $link['style']='background-image: url('.DOKU_BASE.'lib/images/interwiki/'.$wikiName.'.png)'; }elseif(@file_exists(DOKU_INC.'lib/images/interwiki/'.$wikiName.'.gif')){ $link['style']='background-image: url('.DOKU_BASE.'lib/images/interwiki/'.$wikiName.'.gif)'; } } //do we stay at the same server? Use local target if( strpos($url,DOKU_URL) === 0 ){ $link['target'] = $conf['target']['wiki']; } //replace placeholder if(preg_match('#\{(URL|NAME|SCHEME|HOST|PORT|PATH|QUERY)\}#',$url)){ //use placeholders $url = str_replace('{URL}',urlencode($wikiUri),$url); $url = str_replace('{NAME}',$wikiUri,$url); $parsed = parse_url($wikiUri); if(!$parsed['port']) $parsed['port'] = 80; $url = str_replace('{SCHEME}',$parsed['scheme'],$url); $url = str_replace('{HOST}',$parsed['host'],$url); $url = str_replace('{PORT}',$parsed['port'],$url); $url = str_replace('{PATH}',$parsed['path'],$url); $url = str_replace('{QUERY}',$parsed['query'],$url); $link['url'] = $url; }else{ //default $link['url'] = $url.urlencode($wikiUri); } $link['title'] = htmlspecialchars($link['url']); //output formatted $this->doc .= $this->_formatLink($link); } /** */ function windowssharelink($url, $name = NULL) { global $conf; global $lang; //simple setup $link['target'] = $conf['target']['windows']; $link['pre'] = ''; $link['suf'] = ''; $link['style'] = ''; //Display error on browsers other than IE $link['more'] = 'onclick="if(document.all == null){alert(\''. $this->_xmlEntities($lang['nosmblinks'],ENT_QUOTES). '\');}" onkeypress="if(document.all == null){alert(\''. $this->_xmlEntities($lang['nosmblinks'],ENT_QUOTES).'\');}"'; $link['name'] = $this->_getLinkTitle($name, $url, $isImage); if ( !$isImage ) { $link['class'] = 'windows'; } else { $link['class'] = 'media'; } $link['title'] = $this->_xmlEntities($url); $url = str_replace('\\','/',$url); $url = 'file:///'.$url; $link['url'] = $url; //output formatted $this->doc .= $this->_formatLink($link); } function emaillink($address, $name = NULL) { global $conf; //simple setup $link = array(); $link['target'] = ''; $link['pre'] = ''; $link['suf'] = ''; $link['style'] = ''; $link['more'] = ''; //we just test for image here - we need to encode the title our self $this->_getLinkTitle($name, $address, $isImage); if ( !$isImage ) { $link['class']='mail'; } else { $link['class']='media'; } //shields up if($conf['mailguard']=='visible'){ //the mail name gets some visible encoding $address = str_replace('@',' [at] ',$address); $address = str_replace('.',' [dot] ',$address); $address = str_replace('-',' [dash] ',$address); $title = $this->_xmlEntities($address); if(empty($name)){ $name = $this->_xmlEntities($address); }else{ $name = $this->_xmlEntities($name); } }elseif($conf['mailguard']=='hex'){ //encode every char to a hex entity for ($x=0; $x < strlen($address); $x++) { $encode .= '&#x' . bin2hex($address[$x]).';'; } $address = $encode; $title = $encode; if(empty($name)){ $name = $encode; }else{ $name = $this->_xmlEntities($name); } }else{ //keep address as is $title = $this->_xmlEntities($address); if(empty($name)){ $name = $this->_xmlEntities($address); }else{ $name = $this->_xmlEntities($name); } } $link['url'] = 'mailto:'.$address; $link['name'] = $name; $link['title'] = $title; //output formatted $this->doc .= $this->_formatLink($link); } /** * @todo don't add link for flash */ function internalmedia ($src, $title=NULL, $align=NULL, $width=NULL, $height=NULL, $cache=NULL) { global $conf; global $ID; resolve_mediaid(getNS($ID),$src, $exists); $link = array(); $link['class'] = 'media'; $link['style'] = ''; $link['pre'] = ''; $link['suf'] = ''; $link['more'] = 'onclick="return svchk()" onkeypress="return svchk()"'; $link['target'] = $conf['target']['media']; $link['title'] = $this->_xmlEntities($src); $link['url'] = DOKU_BASE.'lib/exe/fetch.php?cache='.$cache.'&media='.urlencode($src); $link['name'] = $this->_media ($src, $title, $align, $width, $height, $cache); //output formatted $this->doc .= $this->_formatLink($link); } /** * @todo don't add link for flash */ function externalmedia ($src, $title=NULL, $align=NULL, $width=NULL, $height=NULL, $cache=NULL) { global $conf; $link = array(); $link['class'] = 'media'; $link['style'] = ''; $link['pre'] = ''; $link['suf'] = ''; $link['more'] = 'onclick="return svchk()" onkeypress="return svchk()"'; $link['target'] = $conf['target']['media']; $link['title'] = $this->_xmlEntities($src); $link['url'] = DOKU_BASE.'lib/exe/fetch.php?cache='.$cache.'&media='.urlencode($src); $link['name'] = $this->_media ($src, $title, $align, $width, $height, $cache); //output formatted $this->doc .= $this->_formatLink($link); } /** * Renders an RSS feed using Magpie * * @author Andreas Gohr */ function rss ($url){ global $lang; define('MAGPIE_CACHE_ON', false); //we do our own caching define('MAGPIE_DIR', DOKU_INC.'inc/magpie/'); define('MAGPIE_OUTPUT_ENCODING','UTF-8'); //return all feeds as UTF-8 require_once(MAGPIE_DIR.'/rss_fetch.inc'); //disable warning while fetching $elvl = error_reporting(E_ERROR); $rss = fetch_rss($url); error_reporting($elvl); $this->doc .= '
      '; if($rss){ foreach ($rss->items as $item ) { $this->doc .= '
    • '; $this->externallink($item['link'],$item['title']); $this->doc .= '
    • '; } }else{ $this->doc .= '
    • '; $this->doc .= ''.$lang['rssfailed'].''; $this->externallink($url); $this->doc .= '
    • '; } $this->doc .= '
    '; } // $numrows not yet implemented function table_open($maxcols = NULL, $numrows = NULL){ $this->doc .= ''.DOKU_LF; } function table_close(){ $this->doc .= '
    '.DOKU_LF.'
    '.DOKU_LF; } function tablerow_open(){ $this->doc .= DOKU_TAB . '' . DOKU_LF . DOKU_TAB . DOKU_TAB; } function tablerow_close(){ $this->doc .= DOKU_LF . DOKU_TAB . '' . DOKU_LF; } function tableheader_open($colspan = 1, $align = NULL){ $this->doc .= 'doc .= ' class="'.$align.'align"'; } if ( $colspan > 1 ) { $this->doc .= ' colspan="'.$colspan.'"'; } $this->doc .= '>'; } function tableheader_close(){ $this->doc .= ''; } function tablecell_open($colspan = 1, $align = NULL){ $this->doc .= 'doc .= ' class="'.$align.'align"'; } if ( $colspan > 1 ) { $this->doc .= ' colspan="'.$colspan.'"'; } $this->doc .= '>'; } function tablecell_close(){ $this->doc .= ''; } //---------------------------------------------------------- // Utils /** * Build a link * * Assembles all parts defined in $link returns HTML for the link * * @author Andreas Gohr */ function _formatLink($link){ //make sure the url is XHTML compliant (skip mailto) if(substr($link['url'],0,7) != 'mailto:'){ $link['url'] = str_replace('&','&',$link['url']); $link['url'] = str_replace('&amp;','&',$link['url']); } //remove double encodings in titles $link['title'] = str_replace('&amp;','&',$link['title']); $ret = ''; $ret .= $link['pre']; $ret .= ' */ function _simpleTitle($name){ global $conf; if($conf['useslash']){ $nssep = '[:;/]'; }else{ $nssep = '[:;]'; } $name = preg_replace('!.*'.$nssep.'!','',$name); //if there is a hash we use the ancor name only $name = preg_replace('!.*#!','',$name); return $name; } /** * Renders internal and external media * * @author Andreas Gohr */ function _media ($src, $title=NULL, $align=NULL, $width=NULL, $height=NULL, $cache=NULL) { $ret = ''; list($ext,$mime) = mimetype($src); if(substr($mime,0,5) == 'image'){ //add image tag $ret .= '_xmlEntities($title).'"'; $ret .= ' alt="'.$this->_xmlEntities($title).'"'; }else{ $ret .= ' alt=""'; } if ( !is_null($width) ) $ret .= ' width="'.$this->_xmlEntities($width).'"'; if ( !is_null($height) ) $ret .= ' height="'.$this->_xmlEntities($height).'"'; $ret .= ' />'; }elseif($mime == 'application/x-shockwave-flash'){ $ret .= '_xmlEntities($width).'"'; if ( !is_null($height) ) $ret .= ' height="'.$this->_xmlEntities($height).'"'; $ret .= '>'.DOKU_LF; $ret .= ''.DOKU_LF; $ret .= ''.DOKU_LF; $ret .= '_xmlEntities($width).'"'; if ( !is_null($height) ) $ret .= ' height="'.$this->_xmlEntities($height).'"'; $ret .= ' type="application/x-shockwave-flash"'. ' pluginspage="http://www.macromedia.com/go/getflashplayer">'.DOKU_LF; $ret .= ''.DOKU_LF; }elseif(!is_null($title)){ // well at least we have a title to display $ret .= $this->_xmlEntities($title); }else{ // just show the source $ret .= $this->_xmlEntities($src); } return $ret; } function _xmlEntities($string) { return htmlspecialchars($string); } function _headerToLink($title) { return str_replace(':','',cleanID($title)); } /** * Adds code for section editing button * * This is just aplaceholder and gets replace by the button if * section editing is allowed * * @author Andreas Gohr */ function _secedit($f, $t){ $this->doc .= ''; } /** * Construct a title and handle images in titles * * @author Harry Fuecks */ function _getLinkTitle($title, $default, & $isImage, $id=NULL) { global $conf; $isImage = FALSE; if ( is_null($title) ) { if ($conf['useheading'] && $id) { $heading = p_get_first_heading($id); if ($heading) { return $this->_xmlEntities($heading); } } return $this->_xmlEntities($default); } else if ( is_string($title) ) { return $this->_xmlEntities($title); } else if ( is_array($title) ) { $isImage = TRUE; return $this->_imageTitle($title); } } /** * Returns an HTML code for images used in link titles * * @todo Resolve namespace on internal images * @author Andreas Gohr */ function _imageTitle($img) { return $this->_media($img['src'], $img['title'], $img['align'], $img['width'], $img['height'], $img['cache']); } } //Setup VIM: ex: et ts=4 enc=utf-8 :