convert ajax calls to websocket

.gitignore

@@ -1,3 +1,4 @@
 __pycache__/
 *.swp
 *.swo
+sync.sh

README.md

@@ -3,11 +3,11 @@ It's a WebGUI for rTorrent.
 
 ## Requirements  
 Python 3.7+  
-Python packages: `flask gunicorn`  
+Python packages: `gunicorn aiohttp aiohttp_jinja2`  
 
 ## Install  
 1. Get on the floor  
 2. Walk the dinosaur  
 
 ## Usage  
-`gunicorn -b localhost:5250 -e SCRIPT_NAME=/aberrant aberrant:app`  
+`gunicorn aberrant:app --bind localhost:5250 --worker-class aiohttp.GunicornWebWorker`  

aberrant.py

@@ -3,35 +3,63 @@
 The primary module for serving the Aberrant application.
 """
 import json
-import signal
 
-from flask import Flask, render_template, send_from_directory
+import jinja2
+import aiohttp_jinja2
+from aiohttp import web, WSMsgType
+from aiohttp_jinja2 import render_template
 
+import config
+import events
 import rtorrent
 
-app = Flask(__name__)
-app.jinja_env.trim_blocks = True
-app.jinja_env.lstrip_blocks = True
-app.jinja_env.undefined = "StrictUndefined"
+app = web.Application()
+app.on_shutdown.append(rtorrent.stop_watch)
+aiohttp_jinja2.setup(app, loader=jinja2.FileSystemLoader('templates'))
 rtorrent.init()
-signal.signal(signal.SIGINT, rtorrent.stop_watch)
 
-@app.route("/")
-def index():
+routes = web.RouteTableDef()
+
+@routes.get(config.prefix + "/", name='index')
+async def index(request):
 	"""The index page."""
 	torrents = rtorrent.get_active()
 	tracker_stats = rtorrent.get_stats()
-	return render_template("index.html", **locals())
+	return render_template("index.html", request, locals())
 
-@app.route("/static/<path:path>")
-def send_static(path):
-	"""Sends static files."""
-	return send_from_directory("static", path)
-
-@app.route("/get_active_torrents")
-def get_active_torrents():
+@routes.get(config.prefix + "/get_active_torrents", name='active-torrents')
+async def get_active_torrents(request):
 	"""Returns all active torrents formatted as JSON."""
-	return json.dumps([vars(t) for t in rtorrent.get_active()])
+	data = [vars(t) for t in rtorrent.get_active()]
+	return web.json_response(data)
+
+@routes.get(config.prefix + '/ws', name='ws')
+async def websocket_handler(request):
+	"""The websocket endpoint."""
+	ws = web.WebSocketResponse()
+	ws_ready = ws.can_prepare(request)
+	if not ws_ready.ok:
+		return web.Response(text="Cannot start websocket.")
+	await ws.prepare(request)
+
+	async for msg in ws:
+		if msg.type == WSMsgType.TEXT:
+			try:
+				data = json.loads(msg.data)
+			except json.JSONDecodeError:
+				continue
+
+			event = data.get('event')
+			if not event or event not in events.events.keys():
+				continue
+
+			await events.events[event](ws, data.get('data'))
+		else: # TODO: handle differnt message types properly
+			break
+	await ws.close()
+	return ws
+
+app.router.add_routes(routes)
 
 if __name__ == "__main__":
-	app.run(host='0.0.0.0', port=5250)
+	aiohttp.web.run_app(app, host='0.0.0.0', port=5250)

config.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python3
+"""
+Configuation settings for Aberrant.
+"""
+prefix = '/aberrant'

events.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python3
+"""
+WebSocket events.
+"""
+import types
+
+import rtorrent
+
+async def active_torrents(ws, data):
+	"""Returns active torrent information."""
+	data = [vars(t) for t in rtorrent.get_active()]
+	res = {'event': 'active_torrents', 'data': data}
+	await ws.send_json(res)
+
+events = {}
+for obj in dir():
+	if type(locals()[obj]) == types.FunctionType:
+		events[locals()[obj].__name__] = locals()[obj]

rtorrent.py

@@ -153,7 +153,7 @@ def init():
 	WATCH_HANDLE = Watch()
 	WATCH_HANDLE.start()
 
-def stop_watch(*args, **kwargs):
+async def stop_watch(*args, **kwargs):
 	"""Stops the watch thread."""
 	global WATCH_HANDLE
 	WATCH_HANDLE.stop()

static/aberrant.css

@@ -14,15 +14,21 @@ tr {
 	border: 1px solid #ccc;
 }
 
-.name {
-	padding-left: 0.5em;
-}
-
-.totalSize, .state, .downrate, .downPercent, .eta, .uprate, .tracker, .rt_id {
+#torrents td {
 	text-align: center;
 	width: 10%;
 }
 
+#torrents .name {
+	padding-left: 0.5em;
+	text-align: left;
+	width: 0;
+}
+
+#torrents .down_percent:after {
+	content: "%";
+}
+
 #tracker_stats {
 	border-collapse: collapse;
 	border: 1px solid #ccc;

static/aberrant.js

@@ -1,8 +1,9 @@
 function load() {
+	//let intervalID = window.setInterval(get_active_torrents_ajax, 20000);
 	let intervalID = window.setInterval(get_active_torrents, 20000);
 }
 
-function get_active_torrents() {
+function get_active_torrents_ajax() {
 	let httpRequest;
 	httpRequest = new XMLHttpRequest();
 	httpRequest.onreadystatechange = function() {
@@ -13,14 +14,14 @@ function get_active_torrents() {
 		for (let i = 0; i < torrents.length; i++) {
 			html_str += '<tr>'
 			html_str += '<td class="name">' + torrents[i].name + '</td>';
-			html_str += '<td class="totalSize">' + torrents[i].total_size_str + '</td>';
+			html_str += '<td class="total_size_str">' + torrents[i].total_size_str + '</td>';
 			html_str += '<td class="state">' + torrents[i].state + '</td>';
-			html_str += '<td class="downrate">' + torrents[i].downrate_str + '</td>';
-			html_str += '<td class="downPercent">' + torrents[i].down_percent + '%</td>';
-			html_str += '<td class="eta">' + torrents[i].eta_str + '</td>';
-			html_str += '<td class="uprate">' + torrents[i].uprate_str + '</td>';
+			html_str += '<td class="downrate_str">' + torrents[i].downrate_str + '</td>';
+			html_str += '<td class="down_percent">' + torrents[i].down_percent + '%</td>';
+			html_str += '<td class="eta_str">' + torrents[i].eta_str + '</td>';
+			html_str += '<td class="uprate_str">' + torrents[i].uprate_str + '</td>';
 			html_str += '<td class="tracker">' + torrents[i].tracker + '</td>';
-			html_str += '<td class="rt_id">' + torrents[i].rtorrent_id + '</td>';
+			html_str += '<td class="rtorrent_id">' + torrents[i].rtorrent_id + '</td>';
 			html_str += '</tr>';
 		}
 		document.getElementById('torrents').children[1].innerHTML = html_str;
@@ -28,3 +29,49 @@ function get_active_torrents() {
 	httpRequest.open('GET', get_torrents_uri, true);
 	httpRequest.send();
 }
+
+var socket = new WebSocket('wss://' + window.location.hostname + ws_uri);
+socket.oldSend = socket.send;
+socket.send = function(event_title, data) {
+		data = JSON.stringify({event: event_title, data: data});
+		socket.oldSend.apply(this, [data]);
+}
+socket.events = {};
+socket.onmessage = function(e) {
+		let data = JSON.parse(e.data);
+		let event = data.event;
+		data = data.data;
+		if (socket.events[event] === undefined) { return; }
+		socket.events[event](data);
+}
+socket.onclose = function(e) {
+	console.log('WebSocket lost connection to server. Re-trying...');
+	// TODO: reconnect
+}
+
+/* Websocket receive */
+socket.events['active_torrents'] = function(data) {
+	let table = document.querySelector('#torrents tbody');
+	while (table.firstChild) {
+		table.removeChild(table.firstChild);
+	}
+	data.forEach(function(torrent) {
+		let template = document.querySelector('#torrent_template');
+		let node = document.importNode(template.content, true);
+		for (let field of node.children[0].children) {
+			field.textContent = torrent[field.className];
+		}
+		table.appendChild(node);
+	});
+}
+socket.events['tracker_stats'] = function(data) {
+	console.log(data);
+}
+
+/* Websocket send */
+function get_active_torrents() {
+	socket.send('active_torrents', {});
+}
+function get_tracker_stats() {
+	socket.send('tracker_stats', {});
+}

templates/index.html

@@ -2,11 +2,12 @@
 <html>
 <head>
 	<title>Aberrant</title>
-	<link rel="stylesheet" type="text/css" href="{{ url_for('static', filename='aberrant.css') }}">
-	<script type="text/javascript" src="{{ url_for('static', filename='aberrant.js') }}"></script>
+	<link rel="stylesheet" type="text/css" href="/static/aberrant.css">
 	<script>
-		const get_torrents_uri = "{{ url_for('get_active_torrents') }}";
+		const get_torrents_uri = "{{ request.app.router['active-torrents'].url_for() }}";
+		const ws_uri = "{{ request.app.router['ws'].url_for() }}";
 	</script>
+	<script type="text/javascript" src="/static/aberrant.js"></script>
 	<script>window.onload = load;</script>
 </head>
 <body>
@@ -14,32 +15,45 @@
 		<thead>
 			<tr>
 				<th class="name">Name</th>
-				<th class="sizeTotal">Size</th>
+				<th class="total_size_str">Size</th>
 				<th class="state">State</th>
-				<th class="downrate">DL</th>
-				<th class="downPercent">%</th>
-				<th class="eta">ETA</th>
-				<th class="uprate">UL</th>
+				<th class="downrate_str">DL</th>
+				<th class="down_percent"></th>
+				<th class="eta_str">ETA</th>
+				<th class="uprate_str">UL</th>
 				<th class="tracker">Tracker</th>
-				<th class="rt_id">RT id</th>
+				<th class="rtorrent_id">RT id</th>
 			</tr>
 		</thead>
 		<tbody>
 			{% for torrent in torrents %}
 			<tr>
 				<td class="name">{{ torrent.name }}</td>
-				<td class="totalSize">{{ torrent.total_size_str }}</td>
+				<td class="total_size_str">{{ torrent.total_size_str }}</td>
 				<td class="state">{{ torrent.state }}</td>
-				<td class="downrate">{{ torrent.downrate_str }}</td>
-				<td class="downPercent">{{ torrent.down_percent }}%</td>
-				<td class="eta">{{ torrent.eta_str }}</td>
-				<td class="uprate">{{ torrent.uprate_str }}</td>
+				<td class="downrate_str">{{ torrent.downrate_str }}</td>
+				<td class="down_percent">{{ torrent.down_percent }}</td>
+				<td class="eta_str">{{ torrent.eta_str }}</td>
+				<td class="uprate_str">{{ torrent.uprate_str }}</td>
 				<td class="tracker">{{ torrent.tracker }}</td>
-				<td class="rt_id">{{ torrent.rtorrent_id }}</td>
+				<td class="rtorrent_id">{{ torrent.rtorrent_id }}</td>
 			</tr>
 			{% endfor %}
 		</tbody>
 	</table>
+	<template id="torrent_template">
+		<tr>
+			<td class="name"></td>
+			<td class="total_size_str"></td>
+			<td class="state"></td>
+			<td class="downrate_str"></td>
+			<td class="down_percent"></td>
+			<td class="eta_str"></td>
+			<td class="uprate_str"></td>
+			<td class="tracker"></td>
+			<td class="rtorrent_id"></td>
+		</tr>
+	</template>
 	<br>
 	<table id="tracker_stats">
 		<thead>