Tinirau/open-ticket
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Bug fixes for new database system

Browse Source
This commit is contained in:
DJj123dj
2024-11-25 19:24:48 +01:00
parent b22f7b2de7
commit 3e928ed06e
11 changed files with 161 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/api/modules/config.ts
+26 -45
View File
@@ -1,7 +1,7 @@
///////////////////////////////////////
//CONFIG MODULE
///////////////////////////////////////
import { ODId, ODManager, ODManagerData, ODSystemError, ODValidId } from "./base"
import { ODId, ODManager, ODManagerData, ODPromiseVoid, ODSystemError, ODValidId } from "./base"
import nodepath from "path"
import { ODDebugger } from "./console"
import fs from "fs"
@@ -12,51 +12,20 @@ import fs from "fs"
* It manages all config files in the bot and allows plugins to access config files from open ticket & other plugins!
*
* You will use this class to get/add a config file (`ODConfig`) in your plugin!
* @example
* //get ./config/general.json => ODConfig class
* const generalConfig = openticket.configs.get("openticket:general")
*
* //add a new config with id "test" => ./config/test.json
* const testConfig = new api.ODConfig("test","test.json")
* openticket.configs.add(testConfig)
*/
export class ODConfigManager extends ODManager<ODConfig> {
constructor(debug:ODDebugger){
super(debug,"config")
}
/**Add data to the manager. The id will be fetched from the data class! You can optionally select to overwrite existing data!
* @example
* //add a new config with id "test" => ./config/test.json
* const testConfig = new api.ODConfig("test","test.json")
* openticket.configs.add(testConfig)
*/
add(data:ODConfig, overwrite?:boolean): boolean {
return super.add(data,overwrite)
}
/**Get data that matches the `ODId`. Returns the found data.
* @example
* //get "./config/general.json" (ot-general) => ODConfig class
* const generalConfig = openticket.configs.get("openticket:general")
*/
get(id:ODValidId): ODConfig|null {
return super.get(id)
}
/**Remove data that matches the `ODId`. Returns the removed data.
* @example
* //remove the "test" config
* openticket.configs.remove("test") //returns null if non-existing
*/
remove(id:ODValidId): ODConfig|null {
return super.remove(id)
}
/**Check if data that matches the `ODId` exists. Returns a boolean.
* @example
* //check if "./config/general.json" (ot-general) exists => boolean
* const exists = openticket.configs.exists("openticket:general")
*/
exists(id:ODValidId): boolean {
return super.exists(id)
/**Init all config files. */
async init(){
for (const config of this.getAll()){
try{
await config.init()
}catch(err){
process.emit("uncaughtException",new ODSystemError(err))
}
}
}
}
@@ -72,7 +41,17 @@ export class ODConfig extends ODManagerData {
/**The path to the file relative to the main directory. */
path: string = ""
/**An object/array of the entire config file! Variables inside it can be edited while the bot is running! */
data: any = undefined
data: any
constructor(id:ODValidId, data:any){
super(id)
this.data = data
}
/**Init the config. */
init(): ODPromiseVoid {
//nothing
}
}
/**## ODJsonConfig `class`
@@ -90,10 +69,13 @@ export class ODJsonConfig extends ODConfig {
#reloadListeners: Function[] = []
constructor(id:ODValidId, file:string, customPath?:string){
super(id)
super(id,{})
this.file = (file.endsWith(".json")) ? file : file+".json"
this.path = customPath ? nodepath.join("./",customPath,this.file) : nodepath.join("./config/",this.file)
}
/**Init the config. */
init(): ODPromiseVoid {
if (!fs.existsSync(this.path)) throw new ODSystemError("Unable to parse config \""+nodepath.join("./",this.path)+"\", the file doesn't exist!")
try{
this.data = JSON.parse(fs.readFileSync(this.path).toString())
@@ -102,7 +84,6 @@ export class ODJsonConfig extends ODConfig {
throw new ODSystemError("Unable to parse config \""+nodepath.join("./",this.path)+"\"!")
}
}
/**Reload the JSON file. Be aware that this doesn't update classes that used individual parts of the config data! */
reload(){
if (!fs.existsSync(this.path)) throw new ODSystemError("Unable to reload config \""+nodepath.join("./",this.path)+"\", the file doesn't exist!")
src/core/api/modules/database.ts
+39 -82
View File
@@ -1,7 +1,7 @@
///////////////////////////////////////
//DATABASE MODULE
///////////////////////////////////////
import { ODId, ODManager, ODManagerData, ODOptionalPromise, ODSystemError, ODValidId, ODValidJsonType } from "./base"
import { ODId, ODManager, ODManagerData, ODOptionalPromise, ODPromiseVoid, ODSystemError, ODValidId, ODValidJsonType } from "./base"
import fs from "fs"
import nodepath from "path"
import { ODDebugger } from "./console"
@@ -13,51 +13,21 @@ import * as fjs from "formatted-json-stringify"
* It manages all databases in the bot and allows to permanently store data from the bot!
*
* You will use this class to get/add a database (`ODDatabase`) in your plugin!
* @example
* //get ./database/ot-global.json => ODDatabase class
* const globalDB = openticket.databases.get("openticket:global")
*
* //add a new database with id "test" => ./database/idk-test.json
* const testDatabase = new api.ODDatabase("test","idk-test.json")
* openticket.databases.add(testDatabase)
*/
export class ODDatabaseManager extends ODManager<ODDatabase> {
constructor(debug:ODDebugger){
super(debug,"database")
}
/**Add data to the manager. The id will be fetched from the data class! You can optionally select to overwrite existing data!
* @example
* //add a new database with id "test" => ./database/idk-test.json
* const testDatabase = new api.ODDatabase("test","idk-test.json")
* openticket.databases.add(testDatabase)
*/
add(data:ODDatabase, overwrite?:boolean): boolean {
return super.add(data,overwrite)
}
/**Get data that matches the `ODId`. Returns the found data.
* @example
* //get ./database/ot-global.json => ODDatabase class
* const globalDB = openticket.databases.get("openticket:global")
*/
get(id:ODValidId): ODDatabase|null {
return super.get(id)
}
/**Remove data that matches the `ODId`. Returns the removed data.
* @example
* //remove the "test" database
* openticket.databases.remove("test") //returns null if non-existing
*/
remove(id:ODValidId): ODDatabase|null {
return super.remove(id)
}
/**Check if data that matches the `ODId` exists. Returns a boolean.
* @example
* //check if "./database/idk-test.json" (test) exists => boolean
* const exists = openticket.databases.exists("test")
*/
exists(id:ODValidId): boolean {
return super.exists(id)
/**Init all database files. */
async init(){
for (const database of this.getAll()){
try{
await database.init()
}catch(err){
process.emit("uncaughtException",new ODSystemError(err))
}
}
}
}
@@ -66,26 +36,17 @@ export class ODDatabaseManager extends ODManager<ODDatabase> {
* This class doesn't do anything at all, it just gives a template & basic methods for a database. Use `ODJsonDatabase` instead!
*
* You will only use this class if you want to create your own database implementation (e.g. `mongodb`, `mysql`,...)!
* @example
* class SomeDatabase extends ODDatabase {
* //override this method
* setData(category:string, key:string, value:ODValidJsonType): boolean {
* return false
* }
* //override this method
* getData(category:string, key:string): ODValidJsonType|undefined {
* return undefined
* }
* //override this method
* deleteData(category:string, key:string): boolean {
* return false
* }
* }
*/
export class ODDatabase extends ODManagerData {
/**The full path to this database with extension */
/**The name of the file with extension. */
file: string = ""
/**The path to the file relative to the main directory. */
path: string = ""
/**Init the database. */
init(): ODPromiseVoid {
//nothing
}
/**Add/Overwrite a specific category & key in the database. Returns `true` when overwritten. */
set(category:string, key:string, value:ODValidJsonType): ODOptionalPromise<boolean> {
return false
@@ -122,24 +83,19 @@ export type ODJsonDatabaseStructure = {category:string, key:string, value:ODVali
* It stores data in a `json` file as a large `Array` using the `category`, `key`, `value` strategy.
* You can store the following types: `string`, `number`, `boolean`, `array`, `object` & `null`!
*
* You will only use this class if you want to create your own database or use an existing one!
* @example
* //get,set & delete data
* const data = database.getData("category","key") //data will be the value
* const didOverwrite = database.setData("category","key","value") //value can be any of the valid types
* const didExist = database.deleteData("category","key") //delete this value
* //You need an ODJsonDatabase class named "database" for this example to work!
* You will use this class if you want to create your own database or use an existing one!
*/
export class ODJsonDatabase extends ODDatabase {
constructor(id:ODValidId, file:string, customPath?:string){
super(id)
const filename = (file.endsWith(".json")) ? file : file+".json"
this.file = customPath ? nodepath.join("./",customPath,filename) : nodepath.join("./database/",filename)
//init file if it doesn't exist yet
this.#system.getData()
this.file = (file.endsWith(".json")) ? file : file+".json"
this.path = customPath ? nodepath.join("./",customPath,this.file) : nodepath.join("./database/",this.file)
}
/**Init the database. */
init(): ODPromiseVoid {
this.#system.getData()
}
/**Set/overwrite the value of `category` & `key`. Returns `true` when overwritten!
* @example
* const didOverwrite = database.setData("category","key","value") //value can be any of the valid types
@@ -202,21 +158,21 @@ export class ODJsonDatabase extends ODDatabase {
#system = {
/**Read parsed data from the json file */
getData: (): ODJsonDatabaseStructure => {
if (fs.existsSync(this.file)){
if (fs.existsSync(this.path)){
try{
return JSON.parse(fs.readFileSync(this.file).toString())
return JSON.parse(fs.readFileSync(this.path).toString())
}catch(err){
process.emit("uncaughtException",err)
throw new ODSystemError("Unable to read database "+this.file+"! getData() read error. (see error above)")
throw new ODSystemError("Unable to read database "+this.path+"! getData() read error. (see error above)")
}
}else{
fs.writeFileSync(this.file,"[]")
fs.writeFileSync(this.path,"[]")
return []
}
},
/**Write parsed data to the json file */
setData: (data:ODJsonDatabaseStructure) => {
fs.writeFileSync(this.file,JSON.stringify(data,null,"\t"))
fs.writeFileSync(this.path,JSON.stringify(data,null,"\t"))
}
}
}
@@ -236,14 +192,15 @@ export class ODFormattedJsonDatabase extends ODDatabase {
constructor(id:ODValidId, file:string, formatter:fjs.ArrayFormatter, customPath?:string){
super(id)
const filename = (file.endsWith(".json")) ? file : file+".json"
this.file = customPath ? nodepath.join("./",customPath,filename) : nodepath.join("./database/",filename)
this.file = (file.endsWith(".json")) ? file : file+".json"
this.path = customPath ? nodepath.join("./",customPath,this.file) : nodepath.join("./database/",this.file)
this.formatter = formatter
//init file if it doesn't exist yet
this.#system.getData()
}
/**Init the database. */
init(): ODPromiseVoid {
this.#system.getData()
}
/**Set/overwrite the value of `category` & `key`. Returns `true` when overwritten!
* @example
* const didOverwrite = database.setData("category","key","value") //value can be any of the valid types
@@ -306,16 +263,16 @@ export class ODFormattedJsonDatabase extends ODDatabase {
#system = {
/**Read parsed data from the json file */
getData: (): ODJsonDatabaseStructure => {
if (fs.existsSync(this.file)){
return JSON.parse(fs.readFileSync(this.file).toString())
if (fs.existsSync(this.path)){
return JSON.parse(fs.readFileSync(this.path).toString())
}else{
fs.writeFileSync(this.file,"[]")
fs.writeFileSync(this.path,"[]")
return []
}
},
/**Write parsed data to the json file */
setData: (data:ODJsonDatabaseStructure) => {
fs.writeFileSync(this.file,this.formatter.stringify(data))
fs.writeFileSync(this.path,this.formatter.stringify(data))
}
}
}
src/core/api/modules/defaults.ts
+6
View File
@@ -29,8 +29,12 @@ export interface ODDefaults {
flagInitiating:boolean,
/**Load the default open ticket configs. */
configLoading:boolean,
/**Enable the default initializer for open ticket config. */
configInitiating:boolean,
/**Load the default open ticket databases. */
databaseLoading:boolean,
/**Enable the default initializer for open ticket database. */
databaseInitiating:boolean,
/**Load the default open ticket sessions. */
sessionLoading:boolean,
@@ -230,7 +234,9 @@ export class ODDefaultsManager {
flagLoading:true,
flagInitiating:true,
configLoading:true,
configInitiating:true,
databaseLoading:true,
databaseInitiating:true,
sessionLoading:true,
languageLoading:true,