Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-present Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | /* |
| 18 | ONOS GUI -- Topology Force Module. |
| 19 | Visualization of the topology in an SVG layer, using a D3 Force Layout. |
| 20 | */ |
| 21 | |
| 22 | (function () { |
| 23 | 'use strict'; |
| 24 | |
| 25 | // injected refs |
Simon Hunt | 9edd172 | 2017-03-10 17:43:26 -0800 | [diff] [blame] | 26 | var $log, $loc, wss; |
Steven Burrows | 57e24e9 | 2016-08-04 18:38:24 +0100 | [diff] [blame] | 27 | |
Steven Burrows | b43c1a9 | 2017-03-07 17:13:28 +0000 | [diff] [blame] | 28 | var t2is, t2rs, t2ls, t2vs, t2bcs, t2ss, t2bgs; |
Steven Burrows | 1aa4f58 | 2016-12-13 15:05:41 -0500 | [diff] [blame] | 29 | var svg, forceG, uplink, dim, opts, zoomer; |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 30 | |
Steven Burrows | dfa52b0 | 2016-09-02 13:50:43 +0100 | [diff] [blame] | 31 | // D3 Selections |
| 32 | var node; |
| 33 | |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 34 | // ========================== Helper Functions |
| 35 | |
Steven Burrows | bd40284 | 2017-03-08 21:30:38 +0000 | [diff] [blame] | 36 | function init(_svg_, _forceG_, _uplink_, _dim_, _zoomer_, _opts_) { |
| 37 | |
Steven Burrows | ec1f45c | 2016-08-08 16:14:41 +0100 | [diff] [blame] | 38 | svg = _svg_; |
Steven Burrows | ec1f45c | 2016-08-08 16:14:41 +0100 | [diff] [blame] | 39 | uplink = _uplink_; |
| 40 | dim = _dim_; |
Steven Burrows | bd40284 | 2017-03-08 21:30:38 +0000 | [diff] [blame] | 41 | zoomer = _zoomer_; |
Steven Burrows | dfa52b0 | 2016-09-02 13:50:43 +0100 | [diff] [blame] | 42 | opts = _opts_; |
| 43 | |
Steven Burrows | bd40284 | 2017-03-08 21:30:38 +0000 | [diff] [blame] | 44 | |
Steven Burrows | b43c1a9 | 2017-03-07 17:13:28 +0000 | [diff] [blame] | 45 | t2bgs.init(); |
Steven Burrows | 68d6f95 | 2017-03-10 13:53:35 +0000 | [diff] [blame] | 46 | t2bgs.region = t2rs; |
Steven Burrows | bd40284 | 2017-03-08 21:30:38 +0000 | [diff] [blame] | 47 | t2ls.init(svg, uplink, dim, zoomer, opts); |
| 48 | t2bcs.addLayout(t2ls); |
Steven Burrows | af96a21 | 2016-12-28 12:57:02 +0000 | [diff] [blame] | 49 | t2ss.init(svg, zoomer); |
Steven Burrows | 5fa057e | 2017-03-15 17:07:56 +0000 | [diff] [blame^] | 50 | t2ss.region = t2rs; |
| 51 | t2rs.layout = t2ls; |
Simon Hunt | 9edd172 | 2017-03-10 17:43:26 -0800 | [diff] [blame] | 52 | |
| 53 | navToBookmarkedRegion($loc.search().regionId); |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 54 | } |
| 55 | |
| 56 | function destroy() { |
| 57 | $log.debug('Destroy topo force layout'); |
| 58 | } |
| 59 | |
Simon Hunt | 9edd172 | 2017-03-10 17:43:26 -0800 | [diff] [blame] | 60 | function navToBookmarkedRegion(regionId) { |
| 61 | $log.debug('navToBookmarkedRegion:', regionId); |
| 62 | if (regionId) { |
| 63 | wss.sendEvent('topo2navRegion', { |
| 64 | rid: regionId |
Simon Hunt | 9818919 | 2016-07-29 19:02:27 -0700 | [diff] [blame] | 65 | }); |
| 66 | |
Simon Hunt | 9edd172 | 2017-03-10 17:43:26 -0800 | [diff] [blame] | 67 | t2ls.createForceElements(); |
| 68 | t2ls.transitionDownRegion(); |
| 69 | } |
Simon Hunt | 9818919 | 2016-07-29 19:02:27 -0700 | [diff] [blame] | 70 | } |
| 71 | |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 72 | // ========================== Event Handlers |
| 73 | |
| 74 | function allInstances(data) { |
Steven Burrows | 57e24e9 | 2016-08-04 18:38:24 +0100 | [diff] [blame] | 75 | $log.debug('>> topo2AllInstances event:', data); |
Steven Burrows | 57e24e9 | 2016-08-04 18:38:24 +0100 | [diff] [blame] | 76 | t2is.allInstances(data); |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 77 | } |
| 78 | |
| 79 | function currentLayout(data) { |
Steven Burrows | 57e24e9 | 2016-08-04 18:38:24 +0100 | [diff] [blame] | 80 | $log.debug('>> topo2CurrentLayout event:', data); |
Steven Burrows | b43c1a9 | 2017-03-07 17:13:28 +0000 | [diff] [blame] | 81 | t2rs.clear(); |
Steven Burrows | af3159d | 2016-08-25 14:54:30 +0100 | [diff] [blame] | 82 | t2bcs.addBreadcrumb(data.crumbs); |
Steven Burrows | b43c1a9 | 2017-03-07 17:13:28 +0000 | [diff] [blame] | 83 | t2bgs.addLayout(data); |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 84 | } |
| 85 | |
| 86 | function currentRegion(data) { |
Steven Burrows | 57e24e9 | 2016-08-04 18:38:24 +0100 | [diff] [blame] | 87 | $log.debug('>> topo2CurrentRegion event:', data); |
Steven Burrows | 68d6f95 | 2017-03-10 13:53:35 +0000 | [diff] [blame] | 88 | t2rs.loaded('regionData', data); |
Simon Hunt | 9818919 | 2016-07-29 19:02:27 -0700 | [diff] [blame] | 89 | } |
| 90 | |
| 91 | function topo2PeerRegions(data) { |
Steven Burrows | dfa52b0 | 2016-09-02 13:50:43 +0100 | [diff] [blame] | 92 | $log.debug('>> topo2PeerRegions event:', data); |
Steven Burrows | 68d6f95 | 2017-03-10 13:53:35 +0000 | [diff] [blame] | 93 | t2rs.loaded('peers', data.peers); |
Simon Hunt | 9818919 | 2016-07-29 19:02:27 -0700 | [diff] [blame] | 94 | } |
| 95 | |
Simon Hunt | 537bc76 | 2016-12-20 12:15:13 -0800 | [diff] [blame] | 96 | function modelEvent(data) { |
| 97 | $log.debug('>> topo2UiModelEvent event:', data); |
Steven Burrows | 42eb9e2 | 2017-02-06 14:20:24 +0000 | [diff] [blame] | 98 | |
Simon Hunt | 537bc76 | 2016-12-20 12:15:13 -0800 | [diff] [blame] | 99 | // TODO: Interpret the event and update our topo model state (if needed) |
| 100 | // To Decide: Can we assume that the server will only send events |
| 101 | // related to objects that we are currently showing? |
| 102 | // (e.g. filtered by subregion contents?) |
Steven Burrows | 42eb9e2 | 2017-02-06 14:20:24 +0000 | [diff] [blame] | 103 | t2rs.update(data); |
Simon Hunt | 537bc76 | 2016-12-20 12:15:13 -0800 | [diff] [blame] | 104 | } |
| 105 | |
Steven Burrows | 57e24e9 | 2016-08-04 18:38:24 +0100 | [diff] [blame] | 106 | function showMastership(masterId) { |
Steven Burrows | dfa52b0 | 2016-09-02 13:50:43 +0100 | [diff] [blame] | 107 | if (masterId) { |
Steven Burrows | 57e24e9 | 2016-08-04 18:38:24 +0100 | [diff] [blame] | 108 | showMastershipFor(masterId); |
Steven Burrows | dfa52b0 | 2016-09-02 13:50:43 +0100 | [diff] [blame] | 109 | } else { |
| 110 | restoreLayerState(); |
Steven Burrows | 57e24e9 | 2016-08-04 18:38:24 +0100 | [diff] [blame] | 111 | } |
| 112 | } |
| 113 | |
| 114 | function restoreLayerState() { |
| 115 | // NOTE: this level of indirection required, for when we have |
| 116 | // the layer filter functionality re-implemented |
| 117 | suppressLayers(false); |
| 118 | } |
| 119 | |
| 120 | // ========================== Main Service Definition |
| 121 | |
| 122 | function showMastershipFor(id) { |
| 123 | suppressLayers(true); |
| 124 | node.each(function (n) { |
| 125 | if (n.master === id) { |
| 126 | n.el.classed('suppressedmax', false); |
| 127 | } |
| 128 | }); |
| 129 | } |
| 130 | |
| 131 | function supAmt(less) { |
| 132 | return less ? 'suppressed' : 'suppressedmax'; |
| 133 | } |
| 134 | |
| 135 | function suppressLayers(b, less) { |
| 136 | var cls = supAmt(less); |
| 137 | node.classed(cls, b); |
| 138 | // link.classed(cls, b); |
| 139 | } |
| 140 | |
Steven Burrows | ec1f45c | 2016-08-08 16:14:41 +0100 | [diff] [blame] | 141 | function newDim(_dim_) { |
| 142 | dim = _dim_; |
| 143 | t2vs.newDim(dim); |
Steven Burrows | ec1f45c | 2016-08-08 16:14:41 +0100 | [diff] [blame] | 144 | } |
| 145 | |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 146 | // ========================== Main Service Definition |
| 147 | |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 148 | function update(elements) { |
| 149 | angular.forEach(elements, function (el) { |
| 150 | el.update(); |
| 151 | }); |
| 152 | } |
| 153 | |
Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [diff] [blame] | 154 | function updateNodes() { |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 155 | update(t2rs.regionNodes()); |
| 156 | } |
| 157 | |
| 158 | function updateLinks() { |
| 159 | update(t2rs.regionLinks()); |
| 160 | } |
| 161 | |
Steven Burrows | 892cba6 | 2017-03-10 16:31:48 +0000 | [diff] [blame] | 162 | function resetNodeLocation() { |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 163 | |
Steven Burrows | 892cba6 | 2017-03-10 16:31:48 +0000 | [diff] [blame] | 164 | var hovered = t2rs.filterRegionNodes(function (model) { |
| 165 | return model.get('hovered'); |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 166 | }); |
| 167 | |
Steven Burrows | 892cba6 | 2017-03-10 16:31:48 +0000 | [diff] [blame] | 168 | angular.forEach(hovered, function (model) { |
| 169 | model.resetPosition(); |
| 170 | }); |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | function unpin() { |
Steven Burrows | b11a8b8 | 2017-03-10 16:00:31 +0000 | [diff] [blame] | 174 | |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 175 | var hovered = t2rs.filterRegionNodes(function (model) { |
| 176 | return model.get('hovered'); |
| 177 | }); |
| 178 | |
| 179 | angular.forEach(hovered, function (model) { |
Steven Burrows | b11a8b8 | 2017-03-10 16:00:31 +0000 | [diff] [blame] | 180 | model.fix(false); |
Steven Burrows | 0616e80 | 2016-10-06 21:45:07 -0500 | [diff] [blame] | 181 | }); |
Steven Burrows | b11a8b8 | 2017-03-10 16:00:31 +0000 | [diff] [blame] | 182 | |
| 183 | t2ls.start(); |
Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [diff] [blame] | 184 | } |
| 185 | |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 186 | angular.module('ovTopo2') |
Steven Burrows | af96a21 | 2016-12-28 12:57:02 +0000 | [diff] [blame] | 187 | .factory('Topo2ForceService', [ |
Steven Burrows | f303c1e | 2017-03-13 12:26:22 +0000 | [diff] [blame] | 188 | '$log', '$location', 'WebSocketService', 'Topo2InstanceService', |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 189 | 'Topo2RegionService', 'Topo2LayoutService', 'Topo2ViewService', |
Steven Burrows | af96a21 | 2016-12-28 12:57:02 +0000 | [diff] [blame] | 190 | 'Topo2BreadcrumbService', 'Topo2ZoomService', 'Topo2SelectService', |
Steven Burrows | b43c1a9 | 2017-03-07 17:13:28 +0000 | [diff] [blame] | 191 | 'Topo2BackgroundService', |
Steven Burrows | f303c1e | 2017-03-13 12:26:22 +0000 | [diff] [blame] | 192 | function (_$log_, _$loc_, _wss_, _t2is_, _t2rs_, _t2ls_, |
Steven Burrows | b43c1a9 | 2017-03-07 17:13:28 +0000 | [diff] [blame] | 193 | _t2vs_, _t2bcs_, zoomService, _t2ss_, _t2bgs_) { |
Steven Burrows | ec1f45c | 2016-08-08 16:14:41 +0100 | [diff] [blame] | 194 | |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 195 | $log = _$log_; |
Steven Burrows | f303c1e | 2017-03-13 12:26:22 +0000 | [diff] [blame] | 196 | $loc = _$loc_; |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 197 | wss = _wss_; |
Steven Burrows | 57e24e9 | 2016-08-04 18:38:24 +0100 | [diff] [blame] | 198 | t2is = _t2is_; |
| 199 | t2rs = _t2rs_; |
Steven Burrows | ec1f45c | 2016-08-08 16:14:41 +0100 | [diff] [blame] | 200 | t2ls = _t2ls_; |
| 201 | t2vs = _t2vs_; |
Steven Burrows | af3159d | 2016-08-25 14:54:30 +0100 | [diff] [blame] | 202 | t2bcs = _t2bcs_; |
Steven Burrows | af96a21 | 2016-12-28 12:57:02 +0000 | [diff] [blame] | 203 | t2ss = _t2ss_; |
Steven Burrows | b43c1a9 | 2017-03-07 17:13:28 +0000 | [diff] [blame] | 204 | t2bgs = _t2bgs_; |
Steven Burrows | 57e24e9 | 2016-08-04 18:38:24 +0100 | [diff] [blame] | 205 | |
Steven Burrows | 0616e80 | 2016-10-06 21:45:07 -0500 | [diff] [blame] | 206 | var onZoom = function () { |
| 207 | var nodes = [].concat( |
| 208 | t2rs.regionNodes(), |
| 209 | t2rs.regionLinks() |
| 210 | ); |
| 211 | |
| 212 | angular.forEach(nodes, function (node) { |
| 213 | node.setScale(); |
| 214 | }); |
| 215 | }; |
| 216 | |
| 217 | zoomService.addZoomEventListener(onZoom); |
| 218 | |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 219 | return { |
Steven Burrows | 57e24e9 | 2016-08-04 18:38:24 +0100 | [diff] [blame] | 220 | |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 221 | init: init, |
Steven Burrows | ec1f45c | 2016-08-08 16:14:41 +0100 | [diff] [blame] | 222 | newDim: newDim, |
Steven Burrows | 57e24e9 | 2016-08-04 18:38:24 +0100 | [diff] [blame] | 223 | |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 224 | destroy: destroy, |
| 225 | topo2AllInstances: allInstances, |
| 226 | topo2CurrentLayout: currentLayout, |
| 227 | topo2CurrentRegion: currentRegion, |
Steven Burrows | 57e24e9 | 2016-08-04 18:38:24 +0100 | [diff] [blame] | 228 | |
Simon Hunt | 537bc76 | 2016-12-20 12:15:13 -0800 | [diff] [blame] | 229 | topo2UiModelEvent: modelEvent, |
| 230 | |
Steven Burrows | 57e24e9 | 2016-08-04 18:38:24 +0100 | [diff] [blame] | 231 | showMastership: showMastership, |
Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [diff] [blame] | 232 | topo2PeerRegions: topo2PeerRegions, |
| 233 | |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 234 | updateNodes: updateNodes, |
| 235 | updateLinks: updateLinks, |
Steven Burrows | 892cba6 | 2017-03-10 16:31:48 +0000 | [diff] [blame] | 236 | resetNodeLocation: resetNodeLocation, |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 237 | unpin: unpin |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 238 | }; |
| 239 | }]); |
Steven Burrows | dfa52b0 | 2016-09-02 13:50:43 +0100 | [diff] [blame] | 240 | })(); |