alex/discord-ollama
1
0
Fork 0
mirror of https://github.com/kevinthedang/discord-ollama.git synced 2025-12-12 11:56:06 -05:00
Code Issues Packages Projects Releases Wiki Activity

User vs Server Preferences (#80)

Browse Source 
* Update: Server vs User prefs

* Add: User vs Server Prefs

* Update: version increment

* Fix: src and tests added to validation range
This commit is contained in:
Kevin Dang
2024-07-04 13:54:25 -07:00
committed by GitHub
parent 7f1326f93e
commit 35b9ad71cb
12 changed files with 130 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/build.yml vendored
View File

@@ -6,6 +6,8 @@ on:
- master
paths:
- '/'
- 'src/**'
- 'tests/**'
- '!docs/**'
- '!imgs/**'
- '!.github/**'

2
.github/workflows/test.yml vendored
View File

@@ -6,6 +6,8 @@ on:
- master
paths:
- '/'
- 'src/**'
- 'tests/**'
- '!docs/**'
- '!imgs/**'
- '!.github/**'

2
docker-compose.yml
View File

@@ -8,7 +8,7 @@ services:
build: ./ # find docker file in designated path
container_name: discord
restart: always # rebuild container always
image: discord/bot:0.5.2
image: discord/bot:0.5.4
environment:
CLIENT_TOKEN: ${CLIENT_TOKEN}
GUILD_ID: ${GUILD_ID}

4
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{
"name": "discord-ollama",
"version": "0.5.2",
"version": "0.5.4",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "discord-ollama",
"version": "0.5.2",
"version": "0.5.4",
"license": "ISC",
"dependencies": {
"discord.js": "^14.15.3",

2
package.json
View File

@@ -1,6 +1,6 @@
{
"name": "discord-ollama",
"version": "0.5.2",
"version": "0.5.4",
"description": "Ollama Integration into discord",
"main": "build/index.js",
"exports": "./build/index.js",

2
src/commands/capacity.ts
View File

@@ -23,7 +23,7 @@ export const Capacity: SlashCommand = {
if (!channel || channel.type !== (ChannelType.PublicThread && ChannelType.GuildText)) return
// set state of bot chat features
openConfig('config.json', interaction.commandName, interaction.options.get('context-capacity')?.value)
openConfig(`${interaction.client.user.username}-config.json`, interaction.commandName, interaction.options.get('context-capacity')?.value)
interaction.reply({
content: `Message History Capacity has been set to \`${interaction.options.get('context-capacity')?.value}\``,

2
src/commands/channelToggle.ts
View File

@@ -24,7 +24,7 @@ export const ChannelToggle: SlashCommand = {
// set state of bot channel preferences
openConfig('config.json', interaction.commandName, interaction.options.get('toggle-channel')?.value)
openConfig(`${interaction.guildId}-config.json`, interaction.commandName, interaction.options.get('toggle-channel')?.value)
interaction.reply({
content: `Channel Preferences have for Regular Channels set to \`${interaction.options.get('toggle-channel')?.value}\``,

2
src/commands/disable.ts
View File

@@ -32,7 +32,7 @@ export const Disable: SlashCommand = {
}
// set state of bot chat features
openConfig('config.json', interaction.commandName, interaction.options.get('enabled')?.value)
openConfig(`${interaction.guildId}-config.json`, interaction.commandName, interaction.options.get('enabled')?.value)
interaction.reply({
content: `Chat features has been \`${interaction.options.get('enabled')?.value ? "enabled" : "disabled" }\``,

2
src/commands/messageStream.ts
View File

@@ -23,7 +23,7 @@ export const MessageStream: SlashCommand = {
if (!channel || channel.type !== (ChannelType.PublicThread && ChannelType.GuildText)) return
// save value to json and write to it
openConfig('config.json', interaction.commandName, interaction.options.get('stream')?.value)
openConfig(`${interaction.client.user.username}-config.json`, interaction.commandName, interaction.options.get('stream')?.value)
interaction.reply({
content: `Message streaming preferences set to: \`${interaction.options.get('stream')?.value}\``,

2
src/commands/messageStyle.ts
View File

@@ -23,7 +23,7 @@ export const MessageStyle: SlashCommand = {
if (!channel || channel.type !== (ChannelType.PublicThread && ChannelType.GuildText)) return
// set the message style
openConfig('config.json', interaction.commandName, interaction.options.get('embed')?.value)
openConfig(`${interaction.client.user.username}-config.json`, interaction.commandName, interaction.options.get('embed')?.value)
interaction.reply({
content: `Message style preferences for embed set to: \`${interaction.options.get('embed')?.value}\``,

48
src/events/messageCreate.ts
View File

@@ -1,30 +1,38 @@
import { embedMessage, event, Events, normalMessage, UserMessage } from '../utils/index.js'
import { Configuration, getChannelInfo, getConfig, getThread, openChannelInfo, openConfig, openThreadInfo } from '../utils/jsonHandler.js'
import { getChannelInfo, getServerConfig, getThread, getUserConfig, openChannelInfo, openConfig, openThreadInfo, ServerConfig, UserConfig } from '../utils/jsonHandler.js'
import { clean } from '../utils/mentionClean.js'
import { TextChannel, ThreadChannel } from 'discord.js'
/**
* Max Message length for free users is 2000 characters (bot or not).
* Bot supports infinite lengths for normal messages.
*
* @param message the message received from the channel
*/
export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama, client }, message) => {
log(`Message \"${clean(message.content)}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)
// Do not respond if bot talks in the chat
if (message.author.tag === message.client.user.tag) return
if (message.author.username === message.client.user.username) return
// Only respond if message mentions the bot
if (!message.mentions.has(tokens.clientUid)) return
// default stream to false
let shouldStream = false
// Try to query and send embed
try {
const config: Configuration = await new Promise((resolve, reject) => {
getConfig('config.json', (config) => {
// Retrieve Server/Guild Preferences
const serverConfig: ServerConfig = await new Promise((resolve, reject) => {
getServerConfig(`${message.guildId}-config.json`, (config) => {
// check if config.json exists
if (config === undefined) {
reject(new Error('No Configuration is set up.\n\nCreating \`config.json\` with \`message-style\` set as \`false\` for regular messages.\nPlease try chatting again.'))
// Allowing chat options to be available
openConfig(`${message.guildId}-config.json`, 'toggle-chat', true)
// default to channel scope chats
openConfig(`${message.guildId}-config.json`, 'channel-toggle', true)
reject(new Error('No Server Preferences is set up.\n\nCreating default server preferences file...\nPlease try chatting again.'))
return
}
@@ -38,10 +46,23 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
if (config.options['channel-toggle']) {
openChannelInfo(message.channelId,
message.channel as TextChannel,
message.author.tag
message.author.username
)
}
resolve(config)
})
})
// Retrieve User Preferences
const userConfig: UserConfig = await new Promise((resolve, reject) => {
getUserConfig(`${message.author.username}-config.json`, (config) => {
if (config === undefined) {
openConfig(`${message.author.username}-config.json`, 'message-style', false)
reject(new Error('No User Preferences is set up.\n\nCreating preferences file with \`message-style\` set as \`false\` for regular messages.\nPlease try chatting again.'))
return
}
// check if there is a set capacity in config
if (typeof config.options['modify-capacity'] !== 'number')
log(`Capacity is undefined, using default capacity of ${msgHist.capacity}.`)
@@ -59,15 +80,17 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
})
})
// need new check for "open/active" threads/channels here!
const chatMessages: UserMessage[] = await new Promise((resolve) => {
// set new queue to modify
if (config.options['channel-toggle']) {
getChannelInfo(`${message.channelId}-${message.author.tag}.json`, (channelInfo) => {
if (serverConfig.options['channel-toggle']) {
getChannelInfo(`${message.channelId}-${message.author.username}.json`, (channelInfo) => {
if (channelInfo?.messages)
resolve(channelInfo.messages)
else
log(`Channel ${message.channel}-${message.author.tag} does not exist.`)
log(`Channel ${message.channel}-${message.author.username} does not exist.`)
})
} else {
getThread(`${message.channelId}.json`, (threadInfo) => {
@@ -95,7 +118,7 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
})
// undefined or false, use normal, otherwise use embed
if (config.options['message-style'])
if (userConfig.options['message-style'])
response = await embedMessage(message, ollama, tokens, msgHist, shouldStream)
else
response = await normalMessage(message, ollama, tokens, msgHist, shouldStream)
@@ -113,7 +136,7 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
})
// only update the json on success
if (config.options['channel-toggle']) {
if (serverConfig.options['channel-toggle']) {
openChannelInfo(message.channelId,
message.channel as TextChannel,
message.author.tag,
@@ -127,7 +150,6 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
}
} catch (error: any) {
msgHist.pop() // remove message because of failure
openConfig('config.json', 'message-style', false)
message.reply(`**Error Occurred:**\n\n**Reason:** *${error.message}*`)
}
})

90
src/utils/jsonHandler.ts
View File

@@ -3,15 +3,39 @@ import { UserMessage } from './events.js'
import fs from 'fs'
import path from 'path'
export interface Configuration {
readonly name: string
options: {
export interface UserConfiguration {
'message-stream'?: boolean,
'message-style'?: boolean,
'modify-capacity': number
}
export interface ServerConfiguration {
'toggle-chat'?: boolean,
'modify-capacity'?: number,
'channel-toggle'?: boolean
}
}
/**
* Parent Configuration interface
*
* @see ServerConfiguration server settings per guild
* @see UserConfiguration user configurations (only for the user for any server)
*/
export interface Configuration {
readonly name: string
options: UserConfiguration | ServerConfiguration
}
/**
* User config to use outside of this file
*/
export interface UserConfig {
readonly name: string
options: UserConfiguration
}
export interface ServerConfig {
readonly name: string
options: ServerConfiguration
}
export interface Thread {
@@ -27,6 +51,14 @@ export interface Channel {
messages: UserMessage[]
}
function isUserConfigurationKey(key: string): key is keyof UserConfiguration {
return ['message-stream', 'message-style', 'modify-capacity'].includes(key);
}
function isServerConfigurationKey(key: string): key is keyof ServerConfiguration {
return ['toggle-chat', 'channel-toggle'].includes(key);
}
/**
* Method to open a file in the working directory and modify/create it
*
@@ -34,27 +66,34 @@ export interface Channel {
* @param key key value to access
* @param value new value to assign
*/
// add type of change (server, user)
export function openConfig(filename: string, key: string, value: any) {
const fullFileName = `data/${filename}`
// check if the file exists, if not then make the config file
if (fs.existsSync(filename)) {
fs.readFile(filename, 'utf8', (error, data) => {
if (fs.existsSync(fullFileName)) {
fs.readFile(fullFileName, 'utf8', (error, data) => {
if (error)
console.log(`[Error: openConfig] Incorrect file format`)
else {
const object = JSON.parse(data)
object['options'][key] = value
fs.writeFileSync(filename, JSON.stringify(object, null, 2))
fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
}
})
} else { // work on dynamic file creation
const object: Configuration = JSON.parse('{ \"name\": \"Discord Ollama Confirgurations\" }')
let object: Configuration
if (isServerConfigurationKey(key))
object = JSON.parse('{ \"name\": \"Server Confirgurations\" }')
else
object = JSON.parse('{ \"name\": \"User Confirgurations\" }')
// set standard information for config file and options
object['options'] = {
[key]: value
}
fs.writeFileSync(filename, JSON.stringify(object, null, 2))
fs.writeFileSync(`data/${filename}`, JSON.stringify(object, null, 2))
console.log(`[Util: openConfig] Created '${filename}' in working directory`)
}
}
@@ -65,10 +104,35 @@ export function openConfig(filename: string, key: string, value: any) {
* @param filename name of the configuration file to get
* @param callback function to allow a promise from getting the config
*/
export async function getConfig(filename: string, callback: (config: Configuration | undefined) => void): Promise<void> {
export async function getServerConfig(filename: string, callback: (config: ServerConfig | undefined) => void): Promise<void> {
const fullFileName = `data/${filename}`
// attempt to read the file and get the configuration
if (fs.existsSync(filename)) {
fs.readFile(filename, 'utf8', (error, data) => {
if (fs.existsSync(fullFileName)) {
fs.readFile(fullFileName, 'utf8', (error, data) => {
if (error) {
callback(undefined)
return // something went wrong... stop
}
callback(JSON.parse(data))
})
} else {
callback(undefined) // file not found
}
}
/**
* Method to obtain the configurations of the message chat/thread
*
* @param filename name of the configuration file to get
* @param callback function to allow a promise from getting the config
*/
export async function getUserConfig(filename: string, callback: (config: UserConfig | undefined) => void): Promise<void> {
const fullFileName = `data/${filename}`
// attempt to read the file and get the configuration
if (fs.existsSync(fullFileName)) {
fs.readFile(fullFileName, 'utf8', (error, data) => {
if (error) {
callback(undefined)
return // something went wrong... stop