xref: /plugin/nodetailsxhtml/renderer.php (revision 9d34047f104972917969f6da92b0c7614e33a857) 
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 || (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    function header($text, $level, $pos, $returnonly = false) {
115        global $conf;
116        global $ID;
117        global $INFO;
118
119        if($text) {
120
121            // Check Text for hint about a CSS style class
122            $class = "";
123            if ( preg_match("/^class:(.*?)>(.*?)$/", $text, $matches) ) {
124                $class = ' ' . $this->_xmlEntities($matches[1]);
125                $text = $matches[2];
126            }
127
128            /* There should be no class for "sectioneditX" if there is no edit perm */
129            $maxLevel = $conf['maxseclevel'];
130            if ( $INFO['perm'] <= AUTH_READ )
131            {
132                $conf['maxseclevel'] = 0;
133            }
134
135            $headingNumber = '';
136            $useNumbered = p_get_metadata($ID, 'usenumberedheading', true); // 2011-02-07 This should be save to use
137            if ( $this->getConf('usenumberedheading') || !empty($useNumbered) || !empty($INFO['meta']['usenumberedheading']) || isset($_REQUEST['usenumberedheading'])) {
138
139                // increment the number of the heading
140                $this->headingCount[$level]++;
141
142                // build the actual number
143                for ($i=1;$i<=5;$i++) {
144
145                    // reset the number of the subheadings
146                    if ($i>$level) {
147                        $this->headingCount[$i] = 0;
148                    }
149
150                    // build the number of the heading
151                    $headingNumber .= $this->headingCount[$i] . '.';
152                }
153
154                $headingNumber = preg_replace("/(\.0)+\.?$/", '', $headingNumber) . ' ';
155            }
156
157            $doc = $this->doc;
158            $this->doc = "";
159
160            parent::header($headingNumber . $text, $level, $pos);
161
162            if ( $this->getConf('useHeadAnchorInsteadOfHeaderID') ) {
163                $matches = [];
164                preg_match("/id=\"(.*?)\"/", $this->doc, $matches);
165                if ( count($matches) > 1 ) {
166                    $this->doc = preg_replace("/id=\".*?\"/", '', $this->doc);
167                    $this->doc = DOKU_LF.'<a id="'. $matches[1] .'" class="head-anchor" style="visibility:hidden"></a>'.DOKU_LF . $this->doc;
168                }
169            }
170
171            if ( $this->getConf('useSectionArticle') ) {
172                $this->doc = $doc . preg_replace("/(<h([1-9]))/", "<".($this->sectionLevel<1?'section':'article')." class=\"level\\2{$class}\">\\1", $this->doc);
173            } else {
174                $this->doc = $doc . $this->doc;
175            }
176
177            $conf['maxseclevel'] = $maxLevel;
178
179        } else if ( $INFO['perm'] > AUTH_READ ) {
180
181            if ( $hasSeenHeader ) $this->finishSectionEdit($pos);
182
183            // write the header
184            $name = $this->startSectionEdit($pos, array( 'target' => 'section_empty', 'name' => rand() . $level));
185            if ( $this->getConf('useSectionArticle') ) {
186                $this->doc .= '<'.($this->sectionLevel<1?'section':'article').' class="'.$name.'">';
187            }
188
189            $this->doc .= DOKU_LF.'<a name="'. $name .'" class="' . $name . '" ></a>'.DOKU_LF;
190        }
191
192        $hasSeenHeader = true;
193    }
194
195    public function finishSectionEdit($end = null, $hid = null) {
196        global $INFO;
197        if ( $INFO['perm'] > AUTH_READ )
198        {
199            return parent::finishSectionEdit($end, $hid);
200        }
201    }
202
203    public function startSectionEdit($start, $data) {
204        global $INFO;
205        if ( $INFO['perm'] > AUTH_READ )
206        {
207            return parent::startSectionEdit($start, $data);
208        }
209
210        return "";
211    }
212
213    function section_close() {
214        $this->sectionLevel--;
215        $this->doc .= DOKU_LF.'</div>'.DOKU_LF;
216        if ( $this->getConf('useSectionArticle') ) {
217            $this->doc .= '</'.($this->sectionLevel<1?'section':'article').'>'.DOKU_LF;
218        }
219    }
220
221    function section_open($level) {
222        $this->sectionLevel++;
223        return parent::section_open($level);
224    }
225
226    function internalmedia ($src, $title=null, $align=null, $width=null,
227                            $height=null, $cache=null, $linking=null, $return=NULL) {
228        global $ID;
229        list($src,$hash) = explode('#',$src,2);
230
231        if ( class_exists('dokuwiki\File\MediaResolver') ) {
232            $src = (new dokuwiki\File\MediaResolver($ID))->resolveId($src);
233        } else {
234            resolve_mediaid(getNS($ID),$src, $exists);
235        }
236
237        $noLink = false;
238        $render = ($linking == 'linkonly') ? false : true;
239        $link = $this->_getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render);
240
241        list($ext,$mime,$dl) = mimetype($src);
242        if(substr($mime,0,5) == 'image' && $render){
243            $link['url'] = ml($src,array('id'=>$ID,'cache'=>$cache),($linking=='direct'));
244            if ( substr($mime,0,5) == 'image' && $linking='details' ) { $noLink = true;}
245        }elseif($mime == 'application/x-shockwave-flash' && $render){
246            // don't link flash movies
247            $noLink = true;
248        }else{
249            // add file icons
250            $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
251            $link['class'] .= ' mediafile mf_'.$class;
252            $link['url'] = ml($src,array('id'=>$ID,'cache'=>$cache),true);
253        }
254
255        if($hash) $link['url'] .= '#'.$hash;
256
257        //markup non existing files
258        if (!$exists)
259        $link['class'] .= ' wikilink2';
260
261        //output formatted
262        if ($linking == 'nolink' || $noLink) $this->doc .= $link['name'];
263        else $this->doc .= $this->_formatLink($link);
264    }
265
266    /**
267     * Render an internal Wiki Link
268     *
269     * $search,$returnonly & $linktype are not for the renderer but are used
270     * elsewhere - no need to implement them in other renderers
271     *
272     * @author Andreas Gohr <andi@splitbrain.org>
273     */
274    function internallink($id, $name = null, $search=null,$returnonly=false,$linktype='content') {
275        global $conf;
276        global $ID;
277        global $INFO;
278
279        $params = '';
280        $parts = explode('?', $id, 2);
281        if (count($parts) === 2) {
282            $id = $parts[0];
283            $params = $parts[1];
284        }
285
286        // For empty $id we need to know the current $ID
287        // We need this check because _simpleTitle needs
288        // correct $id and resolve_pageid() use cleanID($id)
289        // (some things could be lost)
290        if ($id === '') {
291            $id = $ID;
292        }
293
294        // default name is based on $id as given
295        $default = $this->_simpleTitle($id);
296
297        // now first resolve and clean up the $id
298        if ( class_exists('dokuwiki\File\PageResolver') ) {
299            $id = (new dokuwiki\File\PageResolver($ID))->resolveId($id);
300        } else {
301            resolve_pageid(getNS($ID),$id,$exists);
302        }
303
304        $name = $this->_getLinkTitle($name, $default, $isImage, $id, $linktype);
305        if ( !$isImage ) {
306            if ( $exists ) {
307                $class='wikilink1';
308            } else {
309                $class='wikilink2';
310                $link['rel']='nofollow';
311            }
312        } else {
313            $class='media';
314        }
315
316        //keep hash anchor
317        list($id,$hash) = explode('#',$id,2);
318        if(!empty($hash)) $hash = $this->_headerToLink($hash);
319
320        //prepare for formating
321        $link['target'] = $conf['target']['wiki'];
322        $link['style']  = '';
323        $link['pre']    = '';
324        $link['suf']    = '';
325        // highlight link to current page
326        if ($id == $INFO['id']) {
327            $link['pre']    = '<span class="curid">';
328            $link['suf']    = '</span>';
329        }
330        $link['more']   = '';
331        $link['class']  = $class;
332        $link['url']    = wl($id, $params);
333        $link['name']   = $name;
334        $link['title']  = $this->_getLinkTitle(null, $default, $isImage, $id, $linktype);
335        //add search string
336        if($search){
337            ($conf['userewrite']) ? $link['url'].='?' : $link['url'].='&amp;';
338            if(is_array($search)){
339                $search = array_map('rawurlencode',$search);
340                $link['url'] .= 's[]='.join('&amp;s[]=',$search);
341            }else{
342                $link['url'] .= 's='.rawurlencode($search);
343            }
344        }
345
346        //keep hash
347        if($hash) $link['url'].='#'.$hash;
348
349        //output formatted
350        if($returnonly){
351            return $this->_formatLink($link);
352        }else{
353            $this->doc .= $this->_formatLink($link);
354        }
355    }
356
357    function locallink($hash, $name = NULL, $returnonly = false){
358        global $ID;
359        $name  = $this->_getLinkTitle($name, $hash, $isImage);
360        $hash  = $this->_headerToLink($hash);
361        $title = $name;
362        $this->doc .= '<a href="#'.$hash.'" title="'.$title.'" class="wikilink1">';
363        $this->doc .= $name;
364        $this->doc .= '</a>';
365    }
366
367    function acronym($acronym) {
368
369        if ( empty($this->acronymsExchanged) ) {
370            $this->acronymsExchanged = $this->acronyms;
371            $this->acronyms = array();
372
373            foreach( $this->acronymsExchanged as $key => $value ) {
374                $this->acronyms[str_replace('_', ' ', $key)] = $value;
375            }
376        }
377
378        parent::acronym($acronym);
379    }
380
381    function entity($entity) {
382
383        if ( array_key_exists($entity, $this->entities) ) {
384            $entity = $this->entities[$entity];
385        }
386
387        $this->doc .= $this->_xmlEntities($entity);
388    }
389
390    function _xmlEntities($string) {
391
392        // No double encode ...
393        $string = htmlspecialchars($string, ENT_QUOTES, 'UTF-8', false);
394        // $string = parent::_xmlEntities($string);
395        $string = htmlentities($string, 8, 'UTF-8');
396        $string = $this->superentities($string);
397
398        if ( $this->info['scriptmode'] ) {
399            $string = str_replace(    array( "&lt;%", "%&gt;", "&lt;?", "?&gt;"),
400            array( "<%", "%>", "<?", "?>"),
401            $string);
402        }
403
404        return $string;
405    }
406
407    // Unicode-proof htmlentities.
408    // Returns 'normal' chars as chars and weirdos as numeric html entites.
409    function superentities( $str ){
410        // get rid of existing entities else double-escape
411        $str2 = '';
412        $str = html_entity_decode(stripslashes($str),ENT_QUOTES,'UTF-8');
413        $ar = preg_split('/(?<!^)(?!$)(?!\n)/u', $str );  // return array of every multi-byte character
414        foreach ($ar as $c){
415            $o = ord($c);
416            if ( // (strlen($c) > 1) || /* multi-byte [unicode] */
417                ($o > 127) // || /* <- control / latin weirdos -> */
418                // ($o <32 || $o > 126) || /* <- control / latin weirdos -> */
419                // ($o >33 && $o < 40) ||/* quotes + ambersand */
420                // ($o >59 && $o < 63) /* html */
421
422            ) {
423                // convert to numeric entity
424                $c = mb_encode_numericentity($c,array (0x0, 0xffff, 0, 0xffff), 'UTF-8');
425            }
426            $str2 .= $c;
427        }
428        return $str2;
429    }
430
431    /**
432     * Renders internal and external media
433     *
434     * @author Andreas Gohr <andi@splitbrain.org>
435     * @param string $src       media ID
436     * @param string $title     descriptive text
437     * @param string $align     left|center|right
438     * @param int    $width     width of media in pixel
439     * @param int    $height    height of media in pixel
440     * @param string $cache     cache|recache|nocache
441     * @param bool   $render    should the media be embedded inline or just linked
442     * @return string
443     */
444    function _media($src, $title = null, $align = null, $w = null,
445                    $h = null, $cache = null, $render = true) {
446
447        list($ext, $mime) = mimetype($src);
448        if(substr($mime, 0, 5) == 'image') {
449
450            $info = @getimagesize(mediaFN($src)); //get original size
451            $srcset = [];
452
453            if($info !== false) {
454
455	            $origWidth = $info[0];
456	            $origHeight = $info[1];
457
458	            if ( !$w && !$h ) $w = $info[0];
459                if(!$h) $h = round(($w * $info[1]) / $info[0]);
460                if(!$w) $w = round(($h * $info[0]) / $info[1]);
461
462                // There is a two times image
463                if ( 2*2/3*$w <= $origWidth ) { // If the image is at least 1.6 times as large ...
464	                $srcset[] = ml($src, array('w' => 2*$w, 'h' => 2*$h, 'cache' => $cache, 'rev'=>$this->_getLastMediaRevisionAt($src))) . ' 2x';
465                } else {
466
467	                // Check for alternate image
468	                $ext = strrpos($src, '.');
469
470                    foreach ( array( '@2x.', '-2x.', '_2x.') as $extension ) {
471    	                $additionalSrc = substr( $src, 0, $ext) . $extension . substr($src, $ext+1);
472    	                $additionalInfo = @getimagesize(mediaFN($additionalSrc)); //get original size
473    	                if ( $additionalInfo !== false ) {
474                            // Image exists
475                            $srcset[] = ml($additionalSrc, array('w' => 2*$w, 'h' => 2*$h, 'cache' => $cache, 'rev'=>$this->_getLastMediaRevisionAt($srcSetURL))) . ' 2x';
476                            break;
477    	                }
478                    }
479                }
480
481				$ret = parent::_media($src, $title, $align, $w, $h, $cache, $render);
482                if ( count($srcset) > 0 ) {
483                    return str_replace("/>", ' srcset="' . implode(',', $srcset) . '" />', $ret );
484                } else {
485                    return $ret;
486                }
487            }
488        }
489
490        return parent::_media($src, $title, $align, $w, $h, $cache, $render);
491    }
492}
493
494//Setup VIM: ex: et ts=4 enc=utf-8 :
495