Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [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 | (function () { |
| 18 | |
| 19 | // Injected Services |
Simon Hunt | 47f8fb7 | 2017-04-11 13:49:31 -0700 | [diff] [blame] | 20 | var $log, fs, ks, flash, wss, t2ps, t2bgs, ps, t2is, t2sp, t2vs, t2rs, |
| 21 | t2fs, t2sls, t2tbs; |
Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [diff] [blame] | 22 | |
| 23 | // Commmands |
Steven Burrows | c846893 | 2017-03-17 16:13:41 +0000 | [diff] [blame] | 24 | function actionMap() { |
| 25 | return { |
| 26 | L: [cycleDeviceLabels, 'Cycle device labels'], |
| 27 | B: [toggleBackground, 'Toggle background'], |
| 28 | I: [toggleInstancePanel, 'Toggle ONOS Instance Panel'], |
| 29 | O: [toggleSummary, 'Toggle the Summary Panel'], |
| 30 | R: [resetZoom, 'Reset pan / zoom'], |
| 31 | P: [togglePorts, 'Toggle Port Highlighting'], |
| 32 | E: [equalizeMasters, 'Equalize mastership roles'], |
| 33 | X: [resetNodeLocation, 'Reset Node Location'], |
| 34 | U: [unpinNode, 'Unpin node (mouse over)'], |
Steven Burrows | aea509d | 2017-04-12 14:17:47 -0700 | [diff] [blame] | 35 | H: [toggleHosts, 'Toggle host visibility'], |
Steven Burrows | 02e67f4 | 2017-04-13 13:59:43 -0700 | [diff] [blame] | 36 | M: [toggleOfflineDevices, 'Toggle offline visibility'], |
Simon Hunt | 47f8fb7 | 2017-04-11 13:49:31 -0700 | [diff] [blame] | 37 | dot: [toggleToolbar, 'Toggle Toolbar'], |
Steven Burrows | c0efbf0 | 2016-11-16 11:30:47 -0600 | [diff] [blame] | 38 | |
Steven Burrows | c846893 | 2017-03-17 16:13:41 +0000 | [diff] [blame] | 39 | esc: handleEscape, |
| 40 | |
| 41 | _keyListener: t2tbs.keyListener.bind(t2tbs) |
| 42 | } |
Simon Hunt | e6f6461 | 2017-04-28 00:01:48 -0700 | [diff] [blame] | 43 | } |
Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [diff] [blame] | 44 | |
Steven Burrows | c846893 | 2017-03-17 16:13:41 +0000 | [diff] [blame] | 45 | function init(_t2fs_, _t2tbs_) { |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 46 | t2fs = _t2fs_; |
Steven Burrows | c846893 | 2017-03-17 16:13:41 +0000 | [diff] [blame] | 47 | t2tbs = _t2tbs_; |
Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [diff] [blame] | 48 | bindCommands(); |
| 49 | } |
| 50 | |
Simon Hunt | e6f6461 | 2017-04-28 00:01:48 -0700 | [diff] [blame] | 51 | function bindCommands(additional) { |
Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [diff] [blame] | 52 | |
Simon Hunt | e6f6461 | 2017-04-28 00:01:48 -0700 | [diff] [blame] | 53 | var am = actionMap(), |
| 54 | add = fs.isO(additional); |
| 55 | |
| 56 | if (add) { |
| 57 | _.each(add, function (value, key) { |
| 58 | // filter out meta properties (e.g. _keyOrder) |
| 59 | if (!(key.startsWith('_'))) { |
| 60 | // don't allow re-definition of existing key bindings |
| 61 | if (am[key]) { |
| 62 | $log.warn('keybind: ' + key + ' already exists'); |
| 63 | } else { |
| 64 | am[key] = [value.cb, value.tt]; |
| 65 | } |
| 66 | } |
| 67 | }); |
| 68 | } |
| 69 | |
| 70 | ks.keyBindings(am); |
Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [diff] [blame] | 71 | |
| 72 | ks.gestureNotes([ |
| 73 | ['click', 'Select the item and show details'], |
| 74 | ['shift-click', 'Toggle selection state'], |
| 75 | ['drag', 'Reposition (and pin) device / host'], |
| 76 | ['cmd-scroll', 'Zoom in / out'], |
| 77 | ['cmd-drag', 'Pan'] |
| 78 | ]); |
| 79 | } |
| 80 | |
Steven Burrows | c0efbf0 | 2016-11-16 11:30:47 -0600 | [diff] [blame] | 81 | function handleEscape() { |
Steven Burrows | 1aa4f58 | 2016-12-13 15:05:41 -0500 | [diff] [blame] | 82 | |
| 83 | if (false) { |
| 84 | // TODO: Cancel show mastership |
| 85 | // TODO: Cancel Active overlay |
| 86 | |
| 87 | } else if (t2rs.deselectAllNodes()) { |
| 88 | // else if we have node selections, deselect them all |
| 89 | // (work already done) |
| 90 | } else if (t2rs.deselectLink()) { |
| 91 | // else if we have a link selection, deselect it |
| 92 | // (work already done) |
Steven Burrows | c0efbf0 | 2016-11-16 11:30:47 -0600 | [diff] [blame] | 93 | } else if (t2is.isVisible()) { |
Steven Burrows | 1aa4f58 | 2016-12-13 15:05:41 -0500 | [diff] [blame] | 94 | // If the instance panel is visible, close it |
| 95 | t2is.toggle(); |
| 96 | } else if (t2sp.isVisible()) { |
| 97 | // If the summary panel is visible, close it |
| 98 | t2sp.toggle(); |
| 99 | } |
Steven Burrows | c0efbf0 | 2016-11-16 11:30:47 -0600 | [diff] [blame] | 100 | } |
| 101 | |
Steven Burrows | 01ddf60 | 2016-09-28 14:21:00 -0700 | [diff] [blame] | 102 | var prefsState = {}; |
| 103 | |
| 104 | function updatePrefsState(what, b) { |
| 105 | prefsState[what] = b ? 1 : 0; |
Simon Hunt | 95f4b42 | 2017-03-03 13:49:05 -0800 | [diff] [blame] | 106 | ps.setPrefs('topo2_prefs', prefsState); |
Steven Burrows | 01ddf60 | 2016-09-28 14:21:00 -0700 | [diff] [blame] | 107 | } |
| 108 | |
Steven Burrows | 583f4be | 2016-11-04 14:06:50 +0100 | [diff] [blame] | 109 | function deviceLabelFlashMessage(index) { |
Steven Burrows | 583f4be | 2016-11-04 14:06:50 +0100 | [diff] [blame] | 110 | switch (index) { |
| 111 | case 0: return 'Hide device labels'; |
| 112 | case 1: return 'Show friendly device labels'; |
| 113 | case 2: return 'Show device ID labels'; |
| 114 | } |
| 115 | } |
| 116 | |
Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [diff] [blame] | 117 | function cycleDeviceLabels() { |
Steven Burrows | 583f4be | 2016-11-04 14:06:50 +0100 | [diff] [blame] | 118 | var deviceLabelIndex = t2ps.get('dlbls') + 1, |
Steven Burrows | af96a21 | 2016-12-28 12:57:02 +0000 | [diff] [blame] | 119 | newDeviceLabelIndex = deviceLabelIndex % 3; |
Steven Burrows | 583f4be | 2016-11-04 14:06:50 +0100 | [diff] [blame] | 120 | |
| 121 | t2ps.set('dlbls', newDeviceLabelIndex); |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 122 | t2fs.updateNodes(); |
Steven Burrows | 583f4be | 2016-11-04 14:06:50 +0100 | [diff] [blame] | 123 | flash.flash(deviceLabelFlashMessage(newDeviceLabelIndex)); |
Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [diff] [blame] | 124 | } |
| 125 | |
Steven Burrows | b43c1a9 | 2017-03-07 17:13:28 +0000 | [diff] [blame] | 126 | function toggleBackground(x) { |
| 127 | t2bgs.toggle(x); |
Steven Burrows | e3a1884 | 2016-09-22 15:33:33 +0100 | [diff] [blame] | 128 | } |
| 129 | |
Steven Burrows | 01ddf60 | 2016-09-28 14:21:00 -0700 | [diff] [blame] | 130 | function toggleInstancePanel(x) { |
| 131 | updatePrefsState('insts', t2is.toggle(x)); |
| 132 | } |
| 133 | |
Steven Burrows | 5570d1b | 2016-09-28 14:21:00 -0700 | [diff] [blame] | 134 | function toggleSummary() { |
| 135 | t2sp.toggle(); |
| 136 | } |
| 137 | |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 138 | function resetZoom() { |
Steven Burrows | 3bbd9af | 2017-03-16 14:44:14 +0000 | [diff] [blame] | 139 | t2bgs.resetZoom(); |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 140 | flash.flash('Pan and zoom reset'); |
| 141 | } |
| 142 | |
| 143 | function togglePorts(x) { |
| 144 | updatePrefsState('porthl', t2vs.togglePortHighlights(x)); |
| 145 | t2fs.updateLinks(); |
| 146 | } |
| 147 | |
| 148 | function equalizeMasters() { |
| 149 | wss.sendEvent('equalizeMasters'); |
| 150 | flash.flash('Equalizing master roles'); |
| 151 | } |
| 152 | |
Steven Burrows | 892cba6 | 2017-03-10 16:31:48 +0000 | [diff] [blame] | 153 | function resetNodeLocation() { |
| 154 | t2fs.resetNodeLocation(); |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 155 | flash.flash('Reset node locations'); |
| 156 | } |
| 157 | |
| 158 | function unpinNode() { |
| 159 | t2fs.unpin(); |
| 160 | flash.flash('Unpin node'); |
| 161 | } |
| 162 | |
Simon Hunt | 47f8fb7 | 2017-04-11 13:49:31 -0700 | [diff] [blame] | 163 | function toggleToolbar() { |
| 164 | t2tbs.toggle(); |
| 165 | } |
| 166 | |
Steven Burrows | 02e67f4 | 2017-04-13 13:59:43 -0700 | [diff] [blame] | 167 | function actionedFlashed(action, message) { |
| 168 | flash.flash(action + ' ' + message); |
| 169 | } |
| 170 | |
Steven Burrows | aea509d | 2017-04-12 14:17:47 -0700 | [diff] [blame] | 171 | function toggleHosts() { |
Steven Burrows | 02e67f4 | 2017-04-13 13:59:43 -0700 | [diff] [blame] | 172 | var on = t2rs.toggleHosts(); |
| 173 | actionedFlashed(on ? 'Show': 'Hide', 'Hosts') |
| 174 | } |
| 175 | |
| 176 | function toggleOfflineDevices() { |
| 177 | var on = t2rs.toggleOfflineDevices(); |
| 178 | actionedFlashed(on ? 'Show': 'Hide', 'offline devices') |
Steven Burrows | aea509d | 2017-04-12 14:17:47 -0700 | [diff] [blame] | 179 | } |
| 180 | |
Steven Burrows | c846893 | 2017-03-17 16:13:41 +0000 | [diff] [blame] | 181 | function notValid(what) { |
| 182 | $log.warn('topo.js getActionEntry(): Not a valid ' + what); |
| 183 | } |
| 184 | |
| 185 | function getActionEntry(key) { |
| 186 | var entry; |
| 187 | |
| 188 | if (!key) { |
| 189 | notValid('key'); |
| 190 | return null; |
| 191 | } |
| 192 | |
| 193 | entry = actionMap()[key]; |
| 194 | |
| 195 | if (!entry) { |
| 196 | notValid('actionMap (' + key + ') entry'); |
| 197 | return null; |
| 198 | } |
| 199 | return fs.isA(entry) || [entry, '']; |
| 200 | } |
| 201 | |
Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [diff] [blame] | 202 | angular.module('ovTopo2') |
Steven Burrows | af96a21 | 2016-12-28 12:57:02 +0000 | [diff] [blame] | 203 | .factory('Topo2KeyCommandService', [ |
Simon Hunt | 47f8fb7 | 2017-04-11 13:49:31 -0700 | [diff] [blame] | 204 | '$log', 'FnService', 'KeyService', 'FlashService', 'WebSocketService', |
| 205 | 'Topo2PrefsService', 'Topo2BackgroundService', 'PrefsService', |
| 206 | 'Topo2InstanceService', 'Topo2SummaryPanelService', 'Topo2ViewService', |
| 207 | 'Topo2RegionService', 'Topo2SpriteLayerService', |
| 208 | |
| 209 | function (_$log_, _fs_, _ks_, _flash_, _wss_, _t2ps_, _t2bgs_, _ps_, |
| 210 | _t2is_, _t2sp_, _t2vs_, _t2rs_, _t2sls_) { |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 211 | |
Steven Burrows | c846893 | 2017-03-17 16:13:41 +0000 | [diff] [blame] | 212 | $log = _$log_; |
| 213 | fs = _fs_; |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 214 | ks = _ks_; |
| 215 | flash = _flash_; |
| 216 | wss = _wss_; |
Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [diff] [blame] | 217 | t2ps = _t2ps_; |
Steven Burrows | b43c1a9 | 2017-03-07 17:13:28 +0000 | [diff] [blame] | 218 | t2bgs = _t2bgs_; |
Steven Burrows | 01ddf60 | 2016-09-28 14:21:00 -0700 | [diff] [blame] | 219 | t2is = _t2is_; |
| 220 | ps = _ps_; |
Steven Burrows | 5570d1b | 2016-09-28 14:21:00 -0700 | [diff] [blame] | 221 | t2sp = _t2sp_; |
Steven Burrows | 1c5c861 | 2016-10-05 13:45:13 -0500 | [diff] [blame] | 222 | t2vs = _t2vs_; |
Steven Burrows | 1aa4f58 | 2016-12-13 15:05:41 -0500 | [diff] [blame] | 223 | t2rs = _t2rs_; |
Steven Burrows | ea1d1ec | 2017-02-23 15:39:25 +0000 | [diff] [blame] | 224 | t2sls = _t2sls_; |
Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [diff] [blame] | 225 | |
| 226 | return { |
| 227 | init: init, |
Steven Burrows | c846893 | 2017-03-17 16:13:41 +0000 | [diff] [blame] | 228 | bindCommands: bindCommands, |
| 229 | getActionEntry: getActionEntry |
Steven Burrows | 37549ee | 2016-09-21 14:41:39 +0100 | [diff] [blame] | 230 | }; |
| 231 | } |
| 232 | ]); |
| 233 | })(); |