Initial commit

Author: MrMicky-FR

.gitignore

@@ -0,0 +1,11 @@
+# JetBrains
+.idea/
+*.iml
+*.iws
+
+# Visual Studio Code
+.vscode/
+.history
+
+# Mac
+.DS_Store

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Azuriom
+
+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.

README.md

@@ -0,0 +1,19 @@
+# AzLink-GMod
+
+[![Latest release](https://img.shields.io/github/v/release/Azuriom/AzLink-GMod?style=flat-square)](https://github.com/Azuriom/AzLink-GMod/releases)
+[![Chat](https://img.shields.io/discord/625774284823986183?color=5865f2&label=Discord&logo=discord&logoColor=fff&style=flat-square)](https://azuriom.com/discord)
+
+AzLink-GMod is a [Garry's Mod](https://gmod.facepunch.com/) addon to link a Garry's Mod server with Azuriom.
+
+## Download
+
+You can download the plugin on [Azuriom's website](https://azuriom.com/azlink) or in the [GitHub releases](https://github.com/Azuriom/AzLink-GMod/releases).
+
+## Contributing
+
+This project follows the [CFC Glua Style Guidelines](https://github.com/CFC-Servers/cfc_glua_style_guidelines).
+
+## Dependencies
+
+This addon uses [gmsv_serverstat](https://github.com/WilliamVenner/gmsv_serverstat) as an optional dependency to get
+process resources usages.

glualint.json

@@ -0,0 +1,10 @@
+{
+    "lint_unusedParameters": true,
+    "lint_unusedLoopVars": true,
+    "lint_spaceAfterParens": true,
+    "lint_spaceAfterBraces": true,
+    "prettyprint_minimizeParens": true,
+    "prettyprint_spaceAfterParens": true,
+    "prettyprint_spaceAfterBraces": true,
+    "prettyprint_spaceAfterLabel": true
+}

lua/autorun/azlink_autorun.lua

@@ -0,0 +1,8 @@
+if SERVER then
+    include( "azlink/azlink.lua" )
+    include( "azlink/logger/logger.lua" )
+    include( "azlink/fetcher.lua" )
+    include( "azlink/http/http_client.lua" )
+    include( "azlink/http/promise.lua" )
+    include( "azlink/commands/azlink_command.lua" )
+end

lua/azlink/azlink.lua

@@ -0,0 +1,100 @@
+AZLINK_VERSION = "0.1.0" -- TODO
+AzLink = AzLink or { }
+AzLink.lastSent = 0
+AzLink.lastFullSent = 0
+AzLink.config = { }
+
+function AzLink:Fetch( force )
+    local siteKey = AzLink.config.site_key
+    local baseUrl = AzLink.config.url
+    if siteKey == nil or baseUrl == nil or not force and RealTime( ) - AzLink.lastSent < 15 then return end
+    local sendFull = os.date( "*t" ).min % 15 == 0 and RealTime( ) - AzLink.lastFullSent > 60
+    AzLink.lastSent = RealTime( )
+
+    if sendFull then
+        AzLink.lastFullSent = RealTime( )
+    end
+
+    return AzLink.Fetcher:Run( sendFull )
+end
+
+function AzLink:Ping( )
+    local siteKey = AzLink.config.site_key
+    local baseUrl = AzLink.config.url
+    if siteKey == nil or baseUrl == nil then return nil end
+
+    return AzLink.HttpClient:Request( "GET", "", data ):Catch( function( error, status )
+        if status == nil then
+            AzLink.Logger:Error( "Unable to ping: " .. error )
+        else
+            local errorMessage = ( error.message or error ) .. " (" .. status .. ")"
+            AzLink.Logger:Error( "An HTTP error occured during ping: " .. errorMessage )
+        end
+    end )
+end
+
+function AzLink:GetServerData( full )
+    local players = { }
+
+    for _, player in ipairs( player.GetHumans( ) ) do
+        table.insert( players, {
+            ["name"] = player:Nick( ),
+            ["uid"] = player:SteamID64( ),
+        } )
+    end
+
+    local baseData = {
+        ["platform"] = {
+            ["type"] = "GMOD",
+            ["name"] = "Garry's Mod",
+            ["version"] = VERSIONSTR,
+        },
+        ["version"] = AZLINK_VERSION,
+        ["players"] = players,
+        ["maxPlayers"] = game.MaxPlayers( ),
+        ["full"] = full,
+    }
+
+    if not full then return baseData end
+
+    baseData.worlds = {
+        ["entities"] = ents.GetCount( ),
+    }
+
+    if serverstat ~= nil then
+        baseData.system = {
+            ["cpu"] = serverstat.ProcessCPUUsage( ) * 100.0,
+            ["ram"] = serverstat.ProcessMemoryUsage( ),
+        }
+    end
+
+    return baseData
+end
+
+function AzLink:SaveConfig( )
+    file.Write( "azlink/config.json", util.TableToJSON( AzLink.config ) )
+end
+
+MsgN( "[AzLink] Starting AzLink v" .. AZLINK_VERSION .. "..." )
+
+hook.Add( "Initialize", "azlink-init", function( )
+    timer.Create( "azlink-fetcher-task", 60, 0, function( )
+        AzLink:Fetch( )
+    end )
+
+    timer.Start( "azlink-fetcher-task" )
+end )
+
+file.CreateDir( "azlink" )
+local rawConfig = file.Read( "azlink/config.json" )
+
+if rawConfig ~= nil then
+    AzLink.config = util.JSONToTable( rawConfig )
+end
+
+if #file.Find( "lua/bin/gmsv_serverstat*", "GAME" ) == 0 or not pcall( require, "serverstat" ) then
+    MsgN( "[AzLink] Unable to load serverstat, please install the module by following" )
+    MsgN( "these instructions: https://github.com/WilliamVenner/gmsv_serverstat#installation" )
+end
+
+MsgN( "[AzLink] AzLink successfully enabled." )

lua/azlink/commands/azlink_command.lua

@@ -0,0 +1,48 @@
+local function setupAzLink( baseUrl, siteKey )
+    AzLink.config.url = baseUrl
+    AzLink.config.site_key = siteKey
+
+    AzLink:Ping( ):Then( function( )
+        AzLink.Logger:Info( "Linked to the website successfully." )
+        AzLink:SaveConfig( )
+    end )
+end
+
+concommand.Add( "azlink", function( _, _, args )
+    if args[2] == "setup" then
+        if args[3] == nil or args[4] == nil then
+            AzLink.Logger:Error( "Mising URL and/or site key!" )
+
+            return
+        end
+
+        -- TODO find a cleaner way to support column?
+        setupAzLink( args[3]:gsub( "!", ":" ):gsub( "|", "/" ), args[4] )
+
+        return
+    end
+
+    if args[2] == "status" then
+        local promise = AzLink:Ping( )
+
+        if promise == nil then
+            AzLink.Logger:Error( "No URL and/or site key configured yet!" )
+        end
+
+        promise:Then( function( )
+            AzLink.Logger:Info( "Connected to the website successfully." )
+        end )
+
+        return
+    end
+
+    if args[2] == "fetch" then
+        AzLink:Fetch( true ):Then( function( )
+            AzLink.Logger:Info( "Data has been fetched successfully." )
+        end )
+
+        return
+    end
+
+    AzLink.Logger:Info( "Uknown subcommand. Must be 'setup', 'status' or 'fetch'." )
+end )

lua/azlink/fetcher.lua

@@ -0,0 +1,42 @@
+local fetcher = { }
+
+function fetcher:Run( sendFull )
+    local data = AzLink:GetServerData( sendFull )
+
+    return AzLink.HttpClient:Request( "POST", "", data ):Then( function( commands )
+        self:DispatchCommands( commands )
+    end ):Catch( function( error, status )
+        if status == nil then
+            AzLink.Logger:Error( "A connection error occured: " .. error )
+        else
+            local errorMessage = ( error.message or error ) .. " (" .. status .. ")"
+            AzLink.Logger:Error( "An HTTP error occured: " .. errorMessage )
+        end
+    end )
+end
+
+function fetcher:DispatchCommands( data )
+    if not data.commands then return end
+    local total = 0
+
+    for _, commandData in pairs( data.commands ) do
+        local player = player.GetBySteamID64( commandData.uid )
+        local playerName = player and player:Nick( ) or commandData.name
+        local steamId32 = player and player:SteamID() or commandData.steamid_32
+
+        for _, command in pairs( commandData.values ) do
+            local display = playerName .. " (" .. commandData.uid .. ")"
+            local playerCommand = command:gsub( "{player}", playerName )
+            playerCommand = playerCommand:gsub( "{steam_id}", commandData.uid )
+            playerCommand = playerCommand:gsub( "{steam_id_32}", steamId32 )
+            AzLink.Logger:Info( "Dispatching command to " .. display .. ": " .. playerCommand )
+            game.ConsoleCommand( playerCommand .. "\n" )
+        end
+    end
+
+    if total > 0 then
+        AzLink.Logger:Info( "Dispatched commands to " .. total .. " players." )
+    end
+end
+
+AzLink.Fetcher = fetcher

lua/azlink/http/http_client.lua

@@ -0,0 +1,34 @@
+local httpClient = {
+    timeout = 5000
+}
+
+function httpClient:Request( requestMethod, endpoint, data )
+    return AzLink.Promise( function( onResolve, onReject )
+        HTTP( {
+            method = requestMethod,
+            url = AzLink.config.url .. "/api/azlink" .. endpoint,
+            timeout = self.timeout,
+            headers = {
+                ["Azuriom-Link-Token"] = AzLink.config.site_key,
+                ["Accept"] = "application/json",
+                ["User-Agent"] = "AzLink Garry's Mod - v" .. AZLINK_VERSION,
+            },
+            type = "application/json",
+            body = data and util.TableToJSON( data ) or nil,
+            success = function( code, body )
+                body = body and util.JSONToTable( body ) or body
+
+                if code >= 300 then
+                    onReject( body, code )
+
+                    return
+                end
+
+                onResolve( body )
+            end,
+            failed = onReject,
+        } )
+    end )
+end
+
+AzLink.HttpClient = httpClient

lua/azlink/http/promise.lua

@@ -0,0 +1,70 @@
+-- Lua Promise implementation inspired by JavaScript's Promises
+local Promise = { }
+Promise.__index = Promise
+local PENDING = 0
+local RESOLVED = 1
+local REJECTED = -1
+
+function Promise:new( resolver )
+    local target = {
+        state = PENDING,
+        queue = { },
+        handlers = { },
+    }
+
+    setmetatable( target, Promise )
+
+    local resolve = function( ... )
+        if target.state ~= PENDING then return end
+
+        for _, callback in pairs( target.queue ) do
+            callback( ... )
+        end
+
+        target.values = { ... }
+
+        target.state = RESOLVED
+    end
+
+    local reject = function( ... )
+        if target.state ~= PENDING then return end
+
+        for _, callback in pairs( target.handlers ) do
+            callback( ... )
+        end
+
+        target.values = { ... }
+
+        target.state = REJECTED
+    end
+
+    resolver( resolve, reject )
+
+    return target
+end
+
+function Promise:Then( callback )
+    if self.state == PENDING then
+        table.insert( self.queue, callback )
+    elseif self.state == RESOLVED then
+        callback( self.values )
+    end
+
+    return self
+end
+
+function Promise:Catch( callback )
+    if self.state == PENDING then
+        table.insert( self.handlers, callback )
+    elseif self.state == RESOLVED then
+        callback( self.values )
+    end
+
+    return self
+end
+
+setmetatable( Promise, {
+    __call = Promise.new
+} )
+
+AzLink.Promise = Promise