This repository has been archived by the owner on May 16, 2020. It is now read-only.
forked from grantemsley/dokuwiki-plugin-patchpanel
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsyntax.php
319 lines (270 loc) · 13.4 KB
/
syntax.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<?php
/*
* Patch Panel Plugin: display a patch panel from a plaintext source
*
* Each patch panel is enclosed in <patchpanel>...</patchpanel> tags. The tag can have the
* following parameters (all optional):
* name=<name> The name of the patch panel (default: 'Patch Panel')
* ports=<number> The total number of ports. (default: 48)
* rows=<number> Number of rows. (default: 2)
* groups=<number> Number of ports in a group (default: 6)
* rotate=[0,1] If true, rotate the patch panel 90deg clockwise.
* switch=[0,1] If true, port numbering changes to match switches.
* Between these tags is a series of lines, each describing a port:
*
* <port> <label> [#color] [comment]
*
* The fields:
* - <port>: The port number on the patch panel, starting from the top left.
* - <label>: The label for the port. Must be quoted if it contains spaces.
* - [#color]: Optional. Specify an #RRGGBB HTML color code.
* - [comment]: Optional. All remaining text is treated as a comment.
*
* You can also include comment lines starting with a pound sign #.
*
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author Grant Emsley <[email protected]>
* @version 2014.05.11.1
*
* Based on the rack plugin (https://www.dokuwiki.org/plugin:rack) by Tyler Bletsch <[email protected]>
*
*/
if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
require_once(DOKU_PLUGIN.'syntax.php');
/*
* All DokuWiki plugins to extend the parser/rendering mechanism
* need to inherit from this class
*/
class syntax_plugin_patchpanel extends DokuWiki_Syntax_Plugin {
function getType(){
return 'substition';
}
function getSort(){
return 155;
}
function getPType(){
return 'block';
}
function connectTo($mode) {
$this->Lexer->addSpecialPattern("<patchpanel[^>]*>.*?(?:<\/patchpanel>)",$mode,'plugin_patchpanel');
}
/*
* Handle the matches
*/
function handle($match, $state, $pos, &$handler){
// remove "</patchpanel>" from the match
$match = substr($match,0,-13);
//default options
$opt = array(
'name' => 'Patch Panel',
'ports' => 48,
'rows' => '2',
'groups' => '6',
'rotate' => 0,
'switch' => 0
);
list($optstr,$opt['content']) = explode('>',$match,2);
unset($match);
// parse options
// http://stackoverflow.com/questions/2202435/php-explode-the-string-but-treat-words-in-quotes-as-a-single-word
preg_match_all('/\w*?="(?:\\.|[^\\"])*"|\S+/', $optstr, $matches);
$optsin = $matches[0];
foreach($optsin as $o){
$o = trim($o);
if (preg_match("/^name=(.+)/",$o,$matches)) {
// Remove beginning and ending quotes, then html encode
$opt['name'] = htmlspecialchars(trim($matches[1], '"\''), ENT_QUOTES);
} elseif (preg_match("/^ports=(\d+)/",$o,$matches)) {
$opt['ports'] = $matches[1];
} elseif (preg_match("/^rows=(\d+)/",$o,$matches)) {
$opt['rows'] = $matches[1];
} elseif (preg_match("/^groups=(\d+)/",$o,$matches)) {
$opt['groups'] = $matches[1];
} elseif (preg_match("/^rotate=(\d+)/",$o, $matches)) {
$opt['rotate'] = $matches[1];
} elseif (preg_match("/^switch=(\d+)/",$o, $matches)) {
$opt['switch'] = $matches[1];
}
}
return $opt;
}
// This function creates an SVG image of an ethernet port and positions it on the patch panel.
function ethernet_svg($row, $position, $port, $item, $opt) {
// Make row and position start at 0.
$row--;
$position--;
// Calculate things we need to create the image
// If there is no data for the port, set it as unknown
if($item['label'] == '' && $item['comment'] == '') {
$item['label'] = '?';
$item['comment'] = 'This port has not been documented.';
$item['color'] = '#333';
}
$fullcaption = "<div class=\'title\'>" . $opt['name'] . " Port $port</div>";
$fullcaption .= "<div class=\'content\'>";
$fullcaption .= "<table><tr><th>Label:</th><td>" . $item['label'] . "</td></tr>";
$fullcaption .= "<tr><th>Comment:</th><td>" . $item['comment'] . "</td></tr><table></div>";
$group = floor($position/$opt['groups']);
# Ethernet port image, with #STRINGS# to replace later
$image = <<<EOF
<svg xmlns="http://www.w3.org/2000/svg" y="#REPLACEY#" x="#REPLACEX#" width="40" height="134" viewbox="0 0 200 270" preserveAspectRatio="xMinYMin meet" class="ethernet">
<metadata id="metadata6">image/svg+xml</metadata>
<g onmousemove="patchpanel_show_tooltip(evt, '#REPLACECAPTION#')" onmouseout="patchpanel_hide_tooltip()">
<rect width="200" height="100" x="-1" y="0" stroke-width="5" stroke="#000000" fill="#ffffff" ry="21" rx="21"/>
<text font-weight="bold" transform="matrix(2.23270613481651,0,0,2.71289621263044,-0.5055757463585078,-84.46232908315777) " xml:space="preserve" text-anchor="middle" font-family="sans-serif" font-size="26" stroke-width="0" stroke="#000000" fill="#000" id="svg_4" y="57.102295" x="42.59375">#REPLACELABEL#</text>
<rect id="rect2220" width="200" height="170" x="-1" y="100.216216" stroke-miterlimit="4" stroke-width="0" fill="#REPLACECOLOR#"/>
<rect y="130.162162" x="24" height="90" width="150" id="rect2228" stroke-miterlimit="4" stroke-width="0" fill="#000000"/>
<rect y="219.162162" x="59" height="16" width="80" id="rect2230" stroke-miterlimit="4" stroke-width="0" fill="#000000"/>
<rect y="234.162162" x="74" height="16" width="50" id="rect2232" stroke-miterlimit="4" stroke-width="0" fill="#000000"/>
<rect y="132.162162" x="54" height="18" width="6" id="rect2247" stroke-miterlimit="4" stroke-width="0" fill="#ffff00"/>
<rect y="132.162162" x="66" height="18" width="6" id="rect2249" stroke-miterlimit="4" stroke-width="0" fill="#ffff00"/>
<rect y="132.162162" x="78" height="18" width="6" id="rect2251" stroke-miterlimit="4" stroke-width="0" fill="#ffff00"/>
<rect y="132.162162" x="90" height="18" width="6" id="rect2253" stroke-miterlimit="4" stroke-width="0" fill="#ffff00"/>
<rect y="132.162162" x="102" height="18" width="6" id="rect2255" stroke-miterlimit="4" stroke-width="0" fill="#ffff00"/>
<rect y="132.162162" x="114" height="18" width="6" id="rect2257" stroke-miterlimit="4" stroke-width="0" fill="#ffff00"/>
<rect y="132.162162" x="126" height="18" width="6" id="rect2259" stroke-miterlimit="4" stroke-width="0" fill="#ffff00"/>
<rect y="132.162162" x="138" height="18" width="6" id="rect2261" stroke-miterlimit="4" stroke-width="0" fill="#ffff00"/>
<text transform="matrix(2.0431718826293945,0,0,1.720379114151001,-68.70264820754528,-44.79857616126537) " xml:space="preserve" text-anchor="middle" font-family="sans-serif" font-size="32" stroke-width="0" stroke="#000000" fill="#ffffff" id="svg_2" y="143.102295" x="83.59375">#REPLACEPORTNUMBER#</text>
</g>
</svg>
EOF;
// Replace color, setting the default if one wasn't specified
if(!substr($item['color'],0,1) == "#") { $item['color'] = '#CCCCCC'; }
$image = str_replace("#REPLACECOLOR#", $item['color'], $image);
// Replace label
$image = str_replace("#REPLACELABEL#", $item['label'], $image);
// Replace caption
$image = str_replace("#REPLACECAPTION#", htmlspecialchars($fullcaption,ENT_QUOTES), $image);
// Add port number
$image = str_replace("#REPLACEPORTNUMBER#", $port, $image);
// Position the port
$image = str_replace("#REPLACEX#", 80+$position*43+$group*10, $image); // offset from edge+width of preceeding ports+group spacing
$image = str_replace("#REPLACEY#", 20+$row*66, $image);
return $image;
}
/*
* Create output
*/
function render($mode, &$renderer, $opt) {
if($mode == 'metadata') return false;
// Make sure the tooltip div gets created
$renderer->doc .= "<script type='text/javascript'>patchpanel_create_tooltip_div();</script>";
$content = $opt['content'];
// clear any trailing or leading empty lines from the data set
$content = preg_replace("/[\r\n]*$/","",$content);
$content = preg_replace("/^\s*[\r\n]*/","",$content);
$items = array();
$csv_id = uniqid("csv_");
$csv = "Port,Label,Comment\n";
foreach (explode("\n",$content) as $line) {
$item = array();
if (!preg_match("/^\s*\d+/",$line)) { continue; } // skip lines that don't start with a port number
// split on whitespace, keep quoted strings together
$matchcount = preg_match_all('/"(?:\\.|[^\\"])*"|\S+/',$line,$matches);
if ($matchcount > 0) {
$item['port'] = $matches[0][0];
$item['label'] = htmlspecialchars(trim($matches[0][1], '"\''), ENT_QUOTES);
// If 3rd element starts with #, it's a color. Otherwise part of the comment
if (substr($matches[0][2], 0, 1) == "#") {
$item['color'] = $matches[0][2];
} else {
$item['comment'] = $matches[0][2];
}
// Any remaining text is part of the comment.
for($x=3;$x<=$matchcount;$x++) {
$item['comment'] .= " ". $matches[0][$x];
}
$csv .= '"' . $item['port'] . '","' . $item['label'] . '","' . trim($item['comment'], '"\' ') . '"' . "\n";
$item['comment'] = str_replace(array("\r","\n"), '', p_render('xhtml',p_get_instructions(trim($item['comment'], '"\'')),$info));
$items[$item['port']] = $item;
} else {
$renderer->doc .= 'Syntax error on the following line: <pre style="color:red">'.hsc($line)."</pre>\n";
}
}
// Calculate the size of the image and port spacing
$portsPerRow = ceil($opt['ports']/$opt['rows']);
$groups = ceil($portsPerRow/$opt['groups']);
$imagewidth = 80+$portsPerRow*43+$groups*10+60;
$imageheight = 20+$opt['rows']*66;
$renderer->doc .= '<div class="patchpanel">';
$renderer->doc .= '<div class="patchpanel_container">';
if($opt['rotate']) {
// Draw an outer SVG and transform the inner one
$renderer->doc .= "<div style='height:" . $imagewidth . "px; width:" . $imageheight . "px;'>";
$renderer->doc .= "<svg viewbox-'0 0 ".$imageheight." ".$imagewidth."' width=".$imageheight." height=".$imagewidth."><g transform='rotate(90 0 ".$imageheight.") translate(-".$imageheight." 0) '>";
$renderer->doc .= "<svg viewbox='0 0 ".$imagewidth." ".$imageheight."' width=".$imagewidth." height=".$imageheight." style='line-height:0px;'>";
} else {
$renderer->doc .= "<div style='height:" . $imageheight . "px; width:" . $imagewidth . "px;'>";
$renderer->doc .= "<svg viewbox='0 0 ".$imagewidth." ".$imageheight."' style='line-height:0px;'>";
}
// Add a script that creates the tooltips
$renderer->doc .= '<script type="text/ecmascript"><![CDATA[
function patchpanel_show_tooltip(evt, text) {
tooltip = jQuery("#patchpanel_tooltip");
tooltip.html(text);
tooltip.css({left: evt.clientX+10, top: evt.clientY+10, display: "block" });
}
function patchpanel_hide_tooltip() {
jQuery("#patchpanel_tooltip").css("display", "none");
}
]]>
</script>';
// Draw a rounded rectangle for our patch panel
// grey for the patch panel, pjahn, 29.07.2014
$renderer->doc .= '<rect stroke-width="5" fill="#808080" height="100%" width="100%" x="0" y="0" rx="30" ry="30" />';
// original - color black for the panel
///$renderer->doc .= '<rect stroke-width="5" fill="#000000" height="100%" width="100%" x="0" y="0" rx="30" ry="30" />';
// Draw some mounting holes
$renderer->doc .= '<rect fill="#fff" x="20" y="20" width="30" height="17.6" ry="9" />';
$renderer->doc .= '<rect fill="#fff" x="' . ($imagewidth-20-30) . '" y="20" width="30" height="17.6" ry="9" />';
$renderer->doc .= '<rect fill="#fff" x="20" y="'. ($imageheight-20-17.6) .'" width="30" height="17.6" ry="9" />';
$renderer->doc .= '<rect fill="#fff" x="' . ($imagewidth-20-30) . '" y="' . ($imageheight-20-17.6) . '" width="30" height="17.6" ry="9" />';
// Add a label
$renderer->doc .= '<text transform="rotate(-90 70,' . $imageheight/2 . ') " text-anchor="middle" font-size="12" fill="#fff" y="' . $imageheight/2 . '" x="70">' . $opt['name'] . ' </text>';
if ($opt['switch']) {
$startPortEven = 1;
$startPortOdd = 2;
for ($row=1; $row <= $opt['rows']; $row++) {
// swerner 29.07.2014 modify port positioning according to hp switches
if ($row % 2 == 0) {
$port=$startPortOdd;
} else {
$port=$startPortEven;
}
for ($position=1; $position <= $portsPerRow; $position++) {
$renderer->doc .= $this->ethernet_svg($row, $position, $port, $items[$port], $opt);
$port=$port+2;
}
if ($row % 2 == 0) {
$startPortOdd = $startPortOdd+(2*$portsPerRow);
} else {
$startPortEven = $startPortEven+(2*$portsPerRow);
}
}
} else {
// std port drawing code */
for ($row=1; $row <= $opt['rows']; $row++) {
// Calculate the starting and ending ports for this row.
$startPort = 1+$portsPerRow*($row-1);
$endPort = $portsPerRow+$portsPerRow*($row-1);
if ($endPort > $opt['ports']) { $endPort = $opt['ports']; }
// Draw ethernet ports over the patch panel
for ($port=$startPort; $port <= $endPort ; $port++) {
$position = $port - $portsPerRow*($row-1);
$renderer->doc .= $this->ethernet_svg($row, $position, $port, $items[$port], $opt);
}
}
}
$renderer->doc .= "</svg>";
if($opt['rotate']) {
$renderer->doc .= "</g></svg>";
}
$renderer->doc .= "</div></div>";
// Button to show the CSV version
$renderer->doc .= "<div class='patchpanel_csv'><span onclick=\"this.innerHTML = patchpanel_toggle_vis(document.getElementById('$csv_id'),'block')?'Hide CSV ↑':'Show CSV ↓';\">Show CSV ↓</span>";
$renderer->doc .= "<pre style='display:none;' id='$csv_id'>$csv</pre>\n";
$renderer->doc .= "</div></div>";
return true;
}
}