xref: /plugin/nodetailsxhtml/renderer.php (revision 4a5dbf65826a4aeaf0c2535a8a937614ffbc0829) 
1<?php
2/**
3 * Render Plugin for XHTML  without details link for internal images.
4 *
5 * @author i-net software <tools@inetsoftware.de>
6 */
7
8if(!defined('DOKU_INC')) die();
9if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
10
11require_once DOKU_INC . 'inc/parser/xhtml.php';
12
13/**
14 * The Renderer
15 */
16class renderer_plugin_nodetailsxhtml extends Doku_Renderer_xhtml {
17
18    private $acronymsExchanged = null;
19    private $hasSeenHeader = false;
20    private $scriptmode = false;
21
22    private $startlevel = 0; // level to start with numbered headings (default = 2)
23    private $levels = array(        '======'=>1,
24                                    '====='=>2,
25                                    '===='=>3,
26                                    '==='=>4,
27                                    '=='=>5
28    );
29
30    public $sectionLevel = 0;
31    public $info = array(
32                                    'cache'      => true, // may the rendered result cached?
33                                    'toc'        => true, // render the TOC?
34                                    'forceTOC'   => false, // shall I force the TOC?
35                                    'scriptmode' => false, // In scriptmode, some tags will not be encoded => '<%', '%>'
36    );
37
38    public $headingCount = array(   1=>0,
39                                    2=>0,
40                                    3=>0,
41                                    4=>0,
42                                    5=>0
43    );
44
45    /**
46     * return some info
47     */
48    function getInfo(){
49        return confToHash(dirname(__FILE__).'/plugin.info.txt');
50    }
51
52    function canRender($format) {
53        return ($format=='xhtml');
54    }
55
56    function document_start() {
57        global $TOC, $ID, $INFO, $conf;
58
59        parent::document_start();
60
61        // Cheating in again
62        $meta = p_get_metadata($ID, null, false); // 2010-10-23 This should be save to use
63
64        if (isset($meta['toc']['toptoclevel'])) {
65            $conf['toptoclevel'] = $meta['toc']['toptoclevel'];
66        }
67        if (isset($meta['toc']['maxtoclevel'])) {
68            $conf['maxtoclevel'] = $meta['toc']['maxtoclevel'];
69        }
70        if (isset($meta['toc']['toptoclevel'])||isset($INFO['meta']['toc']['maxtoclevel'])) {
71            $conf['tocminheads'] = 1;
72        }
73
74        $newMeta = $meta['description'];
75        if ( is_array($newMeta) && !empty( $newMeta['tableofcontents'] ) && count($newMeta['tableofcontents']) > 1 ) {
76            // $TOC = $this->toc = $newMeta; // 2010-08-23 doubled the TOC
77            $TOC = $newMeta['tableofcontents'];
78        }
79    }
80
81    function document_end() {
82
83        parent::document_end();
84
85        // Prepare the TOC
86        global $TOC, $ID;
87        $meta = array();
88
89        $forceToc = $this->info['forceTOC'] || p_get_metadata($ID, 'internal forceTOC', false);
90
91        // NOTOC, and no forceTOC
92        if ( $this->info['toc'] === false && !$forceToc ) {
93            $TOC = $this->toc = array();
94            $meta['internal']['toc'] = false;
95            $meta['description']['tableofcontents'] = array();
96            $meta['internal']['forceTOC'] = false;
97
98        } else if ( $forceToc || ($this->utf8_strlen(strip_tags($this->doc)) >= $this->getConf('documentlengthfortoc') && count($this->toc) > 1 ) ) {
99            $TOC = $this->toc;
100            // This is a little bit like cheating ... but this will force the TOC into the metadata
101            $meta = array();
102            $meta['internal']['toc'] = true;
103            $meta['internal']['forceTOC'] = $forceToc;
104            $meta['description']['tableofcontents'] = $TOC;
105        }
106
107        // allways write new metadata
108        p_set_metadata($ID, $meta);
109
110        // make sure there are no empty blocks
111        $this->doc = preg_replace('#<(div|section|article) class="[^"]*?level\d[^"]*?">\s*</\1>#','',$this->doc);
112    }
113
114    private function utf8_strlen( $input ) {
115        if ( class_exists('dokuwiki\Utf8\PhpString') ) {
116            return dokuwiki\Utf8\PhpString::strlen( $input );
117        } else {
118            return utf8_strlen( $input );
119        }
120    }
121
122    function header($text, $level, $pos, $returnonly = false) {
123        global $conf;
124        global $ID;
125        global $INFO;
126
127        if($text) {
128
129            // Check Text for hint about a CSS style class
130            $class = "";
131            if ( preg_match("/^class:(.*?)>(.*?)$/", $text, $matches) ) {
132                $class = ' ' . $this->_xmlEntities($matches[1]);
133                $text = $matches[2];
134            }
135
136            /* There should be no class for "sectioneditX" if there is no edit perm */
137            $maxLevel = $conf['maxseclevel'];
138            if ( $INFO['perm'] <= AUTH_READ )
139            {
140                $conf['maxseclevel'] = 0;
141            }
142
143            $headingNumber = '';
144            $useNumbered = p_get_metadata($ID, 'usenumberedheading', true); // 2011-02-07 This should be save to use
145            if ( $this->getConf('usenumberedheading') || !empty($useNumbered) || !empty($INFO['meta']['usenumberedheading']) || isset($_REQUEST['usenumberedheading'])) {
146
147                // increment the number of the heading
148                $this->headingCount[$level]++;
149
150                // build the actual number
151                for ($i=1;$i<=5;$i++) {
152
153                    // reset the number of the subheadings
154                    if ($i>$level) {
155                        $this->headingCount[$i] = 0;
156                    }
157
158                    // build the number of the heading
159                    $headingNumber .= $this->headingCount[$i] . '.';
160                }
161
162                $headingNumber = preg_replace("/(\.0)+\.?$/", '', $headingNumber) . ' ';
163            }
164
165            $doc = $this->doc;
166            $this->doc = "";
167
168            parent::header($headingNumber . $text, $level, $pos);
169
170            if ( $this->getConf('useHeadAnchorInsteadOfHeaderID') ) {
171                $matches = [];
172                preg_match("/id=\"(.*?)\"/", $this->doc, $matches);
173                if ( count($matches) > 1 ) {
174                    $this->doc = preg_replace("/id=\".*?\"/", '', $this->doc);
175                    $this->doc = DOKU_LF.'<a id="'. $matches[1] .'" class="head-anchor" style="visibility:hidden"></a>'.DOKU_LF . $this->doc;
176                }
177            }
178
179            if ( $this->getConf('useSectionArticle') ) {
180                $this->doc = $doc . preg_replace("/(<h([1-9]))/", "<".($this->sectionLevel<1?'section':'article')." class=\"level\\2{$class}\">\\1", $this->doc);
181            } else {
182                $this->doc = $doc . $this->doc;
183            }
184
185            $conf['maxseclevel'] = $maxLevel;
186
187        } else if ( $INFO['perm'] > AUTH_READ ) {
188
189            if ( $hasSeenHeader ) $this->finishSectionEdit($pos);
190
191            // write the header
192            $name = $this->startSectionEdit($pos, array( 'target' => 'section_empty', 'name' => rand() . $level));
193            if ( $this->getConf('useSectionArticle') ) {
194                $this->doc .= '<'.($this->sectionLevel<1?'section':'article').' class="'.$name.'">';
195            }
196
197            $this->doc .= DOKU_LF.'<a name="'. $name .'" class="' . $name . '" ></a>'.DOKU_LF;
198        }
199
200        $hasSeenHeader = true;
201    }
202
203    public function finishSectionEdit($end = null, $hid = null) {
204        global $INFO;
205        if ( $INFO['perm'] > AUTH_READ )
206        {
207            return parent::finishSectionEdit($end, $hid);
208        }
209    }
210
211    public function startSectionEdit($start, $data) {
212        global $INFO;
213        if ( $INFO['perm'] > AUTH_READ )
214        {
215            return parent::startSectionEdit($start, $data);
216        }
217
218        return "";
219    }
220
221    function section_close() {
222        $this->sectionLevel--;
223        $this->doc .= DOKU_LF.'</div>'.DOKU_LF;
224        if ( $this->getConf('useSectionArticle') ) {
225            $this->doc .= '</'.($this->sectionLevel<1?'section':'article').'>'.DOKU_LF;
226        }
227    }
228
229    function section_open($level) {
230        $this->sectionLevel++;
231        return parent::section_open($level);
232    }
233
234    function internalmedia ($src, $title=null, $align=null, $width=null,
235                            $height=null, $cache=null, $linking=null, $return=NULL) {
236        global $ID;
237        list($src,$hash) = explode('#',$src,2);
238
239        if ( class_exists('dokuwiki\File\MediaResolver') ) {
240            $src = (new dokuwiki\File\MediaResolver($ID))->resolveId($src);
241        } else {
242            resolve_mediaid(getNS($ID),$src, $exists);
243        }
244
245        $noLink = false;
246        $render = ($linking == 'linkonly') ? false : true;
247        $link = $this->_getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render);
248
249        list($ext,$mime,$dl) = mimetype($src);
250        if(substr($mime,0,5) == 'image' && $render){
251            $link['url'] = ml($src,array('id'=>$ID,'cache'=>$cache),($linking=='direct'));
252            if ( substr($mime,0,5) == 'image' && $linking='details' ) { $noLink = true;}
253        }elseif($mime == 'application/x-shockwave-flash' && $render){
254            // don't link flash movies
255            $noLink = true;
256        }else{
257            // add file icons
258            $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
259            $link['class'] .= ' mediafile mf_'.$class;
260            $link['url'] = ml($src,array('id'=>$ID,'cache'=>$cache),true);
261        }
262
263        if($hash) $link['url'] .= '#'.$hash;
264
265        //markup non existing files
266        if (!$exists)
267        $link['class'] .= ' wikilink2';
268
269        //output formatted
270        if ($linking == 'nolink' || $noLink) $this->doc .= $link['name'];
271        else $this->doc .= $this->_formatLink($link);
272    }
273
274    /**
275     * Render an internal Wiki Link
276     *
277     * $search,$returnonly & $linktype are not for the renderer but are used
278     * elsewhere - no need to implement them in other renderers
279     *
280     * @author Andreas Gohr <andi@splitbrain.org>
281     */
282    function internallink($id, $name = null, $search=null,$returnonly=false,$linktype='content') {
283        global $conf;
284        global $ID;
285        global $INFO;
286
287        $params = '';
288        $parts = explode('?', $id, 2);
289        if (count($parts) === 2) {
290            $id = $parts[0];
291            $params = $parts[1];
292        }
293
294        // For empty $id we need to know the current $ID
295        // We need this check because _simpleTitle needs
296        // correct $id and resolve_pageid() use cleanID($id)
297        // (some things could be lost)
298        if ($id === '') {
299            $id = $ID;
300        }
301
302        // default name is based on $id as given
303        $default = $this->_simpleTitle($id);
304
305        // now first resolve and clean up the $id
306        if ( class_exists('dokuwiki\File\PageResolver') ) {
307            $id = (new dokuwiki\File\PageResolver($ID))->resolveId($id);
308        } else {
309            resolve_pageid(getNS($ID),$id,$exists);
310        }
311
312        $name = $this->_getLinkTitle($name, $default, $isImage, $id, $linktype);
313        if ( !$isImage ) {
314            if ( $exists ) {
315                $class='wikilink1';
316            } else {
317                $class='wikilink2';
318                $link['rel']='nofollow';
319            }
320        } else {
321            $class='media';
322        }
323
324        //keep hash anchor
325        list($id,$hash) = explode('#',$id,2);
326        if(!empty($hash)) $hash = $this->_headerToLink($hash);
327
328        //prepare for formating
329        $link['target'] = $conf['target']['wiki'];
330        $link['style']  = '';
331        $link['pre']    = '';
332        $link['suf']    = '';
333        // highlight link to current page
334        if ($id == $INFO['id']) {
335            $link['pre']    = '<span class="curid">';
336            $link['suf']    = '</span>';
337        }
338        $link['more']   = '';
339        $link['class']  = $class;
340        $link['url']    = wl($id, $params);
341        $link['name']   = $name;
342        $link['title']  = $this->_getLinkTitle(null, $default, $isImage, $id, $linktype);
343        //add search string
344        if($search){
345            ($conf['userewrite']) ? $link['url'].='?' : $link['url'].='&amp;';
346            if(is_array($search)){
347                $search = array_map('rawurlencode',$search);
348                $link['url'] .= 's[]='.join('&amp;s[]=',$search);
349            }else{
350                $link['url'] .= 's='.rawurlencode($search);
351            }
352        }
353
354        //keep hash
355        if($hash) $link['url'].='#'.$hash;
356
357        //output formatted
358        if($returnonly){
359            return $this->_formatLink($link);
360        }else{
361            $this->doc .= $this->_formatLink($link);
362        }
363    }
364
365    function locallink($hash, $name = NULL, $returnonly = false){
366        global $ID;
367        $name  = $this->_getLinkTitle($name, $hash, $isImage);
368        $hash  = $this->_headerToLink($hash);
369        $title = $name;
370        $this->doc .= '<a href="#'.$hash.'" title="'.$title.'" class="wikilink1">';
371        $this->doc .= $name;
372        $this->doc .= '</a>';
373    }
374
375    function acronym($acronym) {
376
377        if ( empty($this->acronymsExchanged) ) {
378            $this->acronymsExchanged = $this->acronyms;
379            $this->acronyms = array();
380
381            foreach( $this->acronymsExchanged as $key => $value ) {
382                $this->acronyms[str_replace('_', ' ', $key)] = $value;
383            }
384        }
385
386        parent::acronym($acronym);
387    }
388
389    function entity($entity) {
390
391        if ( array_key_exists($entity, $this->entities) ) {
392            $entity = $this->entities[$entity];
393        }
394
395        $this->doc .= $this->_xmlEntities($entity);
396    }
397
398    function _xmlEntities($string) {
399
400        // No double encode ...
401        $string = htmlspecialchars($string, ENT_QUOTES, 'UTF-8', false);
402        // $string = parent::_xmlEntities($string);
403        $string = htmlentities($string, 8, 'UTF-8');
404        $string = $this->superentities($string);
405
406        if ( $this->info['scriptmode'] ) {
407            $string = str_replace(    array( "&lt;%", "%&gt;", "&lt;?", "?&gt;"),
408            array( "<%", "%>", "<?", "?>"),
409            $string);
410        }
411
412        return $string;
413    }
414
415    // Unicode-proof htmlentities.
416    // Returns 'normal' chars as chars and weirdos as numeric html entites.
417    function superentities( $str ){
418        // get rid of existing entities else double-escape
419        $str2 = '';
420        $str = html_entity_decode(stripslashes($str),ENT_QUOTES,'UTF-8');
421        $ar = preg_split('/(?<!^)(?!$)(?!\n)/u', $str );  // return array of every multi-byte character
422        foreach ($ar as $c){
423            $o = ord($c);
424            if ( // (strlen($c) > 1) || /* multi-byte [unicode] */
425                ($o > 127) // || /* <- control / latin weirdos -> */
426                // ($o <32 || $o > 126) || /* <- control / latin weirdos -> */
427                // ($o >33 && $o < 40) ||/* quotes + ambersand */
428                // ($o >59 && $o < 63) /* html */
429
430            ) {
431                // convert to numeric entity
432                $c = mb_encode_numericentity($c,array (0x0, 0xffff, 0, 0xffff), 'UTF-8');
433            }
434            $str2 .= $c;
435        }
436        return $str2;
437    }
438
439    /**
440     * Renders internal and external media
441     *
442     * @author Andreas Gohr <andi@splitbrain.org>
443     * @param string $src       media ID
444     * @param string $title     descriptive text
445     * @param string $align     left|center|right
446     * @param int    $width     width of media in pixel
447     * @param int    $height    height of media in pixel
448     * @param string $cache     cache|recache|nocache
449     * @param bool   $render    should the media be embedded inline or just linked
450     * @return string
451     */
452    function _media($src, $title = null, $align = null, $w = null,
453                    $h = null, $cache = null, $render = true) {
454
455        list($ext, $mime) = mimetype($src);
456        if(substr($mime, 0, 5) == 'image') {
457
458            $info = @getimagesize(mediaFN($src)); //get original size
459            $srcset = [];
460
461            if($info !== false) {
462
463	            $origWidth = $info[0];
464	            $origHeight = $info[1];
465
466	            if ( !$w && !$h ) $w = $info[0];
467                if(!$h) $h = round(($w * $info[1]) / $info[0]);
468                if(!$w) $w = round(($h * $info[0]) / $info[1]);
469
470                // There is a two times image
471                if ( 2*2/3*$w <= $origWidth ) { // If the image is at least 1.6 times as large ...
472	                $srcset[] = ml($src, array('w' => 2*$w, 'h' => 2*$h, 'cache' => $cache, 'rev'=>$this->_getLastMediaRevisionAt($src))) . ' 2x';
473                } else {
474
475	                // Check for alternate image
476	                $ext = strrpos($src, '.');
477
478                    foreach ( array( '@2x.', '-2x.', '_2x.') as $extension ) {
479    	                $additionalSrc = substr( $src, 0, $ext) . $extension . substr($src, $ext+1);
480    	                $additionalInfo = @getimagesize(mediaFN($additionalSrc)); //get original size
481    	                if ( $additionalInfo !== false ) {
482                            // Image exists
483                            $srcset[] = ml($additionalSrc, array('w' => 2*$w, 'h' => 2*$h, 'cache' => $cache, 'rev'=>$this->_getLastMediaRevisionAt($srcSetURL))) . ' 2x';
484                            break;
485    	                }
486                    }
487                }
488
489				$ret = parent::_media($src, $title, $align, $w, $h, $cache, $render);
490                if ( count($srcset) > 0 ) {
491                    return str_replace("/>", ' srcset="' . implode(',', $srcset) . '" />', $ret );
492                } else {
493                    return $ret;
494                }
495            }
496        }
497
498        return parent::_media($src, $title, $align, $w, $h, $cache, $render);
499    }
500}
501
502//Setup VIM: ex: et ts=4 enc=utf-8 :
503