Merge pull request 'refactor-cleanup' (#1) from refactor-cleanup into main

Reviewed-on: #1

.gitea/workflows/deploy.yaml

@@ -0,0 +1,28 @@
+name: Garfbot CI/CD Deployment
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  Deploy:
+    container:
+      volumes:
+        - /home/crate/garfbot:/workspace/crate/garfbot/deploy
+    steps:
+    - name: Pull Garfbot and restart container
+      run: |
+        cd /workspace/crate/garfbot/deploy
+
+        git pull origin main
+        
+        CHANGED=$(git diff --name-only HEAD~1 HEAD)
+        
+        if echo "$CHANGED" | grep -qE "(Dockerfile|requirements\.txt|docker-compose\.yml)"; then
+          docker stop garfbot
+          docker rm garfbot
+          docker build -t git.crate.zip/crate/garfbot:latest .
+          docker run -d --restart always -v $PWD:/usr/src/app --name garfbot git.crate.zip/crate/garfbot:latest
+        else
+          docker restart garfbot
+        fi

.gitignore

@@ -6,3 +6,6 @@ garfpy/__pycache__/
 *.old
 *.log*
 meows.py
+meow_counts.json
+user_stats.json
+responses.json

Dockerfile

@@ -12,5 +12,8 @@ RUN pip3 install discord
 RUN pip3 install openai
 RUN pip3 install aiohttp
 RUN pip3 install requests
+RUN pip3 install wikipedia
+RUN pip3 install pillow
+RUN pip3 install qrcode
 
 CMD [ "python", "garfmain.py" ]

README.md

@@ -16,7 +16,7 @@ Responds with iputils-ping result from target.
 `garfpic {target}`
 Responds with dns lookup result from target.
 
-`garfpic {target}`
+`garfhack {target}`
 Responds with nmap scan result from target.
 
 `garfshop {item} {zip}`
@@ -36,7 +36,6 @@ Add your various API tokens:
 ```python
 GARFBOT_TOKEN = "Discord API token"
 OPENAI_TOKEN = "OpenAI API token"
-GIF_TOKEN = "tenor.com API token"
 ```
 
 I recommend building a docker image using the included DockerFile as a template. Run the container binding /usr/src/app to GarfBot's CWD:

garfmain.py

@@ -1,14 +1,12 @@
 import config
-# import random
 import asyncio
 import discord
 import subprocess
 
 from garfpy import(
     logger, is_private,
-    kroger_token, find_store, search_product,
-    picture_time, process_image_requests, generate_chat,
-    aod_message)
+    aod_message, generate_qr,
+    Kroger, GarfAI, GarfbotRespond)
 
 
 gapikey = config.GIF_TOKEN
@@ -22,11 +20,16 @@ intents.messages = True
 intents.message_content = True
 garfbot = discord.Client(intents=intents)
 
+garf_respond = GarfbotRespond()
+garfield = GarfAI()
+kroger = Kroger()
+
 
 @garfbot.event
 async def on_ready():
     try:
-        asyncio.create_task(process_image_requests())
+        garf_respond.load_responses()
+        asyncio.create_task(garfield.process_image_requests())
         logger.info(f"Logged in as {garfbot.user.name} running {txtmodel} and {imgmodel}.")
     except Exception as e:
         logger.error(e)
@@ -34,41 +37,58 @@ async def on_ready():
 
 @garfbot.event
 async def on_message(message):
+
+    content = message.content.strip()
+    lower = content.lower()
+    user = message.author.name
+    guild = message.guild.name if message.guild else "Direct Message"
+    guild_id = message.guild.id
+
+    # Chats & pics
     if message.author == garfbot.user:
         return
 
-    if message.content.lower().startswith("hey garfield") or isinstance(message.channel, discord.DMChannel):
-        question = message.content[12:] if message.content.lower().startswith("hey garfield") else message.content
-        answer = await generate_chat(question)
+    if lower.startswith("hey garfield") or isinstance(message.channel, discord.DMChannel):
+        prompt = content[12:] if lower.startswith("hey garfield") else message.content
+        answer = await garfield.generate_chat(prompt)
+        logger.info(f"Chat Request - User: {user}, Server: {guild}, Prompt: {prompt}")
         await message.channel.send(answer)
 
