| /* |
| * Copyright 2017-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. |
| * |
| */ |
| |
| (function () { |
| 'use strict'; |
| |
| // constants |
| var t2os = 'Topo2OverlayService: '; |
| |
| // injected refs |
| var $log, $timeout, fs, gs, wss, t2kcs, api; |
| |
| // internal state |
| var overlays = {}, |
| current = null, |
| reset = true; |
| |
| function error(fn, msg) { |
| $log.error(t2os + fn + '(): ' + msg); |
| } |
| |
| function warn(fn, msg) { |
| $log.warn(t2os + fn + '(): ' + msg); |
| } |
| |
| function register(overlay) { |
| var r = 'register', |
| over = fs.isO(overlay), |
| kb = over ? fs.isO(overlay.keyBindings) : null, |
| 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; |
| // TODO handleGlyphs(overlay) ... see topoOverlay.js |
| |
| if (kb) { |
| if (!fs.isA(kb._keyOrder)) { |
| warn(r, 'no _keyOrder array defined on keyBindings'); |
| } else { |
| kb._keyOrder.forEach(function (k) { |
| if (k !== '-' && !kb[k]) { |
| warn(r, 'no "' + k + '" property defined on keyBindings'); |
| } |
| }); |
| } |
| } |
| |
| $log.debug(t2os + 'registered overlay: ' + id, overlay); |
| } |
| |
| // TODO: check topoOverlay.js for more code |
| // TODO: medium term -- factor out common code |
| // TODO: longer term -- deprecate classic topology view |
| |
| // === ----------------------------------------------------- |
| // Hooks for overlays |
| |
| function _hook(x) { |
| var h = current && current.hooks; |
| return h && fs.isF(h[x]); |
| } |
| |
| function escapeHook() { |
| var eh = _hook('escape'); |
| return eh ? eh() : false; |
| } |
| |
| function emptySelectHook() { |
| var cb = _hook('empty'); |
| cb && cb(); |
| } |
| |
| function singleSelectHook(data) { |
| var cb = _hook('single'); |
| cb && cb(data); |
| } |
| |
| function multiSelectHook(selectOrder) { |
| var cb = _hook('multi'); |
| cb && cb(selectOrder); |
| } |
| |
| function mouseOverHook(what) { |
| var cb = _hook('mouseover'); |
| cb && cb(what); |
| } |
| |
| function mouseOutHook() { |
| var cb = _hook('mouseout'); |
| cb && cb(); |
| } |
| |
| // NOTE: modifyLinkData (on classic topo) should not be necessary, as |
| // we should have a way of doing that server side |
| |
| // NOTE: while classic topology view persists, it should be the one to |
| // handle "visualization of intents" from intent view |
| |
| |
| // === ----------------------------------------------------- |
| // Event Handlers (events from server) |
| |
| function setApi(_api_) { |
| api = _api_; |
| } |
| |
| function setOverlay(ovid) { |
| var ov = overlays[ovid]; |
| if (!ov) { |
| $log.error('setOverlay: no such overlay ID: ' + ovid); |
| } else { |
| current = ov; |
| t2kcs.bindCommands(current.keyBindings); |
| } |
| } |
| |
| function showHighlights(data) { |
| function doHighlight() { |
| _showHighlights(data); |
| } |
| |
| // note: this allows the server-side event to add a manual delay |
| // before invoking the highlight... this was (originally) to |
| // allow for the re-creation of the DOM model, before trying |
| // to reference elements. For Topo2, there may be a better |
| // solution, making this piece of code redundant. Steven?? |
| |
| if (data.delay) { |
| $timeout(doHighlight, data.delay); |
| } else { |
| doHighlight(); |
| } |
| |
| } |
| |
| function _showHighlights(data) { |
| // TODO: implement the highlighting .. see topoOverlay.js for example |
| $log.info('+++ TOPO 2 +++ show highlights', data); |
| } |
| |
| // ======================================================================== |
| |
| angular.module('ovTopo2') |
| .factory('Topo2OverlayService', [ |
| '$log', '$timeout', 'FnService', 'GlyphService', 'WebSocketService', |
| 'Topo2KeyCommandService', |
| |
| function (_$log_, _$timeout_, _fs_, _gs_, _wss_, _t2kcs_) { |
| $log = _$log_; |
| $timeout = _$timeout_; |
| fs = _fs_; |
| gs = _gs_; |
| wss = _wss_; |
| t2kcs = _t2kcs_; |
| |
| return { |
| register: register, |
| setApi: setApi, |
| setOverlay: setOverlay, |
| |
| hooks: { |
| escape: escapeHook, |
| emptySelect: emptySelectHook, |
| singleSelect: singleSelectHook, |
| multiSelect: multiSelectHook, |
| mouseOver: mouseOverHook, |
| mouseOut: mouseOutHook |
| }, |
| showHighlights: showHighlights |
| } |
| } |
| ]); |
| |
| }()); |