topoOverlay.js
3.33 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
/*
* Copyright 2015 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 Overlay Module.
Provides overlay capabilities, allowing ONOS apps to provide additional
custom data/behavior for the topology view.
*/
(function () {
'use strict';
// constants
var tos = 'TopoOverlayService: ';
// injected refs
var $log, fs, gs;
// internal state
var overlays = {};
function error(fn, msg) {
$log.error(tos + fn + '(): ' + msg);
}
function warn(fn, msg) {
$log.warn(tos + fn + '(): ' + msg);
}
function handleGlyph(o) {
var gdata = fs.isO(o.glyph),
oid,
data = {};
if (!gdata) {
o._glyphId = 'unknown';
} else {
if (gdata.id) {
o._glyphId = gdata.id;
} else if (gdata.vb && gdata.d) {
oid = o.overlayId;
data['_' + oid] = gdata.vb;
data[oid] = gdata.d;
gs.registerGlyphs(data);
o._glyphId = oid;
$log.debug('registered overlay glyph:', oid);
} else {
warn('registerGlyph', 'problem with glyph data');
}
}
}
function register(overlay) {
var r = 'register',
over = fs.isO(overlay),
id = over ? over.overlayId : '';
if (!id) {
return error(r, 'not a recognized overlay');
}
if (overlays[id]) {
return warn(r, 'already registered: "' + id + '"');
}
overlays[id] = overlay;
handleGlyph(overlay);
$log.debug(tos + 'registered overlay: ' + id, overlay);
}
// NOTE: unregister needs to be called if an app is ever
// deactivated/uninstalled via the applications view
function unregister(overlay) {
var u = 'unregister',
over = fs.isO(overlay),
id = over ? over.overlayId : '';
if (!id) {
return error(u, 'not a recognized overlay');
}
if (!overlays[id]) {
return warn(u, 'not registered: "' + id + "'")
}
delete overlays[id];
$log.debug(tos + 'unregistered overlay: ' + id);
// TODO: rebuild the toolbar overlay radio button set
}
function list() {
return d3.map(overlays).keys();
}
function overlay(id) {
return overlays[id];
}
angular.module('ovTopo')
.factory('TopoOverlayService',
['$log', 'FnService', 'GlyphService',
function (_$log_, _fs_, _gs_) {
$log = _$log_;
fs = _fs_;
gs = _gs_;
return {
register: register,
unregister: unregister,
list: list,
overlay: overlay
}
}]);
}());