-    if message.content.lower().startswith('garfpic '):
-        user = message.author.name
-        server = message.guild.name if message.guild else "Direct Message"
-        prompt = message.content[8:]
-        logger.info(f"Image Request - User: {user}, Server: {server}, Prompt: {prompt}")
+    if lower.startswith('garfpic '):
+        prompt = content[8:]
+        logger.info(f"Image Request - User: {user}, Server: {guild}, Prompt: {prompt}")
         await message.channel.send(f"`Please wait... image generation queued: {prompt}`")
-        await picture_time(message, prompt)
+        await garfield.garfpic(message, prompt)
 
-    # if message.content.lower() == "lasagna":
-    #     await send_gif(message, "garfield lasagna")
+    # Wikipedia
+    if lower.startswith('garfwiki '):
+        query = message.content[9:]
+        summary = await garfield.wikisum(query)
+        await message.channel.send(summary)
 
-    # if message.content.lower() == "monday":
-    #     await send_gif(message, "garfield monday")
-
-    # if message.content.lower().startswith("garfgif "):
-    #     search_term = message.content[8:]
-    #     await send_gif(message, search_term)
-
-    if message.content.lower().startswith("garfping "):
+    # QR codes
+    if lower.startswith('garfqr '):
+        text = message.content[7:]
+        if len(text) > 1000:
+            await message.channel.send("❌ Text too long! Maximum 1000 characters.")
+        else:
             try:
+                qr_code = await generate_qr(text)
+                sendfile = discord.File(fp=qr_code, filename="qrcode.png")
+                await message.channel.send(file=sendfile)
+            except Exception as e:
+                logger.error(e)
+                await message.channel.send(e)
+
+    # IP utils
     query = message.content.split()
-            user = message.author.name
-            server = message.guild.name if message.guild else "Direct Message"
     target = query[-1]
-            logger.info(f"Ping Request - User: {user}, Server: {server}, Target: {target}")
+
+    if lower.startswith("garfping "):
+        try:
+            logger.info(f"Ping Request - User: {user}, Server: {guild}, Target: {target}")
             if is_private(target):
-                rejection = await generate_chat("Hey Garfield, explain to me why I am dumb for trying to hack your private computer network.")
+                rejection = await garfield.generate_chat("Hey Garfield, explain to me why I am dumb for trying to hack your private computer network.")
                 await message.channel.send(rejection)
             else:
                 result = subprocess.run(['ping', '-c', '4', target], capture_output=True, text=True)
@@ -76,15 +96,11 @@ async def on_message(message):
         except Exception as e:
             await message.channel.send(f"`GarfBot Error: {str(e)}`")
 
-    if message.content.lower().startswith("garfdns "):
+    if lower.startswith("garfdns "):
         try:
-            query = message.content.split()
-            user = message.author.name
-            server = message.guild.name if message.guild else "Direct Message"
-            target = query[-1]
-            logger.info(f"NSLookup Request - User: {user}, Server: {server}, Target: {target}")
+            logger.info(f"NSLookup Request - User: {user}, Server: {guild}, Target: {target}")
             if is_private(target):
-                rejection = await generate_chat("Hey Garfield, explain to me why I am dumb for trying to hack your private computer network.")
+                rejection = await garfield.generate_chat("Hey Garfield, explain to me why I am dumb for trying to hack your private computer network.")
                 await message.channel.send(rejection)
             else:
                 result = subprocess.run(['nslookup', target], capture_output=True, text=True)
@@ -92,15 +108,11 @@ async def on_message(message):
         except Exception as e:
             await message.channel.send(f"`GarfBot Error: {str(e)}`")
 
-    if message.content.lower().startswith("garfhack "):
+    if lower.startswith("garfhack "):
         try:
-            query = message.content.split()
-            user = message.author.name
-            server = message.guild.name if message.guild else "Direct Message"
-            target = query[-1]
-            logger.info(f"Nmap Request - User: {user}, Server: {server}, Target: {target}")
+            logger.info(f"Nmap Request - User: {user}, Server: {guild}, Target: {target}")
             if is_private(target):
