mirror of
https://github.com/omltcat/dcs-lua-runner.git
synced 2025-11-10 15:49:49 +00:00
Release 1.0.0
This commit is contained in:
Omelette 蛋卷
parent
33b493bc73
commit
0f97ae3dc3
3
.vscode/settings.json
vendored
3
.vscode/settings.json
vendored
@ -10,5 +10,8 @@
|
|||||||
"typescript.tsc.autoDetect": "off",
|
"typescript.tsc.autoDetect": "off",
|
||||||
"cSpell.words": [
|
"cSpell.words": [
|
||||||
"reimplementation"
|
"reimplementation"
|
||||||
|
],
|
||||||
|
"Lua.diagnostics.globals": [
|
||||||
|
"net"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
20
CHANGELOG.md
20
CHANGELOG.md
@ -6,4 +6,22 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
|
|||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
- Initial release
|
### Added
|
||||||
|
|
||||||
|
- Run current lua file on any DCS server according to address.
|
||||||
|
- Run current lua file in either mission or GUI scripting environment.
|
||||||
|
- Get mission theatre command for quick testing.
|
||||||
|
- Settings to change server address, port, web auth credentials, https.
|
||||||
|
- Display return in output window.
|
||||||
|
|
||||||
|
## [1.0.0] - 2024-01-09
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Run currently selected code via right click menu.
|
||||||
|
- Commands and buttons to quickly switch between local and remote DCS server
|
||||||
|
- Commands and buttons to quickly switch between mission and GUI environment.
|
||||||
|
- Warning for remote DCS server address not set.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Consolidate run code commands to different targets into one, execute based on current setting.
|
||||||
|
- Improve output to show current runner target.
|
||||||
101
README.md
101
README.md
@ -1,71 +1,70 @@
|
|||||||
# dcs-lua-runner README
|
# DCS Lua Runner
|
||||||
|
|
||||||
This is the README for your extension "dcs-lua-runner". After writing up a brief description, we recommend including the following sections.
|
A VS Code extension to run lua code in DCS World (local or remote server). A reimplementation of the [DCS Fiddle](https://github.com/JonathanTurnock/dcsfiddle) web lua console.
|
||||||
|
|
||||||
|
Allows for quick development and debugging of running scripted missions directly from the comfort of VS Code.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
|
- Send Lua code to run on local DCS or remote DCS server.
|
||||||
|
- Run in mission or GUI scripting environment.
|
||||||
For example if there is an image subfolder under your extension project workspace:
|
- Right click and run only selected part of code.
|
||||||
|
- Display return value from DCS.
|
||||||
\!\[feature X\]\(images/feature-x.png\)
|
- Fully compatible with existing DCS Fiddle hooks script.
|
||||||
|
- Optional basic web auth for better public server security (see requirements).
|
||||||
> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
|
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
|
### DCS Hooks Installation
|
||||||
|
Install DCS Fiddle script the same way as the original web version, and de-sanitize mission scripting.
|
||||||
|
[**Original instruction here**](https://dcsfiddle.pages.dev/docs.)
|
||||||
|
|
||||||
|
All credits of this scripts and its API implementations go to the original authors [JonathanTurnock](https://github.com/JonathanTurnock) and [john681611](https://github.com/john681611).
|
||||||
|
|
||||||
|
### Important
|
||||||
|
If you want to run code on a remote DCS server, you need to expose its Fiddle port (12080 by default). This however, creates a security risk, as everyone can now inject lua code into your server.
|
||||||
|
|
||||||
|
It is recommended to install this [modified Fiddle script](src/hooks/dcs-fiddle-server.lua). It allows you configure a basic authentication at the beginning of the file.
|
||||||
|
|
||||||
|
For even better security, put the Fiddle port behind a reverse proxy with HTTPS.
|
||||||
|
|
||||||
## Extension Settings
|
## Extension Settings
|
||||||
|
|
||||||
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
This extension contributes the following settings:
|
This extension contributes the following settings:
|
||||||
|
|
||||||
* `myExtension.enable`: Enable/disable this extension.
|
- `dcsLuaRunner.serverAddress`: Remote DCS server address. It can be an IP address or a domain.
|
||||||
* `myExtension.thing`: Set to `blah` to do something.
|
|
||||||
|
- `dcsLuaRunner.serverPort`: Port of the remote DCS Fiddle. Default is `12080`.
|
||||||
|
|
||||||
|
- `dcsLuaRunner.useHttps`: Specifies whether the server is behind a HTTPS reverse proxy.
|
||||||
|
If this is set to `true`, you should also change the `dcsLuaRunner.serverPort` to `443`.
|
||||||
|
Default is `false`.
|
||||||
|
|
||||||
|
- `dcsLuaRunner.webAuthUsername`: Specifies the username for authentication.
|
||||||
|
**Requires the modified DCS Fiddle script.**
|
||||||
|
|
||||||
|
- `dcsLuaRunner.webAuthPassword`: Specifies the password for authentication.
|
||||||
|
**Requires the modified DCS Fiddle script.**
|
||||||
|
|
||||||
|
- `dcsLuaRunner.runCodeLocally`: Whether to send code to `127.0.0.1:12080` or to the remote server set in `dcsLuaRunner.serverAddress` and `dcsLuaRunner.serverPort`.
|
||||||
|
This setting can be quickly changed with the buttons on the upper-right of a lua file.
|
||||||
|
|
||||||
|
- `dcsLuaRunner.runInMissionEnv`: Specifies whether to execute in mission or GUI Scripting Environment.
|
||||||
|
This setting can be quickly changed with the buttons on the upper-right of a lua file.
|
||||||
|
|
||||||
## Known Issues
|
## Known Issues
|
||||||
|
|
||||||
Calling out known issues can help limit users opening duplicate issues against your extension.
|
The return value is displayed on in the output window, which unfortunately does not support syntax highlight. Possibilities to display return in other ways are being looked into.
|
||||||
|
|
||||||
## Release Notes
|
## Release Notes
|
||||||
|
|
||||||
Users appreciate release notes as you update your extension.
|
See [**changelog**](CHANGELOG.md).
|
||||||
|
|
||||||
### 1.0.0
|
|
||||||
|
|
||||||
Initial release of ...
|
## Credits
|
||||||
|
[**DCS Fiddle**](https://github.com/JonathanTurnock/dcsfiddle) by [JonathanTurnock](https://github.com/JonathanTurnock) and [john681611](https://github.com/john681611).
|
||||||
### 1.0.1
|
|
||||||
|
|
||||||
Fixed issue #.
|
|
||||||
|
|
||||||
### 1.1.0
|
|
||||||
|
|
||||||
Added features X, Y, and Z.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Following extension guidelines
|
|
||||||
|
|
||||||
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
|
|
||||||
|
|
||||||
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
|
|
||||||
|
|
||||||
## Working with Markdown
|
|
||||||
|
|
||||||
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
|
|
||||||
|
|
||||||
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
|
|
||||||
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
|
|
||||||
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.
|
|
||||||
|
|
||||||
## For more information
|
|
||||||
|
|
||||||
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
|
|
||||||
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
|
|
||||||
|
|
||||||
**Enjoy!**
|
|
||||||
BIN
docs/img/demo1.png
Normal file
BIN
docs/img/demo1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
BIN
docs/img/demo2-1.png
Normal file
BIN
docs/img/demo2-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
BIN
docs/img/demo2-2.png
Normal file
BIN
docs/img/demo2-2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 85 KiB |
BIN
docs/img/icon.png
Normal file
BIN
docs/img/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.7 KiB |
139
package.json
139
package.json
@ -1,13 +1,18 @@
|
|||||||
{
|
{
|
||||||
"name": "dcs-lua-runner",
|
"name": "dcs-lua-runner",
|
||||||
"displayName": "DCS Lua Runner",
|
"displayName": "DCS Lua Runner",
|
||||||
"description": "Run lua code in DCS World Mission Scripting Environment (local or remote server). A reimplementation of the DCS Fiddle lua console in VS Code.",
|
"description": "Quickly run lua code in DCS World (local or remote server). A reimplementation of the DCS Fiddle lua console in VS Code.",
|
||||||
"version": "0.0.1",
|
"version": "1.0.0",
|
||||||
|
"icon": "docs/img/icon.png",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/omltcat/dcs-lua-runner"},
|
||||||
"engines": {
|
"engines": {
|
||||||
"vscode": "^1.85.0"
|
"vscode": "^1.85.0"
|
||||||
},
|
},
|
||||||
"categories": [
|
"categories": [
|
||||||
"Other"
|
"Programming Languages",
|
||||||
|
"Debuggers"
|
||||||
],
|
],
|
||||||
"activationEvents": [],
|
"activationEvents": [],
|
||||||
"main": "./out/extension.js",
|
"main": "./out/extension.js",
|
||||||
@ -17,13 +22,13 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"dcsLuaRunner.serverAddress": {
|
"dcsLuaRunner.serverAddress": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "127.0.0.1",
|
"default": "",
|
||||||
"description": "DCS server address."
|
"description": "Remote DCS server address (IP or domain)."
|
||||||
},
|
},
|
||||||
"dcsLuaRunner.serverPort": {
|
"dcsLuaRunner.serverPort": {
|
||||||
"type": "number",
|
"type": "number",
|
||||||
"default": 12080,
|
"default": 12080,
|
||||||
"description": "DCS Fiddle port."
|
"description": "Remote DCS Fiddle port."
|
||||||
},
|
},
|
||||||
"dcsLuaRunner.useHttps": {
|
"dcsLuaRunner.useHttps": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
@ -33,46 +38,138 @@
|
|||||||
"dcsLuaRunner.webAuthUsername": {
|
"dcsLuaRunner.webAuthUsername": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "username",
|
"default": "username",
|
||||||
"description": "The username for authentication."
|
"description": "The username for authentication. Requires the modified DCS Fiddle script."
|
||||||
},
|
},
|
||||||
"dcsLuaRunner.webAuthPassword": {
|
"dcsLuaRunner.webAuthPassword": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "password",
|
"default": "password",
|
||||||
"description": "The password for authentication."
|
"description": "The password for authentication. Requires the modified DCS Fiddle script."
|
||||||
|
},
|
||||||
|
"dcsLuaRunner.runCodeLocally": {
|
||||||
|
"type": "boolean",
|
||||||
|
"default": true,
|
||||||
|
"description": "Send code to 127.0.0.1:12080 or remote server set below."
|
||||||
|
},
|
||||||
|
"dcsLuaRunner.runInMissionEnv": {
|
||||||
|
"type": "boolean",
|
||||||
|
"default": true,
|
||||||
|
"description": "Execute in mission or GUI Scripting Environment."
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"menus": {
|
"menus": {
|
||||||
"editor/title/run": [
|
"editor/title": [
|
||||||
{
|
{
|
||||||
"command": "dcs-lua-runner.run-file-mission",
|
"command": "dcs-lua-runner.run-file",
|
||||||
"group": "navigation@0",
|
"group": "navigation@3",
|
||||||
"when": "editorLangId == lua"
|
"when": "editorLangId == lua"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"command": "dcs-lua-runner.run-file-hooks",
|
"command": "dcs-lua-runner.set-local-button",
|
||||||
"group": "navigation@1",
|
"when": "editorLangId == lua && config.dcsLuaRunner.runCodeLocally == false",
|
||||||
"when": "editorLangId == lua"
|
"group": "navigation@0"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.set-remote-button",
|
||||||
|
"when": "editorLangId == lua && config.dcsLuaRunner.runCodeLocally == true",
|
||||||
|
"group": "navigation@0"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.set-missionEnv-button",
|
||||||
|
"when": "editorLangId == lua && config.dcsLuaRunner.runInMissionEnv == false",
|
||||||
|
"group": "navigation@1"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.set-guiEnv-button",
|
||||||
|
"when": "editorLangId == lua && config.dcsLuaRunner.runInMissionEnv == true",
|
||||||
|
"group": "navigation@1"
|
||||||
}
|
}
|
||||||
]
|
],
|
||||||
|
"editor/context": [
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.run-selected",
|
||||||
|
"group": "navigation",
|
||||||
|
"when": "editorLangId == lua && editorHasSelection"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"commandPalette": [
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.run-file",
|
||||||
|
"when": "editorLangId == lua"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.run-selected",
|
||||||
|
"when": "editorLangId == lua && editorHasSelection"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.set-local-button",
|
||||||
|
"when": "false"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.set-remote-button",
|
||||||
|
"when": "false"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.set-missionEnv-button",
|
||||||
|
"when": "false"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.set-guiEnv-button",
|
||||||
|
"when": "false"
|
||||||
|
}
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"commands": [
|
"commands": [
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.open-settings",
|
||||||
|
"title": "DCS Lua: Open Runner Settings"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"command": "dcs-lua-runner.get-theatre",
|
"command": "dcs-lua-runner.get-theatre",
|
||||||
"group": "navigation@0",
|
"group": "navigation@0",
|
||||||
"title": "DCS Lua: Get Mission Theatre"
|
"title": "DCS Lua: Get Mission Theatre"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"command": "dcs-lua-runner.run-file-mission",
|
"command": "dcs-lua-runner.run-file",
|
||||||
"group": "navigation@1",
|
"group": "navigation@1",
|
||||||
"title": "DCS Lua: Run Current File in Mission Environment",
|
"title": "DCS Lua: Run Current File",
|
||||||
"icon": "$(run)"
|
"icon": "$(run)"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"command": "dcs-lua-runner.run-file-hooks",
|
"command": "dcs-lua-runner.run-selected",
|
||||||
"group": "navigation@2",
|
"title": "DCS Lua: Run Selected Code"
|
||||||
"title": "DCS Lua: Run Current File in Hooks Environment",
|
},
|
||||||
"icon": "$(debug-coverage)"
|
{
|
||||||
|
"command": "dcs-lua-runner.set-local",
|
||||||
|
"title": "DCS Lua: Set Run Code on Local Machine"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.set-local-button",
|
||||||
|
"title": "DCS: Remote"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.set-remote",
|
||||||
|
"title": "DCS Lua: Set Run Code on Remote Server"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.set-remote-button",
|
||||||
|
"title": "DCS: Local"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.set-missionEnv",
|
||||||
|
"title": "DCS Lua: Set Run Code in Mission Environment"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.set-missionEnv-button",
|
||||||
|
"title": "Env: GUI"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.set-guiEnv",
|
||||||
|
"title": "DCS Lua: Set Run Code in GUI Environment"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"command": "dcs-lua-runner.set-guiEnv-button",
|
||||||
|
"title": "Env: Mission"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|||||||
@ -3,16 +3,18 @@ import axios from 'axios';
|
|||||||
import * as fs from 'fs';
|
import * as fs from 'fs';
|
||||||
import * as path from 'path';
|
import * as path from 'path';
|
||||||
|
|
||||||
async function runLua(lua: string, outputChannel: vscode.OutputChannel, filename: string = 'none', portOffset: boolean = false) {
|
async function runLua(lua: string, outputChannel: vscode.OutputChannel, filename: string = 'none') {
|
||||||
const lua_base64 = Buffer.from(lua).toString('base64');
|
const lua_base64 = Buffer.from(lua).toString('base64');
|
||||||
const config = vscode.workspace.getConfiguration('dcsLuaRunner');
|
const config = vscode.workspace.getConfiguration('dcsLuaRunner');
|
||||||
const serverAddress = config.get('serverAddress') as string;
|
const runCodeLocally = config.get('runCodeLocally') as boolean;
|
||||||
const serverPort = config.get('serverPort') as number + (portOffset ? 1 : 0);
|
const runInMissionEnv = config.get('runInMissionEnv') as boolean;
|
||||||
const useHttps = config.get('useHttps') as boolean;
|
const serverAddress = runCodeLocally ? '127.0.0.1' : config.get('serverAddress') as string;
|
||||||
|
const serverPort = runCodeLocally ? 12080 : config.get('serverPort') as number + (runInMissionEnv ? 0 : 1);
|
||||||
|
const useHttps = runCodeLocally ? false : config.get('useHttps') as boolean;
|
||||||
const authUsername = config.get('webAuthUsername') as string;
|
const authUsername = config.get('webAuthUsername') as string;
|
||||||
const authPassword = config.get('webAuthPassword') as string;
|
const authPassword = config.get('webAuthPassword') as string;
|
||||||
const protocol = useHttps ? 'https' : 'http';
|
const protocol = useHttps ? 'https' : 'http';
|
||||||
const prefix = portOffset ? 'Hooks' : 'Mission';
|
const envName = runInMissionEnv ? 'Mission' : 'GUI';
|
||||||
try {
|
try {
|
||||||
const response = await axios.get(`${protocol}://${serverAddress}:${serverPort}/${lua_base64}?env=default`, {
|
const response = await axios.get(`${protocol}://${serverAddress}:${serverPort}/${lua_base64}?env=default`, {
|
||||||
auth: {
|
auth: {
|
||||||
@ -24,14 +26,14 @@ async function runLua(lua: string, outputChannel: vscode.OutputChannel, filename
|
|||||||
|
|
||||||
outputChannel.show(true);
|
outputChannel.show(true);
|
||||||
if (response.data.hasOwnProperty('result')) {
|
if (response.data.hasOwnProperty('result')) {
|
||||||
outputChannel.appendLine(`[DCS] ${new Date().toLocaleString()} (${filename} > ${prefix}):\n${JSON.stringify(response.data.result, null, 2)}`);
|
outputChannel.appendLine(`[DCS] ${new Date().toLocaleString()} (${envName}@${serverAddress}:${serverPort} <- ${filename}):\n${JSON.stringify(response.data.result, null, 2)}`);
|
||||||
} else {
|
} else {
|
||||||
outputChannel.appendLine(`[DCS] ${new Date().toLocaleString()} (${filename} > ${prefix}):\nResult not found in response.`);
|
outputChannel.appendLine(`[DCS] ${new Date().toLocaleString()} (${envName}@${serverAddress}:${serverPort} <- ${filename}):\n<NO RETURN VALUE>`);
|
||||||
}
|
}
|
||||||
} catch (error: any) {
|
} catch (error: any) {
|
||||||
if (error.response && error.response.status === 500) {
|
if (error.response && error.response.status === 500) {
|
||||||
vscode.window.showErrorMessage('Internal server error occurred.');
|
vscode.window.showErrorMessage('Internal server error occurred.');
|
||||||
outputChannel.appendLine(`[DCS] ${new Date().toLocaleString()} (${filename} > ${prefix}):\n${JSON.stringify(error.response.data.error, null, 2)}`);
|
outputChannel.appendLine(`[DCS] ${new Date().toLocaleString()} (${envName}@${serverAddress}:${serverPort} <- ${filename}):\n${JSON.stringify(error.response.data.error, null, 2)}`);
|
||||||
} else {
|
} else {
|
||||||
vscode.window.showErrorMessage(`Error: ${error}`);
|
vscode.window.showErrorMessage(`Error: ${error}`);
|
||||||
}
|
}
|
||||||
@ -56,14 +58,18 @@ function getCurrentFileLua() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export function activate(context: vscode.ExtensionContext) {
|
export function activate(context: vscode.ExtensionContext) {
|
||||||
let outputChannel = vscode.window.createOutputChannel("DCS Return");
|
let outputChannel = vscode.window.createOutputChannel("DCS Lua Runner");
|
||||||
|
|
||||||
|
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.open-settings', () => {
|
||||||
|
vscode.commands.executeCommand('workbench.action.openSettings', 'dcsLuaRunner');
|
||||||
|
}));
|
||||||
|
|
||||||
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.get-theatre', async () => {
|
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.get-theatre', async () => {
|
||||||
const lua = 'return env.mission.theatre';
|
const lua = 'return env.mission.theatre';
|
||||||
await runLua(lua, outputChannel, 'env.mission.theatre');
|
await runLua(lua, outputChannel, 'env.mission.theatre');
|
||||||
}));
|
}));
|
||||||
|
|
||||||
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.run-file-mission', async () => {
|
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.run-file', async () => {
|
||||||
const currentFileLua = getCurrentFileLua();
|
const currentFileLua = getCurrentFileLua();
|
||||||
if (currentFileLua) {
|
if (currentFileLua) {
|
||||||
const { lua, filename } = currentFileLua;
|
const { lua, filename } = currentFileLua;
|
||||||
@ -71,13 +77,57 @@ export function activate(context: vscode.ExtensionContext) {
|
|||||||
}
|
}
|
||||||
}));
|
}));
|
||||||
|
|
||||||
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.run-file-hooks', async () => {
|
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.run-selected', async () => {
|
||||||
const currentFileLua = getCurrentFileLua();
|
const editor = vscode.window.activeTextEditor;
|
||||||
if (currentFileLua) {
|
if (editor && editor.selection) {
|
||||||
const { lua, filename } = currentFileLua;
|
const document = editor.document;
|
||||||
await runLua(lua, outputChannel, filename, true);
|
const selection = editor.selection;
|
||||||
|
const lua = document.getText(selection);
|
||||||
|
const start = selection.start.line + 1;
|
||||||
|
const end = selection.end.line + 1;
|
||||||
|
const lineNumbers = start === end ? start : `${start}-${end}`;
|
||||||
|
const filename = path.basename(document.uri.fsPath) + ':' + lineNumbers;
|
||||||
|
await runLua(lua, outputChannel, filename);
|
||||||
}
|
}
|
||||||
}));
|
}));
|
||||||
|
|
||||||
|
const displayRunTarget = () => {
|
||||||
|
const config = vscode.workspace.getConfiguration('dcsLuaRunner');
|
||||||
|
const runCodeLocally = config.get('runCodeLocally') as boolean;
|
||||||
|
const runInMissionEnv = config.get('runInMissionEnv') as boolean;
|
||||||
|
const runTarget = runCodeLocally ? 'local machine' : 'remote server';
|
||||||
|
const runEnv = runInMissionEnv ? 'mission' : 'GUI';
|
||||||
|
const serverAddress = runCodeLocally ? '127.0.0.1' : config.get('serverAddress') as string;
|
||||||
|
const serverPort = runCodeLocally ? 12080 : config.get('serverPort') as number + (runInMissionEnv ? 0 : 1);
|
||||||
|
outputChannel.show(true);
|
||||||
|
outputChannel.appendLine(`[DCS] Settings: Run code in ${runEnv} environment on ${runTarget} (${serverAddress}:${serverPort}).`);
|
||||||
|
};
|
||||||
|
|
||||||
|
const updateSetting = async (setting: string, targetState: boolean) => {
|
||||||
|
const config = vscode.workspace.getConfiguration('dcsLuaRunner');
|
||||||
|
if (setting === 'runCodeLocally' && targetState === false && config.get('serverAddress') === '') {
|
||||||
|
vscode.window.showErrorMessage('Remote DCS server address not set.', 'Open Settings').then((choice) => {
|
||||||
|
if (choice === 'Open Settings') {
|
||||||
|
vscode.commands.executeCommand('workbench.action.openSettings', 'dcsLuaRunner');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
await config.update(setting, true, vscode.ConfigurationTarget.Global);
|
||||||
|
return;
|
||||||
|
} else {
|
||||||
|
await config.update(setting, targetState, vscode.ConfigurationTarget.Global);
|
||||||
|
displayRunTarget();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.set-local', () => updateSetting('runCodeLocally', true)));
|
||||||
|
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.set-local-button', () => updateSetting('runCodeLocally', true)));
|
||||||
|
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.set-remote', () => updateSetting('runCodeLocally', false)));
|
||||||
|
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.set-remote-button', () => updateSetting('runCodeLocally', false)));
|
||||||
|
|
||||||
|
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.set-missionEnv', () => updateSetting('runInMissionEnv', true)));
|
||||||
|
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.set-missionEnv-button', () => updateSetting('runInMissionEnv', true)));
|
||||||
|
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.set-guiEnv', () => updateSetting('runInMissionEnv', false)));
|
||||||
|
context.subscriptions.push(vscode.commands.registerCommand('dcs-lua-runner.set-guiEnv-button', () => updateSetting('runInMissionEnv', false)));
|
||||||
|
|
||||||
// Update the 'luaFileActive' context when the active editor changes
|
// Update the 'luaFileActive' context when the active editor changes
|
||||||
vscode.window.onDidChangeActiveTextEditor(editor => {
|
vscode.window.onDidChangeActiveTextEditor(editor => {
|
||||||
|
|||||||
642
src/hooks/dcs-fiddle-server.lua
Normal file
642
src/hooks/dcs-fiddle-server.lua
Normal file
@ -0,0 +1,642 @@
|
|||||||
|
FIDDLE = {}
|
||||||
|
|
||||||
|
-- Configs:
|
||||||
|
FIDDLE.PORT = 12080 -- keep this at 12080 if you also want to use the DCS Fiddle website.
|
||||||
|
FIDDLE.AUTH = true -- set to true to enable basic auth, recommended for public servers.
|
||||||
|
FIDDLE.USERNAME = 'username'
|
||||||
|
FIDDLE.PASSWORD = 'password'
|
||||||
|
FIDDLE.BIND_IP = '0.0.0.0' -- for remote access
|
||||||
|
FIDDLE.BYPASS_LOCAL = true -- allow requests to 127.0.0.1:12080 without auth, so DCS Fiddle website can still work. (Not a very secure implementation. Use at your own risk if your 12080 port is public)
|
||||||
|
|
||||||
|
--[[
|
||||||
|
base64 -- v1.5.3 public domain Lua base64 encoder/decoder
|
||||||
|
no warranty implied; use at your own risk
|
||||||
|
Needs bit32.extract function. If not present it's implemented using BitOp
|
||||||
|
or Lua 5.3 native bit operators. For Lua 5.1 fallbacks to pure Lua
|
||||||
|
implementation inspired by Rici Lake's post:
|
||||||
|
http://ricilake.blogspot.co.uk/2007/10/iterating-bits-in-lua.html
|
||||||
|
author: Ilya Kolbin (iskolbin@gmail.com)
|
||||||
|
url: github.com/iskolbin/lbase64
|
||||||
|
COMPATIBILITY
|
||||||
|
Lua 5.1+, LuaJIT
|
||||||
|
LICENSE
|
||||||
|
See end of file for license information.
|
||||||
|
--]]
|
||||||
|
|
||||||
|
local base64 = {}
|
||||||
|
|
||||||
|
local extract = _G.bit32 and _G.bit32.extract -- Lua 5.2/Lua 5.3 in compatibility mode
|
||||||
|
if not extract then
|
||||||
|
if _G.bit then
|
||||||
|
-- LuaJIT
|
||||||
|
local shl, shr, band = _G.bit.lshift, _G.bit.rshift, _G.bit.band
|
||||||
|
extract = function(v, from, width)
|
||||||
|
return band(shr(v, from), shl(1, width) - 1)
|
||||||
|
end
|
||||||
|
elseif _G._VERSION == "Lua 5.1" then
|
||||||
|
extract = function(v, from, width)
|
||||||
|
local w = 0
|
||||||
|
local flag = 2 ^ from
|
||||||
|
for i = 0, width - 1 do
|
||||||
|
local flag2 = flag + flag
|
||||||
|
if v % flag2 >= flag then
|
||||||
|
w = w + 2 ^ i
|
||||||
|
end
|
||||||
|
flag = flag2
|
||||||
|
end
|
||||||
|
return w
|
||||||
|
end
|
||||||
|
else
|
||||||
|
-- Lua 5.3+
|
||||||
|
extract = load [[return function( v, from, width )
|
||||||
|
return ( v >> from ) & ((1 << width) - 1)
|
||||||
|
end]]()
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
function base64.makeencoder(s62, s63, spad)
|
||||||
|
local encoder = {}
|
||||||
|
for b64code, char in pairs { [0] = 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J',
|
||||||
|
'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y',
|
||||||
|
'Z', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n',
|
||||||
|
'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2',
|
||||||
|
'3', '4', '5', '6', '7', '8', '9', s62 or '+', s63 or '/', spad or '=' } do
|
||||||
|
encoder[b64code] = char:byte()
|
||||||
|
end
|
||||||
|
return encoder
|
||||||
|
end
|
||||||
|
|
||||||
|
function base64.makedecoder(s62, s63, spad)
|
||||||
|
local decoder = {}
|
||||||
|
for b64code, charcode in pairs(base64.makeencoder(s62, s63, spad)) do
|
||||||
|
decoder[charcode] = b64code
|
||||||
|
end
|
||||||
|
return decoder
|
||||||
|
end
|
||||||
|
|
||||||
|
local DEFAULT_ENCODER = base64.makeencoder()
|
||||||
|
local DEFAULT_DECODER = base64.makedecoder()
|
||||||
|
|
||||||
|
local char, concat = string.char, table.concat
|
||||||
|
|
||||||
|
function base64.encode(str, encoder, usecaching)
|
||||||
|
encoder = encoder or DEFAULT_ENCODER
|
||||||
|
local t, k, n = {}, 1, #str
|
||||||
|
local lastn = n % 3
|
||||||
|
local cache = {}
|
||||||
|
for i = 1, n - lastn, 3 do
|
||||||
|
local a, b, c = str:byte(i, i + 2)
|
||||||
|
local v = a * 0x10000 + b * 0x100 + c
|
||||||
|
local s
|
||||||
|
if usecaching then
|
||||||
|
s = cache[v]
|
||||||
|
if not s then
|
||||||
|
s = char(encoder[extract(v, 18, 6)], encoder[extract(v, 12, 6)], encoder[extract(v, 6, 6)], encoder[extract(v, 0, 6)])
|
||||||
|
cache[v] = s
|
||||||
|
end
|
||||||
|
else
|
||||||
|
s = char(encoder[extract(v, 18, 6)], encoder[extract(v, 12, 6)], encoder[extract(v, 6, 6)], encoder[extract(v, 0, 6)])
|
||||||
|
end
|
||||||
|
t[k] = s
|
||||||
|
k = k + 1
|
||||||
|
end
|
||||||
|
if lastn == 2 then
|
||||||
|
local a, b = str:byte(n - 1, n)
|
||||||
|
local v = a * 0x10000 + b * 0x100
|
||||||
|
t[k] = char(encoder[extract(v, 18, 6)], encoder[extract(v, 12, 6)], encoder[extract(v, 6, 6)], encoder[64])
|
||||||
|
elseif lastn == 1 then
|
||||||
|
local v = str:byte(n) * 0x10000
|
||||||
|
t[k] = char(encoder[extract(v, 18, 6)], encoder[extract(v, 12, 6)], encoder[64], encoder[64])
|
||||||
|
end
|
||||||
|
return concat(t)
|
||||||
|
end
|
||||||
|
|
||||||
|
function base64.decode(b64, decoder, usecaching)
|
||||||
|
decoder = decoder or DEFAULT_DECODER
|
||||||
|
local pattern = '[^%w%+%/%=]'
|
||||||
|
if decoder then
|
||||||
|
local s62, s63
|
||||||
|
for charcode, b64code in pairs(decoder) do
|
||||||
|
if b64code == 62 then
|
||||||
|
s62 = charcode
|
||||||
|
elseif b64code == 63 then
|
||||||
|
s63 = charcode
|
||||||
|
end
|
||||||
|
end
|
||||||
|
pattern = ('[^%%w%%%s%%%s%%=]'):format(char(s62), char(s63))
|
||||||
|
end
|
||||||
|
b64 = b64:gsub(pattern, '')
|
||||||
|
local cache = usecaching and {}
|
||||||
|
local t, k = {}, 1
|
||||||
|
local n = #b64
|
||||||
|
local padding = b64:sub(-2) == '==' and 2 or b64:sub(-1) == '=' and 1 or 0
|
||||||
|
for i = 1, padding > 0 and n - 4 or n, 4 do
|
||||||
|
local a, b, c, d = b64:byte(i, i + 3)
|
||||||
|
local s
|
||||||
|
if usecaching then
|
||||||
|
local v0 = a * 0x1000000 + b * 0x10000 + c * 0x100 + d
|
||||||
|
s = cache[v0]
|
||||||
|
if not s then
|
||||||
|
local v = decoder[a] * 0x40000 + decoder[b] * 0x1000 + decoder[c] * 0x40 + decoder[d]
|
||||||
|
s = char(extract(v, 16, 8), extract(v, 8, 8), extract(v, 0, 8))
|
||||||
|
cache[v0] = s
|
||||||
|
end
|
||||||
|
else
|
||||||
|
local v = decoder[a] * 0x40000 + decoder[b] * 0x1000 + decoder[c] * 0x40 + decoder[d]
|
||||||
|
s = char(extract(v, 16, 8), extract(v, 8, 8), extract(v, 0, 8))
|
||||||
|
end
|
||||||
|
t[k] = s
|
||||||
|
k = k + 1
|
||||||
|
end
|
||||||
|
if padding == 1 then
|
||||||
|
local a, b, c = b64:byte(n - 3, n - 1)
|
||||||
|
local v = decoder[a] * 0x40000 + decoder[b] * 0x1000 + decoder[c] * 0x40
|
||||||
|
t[k] = char(extract(v, 16, 8), extract(v, 8, 8))
|
||||||
|
elseif padding == 2 then
|
||||||
|
local a, b = b64:byte(n - 3, n - 2)
|
||||||
|
local v = decoder[a] * 0x40000 + decoder[b] * 0x1000
|
||||||
|
t[k] = char(extract(v, 16, 8))
|
||||||
|
end
|
||||||
|
return concat(t)
|
||||||
|
end
|
||||||
|
|
||||||
|
--[[
|
||||||
|
------------------------------------------------------------------------------
|
||||||
|
This software is available under 2 licenses -- choose whichever you prefer.
|
||||||
|
------------------------------------------------------------------------------
|
||||||
|
ALTERNATIVE A - MIT License
|
||||||
|
Copyright (c) 2018 Ilya Kolbin
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||||
|
of the Software, and to permit persons to whom the Software is furnished to do
|
||||||
|
so, subject to the following conditions:
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
|
------------------------------------------------------------------------------
|
||||||
|
ALTERNATIVE B - Public Domain (www.unlicense.org)
|
||||||
|
This is free and unencumbered software released into the public domain.
|
||||||
|
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this
|
||||||
|
software, either in source code form or as a compiled binary, for any purpose,
|
||||||
|
commercial or non-commercial, and by any means.
|
||||||
|
In jurisdictions that recognize copyright laws, the author or authors of this
|
||||||
|
software dedicate any and all copyright interest in the software to the public
|
||||||
|
domain. We make this dedication for the benefit of the public at large and to
|
||||||
|
the detriment of our heirs and successors. We intend this dedication to be an
|
||||||
|
overt act of relinquishment in perpetuity of all present and future rights to
|
||||||
|
this software under copyright law.
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
||||||
|
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||||
|
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
------------------------------------------------------------------------------
|
||||||
|
--]]
|
||||||
|
|
||||||
|
local function dumpt(t)
|
||||||
|
if type(t) == 'table' then
|
||||||
|
local s = '{ '
|
||||||
|
for k, v in pairs(t) do
|
||||||
|
if type(k) ~= 'number' then
|
||||||
|
k = '"' .. k .. '"'
|
||||||
|
end
|
||||||
|
s = s .. '[' .. k .. '] = ' .. dumpt(v) .. ','
|
||||||
|
end
|
||||||
|
return s .. '} '
|
||||||
|
else
|
||||||
|
return tostring(t)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
--- Logger
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
local __debug = function(message)
|
||||||
|
local message = '[dcs-fiddle-server] - ' .. message
|
||||||
|
if (log and log.debug) then
|
||||||
|
log.debug(message)
|
||||||
|
else
|
||||||
|
print('DEBUG - ' .. message)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
local __info = function(message)
|
||||||
|
local message = '[dcs-fiddle-server] - ' .. message
|
||||||
|
if (log and log.info) then
|
||||||
|
log.info(message)
|
||||||
|
else
|
||||||
|
print('INFO - ' .. message)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
local __error = function(message)
|
||||||
|
local message = '[dcs-fiddle-server] - ' .. message
|
||||||
|
if (log and log.error) then
|
||||||
|
log.error(message)
|
||||||
|
else
|
||||||
|
print('ERROR - ' .. message)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
--- DCS Instruction Handler
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
local IS_DCS = false
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
--- Takes a LUA string, executes it and returns the result as a JSON string
|
||||||
|
---@param env string Environment to run the lua string within
|
||||||
|
---
|
||||||
|
local function handle_request(luastring, env)
|
||||||
|
__info("[handle_request] - Handling request to execute string in " .. env)
|
||||||
|
|
||||||
|
if (env ~= "default") then
|
||||||
|
__info("[handle_request] - Executing string via dostring_in")
|
||||||
|
local str, err = net.dostring_in(env, luastring)
|
||||||
|
if (err) then
|
||||||
|
__error(string.format("Error while executing string in %s\n%s", env, str))
|
||||||
|
end
|
||||||
|
return str
|
||||||
|
else
|
||||||
|
__info("[handle_request] - Loading LUA String...")
|
||||||
|
local loaded = assert(loadstring(luastring))
|
||||||
|
|
||||||
|
__info("[handle_request] - Executing LUA String...")
|
||||||
|
local result = loaded()
|
||||||
|
|
||||||
|
__info("[handle_request] - Processing result...")
|
||||||
|
return result
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
--- Url
|
||||||
|
--- https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_is_a_URL
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
--- Parses the given url and returns a URL table
|
||||||
|
---
|
||||||
|
--- `{ parameters={sort="asc", size=20}, path="/employees" }`
|
||||||
|
---
|
||||||
|
--- @param original_url string - The Original Request URL i.e. `/employees?sort=asc&size=20`
|
||||||
|
--- @return string, table Returns the path part alongside a table of parsed parameters
|
||||||
|
---
|
||||||
|
local function parse_url(original_url)
|
||||||
|
local resource_path, parameters = original_url:match('(.+)?(.*)')
|
||||||
|
if (parameters) then
|
||||||
|
local params = {}
|
||||||
|
for parameter in string.gmatch(parameters, "[^&]+") do
|
||||||
|
local name, value = parameter:match('(.+)=(.+)')
|
||||||
|
params[name] = value
|
||||||
|
end
|
||||||
|
|
||||||
|
return resource_path, params
|
||||||
|
end
|
||||||
|
return original_url
|
||||||
|
end
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
--- HTTP Receiver
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
--- Reads HTTP Message from the given connection
|
||||||
|
---
|
||||||
|
--- @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Messages
|
||||||
|
--- @see https://lunarmodules.github.io/luasocket/tcp.html#accept
|
||||||
|
--- @param client socket.client LUA Socket Lib Client
|
||||||
|
--- @return table, number Request table containing method, original_url, protocol, path, parameters, body, headers. Optionally returns a second item representing an error_code from the match_headers failing
|
||||||
|
local function receive_http(client)
|
||||||
|
local request = {}
|
||||||
|
__debug("receiving start-line")
|
||||||
|
local received, err = client:receive("*l")
|
||||||
|
|
||||||
|
if (err) then
|
||||||
|
__error("Failed to get start-line due to " .. err)
|
||||||
|
return
|
||||||
|
end
|
||||||
|
|
||||||
|
__debug("parsing start-line")
|
||||||
|
local method, original_url, protocol = string.match(received, "(%S+) (%S+) (%S+)")
|
||||||
|
request.method = method
|
||||||
|
request.original_url = original_url
|
||||||
|
request.protocol = protocol
|
||||||
|
|
||||||
|
__debug("parsing url")
|
||||||
|
local path, parameters = parse_url(original_url)
|
||||||
|
request.path = path
|
||||||
|
request.parameters = parameters
|
||||||
|
|
||||||
|
request.authOK = false
|
||||||
|
if FIDDLE.AUTH then
|
||||||
|
__debug("parsing headers for auth")
|
||||||
|
local headers = {}
|
||||||
|
while true do
|
||||||
|
local line = client:receive()
|
||||||
|
if not line or line == "" then break end
|
||||||
|
local name, value = line:match("^([^:]+):%s*(.*)$")
|
||||||
|
headers[name] = value
|
||||||
|
end
|
||||||
|
local auth_header = headers["Authorization"]
|
||||||
|
local host_header = headers['X-Forwarded-Host'] or headers["Host"]
|
||||||
|
if FIDDLE.BYPASS_LOCAL and (host_header == '127.0.0.1:12080' or host_header == '127.0.0.1:12081') then
|
||||||
|
request.authOK = true
|
||||||
|
elseif auth_header then
|
||||||
|
local encoded_username_password = auth_header:match("^Basic%s+(.*)$")
|
||||||
|
if encoded_username_password then
|
||||||
|
local decoded_username_password = base64.decode(encoded_username_password)
|
||||||
|
local username, password = decoded_username_password:match("^(.*):(.*)$")
|
||||||
|
-- __info(decoded_username_password)
|
||||||
|
if username == FIDDLE.USERNAME and password == FIDDLE.PASSWORD then
|
||||||
|
-- __info("Auth Passed")
|
||||||
|
request.authOK = true
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
else
|
||||||
|
request.authOK = true
|
||||||
|
end
|
||||||
|
|
||||||
|
__debug("request completed")
|
||||||
|
return request
|
||||||
|
end
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
--- HTTP Sender
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
local EMPTY_LINE = ""
|
||||||
|
local CRLF = "\r\n"
|
||||||
|
|
||||||
|
local status_text = {
|
||||||
|
[100] = "Continue",
|
||||||
|
[101] = "Switching protocols",
|
||||||
|
[102] = "Processing",
|
||||||
|
[103] = "Early Hints",
|
||||||
|
[200] = "OK",
|
||||||
|
[201] = "Created",
|
||||||
|
[202] = "Accepted",
|
||||||
|
[203] = "Non-Authoritative Information",
|
||||||
|
[204] = "No Content",
|
||||||
|
[205] = "Reset Content",
|
||||||
|
[206] = "Partial Content",
|
||||||
|
[207] = "Multi-Status",
|
||||||
|
[208] = "Already Reported",
|
||||||
|
[226] = "IM Used",
|
||||||
|
[300] = "Multiple Choices",
|
||||||
|
[301] = "Moved Permanently",
|
||||||
|
[302] = "Found (Previously \"Moved Temporarily\")",
|
||||||
|
[303] = "See Other",
|
||||||
|
[304] = "Not Modified",
|
||||||
|
[305] = "Use Proxy",
|
||||||
|
[306] = "Switch Proxy",
|
||||||
|
[307] = "Temporary Redirect",
|
||||||
|
[308] = "Permanent Redirect",
|
||||||
|
[400] = "Bad Request",
|
||||||
|
[401] = "Unauthorized",
|
||||||
|
[402] = "Payment Required",
|
||||||
|
[403] = "Forbidden",
|
||||||
|
[404] = "Not Found",
|
||||||
|
[405] = "Method Not Allowed",
|
||||||
|
[406] = "Not Acceptable",
|
||||||
|
[407] = "Proxy Authentication Required",
|
||||||
|
[408] = "Request Timeout",
|
||||||
|
[409] = "Conflict",
|
||||||
|
[410] = "Gone",
|
||||||
|
[411] = "Length Required",
|
||||||
|
[412] = "Precondition Failed",
|
||||||
|
[413] = "Payload Too Large",
|
||||||
|
[414] = "URI Too Long",
|
||||||
|
[415] = "Unsupported Media Type",
|
||||||
|
[416] = "Range Not Satisfiable",
|
||||||
|
[417] = "Expectation Failed",
|
||||||
|
[418] = "I'm a Teapot",
|
||||||
|
[421] = "Misdirected Request",
|
||||||
|
[422] = "Unprocessable Entity",
|
||||||
|
[423] = "Locked",
|
||||||
|
[424] = "Failed Dependency",
|
||||||
|
[425] = "Too Early",
|
||||||
|
[426] = "Upgrade Required",
|
||||||
|
[428] = "Precondition Required",
|
||||||
|
[429] = "Too Many Requests",
|
||||||
|
[431] = "Request Header Fields Too Large",
|
||||||
|
[451] = "Unavailable For Legal Reasons",
|
||||||
|
[500] = "Internal Server Error",
|
||||||
|
[501] = "Not Implemented",
|
||||||
|
[502] = "Bad Gateway",
|
||||||
|
[503] = "Service Unavailable",
|
||||||
|
[504] = "Gateway Timeout",
|
||||||
|
[505] = "HTTP Version Not Supported",
|
||||||
|
[506] = "Variant Also Negotiates",
|
||||||
|
[507] = "Insufficient Storage",
|
||||||
|
[508] = "Loop Detected",
|
||||||
|
[510] = "Not Extended",
|
||||||
|
[511] = "Network Authentication Required"
|
||||||
|
}
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
--- Writes HTTP Message to the given connection using the given response object
|
||||||
|
---
|
||||||
|
--- @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Messages
|
||||||
|
--- @param client client @see https://lunarmodules.github.io/luasocket/tcp.html
|
||||||
|
--- @param response table response table containing 'status' and 'body'
|
||||||
|
local function send_http(client, response)
|
||||||
|
local start_line = table.concat({ "HTTP/1.1", response.status, status_text[response.status] }, " ")
|
||||||
|
|
||||||
|
local headers = { "Server: DCS Fiddle Server HTTP/1.1" }
|
||||||
|
|
||||||
|
for name, value in pairs(response.headers) do
|
||||||
|
table.insert(headers, name .. ": " .. value)
|
||||||
|
end
|
||||||
|
|
||||||
|
local response_string
|
||||||
|
if (response.body) then
|
||||||
|
response_string = table.concat({ start_line, table.concat(headers, CRLF), EMPTY_LINE, response.body }, CRLF)
|
||||||
|
else
|
||||||
|
response_string = table.concat({ start_line, table.concat(headers, CRLF), EMPTY_LINE, EMPTY_LINE }, CRLF)
|
||||||
|
end
|
||||||
|
|
||||||
|
__info("Sending HTTP Response")
|
||||||
|
--__debug(">> " .. response_string)
|
||||||
|
local index, err = client:send(response_string)
|
||||||
|
if (err) then
|
||||||
|
__error("Failed to fully send due to: " .. err)
|
||||||
|
else
|
||||||
|
__info("Successfully sent response")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
--- HTTP Server
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
if (not require or not package) then
|
||||||
|
if (env and env.error) then
|
||||||
|
env.error("DCS Fiddle failed to inject into the mission scripting environment as require or package was not found.\n\nPlease follow the installation docs to de-sanitize the mission scripting environment\nhttps://dcsfiddle.pages.dev/docs", true)
|
||||||
|
return
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
package.path = package.path .. ";.\\LuaSocket\\?.lua"
|
||||||
|
package.cpath = package.cpath .. ";.\\LuaSocket\\?.dll"
|
||||||
|
|
||||||
|
local socket = require("socket")
|
||||||
|
|
||||||
|
local clients = {}
|
||||||
|
local tcp_server
|
||||||
|
|
||||||
|
local server_config = { cors = "*" }
|
||||||
|
|
||||||
|
local client_id_seq = 1
|
||||||
|
|
||||||
|
local OK = 200
|
||||||
|
|
||||||
|
local BAD_REQUEST = 400
|
||||||
|
|
||||||
|
local INTERNAL_SERVER_ERROR = 500
|
||||||
|
local METHOD_NOT_ALLOWED = 405
|
||||||
|
local UNAUTHORIZED = 401
|
||||||
|
|
||||||
|
-----------------------------------------------------------------------------------------------------------------------
|
||||||
|
--- Gets and returns a client id incrementing the sequence
|
||||||
|
local function get_client_id()
|
||||||
|
local id = client_id_seq
|
||||||
|
client_id_seq = client_id_seq + 1
|
||||||
|
return id
|
||||||
|
end
|
||||||
|
|
||||||
|
local function handle_client_connection(client)
|
||||||
|
-- Dictionary of Headers that need to match, failure to match fails the read operation and returns the error code
|
||||||
|
local response = { status = INTERNAL_SERVER_ERROR, headers = { ["Content-Type"] = "application/json"} }
|
||||||
|
|
||||||
|
local request = receive_http(client)
|
||||||
|
|
||||||
|
if (request) then
|
||||||
|
if (request.method ~= "GET") then
|
||||||
|
response.status = METHOD_NOT_ALLOWED
|
||||||
|
elseif not request.authOK then
|
||||||
|
__info("Request Unauthorized")
|
||||||
|
response.status = UNAUTHORIZED
|
||||||
|
else
|
||||||
|
__info("Handling Request")
|
||||||
|
local success, res = pcall(base64.decode, string.sub(request.path, 2))
|
||||||
|
if (not success) then
|
||||||
|
__error("Failed to read input due to " .. res)
|
||||||
|
response.status = BAD_REQUEST
|
||||||
|
else
|
||||||
|
local env = request.parameters and request.parameters.env
|
||||||
|
__info("Processing Command " .. res)
|
||||||
|
local success, res = pcall(handle_request, res, env)
|
||||||
|
if (not success) then
|
||||||
|
__error("Failed to handle request due to \n" .. res)
|
||||||
|
response.body = net.lua2json({error=tostring(res)})
|
||||||
|
response.status = INTERNAL_SERVER_ERROR
|
||||||
|
else
|
||||||
|
__info("Handled request")
|
||||||
|
response.body = net.lua2json({result=res})
|
||||||
|
response.status = OK
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
if (server_config.cors) then
|
||||||
|
response.headers["Access-Control-Allow-Origin"] = server_config.cors
|
||||||
|
end
|
||||||
|
|
||||||
|
send_http(client, response)
|
||||||
|
|
||||||
|
__info("Connection Completed")
|
||||||
|
client:close()
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
local function create_server(address, port)
|
||||||
|
tcp_server = socket.bind(address, port)
|
||||||
|
tcp_server:settimeout(0) -- Make non blocking
|
||||||
|
|
||||||
|
if not tcp_server then
|
||||||
|
__error("Could not bind socket.")
|
||||||
|
end
|
||||||
|
|
||||||
|
local ip, port = tcp_server:getsockname()
|
||||||
|
|
||||||
|
__info("HTTP Server running on " .. ip .. ":" .. port)
|
||||||
|
|
||||||
|
--- Returns function which when called will perform 1 server loop
|
||||||
|
--- Note this impl only allows 1 request to be handled at a time
|
||||||
|
return function()
|
||||||
|
local client = tcp_server:accept()
|
||||||
|
if (client) then
|
||||||
|
local success, res = pcall(handle_client_connection, client)
|
||||||
|
res = res or 'No res'
|
||||||
|
if (not success) then
|
||||||
|
__error("Failed to run client handler " .. res)
|
||||||
|
-- else
|
||||||
|
-- clients[id].receive_patten = res
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
------------------------------------------------------------------------------------------------------------------------
|
||||||
|
--------------------------------------------------- MAIN ---------------------------------------------------------------
|
||||||
|
|
||||||
|
__info("Checking the DCS environment...")
|
||||||
|
|
||||||
|
local isMission = not DCS
|
||||||
|
local port = FIDDLE.PORT or 12080
|
||||||
|
local bind_ip = FIDDLE.BIND_IP or '127.0.0.1'
|
||||||
|
|
||||||
|
if (isMission) then
|
||||||
|
__info("Starting fiddle server in the mission scripting environment...")
|
||||||
|
local loop = create_server(bind_ip, port)
|
||||||
|
|
||||||
|
timer.scheduleFunction(function(arg, time)
|
||||||
|
local success, err = pcall(loop)
|
||||||
|
if not success then
|
||||||
|
__info("loop() error: " .. tostring(err))
|
||||||
|
end
|
||||||
|
return timer.getTime() + .1
|
||||||
|
end, nil, timer.getTime() + .1)
|
||||||
|
|
||||||
|
__info("DCS Fiddle server running")
|
||||||
|
env.info("DCS Fiddle successfully initialized.\n\nHappy Hacking!!", false)
|
||||||
|
trigger.action.outText("DCS Fiddle successfully initialized.", 5)
|
||||||
|
elseif (not isMission) then
|
||||||
|
__info("Starting fiddle server in the Hooks environment...")
|
||||||
|
|
||||||
|
local fiddleFile = lfs.writedir() .. 'Scripts\\Hooks\\dcs-fiddle-server.lua'
|
||||||
|
|
||||||
|
local loop = create_server(bind_ip, port+1)
|
||||||
|
|
||||||
|
local callbacks = {}
|
||||||
|
|
||||||
|
function callbacks.onSimulationStart()
|
||||||
|
__info("Bootstrapping DCS Fiddle inside the mission using file " .. fiddleFile)
|
||||||
|
net.dostring_in("mission", string.format([[a_do_script("dofile('%s')")]], fiddleFile:gsub("\\","/")))
|
||||||
|
end
|
||||||
|
|
||||||
|
function callbacks.onSimulationFrame()
|
||||||
|
loop()
|
||||||
|
end
|
||||||
|
|
||||||
|
DCS.setUserCallbacks(callbacks)
|
||||||
|
|
||||||
|
__info("DCS Fiddle server running")
|
||||||
|
else
|
||||||
|
__info("Failed to start DCS fiddle, unknown environment")
|
||||||
|
end
|
||||||
Loading…
x
Reference in New Issue
Block a user