|
| 1 | +# |
| 2 | +# Project Wok |
| 3 | +# |
| 4 | +# Copyright IBM Corp, 2017 |
| 5 | +# |
| 6 | +# This library is free software; you can redistribute it and/or |
| 7 | +# modify it under the terms of the GNU Lesser General Public |
| 8 | +# License as published by the Free Software Foundation; either |
| 9 | +# version 2.1 of the License, or (at your option) any later version. |
| 10 | +# |
| 11 | +# This library is distributed in the hope that it will be useful, |
| 12 | +# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 14 | +# Lesser General Public License for more details. |
| 15 | +# |
| 16 | +# You should have received a copy of the GNU Lesser General Public |
| 17 | +# License along with this library; if not, write to the Free Software |
| 18 | +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 19 | +# |
| 20 | + |
| 21 | +import cherrypy |
| 22 | +import os |
| 23 | +import select |
| 24 | +import socket |
| 25 | +import threading |
| 26 | + |
| 27 | +import wok.websocket as websocket |
| 28 | +from wok.config import get_pushserver_socket_dir |
| 29 | +from wok.utils import wok_log |
| 30 | + |
| 31 | + |
| 32 | +BASE_DIRECTORY = get_pushserver_socket_dir() |
| 33 | +TOKEN_NAME = 'woknotifications' |
| 34 | +END_OF_MESSAGE_MARKER = '//EOM//' |
| 35 | +push_server = None |
| 36 | + |
| 37 | + |
| 38 | +def start_push_server(): |
| 39 | + global push_server |
| 40 | + |
| 41 | + if not push_server: |
| 42 | + push_server = PushServer() |
| 43 | + |
| 44 | + |
| 45 | +def send_websocket_notification(message): |
| 46 | + global push_server |
| 47 | + |
| 48 | + if push_server: |
| 49 | + push_server.send_notification(message) |
| 50 | + |
| 51 | + |
| 52 | +def send_wok_notification(uri, entity, method, action_name=None): |
| 53 | + app_name = 'wok' |
| 54 | + app = cherrypy.tree.apps.get(uri) |
| 55 | + if app: |
| 56 | + app_name = app.root.domain |
| 57 | + |
| 58 | + source = '/%s/%s' % (app_name, entity) |
| 59 | + if action_name: |
| 60 | + source = '%s/%s' % (source, action_name) |
| 61 | + message = '%s:%s' % (method, source) |
| 62 | + send_websocket_notification(message) |
| 63 | + |
| 64 | + |
| 65 | +class PushServer(object): |
| 66 | + |
| 67 | + def set_socket_file(self): |
| 68 | + if not os.path.isdir(BASE_DIRECTORY): |
| 69 | + try: |
| 70 | + os.mkdir(BASE_DIRECTORY) |
| 71 | + except OSError: |
| 72 | + raise RuntimeError('PushServer base UNIX socket dir %s ' |
| 73 | + 'not found.' % BASE_DIRECTORY) |
| 74 | + |
| 75 | + self.server_addr = os.path.join(BASE_DIRECTORY, TOKEN_NAME) |
| 76 | + |
| 77 | + if os.path.exists(self.server_addr): |
| 78 | + try: |
| 79 | + os.remove(self.server_addr) |
| 80 | + except: |
| 81 | + raise RuntimeError('There is an existing connection in %s' % |
| 82 | + self.server_addr) |
| 83 | + |
| 84 | + def __init__(self): |
| 85 | + self.set_socket_file() |
| 86 | + |
| 87 | + websocket.add_proxy_token(TOKEN_NAME, self.server_addr, True) |
| 88 | + |
| 89 | + self.connections = [] |
| 90 | + |
| 91 | + self.server_running = True |
| 92 | + self.server_socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) |
| 93 | + self.server_socket.setsockopt(socket.SOL_SOCKET, |
| 94 | + socket.SO_REUSEADDR, 1) |
| 95 | + self.server_socket.bind(self.server_addr) |
| 96 | + self.server_socket.listen(10) |
| 97 | + wok_log.info('Push server created on address %s' % self.server_addr) |
| 98 | + |
| 99 | + self.connections.append(self.server_socket) |
| 100 | + cherrypy.engine.subscribe('stop', self.close_server, 1) |
| 101 | + |
| 102 | + server_loop = threading.Thread(target=self.listen) |
| 103 | + server_loop.setDaemon(True) |
| 104 | + server_loop.start() |
| 105 | + |
| 106 | + def listen(self): |
| 107 | + try: |
| 108 | + while self.server_running: |
| 109 | + read_ready, _, _ = select.select(self.connections, |
| 110 | + [], [], 1) |
| 111 | + for sock in read_ready: |
| 112 | + if not self.server_running: |
| 113 | + break |
| 114 | + |
| 115 | + if sock == self.server_socket: |
| 116 | + |
| 117 | + new_socket, addr = self.server_socket.accept() |
| 118 | + self.connections.append(new_socket) |
| 119 | + else: |
| 120 | + try: |
| 121 | + data = sock.recv(4096) |
| 122 | + except: |
| 123 | + try: |
| 124 | + self.connections.remove(sock) |
| 125 | + except ValueError: |
| 126 | + pass |
| 127 | + |
| 128 | + continue |
| 129 | + if data and data == 'CLOSE': |
| 130 | + sock.send('ACK') |
| 131 | + try: |
| 132 | + self.connections.remove(sock) |
| 133 | + except ValueError: |
| 134 | + pass |
| 135 | + sock.close() |
| 136 | + |
| 137 | + except Exception as e: |
| 138 | + raise RuntimeError('Exception ocurred in listen() of pushserver ' |
| 139 | + 'module: %s' % e.message) |
| 140 | + |
| 141 | + def send_notification(self, message): |
| 142 | + message += END_OF_MESSAGE_MARKER |
| 143 | + for sock in self.connections: |
| 144 | + if sock != self.server_socket: |
| 145 | + try: |
| 146 | + sock.send(message) |
| 147 | + except IOError as e: |
| 148 | + if 'Broken pipe' in str(e): |
| 149 | + sock.close() |
| 150 | + try: |
| 151 | + self.connections.remove(sock) |
| 152 | + except ValueError: |
| 153 | + pass |
| 154 | + |
| 155 | + def close_server(self): |
| 156 | + try: |
| 157 | + self.server_running = False |
| 158 | + self.server_socket.shutdown(socket.SHUT_RDWR) |
| 159 | + self.server_socket.close() |
| 160 | + os.remove(self.server_addr) |
| 161 | + except: |
| 162 | + pass |
| 163 | + finally: |
| 164 | + cherrypy.engine.unsubscribe('stop', self.close_server) |
0 commit comments