-                rejection = await generate_chat("Hey Garfield, explain to me why I am dumb for trying to hack your private computer network.")
+                rejection = await garfield.generate_chat("Hey Garfield, explain to me why I am dumb for trying to hack your private computer network.")
                 await message.channel.send(rejection)
             else:
                 await message.channel.send(f"`Scanning {target}...`")
@@ -110,52 +122,32 @@ async def on_message(message):
             await message.channel.send(f"`GarfBot Error: {str(e)}`")
 
     # Kroger Shopping
-    if message.content.lower().startswith("garfshop "):
+    if lower.startswith("garfshop "):
         try:
-            kroken = kroger_token()
-            kroger_query = message.content.split()
-            product = " ".join(kroger_query[1:-1])
-            zipcode = kroger_query[-1]
-            loc_data = find_store(zipcode, kroken)
-            loc_id = loc_data['data'][0]['locationId']
-            store_name = loc_data['data'][0]['name']
-            product_query = search_product(product, loc_id, kroken)
-            products = product_query['data']
-            sorted_products = sorted(products, key=lambda item: item['items'][0]['price']['regular'])
-            response = f"Prices for `{product}` at `{store_name}` near `{zipcode}`:\n"
-            for item in sorted_products:
-                product_name = item['description']
-                price = item['items'][0]['price']['regular']
-                response += f"- `${price}`: {product_name} \n"
+            query = message.content[9:]
+            response = kroger.garfshop(query)
             await message.channel.send(response)
         except Exception as e:
             await message.channel.send(f"`GarfBot Error: {str(e)}`")
 
     # Army of Dawn Server only!!
     if message.guild and message.guild.id == 719605634772893757:
-
         await aod_message(garfbot, message)
 
+    # Auto-responses
+    if message.guild:
+        responses = garf_respond.get_responses(guild_id)
         
-# # GarfGifs
-# @garfbot.event
-# async def send_gif(message, search_term):
-#     lmt = 50
-#     ckey = "garfbot"
-#     r = requests.get(f"https://tenor.googleapis.com/v2/search?q={search_term}&key={gapikey}&client_key={ckey}&limit={lmt}")
-#     if r.status_code == 200:
-#         top_50gifs = json.loads(r.content)
-#         gif_url = random.choice(top_50gifs["results"])["itemurl"]
-#         logger.info(gif_url)
-#         # logger.info(gif_url)
-#         try:
-#             await message.channel.send(gif_url)
-#         except KeyError:
-#             await message.channel.send("Oops, something went wrong.")
-#     else:
-#         await message.channel.send(f"`Oops, something went wrong. Error code: {r.status_code}`")
+        if lower.startswith('garfbot response '):
+            await garf_respond.garfbot_response(message, content)
+            return
             
+        for trigger, response in responses.items():
+            if trigger.lower() in lower:
+                await message.channel.send(response)
+                break
 
+# Run Garfbot
 async def garfbot_connect():
     while True:
         try:

garfpy/__init__.py

@@ -1,12 +1,10 @@
 # garfpy/__init__.py
+
 from .log import logger
-from .kroger import(
-    kroger_token, find_store, search_product
-)
-from .garfai import(
-    picture_time,
-    process_image_requests,
-    generate_chat
-)
+from .kroger import Kroger
 from .iputils import is_private
 from .aod import aod_message
+from .qr import generate_qr
+from .kroger import Kroger
+from .garfai import GarfAI
+from .respond import GarfbotRespond

garfpy/garfai.py

@@ -4,25 +4,26 @@ import config
 import aiohttp
 import asyncio
 import discord
+import wikipedia
 from openai import AsyncOpenAI
 from garfpy import logger
 
-openaikey = config.OPENAI_TOKEN
 
-txtmodel = config.TXT_MODEL
-imgmodel = config.IMG_MODEL
+class GarfAI:
+    def __init__(self):
+        self.openaikey = config.OPENAI_TOKEN
+        self.txtmodel = config.TXT_MODEL
+        self.imgmodel = config.IMG_MODEL
+        self.image_request_queue = asyncio.Queue()
 
-# GarfPics
-image_request_queue = asyncio.Queue()
+    async def garfpic(self, message, prompt):
+        await self.image_request_queue.put({'message': message, 'prompt': prompt})
 
