tweaked, traffic light + Mate-O-Meter implemented

Author: basti2342

README.md

@@ -6,18 +6,22 @@ Overview
 * room status (for SpaceAPI etc.)
 * extended information about our hackspace
 * audio announcement system via long polling
-* LED ticker via long polling
-* Mate-O-Meter (still to come)
+* LED ticker via long polling (see [ledticker](https://github.com/hickerspace/ledticker/))
+* traffic light via long polling and normal request (see [traffic light](https://hickerspace.org/wiki/Verkehrsampel))
+* Mate-O-Meter (measures our Club-Mate stock) (see [Mate-O-Meter](https://hickerspace.org/wiki/Mate-O-Meter))
 * MUC (xmpp) status
-* Wiki status (just redirects)
+* wiki status (just some redirects)
 
 Dependencies
 ============
 
 * flask
-* [ledticker.py](https://github.com/hickerspace/ledticker/blob/master/ledticker.py)
+* gevent
+* simplejson
+* python-xmpp (see /helper)
+* bash, espeak, sox, lame (see /data/espeak/espeak.sh)
 
 Notes
 =====
-* Enable WSGIPassAuthorization to pass through authorisation headers:
-http://code.google.com/p/modwsgi/wiki/ConfigurationDirectives#WSGIPassAuthorization
+* enable [WSGIPassAuthorization](http://code.google.com/p/modwsgi/wiki/ConfigurationDirectives#WSGIPassAuthorization) to pass through authorisation headers:
+* scripts in /helper update the API via http calls and must be called via cron or something similar (calls from other servers are supported)

announce.py

@@ -1,16 +1,65 @@
-from flask import jsonify
+from flask import jsonify, send_from_directory
 from logger import log
 import os
+import glob
+import time
+import ledticker, room
+from conf import *
+from subprocess import Popen, PIPE
+from misc import error504
 
+"""
+Call a bash script which creates a mp3 with espeak content
+and moves it into our restapi directory.
+"""
 def announce(lang, text):
-	if lang in ['de', 'en']:
-		os.system('bash /var/www/hickerspace.org/espeak/espeak_%s.sh \'%s\'' % (lang, text))
-		message = {'status': 'Ok'}
+	if not room.isRoomOpen():
+		message = { 'success': False, 'status': 'Room is not open. Announcements are forbidden at the moment.' }
+		resp = jsonify(message)
+		resp.status_code = 403
+	elif lang in ['de', 'en']:
+		espeak = Popen([ESPEAK_LOCATION, lang, text], stdout=PIPE, stderr=PIPE)
+		returnMsg = espeak.communicate()[0]
+		if espeak.returncode > 0:
+			log('espeak returned "%s"' % returnMsg)
+			message = { 'success': False, 'status': 'Unknown error. Error logged.' }
+		else:
+			message = { 'success': True }
+
 		resp = jsonify(message)
 	else:
-		message = {'message': 'Language not found.'}
+		message = { 'success': False, 'status': 'Language not found.' }
 		resp = jsonify(message)
 		resp.status_code = 403
 
 	return resp
 
+"""
+When the mp3 announcement file is ready, call this method to deliver it.
+"""
+def serveAnnouncement(announcement):
+	try:
+		dlLocation = 'data/downloadable.mp3'
+		os.rename(announcement, API_PATH+'/'+dlLocation)
+		return send_from_directory(API_PATH, dlLocation, as_attachment=True)
+	except OSError:
+		log.exception('Could not move %s.' % announcement)
+		message = { 'success': False, 'status': 'Announcement is not ready yet.' }
+		resp = jsonify(message)
+		resp.status_code = 403
+		return resp
+
+"""
+Determine oldest announcement and return it.
+"""
+def serveOldestAnnouncement():
+	# get mp3 announces sorted by creation time, oldest first
+	mtime = lambda f: os.stat(f).st_mtime
+	announces = list(sorted(glob.glob(ANNOUNCE_LOCATION), key=mtime))
+
+	if len(announces) > 0:
+		# return oldest announcement
+		return serveAnnouncement(announces[0])
+	else:
+		return error504()
+

auth.py

@@ -1,4 +1,4 @@
-from functools import wraps
+from functools import update_wrapper
 from flask import request, jsonify
 from conf import *
 
@@ -17,38 +17,39 @@ def check_auth(username, password):
 Source: "HTTP Basic Auth" by Armin Ronacher
 		http://flask.pocoo.org/snippets/8/
 """
-def authenticate(msg='Authenticate.'):
-	resp = jsonify({'message': msg})
+def authenticate(msg='Please authenticate.'):
+	resp = jsonify({'success': False, 'status': msg})
 	resp.status_code = 401
 	resp.headers['WWW-Authenticate'] = 'Basic realm="API credentials needed to access this resource."'
-
 	return resp
 
 """
 Basic authentication for protected resources and SSL enforcement.
 Source: "HTTP Basic Auth" by Armin Ronacher
 		http://flask.pocoo.org/snippets/8/
+Changed to require ssl for authentication. Extra argument added to require auth only for POST requests.
 """
 
-def requires_auth(f):
-	@wraps(f)
-	def decorated(*args, **kwargs):
-		# require ssl for api requests with auth
-		if "https://" not in request.url:
-			message = {'message': 'Resources requiring authentication also require ssl.'}
-			resp = jsonify(message)
-			resp.status_code = 403
-			return resp
-
-		auth = request.authorization
-		if not auth:
-			return authenticate()
-
-		elif not check_auth(auth.username, auth.password):
-			return authenticate("Authentication Failed.")
-
-		return f(*args, **kwargs)
-
-	return decorated
+def requires_auth(postAuthOnly=False):
+	def decorator(f):
+		def wrapped_function(*args, **kwargs):
+			# require ssl for api requests with auth
+			if "https://" not in request.url and not (postAuthOnly and request.method != 'POST'):
+				message = { 'success': False, 'status': 'Resources requiring authentication also require ssl.'}
+				resp = jsonify(message)
+				resp.status_code = 403
+				return resp
+
+			if not (request.method != 'POST' and postAuthOnly):
+				auth = request.authorization
+				if not auth:
+					return authenticate()
+
+				elif not check_auth(auth.username, auth.password):
+					return authenticate("Authentication Failed.")
+
+			return f(*args, **kwargs)
+		return update_wrapper(wrapped_function, f)
+	return decorator
 
 

conf.py

@@ -1,29 +1,58 @@
+import os
+
+# timeout per request in seconds (adjust WSGI/proxy timeout settings)
+REQUEST_TIMEOUT = 120
+
 # path to REST API files
 API_PATH = os.path.abspath(os.path.dirname(__file__))
+
 # access tuples
 API_ACCESS = [ ("api-user", "APIKEY") ]
+
 # after this number of minutes, the room will be automatically marked as "closed"
 ROOM_TIMEOUT = 15
+
 # weekdays with events
 EVENT_WEEKDAYS = [3, 4]
+
 # begin of meeting
 MEET_HOUR_BEGIN = 18
+
 # end of meeting
 MEET_HOUR_END = 2
+
 # people needed to open the room on events
 EVENT_PEOPLE_LIMIT = 1
+
 # people needed to open the room on normal days
 PEOPLE_LIMIT = 3
+
 # file to save room status in
-ROOM_STATUS_FILE = API_PATH + "/data/room_status.json"
+ROOM_STATUS_FILE = "%s/data/room.json" % API_PATH
+
+# file to save MUC status in
+MUC_FILE = "%s/data/muc.json" % API_PATH
+
+# store traffic light info in this file
+AMPEL_FILE = "%s/data/ampel.json" % API_PATH
+
+# store mate info in this file
+MATE_FILE = "%s/data/mate.json" % API_PATH
+
+# stores ledticker messages
+LEDTICKER_FILE = "%s/data/ledticker.txt" % API_PATH
+
+# location of the espeak script
+ESPEAK_LOCATION = "%s/data/espeak/espeak.sh" % API_PATH
+
+# temporary announce file location
+ANNOUNCE_LOCATION = "%s/data/announces/*.mp3" % API_PATH
+
 # jabber info for status user
 JABBER_SERVER = "hickerspace.org"
-JABBER_USER = "checkMUCuser"
-JABBER_PASSWORD = "password"
+JABBER_USER = "JABBERUSER"
+JABBER_PASSWORD = "JABBERPASSWORD"
+
 # muc info
 JABBER_MUC = "hick"
 JABBER_MUC_SERVER = "conference.hickerspace.org"
-# temprary announce file location
-ANNOUNCE_DL = "downloadable.mp3"
-# where to get announcements initally
-ESPEAK_FILE = "announce.mp3"

data/ampel.json

@@ -0,0 +1 @@
+{"lastUpdate": 1366758579, "green": false, "yellow": false, "red": false, "mode": "all off"}

data/espeak/espeak.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+cd "$(dirname "$0")"
+
+if [ "$1" != "en" ] && [ "$1" != "de" ]
+then
+	echo "Please specify either 'en' or 'de' as your language of choice."
+	exit 1
+fi
+
+# create wav from text
+espeak "$2" -v$1 -s130 -w espeak-$$.wav
+
+# prepend intro gong
+sox psa.wav espeak-$$.wav announce-$$.wav
+
+# encode mp3
+lame -S -V0 -h -b 160 --vbr-new announce-$$.wav announce-$$.mp3
+
+# move mp3 to final destination
+mv announce-$$.mp3 $(mktemp --tmpdir="$(dirname "$0")/../announces/ --suffix=.mp3)
+
+# cleanup
+rm espeak-$$.wav
+rm announce-$$.wav

data/espeak/psa.wav

@@ -0,0 +1 @@
+{"lastUpdate": 1366753502, "bottles": 18}

data/ledticker.txt

@@ -0,0 +1 @@
+{"lastUpdate": 1366844105, "mucUsers": 2, "botOnline": true}

data/mate.json

@@ -0,0 +1 @@
+{"lastOpenSignal": 1366759202.5305691, "lastStatusSignal": 1366753802.6650469, "people": "1"}

data/muc.json

@@ -1,12 +1,25 @@
 import subprocess as sp
-import xmpp
-from conf import *
+import xmpp, urllib, urllib2
+
+# api settings
+API_URL = "https://hickerspace.org/api/muc/"
+API_USER = "api-user"
+API_PASSWORD = "APIKEY"
+
+# jabber settings for status user
+JABBER_SERVER = "hickerspace.org"
+JABBER_USER = "JABBERUSER"
+JABBER_PASSWORD = "JABBERPASSWORD"
+
+# muc settings
+JABBER_MUC = "hick"
+JABBER_MUC_SERVER = "conference.hickerspace.org"
 
 """
 Returns bot status and number of users online in our MUC.
 """
-def mucStatus():
-	result = { 'mucUsers' : 0, 'botOnline' : False }
+def determineStatus():
+	result = { "mucUsers": 0, "botOnline": False }
 
 	# connect to jabber server
 	con = xmpp.Client(JABBER_SERVER)
@@ -27,3 +40,11 @@ def mucStatus():
 			result['mucUsers'] = result['mucUsers'] - 1
 
 	return result
+
+
+passman = urllib2.HTTPPasswordMgrWithDefaultRealm()
+passman.add_password(None, API_URL, API_USER, API_PASSWORD)
+urllib2.install_opener(urllib2.build_opener(urllib2.HTTPBasicAuthHandler(passman)))
+req = urllib2.Request(API_URL)
+urllib2.urlopen(req, urllib.urlencode(determineStatus()))
+

data/room.json

@@ -0,0 +1,50 @@
+from datetime import timedelta
+from flask import make_response, request, current_app
+from functools import update_wrapper
+
+
+"""
+Source: "Decorator for the HTTP Access Control" by Armin Ronacher
+         http://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