#!/usr/bin/env python
"""
Server for realtime Galaxy communication.
At first you need to install a few requirements.
. GALAXY_ROOT/.venv/bin/activate # activate Galaxy's virtualenv
pip install flask flask-socketio eventlet # install the requirements
As a next step start the communication server with something like this:
./scripts/communication_server.py --port 7070 --host localhost
Please make sure the host and the port matches the ones on config/galaxy.ini
The communication server feature of Galaxy can be controlled on three different levels:
1. Admin can activate/deactivate communication (config/galaxy.ini)
2. User can actrivate/deactivate for one session (in the communication window)
3. User can actrivate/deactivate as personal-setting for ever (Galaxy user preferences)
"""
import sys
import argparse
from flask import Flask, request, make_response, current_app
from flask_socketio import SocketIO, emit, disconnect
from datetime import timedelta
from functools import update_wrapper
app = Flask(__name__)
app.config['SECRET_KEY'] = 'notscret'
socketio = SocketIO(app)
# Taken from flask.pocoo.org/snippets/56/
def crossdomain(origin=None, methods=None, headers=None,
max_age=21600, attach_to_all=True,
automatic_options=True):
if methods is not None:
methods = ', '.join(sorted(x.upper() for x in methods))
if headers is not None and not isinstance(headers, basestring):
headers = ', '.join(x.upper() for x in headers)
if not isinstance(origin, basestring):
origin = ', '.join(origin)
if isinstance(max_age, timedelta):
max_age = max_age.total_seconds()
def get_methods():
if methods is not None:
return methods
options_resp = current_app.make_default_options_response()
return options_resp.headers['allow']
def decorator(f):
def wrapped_function(*args, **kwargs):
if automatic_options and request.method == 'OPTIONS':
resp = current_app.make_default_options_response()
else:
resp = make_response(f(*args, **kwargs))
if not attach_to_all and request.method != 'OPTIONS':
return resp
h = resp.headers
h['Access-Control-Allow-Origin'] = origin
h['Access-Control-Allow-Methods'] = get_methods()
h['Access-Control-Max-Age'] = str(max_age)
if headers is not None:
h['Access-Control-Allow-Headers'] = headers
return resp
f.provide_automatic_options = False
return update_wrapper(wrapped_function, f)
return decorator
template = """
Chat
"""
@app.route('/')
@crossdomain(origin='*')
def index():
return template
@socketio.on('event connect', namespace='/chat')
def event_connect(message):
print("connected")
@socketio.on('event broadcast', namespace='/chat')
def event_broadcast(message):
emit('event response',
{'data': message['data']}, broadcast=True)
@socketio.on('event disconnect', namespace='/chat')
def event_disconnect(message):
print("disconnected")
disconnect()
@socketio.on('disconnect', namespace='/chat')
def event_disconnect():
print("disconnected")
if __name__ == '__main__':
parser = argparse.ArgumentParser(description='Real-time communication server for Galaxy.')
parser.add_argument('--port', type=int, default="7070", help='Port number on which the server should run.')
parser.add_argument('--host', default='localhost', help='Hostname of the communication server.')
args = parser.parse_args()
socketio.run(app, host=args.host, port=args.port)