topoPanel.js
15.4 KB
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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
/*
* Copyright 2015-present Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
ONOS GUI -- Topology Panel Module.
Defines functions for manipulating the summary, detail, and instance panels.
*/
(function () {
'use strict';
// injected refs
var $log, $window, $rootScope, fs, ps, gs, flash, wss, bns, mast, ns;
// constants
var pCls = 'topo-p',
idSum = 'topo-p-summary',
idDet = 'topo-p-detail',
panelOpts = {
width: 260 // summary and detail panel width
},
sumMax = 226, // summary panel max height
padTop = 16, // summary panel padding below masthead
padding = 16, // panel internal padding
padFudge = padTop + 2 * padding,
devPath = 'device';
// internal state
var useDetails = true, // should we show details if we have 'em?
haveDetails = false, // do we have details that we could show?
sumFromTop, // summary panel distance from top of screen
unbindWatch;
// panels
var summary, detail;
// === -----------------------------------------------------
// Panel API
function createTopoPanel(id, opts) {
var p = ps.createPanel(id, opts),
pid = id,
header, body, footer;
p.classed(pCls, true);
function panel() {
return p;
}
function hAppend(x) {
return header.append(x);
}
function bAppend(x) {
return body.append(x);
}
function fAppend(x) {
return footer.append(x);
}
function setup() {
p.empty();
p.append('div').classed('header', true);
p.append('div').classed('body', true);
p.append('div').classed('footer', true);
header = p.el().select('.header');
body = p.el().select('.body');
footer = p.el().select('.footer');
}
function destroy() {
ps.destroyPanel(pid);
}
// fromTop is how many pixels from the top of the page the panel is
// max is the max height of the panel in pixels
// only adjusts if the body content would be 10px or larger
function adjustHeight(fromTop, max) {
var totalPHeight, avSpace,
overflow = 0;
if (!fromTop) {
$log.warn('adjustHeight: height from top of page not given');
return null;
} else if (!body || !p) {
// panel contents are not defined
// this may happen when window is resizing but panel has
// been cleared or removed
return null;
}
p.el().style('top', fromTop + 'px');
p.el().style('height', null);
body.style('height', null);
totalPHeight = fromTop + p.height();
avSpace = fs.windowSize(padFudge).height;
if (totalPHeight >= avSpace) {
overflow = totalPHeight - avSpace;
}
function _adjustBody(height) {
if (height < 10) {
return false;
} else {
body.style('height', height + 'px');
}
return true;
}
if (!_adjustBody(fs.noPxStyle(body, 'height') - overflow)) {
return p.height();
}
if (max && p.height() > max) {
_adjustBody(fs.noPxStyle(body, 'height') - (p.height() - max));
}
return p.height();
}
return {
panel: panel,
setup: setup,
destroy: destroy,
appendHeader: hAppend,
appendBody: bAppend,
appendFooter: fAppend,
adjustHeight: adjustHeight
};
}
// === -----------------------------------------------------
// Utility functions
function addSep(tbody) {
tbody.append('tr').append('td').attr('colspan', 2).append('hr');
}
function addBtnFooter() {
detail.appendFooter('hr');
detail.appendFooter('div').classed('actionBtns', true);
}
function addProp(tbody, label, value) {
var tr = tbody.append('tr'),
lab;
if (typeof label === 'string') {
lab = label.replace(/_/g, ' ');
} else {
lab = label;
}
function addCell(cls, txt) {
tr.append('td').attr('class', cls).html(txt);
}
addCell('label', lab + ' :');
addCell('value', value);
}
function listProps(tbody, data) {
data.propOrder.forEach(function (p) {
if (p === '-') {
addSep(tbody);
} else {
addProp(tbody, p, data.props[p]);
}
});
}
function watchWindow() {
unbindWatch = $rootScope.$watchCollection(
function () {
return {
h: $window.innerHeight,
w: $window.innerWidth
};
}, function () {
var h = summary.adjustHeight(sumFromTop, sumMax),
ss = summary.panel().isVisible(),
dtop = h && ss ? sumFromTop + h + padFudge : 0,
dy = dtop || ss ? detail.ypos.current : sumFromTop;
detail.adjustHeight(dy);
}
);
}
// === -----------------------------------------------------
// Functions for populating the summary panel
function populateSummary(data) {
summary.setup();
var svg = summary.appendHeader('div')
.classed('icon', true)
.append('svg'),
title = summary.appendHeader('h2'),
table = summary.appendBody('table'),
tbody = table.append('tbody');
gs.addGlyph(svg, 'bird', 24, 0, [1,1]);
title.text(data.title);
listProps(tbody, data);
}
// === -----------------------------------------------------
// Functions for populating the detail panel
var isDevice = {
switch: 1,
roadm: 1,
otn:1
};
function displaySingle(data) {
detail.setup();
var svg = detail.appendHeader('div')
.classed('icon clickable', true)
.append('svg'),
title = detail.appendHeader('h2')
.classed('clickable', true),
table = detail.appendBody('table'),
tbody = table.append('tbody'),
navFn;
gs.addGlyph(svg, (data.type || 'unknown'), 26);
title.text(data.title);
// only add navigation when displaying a device
if (isDevice[data.type]) {
navFn = function () {
ns.navTo(devPath, { devId: data.id });
};
svg.on('click', navFn);
title.on('click', navFn);
}
listProps(tbody, data);
addBtnFooter();
}
function displayMulti(ids) {
detail.setup();
var title = detail.appendHeader('h3'),
table = detail.appendBody('table'),
tbody = table.append('tbody');
title.text('Selected Items');
ids.forEach(function (d, i) {
addProp(tbody, i+1, d);
});
addBtnFooter();
}
function addAction(o) {
var btnDiv = d3.select('#' + idDet)
.select('.actionBtns')
.append('div')
.classed('actionBtn', true);
bns.button(btnDiv, idDet + '-' + o.id, o.gid, o.cb, o.tt);
}
var friendlyIndex = {
device: 1,
host: 0
};
function friendly(d) {
var i = friendlyIndex[d.class] || 0;
return (d.labels && d.labels[i]) || '';
}
function linkSummary(d) {
var o = d && d.online ? 'online' : 'offline';
return d ? d.type + ' / ' + o : '-';
}
// provided to change presentation of internal type name
var linkTypePres = {
hostLink: 'edge link'
};
function linkType(d) {
return linkTypePres[d.type()] || d.type();
}
function linkExpected(d) {
return d.expected();
}
var coreOrder = [
'Type', 'Expected', '-',
'A_type', 'A_id', 'A_label', 'A_port', '-',
'B_type', 'B_id', 'B_label', 'B_port'
],
edgeOrder = [
'Type', '-',
'A_type', 'A_id', 'A_label', '-',
'B_type', 'B_id', 'B_label', 'B_port'
];
function displayLink(data, modifyCb) {
detail.setup();
var svg = detail.appendHeader('div')
.classed('icon', true)
.append('svg'),
title = detail.appendHeader('h2'),
table = detail.appendBody('table'),
tbody = table.append('tbody'),
edgeLink = data.type() === 'hostLink',
order = edgeLink ? edgeOrder : coreOrder;
gs.addGlyph(svg, 'ports', 26);
title.text('Link');
var linkData = {
propOrder: order.slice(0), // makes a copy of the array
props: {
Type: linkType(data),
Expected: linkExpected(data),
A_type: data.source.class,
A_id: data.source.id,
A_label: friendly(data.source),
A_port: data.srcPort,
B_type: data.target.class,
B_id: data.target.id,
B_label: friendly(data.target),
B_port: data.tgtPort
}
};
listProps(tbody, modifyCb(linkData, data.extra));
if (!edgeLink) {
addSep(tbody);
addProp(tbody, 'A → B', linkSummary(data.fromSource));
addProp(tbody, 'B → A', linkSummary(data.fromTarget));
}
}
function displayNothing() {
haveDetails = false;
hideDetailPanel();
}
function displaySomething() {
haveDetails = true;
if (useDetails) {
showDetailPanel();
}
}
// === -----------------------------------------------------
// Event Handlers
function showSummary(data) {
populateSummary(data);
showSummaryPanel();
}
function toggleSummary(x) {
var kev = (x === 'keyev'),
on = kev ? !summary.panel().isVisible() : !!x,
verb = on ? 'Show' : 'Hide';
if (on) {
// ask server to start sending summary data.
wss.sendEvent('requestSummary');
// note: the summary panel will appear, once data arrives
} else {
hideSummaryPanel();
}
flash.flash(verb + ' summary panel');
return on;
}
// === -----------------------------------------------------
// === LOGIC For showing/hiding summary and detail panels...
function showSummaryPanel() {
function _show() {
summary.panel().show();
summary.adjustHeight(sumFromTop, sumMax);
}
if (detail.panel().isVisible()) {
detail.down(_show);
} else {
_show();
}
}
function hideSummaryPanel() {
// instruct server to stop sending summary data
wss.sendEvent("cancelSummary");
summary.panel().hide(detail.up);
}
function showDetailPanel() {
if (summary.panel().isVisible()) {
detail.down(detail.panel().show);
} else {
detail.up(detail.panel().show);
}
}
function hideDetailPanel() {
detail.panel().hide();
}
// ==========================
function augmentDetailPanel() {
var d = detail,
downPos = sumFromTop + sumMax + padFudge;
d.ypos = { up: sumFromTop, down: downPos, current: downPos};
d._move = function (y, cb) {
var yp = d.ypos,
endCb;
if (fs.isF(cb)) {
endCb = function () {
cb();
d.adjustHeight(d.ypos.current);
}
} else {
endCb = function () {
d.adjustHeight(d.ypos.current);
}
}
if (yp.current !== y) {
yp.current = y;
d.panel().el().transition().duration(300)
.each('end', endCb)
.style('top', yp.current + 'px');
} else {
endCb();
}
};
d.down = function (cb) { d._move(d.ypos.down, cb); };
d.up = function (cb) { d._move(d.ypos.up, cb); };
}
function toggleUseDetailsFlag(x) {
var kev = (x === 'keyev'),
verb;
useDetails = kev ? !useDetails : !!x;
verb = useDetails ? 'Enable' : 'Disable';
if (useDetails) {
if (haveDetails) {
showDetailPanel();
}
} else {
hideDetailPanel();
}
flash.flash(verb + ' details panel');
return useDetails;
}
// ==========================
function initPanels() {
sumFromTop = mast.mastHeight() + padTop;
summary = createTopoPanel(idSum, panelOpts);
detail = createTopoPanel(idDet, panelOpts);
augmentDetailPanel();
watchWindow();
}
function destroyPanels() {
summary.destroy();
summary = null;
detail.destroy();
detail = null;
haveDetails = false;
unbindWatch();
}
// ==========================
angular.module('ovTopo')
.factory('TopoPanelService',
['$log', '$window', '$rootScope', 'FnService', 'PanelService', 'GlyphService',
'FlashService', 'WebSocketService', 'ButtonService', 'MastService',
'NavService',
function (_$log_, _$window_, _$rootScope_,
_fs_, _ps_, _gs_, _flash_, _wss_, _bns_, _mast_, _ns_) {
$log = _$log_;
$window = _$window_;
$rootScope = _$rootScope_;
fs = _fs_;
ps = _ps_;
gs = _gs_;
flash = _flash_;
wss = _wss_;
bns = _bns_;
mast = _mast_;
ns = _ns_;
return {
initPanels: initPanels,
destroyPanels: destroyPanels,
createTopoPanel: createTopoPanel,
showSummary: showSummary,
toggleSummary: toggleSummary,
hideSummary: hideSummaryPanel,
toggleUseDetailsFlag: toggleUseDetailsFlag,
displaySingle: displaySingle,
displayMulti: displayMulti,
displayLink: displayLink,
displayNothing: displayNothing,
displaySomething: displaySomething,
addAction: addAction,
detailVisible: function () { return detail.panel().isVisible(); },
summaryVisible: function () { return summary.panel().isVisible(); }
};
}]);
}());