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 function listu_open() { 432 $this->doc .= '<ul>'.DOKU_LF; 433 } 434 435 /** 436 * Close an unordered list 437 */ 438 function listu_close() { 439 $this->doc .= '</ul>'.DOKU_LF; 440 } 441 442 /** 443 * Open an ordered list 444 */ 445 function listo_open() { 446 $this->doc .= '<ol>'.DOKU_LF; 447 } 448 449 /** 450 * Close an ordered list 451 */ 452 function listo_close() { 453 $this->doc .= '</ol>'.DOKU_LF; 454 } 455 456 /** 457 * Open a list item 458 * 459 * @param int $level the nesting level 460 * @param bool $node true when a node; false when a leaf 461 */ 462 function listitem_open($level, $node=false) { 463 $branching = $node ? ' node' : ''; 464 $this->doc .= '<li class="level'.$level.$branching.'">'; 465 } 466 467 /** 468 * Close a list item 469 */ 470 function listitem_close() { 471 $this->doc .= '</li>'.DOKU_LF; 472 } 473 474 /** 475 * Start the content of a list item 476 */ 477 function listcontent_open() { 478 $this->doc .= '<div class="li">'; 479 } 480 481 /** 482 * Stop the content of a list item 483 */ 484 function listcontent_close() { 485 $this->doc .= '</div>'.DOKU_LF; 486 } 487 488 /** 489 * Output unformatted $text 490 * 491 * Defaults to $this->cdata() 492 * 493 * @param string $text 494 */ 495 function unformatted($text) { 496 $this->doc .= $this->_xmlEntities($text); 497 } 498 499 /** 500 * Execute PHP code if allowed 501 * 502 * @param string $text PHP code that is either executed or printed 503 * @param string $wrapper html element to wrap result if $conf['phpok'] is okff 504 * 505 * @author Andreas Gohr <andi@splitbrain.org> 506 */ 507 function php($text, $wrapper = 'code') { 508 global $conf; 509 510 if($conf['phpok']) { 511 ob_start(); 512 eval($text); 513 $this->doc .= ob_get_contents(); 514 ob_end_clean(); 515 } else { 516 $this->doc .= p_xhtml_cached_geshi($text, 'php', $wrapper); 517 } 518 } 519 520 /** 521 * Output block level PHP code 522 * 523 * If $conf['phpok'] is true this should evaluate the given code and append the result 524 * to $doc 525 * 526 * @param string $text The PHP code 527 */ 528 function phpblock($text) { 529 $this->php($text, 'pre'); 530 } 531 532 /** 533 * Insert HTML if allowed 534 * 535 * @param string $text html text 536 * @param string $wrapper html element to wrap result if $conf['htmlok'] is okff 537 * 538 * @author Andreas Gohr <andi@splitbrain.org> 539 */ 540 function html($text, $wrapper = 'code') { 541 global $conf; 542 543 if($conf['htmlok']) { 544 $this->doc .= $text; 545 } else { 546 $this->doc .= p_xhtml_cached_geshi($text, 'html4strict', $wrapper); 547 } 548 } 549 550 /** 551 * Output raw block-level HTML 552 * 553 * If $conf['htmlok'] is true this should add the code as is to $doc 554 * 555 * @param string $text The HTML 556 */ 557 function htmlblock($text) { 558 $this->html($text, 'pre'); 559 } 560 561 /** 562 * Start a block quote 563 */ 564 function quote_open() { 565 $this->doc .= '<blockquote><div class="no">'.DOKU_LF; 566 } 567 568 /** 569 * Stop a block quote 570 */ 571 function quote_close() { 572 $this->doc .= '</div></blockquote>'.DOKU_LF; 573 } 574 575 /** 576 * Output preformatted text 577 * 578 * @param string $text 579 */ 580 function preformatted($text) { 581 $this->doc .= '<pre class="code">'.trim($this->_xmlEntities($text), "\n\r").'</pre>'.DOKU_LF; 582 } 583 584 /** 585 * Display text as file content, optionally syntax highlighted 586 * 587 * @param string $text text to show 588 * @param string $language programming language to use for syntax highlighting 589 * @param string $filename file path label 590 */ 591 function file($text, $language = null, $filename = null) { 592 $this->_highlight('file', $text, $language, $filename); 593 } 594 595 /** 596 * Display text as code content, optionally syntax highlighted 597 * 598 * @param string $text text to show 599 * @param string $language programming language to use for syntax highlighting 600 * @param string $filename file path label 601 */ 602 function code($text, $language = null, $filename = null) { 603 $this->_highlight('code', $text, $language, $filename); 604 } 605 606 /** 607 * Use GeSHi to highlight language syntax in code and file blocks 608 * 609 * @author Andreas Gohr <andi@splitbrain.org> 610 * @param string $type code|file 611 * @param string $text text to show 612 * @param string $language programming language to use for syntax highlighting 613 * @param string $filename file path label 614 */ 615 function _highlight($type, $text, $language = null, $filename = null) { 616 global $ID; 617 global $lang; 618 619 if($filename) { 620 // add icon 621 list($ext) = mimetype($filename, false); 622 $class = preg_replace('/[^_\-a-z0-9]+/i', '_', $ext); 623 $class = 'mediafile mf_'.$class; 624 625 $this->doc .= '<dl class="'.$type.'">'.DOKU_LF; 626 $this->doc .= '<dt><a href="'.exportlink($ID, 'code', array('codeblock' => $this->_codeblock)).'" title="'.$lang['download'].'" class="'.$class.'">'; 627 $this->doc .= hsc($filename); 628 $this->doc .= '</a></dt>'.DOKU_LF.'<dd>'; 629 } 630 631 if($text{0} == "\n") { 632 $text = substr($text, 1); 633 } 634 if(substr($text, -1) == "\n") { 635 $text = substr($text, 0, -1); 636 } 637 638 if(is_null($language)) { 639 $this->doc .= '<pre class="'.$type.'">'.$this->_xmlEntities($text).'</pre>'.DOKU_LF; 640 } else { 641 $class = 'code'; //we always need the code class to make the syntax highlighting apply 642 if($type != 'code') $class .= ' '.$type; 643 644 $this->doc .= "<pre class=\"$class $language\">".p_xhtml_cached_geshi($text, $language, '').'</pre>'.DOKU_LF; 645 } 646 647 if($filename) { 648 $this->doc .= '</dd></dl>'.DOKU_LF; 649 } 650 651 $this->_codeblock++; 652 } 653 654 /** 655 * Format an acronym 656 * 657 * Uses $this->acronyms 658 * 659 * @param string $acronym 660 */ 661 function acronym($acronym) { 662 663 if(array_key_exists($acronym, $this->acronyms)) { 664 665 $title = $this->_xmlEntities($this->acronyms[$acronym]); 666 667 $this->doc .= '<abbr title="'.$title 668 .'">'.$this->_xmlEntities($acronym).'</abbr>'; 669 670 } else { 671 $this->doc .= $this->_xmlEntities($acronym); 672 } 673 } 674 675 /** 676 * Format a smiley 677 * 678 * Uses $this->smiley 679 * 680 * @param string $smiley 681 */ 682 function smiley($smiley) { 683 if(array_key_exists($smiley, $this->smileys)) { 684 $this->doc .= '<img src="'.DOKU_BASE.'lib/images/smileys/'.$this->smileys[$smiley]. 685 '" class="icon" alt="'. 686 $this->_xmlEntities($smiley).'" />'; 687 } else { 688 $this->doc .= $this->_xmlEntities($smiley); 689 } 690 } 691 692 /** 693 * Format an entity 694 * 695 * Entities are basically small text replacements 696 * 697 * Uses $this->entities 698 * 699 * @param string $entity 700 */ 701 function entity($entity) { 702 if(array_key_exists($entity, $this->entities)) { 703 $this->doc .= $this->entities[$entity]; 704 } else { 705 $this->doc .= $this->_xmlEntities($entity); 706 } 707 } 708 709 /** 710 * Typographically format a multiply sign 711 * 712 * Example: ($x=640, $y=480) should result in "640×480" 713 * 714 * @param string|int $x first value 715 * @param string|int $y second value 716 */ 717 function multiplyentity($x, $y) { 718 $this->doc .= "$x×$y"; 719 } 720 721 /** 722 * Render an opening single quote char (language specific) 723 */ 724 function singlequoteopening() { 725 global $lang; 726 $this->doc .= $lang['singlequoteopening']; 727 } 728 729 /** 730 * Render a closing single quote char (language specific) 731 */ 732 function singlequoteclosing() { 733 global $lang; 734 $this->doc .= $lang['singlequoteclosing']; 735 } 736 737 /** 738 * Render an apostrophe char (language specific) 739 */ 740 function apostrophe() { 741 global $lang; 742 $this->doc .= $lang['apostrophe']; 743 } 744 745 /** 746 * Render an opening double quote char (language specific) 747 */ 748 function doublequoteopening() { 749 global $lang; 750 $this->doc .= $lang['doublequoteopening']; 751 } 752 753 /** 754 * Render an closinging double quote char (language specific) 755 */ 756 function doublequoteclosing() { 757 global $lang; 758 $this->doc .= $lang['doublequoteclosing']; 759 } 760 761 /** 762 * Render a CamelCase link 763 * 764 * @param string $link The link name 765 * @param bool $returnonly whether to return html or write to doc attribute 766 * @see http://en.wikipedia.org/wiki/CamelCase 767 */ 768 function camelcaselink($link, $returnonly = false) { 769 if($returnonly) { 770 return $this->internallink($link, $link, null, true); 771 } else { 772 $this->internallink($link, $link); 773 } 774 } 775 776 /** 777 * Render a page local link 778 * 779 * @param string $hash hash link identifier 780 * @param string $name name for the link 781 * @param bool $returnonly whether to return html or write to doc attribute 782 */ 783 function locallink($hash, $name = null, $returnonly = false) { 784 global $ID; 785 $name = $this->_getLinkTitle($name, $hash, $isImage); 786 $hash = $this->_headerToLink($hash); 787 $title = $ID.' ↵'; 788 789 $doc = '<a href="#'.$hash.'" title="'.$title.'" class="wikilink1">'; 790 $doc .= $name; 791 $doc .= '</a>'; 792 793 if($returnonly) { 794 return $doc; 795 } else { 796 $this->doc .= $doc; 797 } 798 } 799 800 /** 801 * Render an internal Wiki Link 802 * 803 * $search,$returnonly & $linktype are not for the renderer but are used 804 * elsewhere - no need to implement them in other renderers 805 * 806 * @author Andreas Gohr <andi@splitbrain.org> 807 * @param string $id pageid 808 * @param string|null $name link name 809 * @param string|null $search adds search url param 810 * @param bool $returnonly whether to return html or write to doc attribute 811 * @param string $linktype type to set use of headings 812 * @return void|string writes to doc attribute or returns html depends on $returnonly 813 */ 814 function internallink($id, $name = null, $search = null, $returnonly = false, $linktype = 'content') { 815 global $conf; 816 global $ID; 817 global $INFO; 818 819 $params = ''; 820 $parts = explode('?', $id, 2); 821 if(count($parts) === 2) { 822 $id = $parts[0]; 823 $params = $parts[1]; 824 } 825 826 // For empty $id we need to know the current $ID 827 // We need this check because _simpleTitle needs 828 // correct $id and resolve_pageid() use cleanID($id) 829 // (some things could be lost) 830 if($id === '') { 831 $id = $ID; 832 } 833 834 // default name is based on $id as given 835 $default = $this->_simpleTitle($id); 836 837 // now first resolve and clean up the $id 838 resolve_pageid(getNS($ID), $id, $exists, $this->date_at, true); 839 840 $link = array(); 841 $name = $this->_getLinkTitle($name, $default, $isImage, $id, $linktype); 842 if(!$isImage) { 843 if($exists) { 844 $class = 'wikilink1'; 845 } else { 846 $class = 'wikilink2'; 847 $link['rel'] = 'nofollow'; 848 } 849 } else { 850 $class = 'media'; 851 } 852 853 //keep hash anchor 854 @list($id, $hash) = explode('#', $id, 2); 855 if(!empty($hash)) $hash = $this->_headerToLink($hash); 856 857 //prepare for formating 858 $link['target'] = $conf['target']['wiki']; 859 $link['style'] = ''; 860 $link['pre'] = ''; 861 $link['suf'] = ''; 862 // highlight link to current page 863 if($id == $INFO['id']) { 864 $link['pre'] = '<span class="curid">'; 865 $link['suf'] = '</span>'; 866 } 867 $link['more'] = ''; 868 $link['class'] = $class; 869 if($this->date_at) { 870 $params['at'] = $this->date_at; 871 } 872 $link['url'] = wl($id, $params); 873 $link['name'] = $name; 874 $link['title'] = $id; 875 //add search string 876 if($search) { 877 ($conf['userewrite']) ? $link['url'] .= '?' : $link['url'] .= '&'; 878 if(is_array($search)) { 879 $search = array_map('rawurlencode', $search); 880 $link['url'] .= 's[]='.join('&s[]=', $search); 881 } else { 882 $link['url'] .= 's='.rawurlencode($search); 883 } 884 } 885 886 //keep hash 887 if($hash) $link['url'] .= '#'.$hash; 888 889 //output formatted 890 if($returnonly) { 891 return $this->_formatLink($link); 892 } else { 893 $this->doc .= $this->_formatLink($link); 894 } 895 } 896 897 /** 898 * Render an external link 899 * 900 * @param string $url full URL with scheme 901 * @param string|array $name name for the link, array for media file 902 * @param bool $returnonly whether to return html or write to doc attribute 903 */ 904 function externallink($url, $name = null, $returnonly = false) { 905 global $conf; 906 907 $name = $this->_getLinkTitle($name, $url, $isImage); 908 909 // url might be an attack vector, only allow registered protocols 910 if(is_null($this->schemes)) $this->schemes = getSchemes(); 911 list($scheme) = explode('://', $url); 912 $scheme = strtolower($scheme); 913 if(!in_array($scheme, $this->schemes)) $url = ''; 914 915 // is there still an URL? 916 if(!$url) { 917 $this->doc .= $name; 918 return; 919 } 920 921 // set class 922 if(!$isImage) { 923 $class = 'urlextern'; 924 } else { 925 $class = 'media'; 926 } 927 928 //prepare for formating 929 $link = array(); 930 $link['target'] = $conf['target']['extern']; 931 $link['style'] = ''; 932 $link['pre'] = ''; 933 $link['suf'] = ''; 934 $link['more'] = ''; 935 $link['class'] = $class; 936 $link['url'] = $url; 937 938 $link['name'] = $name; 939 $link['title'] = $this->_xmlEntities($url); 940 if($conf['relnofollow']) $link['more'] .= ' rel="nofollow"'; 941 942 //output formatted 943 if($returnonly) { 944 return $this->_formatLink($link); 945 } else { 946 $this->doc .= $this->_formatLink($link); 947 } 948 } 949 950 /** 951 * Render an interwiki link 952 * 953 * You may want to use $this->_resolveInterWiki() here 954 * 955 * @param string $match original link - probably not much use 956 * @param string|array $name name for the link, array for media file 957 * @param string $wikiName indentifier (shortcut) for the remote wiki 958 * @param string $wikiUri the fragment parsed from the original link 959 * @param bool $returnonly whether to return html or write to doc attribute 960 */ 961 function interwikilink($match, $name = null, $wikiName, $wikiUri, $returnonly = false) { 962 global $conf; 963 964 $link = array(); 965 $link['target'] = $conf['target']['interwiki']; 966 $link['pre'] = ''; 967 $link['suf'] = ''; 968 $link['more'] = ''; 969 $link['name'] = $this->_getLinkTitle($name, $wikiUri, $isImage); 970 971 //get interwiki URL 972 $exists = null; 973 $url = $this->_resolveInterWiki($wikiName, $wikiUri, $exists); 974 975 if(!$isImage) { 976 $class = preg_replace('/[^_\-a-z0-9]+/i', '_', $wikiName); 977 $link['class'] = "interwiki iw_$class"; 978 } else { 979 $link['class'] = 'media'; 980 } 981 982 //do we stay at the same server? Use local target 983 if(strpos($url, DOKU_URL) === 0 OR strpos($url, DOKU_BASE) === 0) { 984 $link['target'] = $conf['target']['wiki']; 985 } 986 if($exists !== null && !$isImage) { 987 if($exists) { 988 $link['class'] .= ' wikilink1'; 989 } else { 990 $link['class'] .= ' wikilink2'; 991 $link['rel'] = 'nofollow'; 992 } 993 } 994 995 $link['url'] = $url; 996 $link['title'] = htmlspecialchars($link['url']); 997 998 //output formatted 999 if($returnonly) { 1000 return $this->_formatLink($link); 1001 } else { 1002 $this->doc .= $this->_formatLink($link); 1003 } 1004 } 1005 1006 /** 1007 * Link to windows share 1008 * 1009 * @param string $url the link 1010 * @param string|array $name name for the link, array for media file 1011 * @param bool $returnonly whether to return html or write to doc attribute 1012 */ 1013 function windowssharelink($url, $name = null, $returnonly = false) { 1014 global $conf; 1015 1016 //simple setup 1017 $link = array(); 1018 $link['target'] = $conf['target']['windows']; 1019 $link['pre'] = ''; 1020 $link['suf'] = ''; 1021 $link['style'] = ''; 1022 1023 $link['name'] = $this->_getLinkTitle($name, $url, $isImage); 1024 if(!$isImage) { 1025 $link['class'] = 'windows'; 1026 } else { 1027 $link['class'] = 'media'; 1028 } 1029 1030 $link['title'] = $this->_xmlEntities($url); 1031 $url = str_replace('\\', '/', $url); 1032 $url = ltrim($url,'/'); 1033 $url = 'file:///'.$url; 1034 $link['url'] = $url; 1035 1036 //output formatted 1037 if($returnonly) { 1038 return $this->_formatLink($link); 1039 } else { 1040 $this->doc .= $this->_formatLink($link); 1041 } 1042 } 1043 1044 /** 1045 * Render a linked E-Mail Address 1046 * 1047 * Honors $conf['mailguard'] setting 1048 * 1049 * @param string $address Email-Address 1050 * @param string|array $name name for the link, array for media file 1051 * @param bool $returnonly whether to return html or write to doc attribute 1052 */ 1053 function emaillink($address, $name = null, $returnonly = false) { 1054 global $conf; 1055 //simple setup 1056 $link = array(); 1057 $link['target'] = ''; 1058 $link['pre'] = ''; 1059 $link['suf'] = ''; 1060 $link['style'] = ''; 1061 $link['more'] = ''; 1062 1063 $name = $this->_getLinkTitle($name, '', $isImage); 1064 if(!$isImage) { 1065 $link['class'] = 'mail'; 1066 } else { 1067 $link['class'] = 'media'; 1068 } 1069 1070 $address = $this->_xmlEntities($address); 1071 $address = obfuscate($address); 1072 $title = $address; 1073 1074 if(empty($name)) { 1075 $name = $address; 1076 } 1077 1078 if($conf['mailguard'] == 'visible') $address = rawurlencode($address); 1079 1080 $link['url'] = 'mailto:'.$address; 1081 $link['name'] = $name; 1082 $link['title'] = $title; 1083 1084 //output formatted 1085 if($returnonly) { 1086 return $this->_formatLink($link); 1087 } else { 1088 $this->doc .= $this->_formatLink($link); 1089 } 1090 } 1091 1092 /** 1093 * Render an internal media file 1094 * 1095 * @param string $src media ID 1096 * @param string $title descriptive text 1097 * @param string $align left|center|right 1098 * @param int $width width of media in pixel 1099 * @param int $height height of media in pixel 1100 * @param string $cache cache|recache|nocache 1101 * @param string $linking linkonly|detail|nolink 1102 * @param bool $return return HTML instead of adding to $doc 1103 * @return void|string 1104 */ 1105 function internalmedia($src, $title = null, $align = null, $width = null, 1106 $height = null, $cache = null, $linking = null, $return = false) { 1107 global $ID; 1108 list($src, $hash) = explode('#', $src, 2); 1109 resolve_mediaid(getNS($ID), $src, $exists, $this->date_at, true); 1110 1111 $noLink = false; 1112 $render = ($linking == 'linkonly') ? false : true; 1113 $link = $this->_getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render); 1114 1115 list($ext, $mime) = mimetype($src, false); 1116 if(substr($mime, 0, 5) == 'image' && $render) { 1117 $link['url'] = ml($src, array('id' => $ID, 'cache' => $cache, 'rev'=>$this->_getLastMediaRevisionAt($src)), ($linking == 'direct')); 1118 } elseif(($mime == 'application/x-shockwave-flash' || media_supportedav($mime)) && $render) { 1119 // don't link movies 1120 $noLink = true; 1121 } else { 1122 // add file icons 1123 $class = preg_replace('/[^_\-a-z0-9]+/i', '_', $ext); 1124 $link['class'] .= ' mediafile mf_'.$class; 1125 $link['url'] = ml($src, array('id' => $ID, 'cache' => $cache , 'rev'=>$this->_getLastMediaRevisionAt($src)), true); 1126 if($exists) $link['title'] .= ' ('.filesize_h(filesize(mediaFN($src))).')'; 1127 } 1128 1129 if($hash) $link['url'] .= '#'.$hash; 1130 1131 //markup non existing files 1132 if(!$exists) { 1133 $link['class'] .= ' wikilink2'; 1134 } 1135 1136 //output formatted 1137 if($return) { 1138 if($linking == 'nolink' || $noLink) return $link['name']; 1139 else return $this->_formatLink($link); 1140 } else { 1141 if($linking == 'nolink' || $noLink) $this->doc .= $link['name']; 1142 else $this->doc .= $this->_formatLink($link); 1143 } 1144 } 1145 1146 /** 1147 * Render an external media file 1148 * 1149 * @param string $src full media URL 1150 * @param string $title descriptive text 1151 * @param string $align left|center|right 1152 * @param int $width width of media in pixel 1153 * @param int $height height of media in pixel 1154 * @param string $cache cache|recache|nocache 1155 * @param string $linking linkonly|detail|nolink 1156 * @param bool $return return HTML instead of adding to $doc 1157 */ 1158 function externalmedia($src, $title = null, $align = null, $width = null, 1159 $height = null, $cache = null, $linking = null, $return = false) { 1160 list($src, $hash) = explode('#', $src, 2); 1161 $noLink = false; 1162 $render = ($linking == 'linkonly') ? false : true; 1163 $link = $this->_getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render); 1164 1165 $link['url'] = ml($src, array('cache' => $cache)); 1166 1167 list($ext, $mime) = mimetype($src, false); 1168 if(substr($mime, 0, 5) == 'image' && $render) { 1169 // link only jpeg images 1170 // if ($ext != 'jpg' && $ext != 'jpeg') $noLink = true; 1171 } elseif(($mime == 'application/x-shockwave-flash' || media_supportedav($mime)) && $render) { 1172 // don't link movies 1173 $noLink = true; 1174 } else { 1175 // add file icons 1176 $class = preg_replace('/[^_\-a-z0-9]+/i', '_', $ext); 1177 $link['class'] .= ' mediafile mf_'.$class; 1178 } 1179 1180 if($hash) $link['url'] .= '#'.$hash; 1181 1182 //output formatted 1183 if($return) { 1184 if($linking == 'nolink' || $noLink) return $link['name']; 1185 else return $this->_formatLink($link); 1186 } else { 1187 if($linking == 'nolink' || $noLink) $this->doc .= $link['name']; 1188 else $this->doc .= $this->_formatLink($link); 1189 } 1190 } 1191 1192 /** 1193 * Renders an RSS feed 1194 * 1195 * @author Andreas Gohr <andi@splitbrain.org> 1196 */ 1197 function rss($url, $params) { 1198 global $lang; 1199 global $conf; 1200 1201 require_once(DOKU_INC.'inc/FeedParser.php'); 1202 $feed = new FeedParser(); 1203 $feed->set_feed_url($url); 1204 1205 //disable warning while fetching 1206 if(!defined('DOKU_E_LEVEL')) { 1207 $elvl = error_reporting(E_ERROR); 1208 } 1209 $rc = $feed->init(); 1210 if(isset($elvl)) { 1211 error_reporting($elvl); 1212 } 1213 1214 if($params['nosort']) $feed->enable_order_by_date(false); 1215 1216 //decide on start and end 1217 if($params['reverse']) { 1218 $mod = -1; 1219 $start = $feed->get_item_quantity() - 1; 1220 $end = $start - ($params['max']); 1221 $end = ($end < -1) ? -1 : $end; 1222 } else { 1223 $mod = 1; 1224 $start = 0; 1225 $end = $feed->get_item_quantity(); 1226 $end = ($end > $params['max']) ? $params['max'] : $end; 1227 } 1228 1229 $this->doc .= '<ul class="rss">'; 1230 if($rc) { 1231 for($x = $start; $x != $end; $x += $mod) { 1232 $item = $feed->get_item($x); 1233 $this->doc .= '<li><div class="li">'; 1234 // support feeds without links 1235 $lnkurl = $item->get_permalink(); 1236 if($lnkurl) { 1237 // title is escaped by SimplePie, we unescape here because it 1238 // is escaped again in externallink() FS#1705 1239 $this->externallink( 1240 $item->get_permalink(), 1241 html_entity_decode($item->get_title(), ENT_QUOTES, 'UTF-8') 1242 ); 1243 } else { 1244 $this->doc .= ' '.$item->get_title(); 1245 } 1246 if($params['author']) { 1247 $author = $item->get_author(0); 1248 if($author) { 1249 $name = $author->get_name(); 1250 if(!$name) $name = $author->get_email(); 1251 if($name) $this->doc .= ' '.$lang['by'].' '.$name; 1252 } 1253 } 1254 if($params['date']) { 1255 $this->doc .= ' ('.$item->get_local_date($conf['dformat']).')'; 1256 } 1257 if($params['details']) { 1258 $this->doc .= '<div class="detail">'; 1259 if($conf['htmlok']) { 1260 $this->doc .= $item->get_description(); 1261 } else { 1262 $this->doc .= strip_tags($item->get_description()); 1263 } 1264 $this->doc .= '</div>'; 1265 } 1266 1267 $this->doc .= '</div></li>'; 1268 } 1269 } else { 1270 $this->doc .= '<li><div class="li">'; 1271 $this->doc .= '<em>'.$lang['rssfailed'].'</em>'; 1272 $this->externallink($url); 1273 if($conf['allowdebug']) { 1274 $this->doc .= '<!--'.hsc($feed->error).'-->'; 1275 } 1276 $this->doc .= '</div></li>'; 1277 } 1278 $this->doc .= '</ul>'; 1279 } 1280 1281 /** 1282 * Start a table 1283 * 1284 * @param int $maxcols maximum number of columns 1285 * @param int $numrows NOT IMPLEMENTED 1286 * @param int $pos byte position in the original source 1287 */ 1288 function table_open($maxcols = null, $numrows = null, $pos = null) { 1289 // initialize the row counter used for classes 1290 $this->_counter['row_counter'] = 0; 1291 $class = 'table'; 1292 if($pos !== null) { 1293 $class .= ' '.$this->startSectionEdit($pos, 'table'); 1294 } 1295 $this->doc .= '<div class="'.$class.'"><table class="inline">'. 1296 DOKU_LF; 1297 } 1298 1299 /** 1300 * Close a table 1301 * 1302 * @param int $pos byte position in the original source 1303 */ 1304 function table_close($pos = null) { 1305 $this->doc .= '</table></div>'.DOKU_LF; 1306 if($pos !== null) { 1307 $this->finishSectionEdit($pos); 1308 } 1309 } 1310 1311 /** 1312 * Open a table header 1313 */ 1314 function tablethead_open() { 1315 $this->doc .= DOKU_TAB.'<thead>'.DOKU_LF; 1316 } 1317 1318 /** 1319 * Close a table header 1320 */ 1321 function tablethead_close() { 1322 $this->doc .= DOKU_TAB.'</thead>'.DOKU_LF; 1323 } 1324 1325 /** 1326 * Open a table body 1327 */ 1328 function tabletbody_open() { 1329 $this->doc .= DOKU_TAB.'<tbody>'.DOKU_LF; 1330 } 1331 1332 /** 1333 * Close a table body 1334 */ 1335 function tabletbody_close() { 1336 $this->doc .= DOKU_TAB.'</tbody>'.DOKU_LF; 1337 } 1338 1339 /** 1340 * Open a table row 1341 */ 1342 function tablerow_open() { 1343 // initialize the cell counter used for classes 1344 $this->_counter['cell_counter'] = 0; 1345 $class = 'row'.$this->_counter['row_counter']++; 1346 $this->doc .= DOKU_TAB.'<tr class="'.$class.'">'.DOKU_LF.DOKU_TAB.DOKU_TAB; 1347 } 1348 1349 /** 1350 * Close a table row 1351 */ 1352 function tablerow_close() { 1353 $this->doc .= DOKU_LF.DOKU_TAB.'</tr>'.DOKU_LF; 1354 } 1355 1356 /** 1357 * Open a table header cell 1358 * 1359 * @param int $colspan 1360 * @param string $align left|center|right 1361 * @param int $rowspan 1362 */ 1363 function tableheader_open($colspan = 1, $align = null, $rowspan = 1) { 1364 $class = 'class="col'.$this->_counter['cell_counter']++; 1365 if(!is_null($align)) { 1366 $class .= ' '.$align.'align'; 1367 } 1368 $class .= '"'; 1369 $this->doc .= '<th '.$class; 1370 if($colspan > 1) { 1371 $this->_counter['cell_counter'] += $colspan - 1; 1372 $this->doc .= ' colspan="'.$colspan.'"'; 1373 } 1374 if($rowspan > 1) { 1375 $this->doc .= ' rowspan="'.$rowspan.'"'; 1376 } 1377 $this->doc .= '>'; 1378 } 1379 1380 /** 1381 * Close a table header cell 1382 */ 1383 function tableheader_close() { 1384 $this->doc .= '</th>'; 1385 } 1386 1387 /** 1388 * Open a table cell 1389 * 1390 * @param int $colspan 1391 * @param string $align left|center|right 1392 * @param int $rowspan 1393 */ 1394 function tablecell_open($colspan = 1, $align = null, $rowspan = 1) { 1395 $class = 'class="col'.$this->_counter['cell_counter']++; 1396 if(!is_null($align)) { 1397 $class .= ' '.$align.'align'; 1398 } 1399 $class .= '"'; 1400 $this->doc .= '<td '.$class; 1401 if($colspan > 1) { 1402 $this->_counter['cell_counter'] += $colspan - 1; 1403 $this->doc .= ' colspan="'.$colspan.'"'; 1404 } 1405 if($rowspan > 1) { 1406 $this->doc .= ' rowspan="'.$rowspan.'"'; 1407 } 1408 $this->doc .= '>'; 1409 } 1410 1411 /** 1412 * Close a table cell 1413 */ 1414 function tablecell_close() { 1415 $this->doc .= '</td>'; 1416 } 1417 1418 #region Utility functions 1419 1420 /** 1421 * Build a link 1422 * 1423 * Assembles all parts defined in $link returns HTML for the link 1424 * 1425 * @author Andreas Gohr <andi@splitbrain.org> 1426 */ 1427 function _formatLink($link) { 1428 //make sure the url is XHTML compliant (skip mailto) 1429 if(substr($link['url'], 0, 7) != 'mailto:') { 1430 $link['url'] = str_replace('&', '&', $link['url']); 1431 $link['url'] = str_replace('&amp;', '&', $link['url']); 1432 } 1433 //remove double encodings in titles 1434 $link['title'] = str_replace('&amp;', '&', $link['title']); 1435 1436 // be sure there are no bad chars in url or title 1437 // (we can't do this for name because it can contain an img tag) 1438 $link['url'] = strtr($link['url'], array('>' => '%3E', '<' => '%3C', '"' => '%22')); 1439 $link['title'] = strtr($link['title'], array('>' => '>', '<' => '<', '"' => '"')); 1440 1441 $ret = ''; 1442 $ret .= $link['pre']; 1443 $ret .= '<a href="'.$link['url'].'"'; 1444 if(!empty($link['class'])) $ret .= ' class="'.$link['class'].'"'; 1445 if(!empty($link['target'])) $ret .= ' target="'.$link['target'].'"'; 1446 if(!empty($link['title'])) $ret .= ' title="'.$link['title'].'"'; 1447 if(!empty($link['style'])) $ret .= ' style="'.$link['style'].'"'; 1448 if(!empty($link['rel'])) $ret .= ' rel="'.$link['rel'].'"'; 1449 if(!empty($link['more'])) $ret .= ' '.$link['more']; 1450 $ret .= '>'; 1451 $ret .= $link['name']; 1452 $ret .= '</a>'; 1453 $ret .= $link['suf']; 1454 return $ret; 1455 } 1456 1457 /** 1458 * Renders internal and external media 1459 * 1460 * @author Andreas Gohr <andi@splitbrain.org> 1461 * @param string $src media ID 1462 * @param string $title descriptive text 1463 * @param string $align left|center|right 1464 * @param int $width width of media in pixel 1465 * @param int $height height of media in pixel 1466 * @param string $cache cache|recache|nocache 1467 * @param bool $render should the media be embedded inline or just linked 1468 * @return string 1469 */ 1470 function _media($src, $title = null, $align = null, $width = null, 1471 $height = null, $cache = null, $render = true) { 1472 1473 $ret = ''; 1474 1475 list($ext, $mime) = mimetype($src); 1476 if(substr($mime, 0, 5) == 'image') { 1477 // first get the $title 1478 if(!is_null($title)) { 1479 $title = $this->_xmlEntities($title); 1480 } elseif($ext == 'jpg' || $ext == 'jpeg') { 1481 //try to use the caption from IPTC/EXIF 1482 require_once(DOKU_INC.'inc/JpegMeta.php'); 1483 $jpeg = new JpegMeta(mediaFN($src)); 1484 if($jpeg !== false) $cap = $jpeg->getTitle(); 1485 if(!empty($cap)) { 1486 $title = $this->_xmlEntities($cap); 1487 } 1488 } 1489 if(!$render) { 1490 // if the picture is not supposed to be rendered 1491 // return the title of the picture 1492 if(!$title) { 1493 // just show the sourcename 1494 $title = $this->_xmlEntities(utf8_basename(noNS($src))); 1495 } 1496 return $title; 1497 } 1498 //add image tag 1499 $ret .= '<img src="'.ml($src, array('w' => $width, 'h' => $height, 'cache' => $cache, 'rev'=>$this->_getLastMediaRevisionAt($src))).'"'; 1500 $ret .= ' class="media'.$align.'"'; 1501 1502 if($title) { 1503 $ret .= ' title="'.$title.'"'; 1504 $ret .= ' alt="'.$title.'"'; 1505 } else { 1506 $ret .= ' alt=""'; 1507 } 1508 1509 if(!is_null($width)) 1510 $ret .= ' width="'.$this->_xmlEntities($width).'"'; 1511 1512 if(!is_null($height)) 1513 $ret .= ' height="'.$this->_xmlEntities($height).'"'; 1514 1515 $ret .= ' />'; 1516 1517 } elseif(media_supportedav($mime, 'video') || media_supportedav($mime, 'audio')) { 1518 // first get the $title 1519 $title = !is_null($title) ? $this->_xmlEntities($title) : false; 1520 if(!$render) { 1521 // if the file is not supposed to be rendered 1522 // return the title of the file (just the sourcename if there is no title) 1523 return $title ? $title : $this->_xmlEntities(utf8_basename(noNS($src))); 1524 } 1525 1526 $att = array(); 1527 $att['class'] = "media$align"; 1528 if($title) { 1529 $att['title'] = $title; 1530 } 1531 1532 if(media_supportedav($mime, 'video')) { 1533 //add video 1534 $ret .= $this->_video($src, $width, $height, $att); 1535 } 1536 if(media_supportedav($mime, 'audio')) { 1537 //add audio 1538 $ret .= $this->_audio($src, $att); 1539 } 1540 1541 } elseif($mime == 'application/x-shockwave-flash') { 1542 if(!$render) { 1543 // if the flash is not supposed to be rendered 1544 // return the title of the flash 1545 if(!$title) { 1546 // just show the sourcename 1547 $title = utf8_basename(noNS($src)); 1548 } 1549 return $this->_xmlEntities($title); 1550 } 1551 1552 $att = array(); 1553 $att['class'] = "media$align"; 1554 if($align == 'right') $att['align'] = 'right'; 1555 if($align == 'left') $att['align'] = 'left'; 1556 $ret .= html_flashobject( 1557 ml($src, array('cache' => $cache), true, '&'), $width, $height, 1558 array('quality' => 'high'), 1559 null, 1560 $att, 1561 $this->_xmlEntities($title) 1562 ); 1563 } elseif($title) { 1564 // well at least we have a title to display 1565 $ret .= $this->_xmlEntities($title); 1566 } else { 1567 // just show the sourcename 1568 $ret .= $this->_xmlEntities(utf8_basename(noNS($src))); 1569 } 1570 1571 return $ret; 1572 } 1573 1574 /** 1575 * Escape string for output 1576 * 1577 * @param $string 1578 * @return string 1579 */ 1580 function _xmlEntities($string) { 1581 return htmlspecialchars($string, ENT_QUOTES, 'UTF-8'); 1582 } 1583 1584 /** 1585 * Creates a linkid from a headline 1586 * 1587 * @author Andreas Gohr <andi@splitbrain.org> 1588 * @param string $title The headline title 1589 * @param boolean $create Create a new unique ID? 1590 * @return string 1591 */ 1592 function _headerToLink($title, $create = false) { 1593 if($create) { 1594 return sectionID($title, $this->headers); 1595 } else { 1596 $check = false; 1597 return sectionID($title, $check); 1598 } 1599 } 1600 1601 /** 1602 * Construct a title and handle images in titles 1603 * 1604 * @author Harry Fuecks <hfuecks@gmail.com> 1605 * @param string|array $title either string title or media array 1606 * @param string $default default title if nothing else is found 1607 * @param bool $isImage will be set to true if it's a media file 1608 * @param null|string $id linked page id (used to extract title from first heading) 1609 * @param string $linktype content|navigation 1610 * @return string HTML of the title, might be full image tag or just escaped text 1611 */ 1612 function _getLinkTitle($title, $default, &$isImage, $id = null, $linktype = 'content') { 1613 $isImage = false; 1614 if(is_array($title)) { 1615 $isImage = true; 1616 return $this->_imageTitle($title); 1617 } elseif(is_null($title) || trim($title) == '') { 1618 if(useHeading($linktype) && $id) { 1619 $heading = p_get_first_heading($id); 1620 if($heading) { 1621 return $this->_xmlEntities($heading); 1622 } 1623 } 1624 return $this->_xmlEntities($default); 1625 } else { 1626 return $this->_xmlEntities($title); 1627 } 1628 } 1629 1630 /** 1631 * Returns HTML code for images used in link titles 1632 * 1633 * @author Andreas Gohr <andi@splitbrain.org> 1634 * @param array $img 1635 * @return string HTML img tag or similar 1636 */ 1637 function _imageTitle($img) { 1638 global $ID; 1639 1640 // some fixes on $img['src'] 1641 // see internalmedia() and externalmedia() 1642 list($img['src']) = explode('#', $img['src'], 2); 1643 if($img['type'] == 'internalmedia') { 1644 resolve_mediaid(getNS($ID), $img['src'], $exists ,$this->date_at, true); 1645 } 1646 1647 return $this->_media( 1648 $img['src'], 1649 $img['title'], 1650 $img['align'], 1651 $img['width'], 1652 $img['height'], 1653 $img['cache'] 1654 ); 1655 } 1656 1657 /** 1658 * helperfunction to return a basic link to a media 1659 * 1660 * used in internalmedia() and externalmedia() 1661 * 1662 * @author Pierre Spring <pierre.spring@liip.ch> 1663 * @param string $src media ID 1664 * @param string $title descriptive text 1665 * @param string $align left|center|right 1666 * @param int $width width of media in pixel 1667 * @param int $height height of media in pixel 1668 * @param string $cache cache|recache|nocache 1669 * @param bool $render should the media be embedded inline or just linked 1670 * @return array associative array with link config 1671 */ 1672 function _getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render) { 1673 global $conf; 1674 1675 $link = array(); 1676 $link['class'] = 'media'; 1677 $link['style'] = ''; 1678 $link['pre'] = ''; 1679 $link['suf'] = ''; 1680 $link['more'] = ''; 1681 $link['target'] = $conf['target']['media']; 1682 $link['title'] = $this->_xmlEntities($src); 1683 $link['name'] = $this->_media($src, $title, $align, $width, $height, $cache, $render); 1684 1685 return $link; 1686 } 1687 1688 /** 1689 * Embed video(s) in HTML 1690 * 1691 * @author Anika Henke <anika@selfthinker.org> 1692 * 1693 * @param string $src - ID of video to embed 1694 * @param int $width - width of the video in pixels 1695 * @param int $height - height of the video in pixels 1696 * @param array $atts - additional attributes for the <video> tag 1697 * @return string 1698 */ 1699 function _video($src, $width, $height, $atts = null) { 1700 // prepare width and height 1701 if(is_null($atts)) $atts = array(); 1702 $atts['width'] = (int) $width; 1703 $atts['height'] = (int) $height; 1704 if(!$atts['width']) $atts['width'] = 320; 1705 if(!$atts['height']) $atts['height'] = 240; 1706 1707 $posterUrl = ''; 1708 $files = array(); 1709 $isExternal = media_isexternal($src); 1710 1711 if ($isExternal) { 1712 // take direct source for external files 1713 list(/*ext*/, $srcMime) = mimetype($src); 1714 $files[$srcMime] = $src; 1715 } else { 1716 // prepare alternative formats 1717 $extensions = array('webm', 'ogv', 'mp4'); 1718 $files = media_alternativefiles($src, $extensions); 1719 $poster = media_alternativefiles($src, array('jpg', 'png')); 1720 if(!empty($poster)) { 1721 $posterUrl = ml(reset($poster), '', true, '&'); 1722 } 1723 } 1724 1725 $out = ''; 1726 // open video tag 1727 $out .= '<video '.buildAttributes($atts).' controls="controls"'; 1728 if($posterUrl) $out .= ' poster="'.hsc($posterUrl).'"'; 1729 $out .= '>'.NL; 1730 $fallback = ''; 1731 1732 // output source for each alternative video format 1733 foreach($files as $mime => $file) { 1734 if ($isExternal) { 1735 $url = $file; 1736 $linkType = 'externalmedia'; 1737 } else { 1738 $url = ml($file, '', true, '&'); 1739 $linkType = 'internalmedia'; 1740 } 1741 $title = $atts['title'] ? $atts['title'] : $this->_xmlEntities(utf8_basename(noNS($file))); 1742 1743 $out .= '<source src="'.hsc($url).'" type="'.$mime.'" />'.NL; 1744 // alternative content (just a link to the file) 1745 $fallback .= $this->$linkType($file, $title, null, null, null, $cache = null, $linking = 'linkonly', $return = true); 1746 } 1747 1748 // finish 1749 $out .= $fallback; 1750 $out .= '</video>'.NL; 1751 return $out; 1752 } 1753 1754 /** 1755 * Embed audio in HTML 1756 * 1757 * @author Anika Henke <anika@selfthinker.org> 1758 * 1759 * @param string $src - ID of audio to embed 1760 * @param array $atts - additional attributes for the <audio> tag 1761 * @return string 1762 */ 1763 function _audio($src, $atts = array()) { 1764 $files = array(); 1765 $isExternal = media_isexternal($src); 1766 1767 if ($isExternal) { 1768 // take direct source for external files 1769 list(/*ext*/, $srcMime) = mimetype($src); 1770 $files[$srcMime] = $src; 1771 } else { 1772 // prepare alternative formats 1773 $extensions = array('ogg', 'mp3', 'wav'); 1774 $files = media_alternativefiles($src, $extensions); 1775 } 1776 1777 $out = ''; 1778 // open audio tag 1779 $out .= '<audio '.buildAttributes($atts).' controls="controls">'.NL; 1780 $fallback = ''; 1781 1782 // output source for each alternative audio format 1783 foreach($files as $mime => $file) { 1784 if ($isExternal) { 1785 $url = $file; 1786 $linkType = 'externalmedia'; 1787 } else { 1788 $url = ml($file, '', true, '&'); 1789 $linkType = 'internalmedia'; 1790 } 1791 $title = $atts['title'] ? $atts['title'] : $this->_xmlEntities(utf8_basename(noNS($file))); 1792 1793 $out .= '<source src="'.hsc($url).'" type="'.$mime.'" />'.NL; 1794 // alternative content (just a link to the file) 1795 $fallback .= $this->$linkType($file, $title, null, null, null, $cache = null, $linking = 'linkonly', $return = true); 1796 } 1797 1798 // finish 1799 $out .= $fallback; 1800 $out .= '</audio>'.NL; 1801 return $out; 1802 } 1803 1804 /** 1805 * _getLastMediaRevisionAt is a helperfunction to internalmedia() and _media() 1806 * which returns an existing media revision less or equal to rev or date_at 1807 * 1808 * @author lisps 1809 * @param string $media_id 1810 * @access protected 1811 * @return string revision ('' for current) 1812 */ 1813 function _getLastMediaRevisionAt($media_id){ 1814 if(!$this->date_at || media_isexternal($media_id)) return ''; 1815 $pagelog = new MediaChangeLog($media_id); 1816 return $pagelog->getLastRevisionAt($this->date_at); 1817 } 1818 1819 #endregion 1820} 1821 1822//Setup VIM: ex: et ts=4 : 1823