1<?php 2/** 3 * Renderer for XHTML output 4 * 5 * @author Harry Fuecks <hfuecks@gmail.com> 6 * @author Andreas Gohr <andi@splitbrain.org> 7 */ 8if(!defined('DOKU_INC')) die('meh.'); 9 10if(!defined('DOKU_LF')) { 11 // Some whitespace to help View > Source 12 define ('DOKU_LF', "\n"); 13} 14 15if(!defined('DOKU_TAB')) { 16 // Some whitespace to help View > Source 17 define ('DOKU_TAB', "\t"); 18} 19 20/** 21 * The XHTML Renderer 22 * 23 * This is DokuWiki's main renderer used to display page content in the wiki 24 */ 25class Doku_Renderer_xhtml extends Doku_Renderer { 26 /** @var array store the table of contents */ 27 public $toc = array(); 28 29 /** @var array A stack of section edit data */ 30 protected $sectionedits = array(); 31 var $date_at = ''; // link pages and media against this revision 32 33 /** @var int last section edit id, used by startSectionEdit */ 34 protected $lastsecid = 0; 35 36 /** @var array the list of headers used to create unique link ids */ 37 protected $headers = array(); 38 39 /** @var array a list of footnotes, list starts at 1! */ 40 protected $footnotes = array(); 41 42 /** @var int current section level */ 43 protected $lastlevel = 0; 44 /** @var array section node tracker */ 45 protected $node = array(0, 0, 0, 0, 0); 46 47 /** @var string temporary $doc store */ 48 protected $store = ''; 49 50 /** @var array global counter, for table classes etc. */ 51 protected $_counter = array(); // 52 53 /** @var int counts the code and file blocks, used to provide download links */ 54 protected $_codeblock = 0; 55 56 /** @var array list of allowed URL schemes */ 57 protected $schemes = null; 58 59 /** 60 * Register a new edit section range 61 * 62 * @param string $type The section type identifier 63 * @param string $title The section title 64 * @param int $start The byte position for the edit start 65 * @return string A marker class for the starting HTML element 66 * 67 * @author Adrian Lang <lang@cosmocode.de> 68 */ 69 public function startSectionEdit($start, $type, $title = null) { 70 $this->sectionedits[] = array(++$this->lastsecid, $start, $type, $title); 71 return 'sectionedit'.$this->lastsecid; 72 } 73 74 /** 75 * Finish an edit section range 76 * 77 * @param int $end The byte position for the edit end; null for the rest of the page 78 * 79 * @author Adrian Lang <lang@cosmocode.de> 80 */ 81 public function finishSectionEdit($end = null) { 82 list($id, $start, $type, $title) = array_pop($this->sectionedits); 83 if(!is_null($end) && $end <= $start) { 84 return; 85 } 86 $this->doc .= "<!-- EDIT$id ".strtoupper($type).' '; 87 if(!is_null($title)) { 88 $this->doc .= '"'.str_replace('"', '', $title).'" '; 89 } 90 $this->doc .= "[$start-".(is_null($end) ? '' : $end).'] -->'; 91 } 92 93 /** 94 * Returns the format produced by this renderer. 95 * 96 * @return string always 'xhtml' 97 */ 98 function getFormat() { 99 return 'xhtml'; 100 } 101 102 /** 103 * Initialize the document 104 */ 105 function document_start() { 106 //reset some internals 107 $this->toc = array(); 108 $this->headers = array(); 109 } 110 111 /** 112 * Finalize the document 113 */ 114 function document_end() { 115 // Finish open section edits. 116 while(count($this->sectionedits) > 0) { 117 if($this->sectionedits[count($this->sectionedits) - 1][1] <= 1) { 118 // If there is only one section, do not write a section edit 119 // marker. 120 array_pop($this->sectionedits); 121 } else { 122 $this->finishSectionEdit(); 123 } 124 } 125 126 if(count($this->footnotes) > 0) { 127 $this->doc .= '<div class="footnotes">'.DOKU_LF; 128 129 foreach($this->footnotes as $id => $footnote) { 130 // check its not a placeholder that indicates actual footnote text is elsewhere 131 if(substr($footnote, 0, 5) != "@@FNT") { 132 133 // open the footnote and set the anchor and backlink 134 $this->doc .= '<div class="fn">'; 135 $this->doc .= '<sup><a href="#fnt__'.$id.'" id="fn__'.$id.'" class="fn_bot">'; 136 $this->doc .= $id.')</a></sup> '.DOKU_LF; 137 138 // get any other footnotes that use the same markup 139 $alt = array_keys($this->footnotes, "@@FNT$id"); 140 141 if(count($alt)) { 142 foreach($alt as $ref) { 143 // set anchor and backlink for the other footnotes 144 $this->doc .= ', <sup><a href="#fnt__'.($ref).'" id="fn__'.($ref).'" class="fn_bot">'; 145 $this->doc .= ($ref).')</a></sup> '.DOKU_LF; 146 } 147 } 148 149 // add footnote markup and close this footnote 150 $this->doc .= $footnote; 151 $this->doc .= '</div>'.DOKU_LF; 152 } 153 } 154 $this->doc .= '</div>'.DOKU_LF; 155 } 156 157 // Prepare the TOC 158 global $conf; 159 if($this->info['toc'] && is_array($this->toc) && $conf['tocminheads'] && count($this->toc) >= $conf['tocminheads']) { 160 global $TOC; 161 $TOC = $this->toc; 162 } 163 164 // make sure there are no empty paragraphs 165 $this->doc = preg_replace('#<p>\s*</p>#', '', $this->doc); 166 } 167 168 /** 169 * Add an item to the TOC 170 * 171 * @param string $id the hash link 172 * @param string $text the text to display 173 * @param int $level the nesting level 174 */ 175 function toc_additem($id, $text, $level) { 176 global $conf; 177 178 //handle TOC 179 if($level >= $conf['toptoclevel'] && $level <= $conf['maxtoclevel']) { 180 $this->toc[] = html_mktocitem($id, $text, $level - $conf['toptoclevel'] + 1); 181 } 182 } 183 184 /** 185 * Render a heading 186 * 187 * @param string $text the text to display 188 * @param int $level header level 189 * @param int $pos byte position in the original source 190 */ 191 function header($text, $level, $pos) { 192 global $conf; 193 194 if(!$text) return; //skip empty headlines 195 196 $hid = $this->_headerToLink($text, true); 197 198 //only add items within configured levels 199 $this->toc_additem($hid, $text, $level); 200 201 // adjust $node to reflect hierarchy of levels 202 $this->node[$level - 1]++; 203 if($level < $this->lastlevel) { 204 for($i = 0; $i < $this->lastlevel - $level; $i++) { 205 $this->node[$this->lastlevel - $i - 1] = 0; 206 } 207 } 208 $this->lastlevel = $level; 209 210 if($level <= $conf['maxseclevel'] && 211 count($this->sectionedits) > 0 && 212 $this->sectionedits[count($this->sectionedits) - 1][2] === 'section' 213 ) { 214 $this->finishSectionEdit($pos - 1); 215 } 216 217 // write the header 218 $this->doc .= DOKU_LF.'<h'.$level; 219 if($level <= $conf['maxseclevel']) { 220 $this->doc .= ' class="'.$this->startSectionEdit($pos, 'section', $text).'"'; 221 } 222 $this->doc .= ' id="'.$hid.'">'; 223 $this->doc .= $this->_xmlEntities($text); 224 $this->doc .= "</h$level>".DOKU_LF; 225 } 226 227 /** 228 * Open a new section 229 * 230 * @param int $level section level (as determined by the previous header) 231 */ 232 function section_open($level) { 233 $this->doc .= '<div class="level'.$level.'">'.DOKU_LF; 234 } 235 236 /** 237 * Close the current section 238 */ 239 function section_close() { 240 $this->doc .= DOKU_LF.'</div>'.DOKU_LF; 241 } 242 243 /** 244 * Render plain text data 245 * 246 * @param $text 247 */ 248 function cdata($text) { 249 $this->doc .= $this->_xmlEntities($text); 250 } 251 252 /** 253 * Open a paragraph 254 */ 255 function p_open() { 256 $this->doc .= DOKU_LF.'<p>'.DOKU_LF; 257 } 258 259 /** 260 * Close a paragraph 261 */ 262 function p_close() { 263 $this->doc .= DOKU_LF.'</p>'.DOKU_LF; 264 } 265 266 /** 267 * Create a line break 268 */ 269 function linebreak() { 270 $this->doc .= '<br/>'.DOKU_LF; 271 } 272 273 /** 274 * Create a horizontal line 275 */ 276 function hr() { 277 $this->doc .= '<hr />'.DOKU_LF; 278 } 279 280 /** 281 * Start strong (bold) formatting 282 */ 283 function strong_open() { 284 $this->doc .= '<strong>'; 285 } 286 287 /** 288 * Stop strong (bold) formatting 289 */ 290 function strong_close() { 291 $this->doc .= '</strong>'; 292 } 293 294 /** 295 * Start emphasis (italics) formatting 296 */ 297 function emphasis_open() { 298 $this->doc .= '<em>'; 299 } 300 301 /** 302 * Stop emphasis (italics) formatting 303 */ 304 function emphasis_close() { 305 $this->doc .= '</em>'; 306 } 307 308 /** 309 * Start underline formatting 310 */ 311 function underline_open() { 312 $this->doc .= '<em class="u">'; 313 } 314 315 /** 316 * Stop underline formatting 317 */ 318 function underline_close() { 319 $this->doc .= '</em>'; 320 } 321 322 /** 323 * Start monospace formatting 324 */ 325 function monospace_open() { 326 $this->doc .= '<code>'; 327 } 328 329 /** 330 * Stop monospace formatting 331 */ 332 function monospace_close() { 333 $this->doc .= '</code>'; 334 } 335 336 /** 337 * Start a subscript 338 */ 339 function subscript_open() { 340 $this->doc .= '<sub>'; 341 } 342 343 /** 344 * Stop a subscript 345 */ 346 function subscript_close() { 347 $this->doc .= '</sub>'; 348 } 349 350 /** 351 * Start a superscript 352 */ 353 function superscript_open() { 354 $this->doc .= '<sup>'; 355 } 356 357 /** 358 * Stop a superscript 359 */ 360 function superscript_close() { 361 $this->doc .= '</sup>'; 362 } 363 364 /** 365 * Start deleted (strike-through) formatting 366 */ 367 function deleted_open() { 368 $this->doc .= '<del>'; 369 } 370 371 /** 372 * Stop deleted (strike-through) formatting 373 */ 374 function deleted_close() { 375 $this->doc .= '</del>'; 376 } 377 378 /** 379 * Callback for footnote start syntax 380 * 381 * All following content will go to the footnote instead of 382 * the document. To achieve this the previous rendered content 383 * is moved to $store and $doc is cleared 384 * 385 * @author Andreas Gohr <andi@splitbrain.org> 386 */ 387 function footnote_open() { 388 389 // move current content to store and record footnote 390 $this->store = $this->doc; 391 $this->doc = ''; 392 } 393 394 /** 395 * Callback for footnote end syntax 396 * 397 * All rendered content is moved to the $footnotes array and the old 398 * content is restored from $store again 399 * 400 * @author Andreas Gohr 401 */ 402 function footnote_close() { 403 /** @var $fnid int takes track of seen footnotes, assures they are unique even across multiple docs FS#2841 */ 404 static $fnid = 0; 405 // assign new footnote id (we start at 1) 406 $fnid++; 407 408 // recover footnote into the stack and restore old content 409 $footnote = $this->doc; 410 $this->doc = $this->store; 411 $this->store = ''; 412 413 // check to see if this footnote has been seen before 414 $i = array_search($footnote, $this->footnotes); 415 416 if($i === false) { 417 // its a new footnote, add it to the $footnotes array 418 $this->footnotes[$fnid] = $footnote; 419 } else { 420 // seen this one before, save a placeholder 421 $this->footnotes[$fnid] = "@@FNT".($i); 422 } 423 424 // output the footnote reference and link 425 $this->doc .= '<sup><a href="#fn__'.$fnid.'" id="fnt__'.$fnid.'" class="fn_top">'.$fnid.')</a></sup>'; 426 } 427 428 /** 429 * Open an unordered list 430 * 431 * @param string|string[] $classes css classes - have to be valid, do not pass unfiltered user input 432 */ 433 function listu_open($classes = null) { 434 $class = ''; 435 if($classes !== null) { 436 if(is_array($classes)) $classes = join(' ', $classes); 437 $class = " class=\"$classes\""; 438 } 439 $this->doc .= "<ul$class>".DOKU_LF; 440 } 441 442 /** 443 * Close an unordered list 444 */ 445 function listu_close() { 446 $this->doc .= '</ul>'.DOKU_LF; 447 } 448 449 /** 450 * Open an ordered list 451 * 452 * @param string|string[] $classes css classes - have to be valid, do not pass unfiltered user input 453 */ 454 function listo_open($classes = null) { 455 $class = ''; 456 if($classes !== null) { 457 if(is_array($classes)) $classes = join(' ', $classes); 458 $class = " class=\"$classes\""; 459 } 460 $this->doc .= "<ol$class>".DOKU_LF; 461 } 462 463 /** 464 * Close an ordered list 465 */ 466 function listo_close() { 467 $this->doc .= '</ol>'.DOKU_LF; 468 } 469 470 /** 471 * Open a list item 472 * 473 * @param int $level the nesting level 474 * @param bool $node true when a node; false when a leaf 475 */ 476 function listitem_open($level, $node=false) { 477 $branching = $node ? ' node' : ''; 478 $this->doc .= '<li class="level'.$level.$branching.'">'; 479 } 480 481 /** 482 * Close a list item 483 */ 484 function listitem_close() { 485 $this->doc .= '</li>'.DOKU_LF; 486 } 487 488 /** 489 * Start the content of a list item 490 */ 491 function listcontent_open() { 492 $this->doc .= '<div class="li">'; 493 } 494 495 /** 496 * Stop the content of a list item 497 */ 498 function listcontent_close() { 499 $this->doc .= '</div>'.DOKU_LF; 500 } 501 502 /** 503 * Output unformatted $text 504 * 505 * Defaults to $this->cdata() 506 * 507 * @param string $text 508 */ 509 function unformatted($text) { 510 $this->doc .= $this->_xmlEntities($text); 511 } 512 513 /** 514 * Execute PHP code if allowed 515 * 516 * @param string $text PHP code that is either executed or printed 517 * @param string $wrapper html element to wrap result if $conf['phpok'] is okff 518 * 519 * @author Andreas Gohr <andi@splitbrain.org> 520 */ 521 function php($text, $wrapper = 'code') { 522 global $conf; 523 524 if($conf['phpok']) { 525 ob_start(); 526 eval($text); 527 $this->doc .= ob_get_contents(); 528 ob_end_clean(); 529 } else { 530 $this->doc .= p_xhtml_cached_geshi($text, 'php', $wrapper); 531 } 532 } 533 534 /** 535 * Output block level PHP code 536 * 537 * If $conf['phpok'] is true this should evaluate the given code and append the result 538 * to $doc 539 * 540 * @param string $text The PHP code 541 */ 542 function phpblock($text) { 543 $this->php($text, 'pre'); 544 } 545 546 /** 547 * Insert HTML if allowed 548 * 549 * @param string $text html text 550 * @param string $wrapper html element to wrap result if $conf['htmlok'] is okff 551 * 552 * @author Andreas Gohr <andi@splitbrain.org> 553 */ 554 function html($text, $wrapper = 'code') { 555 global $conf; 556 557 if($conf['htmlok']) { 558 $this->doc .= $text; 559 } else { 560 $this->doc .= p_xhtml_cached_geshi($text, 'html4strict', $wrapper); 561 } 562 } 563 564 /** 565 * Output raw block-level HTML 566 * 567 * If $conf['htmlok'] is true this should add the code as is to $doc 568 * 569 * @param string $text The HTML 570 */ 571 function htmlblock($text) { 572 $this->html($text, 'pre'); 573 } 574 575 /** 576 * Start a block quote 577 */ 578 function quote_open() { 579 $this->doc .= '<blockquote><div class="no">'.DOKU_LF; 580 } 581 582 /** 583 * Stop a block quote 584 */ 585 function quote_close() { 586 $this->doc .= '</div></blockquote>'.DOKU_LF; 587 } 588 589 /** 590 * Output preformatted text 591 * 592 * @param string $text 593 */ 594 function preformatted($text) { 595 $this->doc .= '<pre class="code">'.trim($this->_xmlEntities($text), "\n\r").'</pre>'.DOKU_LF; 596 } 597 598 /** 599 * Display text as file content, optionally syntax highlighted 600 * 601 * @param string $text text to show 602 * @param string $language programming language to use for syntax highlighting 603 * @param string $filename file path label 604 */ 605 function file($text, $language = null, $filename = null) { 606 $this->_highlight('file', $text, $language, $filename); 607 } 608 609 /** 610 * Display text as code content, optionally syntax highlighted 611 * 612 * @param string $text text to show 613 * @param string $language programming language to use for syntax highlighting 614 * @param string $filename file path label 615 */ 616 function code($text, $language = null, $filename = null) { 617 $this->_highlight('code', $text, $language, $filename); 618 } 619 620 /** 621 * Use GeSHi to highlight language syntax in code and file blocks 622 * 623 * @author Andreas Gohr <andi@splitbrain.org> 624 * @param string $type code|file 625 * @param string $text text to show 626 * @param string $language programming language to use for syntax highlighting 627 * @param string $filename file path label 628 */ 629 function _highlight($type, $text, $language = null, $filename = null) { 630 global $ID; 631 global $lang; 632 633 if($filename) { 634 // add icon 635 list($ext) = mimetype($filename, false); 636 $class = preg_replace('/[^_\-a-z0-9]+/i', '_', $ext); 637 $class = 'mediafile mf_'.$class; 638 639 $this->doc .= '<dl class="'.$type.'">'.DOKU_LF; 640 $this->doc .= '<dt><a href="'.exportlink($ID, 'code', array('codeblock' => $this->_codeblock)).'" title="'.$lang['download'].'" class="'.$class.'">'; 641 $this->doc .= hsc($filename); 642 $this->doc .= '</a></dt>'.DOKU_LF.'<dd>'; 643 } 644 645 if($text{0} == "\n") { 646 $text = substr($text, 1); 647 } 648 if(substr($text, -1) == "\n") { 649 $text = substr($text, 0, -1); 650 } 651 652 if(is_null($language)) { 653 $this->doc .= '<pre class="'.$type.'">'.$this->_xmlEntities($text).'</pre>'.DOKU_LF; 654 } else { 655 $class = 'code'; //we always need the code class to make the syntax highlighting apply 656 if($type != 'code') $class .= ' '.$type; 657 658 $this->doc .= "<pre class=\"$class $language\">".p_xhtml_cached_geshi($text, $language, '').'</pre>'.DOKU_LF; 659 } 660 661 if($filename) { 662 $this->doc .= '</dd></dl>'.DOKU_LF; 663 } 664 665 $this->_codeblock++; 666 } 667 668 /** 669 * Format an acronym 670 * 671 * Uses $this->acronyms 672 * 673 * @param string $acronym 674 */ 675 function acronym($acronym) { 676 677 if(array_key_exists($acronym, $this->acronyms)) { 678 679 $title = $this->_xmlEntities($this->acronyms[$acronym]); 680 681 $this->doc .= '<abbr title="'.$title 682 .'">'.$this->_xmlEntities($acronym).'</abbr>'; 683 684 } else { 685 $this->doc .= $this->_xmlEntities($acronym); 686 } 687 } 688 689 /** 690 * Format a smiley 691 * 692 * Uses $this->smiley 693 * 694 * @param string $smiley 695 */ 696 function smiley($smiley) { 697 if(array_key_exists($smiley, $this->smileys)) { 698 $this->doc .= '<img src="'.DOKU_BASE.'lib/images/smileys/'.$this->smileys[$smiley]. 699 '" class="icon" alt="'. 700 $this->_xmlEntities($smiley).'" />'; 701 } else { 702 $this->doc .= $this->_xmlEntities($smiley); 703 } 704 } 705 706 /** 707 * Format an entity 708 * 709 * Entities are basically small text replacements 710 * 711 * Uses $this->entities 712 * 713 * @param string $entity 714 */ 715 function entity($entity) { 716 if(array_key_exists($entity, $this->entities)) { 717 $this->doc .= $this->entities[$entity]; 718 } else { 719 $this->doc .= $this->_xmlEntities($entity); 720 } 721 } 722 723 /** 724 * Typographically format a multiply sign 725 * 726 * Example: ($x=640, $y=480) should result in "640×480" 727 * 728 * @param string|int $x first value 729 * @param string|int $y second value 730 */ 731 function multiplyentity($x, $y) { 732 $this->doc .= "$x×$y"; 733 } 734 735 /** 736 * Render an opening single quote char (language specific) 737 */ 738 function singlequoteopening() { 739 global $lang; 740 $this->doc .= $lang['singlequoteopening']; 741 } 742 743 /** 744 * Render a closing single quote char (language specific) 745 */ 746 function singlequoteclosing() { 747 global $lang; 748 $this->doc .= $lang['singlequoteclosing']; 749 } 750 751 /** 752 * Render an apostrophe char (language specific) 753 */ 754 function apostrophe() { 755 global $lang; 756 $this->doc .= $lang['apostrophe']; 757 } 758 759 /** 760 * Render an opening double quote char (language specific) 761 */ 762 function doublequoteopening() { 763 global $lang; 764 $this->doc .= $lang['doublequoteopening']; 765 } 766 767 /** 768 * Render an closinging double quote char (language specific) 769 */ 770 function doublequoteclosing() { 771 global $lang; 772 $this->doc .= $lang['doublequoteclosing']; 773 } 774 775 /** 776 * Render a CamelCase link 777 * 778 * @param string $link The link name 779 * @param bool $returnonly whether to return html or write to doc attribute 780 * @return void|string writes to doc attribute or returns html depends on $returnonly 781 * 782 * @see http://en.wikipedia.org/wiki/CamelCase 783 */ 784 function camelcaselink($link, $returnonly = false) { 785 if($returnonly) { 786 return $this->internallink($link, $link, null, true); 787 } else { 788 $this->internallink($link, $link); 789 } 790 } 791 792 /** 793 * Render a page local link 794 * 795 * @param string $hash hash link identifier 796 * @param string $name name for the link 797 * @param bool $returnonly whether to return html or write to doc attribute 798 * @return void|string writes to doc attribute or returns html depends on $returnonly 799 */ 800 function locallink($hash, $name = null, $returnonly = false) { 801 global $ID; 802 $name = $this->_getLinkTitle($name, $hash, $isImage); 803 $hash = $this->_headerToLink($hash); 804 $title = $ID.' ↵'; 805 806 $doc = '<a href="#'.$hash.'" title="'.$title.'" class="wikilink1">'; 807 $doc .= $name; 808 $doc .= '</a>'; 809 810 if($returnonly) { 811 return $doc; 812 } else { 813 $this->doc .= $doc; 814 } 815 } 816 817 /** 818 * Render an internal Wiki Link 819 * 820 * $search,$returnonly & $linktype are not for the renderer but are used 821 * elsewhere - no need to implement them in other renderers 822 * 823 * @author Andreas Gohr <andi@splitbrain.org> 824 * @param string $id pageid 825 * @param string|null $name link name 826 * @param string|null $search adds search url param 827 * @param bool $returnonly whether to return html or write to doc attribute 828 * @param string $linktype type to set use of headings 829 * @return void|string writes to doc attribute or returns html depends on $returnonly 830 */ 831 function internallink($id, $name = null, $search = null, $returnonly = false, $linktype = 'content') { 832 global $conf; 833 global $ID; 834 global $INFO; 835 836 $params = ''; 837 $parts = explode('?', $id, 2); 838 if(count($parts) === 2) { 839 $id = $parts[0]; 840 $params = $parts[1]; 841 } 842 843 // For empty $id we need to know the current $ID 844 // We need this check because _simpleTitle needs 845 // correct $id and resolve_pageid() use cleanID($id) 846 // (some things could be lost) 847 if($id === '') { 848 $id = $ID; 849 } 850 851 // default name is based on $id as given 852 $default = $this->_simpleTitle($id); 853 854 // now first resolve and clean up the $id 855 resolve_pageid(getNS($ID), $id, $exists, $this->date_at, true); 856 857 $link = array(); 858 $name = $this->_getLinkTitle($name, $default, $isImage, $id, $linktype); 859 if(!$isImage) { 860 if($exists) { 861 $class = 'wikilink1'; 862 } else { 863 $class = 'wikilink2'; 864 $link['rel'] = 'nofollow'; 865 } 866 } else { 867 $class = 'media'; 868 } 869 870 //keep hash anchor 871 @list($id, $hash) = explode('#', $id, 2); 872 if(!empty($hash)) $hash = $this->_headerToLink($hash); 873 874 //prepare for formating 875 $link['target'] = $conf['target']['wiki']; 876 $link['style'] = ''; 877 $link['pre'] = ''; 878 $link['suf'] = ''; 879 // highlight link to current page 880 if($id == $INFO['id']) { 881 $link['pre'] = '<span class="curid">'; 882 $link['suf'] = '</span>'; 883 } 884 $link['more'] = ''; 885 $link['class'] = $class; 886 if($this->date_at) { 887 $params['at'] = $this->date_at; 888 } 889 $link['url'] = wl($id, $params); 890 $link['name'] = $name; 891 $link['title'] = $id; 892 //add search string 893 if($search) { 894 ($conf['userewrite']) ? $link['url'] .= '?' : $link['url'] .= '&'; 895 if(is_array($search)) { 896 $search = array_map('rawurlencode', $search); 897 $link['url'] .= 's[]='.join('&s[]=', $search); 898 } else { 899 $link['url'] .= 's='.rawurlencode($search); 900 } 901 } 902 903 //keep hash 904 if($hash) $link['url'] .= '#'.$hash; 905 906 //output formatted 907 if($returnonly) { 908 return $this->_formatLink($link); 909 } else { 910 $this->doc .= $this->_formatLink($link); 911 } 912 } 913 914 /** 915 * Render an external link 916 * 917 * @param string $url full URL with scheme 918 * @param string|array $name name for the link, array for media file 919 * @param bool $returnonly whether to return html or write to doc attribute 920 * @return void|string writes to doc attribute or returns html depends on $returnonly 921 */ 922 function externallink($url, $name = null, $returnonly = false) { 923 global $conf; 924 925 $name = $this->_getLinkTitle($name, $url, $isImage); 926 927 // url might be an attack vector, only allow registered protocols 928 if(is_null($this->schemes)) $this->schemes = getSchemes(); 929 list($scheme) = explode('://', $url); 930 $scheme = strtolower($scheme); 931 if(!in_array($scheme, $this->schemes)) $url = ''; 932 933 // is there still an URL? 934 if(!$url) { 935 if($returnonly) { 936 return $name; 937 } else { 938 $this->doc .= $name; 939 } 940 return; 941 } 942 943 // set class 944 if(!$isImage) { 945 $class = 'urlextern'; 946 } else { 947 $class = 'media'; 948 } 949 950 //prepare for formating 951 $link = array(); 952 $link['target'] = $conf['target']['extern']; 953 $link['style'] = ''; 954 $link['pre'] = ''; 955 $link['suf'] = ''; 956 $link['more'] = ''; 957 $link['class'] = $class; 958 $link['url'] = $url; 959 $link['rel'] = ''; 960 961 $link['name'] = $name; 962 $link['title'] = $this->_xmlEntities($url); 963 if($conf['relnofollow']) $link['rel'] .= ' nofollow'; 964 if($conf['target']['extern']) $link['rel'] .= ' noopener'; 965 966 //output formatted 967 if($returnonly) { 968 return $this->_formatLink($link); 969 } else { 970 $this->doc .= $this->_formatLink($link); 971 } 972 } 973 974 /** 975 * Render an interwiki link 976 * 977 * You may want to use $this->_resolveInterWiki() here 978 * 979 * @param string $match original link - probably not much use 980 * @param string|array $name name for the link, array for media file 981 * @param string $wikiName indentifier (shortcut) for the remote wiki 982 * @param string $wikiUri the fragment parsed from the original link 983 * @param bool $returnonly whether to return html or write to doc attribute 984 * @return void|string writes to doc attribute or returns html depends on $returnonly 985 */ 986 function interwikilink($match, $name = null, $wikiName, $wikiUri, $returnonly = false) { 987 global $conf; 988 989 $link = array(); 990 $link['target'] = $conf['target']['interwiki']; 991 $link['pre'] = ''; 992 $link['suf'] = ''; 993 $link['more'] = ''; 994 $link['name'] = $this->_getLinkTitle($name, $wikiUri, $isImage); 995 $link['rel'] = ''; 996 997 //get interwiki URL 998 $exists = null; 999 $url = $this->_resolveInterWiki($wikiName, $wikiUri, $exists); 1000 1001 if(!$isImage) { 1002 $class = preg_replace('/[^_\-a-z0-9]+/i', '_', $wikiName); 1003 $link['class'] = "interwiki iw_$class"; 1004 } else { 1005 $link['class'] = 'media'; 1006 } 1007 1008 //do we stay at the same server? Use local target 1009 if(strpos($url, DOKU_URL) === 0 OR strpos($url, DOKU_BASE) === 0) { 1010 $link['target'] = $conf['target']['wiki']; 1011 } 1012 if($exists !== null && !$isImage) { 1013 if($exists) { 1014 $link['class'] .= ' wikilink1'; 1015 } else { 1016 $link['class'] .= ' wikilink2'; 1017 $link['rel'] .= ' nofollow'; 1018 } 1019 } 1020 if($conf['target']['interwiki']) $link['rel'] .= ' noopener'; 1021 1022 $link['url'] = $url; 1023 $link['title'] = htmlspecialchars($link['url']); 1024 1025 //output formatted 1026 if($returnonly) { 1027 return $this->_formatLink($link); 1028 } else { 1029 $this->doc .= $this->_formatLink($link); 1030 } 1031 } 1032 1033 /** 1034 * Link to windows share 1035 * 1036 * @param string $url the link 1037 * @param string|array $name name for the link, array for media file 1038 * @param bool $returnonly whether to return html or write to doc attribute 1039 * @return void|string writes to doc attribute or returns html depends on $returnonly 1040 */ 1041 function windowssharelink($url, $name = null, $returnonly = false) { 1042 global $conf; 1043 1044 //simple setup 1045 $link = array(); 1046 $link['target'] = $conf['target']['windows']; 1047 $link['pre'] = ''; 1048 $link['suf'] = ''; 1049 $link['style'] = ''; 1050 1051 $link['name'] = $this->_getLinkTitle($name, $url, $isImage); 1052 if(!$isImage) { 1053 $link['class'] = 'windows'; 1054 } else { 1055 $link['class'] = 'media'; 1056 } 1057 1058 $link['title'] = $this->_xmlEntities($url); 1059 $url = str_replace('\\', '/', $url); 1060 $url = 'file:///'.$url; 1061 $link['url'] = $url; 1062 1063 //output formatted 1064 if($returnonly) { 1065 return $this->_formatLink($link); 1066 } else { 1067 $this->doc .= $this->_formatLink($link); 1068 } 1069 } 1070 1071 /** 1072 * Render a linked E-Mail Address 1073 * 1074 * Honors $conf['mailguard'] setting 1075 * 1076 * @param string $address Email-Address 1077 * @param string|array $name name for the link, array for media file 1078 * @param bool $returnonly whether to return html or write to doc attribute 1079 * @return void|string writes to doc attribute or returns html depends on $returnonly 1080 */ 1081 function emaillink($address, $name = null, $returnonly = false) { 1082 global $conf; 1083 //simple setup 1084 $link = array(); 1085 $link['target'] = ''; 1086 $link['pre'] = ''; 1087 $link['suf'] = ''; 1088 $link['style'] = ''; 1089 $link['more'] = ''; 1090 1091 $name = $this->_getLinkTitle($name, '', $isImage); 1092 if(!$isImage) { 1093 $link['class'] = 'mail'; 1094 } else { 1095 $link['class'] = 'media'; 1096 } 1097 1098 $address = $this->_xmlEntities($address); 1099 $address = obfuscate($address); 1100 $title = $address; 1101 1102 if(empty($name)) { 1103 $name = $address; 1104 } 1105 1106 if($conf['mailguard'] == 'visible') $address = rawurlencode($address); 1107 1108 $link['url'] = 'mailto:'.$address; 1109 $link['name'] = $name; 1110 $link['title'] = $title; 1111 1112 //output formatted 1113 if($returnonly) { 1114 return $this->_formatLink($link); 1115 } else { 1116 $this->doc .= $this->_formatLink($link); 1117 } 1118 } 1119 1120 /** 1121 * Render an internal media file 1122 * 1123 * @param string $src media ID 1124 * @param string $title descriptive text 1125 * @param string $align left|center|right 1126 * @param int $width width of media in pixel 1127 * @param int $height height of media in pixel 1128 * @param string $cache cache|recache|nocache 1129 * @param string $linking linkonly|detail|nolink 1130 * @param bool $return return HTML instead of adding to $doc 1131 * @return void|string writes to doc attribute or returns html depends on $return 1132 */ 1133 function internalmedia($src, $title = null, $align = null, $width = null, 1134 $height = null, $cache = null, $linking = null, $return = false) { 1135 global $ID; 1136 list($src, $hash) = explode('#', $src, 2); 1137 resolve_mediaid(getNS($ID), $src, $exists, $this->date_at, true); 1138 1139 $noLink = false; 1140 $render = ($linking == 'linkonly') ? false : true; 1141 $link = $this->_getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render); 1142 1143 list($ext, $mime) = mimetype($src, false); 1144 if(substr($mime, 0, 5) == 'image' && $render) { 1145 $link['url'] = ml($src, array('id' => $ID, 'cache' => $cache, 'rev'=>$this->_getLastMediaRevisionAt($src)), ($linking == 'direct')); 1146 } elseif(($mime == 'application/x-shockwave-flash' || media_supportedav($mime)) && $render) { 1147 // don't link movies 1148 $noLink = true; 1149 } else { 1150 // add file icons 1151 $class = preg_replace('/[^_\-a-z0-9]+/i', '_', $ext); 1152 $link['class'] .= ' mediafile mf_'.$class; 1153 $link['url'] = ml($src, array('id' => $ID, 'cache' => $cache , 'rev'=>$this->_getLastMediaRevisionAt($src)), true); 1154 if($exists) $link['title'] .= ' ('.filesize_h(filesize(mediaFN($src))).')'; 1155 } 1156 1157 if($hash) $link['url'] .= '#'.$hash; 1158 1159 //markup non existing files 1160 if(!$exists) { 1161 $link['class'] .= ' wikilink2'; 1162 } 1163 1164 //output formatted 1165 if($return) { 1166 if($linking == 'nolink' || $noLink) return $link['name']; 1167 else return $this->_formatLink($link); 1168 } else { 1169 if($linking == 'nolink' || $noLink) $this->doc .= $link['name']; 1170 else $this->doc .= $this->_formatLink($link); 1171 } 1172 } 1173 1174 /** 1175 * Render an external media file 1176 * 1177 * @param string $src full media URL 1178 * @param string $title descriptive text 1179 * @param string $align left|center|right 1180 * @param int $width width of media in pixel 1181 * @param int $height height of media in pixel 1182 * @param string $cache cache|recache|nocache 1183 * @param string $linking linkonly|detail|nolink 1184 * @param bool $return return HTML instead of adding to $doc 1185 * @return void|string writes to doc attribute or returns html depends on $return 1186 */ 1187 function externalmedia($src, $title = null, $align = null, $width = null, 1188 $height = null, $cache = null, $linking = null, $return = false) { 1189 list($src, $hash) = explode('#', $src, 2); 1190 $noLink = false; 1191 $render = ($linking == 'linkonly') ? false : true; 1192 $link = $this->_getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render); 1193 1194 $link['url'] = ml($src, array('cache' => $cache)); 1195 1196 list($ext, $mime) = mimetype($src, false); 1197 if(substr($mime, 0, 5) == 'image' && $render) { 1198 // link only jpeg images 1199 // if ($ext != 'jpg' && $ext != 'jpeg') $noLink = true; 1200 } elseif(($mime == 'application/x-shockwave-flash' || media_supportedav($mime)) && $render) { 1201 // don't link movies 1202 $noLink = true; 1203 } else { 1204 // add file icons 1205 $class = preg_replace('/[^_\-a-z0-9]+/i', '_', $ext); 1206 $link['class'] .= ' mediafile mf_'.$class; 1207 } 1208 1209 if($hash) $link['url'] .= '#'.$hash; 1210 1211 //output formatted 1212 if($return) { 1213 if($linking == 'nolink' || $noLink) return $link['name']; 1214 else return $this->_formatLink($link); 1215 } else { 1216 if($linking == 'nolink' || $noLink) $this->doc .= $link['name']; 1217 else $this->doc .= $this->_formatLink($link); 1218 } 1219 } 1220 1221 /** 1222 * Renders an RSS feed 1223 * 1224 * @param string $url URL of the feed 1225 * @param array $params Finetuning of the output 1226 * 1227 * @author Andreas Gohr <andi@splitbrain.org> 1228 */ 1229 function rss($url, $params) { 1230 global $lang; 1231 global $conf; 1232 1233 require_once(DOKU_INC.'inc/FeedParser.php'); 1234 $feed = new FeedParser(); 1235 $feed->set_feed_url($url); 1236 1237 //disable warning while fetching 1238 if(!defined('DOKU_E_LEVEL')) { 1239 $elvl = error_reporting(E_ERROR); 1240 } 1241 $rc = $feed->init(); 1242 if(isset($elvl)) { 1243 error_reporting($elvl); 1244 } 1245 1246 if($params['nosort']) $feed->enable_order_by_date(false); 1247 1248 //decide on start and end 1249 if($params['reverse']) { 1250 $mod = -1; 1251 $start = $feed->get_item_quantity() - 1; 1252 $end = $start - ($params['max']); 1253 $end = ($end < -1) ? -1 : $end; 1254 } else { 1255 $mod = 1; 1256 $start = 0; 1257 $end = $feed->get_item_quantity(); 1258 $end = ($end > $params['max']) ? $params['max'] : $end; 1259 } 1260 1261 $this->doc .= '<ul class="rss">'; 1262 if($rc) { 1263 for($x = $start; $x != $end; $x += $mod) { 1264 $item = $feed->get_item($x); 1265 $this->doc .= '<li><div class="li">'; 1266 // support feeds without links 1267 $lnkurl = $item->get_permalink(); 1268 if($lnkurl) { 1269 // title is escaped by SimplePie, we unescape here because it 1270 // is escaped again in externallink() FS#1705 1271 $this->externallink( 1272 $item->get_permalink(), 1273 html_entity_decode($item->get_title(), ENT_QUOTES, 'UTF-8') 1274 ); 1275 } else { 1276 $this->doc .= ' '.$item->get_title(); 1277 } 1278 if($params['author']) { 1279 $author = $item->get_author(0); 1280 if($author) { 1281 $name = $author->get_name(); 1282 if(!$name) $name = $author->get_email(); 1283 if($name) $this->doc .= ' '.$lang['by'].' '.$name; 1284 } 1285 } 1286 if($params['date']) { 1287 $this->doc .= ' ('.$item->get_local_date($conf['dformat']).')'; 1288 } 1289 if($params['details']) { 1290 $this->doc .= '<div class="detail">'; 1291 if($conf['htmlok']) { 1292 $this->doc .= $item->get_description(); 1293 } else { 1294 $this->doc .= strip_tags($item->get_description()); 1295 } 1296 $this->doc .= '</div>'; 1297 } 1298 1299 $this->doc .= '</div></li>'; 1300 } 1301 } else { 1302 $this->doc .= '<li><div class="li">'; 1303 $this->doc .= '<em>'.$lang['rssfailed'].'</em>'; 1304 $this->externallink($url); 1305 if($conf['allowdebug']) { 1306 $this->doc .= '<!--'.hsc($feed->error).'-->'; 1307 } 1308 $this->doc .= '</div></li>'; 1309 } 1310 $this->doc .= '</ul>'; 1311 } 1312 1313 /** 1314 * Start a table 1315 * 1316 * @param int $maxcols maximum number of columns 1317 * @param int $numrows NOT IMPLEMENTED 1318 * @param int $pos byte position in the original source 1319 * @param string|string[] $classes css classes - have to be valid, do not pass unfiltered user input 1320 */ 1321 function table_open($maxcols = null, $numrows = null, $pos = null, $classes = null) { 1322 // initialize the row counter used for classes 1323 $this->_counter['row_counter'] = 0; 1324 $class = 'table'; 1325 if($classes !== null) { 1326 if(is_array($classes)) $classes = join(' ', $classes); 1327 $class .= ' ' . $classes; 1328 } 1329 if($pos !== null) { 1330 $class .= ' '.$this->startSectionEdit($pos, 'table'); 1331 } 1332 $this->doc .= '<div class="'.$class.'"><table class="inline">'. 1333 DOKU_LF; 1334 } 1335 1336 /** 1337 * Close a table 1338 * 1339 * @param int $pos byte position in the original source 1340 */ 1341 function table_close($pos = null) { 1342 $this->doc .= '</table></div>'.DOKU_LF; 1343 if($pos !== null) { 1344 $this->finishSectionEdit($pos); 1345 } 1346 } 1347 1348 /** 1349 * Open a table header 1350 */ 1351 function tablethead_open() { 1352 $this->doc .= DOKU_TAB.'<thead>'.DOKU_LF; 1353 } 1354 1355 /** 1356 * Close a table header 1357 */ 1358 function tablethead_close() { 1359 $this->doc .= DOKU_TAB.'</thead>'.DOKU_LF; 1360 } 1361 1362 /** 1363 * Open a table body 1364 */ 1365 function tabletbody_open() { 1366 $this->doc .= DOKU_TAB.'<tbody>'.DOKU_LF; 1367 } 1368 1369 /** 1370 * Close a table body 1371 */ 1372 function tabletbody_close() { 1373 $this->doc .= DOKU_TAB.'</tbody>'.DOKU_LF; 1374 } 1375 1376 /** 1377 * Open a table row 1378 * 1379 * @param string|string[] $classes css classes - have to be valid, do not pass unfiltered user input 1380 */ 1381 function tablerow_open($classes = null) { 1382 // initialize the cell counter used for classes 1383 $this->_counter['cell_counter'] = 0; 1384 $class = 'row'.$this->_counter['row_counter']++; 1385 if($classes !== null) { 1386 if(is_array($classes)) $classes = join(' ', $classes); 1387 $class .= ' ' . $classes; 1388 } 1389 $this->doc .= DOKU_TAB.'<tr class="'.$class.'">'.DOKU_LF.DOKU_TAB.DOKU_TAB; 1390 } 1391 1392 /** 1393 * Close a table row 1394 */ 1395 function tablerow_close() { 1396 $this->doc .= DOKU_LF.DOKU_TAB.'</tr>'.DOKU_LF; 1397 } 1398 1399 /** 1400 * Open a table header cell 1401 * 1402 * @param int $colspan 1403 * @param string $align left|center|right 1404 * @param int $rowspan 1405 * @param string|string[] $classes css classes - have to be valid, do not pass unfiltered user input 1406 */ 1407 function tableheader_open($colspan = 1, $align = null, $rowspan = 1, $classes = null) { 1408 $class = 'class="col'.$this->_counter['cell_counter']++; 1409 if(!is_null($align)) { 1410 $class .= ' '.$align.'align'; 1411 } 1412 if($classes !== null) { 1413 if(is_array($classes)) $classes = join(' ', $classes); 1414 $class .= ' ' . $classes; 1415 } 1416 $class .= '"'; 1417 $this->doc .= '<th '.$class; 1418 if($colspan > 1) { 1419 $this->_counter['cell_counter'] += $colspan - 1; 1420 $this->doc .= ' colspan="'.$colspan.'"'; 1421 } 1422 if($rowspan > 1) { 1423 $this->doc .= ' rowspan="'.$rowspan.'"'; 1424 } 1425 $this->doc .= '>'; 1426 } 1427 1428 /** 1429 * Close a table header cell 1430 */ 1431 function tableheader_close() { 1432 $this->doc .= '</th>'; 1433 } 1434 1435 /** 1436 * Open a table cell 1437 * 1438 * @param int $colspan 1439 * @param string $align left|center|right 1440 * @param int $rowspan 1441 * @param string|string[] $classes css classes - have to be valid, do not pass unfiltered user input 1442 */ 1443 function tablecell_open($colspan = 1, $align = null, $rowspan = 1, $classes = null) { 1444 $class = 'class="col'.$this->_counter['cell_counter']++; 1445 if(!is_null($align)) { 1446 $class .= ' '.$align.'align'; 1447 } 1448 if($classes !== null) { 1449 if(is_array($classes)) $classes = join(' ', $classes); 1450 $class .= ' ' . $classes; 1451 } 1452 $class .= '"'; 1453 $this->doc .= '<td '.$class; 1454 if($colspan > 1) { 1455 $this->_counter['cell_counter'] += $colspan - 1; 1456 $this->doc .= ' colspan="'.$colspan.'"'; 1457 } 1458 if($rowspan > 1) { 1459 $this->doc .= ' rowspan="'.$rowspan.'"'; 1460 } 1461 $this->doc .= '>'; 1462 } 1463 1464 /** 1465 * Close a table cell 1466 */ 1467 function tablecell_close() { 1468 $this->doc .= '</td>'; 1469 } 1470 1471 /** 1472 * Returns the current header level. 1473 * (required e.g. by the filelist plugin) 1474 * 1475 * @return int The current header level 1476 */ 1477 function getLastlevel() { 1478 return $this->lastlevel; 1479 } 1480 1481 #region Utility functions 1482 1483 /** 1484 * Build a link 1485 * 1486 * Assembles all parts defined in $link returns HTML for the link 1487 * 1488 * @param array $link attributes of a link 1489 * @return string 1490 * 1491 * @author Andreas Gohr <andi@splitbrain.org> 1492 */ 1493 function _formatLink($link) { 1494 //make sure the url is XHTML compliant (skip mailto) 1495 if(substr($link['url'], 0, 7) != 'mailto:') { 1496 $link['url'] = str_replace('&', '&', $link['url']); 1497 $link['url'] = str_replace('&amp;', '&', $link['url']); 1498 } 1499 //remove double encodings in titles 1500 $link['title'] = str_replace('&amp;', '&', $link['title']); 1501 1502 // be sure there are no bad chars in url or title 1503 // (we can't do this for name because it can contain an img tag) 1504 $link['url'] = strtr($link['url'], array('>' => '%3E', '<' => '%3C', '"' => '%22')); 1505 $link['title'] = strtr($link['title'], array('>' => '>', '<' => '<', '"' => '"')); 1506 1507 $ret = ''; 1508 $ret .= $link['pre']; 1509 $ret .= '<a href="'.$link['url'].'"'; 1510 if(!empty($link['class'])) $ret .= ' class="'.$link['class'].'"'; 1511 if(!empty($link['target'])) $ret .= ' target="'.$link['target'].'"'; 1512 if(!empty($link['title'])) $ret .= ' title="'.$link['title'].'"'; 1513 if(!empty($link['style'])) $ret .= ' style="'.$link['style'].'"'; 1514 if(!empty($link['rel'])) $ret .= ' rel="'.trim($link['rel']).'"'; 1515 if(!empty($link['more'])) $ret .= ' '.$link['more']; 1516 $ret .= '>'; 1517 $ret .= $link['name']; 1518 $ret .= '</a>'; 1519 $ret .= $link['suf']; 1520 return $ret; 1521 } 1522 1523 /** 1524 * Renders internal and external media 1525 * 1526 * @author Andreas Gohr <andi@splitbrain.org> 1527 * @param string $src media ID 1528 * @param string $title descriptive text 1529 * @param string $align left|center|right 1530 * @param int $width width of media in pixel 1531 * @param int $height height of media in pixel 1532 * @param string $cache cache|recache|nocache 1533 * @param bool $render should the media be embedded inline or just linked 1534 * @return string 1535 */ 1536 function _media($src, $title = null, $align = null, $width = null, 1537 $height = null, $cache = null, $render = true) { 1538 1539 $ret = ''; 1540 1541 list($ext, $mime) = mimetype($src); 1542 if(substr($mime, 0, 5) == 'image') { 1543 // first get the $title 1544 if(!is_null($title)) { 1545 $title = $this->_xmlEntities($title); 1546 } elseif($ext == 'jpg' || $ext == 'jpeg') { 1547 //try to use the caption from IPTC/EXIF 1548 require_once(DOKU_INC.'inc/JpegMeta.php'); 1549 $jpeg = new JpegMeta(mediaFN($src)); 1550 if($jpeg !== false) $cap = $jpeg->getTitle(); 1551 if(!empty($cap)) { 1552 $title = $this->_xmlEntities($cap); 1553 } 1554 } 1555 if(!$render) { 1556 // if the picture is not supposed to be rendered 1557 // return the title of the picture 1558 if(!$title) { 1559 // just show the sourcename 1560 $title = $this->_xmlEntities(utf8_basename(noNS($src))); 1561 } 1562 return $title; 1563 } 1564 //add image tag 1565 $ret .= '<img src="'.ml($src, array('w' => $width, 'h' => $height, 'cache' => $cache, 'rev'=>$this->_getLastMediaRevisionAt($src))).'"'; 1566 $ret .= ' class="media'.$align.'"'; 1567 1568 if($title) { 1569 $ret .= ' title="'.$title.'"'; 1570 $ret .= ' alt="'.$title.'"'; 1571 } else { 1572 $ret .= ' alt=""'; 1573 } 1574 1575 if(!is_null($width)) 1576 $ret .= ' width="'.$this->_xmlEntities($width).'"'; 1577 1578 if(!is_null($height)) 1579 $ret .= ' height="'.$this->_xmlEntities($height).'"'; 1580 1581 $ret .= ' />'; 1582 1583 } elseif(media_supportedav($mime, 'video') || media_supportedav($mime, 'audio')) { 1584 // first get the $title 1585 $title = !is_null($title) ? $this->_xmlEntities($title) : false; 1586 if(!$render) { 1587 // if the file is not supposed to be rendered 1588 // return the title of the file (just the sourcename if there is no title) 1589 return $title ? $title : $this->_xmlEntities(utf8_basename(noNS($src))); 1590 } 1591 1592 $att = array(); 1593 $att['class'] = "media$align"; 1594 if($title) { 1595 $att['title'] = $title; 1596 } 1597 1598 if(media_supportedav($mime, 'video')) { 1599 //add video 1600 $ret .= $this->_video($src, $width, $height, $att); 1601 } 1602 if(media_supportedav($mime, 'audio')) { 1603 //add audio 1604 $ret .= $this->_audio($src, $att); 1605 } 1606 1607 } elseif($mime == 'application/x-shockwave-flash') { 1608 if(!$render) { 1609 // if the flash is not supposed to be rendered 1610 // return the title of the flash 1611 if(!$title) { 1612 // just show the sourcename 1613 $title = utf8_basename(noNS($src)); 1614 } 1615 return $this->_xmlEntities($title); 1616 } 1617 1618 $att = array(); 1619 $att['class'] = "media$align"; 1620 if($align == 'right') $att['align'] = 'right'; 1621 if($align == 'left') $att['align'] = 'left'; 1622 $ret .= html_flashobject( 1623 ml($src, array('cache' => $cache), true, '&'), $width, $height, 1624 array('quality' => 'high'), 1625 null, 1626 $att, 1627 $this->_xmlEntities($title) 1628 ); 1629 } elseif($title) { 1630 // well at least we have a title to display 1631 $ret .= $this->_xmlEntities($title); 1632 } else { 1633 // just show the sourcename 1634 $ret .= $this->_xmlEntities(utf8_basename(noNS($src))); 1635 } 1636 1637 return $ret; 1638 } 1639 1640 /** 1641 * Escape string for output 1642 * 1643 * @param $string 1644 * @return string 1645 */ 1646 function _xmlEntities($string) { 1647 return htmlspecialchars($string, ENT_QUOTES, 'UTF-8'); 1648 } 1649 1650 /** 1651 * Creates a linkid from a headline 1652 * 1653 * @author Andreas Gohr <andi@splitbrain.org> 1654 * @param string $title The headline title 1655 * @param boolean $create Create a new unique ID? 1656 * @return string 1657 */ 1658 function _headerToLink($title, $create = false) { 1659 if($create) { 1660 return sectionID($title, $this->headers); 1661 } else { 1662 $check = false; 1663 return sectionID($title, $check); 1664 } 1665 } 1666 1667 /** 1668 * Construct a title and handle images in titles 1669 * 1670 * @author Harry Fuecks <hfuecks@gmail.com> 1671 * @param string|array $title either string title or media array 1672 * @param string $default default title if nothing else is found 1673 * @param bool $isImage will be set to true if it's a media file 1674 * @param null|string $id linked page id (used to extract title from first heading) 1675 * @param string $linktype content|navigation 1676 * @return string HTML of the title, might be full image tag or just escaped text 1677 */ 1678 function _getLinkTitle($title, $default, &$isImage, $id = null, $linktype = 'content') { 1679 $isImage = false; 1680 if(is_array($title)) { 1681 $isImage = true; 1682 return $this->_imageTitle($title); 1683 } elseif(is_null($title) || trim($title) == '') { 1684 if(useHeading($linktype) && $id) { 1685 $heading = p_get_first_heading($id); 1686 if($heading) { 1687 return $this->_xmlEntities($heading); 1688 } 1689 } 1690 return $this->_xmlEntities($default); 1691 } else { 1692 return $this->_xmlEntities($title); 1693 } 1694 } 1695 1696 /** 1697 * Returns HTML code for images used in link titles 1698 * 1699 * @author Andreas Gohr <andi@splitbrain.org> 1700 * @param array $img 1701 * @return string HTML img tag or similar 1702 */ 1703 function _imageTitle($img) { 1704 global $ID; 1705 1706 // some fixes on $img['src'] 1707 // see internalmedia() and externalmedia() 1708 list($img['src']) = explode('#', $img['src'], 2); 1709 if($img['type'] == 'internalmedia') { 1710 resolve_mediaid(getNS($ID), $img['src'], $exists ,$this->date_at, true); 1711 } 1712 1713 return $this->_media( 1714 $img['src'], 1715 $img['title'], 1716 $img['align'], 1717 $img['width'], 1718 $img['height'], 1719 $img['cache'] 1720 ); 1721 } 1722 1723 /** 1724 * helperfunction to return a basic link to a media 1725 * 1726 * used in internalmedia() and externalmedia() 1727 * 1728 * @author Pierre Spring <pierre.spring@liip.ch> 1729 * @param string $src media ID 1730 * @param string $title descriptive text 1731 * @param string $align left|center|right 1732 * @param int $width width of media in pixel 1733 * @param int $height height of media in pixel 1734 * @param string $cache cache|recache|nocache 1735 * @param bool $render should the media be embedded inline or just linked 1736 * @return array associative array with link config 1737 */ 1738 function _getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render) { 1739 global $conf; 1740 1741 $link = array(); 1742 $link['class'] = 'media'; 1743 $link['style'] = ''; 1744 $link['pre'] = ''; 1745 $link['suf'] = ''; 1746 $link['more'] = ''; 1747 $link['target'] = $conf['target']['media']; 1748 if($conf['target']['media']) $link['rel'] = 'noopener'; 1749 $link['title'] = $this->_xmlEntities($src); 1750 $link['name'] = $this->_media($src, $title, $align, $width, $height, $cache, $render); 1751 1752 return $link; 1753 } 1754 1755 /** 1756 * Embed video(s) in HTML 1757 * 1758 * @author Anika Henke <anika@selfthinker.org> 1759 * 1760 * @param string $src - ID of video to embed 1761 * @param int $width - width of the video in pixels 1762 * @param int $height - height of the video in pixels 1763 * @param array $atts - additional attributes for the <video> tag 1764 * @return string 1765 */ 1766 function _video($src, $width, $height, $atts = null) { 1767 // prepare width and height 1768 if(is_null($atts)) $atts = array(); 1769 $atts['width'] = (int) $width; 1770 $atts['height'] = (int) $height; 1771 if(!$atts['width']) $atts['width'] = 320; 1772 if(!$atts['height']) $atts['height'] = 240; 1773 1774 $posterUrl = ''; 1775 $files = array(); 1776 $isExternal = media_isexternal($src); 1777 1778 if ($isExternal) { 1779 // take direct source for external files 1780 list(/*ext*/, $srcMime) = mimetype($src); 1781 $files[$srcMime] = $src; 1782 } else { 1783 // prepare alternative formats 1784 $extensions = array('webm', 'ogv', 'mp4'); 1785 $files = media_alternativefiles($src, $extensions); 1786 $poster = media_alternativefiles($src, array('jpg', 'png')); 1787 if(!empty($poster)) { 1788 $posterUrl = ml(reset($poster), '', true, '&'); 1789 } 1790 } 1791 1792 $out = ''; 1793 // open video tag 1794 $out .= '<video '.buildAttributes($atts).' controls="controls"'; 1795 if($posterUrl) $out .= ' poster="'.hsc($posterUrl).'"'; 1796 $out .= '>'.NL; 1797 $fallback = ''; 1798 1799 // output source for each alternative video format 1800 foreach($files as $mime => $file) { 1801 if ($isExternal) { 1802 $url = $file; 1803 $linkType = 'externalmedia'; 1804 } else { 1805 $url = ml($file, '', true, '&'); 1806 $linkType = 'internalmedia'; 1807 } 1808 $title = $atts['title'] ? $atts['title'] : $this->_xmlEntities(utf8_basename(noNS($file))); 1809 1810 $out .= '<source src="'.hsc($url).'" type="'.$mime.'" />'.NL; 1811 // alternative content (just a link to the file) 1812 $fallback .= $this->$linkType($file, $title, null, null, null, $cache = null, $linking = 'linkonly', $return = true); 1813 } 1814 1815 // finish 1816 $out .= $fallback; 1817 $out .= '</video>'.NL; 1818 return $out; 1819 } 1820 1821 /** 1822 * Embed audio in HTML 1823 * 1824 * @author Anika Henke <anika@selfthinker.org> 1825 * 1826 * @param string $src - ID of audio to embed 1827 * @param array $atts - additional attributes for the <audio> tag 1828 * @return string 1829 */ 1830 function _audio($src, $atts = array()) { 1831 $files = array(); 1832 $isExternal = media_isexternal($src); 1833 1834 if ($isExternal) { 1835 // take direct source for external files 1836 list(/*ext*/, $srcMime) = mimetype($src); 1837 $files[$srcMime] = $src; 1838 } else { 1839 // prepare alternative formats 1840 $extensions = array('ogg', 'mp3', 'wav'); 1841 $files = media_alternativefiles($src, $extensions); 1842 } 1843 1844 $out = ''; 1845 // open audio tag 1846 $out .= '<audio '.buildAttributes($atts).' controls="controls">'.NL; 1847 $fallback = ''; 1848 1849 // output source for each alternative audio format 1850 foreach($files as $mime => $file) { 1851 if ($isExternal) { 1852 $url = $file; 1853 $linkType = 'externalmedia'; 1854 } else { 1855 $url = ml($file, '', true, '&'); 1856 $linkType = 'internalmedia'; 1857 } 1858 $title = $atts['title'] ? $atts['title'] : $this->_xmlEntities(utf8_basename(noNS($file))); 1859 1860 $out .= '<source src="'.hsc($url).'" type="'.$mime.'" />'.NL; 1861 // alternative content (just a link to the file) 1862 $fallback .= $this->$linkType($file, $title, null, null, null, $cache = null, $linking = 'linkonly', $return = true); 1863 } 1864 1865 // finish 1866 $out .= $fallback; 1867 $out .= '</audio>'.NL; 1868 return $out; 1869 } 1870 1871 /** 1872 * _getLastMediaRevisionAt is a helperfunction to internalmedia() and _media() 1873 * which returns an existing media revision less or equal to rev or date_at 1874 * 1875 * @author lisps 1876 * @param string $media_id 1877 * @access protected 1878 * @return string revision ('' for current) 1879 */ 1880 function _getLastMediaRevisionAt($media_id){ 1881 if(!$this->date_at || media_isexternal($media_id)) return ''; 1882 $pagelog = new MediaChangeLog($media_id); 1883 return $pagelog->getLastRevisionAt($this->date_at); 1884 } 1885 1886 #endregion 1887} 1888 1889//Setup VIM: ex: et ts=4 : 1890