flask_app.py

from datetime import timedelta
from time import sleep
from flask import Flask, render_template
from flask import jsonify, request, session
from flask_sock import Sock
from skimmer import cSkimmer

WEB_APP_VER = "0.1.0"

app = Flask(__name__)

# setup config for sessions
app.config['SESSION_PERMANENT'] = True
app.config['SESSION_TYPE'] = 'filesystem'
app.config['PERMANENT_SESSION_LIFETIME'] = timedelta(hours=48)
app.secret_key = 'WE_SHOULD_PROBABLY_CHANGE_THIS'

sock = Sock(app)
app.config.from_pyfile('skimmerwebapp.cfg')
skimmer = cSkimmer(app.config)


@app.before_first_request
def start_skimmer():
    # make session permanent
    session.permanent = True

    # kick off main skcc skimmer script
    skimmer.run()


@app.route("/")
def index():
    """Getting this route will make the skimmer immediately resend the spots
    and skeds.
    """
    skimmer.force_refresh()
    return render_template('index.html')


@app.route("/restart/", methods=['POST'])
def restart():
    """Posting to this route will stop the skimmer then restart it
    """
    skimmer.stop()
    skimmer.force_refresh()
    skimmer.run()
    return render_template('index.html')    


@app.route('/getstatus')
def get_status():
    """Gets the status of the SKCC Skimmer background application (at startup).
    
    This method gets all the text output lines of the skimmer during it's initial
    startup period. Afterwards it serves no function.
    """
    s = skimmer.get_status()
    j = s.get_lines()
    return jsonify(j)


@app.route('/clearspots')
def clear_spots():
    """Allow user to clear the current list of RBN spots.
    
    Returns "nothing" str
    """
    skimmer.clear_spots()
    return "nothing"


@app.route('/save/', methods=['POST'])
def save():
    """Allows a user to save a SPOT line from the UI to the current session.
    
    POSTing with ?clear=1 will pop the current list of stored_spots from the 
    session.
    """
    data = request.get_json()
    #print(data)
    if not session.get('stored_spots'):
        session['stored_spots'] = []

    session['stored_spots'].append(data)
    session.modified = True

    do_clear = request.args.get('clear', default=0, type=int)

    if (do_clear == 1):
        session.pop('stored_spots')

    return jsonify(success=True)


@app.route('/load', methods=['GET'])
def load():
    """Returns the session's stored_spots array as a JSON object.
    
    Use this on refresh to get the current stored spots.
    Returns {Success}
    """
    if not session.get('stored_spots'):
        return jsonify(success=False, message='no stored spots')

    print('load' + str(session['stored_spots']))
    return jsonify(session['stored_spots'])


@app.route('/version', methods=['GET'])
def version():
    """Returns the applications version information. 

    """

    return jsonify(success=True, version=WEB_APP_VER)

@sock.route('/getskedsws')
def get_skeds_ws(ws):
    """Provide a websocket connection that continually sends the current list of
    skeds.
    
    This loops forever and delays based on the app.config 'SKED_TIME' 
    """
    while True:
        sleep(app.config['SKED_TIME'] / 1000)
        (new_skeds, skeds) = skimmer.get_skeds()

        x = jsonify(skeds)
        ws.send(x.data.decode('utf-8'))


@sock.route('/getspotsws')
def get_spots_ws(ws):
    """Provide a websocket connection that continually sends the current list of
    RBN spots of SKCC members.
    
    This loops forever and delays based on the app.config 'SPOT_TIME' 
    """
    while True:
        sleep(app.config['SPOT_TIME'] / 1000)
        (new_spots, spots) = skimmer.get_spots()

        x = jsonify(spots)
        ws.send(x.data.decode('utf-8'))


# when we run out of a bundled exe this is what starts off the flask application
if __name__ == '__main__':

    # run the flask server
    if (app.config['BIND_LOCALHOST_ONLY']): 
        app.run()
    else:
        app.run(host="0.0.0.0")