Create attractive VASL scenarios, with loads of useful information embedded to assist with game play.
https://vasl-templates.org
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
115 lines
4.2 KiB
115 lines
4.2 KiB
""" Serve static files. """
|
|
|
|
import os
|
|
import io
|
|
import urllib.request
|
|
import urllib.parse
|
|
import mimetypes
|
|
import logging
|
|
|
|
from flask import send_file, send_from_directory, jsonify, redirect, url_for, abort, render_template
|
|
|
|
from vasl_templates.webapp import app, globvars
|
|
from vasl_templates.webapp.utils import resize_image_response, is_empty_file
|
|
|
|
# ---------------------------------------------------------------------
|
|
|
|
class FileServer:
|
|
"""Serve static files."""
|
|
|
|
def __init__( self, base_dir ):
|
|
if FileServer.is_remote_path( base_dir ):
|
|
self.base_dir = base_dir
|
|
else:
|
|
self.base_dir = os.path.abspath( base_dir )
|
|
|
|
def serve_file( self, path, ignore_empty=False ):
|
|
"""Serve a file."""
|
|
# NOTE: We return a Flask Response object, instead of the file data, so that (1) we can use
|
|
# send_from_directory() and (2) if we have to download a file from a URL, we can include
|
|
# the MIME type in what we return.
|
|
if FileServer.is_remote_path( self.base_dir ):
|
|
url = "{}/{}".format( self.base_dir, path )
|
|
# NOTE: We download the target file and serve it ourself (instead of just redirecting)
|
|
# since VASSAL can't handle SSL :-/
|
|
resp = urllib.request.urlopen( url )
|
|
buf = io.BytesIO()
|
|
buf.write( resp.read() )
|
|
buf.seek( 0 )
|
|
mime_type = mimetypes.guess_type( url )[0]
|
|
if not mime_type:
|
|
# FUDGE! send_file() requires a MIME type, so we take a guess and hope the browser
|
|
# can figure it out if we're wrong :-/
|
|
mime_type = "image/png"
|
|
return send_file( buf, mimetype=mime_type )
|
|
else:
|
|
path = path.replace( "\\", "/" ) # nb: for Windows :-/
|
|
if ignore_empty:
|
|
fname = os.path.join( self.base_dir, path )
|
|
if os.path.isfile( fname ) and is_empty_file( fname ):
|
|
return None
|
|
return send_from_directory( self.base_dir, path )
|
|
|
|
@staticmethod
|
|
def is_remote_path( path ):
|
|
"""Check if a path is referring to a remote server."""
|
|
return path.startswith( ("http://","https://") )
|
|
|
|
# ---------------------------------------------------------------------
|
|
|
|
@app.route( "/user/<path:path>" )
|
|
def get_user_file( path ):
|
|
"""Get a static file."""
|
|
dname = app.config.get( "USER_FILES_DIR" )
|
|
if not dname:
|
|
abort( 404 )
|
|
if not os.path.isdir( dname ):
|
|
logging.error( "Missing user files directory: %s", dname )
|
|
resp = FileServer( dname ).serve_file( path )
|
|
if not resp:
|
|
abort( 404 )
|
|
return resize_image_response( resp )
|
|
|
|
# ---------------------------------------------------------------------
|
|
|
|
@app.route( "/counter/<gpid>/<side>/<int:index>" )
|
|
@app.route( "/counter/<gpid>/<side>", defaults={"index":0} )
|
|
def get_counter_image( gpid, side, index ):
|
|
"""Get a counter image."""
|
|
|
|
# check if a VASL module has been configured
|
|
if not globvars.vasl_mod:
|
|
return redirect( url_for( "static", filename="images/missing-image.png" ), code=302 )
|
|
|
|
# return the specified counter image
|
|
image_path, image_data = globvars.vasl_mod.get_piece_image( gpid, side, int(index) )
|
|
if not image_data:
|
|
abort( 404 )
|
|
return send_file(
|
|
io.BytesIO( image_data ),
|
|
attachment_filename = os.path.split( image_path )[1]## nb: so Flask can figure out the MIME type
|
|
)
|
|
|
|
# ---------------------------------------------------------------------
|
|
|
|
@app.route( "/vasl-piece-info" )
|
|
def get_vasl_piece_info():
|
|
"""Get information about the VASL pieces."""
|
|
|
|
# check if a VASL module has been configured
|
|
if not globvars.vasl_mod:
|
|
return jsonify( {} )
|
|
|
|
# return the VASL piece info
|
|
return jsonify( globvars.vasl_mod.get_piece_info() )
|
|
|
|
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
|
|
@app.route( "/counter-image-urls/<nat>/<vo_type>" )
|
|
def get_counter_image_urls( nat, vo_type ):
|
|
"""Get the URL's for each counter image (for testing porpoises)."""
|
|
return render_template( "counter-image-urls.html",
|
|
NATIONALITY = nat,
|
|
VO_TYPE = vo_type,
|
|
VO_TYPE0 = vo_type[:-1] if vo_type.endswith("s") else vo_type,
|
|
)
|
|
|