Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 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 | package org.onosproject.ui.impl; |
| 17 | |
Thomas Vachuska | fa74dd7 | 2016-03-20 19:11:12 -0700 | [diff] [blame] | 18 | import com.fasterxml.jackson.databind.node.ObjectNode; |
Thomas Vachuska | f389723 | 2018-04-25 12:50:32 -0400 | [diff] [blame] | 19 | import com.google.common.collect.ImmutableSet; |
Charles Chan | 43455b8 | 2018-04-23 10:52:48 -0700 | [diff] [blame] | 20 | import com.google.common.collect.Sets; |
Thomas Vachuska | d0d7ea1 | 2018-10-10 10:27:04 -0700 | [diff] [blame] | 21 | import org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest; |
| 22 | import org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse; |
| 23 | import org.eclipse.jetty.websocket.servlet.WebSocketCreator; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 24 | import org.eclipse.jetty.websocket.servlet.WebSocketServlet; |
| 25 | import org.eclipse.jetty.websocket.servlet.WebSocketServletFactory; |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 26 | import org.onlab.osgi.DefaultServiceDirectory; |
| 27 | import org.onlab.osgi.ServiceDirectory; |
| 28 | |
| 29 | import javax.servlet.ServletException; |
Simon Hunt | ea32708 | 2016-04-11 16:49:07 -0700 | [diff] [blame] | 30 | import java.security.Principal; |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 31 | import java.util.Set; |
| 32 | import java.util.Timer; |
| 33 | import java.util.TimerTask; |
| 34 | |
| 35 | /** |
| 36 | * Web socket servlet capable of creating web sockets for the user interface. |
| 37 | */ |
| 38 | public class UiWebSocketServlet extends WebSocketServlet { |
| 39 | |
Thomas Vachuska | c0f757a | 2018-10-23 11:41:34 -0700 | [diff] [blame] | 40 | static final long PING_DELAY_MS = 5000; |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 41 | |
Thomas Vachuska | 51f540f | 2015-05-27 17:26:57 -0700 | [diff] [blame] | 42 | private static UiWebSocketServlet instance; |
Ray Milkey | 06297ed | 2018-01-22 17:13:41 -0800 | [diff] [blame] | 43 | private static final Object INSTANCE_LOCK = new Object(); |
Thomas Vachuska | 51f540f | 2015-05-27 17:26:57 -0700 | [diff] [blame] | 44 | |
Ray Milkey | 2014cdb | 2018-05-16 09:12:24 -0700 | [diff] [blame] | 45 | private static ServiceDirectory directory = new DefaultServiceDirectory(); |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 46 | |
Charles Chan | 43455b8 | 2018-04-23 10:52:48 -0700 | [diff] [blame] | 47 | private final Set<UiWebSocket> sockets = Sets.newConcurrentHashSet(); |
Thomas Vachuska | d0d7ea1 | 2018-10-10 10:27:04 -0700 | [diff] [blame] | 48 | |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 49 | private final Timer timer = new Timer(); |
| 50 | private final TimerTask pruner = new Pruner(); |
Ray Milkey | 2014cdb | 2018-05-16 09:12:24 -0700 | [diff] [blame] | 51 | private static boolean isStopped = false; |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 52 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 53 | @Override |
| 54 | public void configure(WebSocketServletFactory webSocketServletFactory) { |
Thomas Vachuska | c0f757a | 2018-10-23 11:41:34 -0700 | [diff] [blame] | 55 | webSocketServletFactory.getPolicy().setIdleTimeout(Long.MAX_VALUE); |
Thomas Vachuska | d0d7ea1 | 2018-10-10 10:27:04 -0700 | [diff] [blame] | 56 | webSocketServletFactory.setCreator(new UiWebSocketCreator()); |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 57 | } |
| 58 | |
Thomas Vachuska | 51f540f | 2015-05-27 17:26:57 -0700 | [diff] [blame] | 59 | /** |
| 60 | * Closes all currently open UI web-sockets. |
| 61 | */ |
| 62 | public static void closeAll() { |
Ray Milkey | 06297ed | 2018-01-22 17:13:41 -0800 | [diff] [blame] | 63 | synchronized (INSTANCE_LOCK) { |
| 64 | if (instance != null) { |
Ray Milkey | 2014cdb | 2018-05-16 09:12:24 -0700 | [diff] [blame] | 65 | isStopped = true; |
Ray Milkey | 06297ed | 2018-01-22 17:13:41 -0800 | [diff] [blame] | 66 | instance.sockets.forEach(UiWebSocket::close); |
| 67 | instance.sockets.clear(); |
| 68 | instance.pruner.cancel(); |
| 69 | instance.timer.cancel(); |
| 70 | } |
Thomas Vachuska | 51f540f | 2015-05-27 17:26:57 -0700 | [diff] [blame] | 71 | } |
| 72 | } |
| 73 | |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 74 | @Override |
| 75 | public void init() throws ServletException { |
| 76 | super.init(); |
Ray Milkey | 06297ed | 2018-01-22 17:13:41 -0800 | [diff] [blame] | 77 | synchronized (INSTANCE_LOCK) { |
| 78 | instance = this; |
| 79 | } |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 80 | timer.schedule(pruner, PING_DELAY_MS, PING_DELAY_MS); |
| 81 | } |
| 82 | |
Thomas Vachuska | fa74dd7 | 2016-03-20 19:11:12 -0700 | [diff] [blame] | 83 | /** |
| 84 | * Sends the specified message to all the GUI clients. |
| 85 | * |
| 86 | * @param type message type |
| 87 | * @param payload message payload |
| 88 | */ |
| 89 | static void sendToAll(String type, ObjectNode payload) { |
Ray Milkey | 06297ed | 2018-01-22 17:13:41 -0800 | [diff] [blame] | 90 | synchronized (INSTANCE_LOCK) { |
| 91 | if (instance != null) { |
| 92 | instance.sockets.forEach(ws -> ws.sendMessage(type, payload)); |
| 93 | } |
Thomas Vachuska | fa74dd7 | 2016-03-20 19:11:12 -0700 | [diff] [blame] | 94 | } |
| 95 | } |
| 96 | |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 97 | /** |
| 98 | * Sends the specified message to all the GUI clients of the specified user. |
| 99 | * |
| 100 | * @param userName user name |
| 101 | * @param type message type |
| 102 | * @param payload message payload |
| 103 | */ |
| 104 | static void sendToUser(String userName, String type, ObjectNode payload) { |
Ray Milkey | 06297ed | 2018-01-22 17:13:41 -0800 | [diff] [blame] | 105 | synchronized (INSTANCE_LOCK) { |
| 106 | if (instance != null) { |
| 107 | instance.sockets.stream().filter(ws -> userName.equals(ws.userName())) |
| 108 | .forEach(ws -> ws.sendMessage(type, payload)); |
| 109 | } |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 110 | } |
| 111 | } |
| 112 | |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 113 | // Task for pruning web-sockets that are idle. |
| 114 | private class Pruner extends TimerTask { |
| 115 | @Override |
| 116 | public void run() { |
Thomas Vachuska | f389723 | 2018-04-25 12:50:32 -0400 | [diff] [blame] | 117 | ImmutableSet<UiWebSocket> set = ImmutableSet.copyOf(sockets); |
| 118 | set.stream().filter(UiWebSocket::isIdle).forEach(s -> { |
| 119 | sockets.remove(s); |
| 120 | s.close(); |
| 121 | }); |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 122 | } |
| 123 | } |
Thomas Vachuska | d0d7ea1 | 2018-10-10 10:27:04 -0700 | [diff] [blame] | 124 | |
| 125 | // FIXME: This should not be necessary |
Thomas Vachuska | 2bd1fc8 | 2018-10-22 13:09:14 -0700 | [diff] [blame] | 126 | private static final String FAKE_USERNAME = "unknown"; |
Thomas Vachuska | d0d7ea1 | 2018-10-10 10:27:04 -0700 | [diff] [blame] | 127 | |
| 128 | public class UiWebSocketCreator implements WebSocketCreator { |
| 129 | @Override |
| 130 | public Object createWebSocket(ServletUpgradeRequest request, ServletUpgradeResponse response) { |
| 131 | if (!isStopped) { |
| 132 | // FIXME: Replace this with globally shared opaque token to allow secure failover |
| 133 | Principal p = request.getUserPrincipal(); |
| 134 | String userName = p != null ? p.getName() : FAKE_USERNAME; |
| 135 | |
| 136 | UiWebSocket socket = new UiWebSocket(directory, userName); |
| 137 | sockets.add(socket); |
Thomas Vachuska | 2bd1fc8 | 2018-10-22 13:09:14 -0700 | [diff] [blame] | 138 | return socket; |
Thomas Vachuska | d0d7ea1 | 2018-10-10 10:27:04 -0700 | [diff] [blame] | 139 | } |
| 140 | return null; |
| 141 | } |
| 142 | } |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 143 | } |