add game log server

GameLogServer/GameLogServer.pyproj

@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
+  <PropertyGroup>
+    <VisualStudioVersion Condition="'$(VisualStudioVersion)' == ''">10.0</VisualStudioVersion>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <SchemaVersion>2.0</SchemaVersion>
+    <ProjectGuid>42efda12-10d3-4c40-a210-9483520116bc</ProjectGuid>
+    <ProjectHome>.</ProjectHome>
+    <ProjectTypeGuids>{789894c7-04a9-4a11-a6b5-3f4435165112};{1b580a1a-fdb3-4b32-83e1-6407eb2722e6};{349c5851-65df-11da-9384-00065b846f21};{888888a0-9f3d-457c-b088-3a5042f75d52}</ProjectTypeGuids>
+    <StartupFile>runserver.py</StartupFile>
+    <SearchPath>
+    </SearchPath>
+    <WorkingDirectory>.</WorkingDirectory>
+    <LaunchProvider>Web launcher</LaunchProvider>
+    <WebBrowserUrl>http://localhost</WebBrowserUrl>
+    <OutputPath>.</OutputPath>
+    <SuppressCollectPythonCloudServiceFiles>true</SuppressCollectPythonCloudServiceFiles>
+    <Name>GameLogServer</Name>
+    <RootNamespace>GameLogServer</RootNamespace>
+    <InterpreterId>MSBuild|env|$(MSBuildProjectFullPath)</InterpreterId>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
+    <DebugSymbols>true</DebugSymbols>
+    <EnableUnmanagedDebugging>false</EnableUnmanagedDebugging>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
+    <DebugSymbols>true</DebugSymbols>
+    <EnableUnmanagedDebugging>false</EnableUnmanagedDebugging>
+  </PropertyGroup>
+  <ItemGroup>
+    <Compile Include="GameLogServer\log_reader.py">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="GameLogServer\server.py">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="runserver.py" />
+    <Compile Include="GameLogServer\__init__.py" />
+    <Compile Include="GameLogServer\log_resource.py" />
+  </ItemGroup>
+  <ItemGroup>
+    <Folder Include="GameLogServer\" />
+  </ItemGroup>
+  <ItemGroup>
+    <None Include="FolderProfile.pubxml" />
+    <Content Include="requirements.txt" />
+  </ItemGroup>
+  <ItemGroup>
+    <Interpreter Include="env\">
+      <Id>env</Id>
+      <Version>3.6</Version>
+      <Description>env (Python 3.6 (64-bit))</Description>
+      <InterpreterPath>Scripts\python.exe</InterpreterPath>
+      <WindowsInterpreterPath>Scripts\pythonw.exe</WindowsInterpreterPath>
+      <PathEnvironmentVariable>PYTHONPATH</PathEnvironmentVariable>
+      <Architecture>X64</Architecture>
+    </Interpreter>
+  </ItemGroup>
+  <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\Python Tools\Microsoft.PythonTools.Web.targets" />
+  <!-- Specify pre- and post-build commands in the BeforeBuild and 
+       AfterBuild targets below. -->
+  <Target Name="BeforeBuild">
+  </Target>
+  <Target Name="AfterBuild">
+  </Target>
+  <ProjectExtensions>
+    <VisualStudio>
+      <FlavorProperties GUID="{349c5851-65df-11da-9384-00065b846f21}">
+        <WebProjectProperties>
+          <AutoAssignPort>True</AutoAssignPort>
+          <UseCustomServer>True</UseCustomServer>
+          <CustomServerUrl>http://localhost</CustomServerUrl>
+          <SaveServerSettingsInUserFile>False</SaveServerSettingsInUserFile>
+        </WebProjectProperties>
+      </FlavorProperties>
+      <FlavorProperties GUID="{349c5851-65df-11da-9384-00065b846f21}" User="">
+        <WebProjectProperties>
+          <StartPageUrl>
+          </StartPageUrl>
+          <StartAction>CurrentPage</StartAction>
+          <AspNetDebugging>True</AspNetDebugging>
+          <SilverlightDebugging>False</SilverlightDebugging>
+          <NativeDebugging>False</NativeDebugging>
+          <SQLDebugging>False</SQLDebugging>
+          <ExternalProgram>
+          </ExternalProgram>
+          <StartExternalURL>
+          </StartExternalURL>
+          <StartCmdLineArguments>
+          </StartCmdLineArguments>
+          <StartWorkingDirectory>
+          </StartWorkingDirectory>
+          <EnableENC>False</EnableENC>
+          <AlwaysStartWebServerOnDebug>False</AlwaysStartWebServerOnDebug>
+        </WebProjectProperties>
+      </FlavorProperties>
+    </VisualStudio>
+  </ProjectExtensions>
+</Project>

