xref: /plugin/popupviewer/syntax/viewer.php (revision 4558ab00ed60143e6ec3fb2160367978d4028a81) 
1<?php
2/**
3 * popoutviewer Plugin
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     i-net software <tools@inetsoftware.de>
7 * @author     Gerry Weissbach <gweissbach@inetsoftware.de>
8 */
9
10// must be run within Dokuwiki
11if(!defined('DOKU_INC')) die();
12if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
13
14require_once(DOKU_PLUGIN.'syntax.php');
15
16class syntax_plugin_popupviewer_viewer extends DokuWiki_Syntax_Plugin {
17
18    private $headers = array();
19
20    function getInfo(){
21        return array_merge(confToHash(dirname(__FILE__).'/plugin.info.txt'), array(
22                'name' => 'PopUpViewer Linking Component',
23                'desc' => 'Takes a Page to be diplayed in an overlay pop-out'
24                ));
25    }
26
27    function getType() { return 'substition'; }
28    function getPType() { return 'normal'; }
29    function getSort() { return 98; }
30
31    function connectTo($mode) {
32
33        $this->Lexer->addSpecialPattern('{{popup>[^}]+}}}}', $mode, 'plugin_popupviewer_viewer');
34        $this->Lexer->addSpecialPattern('{{popup>[^}]+}}', $mode, 'plugin_popupviewer_viewer');
35        $this->Lexer->addSpecialPattern('{{popupclose>[^}]+}}}}', $mode, 'plugin_popupviewer_viewer');
36        $this->Lexer->addSpecialPattern('{{popupclose>[^}]+}}', $mode, 'plugin_popupviewer_viewer');
37    }
38
39    function handle($match, $state, $pos, Doku_Handler $handler) {
40
41        $close = strstr( $match, "{{popupclose>") !== false;
42
43        $orig = substr($match, $close ? 13 : 8, -2);
44        list($id, $name) = explode('|', $orig, 2); // find ID/Params + Name Extension
45        list($name, $title) = explode('%', $name, 2); // find Name and Title
46        list($id, $param) = explode('?', $id, 2); // find ID + Params
47
48        $params = explode('&', strtolower($param));
49        $w = $h = $keepOpen = null;
50        foreach( $params as $p ) {
51            if ( $p === 'keepOpen' ) {
52                $keepOpen = true;
53            } else {
54                list($w, $h) = explode('x', $p, 2); // find Size
55            }
56        }
57
58        return array(trim($id), $name, $title, $w, $h, $orig, $close, null, $keepOpen);
59    }
60
61    function render($mode, Doku_Renderer $renderer, $data) {
62        global $ID, $conf, $JSINFO;
63
64        if ( $mode != 'xhtml' && $mode != 'metadata' ) { return true; }
65
66        list($id, $name, $title, $w, $h, $orig, $close, $isImageMap, $keepOpen) = $data;
67
68        $exists = false;
69        if ( !empty($id) ) {
70            $origID = $id;
71            resolve_mediaid(getNS($ID),$id,$exists);
72            if ( !$exists ) {
73                $id = $origID;
74            }
75        }
76
77        if($mode === 'metadata') {
78            $renderer->internalmedia($id,$title);
79            return;
80        }
81
82        $scID = sectionID(noNs($id), $this->headers);
83        $more = 'id="' . $scID . '"';
84        $script = '';
85
86        if ( $exists ) {
87            // is Media
88            if ( function_exists('Doku_Handler_Parse_Media') ) {
89                $p1 = Doku_Handler_Parse_Media($orig);
90                // TODO, this is not right in Hogfather!
91            }
92
93            if ( empty($name) ) {
94
95                if ( !method_exists($renderer, '_media') ) {
96                    $p = array();
97                    $p['alt'] = $id;
98                    $p['class'] = 'popupimage';
99                    $p['title'] = $title;
100                    $p['id'] = 'popupimage_' . $scID;
101                    if ($p1['width']) $p['width'] = $p1['width'];
102                    if ($p1['height']) $p['height'] = $p1['height'];
103                    if ($p1['title'] && !$p['title']) { $p['title'] = $p1['title']; $p['alt'] = $p1['title']; }
104                    if ($p1['align']) $p['class'] .= ' media' . $p1['align'];
105
106                    $p2 = buildAttributes($p);
107                    $name = '<img src="' . ml($id, array( 'w' => $p['width'], 'h' => $p['height'] ) ) . '" '.$p2.'/>';
108                } else {
109                    $name = $renderer->_media($id, ($title ? $title : ($p1['title'] ? $p1['title'] : $id) ), ' popupimage' . ($p1['align'] ? ' media' . $p1['align'] : '' ), $p1['width'], $p1['height']);
110                }
111            } else {
112                $name = trim(p_render($mode, p_get_instructions(trim($name)), $info));
113                $name = trim(preg_replace("%^(\s|\r|\n)*?<a.+?>(.*)?</a>(\s|\r|\n)*?$%is", "$2", preg_replace("%^(\s|\r|\n)*?<p.*?>(.*)?</p>(\s|\r|\n)*?$%is", "$2", $name)));
114
115                $name = preg_replace("%^(<img[^>]*?)>%", "$1 id=\"popupimage_$scID\">", $name);
116            }
117
118            $more = $this->_getOnClickHandler($close, array('isImage' => true, 'id' => $id));
119            $id = ml($id);
120
121        } else {
122            // is Page
123            resolve_pageid(getNS($ID),$id,$exists);
124            if ( empty($name) ) {
125                $name = htmlspecialchars(noNS($id),ENT_QUOTES,'UTF-8');
126                if ($conf['useheading'] && $id ) {
127                    $heading = p_get_first_heading($id,true);
128                    if ($heading) {
129                        $name = htmlspecialchars($heading,ENT_QUOTES,'UTF-8');
130                    }
131                }
132            } else {
133                $name = trim(p_render($mode, p_get_instructions(trim($name)), $info));
134            }
135
136            $data = array(
137                'width' => $w,
138                'height' => $h,
139                'id' => $id
140            );
141
142            if ( $keepOpen ) {
143                $data['keepOpen'] = true;
144            }
145
146            // Add ID for AJAX - this.href for offline versions
147            $more = $this->_getOnClickHandler($close, $data);
148            $id=wl($id);
149        }
150
151        $renderer->doc .= $this->_renderFinalPopupImage($id, $exists, $more, $name, $isImageMap, $script);
152
153        return true;
154    }
155
156    function _renderFinalPopupImage($id, $exists, $more, $name, $isImageMap, $script, $class='') {
157
158        $more .= ' class="wikilink' . ($exists?1:2) . (!empty($class) ? ' ' . $class : '' ). '"';
159        $name = trim(preg_replace("%^(\s|\r|\n)*?<a.+?>(.*)?</a>(\s|\r|\n)*?$%is", "$2", preg_replace("%^(\s|\r|\n)*?<p.*?>(.*)?</p>(\s|\r|\n)*?$%is", "$2", $name)));
160
161        if ( !is_array($isImageMap) ) {
162            return '<a href="'.$id.'" ' . trim($more) . ' >' . $name . '</a>' . $script;
163        } else {
164            $return = '<area href="'.$id.'" ' . trim($more) . '';
165            $return .= ' title="'.$name.'" alt="'.$name.'"';
166            $return .= ' shape="'.$isImageMap['shape'].'" coords="'.$isImageMap['coords'].'" />' . $script;
167
168            return $return;
169        }
170    }
171
172    function _getOnClickHandler($close, $data=array()) {
173        if ( !$close ) {
174            return ' data-popupviewer="' . htmlentities(json_encode(array_filter($data))) . '"';
175        } else {
176            return ' data-popupviewerclose';
177        }
178    }
179
180    /**
181     * Implements API from imagemap
182     */
183    function convertToImageMapArea($imagemap, $data, $pos) {
184
185        list($id, $name, $title, $w, $h, $orig, $close) = $data;
186
187        if ( !preg_match('/^(.*)@([^@]+)$/u', array_pop(explode('|', $name)), $match)) {
188            return;
189        }
190
191        $coords = explode(',',$match[2]);
192        if (count($coords) == 3) {
193            $shape = 'circle';
194        } elseif (count($coords) == 4) {
195            $shape = 'rect';
196        } elseif (count($coords) >= 6) {
197            $shape = 'poly';
198        } else {
199            return;
200        }
201
202        $coords = array_map('trim', $coords);
203        $name = trim($match[1]);
204        $imagemap->CallWriter->writeCall(array('plugin', array('popupviewer_viewer', array($id, $name, $title, $w, $h, $orig, $close, array('shape' => $shape, 'coords' => join(',',$coords))), DOKU_LEXER_MATCHED), $pos));
205    }
206}
207// vim:ts=4:sw=4:et:enc=utf-8:
208