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    /**
235     * Render an internal Wiki Link
236     *
237     * $search,$returnonly & $linktype are not for the renderer but are used
238     * elsewhere - no need to implement them in other renderers
239     *
240     * @author Andreas Gohr <andi@splitbrain.org>
241     */
242    function internallink($id, $name = null, $search=null,$returnonly=false,$linktype='content') {
243        global $conf;
244        global $ID;
245        global $INFO;
246
247        $params = '';
248        $parts = explode('?', $id, 2);
249        if (count($parts) === 2) {
250            $id = $parts[0];
251            $params = $parts[1];
252        }
253
254        // For empty $id we need to know the current $ID
255        // We need this check because _simpleTitle needs
256        // correct $id and resolve_pageid() use cleanID($id)
257        // (some things could be lost)
258        if ($id === '') {
259            $id = $ID;
260        }
261
262        // default name is based on $id as given
263        $default = $this->_simpleTitle($id);
264
265        // now first resolve and clean up the $id
266        if ( class_exists('dokuwiki\File\PageResolver') ) {
267            $id = (new dokuwiki\File\PageResolver($ID))->resolveId($id);
268            $exists = page_exists($id);
269        } else {
270            resolve_pageid(getNS($ID),$id,$exists);
271        }
272
273        $name = $this->_getLinkTitle($name, $default, $isImage, $id, $linktype);
274        if ( !$isImage ) {
275            if ( $exists ) {
276                $class='wikilink1';
277            } else {
278                $class='wikilink2';
279                $link['rel']='nofollow';
280            }
281        } else {
282            $class='media';
283        }
284
285        //keep hash anchor
286        list($id,$hash) = explode('#',$id,2);
287        if(!empty($hash)) $hash = $this->_headerToLink($hash);
288
289        //prepare for formating
290        $link['target'] = $conf['target']['wiki'];
291        $link['style']  = '';
292        $link['pre']    = '';
293        $link['suf']    = '';
294        // highlight link to current page
295        if ($id == $INFO['id']) {
296            $link['pre']    = '<span class="curid">';
297            $link['suf']    = '</span>';
298        }
299        $link['more']   = '';
300        $link['class']  = $class;
301        $link['url']    = wl($id, $params);
302        $link['name']   = $name;
303        $link['title']  = $this->_getLinkTitle(null, $default, $isImage, $id, $linktype);
304        //add search string
305        if($search){
306            ($conf['userewrite']) ? $link['url'].='?' : $link['url'].='&amp;';
307            if(is_array($search)){
308                $search = array_map('rawurlencode',$search);
309                $link['url'] .= 's[]='.join('&amp;s[]=',$search);
310            }else{
311                $link['url'] .= 's='.rawurlencode($search);
312            }
313        }
314
315        //keep hash
316        if($hash) $link['url'].='#'.$hash;
317
318        //output formatted
319        if($returnonly){
320            return $this->_formatLink($link);
321        }else{
322            $this->doc .= $this->_formatLink($link);
323        }
324    }
325
326    function locallink($hash, $name = NULL, $returnonly = false){
327        global $ID;
328        $name  = $this->_getLinkTitle($name, $hash, $isImage);
329        $hash  = $this->_headerToLink($hash);
330        $title = $name;
331        $this->doc .= '<a href="#'.$hash.'" title="'.$title.'" class="wikilink1">';
332        $this->doc .= $name;
333        $this->doc .= '</a>';
334    }
335
336    function acronym($acronym) {
337
338        if ( empty($this->acronymsExchanged) ) {
339            $this->acronymsExchanged = $this->acronyms;
340            $this->acronyms = array();
341
342            foreach( $this->acronymsExchanged as $key => $value ) {
343                $this->acronyms[str_replace('_', ' ', $key)] = $value;
344            }
345        }
346
347        parent::acronym($acronym);
348    }
349
350    function entity($entity) {
351
352        if ( array_key_exists($entity, $this->entities) ) {
353            $entity = $this->entities[$entity];
354        }
355
356        $this->doc .= $this->_xmlEntities($entity);
357    }
358
359    function _xmlEntities($string) {
360
361        // No double encode ...
362        $string = htmlspecialchars($string, ENT_QUOTES, 'UTF-8', false);
363        // $string = parent::_xmlEntities($string);
364        $string = htmlentities($string, 8, 'UTF-8');
365        $string = $this->superentities($string);
366
367        if ( $this->info['scriptmode'] ) {
368            $string = str_replace(    array( "&lt;%", "%&gt;", "&lt;?", "?&gt;"),
369            array( "<%", "%>", "<?", "?>"),
370            $string);
371        }
372
373        return $string;
374    }
375
376    // Unicode-proof htmlentities.
377    // Returns 'normal' chars as chars and weirdos as numeric html entites.
378    function superentities( $str ){
379        // get rid of existing entities else double-escape
380        $str2 = '';
381        $str = html_entity_decode(stripslashes($str),ENT_QUOTES,'UTF-8');
382        $ar = preg_split('/(?<!^)(?!$)(?!\n)/u', $str );  // return array of every multi-byte character
383        foreach ($ar as $c){
384            $o = ord($c);
385            if ( // (strlen($c) > 1) || /* multi-byte [unicode] */
386                ($o > 127) // || /* <- control / latin weirdos -> */
387                // ($o <32 || $o > 126) || /* <- control / latin weirdos -> */
388                // ($o >33 && $o < 40) ||/* quotes + ambersand */
389                // ($o >59 && $o < 63) /* html */
390
391            ) {
392                // convert to numeric entity
393                $c = mb_encode_numericentity($c,array (0x0, 0xffff, 0, 0xffff), 'UTF-8');
394            }
395            $str2 .= $c;
396        }
397        return $str2;
398    }
399
400    /**
401     * Renders internal and external media
402     *
403     * @author Andreas Gohr <andi@splitbrain.org>
404     * @param string $src       media ID
405     * @param string $title     descriptive text
406     * @param string $align     left|center|right
407     * @param int    $width     width of media in pixel
408     * @param int    $height    height of media in pixel
409     * @param string $cache     cache|recache|nocache
410     * @param bool   $render    should the media be embedded inline or just linked
411     * @return string
412     */
413    function _media($src, $title = null, $align = null, $w = null,
414                    $h = null, $cache = null, $render = true) {
415
416        list($ext, $mime) = mimetype($src);
417        if(substr($mime, 0, 5) == 'image') {
418
419            $info = @getimagesize(mediaFN($src)); //get original size
420            $srcset = [];
421
422            if($info !== false) {
423
424                $origWidth = $info[0];
425                $origHeight = $info[1];
426
427                if ( !$w && !$h ) $w = $info[0];
428                if(!$h) $h = round(($w * $info[1]) / $info[0]);
429                if(!$w) $w = round(($h * $info[0]) / $info[1]);
430
431                // There is a two times image
432                if ( 2*2/3*$w <= $origWidth ) { // If the image is at least 1.6 times as large ...
433                    $srcset[] = ml($src, array('w' => 2*$w, 'h' => 2*$h, 'cache' => $cache, 'rev'=>$this->_getLastMediaRevisionAt($src))) . ' 2x';
434                } else {
435
436                    // Check for alternate image
437                    $ext = strrpos($src, '.');
438
439                    foreach ( array( '@2x.', '-2x.', '_2x.') as $extension ) {
440                        $additionalSrc = substr( $src, 0, $ext) . $extension . substr($src, $ext+1);
441                        $additionalInfo = @getimagesize(mediaFN($additionalSrc)); //get original size
442                        if ( $additionalInfo !== false ) {
443                            // Image exists
444                            $srcset[] = ml($additionalSrc, array('w' => 2*$w, 'h' => 2*$h, 'cache' => $cache, 'rev'=>$this->_getLastMediaRevisionAt($srcSetURL))) . ' 2x';
445                            break;
446                        }
447                    }
448                }
449
450                $ret = parent::_media($src, $title, $align, $w, $h, $cache, $render);
451                if ( count($srcset) > 0 ) {
452                    return str_replace("/>", ' srcset="' . implode(',', $srcset) . '" />', $ret );
453                } else {
454                    return $ret;
455                }
456            }
457        }
458
459        return parent::_media($src, $title, $align, $w, $h, $cache, $render);
460    }
461
462    /**
463     * helperfunction to return a basic link to a media
464     *
465     * used in internalmedia() and externalmedia()
466     *
467     * @author   Pierre Spring <pierre.spring@liip.ch>
468     * @param string $src       media ID
469     * @param string $title     descriptive text
470     * @param string $align     left|center|right
471     * @param int    $width     width of media in pixel
472     * @param int    $height    height of media in pixel
473     * @param string $cache     cache|recache|nocache
474     * @param bool   $render    should the media be embedded inline or just linked
475     * @return array associative array with link config
476     */
477    public function _getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render) {
478        $link = parent::_getMediaLinkConf( $src, $title, $align, $width, $height, $cache, $render );
479        // set a marker for media links, whcih we do not want to have.
480        $link['nodetails'] = true;
481        return $link;
482    }
483
484    /**
485     * Build a link
486     *
487     * Assembles all parts defined in $link returns HTML for the link
488     *
489     * @param array $link attributes of a link
490     * @return string
491     *
492     * @author Andreas Gohr <andi@splitbrain.org>
493     */
494    public function _formatLink($link) {
495        if ( $link['nodetails'] ) {
496            return $link['name'];
497        }
498
499        return parent::_formatLink($link);
500    }
501}
502
503//Setup VIM: ex: et ts=4 enc=utf-8 :
504