-async def picture_time(message, prompt):
-    await image_request_queue.put({'message': message, 'prompt': prompt})
-
-async def generate_image(prompt):
+    async def generate_image(self, prompt):
         try:
-        client = AsyncOpenAI(api_key = openaikey)
+            client = AsyncOpenAI(api_key = self.openaikey)
             response = await client.images.generate(
-            model=imgmodel,
+                model=self.imgmodel,
                 prompt=prompt,
                 n=1,
                 size="1024x1024"
@@ -38,13 +39,13 @@ async def generate_image(prompt):
             logger.error(e)
             return f"`GarfBot Error: Lasagna`"
 
-async def process_image_requests():
+    async def process_image_requests(self):
         async with aiohttp.ClientSession() as session:
             while True:
-            request = await image_request_queue.get()
+                request = await self.image_request_queue.get()
                 message = request['message']
                 prompt = request['prompt']
-            image_url = await generate_image(prompt)
+                image_url = await self.generate_image(prompt)
                 if "GarfBot Error" not in image_url:
                     logger.info("Downloading & sending image...")
                     async with session.get(image_url) as resp:
@@ -63,15 +64,14 @@ async def process_image_requests():
                             await message.channel.send("`GarfBot Error: Odie`")
                 else:
                     await message.channel.send(image_url)
-            image_request_queue.task_done()
+                self.image_request_queue.task_done()
                 await asyncio.sleep(2)
 
-# GarfChats
-async def generate_chat(question):
+    async def generate_chat(self, question):
         try:
-        client = AsyncOpenAI(api_key = openaikey)
+            client = AsyncOpenAI(api_key = self.openaikey)
             response = await client.chat.completions.create(
-            model=txtmodel,
+                model=self.txtmodel,
                 messages=[
                     {"role": "system", "content": "Pretend you are sarcastic Garfield."},
                     {"role": "user", "content": f"{question}"}
@@ -88,3 +88,11 @@ async def generate_chat(question):
         except Exception as e:
             logger.info(e, flush=True)
             return f"`GarfBot Error: Lasagna`"
+
+    async def wikisum(self, query):
+        try:
+            summary = wikipedia.summary(query)
+            garfsum = await self.generate_chat(f"Please summarize in your own words: {summary}")
+            return garfsum
+        except Exception as e:
+            return e

garfpy/kroger.py

@@ -4,15 +4,16 @@ from base64 import b64encode
 from garfpy import logger
 
 
-client_id = config.CLIENT_ID
-client_secret = config.CLIENT_SECRET
+class Kroger:
+    def __init__(self):
+        self.client_id = config.CLIENT_ID
+        self.client_secret = config.CLIENT_SECRET
+        self.auth = b64encode(f"{self.client_id}:{self.client_secret}".encode()).decode()
 
-auth = b64encode(f"{client_id}:{client_secret}".encode()).decode()
-
-def kroger_token():
+    def kroger_token(self):
         headers = {
             'Content-Type': 'application/x-www-form-urlencoded',
-        'Authorization': f'Basic {auth}'
+            'Authorization': f'Basic {self.auth}'
         }
 
         response = requests.post('https://api.kroger.com/v1/connect/oauth2/token', headers=headers, data={
@@ -23,7 +24,7 @@ def kroger_token():
         response.raise_for_status()
         return response.json()['access_token']
 
-def find_store(zipcode, kroken):
+    def find_store(self, zipcode, kroken):
         headers = {
             'Authorization': f'Bearer {kroken}',
         }
@@ -34,7 +35,7 @@ def find_store(zipcode, kroken):
         response = requests.get('https://api.kroger.com/v1/locations', headers=headers, params=params)
         return response.json()
 
-def search_product(product, loc_id, kroken):
+    def search_product(self, product, loc_id, kroken):
         logger.info(f"Searching for {product}...")
         headers = {
             'Authorization': f'Bearer {kroken}',
@@ -46,3 +47,24 @@ def search_product(product, loc_id, kroken):
         }
         response = requests.get('https://api.kroger.com/v1/products', headers=headers, params=params)
         return response.json()
+
+    def garfshop(self, query):
+        try:
+            query = query.split()
+            kroken = self.kroger_token()
+            product = query[-2]
+            zipcode = query[-1]
+            loc_data = self.find_store(zipcode, kroken)
+            loc_id = loc_data['data'][0]['locationId']
+            store_name = loc_data['data'][0]['name']
+            product_query = self.search_product(product, loc_id, kroken)
+            products = product_query['data']
+            sorted_products = sorted(products, key=lambda item: item['items'][0]['price']['regular'])
+            response = f"Prices for `{product}` at `{store_name}` near `{zipcode}`:\n"
+            for item in sorted_products:
+                product_name = item['description']
+                price = item['items'][0]['price']['regular']
+                response += f"- `${price}`: {product_name} \n"
+            return response
+        except Exception as e:
+            return e

garfpy/qr.py

@@ -0,0 +1,63 @@
+import qrcode
+from io import BytesIO
+
+
+def calculate_qr_settings(text):
+    text_length = len(text)
+    
+    if text_length <= 25:
+        version = 1
+        box_size = 12
+    elif text_length <= 47:
+        version = 2
+        box_size = 10
+    elif text_length <= 77:
+        version = 3
+        box_size = 8
+    elif text_length <= 114:
+        version = 4
+        box_size = 7
+    elif text_length <= 154:
+        version = 5
+        box_size = 6
+    elif text_length <= 195:
+        version = 6
+        box_size = 5
+    elif text_length <= 224:
+        version = 7
+        box_size = 5
+    elif text_length <= 279:
+        version = 8
+        box_size = 4
+    elif text_length <= 335:
+        version = 9
+        box_size = 4
+    elif text_length <= 395:
+        version = 10
+        box_size = 3
+    else:
+        version = None
+        box_size = 3
+    
+    return version, box_size
+
+async def generate_qr(text):
+    version, box_size = calculate_qr_settings(text)
+    
+    qr = qrcode.QRCode(
+        version=version,
+        error_correction=qrcode.constants.ERROR_CORRECT_L,
+        box_size=box_size,
+        border=4,
+    )
+    
+    qr.add_data(text)
+    qr.make(fit=True)
+    
+    qr_image = qr.make_image(fill_color="black", back_color="white")
+    
+    img_buffer = BytesIO()
+    qr_image.save(img_buffer, format='PNG')
+    img_buffer.seek(0)
+
+    return img_buffer

garfpy/respond.py

@@ -0,0 +1,163 @@
+from garfpy import logger
+import discord
+import json
+import os
+import re
+
+
+class GarfbotRespond:
+    def __init__(self):
+        self.guild_responses = {}
+        self.responses_file = 'responses.json'
+
+    def load_responses(self):
+        if os.path.exists(self.responses_file):
+            try:
+                with open(self.responses_file, 'r', encoding='utf-8') as f:
+                    self.guild_responses = json.load(f)
+                self.guild_responses = {int(k): v for k, v in self.guild_responses.items()}
+                total_responses = sum(len(responses) for responses in self.guild_responses.values())
+                logger.info(f"Loaded responses for {len(self.guild_responses)} server(s), ({total_responses} total responses)")
+            except Exception as e:
+                logger.info(f"Error loading responses: {e}")
+                self.guild_responses = {}
+        else:
+            self.guild_responses = {}
+
+    def save_responses(self):
+        try:
+            save_data = {str(k): v for k, v in self.guild_responses.items()}
+            with open(self.responses_file, 'w', encoding='utf-8') as f:
+                json.dump(save_data, f, indent=2, ensure_ascii=False)
+            total_responses = sum(len(responses) for responses in self.guild_responses.values())
+            logger.info(f"Saved responses for {len(self.guild_responses)} servers ({total_responses} total responses)")
+        except Exception as e:
+            logger.info(f"Error saving responses: {e}")
+
+    def get_responses(self, guild_id):
+        if guild_id not in self.guild_responses:
+            self.guild_responses[guild_id] = {}
+        return self.guild_responses[guild_id]
+
+    async def garfbot_response(self, message, content):
+        guild_id = message.guild.id
+
+        logger.info(message.content)
+        
+        match = re.search(r'garfbot response add "(.+)" "(.+)"', content, re.IGNORECASE)
+        if match:
+            trigger = match.group(1)
+            response_text = match.group(2)
+            await self.add_response(message, guild_id, trigger, response_text)
+            return
+        
+        match = re.search(r'garfbot response add (\S+) (.+)', content, re.IGNORECASE)
+        if match:
+            trigger = match.group(1) 
+            response_text = match.group(2)
+            await self.add_response(message, guild_id, trigger, response_text)
+            return
+        
+        match = re.search(r'garfbot\s+response\s+remove\s+(.+)', content, re.IGNORECASE)
+        if match:
+            trigger = match.group(1).strip()
+            await self.remove_response(message, guild_id, trigger)
+            return
+        
+        if content.lower() == "garfbot response list":
+            await self.list_responses(message, guild_id)
+            return
+        
+        await message.channel.send(
+            "**Garfbot Auto-Response Commands:**\n"
+            "`garfbot response add \"trigger\" \"response\"`\n"
+            "`garfbot response remove \"trigger\"`\n"
+            "`garfbot response list`\n\n"
+            "**Examples:**\n"
+            "`garfbot response add \"hi\" \"Hello there!\"`\n"
+            "`garfbot response add \"that's what\" \"That's what she said!\"`\n"
+            "`garfbot response remove \"hi\"`"
+        )
+
+    async def add_response(self, message, guild_id, trigger, response_text):
+        if not response_text or not trigger:
+            await message.channel.send("❌ Trigger and response must not be null.")
+            return
+        
+        responses = self.get_responses(guild_id)
+        responses[trigger] = response_text
+        self.guild_responses[guild_id] = responses
+        self.save_responses()
+        
+        embed = discord.Embed(
+            title="✅ Auto-response Added.",
+            color=0x00ff00
+        )
+        embed.add_field(name="Trigger", value=f"`{trigger}`", inline=True)
+        embed.add_field(name="Response", value=f"`{response_text}`", inline=True)
+        embed.set_footer(text=f"Server: {message.guild.name}")
+        
+        await message.channel.send(embed=embed)
+
+    async def remove_response(self, message, guild_id, trigger):
+        responses = self.get_responses(guild_id)
+        
+        if trigger in responses:
+            removed_response = responses[trigger]
+            del responses[trigger]
+            self.guild_responses[guild_id] = responses
+            self.save_responses()
+            
+            embed = discord.Embed(
+                title="✅ Auto-response Removed.",
+                color=0xff6b6b
+            )
+            embed.add_field(name="Trigger", value=f"`{trigger}`", inline=True)
+            embed.add_field(name="Response", value=f"`{removed_response}`", inline=True)
+            embed.set_footer(text=f"Server: {message.guild.name}")
+            
+            await message.channel.send(embed=embed)
+            return
+        
+        for key in responses.keys():
+            if key.lower() == trigger.lower():
+                removed_response = responses[key]
+                del responses[key]
+                self.guild_responses[guild_id] = responses
+                self.save_responses()
+                
+                embed = discord.Embed(
+                    title="✅ Auto-response Removed.",
+                    color=0xff6b6b
+                )
+                embed.add_field(name="Trigger", value=f"`{key}`", inline=True)
+                embed.add_field(name="Response", value=f"`{removed_response}`", inline=True)
+                embed.set_footer(text=f"Server: {message.guild.name}")
+                
+                await message.channel.send(embed=embed)
+                return
+        
+        await message.channel.send(f"❌ No auto-response found for trigger: `{trigger}`")
+
+    async def list_responses(self, message, guild_id):
+        responses = self.get_responses(guild_id)
+        
+        if not responses:
+            await message.channel.send("No auto-responses configured for this server.")
+            return
+        
+        embed = discord.Embed(
+            title=f"Auto-Responses for {message.guild.name}",
+            color=0x3498db
+        )
+        
+        for i, (trigger, response) in enumerate(responses.items(), 1):
+            display_response = response[:50] + "..." if len(response) > 50 else response
+            embed.add_field(
+                name=f"{i}. `{trigger}`",
+                value=f"→ {display_response}",
+                inline=False
+            )
+        
+        embed.set_footer(text=f"Total responses: {len(responses)}")
+        await message.channel.send(embed=embed)

requirements.txt

@@ -2,3 +2,6 @@ discord.py
 openai
 aiohttp
 requests
+wikipedia
+pillow
+qrcode