GameLogServer/GameLogServer/__init__.py

@@ -0,0 +1,9 @@
+"""
+The flask application package.
+"""
+
+from flask import Flask
+from flask_restful import Api
+
+app = Flask(__name__)
+api = Api(app)

GameLogServer/GameLogServer/log_reader.py

@@ -0,0 +1,75 @@
+import re
+import os
+import time
+
+class LogReader(object):
+    def __init__(self):
+        self.log_file_sizes = {}
+        # (if the file changes more than this, ignore ) - 1 MB
+        self.max_file_size_change = 1000000
+        # (if the time between checks is greater, ignore ) - 5 minutes
+        self.max_file_time_change = 300
+
+    def read_file(self, path):
+        # prevent traversing directories
+        if re.search('r^.+\.\.\\.+$', path):
+            return False
+        # must be a valid log path and log file
+        if not re.search(r'^.+[\\|\/](userraw|mods)[\\|\/].+.log$', path):
+            return False
+        # set the initialze size to the current file size
+        file_size = 0
+        if path not in self.log_file_sizes:
+            self.log_file_sizes[path] = { 
+                'length' : self.file_length(path),
+                'read': time.time()
+            }
+            return ''
+
+        # grab the previous values
+        last_length = self.log_file_sizes[path]['length']
+        last_read = self.log_file_sizes[path]['read']
+
+        # the file is being tracked already
+        new_file_size = self.file_length(path)
+          
+        # the log size was  unable to be read (probably the wrong path)
+        if new_file_size < 0:
+            return False
+
+        now = time.time()
+    
+        file_size_difference = new_file_size - last_length
+        time_difference = now - last_read
+
+        # update the new size and actually read the data
+        self.log_file_sizes[path] = {
+            'length': new_file_size,
+            'read': now
+        }
+
+        # if it's been too long since we read and the amount changed is too great, discard it
+        # todo: do we really want old events? maybe make this an "or"
+        if file_size_difference > self.max_file_size_change and time_difference > self.max_file_time_change:
+            return ''
+            
+        new_log_info = self.get_file_lines(path, file_size_difference)
+        return new_log_info
+
+    def get_file_lines(self, path, length):
+        try:
+            file_handle = open(path, 'rb')
+            file_handle.seek(-length, 2)
+            file_data = file_handle.read(length)
+            file_handle.close()
+            return file_data.decode('utf-8')
+        except:
+            return False
+        
+    def file_length(self, path):
+        try:
+            return os.stat(path).st_size
+        except:
+            return -1
+
+reader = LogReader()

GameLogServer/GameLogServer/log_resource.py

@@ -0,0 +1,17 @@
+from flask_restful import Resource
+from GameLogServer.log_reader import reader
+from base64 import urlsafe_b64decode
+
+class LogResource(Resource):
+    def get(self, path):
+        path = urlsafe_b64decode(path).decode('utf-8')
+        log_info = reader.read_file(path)
+
+        if not log_info:
+            print('could not read log file ' + path)
+        
+        return {
+            'success' : log_info is not False,
+            'length':  -1 if log_info is False else len(log_info),
+            'data': log_info
+        }

GameLogServer/GameLogServer/server.py

@@ -0,0 +1,9 @@
+from flask import Flask
+from flask_restful import Api
+from .log_resource import LogResource
+
+app = Flask(__name__)
+
+def init():
+    api = Api(app)
+    api.add_resource(LogResource, '/log/<string:path>')

GameLogServer/requirements.txt

@@ -0,0 +1,12 @@
+Flask==1.0.2
+aniso8601==3.0.2
+click==6.7
+Flask-RESTful==0.3.6
+itsdangerous==0.24
+Jinja2==2.10
+MarkupSafe==1.0
+pip==9.0.3
+pytz==2018.5
+setuptools==39.0.1
+six==1.11.0
+Werkzeug==0.14.1

GameLogServer/runserver.py

@@ -0,0 +1,15 @@
+"""
+This script runs the GameLogServer application using a development server.
+"""
+
+from os import environ
+from GameLogServer.server import app, init
+
+if __name__ == '__main__':
+    HOST = environ.get('SERVER_HOST', '0.0.0.0')
+    try:
+        PORT = int(environ.get('SERVER_PORT', '1625'))
+    except ValueError:
+        PORT = 5555
+    init()
+    app.run(HOST, PORT, debug=True)