0.0.1

resources/[standalone]/oxmysql/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

resources/[standalone]/oxmysql/README.md

@@ -0,0 +1,34 @@
+# oxmysql
+
+A FiveM resource to communicate with a MySQL database using [node-mysql2](https://github.com/sidorares/node-mysql2).
+
+![](https://img.shields.io/github/downloads/overextended/oxmysql/total?logo=github)
+![](https://img.shields.io/github/downloads/overextended/oxmysql/latest/total?logo=github)
+![](https://img.shields.io/github/contributors/overextended/oxmysql?logo=github)
+![](https://img.shields.io/github/v/release/overextended/oxmysql?logo=github) 
+
+## 🔗 Links
+- 💾 [Download](https://github.com/overextended/oxmysql/releases/latest/download/oxmysql.zip)
+  - Download the latest release directly.
+- 📚 [Documentation](https://overextended.dev/oxmysql)
+  - For installation, setup, and everything else.
+- 📦 [npm](https://www.npmjs.com/package/@overextended/oxmysql)
+  - Use our npm package for enhanced functionality and TypeScript support.
+
+## ✨ Features
+
+- Support for mysql-async and ghmattimysql syntax.
+- Promises / async query handling allowing for non-blocking and awaitable responses.
+- Improved performance and stability compared to other options.
+- Support for named and unnamed placeholders, improving performance and security.
+- Support for URI connection strings and semicolon separated values.
+- Improved parameter checking and error handling.
+
+## 🧾 Logging
+
+We have included a module for submitting error logs to [Fivemanage](https://fivemanage.com/?ref=overextended), a cloud management service tailored for game servers. Additional logging options and support for other services will be available in the future.
+
+## Lua Language Server
+
+- Install [Lua Language Server](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) to ease development with annotations, type checking, diagnostics, and more.
+- See [ox_types](https://github.com/overextended/ox_types) for our Lua type definitions.

resources/[standalone]/oxmysql/fxmanifest.lua

@@ -0,0 +1,37 @@
+fx_version 'cerulean'
+game 'common'
+use_experimental_fxv2_oal 'yes'
+lua54 'yes'
+node_version '22'
+
+name 'oxmysql'
+author 'Overextended'
+version '2.14.1'
+license 'LGPL-3.0-or-later'
+repository 'git+https://github.com/overextended/oxmysql.git'
+description 'FXServer to MySQL communication via node-mysql2'
+
+dependencies {
+    '/server:12913',
+}
+
+client_script 'ui.lua'
+server_script 'dist/build.js'
+
+files {
+	'web/build/index.html',
+	'web/build/**/*'
+}
+
+ui_page 'web/build/index.html'
+
+provide 'mysql-async'
+provide 'ghmattimysql'
+
+convar_category 'OxMySQL' {
+	'Configuration',
+	{
+		{ 'Connection string', 'mysql_connection_string', 'CV_STRING', 'mysql://user:password@localhost/database' },
+		{ 'Debug', 'mysql_debug', 'CV_BOOL', 'false' }
+	}
+}

resources/[standalone]/oxmysql/lib/MySQL.lua

@@ -0,0 +1,155 @@
+local promise = promise
+local Await = Citizen.Await
+local resourceName = GetCurrentResourceName()
+local GetResourceState = GetResourceState
+
+local options = {
+	return_callback_errors = false
+}
+
+for i = 1, GetNumResourceMetadata(resourceName, 'mysql_option') do
+	local option = GetResourceMetadata(resourceName, 'mysql_option', i - 1)
+	options[option] = true
+end
+
+local function await(fn, query, parameters)
+	local p = promise.new()
+
+	fn(nil, query, parameters, function(result, error)
+		if error then
+			return p:reject(error)
+		end
+
+		p:resolve(result)
+	end, resourceName, true)
+
+	return Await(p)
+end
+
+local type = type
+local queryStore = {}
+
+local function safeArgs(query, parameters, cb, transaction)
+	local queryType = type(query)
+
+	if queryType == 'number' then
+		query = queryStore[query]
+		assert(query, "First argument received invalid query store reference")
+	elseif transaction then
+		if queryType ~= 'table' then
+			error(("First argument expected table, received '%s'"):format(query))
+		end
+	elseif queryType ~= 'string' then
+		error(("First argument expected string, received '%s'"):format(query))
+	end
+
+	if parameters then
+		local paramType = type(parameters)
+
+		if paramType ~= 'table' and paramType ~= 'function' then
+			error(("Second argument expected table or function, received '%s'"):format(parameters))
+		end
+
+		if paramType == 'function' or parameters.__cfx_functionReference then
+			cb = parameters
+			parameters = nil
+		end
+	end
+
+	if cb and parameters then
+		local cbType = type(cb)
+
+		if cbType ~= 'function' and (cbType == 'table' and not cb.__cfx_functionReference) then
+			error(("Third argument expected function, received '%s'"):format(cb))
+		end
+	end
+
+	return query, parameters, cb
+end
+
+local oxmysql = exports.oxmysql
+
+local mysql_method_mt = {
+	__call = function(self, query, parameters, cb)
+		query, parameters, cb = safeArgs(query, parameters, cb, self.method == 'transaction')
+		return oxmysql[self.method](nil, query, parameters, cb, resourceName, options.return_callback_errors)
+	end
+}
+
+local MySQL = setmetatable(MySQL or {}, {
+	__index = function(_, index)
+		return function(...)
+			return oxmysql[index](nil, ...)
+		end
+	end
+})
+
+for _, method in pairs({
+	'scalar', 'single', 'query', 'insert', 'update', 'prepare', 'transaction', 'rawExecute',
+}) do
+	MySQL[method] = setmetatable({
+		method = method,
+		await = function(query, parameters)
+			query, parameters = safeArgs(query, parameters, nil, method == 'transaction')
+			return await(oxmysql[method], query, parameters)
+		end
+	}, mysql_method_mt)
+end
+
+local alias = {
+	fetchAll = 'query',
+	fetchScalar = 'scalar',
+	fetchSingle = 'single',
+	insert = 'insert',
+	execute = 'update',
+	transaction = 'transaction',
+	prepare = 'prepare'
+}
+
+local alias_mt = {
+	__index = function(self, key)
+		if alias[key] then
+			local method = MySQL[alias[key]]
+			MySQL.Async[key] = method
+			MySQL.Sync[key] = method.await
+			alias[key] = nil
+			return self[key]
+		end
+	end
+}
+
+local function addStore(query, cb)
+	assert(type(query) == 'string', 'The SQL Query must be a string')
+
+	local storeN = #queryStore + 1
+	queryStore[storeN] = query
+
+	return cb and cb(storeN) or storeN
+end
+
+MySQL.Sync = setmetatable({ store = addStore }, alias_mt)
+MySQL.Async = setmetatable({ store = addStore }, alias_mt)
+
+local function onReady(cb)
+	while GetResourceState('oxmysql') ~= 'started' do
+		Wait(50)
+	end
+
+	oxmysql.awaitConnection()
+
+	return cb and cb() or true
+end
+
+MySQL.ready = setmetatable({
+	await = onReady
+}, {
+	__call = function(_, cb)
+		Citizen.CreateThreadNow(function() onReady(cb) end)
+	end,
+})
+
+function MySQL.startTransaction(cb)
+	return oxmysql:startTransaction(cb, resourceName)
+end
+
+_ENV.MySQL = MySQL

resources/[standalone]/oxmysql/logger/fivemanage.js

@@ -0,0 +1,38 @@
+// https://fivemanage.com/?ref=overextended
+
+const apiKey = GetConvar('FIVEMANAGE_LOGS_API_KEY', '');
+
+if (!apiKey) return console.warning(`convar "FIVEMANAGE_LOGS_API_KEY" has not been set`);
+
+const batchedLogs = [];
+const endpoint = 'https://api.fivemanage.com/api/logs/batch';
+const headers = {
+  ['Content-Type']: 'application/json',
+  ['Authorization']: apiKey,
+  ['User-Agent']: 'oxmysql',
+};
+
+async function sendLogs() {
+  try {
+    const body = JSON.stringify(batchedLogs);
+    batchedLogs.length = 0;
+
+    const response = await fetch(endpoint, {
+      method: 'POST',
+      body: body,
+      headers: headers,
+    });
+
+    if (response.ok) return;
+
+    console.error(`Failed to submit logs to fivemanage - ${response.status} ${response.statusText}`);
+  } catch (err) {
+    console.error(err);
+  }
+}
+
+return function logger(data) {
+  if (batchedLogs.length === 0) setTimeout(sendLogs, 500);
+
+  batchedLogs.push(data);
+};

resources/[standalone]/oxmysql/ui.lua

@@ -0,0 +1,24 @@
+RegisterNetEvent('oxmysql:openUi', function(data)
+    SendNUIMessage({
+        action = 'openUI',
+        data = data
+    })
+    SetNuiFocus(true, true)
+end)
+
+RegisterNUICallback('exit', function(_, cb)
+    cb(true)
+    SetNuiFocus(false, false)
+end)
+
+RegisterNUICallback('fetchResource', function(data, cb)
+    TriggerServerEvent('oxmysql:fetchResource', data)
+    cb(true)
+end)
+
+RegisterNetEvent('oxmysql:loadResource', function(data)
+    SendNUIMessage({
+        action = 'loadResource',
+        data = data
+    })
+end)