From 11c9cf58a3fcd16cc8d6aa6da4f1f625eaef5891 Mon Sep 17 00:00:00 2001
From: w
Date: Thu, 22 May 2025 23:26:03 -0300
Subject: [PATCH 01/56] Added table and general functions for stats system
---
bot/db_utils.py | 106 ++++++++++++++++++++++++++++++++++++++++++++++++
db.py | 9 ++++
2 files changed, 115 insertions(+)
diff --git a/bot/db_utils.py b/bot/db_utils.py
index bb80d98..62e7f15 100644
--- a/bot/db_utils.py
+++ b/bot/db_utils.py
@@ -4,12 +4,17 @@ import config
DB_PATH = config.DB_PATH
+# Database functions
+
def get_db_connection():
'''Creates a connection to the database'''
conn = sqlite3.connect(DB_PATH)
conn.row_factory = sqlite3.Row
return conn
+
+# User functions
+
def get_or_create_user(username):
'''Retrieves an ID for a given user, if the user does not exist, it will be
created.'''
@@ -32,6 +37,9 @@ def get_or_create_user(username):
conn.close()
return user_id
+
+# Gameplay functions
+
def add_pull(user_id, character_id):
'''Creates a pull in the database'''
conn = get_db_connection()
@@ -40,6 +48,9 @@ def add_pull(user_id, character_id):
conn.commit()
conn.close()
+
+# Configuration
+
def get_config(key):
'''Reads the value for a specified config key from the db'''
conn = get_db_connection()
@@ -56,3 +67,98 @@ def set_config(key, value):
cur.execute("INSERT OR REPLACE INTO config (key, value) VALUES (?, ?)", (key, value))
conn.commit()
conn.close()
+
+
+# Character stat functions
+
+def add_character_stats(character_id, stats):
+ '''
+ Adds or updates character stats in the character_stats table.
+ `stats` should be a dictionary like {'power': 5, 'charm': 3}
+ '''
+ if not stats:
+ return
+
+ conn = get_db_connection()
+ cur = conn.cursor()
+
+ columns = ', '.join(stats.keys())
+ placeholders = ', '.join(['?'] * len(stats))
+ updates = ', '.join([f"{col}=excluded.{col}" for col in stats.keys()])
+
+ values = list(stats.values())
+
+ sql = f'''
+ INSERT INTO character_stats (character_id, {columns})
+ VALUES (?, {placeholders})
+ ON CONFLICT(character_id) DO UPDATE SET {updates}
+ '''
+ cur.execute(sql, [character_id] + values)
+ conn.commit()
+ conn.close()
+
+
+def update_character_stat(character_id, stat_name, value):
+ '''Updates a single stat field for a character'''
+ conn = get_db_connection()
+ cur = conn.cursor()
+ cur.execute(f'''
+ UPDATE character_stats SET {stat_name} = ? WHERE character_id = ?
+ ''', (value, character_id))
+ conn.commit()
+ conn.close()
+
+def get_character_stats(character_id):
+ '''Retrieves all stats for a single character dynamically'''
+ conn = get_db_connection()
+ conn.row_factory = sqlite3.Row # Enables dict-style access to rows
+ cur = conn.cursor()
+ cur.execute('SELECT * FROM character_stats WHERE character_id = ?', (character_id,))
+ row = cur.fetchone()
+ conn.close()
+
+ if row:
+ return {key: row[key] for key in row.keys() if key != 'character_id'}
+ else:
+ return {}
+
+def get_character_stat(character_id, stat_name):
+ '''Retrieves a single stat value for a character'''
+ if stat_name not in ('power', 'charm'):
+ raise ValueError("Invalid stat name")
+ conn = get_db_connection()
+ cur = conn.cursor()
+ cur.execute(f'SELECT {stat_name} FROM character_stats WHERE character_id = ?', (character_id,))
+ row = cur.fetchone()
+ conn.close()
+ return row[0] if row else 0
+
+def get_stats_for_multiple_characters(character_ids):
+ '''
+ Retrieves stats for a list of character IDs.
+ Returns a dictionary of character_id -> {stat_name: value, ...}
+ '''
+ if not character_ids:
+ return {}
+
+ placeholders = ','.join('?' for _ in character_ids)
+ query = f'''
+ SELECT *
+ FROM character_stats
+ WHERE character_id IN ({placeholders})
+ '''
+
+ conn = get_db_connection()
+ cur = conn.cursor()
+ cur.execute(query, character_ids)
+ rows = cur.fetchall()
+ col_names = [desc[0] for desc in cur.description]
+ conn.close()
+
+ result = {}
+ for row in rows:
+ character_id = row[0]
+ stats = dict(zip(col_names[1:], row[1:])) # Skip character_id
+ result[character_id] = stats
+
+ return result
diff --git a/db.py b/db.py
index 63d0b43..93d96ea 100644
--- a/db.py
+++ b/db.py
@@ -41,6 +41,15 @@ cursor.execute("""
)
""")
+cursor.execute('''
+CREATE TABLE IF NOT EXISTS character_stats (
+ character_id INTEGER PRIMARY KEY,
+ power INTEGER NOT NULL,
+ charm INTEGER NOT NULL,
+ FOREIGN KEY(character_id) REFERENCES characters(id)
+)
+''')
+
""" # Insert example characters into the database if they don't already exist
characters = [
('Murakami-san', 1, 0.35),
From 237f17f40d6d6b2e2c5be0c59699ea1d71a9b2d1 Mon Sep 17 00:00:00 2001
From: VD15
Date: Fri, 23 May 2025 23:44:03 +0100
Subject: [PATCH 02/56] Add a roll timeout to the bot
---
bot/add_character.py | 7 +--
bot/config.py | 24 ++++----
bot/db_utils.py | 10 +++-
bot/response.py | 130 ++++++++++++++++++++++++++++++-------------
example_config.ini | 36 ++++++------
5 files changed, 133 insertions(+), 74 deletions(-)
diff --git a/bot/add_character.py b/bot/add_character.py
index 68528c3..aae3fb3 100644
--- a/bot/add_character.py
+++ b/bot/add_character.py
@@ -32,7 +32,7 @@ def add_character(name: str, rarity: int, weight: float, image_url: str) -> tupl
raise ValueError("Image URL must be provided.")
# Download image
- response = requests.get(image_url, stream=True)
+ response = requests.get(image_url, stream=True, timeout=30)
if response.status_code != 200:
raise RuntimeError(f"Failed to download image from {image_url}")
@@ -55,9 +55,6 @@ def add_character(name: str, rarity: int, weight: float, image_url: str) -> tupl
character_id = cur.lastrowid
return character_id, file_id
-
- except Exception as e:
- raise
finally:
if 'conn' in locals():
- conn.close()
\ No newline at end of file
+ conn.close()
diff --git a/bot/config.py b/bot/config.py
index 5b73661..643aeb1 100644
--- a/bot/config.py
+++ b/bot/config.py
@@ -4,22 +4,20 @@ config = configparser.ConfigParser()
config.read('config.ini')
# Username for the bot
-USER = config['application']['BotUser']
-
+USER = config['credentials']['User']
# API key for the bot
-KEY = config['application']['ApiKey']
+KEY = config['credentials']['Token']
# Bot's Misskey instance URL
-INSTANCE = config['application']['InstanceUrl']
-
-# SQLite Database location
-DB_PATH = config['application']['DatabaseLocation']
-
-# Extra stuff for control of the bot
+INSTANCE = config['credentials']['Instance']
# TODO: move this to db
# Fedi handles in the traditional 'user@domain.tld' style, allows these users
-# to use extra admin exclusive commands with the bot'''
-ADMINS = config['application']['DefaultAdmins']
+# to use extra admin exclusive commands with the bot
+ADMINS = config['application']['DefaultAdmins']
+# SQLite Database location
+DB_PATH = config['application']['DatabaseLocation']
-NOTIFICATION_POLL_INTERVAL = int(config['application']['NotificationPollInterval'])
-NOTIFICATION_BATCH_SIZE = int(config['application']['NotificationBatchSize'])
+NOTIFICATION_POLL_INTERVAL = int(config['notification']['PollInterval'])
+NOTIFICATION_BATCH_SIZE = int(config['notification']['BatchSize'])
+
+GACHA_ROLL_INTERVAL = int(config['gacha']['RollInterval'])
diff --git a/bot/db_utils.py b/bot/db_utils.py
index 62e7f15..584856b 100644
--- a/bot/db_utils.py
+++ b/bot/db_utils.py
@@ -1,5 +1,4 @@
import sqlite3
-import random
import config
DB_PATH = config.DB_PATH
@@ -48,6 +47,15 @@ def add_pull(user_id, character_id):
conn.commit()
conn.close()
+def get_last_rolled_at(user_id):
+ '''Gets the timestamp when the user last rolled'''
+ conn = get_db_connection()
+ cur = conn.cursor()
+ cur.execute("SELECT timestamp FROM pulls WHERE user_id = ? ORDER BY timestamp DESC", \
+ (user_id,))
+ row = cur.fetchone()
+ conn.close()
+ return row[0] if row else None
# Configuration
diff --git a/bot/response.py b/bot/response.py
index 2c58c43..b009344 100644
--- a/bot/response.py
+++ b/bot/response.py
@@ -1,6 +1,8 @@
import random
-from db_utils import get_or_create_user, add_pull, get_db_connection
+from datetime import datetime, timedelta, timezone
+from db_utils import get_or_create_user, add_pull, get_db_connection, get_last_rolled_at
from add_character import add_character
+from config import GACHA_ROLL_INTERVAL
def get_character():
''' Gets a random character from the database'''
@@ -18,54 +20,104 @@ def get_character():
return chosen['id'], chosen['name'], chosen['file_id'], chosen['rarity']
+def do_roll(full_user):
+ '''Determines whether the user can roll, then pulls a random character'''
+ user_id = get_or_create_user(full_user)
+
+ # Get date of user's last roll
+ date = get_last_rolled_at(user_id)
+
+ # No date means it's users first roll
+ if date:
+ # SQLite timestamps returned by the DB are always in UTC
+ # Below timestamps are to be converted to UTC
+ prev = datetime.strptime(date + '+0000', '%Y-%m-%d %H:%M:%S%z')
+ now = datetime.now(timezone.utc)
+
+ time_since_last_roll = now - prev
+ roll_interval = timedelta(seconds=GACHA_ROLL_INTERVAL)
+ duration = roll_interval - time_since_last_roll
+
+ # User needs to wait before they can roll again
+ if time_since_last_roll < roll_interval:
+ remaining_duration = None
+ if duration.seconds > 3600:
+ remaining_duration = f'{-(duration.seconds // -3600)} hours'
+ elif duration.seconds > 60:
+ remaining_duration = f'{-(duration.seconds // -60)} minutes'
+ else:
+ remaining_duration = f'{duration.seconds} seconds'
+
+ return f'{full_user} ⏱️ Please wait another {remaining_duration} before rolling again.'
+
+ character_id, character_name, file_id, rarity = get_character()
+
+ if not character_id:
+ return f'{full_user} Uwaaa... something went wrong! No characters found. 😿'
+
+ add_pull(user_id,character_id)
+ stars = '⭐️' * rarity
+ return([f"@{full_user} 🎲 Congrats! You rolled {stars} **{character_name}**\n\
+ She's all yours now~ 💖✨",[file_id]])
+
def is_float(val):
+ '''Returns true if `val` can be converted to a float'''
try:
float(val)
return True
except ValueError:
return False
+def do_create(full_user, arguments, note_obj):
+ '''Creates a character'''
+ # Example call from bot logic
+ image_url = note_obj.get('files', [{}])[0].get('url') if note_obj.get('files') else None
+ if not image_url:
+ return f'{full_user}{full_user} You need an image to create a character, dumbass.'
+
+ if len(arguments) != 3:
+ return '{full_user}Please specify the following attributes in order: \
+ name, rarity, drop weighting'
+
+ if not (arguments[1].isnumeric() and 1 <= int(arguments[1]) <= 5):
+ return f'{full_user}Invalid rarity: \'{arguments[1]}\' must be a number between 1 and 5'
+
+ if not (is_float(arguments[2]) and 0.0 < float(arguments[2]) <= 1.0):
+ return f'{full_user}Invalid drop weight: \'{arguments[2]}\' \
+ must be a decimal value between 0.0 and 1.0'
+
+ character_id, file_id = add_character(
+ name=arguments[0],
+ rarity=int(arguments[1]),
+ weight=float(arguments[2]),
+ image_url=image_url
+ )
+ return([f'{full_user}Added {arguments[0]}, ID {character_id}.',[file_id]])
+
+
+def do_help(full_user):
+ '''Provides a list of commands that the bot can do.'''
+ return f'{full_user} Here\'s what I can do:\n \
+ - `roll` Pulls a random character.\
+ - `create ` Creates a character using a given image.\
+ - `help` Shows this message'
+
+def do_invalid_command(command, full_user):
+ '''Generic response when an unknown or invalid command is sent'''
+ return f'{full_user} Unrecognised command: {command}\n\
+ Message \'help\' to get a list of valid commands'
def generate_response(parsed_command):
-
'''Given a command with arguments, processes the game state and
returns a response'''
command, full_user, arguments, note_obj = parsed_command
-
- if command == "roll":
- user_id = get_or_create_user(full_user)
- character_id, character_name, file_id, rarity = get_character()
-
- if not character_id:
- #TODO: Can't have tuples of a single element
- # Return these as a dict or object instead.
- return(f"@{full_user} Uwaaa... something went wrong! No characters found. 😿")
-
- add_pull(user_id,character_id)
- stars = '⭐️' * rarity
- return([f"@{full_user} 🎲 Congrats! You rolled {stars} **{character_name}**\nShe's all yours now~ 💖✨",[file_id]])
-
- if command == "create":
- # Example call from bot logic
- image_url = note_obj.get("files", [{}])[0].get("url") if note_obj.get("files") else None
- if not image_url:
- return "You need an image to create a character, dumbass."
-
- if len(arguments) != 3:
- return "Please specify the following attributes in order: name, rarity, drop weighting"
-
- if not (arguments[1].isnumeric() and 1 <= int(arguments[1]) <= 5):
- return f"Invalid rarity: '{arguments[1]}' must be a number between 1 and 5"
-
- if not (is_float(arguments[2]) and 0.0 < float(arguments[2]) <= 1.0):
- return f"Invalid drop weight: '{arguments[2]}' must be a decimal value between 0.0 and 1.0"
-
- character_id, file_id = add_character(
- name=arguments[0],
- rarity=int(arguments[1]),
- weight=float(arguments[2]),
- image_url=image_url
- )
- return([f"Added {arguments[0]}, ID {character_id}.",[file_id]])
- return None
+ match command:
+ case 'roll':
+ return do_roll(full_user)
+ case 'create':
+ return do_create(full_user, arguments, note_obj)
+ case 'help':
+ return do_help(command)
+ case _:
+ return do_invalid_command(command, full_user)
diff --git a/example_config.ini b/example_config.ini
index 44cc2f9..d7f1c14 100644
--- a/example_config.ini
+++ b/example_config.ini
@@ -1,23 +1,27 @@
; Rename me to config.ini and put your values in here
[application]
-; Full fedi handle of the bot user
-BotUser = @bot@example.tld
-
-; API key for the bot
-; Generate one by going to Settings > API > Generate access token
-ApiKey = abcdefghijklmnopqrstuvwxyz012345
-
-; Fully qualified URL of the instance hosting the bot
-InstanceUrl = http://example.tld
-
; Comma separated list of fedi handles for any administrator users
-DefaultAdmins = ['admin@example.tld']
-
+; More can be added through the application
+DefaultAdmins = ['admin@example.tld']
; SQLite Database location
DatabaseLocation = ./gacha_game.db
-; Number of seconds to sleep while awaiting new notifications
-NotificationPollInterval = 5
+[gacha]
+; Number of seconds players have to wait between rolls
+RollInterval = 72000
+
+[notification]
+; Number of seconds to sleep while awaiting new notifications
+PollInterval = 5
+; Number of notifications to process at once (max 100)
+BatchSize = 10
+
+[credentials]
+; Fully qualified URL of the instance hosting the bot
+Instance = http://example.tld
+; Full fedi handle of the bot user
+User = @bot@example.tld
+; API key for the bot
+; Generate one by going to Settings > API > Generate access token
+Token = abcdefghijklmnopqrstuvwxyz012345
-; Number of notifications to process at once (limit 100)
-NotificationBatchSize = 10
From 74e4c86d02f5a2ee83c0f116e21784abbc661f5d Mon Sep 17 00:00:00 2001
From: w
Date: Thu, 22 May 2025 23:26:03 -0300
Subject: [PATCH 03/56] Added table and general functions for stats system
---
bot/db_utils.py | 2 ++
1 file changed, 2 insertions(+)
diff --git a/bot/db_utils.py b/bot/db_utils.py
index 584856b..402d0af 100644
--- a/bot/db_utils.py
+++ b/bot/db_utils.py
@@ -59,6 +59,8 @@ def get_last_rolled_at(user_id):
# Configuration
+# Configuration
+
def get_config(key):
'''Reads the value for a specified config key from the db'''
conn = get_db_connection()
From 3a2033a0254e9c7c80f5ff23938bc6370b736cb8 Mon Sep 17 00:00:00 2001
From: w
Date: Sat, 24 May 2025 17:54:15 -0300
Subject: [PATCH 04/56] Add a roll timeout to the bot
---
bot/db_utils.py | 2 --
1 file changed, 2 deletions(-)
diff --git a/bot/db_utils.py b/bot/db_utils.py
index 402d0af..584856b 100644
--- a/bot/db_utils.py
+++ b/bot/db_utils.py
@@ -59,8 +59,6 @@ def get_last_rolled_at(user_id):
# Configuration
-# Configuration
-
def get_config(key):
'''Reads the value for a specified config key from the db'''
conn = get_db_connection()
From 3b7f2006ef3dea991f6910e49a487453fe5bacae Mon Sep 17 00:00:00 2001
From: w
Date: Wed, 28 May 2025 23:44:59 -0300
Subject: [PATCH 05/56] unifying character and stats insertion, generalize
get_character
---
bot/db_utils.py | 86 +++++++++++--------------------------------------
1 file changed, 18 insertions(+), 68 deletions(-)
diff --git a/bot/db_utils.py b/bot/db_utils.py
index 2d030cb..a236980 100644
--- a/bot/db_utils.py
+++ b/bot/db_utils.py
@@ -47,13 +47,27 @@ def get_or_create_user(username):
user_id = CURSOR.lastrowid
return user_id
-def insert_character(name: str, rarity: int, weight: float, file_id: str) -> int:
+def insert_character(name: str, rarity: int, weight: float, file_id: str, stats: dict) -> int:
'''Inserts a character'''
CURSOR.execute(
'INSERT INTO characters (name, rarity, weight, file_id) VALUES (?, ?, ?, ?)',
(name, rarity, weight, file_id)
)
character_id = CURSOR.lastrowid
+
+ # Insert stats
+ columns = ', '.join(stats.keys())
+ placeholders = ', '.join(['?'] * len(stats))
+ updates = ', '.join([f"{col}=excluded.{col}" for col in stats.keys()])
+ values = list(stats.values())
+
+ sql = f'''
+ INSERT INTO character_stats (character_id, {columns})
+ VALUES (?, {placeholders})
+ ON CONFLICT(character_id) DO UPDATE SET {updates}
+ '''
+ CURSOR.execute(sql, [character_id] + values)
+
return character_id if character_id else 0
def insert_pull(user_id, character_id):
@@ -85,69 +99,7 @@ def set_config(key, value):
# Character stat functions
-def add_character_stats(character_id, stats):
- '''
- Adds or updates character stats in the character_stats table.
- `stats` should be a dictionary like {'power': 5, 'charm': 3}
- '''
- if not stats:
- return
-
- conn = get_db_connection()
- cur = conn.cursor()
-
- columns = ', '.join(stats.keys())
- placeholders = ', '.join(['?'] * len(stats))
- updates = ', '.join([f"{col}=excluded.{col}" for col in stats.keys()])
-
- values = list(stats.values())
-
- sql = f'''
- INSERT INTO character_stats (character_id, {columns})
- VALUES (?, {placeholders})
- ON CONFLICT(character_id) DO UPDATE SET {updates}
- '''
- cur.execute(sql, [character_id] + values)
- conn.commit()
- conn.close()
-
-
-def update_character_stat(character_id, stat_name, value):
- '''Updates a single stat field for a character'''
- conn = get_db_connection()
- cur = conn.cursor()
- cur.execute(f'''
- UPDATE character_stats SET {stat_name} = ? WHERE character_id = ?
- ''', (value, character_id))
- conn.commit()
- conn.close()
-
-def get_character_stats(character_id):
- '''Retrieves all stats for a single character dynamically'''
- conn = get_db_connection()
- conn.row_factory = sqlite3.Row # Enables dict-style access to rows
- cur = conn.cursor()
- cur.execute('SELECT * FROM character_stats WHERE character_id = ?', (character_id,))
- row = cur.fetchone()
- conn.close()
-
- if row:
- return {key: row[key] for key in row.keys() if key != 'character_id'}
- else:
- return {}
-
-def get_character_stat(character_id, stat_name):
- '''Retrieves a single stat value for a character'''
- if stat_name not in ('power', 'charm'):
- raise ValueError("Invalid stat name")
- conn = get_db_connection()
- cur = conn.cursor()
- cur.execute(f'SELECT {stat_name} FROM character_stats WHERE character_id = ?', (character_id,))
- row = cur.fetchone()
- conn.close()
- return row[0] if row else 0
-
-def get_stats_for_multiple_characters(character_ids):
+def get_characters(character_ids):
'''
Retrieves stats for a list of character IDs.
Returns a dictionary of character_id -> {stat_name: value, ...}
@@ -162,12 +114,10 @@ def get_stats_for_multiple_characters(character_ids):
WHERE character_id IN ({placeholders})
'''
- conn = get_db_connection()
- cur = conn.cursor()
- cur.execute(query, character_ids)
+
+ CURSOR.execute(query, character_ids)
rows = cur.fetchall()
col_names = [desc[0] for desc in cur.description]
- conn.close()
result = {}
for row in rows:
From 9d98299264ebfc0f1632938cb4ef5fdefc80abf4 Mon Sep 17 00:00:00 2001
From: w
Date: Wed, 28 May 2025 23:52:04 -0300
Subject: [PATCH 06/56] expanding character_stats
---
db.py | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/db.py b/db.py
index 52596c4..3849481 100644
--- a/db.py
+++ b/db.py
@@ -44,8 +44,8 @@ cursor.execute("""
cursor.execute('''
CREATE TABLE IF NOT EXISTS character_stats (
character_id INTEGER PRIMARY KEY,
- power INTEGER NOT NULL,
- charm INTEGER NOT NULL,
+ power INTEGER NOT NULL DEFAULT abs(random() % 9999),
+ charm INTEGER NOT NULL DEFAULT abs(random() % 9999),,
FOREIGN KEY(character_id) REFERENCES characters(id)
)
''')
From fde6e1167a8143a7ebfda9bab09c8fa70c1cc751 Mon Sep 17 00:00:00 2001
From: VD15
Date: Sat, 7 Jun 2025 19:23:17 +0100
Subject: [PATCH 07/56] Add administrators
---
bot/{add_character.py => add_card.py} | 20 ++--
bot/bot_app.py | 3 +
bot/config.py | 10 +-
bot/custom_types.py | 2 +-
bot/db_utils.py | 128 ++++++++++++++++---------
bot/response.py | 105 +++++++++++---------
example_config.ini | 2 +-
migrations/0003_rename_tables.sql | 4 +
migrations/0004_add_administrators.sql | 1 +
9 files changed, 171 insertions(+), 104 deletions(-)
rename bot/{add_character.py => add_card.py} (76%)
create mode 100644 migrations/0003_rename_tables.sql
create mode 100644 migrations/0004_add_administrators.sql
diff --git a/bot/add_character.py b/bot/add_card.py
similarity index 76%
rename from bot/add_character.py
rename to bot/add_card.py
index 18b0f98..fcaab43 100644
--- a/bot/add_character.py
+++ b/bot/add_card.py
@@ -1,27 +1,27 @@
import requests
from misskey.exceptions import MisskeyAPIException
from client import client_connection
-from db_utils import insert_character
-from custom_types import Character
+from db_utils import insert_card
+from custom_types import Card
from config import RARITY_TO_WEIGHT
-def add_character(
+def add_card(
name: str,
rarity: int,
image_url: str) -> tuple[int, str]:
'''
- Adds a character to the database, uploading the image from a public URL to
+ Adds a card to the database, uploading the image from a public URL to
the bot's Misskey Drive.
Args:
- name (str): Character name.
- rarity (int): Character rarity (e.g., 1-5).
+ name (str): Card name.
+ rarity (int): Card rarity (e.g., 1-5).
image_url (str): Public URL of the image from the post (e.g., from
note['files'][i]['url']).
Returns:
- tuple[int, str]: Character ID and bot's Drive file_id.
+ tuple[int, str]: Card ID and bot's Drive file_id.
Raises:
ValueError: If inputs are invalid.
@@ -32,7 +32,7 @@ def add_character(
# Validate inputs
if not stripped_name:
- raise ValueError('Character name cannot be empty.')
+ raise ValueError('Card name cannot be empty.')
if rarity < 1:
raise ValueError('Rarity must be a positive integer.')
if rarity not in RARITY_TO_WEIGHT.keys():
@@ -55,10 +55,10 @@ def add_character(
from e
# Insert into database
- character_id = insert_character(
+ card_id = insert_card(
stripped_name,
rarity,
RARITY_TO_WEIGHT[rarity],
file_id
)
- return character_id, file_id
+ return card_id, file_id
diff --git a/bot/bot_app.py b/bot/bot_app.py
index 825695e..ed2772b 100644
--- a/bot/bot_app.py
+++ b/bot/bot_app.py
@@ -12,6 +12,9 @@ if __name__ == '__main__':
# Connect to DB
db.connect()
+ # Setup default administrators
+ db.setup_administrators()
+
print('Listening for notifications...')
while True:
if not process_notifications(client):
diff --git a/bot/config.py b/bot/config.py
index 227f949..af806f9 100644
--- a/bot/config.py
+++ b/bot/config.py
@@ -1,5 +1,6 @@
'''Essentials for the bot to function'''
import configparser
+import json
from os import environ, path
@@ -21,7 +22,9 @@ def get_config_file() -> str:
raise ConfigError(f'Could not find {config_path}')
return config_path
-def get_rarity_to_weight(config_section):
+
+def get_rarity_to_weight(
+ config_section: configparser.SectionProxy) -> dict[int, float]:
"""Parses Rarity_X keys from config and returns a {rarity: weight} dict."""
rarity_weights = {}
for key, value in config_section.items():
@@ -41,10 +44,9 @@ KEY = config['credentials']['Token']
# Bot's Misskey instance URL
INSTANCE = config['credentials']['Instance'].lower()
-# TODO: move this to db
# Fedi handles in the traditional 'user@domain.tld' style, allows these users
# to use extra admin exclusive commands with the bot
-ADMINS = config['application']['DefaultAdmins']
+ADMINS = json.loads(config['application']['DefaultAdmins'])
# SQLite Database location
DB_PATH = config['application']['DatabaseLocation']
@@ -53,4 +55,4 @@ NOTIFICATION_BATCH_SIZE = int(config['notification']['BatchSize'])
GACHA_ROLL_INTERVAL = int(config['gacha']['RollInterval'])
-RARITY_TO_WEIGHT = get_rarity_to_weight(config['gacha'])
\ No newline at end of file
+RARITY_TO_WEIGHT = get_rarity_to_weight(config['gacha'])
diff --git a/bot/custom_types.py b/bot/custom_types.py
index 0c23cb6..7fc7885 100644
--- a/bot/custom_types.py
+++ b/bot/custom_types.py
@@ -5,7 +5,7 @@ BotResponse = TypedDict('BotResponse', {
'attachment_urls': List[str] | None
})
-Character = TypedDict('Character', {
+Card = TypedDict('Card', {
'id': int,
'name': str,
'rarity': int,
diff --git a/bot/db_utils.py b/bot/db_utils.py
index 68409be..f7edd83 100644
--- a/bot/db_utils.py
+++ b/bot/db_utils.py
@@ -1,7 +1,7 @@
from random import choices
import sqlite3
import config
-from custom_types import Character
+from custom_types import Card
DB_PATH = config.DB_PATH
CONNECTION: sqlite3.Connection
@@ -18,16 +18,38 @@ def connect() -> None:
CURSOR = CONNECTION.cursor()
-def get_random_character() -> Character | None:
- ''' Gets a random character from the database'''
- CURSOR.execute('SELECT * FROM characters')
- characters = CURSOR.fetchall()
+def setup_administrators() -> None:
+ '''Creates administrator players for each handle in the config file'''
+ # Get default admins from config
+ for username in config.ADMINS:
+ player_id = get_player(username)
+ if player_id == 0:
+ # Create player if not exists
+ print(f'Creating administrator player: {username}')
+ CURSOR.execute(
+ 'INSERT INTO players (username, has_rolled, is_administrator) \
+ VALUES (?, ?, ?)',
+ (username, False, True)
+ )
+ else:
+ # Update is_administrator if exists
+ print(f'Granting administrator to player: {username}')
+ CURSOR.execute(
+ 'UPDATE players SET is_administrator = 1 WHERE id = ?',
+ (player_id,)
+ )
- if not characters:
+
+def get_random_card() -> Card | None:
+ ''' Gets a random card from the database'''
+ CURSOR.execute('SELECT * FROM cards')
+ cards = CURSOR.fetchall()
+
+ if not cards:
return None
- weights = [config.RARITY_TO_WEIGHT[c['rarity']] for c in characters]
- chosen = choices(characters, weights=weights, k=1)[0]
+ weights = [config.RARITY_TO_WEIGHT[c['rarity']] for c in cards]
+ chosen = choices(cards, weights=weights, k=1)[0]
return {
'id': chosen['id'],
@@ -37,73 +59,89 @@ def get_random_character() -> Character | None:
'image_url': chosen['file_id']
}
+
def get_player(username: str) -> int:
'''Retrieve a player ID by username, or return None if not found.'''
- CURSOR.execute('SELECT id FROM users WHERE username = ?', (username,))
- user = CURSOR.fetchone()
- if user:
- return int(user[0])
-
-def insert_player(username: str) -> int:
- '''Insert a new player with default has_rolled = False and return their user ID.'''
CURSOR.execute(
- 'INSERT INTO users (username, has_rolled) VALUES (?, ?)',
- (username, False)
- )
- return CURSOR.lastrowid
-
-def delete_player(username: str) -> bool:
- '''Permanently deletes a user and all their pulls.'''
- CURSOR.execute(
- 'SELECT id FROM users WHERE username = ?',
+ 'SELECT id FROM players WHERE username = ?',
(username,)
)
- user = CURSOR.fetchone()
+ player = CURSOR.fetchone()
+ if player:
+ return int(player[0])
+ return 0
- user_id = user[0]
+
+def insert_player(username: str) -> int:
+ '''Insert a new player with default has_rolled = False and return their
+ player ID.'''
+ CURSOR.execute(
+ 'INSERT INTO players (username, has_rolled) VALUES (?, ?)',
+ (username, False)
+ )
+ return CURSOR.lastrowid if CURSOR.lastrowid else 0
+
+
+def delete_player(username: str) -> bool:
+ '''Permanently deletes a player and all their pulls.'''
+ CURSOR.execute(
+ 'SELECT id FROM players WHERE username = ?',
+ (username,)
+ )
+ player = CURSOR.fetchone()
+
+ player_id = player[0]
# Delete pulls
CURSOR.execute(
- 'DELETE FROM pulls WHERE user_id = ?',
- (user_id,)
+ 'DELETE FROM pulls WHERE player_id = ?',
+ (player_id,)
)
- # Delete user
+ # Delete player
CURSOR.execute(
- 'DELETE FROM users WHERE id = ?',
- (user_id,)
+ 'DELETE FROM players WHERE id = ?',
+ (player_id,)
)
return True
-
-def insert_character(
- name: str, rarity: int, weight: float, file_id: str) -> int:
- '''Inserts a character'''
+def is_player_administrator(player_id: int) -> bool:
CURSOR.execute(
- 'INSERT INTO characters (name, rarity, weight, file_id) VALUES \
+ 'SELECT is_administrator FROM PLAYERS WHERE id = ? LIMIT 1',
+ (player_id,)
+ )
+ row = CURSOR.fetchone()
+ return row[0] if row else False
+
+
+def insert_card(
+ name: str, rarity: int, weight: float, file_id: str) -> int:
+ '''Inserts a card'''
+ CURSOR.execute(
+ 'INSERT INTO cards (name, rarity, weight, file_id) VALUES \
(?, ?, ?, ?)',
(name, rarity, weight, file_id)
)
- character_id = CURSOR.lastrowid
- return character_id if character_id else 0
+ card_id = CURSOR.lastrowid
+ return card_id if card_id else 0
-def insert_pull(user_id: int, character_id: int) -> None:
+def insert_pull(player_id: int, card_id: int) -> None:
'''Creates a pull in the database'''
CURSOR.execute(
- 'INSERT INTO pulls (user_id, character_id) VALUES (?, ?)',
- (user_id, character_id)
+ 'INSERT INTO pulls (player_id, card_id) VALUES (?, ?)',
+ (player_id, card_id)
)
-def get_last_rolled_at(user_id: int) -> int:
- '''Gets the timestamp when the user last rolled'''
+def get_last_rolled_at(player_id: int) -> int:
+ '''Gets the timestamp when the player last rolled'''
CURSOR.execute(
- "SELECT timestamp FROM pulls WHERE user_id = ? ORDER BY timestamp \
+ "SELECT timestamp FROM pulls WHERE player_id = ? ORDER BY timestamp \
DESC",
- (user_id,))
+ (player_id,))
row = CURSOR.fetchone()
return row[0] if row else 0
diff --git a/bot/response.py b/bot/response.py
index 3fde3ed..aa7b8b7 100644
--- a/bot/response.py
+++ b/bot/response.py
@@ -1,19 +1,20 @@
from datetime import datetime, timedelta, timezone
from typing import TypedDict, Any, List, Dict
-from db_utils import get_player, insert_player, delete_player, insert_pull, get_last_rolled_at, \
- get_random_character
-from add_character import add_character
+from db_utils import get_player, insert_player, delete_player, insert_pull, \
+ get_last_rolled_at, get_random_card, is_player_administrator
+from add_card import add_card
from config import GACHA_ROLL_INTERVAL
from custom_types import BotResponse, ParsedNotification
def do_roll(author: str) -> BotResponse:
- '''Determines whether the user can roll, then pulls a random character'''
+ '''Determines whether the user can roll, then pulls a random card'''
user_id = get_player(author)
if not user_id:
return {
- 'message':f'{author} 🛑 You haven’t signed up yet! Use the `signup` command to start playing.',
- 'attachment_urls': None
+ 'message': f'{author} 🛑 You haven’t signed up yet! Use the \
+`signup` command to start playing.',
+ 'attachment_urls': None
}
# Get date of user's last roll
date = get_last_rolled_at(user_id)
@@ -45,39 +46,43 @@ def do_roll(author: str) -> BotResponse:
'attachment_urls': None
}
- character = get_random_character()
+ card = get_random_card()
- if not character:
+ if not card:
return {
'message': f'{author} Uwaaa... something went wrong! No \
-characters found. 😿',
+cards found. 😿',
'attachment_urls': None
}
- insert_pull(user_id, character['id'])
- stars = '⭐️' * character['rarity']
+ insert_pull(user_id, card['id'])
+ stars = '⭐️' * card['rarity']
return {
'message': f'{author} 🎲 Congrats! You rolled {stars} \
-**{character['name']}**\nShe\'s all yours now~ 💖✨',
- 'attachment_urls': [character['image_url']]
+**{card['name']}**\nShe\'s all yours now~ 💖✨',
+ 'attachment_urls': [card['image_url']]
}
+
def do_signup(author: str) -> BotResponse:
'''Registers a new user if they haven’t signed up yet.'''
user_id = get_player(author)
if user_id:
return {
- 'message':f'{author} 👀 You’re already signed up! Let the rolling begin~ 🎲',
+ 'message': f'{author} 👀 You’re already signed up! Let the rolling \
+begin~ 🎲',
'attachment_urls': None
}
new_user_id = insert_player(author)
return {
- 'message': f'{author} ✅ Signed up successfully! Your gacha destiny begins now... ✨ Use the roll command to start!',
+ 'message': f'{author} ✅ Signed up successfully! Your gacha \
+destiny begins now... ✨ Use the roll command to start!',
'attachment_urls': None
}
+
def is_float(val: Any) -> bool:
'''Returns true if `val` can be converted to a float'''
try:
@@ -91,14 +96,14 @@ def do_create(
author: str,
arguments: List[str],
note_obj: Dict[str, Any]) -> BotResponse:
- '''Creates a character'''
+ '''Creates a card'''
# Example call from bot logic
image_url = note_obj.get('files', [{}])[0].get('url') \
if note_obj.get('files') else None
if not image_url:
return {
- 'message': f'{author} You need an image to create a character, \
+ 'message': f'{author} You need an image to create a card, \
dumbass.',
'attachment_urls': None
}
@@ -123,13 +128,13 @@ must be a decimal value between 0.0 and 1.0',
'attachment_urls': None
}
- character_id, file_id = add_character(
+ card_id, file_id = add_card(
name=arguments[0],
rarity=int(arguments[1]),
image_url=image_url
)
return {
- 'message': f'{author} Added {arguments[0]}, ID {character_id}.',
+ 'message': f'{author} Added {arguments[0]}, ID {card_id}.',
'attachment_urls': [file_id]
}
@@ -137,30 +142,43 @@ must be a decimal value between 0.0 and 1.0',
def do_help(author: str) -> BotResponse:
'''Provides a list of commands that the bot can do.'''
return {
- 'message':f'{author} Here\'s what I can do:\n \
- - `roll` Pulls a random character.\
- - `create ` Creates a character using a given image.\
- - `signup` Registers your account.\
- - `delete_account` Deletes your account.\
- - `help` Shows this message',
- 'attachment_urls': None
+ 'message': f'{author} Here\'s what I can do:\n\
+- `roll` Pulls a random card.\n\
+- `create ` Creates a card using a given image.\n\
+- `signup` Registers your account.\n\
+- `delete_account` Deletes your account.\n\
+- `help` Shows this message',
+ 'attachment_urls': None
}
-
+
+
def delete_account(author: str) -> BotResponse:
return {
- 'message':f'{author} ⚠️ This will permanently delete your account and all your cards.\n'
- 'If you’re sure, reply with `confirm_delete` to proceed.\n\n'
+ 'message': f'{author} ⚠️ This will permanently delete your account \
+and all your cards.\n'
+ 'If you’re sure, reply with `confirm_delete_account` to proceed.\n\n'
'**There is no undo.** Your gacha luck will be lost to the void... 💀✨',
'attachment_urls': None
}
+
def confirm_delete(author: str) -> BotResponse:
-
delete_player(author)
return {
- 'message':f'{author} 🧼 Your account and all your cards have been deleted. RIP your gacha history 🕊️✨',
+ 'message': f'{author} 🧼 Your account and all your cards have been \
+deleted. RIP your gacha history 🕊️✨',
+ 'attachment_urls': None
+ }
+
+
+def do_admin_test(author: str) -> BotResponse:
+ player_id = get_player(author)
+ is_admin = is_player_administrator(player_id)
+ return {
+ 'message': f'{author} You are {"not " if not is_admin else ""}an \
+admin.',
'attachment_urls': None
}
@@ -171,25 +189,23 @@ def generate_response(notification: ParsedNotification) -> BotResponse | None:
# Temporary response variable
res: BotResponse | None = None
- # TODO: Check if the user has an account
author = notification['author']
- user_id = get_player(author)
+ player_id = get_player(author)
command = notification['command']
- # Check if the user is an administrator
- # user_is_administrator = user_is_administrator()
# Unrestricted commands
match command:
+ case 'roll':
+ res = do_roll(author)
case 'signup':
res = do_signup(author)
case 'help':
res = do_help(author)
- case 'roll':
- res = do_roll(author)
case _:
pass
- if not user_id:
+ # Commands beyond this point require the user to have an account
+ if not player_id:
return res
# User commands
@@ -200,15 +216,18 @@ def generate_response(notification: ParsedNotification) -> BotResponse | None:
notification['arguments'],
notification['note_obj']
)
- case 'signup':
- res = do_signup(author)
case 'delete_account':
res = delete_account(author)
- case 'confirm_delete':
+ case 'confirm_delete_account':
res = confirm_delete(author)
+ case 'admin_test':
+ res = do_admin_test(author)
case _:
pass
- # if not user_is_administrator:
- return res
+
+ # Commands beyond this point require the user to be an administrator
+ if not is_player_administrator(player_id):
+ return res
# Administrator commands go here
+ return res
diff --git a/example_config.ini b/example_config.ini
index af7e0f2..25402e4 100644
--- a/example_config.ini
+++ b/example_config.ini
@@ -2,7 +2,7 @@
[application]
; Comma separated list of fedi handles for any administrator users
; More can be added through the application
-DefaultAdmins = ['admin@example.tld']
+DefaultAdmins = ["@localadmin", "remoteadmin@example.tld"]
; SQLite Database location
DatabaseLocation = ./gacha_game.db
diff --git a/migrations/0003_rename_tables.sql b/migrations/0003_rename_tables.sql
new file mode 100644
index 0000000..a3ba3a7
--- /dev/null
+++ b/migrations/0003_rename_tables.sql
@@ -0,0 +1,4 @@
+ALTER TABLE users RENAME TO players;
+ALTER TABLE characters RENAME TO cards;
+ALTER TABLE pulls RENAME user_id TO player_id;
+ALTER TABLE pulls RENAME character_id TO card_id;
diff --git a/migrations/0004_add_administrators.sql b/migrations/0004_add_administrators.sql
new file mode 100644
index 0000000..7503e21
--- /dev/null
+++ b/migrations/0004_add_administrators.sql
@@ -0,0 +1 @@
+ALTER TABLE players ADD COLUMN is_administrator BOOLEAN NOT NULL DEFAULT 0;
From 8ae6e25b95bca5643055d72d336c1b66c58de426 Mon Sep 17 00:00:00 2001
From: VD15
Date: Sat, 7 Jun 2025 20:40:27 +0100
Subject: [PATCH 08/56] Add instance whitelist
---
bot/config.py | 2 ++
bot/db_utils.py | 29 ++++++++++++++++
bot/notification.py | 6 ++--
bot/response.py | 81 +++++++++++++++++++++++++++++++++------------
example_config.ini | 5 ++-
5 files changed, 98 insertions(+), 25 deletions(-)
diff --git a/bot/config.py b/bot/config.py
index af806f9..9737608 100644
--- a/bot/config.py
+++ b/bot/config.py
@@ -49,6 +49,8 @@ INSTANCE = config['credentials']['Instance'].lower()
ADMINS = json.loads(config['application']['DefaultAdmins'])
# SQLite Database location
DB_PATH = config['application']['DatabaseLocation']
+# Whether to enable the instance whitelist
+USE_WHITELIST = config['application']['UseWhitelist']
NOTIFICATION_POLL_INTERVAL = int(config['notification']['PollInterval'])
NOTIFICATION_BATCH_SIZE = int(config['notification']['BatchSize'])
diff --git a/bot/db_utils.py b/bot/db_utils.py
index f7edd83..802e3f0 100644
--- a/bot/db_utils.py
+++ b/bot/db_utils.py
@@ -146,6 +146,35 @@ DESC",
return row[0] if row else 0
+def add_to_whitelist(instance: str) -> bool:
+ '''Adds an instance to the whitelist, returns false if instance was already
+ present'''
+ try:
+ CURSOR.execute(
+ 'INSERT INTO instance_whitelist (tld) VALUES (?)', (instance,))
+ return True
+ except sqlite3.IntegrityError:
+ return False
+
+
+def remove_from_whitelist(instance: str) -> bool:
+ '''Removes an instance to the whitelist, returns false if instance was not
+ present'''
+ CURSOR.execute(
+ 'DELETE FROM instance_whitelist WHERE tld = ?', (instance,))
+ return CURSOR.rowcount > 0
+
+
+def is_whitelisted(instance: str) -> bool:
+ '''Checks whether an instance is in the whitelist'''
+ if instance == 'local':
+ return True
+ CURSOR.execute(
+ 'SELECT * FROM instance_whitelist WHERE tld = ?', (instance,))
+ row = CURSOR.fetchone()
+ return row is not None
+
+
def get_config(key: str) -> str:
'''Reads the value for a specified config key from the db'''
CURSOR.execute("SELECT value FROM config WHERE key = ?", (key,))
diff --git a/bot/notification.py b/bot/notification.py
index 9427dbf..faac1d3 100644
--- a/bot/notification.py
+++ b/bot/notification.py
@@ -4,9 +4,9 @@ from typing import Dict, Any
import misskey
from misskey.exceptions import MisskeyAPIException
-from config import NOTIFICATION_BATCH_SIZE
+from config import NOTIFICATION_BATCH_SIZE, USE_WHITELIST
from parsing import parse_notification
-from db_utils import get_config, set_config
+from db_utils import get_config, set_config, is_whitelisted
from response import generate_response
from custom_types import BotResponse
@@ -24,7 +24,7 @@ def process_notification(
host = user.get('host') # None if local user
instance = host if host else 'local'
- if not (instance in WHITELISTED_INSTANCES or instance == 'local'):
+ if USE_WHITELIST and not is_whitelisted(instance):
print(f'⚠️ Blocked notification from untrusted instance: {instance}')
return
diff --git a/bot/response.py b/bot/response.py
index aa7b8b7..16bd05e 100644
--- a/bot/response.py
+++ b/bot/response.py
@@ -1,7 +1,6 @@
from datetime import datetime, timedelta, timezone
from typing import TypedDict, Any, List, Dict
-from db_utils import get_player, insert_player, delete_player, insert_pull, \
- get_last_rolled_at, get_random_card, is_player_administrator
+import db_utils as db
from add_card import add_card
from config import GACHA_ROLL_INTERVAL
from custom_types import BotResponse, ParsedNotification
@@ -9,7 +8,7 @@ from custom_types import BotResponse, ParsedNotification
def do_roll(author: str) -> BotResponse:
'''Determines whether the user can roll, then pulls a random card'''
- user_id = get_player(author)
+ user_id = db.get_player(author)
if not user_id:
return {
'message': f'{author} 🛑 You haven’t signed up yet! Use the \
@@ -17,7 +16,7 @@ def do_roll(author: str) -> BotResponse:
'attachment_urls': None
}
# Get date of user's last roll
- date = get_last_rolled_at(user_id)
+ date = db.get_last_rolled_at(user_id)
# No date means it's users first roll
if date:
@@ -46,7 +45,7 @@ def do_roll(author: str) -> BotResponse:
'attachment_urls': None
}
- card = get_random_card()
+ card = db.get_random_card()
if not card:
return {
@@ -55,7 +54,7 @@ cards found. 😿',
'attachment_urls': None
}
- insert_pull(user_id, card['id'])
+ db.insert_pull(user_id, card['id'])
stars = '⭐️' * card['rarity']
return {
'message': f'{author} 🎲 Congrats! You rolled {stars} \
@@ -66,7 +65,7 @@ cards found. 😿',
def do_signup(author: str) -> BotResponse:
'''Registers a new user if they haven’t signed up yet.'''
- user_id = get_player(author)
+ user_id = db.get_player(author)
if user_id:
return {
@@ -75,7 +74,7 @@ begin~ 🎲',
'attachment_urls': None
}
- new_user_id = insert_player(author)
+ new_user_id = db.insert_player(author)
return {
'message': f'{author} ✅ Signed up successfully! Your gacha \
destiny begins now... ✨ Use the roll command to start!',
@@ -164,7 +163,7 @@ and all your cards.\n'
def confirm_delete(author: str) -> BotResponse:
- delete_player(author)
+ db.delete_player(author)
return {
'message': f'{author} 🧼 Your account and all your cards have been \
@@ -173,14 +172,43 @@ deleted. RIP your gacha history 🕊️✨',
}
-def do_admin_test(author: str) -> BotResponse:
- player_id = get_player(author)
- is_admin = is_player_administrator(player_id)
- return {
- 'message': f'{author} You are {"not " if not is_admin else ""}an \
-admin.',
- 'attachment_urls': None
- }
+def do_whitelist(author: str, args: list[str]) -> BotResponse:
+ if len(args) == 0:
+ return {
+ 'message': f'{author} Please specify an instance to whitelist',
+ 'attachment_urls': None
+ }
+
+ if db.add_to_whitelist(args[0]):
+ return {
+ 'message': f'{author} Whitelisted instance: {args[0]}',
+ 'attachment_urls': None
+ }
+ else:
+ return {
+ 'message': f'{author} Instance already whitelisted: {args[0]}',
+ 'attachment_urls': None
+ }
+
+
+def do_unwhitelist(author: str, args: list[str]) -> BotResponse:
+ if len(args) == 0:
+ return {
+ 'message': f'{author} Please specify an instance to remove from \
+the whitelist',
+ 'attachment_urls': None
+ }
+
+ if db.remove_from_whitelist(args[0]):
+ return {
+ 'message': f'{author} Unwhitelisted instance: {args[0]}',
+ 'attachment_urls': None
+ }
+ else:
+ return {
+ 'message': f'{author} Instance not whitelisted: {args[0]}',
+ 'attachment_urls': None
+ }
def generate_response(notification: ParsedNotification) -> BotResponse | None:
@@ -190,7 +218,7 @@ def generate_response(notification: ParsedNotification) -> BotResponse | None:
# Temporary response variable
res: BotResponse | None = None
author = notification['author']
- player_id = get_player(author)
+ player_id = db.get_player(author)
command = notification['command']
# Unrestricted commands
@@ -220,14 +248,25 @@ def generate_response(notification: ParsedNotification) -> BotResponse | None:
res = delete_account(author)
case 'confirm_delete_account':
res = confirm_delete(author)
- case 'admin_test':
- res = do_admin_test(author)
case _:
pass
# Commands beyond this point require the user to be an administrator
- if not is_player_administrator(player_id):
+ if not db.is_player_administrator(player_id):
return res
+ # Admin commands
+ match command:
+ case 'whitelist':
+ res = do_whitelist(author, notification['arguments'])
+ case 'unwhitelist':
+ res = do_unwhitelist(author, notification['arguments'])
+ # case 'ban':
+ # res = do_ban(author, notification['arguments'])
+ # case 'unban':
+ # res = do_unban(author, notification['arguments'])
+ case _:
+ pass
+
# Administrator commands go here
return res
diff --git a/example_config.ini b/example_config.ini
index 25402e4..0ea2422 100644
--- a/example_config.ini
+++ b/example_config.ini
@@ -2,9 +2,12 @@
[application]
; Comma separated list of fedi handles for any administrator users
; More can be added through the application
-DefaultAdmins = ["@localadmin", "remoteadmin@example.tld"]
+DefaultAdmins = ["@localadmin", "@remoteadmin@example.tld"]
; SQLite Database location
DatabaseLocation = ./gacha_game.db
+; Whether to lmit access to the bot via an instance whitelist
+; The whitelist can be adjusted via the application
+UseWhitelist = False
[gacha]
; Number of seconds players have to wait between rolls
From 97b30c79f44ef28dc72f945a1bfbf3a555c673d6 Mon Sep 17 00:00:00 2001
From: VD15
Date: Sat, 7 Jun 2025 23:18:39 +0100
Subject: [PATCH 09/56] Add admin commands
---
bot/db_utils.py | 42 ++++++++++++++++++++---
bot/notification.py | 7 +++-
bot/parsing.py | 18 +++++-----
bot/response.py | 56 ++++++++++++++++++++++++++++---
migrations/0005_add_whitelist.sql | 7 ++++
5 files changed, 111 insertions(+), 19 deletions(-)
create mode 100644 migrations/0005_add_whitelist.sql
diff --git a/bot/db_utils.py b/bot/db_utils.py
index 802e3f0..94e915e 100644
--- a/bot/db_utils.py
+++ b/bot/db_utils.py
@@ -90,6 +90,9 @@ def delete_player(username: str) -> bool:
)
player = CURSOR.fetchone()
+ if not player:
+ return False
+
player_id = player[0]
# Delete pulls
@@ -107,10 +110,40 @@ def delete_player(username: str) -> bool:
return True
-def is_player_administrator(player_id: int) -> bool:
+def ban_player(username: str) -> bool:
+ '''Adds a player to the ban list.'''
+ try:
+ CURSOR.execute(
+ 'INSERT INTO banned_players (handle) VALUES (?)',
+ (username,)
+ )
+ return True
+ except sqlite3.IntegrityError:
+ return False
+
+
+def unban_player(username: str) -> bool:
+ '''Removes a player from the ban list.'''
CURSOR.execute(
- 'SELECT is_administrator FROM PLAYERS WHERE id = ? LIMIT 1',
- (player_id,)
+ 'DELETE FROM banned_players WHERE handle = ?',
+ (username,)
+ )
+ return CURSOR.rowcount > 0
+
+
+def is_player_banned(username: str) -> bool:
+ CURSOR.execute(
+ 'SELECT * FROM banned_players WHERE handle = ?',
+ (username,)
+ )
+ row = CURSOR.fetchone()
+ return row is not None
+
+
+def is_player_administrator(username: str) -> bool:
+ CURSOR.execute(
+ 'SELECT is_administrator FROM players WHERE username = ? LIMIT 1',
+ (username,)
)
row = CURSOR.fetchone()
return row[0] if row else False
@@ -151,7 +184,8 @@ def add_to_whitelist(instance: str) -> bool:
present'''
try:
CURSOR.execute(
- 'INSERT INTO instance_whitelist (tld) VALUES (?)', (instance,))
+ 'INSERT INTO instance_whitelist (tld) VALUES (?)', (instance,)
+ )
return True
except sqlite3.IntegrityError:
return False
diff --git a/bot/notification.py b/bot/notification.py
index faac1d3..deb8ec6 100644
--- a/bot/notification.py
+++ b/bot/notification.py
@@ -6,7 +6,7 @@ from misskey.exceptions import MisskeyAPIException
from config import NOTIFICATION_BATCH_SIZE, USE_WHITELIST
from parsing import parse_notification
-from db_utils import get_config, set_config, is_whitelisted
+from db_utils import get_config, set_config, is_whitelisted, is_player_banned
from response import generate_response
from custom_types import BotResponse
@@ -44,6 +44,11 @@ def process_notification(
if not parsed_notification:
return
+ author = parsed_notification['author']
+ if is_player_banned(author):
+ print(f'⚠️ Blocked notification from banned player: {author}')
+ return
+
# Get the note Id to reply to
note_id = notification.get('note', {}).get('id')
diff --git a/bot/parsing.py b/bot/parsing.py
index eece077..e1e8583 100644
--- a/bot/parsing.py
+++ b/bot/parsing.py
@@ -24,6 +24,8 @@ def parse_notification(
note_id = note_obj.get("id")
note = note_text.strip().lower() if note_text else ""
+ # Split words into tokens
+ parts = note.split()
# Check for both short and fully-qualified name mentions
username_variants = [
@@ -31,18 +33,16 @@ def parse_notification(
f'@{config.USER.split("@")[1]}'
]
- # Make sure the notification text explicitly mentions the bot
- if not any(variant in note for variant in username_variants):
+ # Notifs must consist of the initial mention and at least one other token
+ if len(parts) <= 1:
return None
- # Find command and arguments after the mention
- # Removes all mentions
- # regex = mentions that start with @ and may contain @domain
- cleaned_text = re.sub(r"@\w+(?:@\S+)?", "", note).strip()
- parts = cleaned_text.split()
+ # Make sure the first token is a mention to the bot
+ if not parts[0] in username_variants:
+ return None
- command = parts[0].lower() if parts else None
- arguments = parts[1:] if len(parts) > 1 else []
+ command = parts[1].lower()
+ arguments = parts[2:] if len(parts) > 2 else []
return {
'author': full_user,
diff --git a/bot/response.py b/bot/response.py
index 16bd05e..f21d7b0 100644
--- a/bot/response.py
+++ b/bot/response.py
@@ -211,6 +211,52 @@ the whitelist',
}
+def do_ban(author: str, args: list[str]) -> BotResponse:
+ if len(args) == 0:
+ return {
+ 'message': f'{author} Please specify a user to ban',
+ 'attachment_urls': None
+ }
+
+ if db.is_player_administrator(args[0]):
+ return {
+ 'message': f'{author} Cannot ban other administrators.',
+ 'attachment_urls': None
+ }
+
+ if db.ban_player(args[0]):
+ # Delete banned player's account
+ db.delete_player(args[0])
+ return {
+ 'message': f'{author} 🔨 **BONK!** Get banned, {args[0]}!',
+ 'attachment_urls': None
+ }
+ else:
+ return {
+ 'message': f'{author} Player is already banned: {args[0]}',
+ 'attachment_urls': None
+ }
+
+
+def do_unban(author: str, args: list[str]) -> BotResponse:
+ if len(args) == 0:
+ return {
+ 'message': f'{author} Please specify a user to unban',
+ 'attachment_urls': None
+ }
+
+ if db.unban_player(args[0]):
+ return {
+ 'message': f'{author} Player unbanned: {args[0]}!',
+ 'attachment_urls': None
+ }
+ else:
+ return {
+ 'message': f'{author} Player was not banned: {args[0]}',
+ 'attachment_urls': None
+ }
+
+
def generate_response(notification: ParsedNotification) -> BotResponse | None:
'''Given a command with arguments, processes the game state and
returns a response'''
@@ -252,7 +298,7 @@ def generate_response(notification: ParsedNotification) -> BotResponse | None:
pass
# Commands beyond this point require the user to be an administrator
- if not db.is_player_administrator(player_id):
+ if not db.is_player_administrator(author):
return res
# Admin commands
@@ -261,10 +307,10 @@ def generate_response(notification: ParsedNotification) -> BotResponse | None:
res = do_whitelist(author, notification['arguments'])
case 'unwhitelist':
res = do_unwhitelist(author, notification['arguments'])
- # case 'ban':
- # res = do_ban(author, notification['arguments'])
- # case 'unban':
- # res = do_unban(author, notification['arguments'])
+ case 'ban':
+ res = do_ban(author, notification['arguments'])
+ case 'unban':
+ res = do_unban(author, notification['arguments'])
case _:
pass
diff --git a/migrations/0005_add_whitelist.sql b/migrations/0005_add_whitelist.sql
new file mode 100644
index 0000000..d24f2e3
--- /dev/null
+++ b/migrations/0005_add_whitelist.sql
@@ -0,0 +1,7 @@
+CREATE TABLE IF NOT EXISTS instance_whitelist (
+ tld TEXT UNIQUE PRIMARY KEY
+);
+
+CREATE TABLE IF NOT EXISTS banned_players (
+ handle TEXT UNIQUE PRIMARY KEY
+);
From 4b1b8a53c7d691bfd2eda1d76d038298173b6ecf Mon Sep 17 00:00:00 2001
From: VD15
Date: Sat, 7 Jun 2025 23:25:48 +0100
Subject: [PATCH 10/56] Fix nonstandard apostrophe
---
bot/response.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/bot/response.py b/bot/response.py
index f21d7b0..b49de1e 100644
--- a/bot/response.py
+++ b/bot/response.py
@@ -155,7 +155,7 @@ def delete_account(author: str) -> BotResponse:
return {
'message': f'{author} ⚠️ This will permanently delete your account \
and all your cards.\n'
- 'If you’re sure, reply with `confirm_delete_account` to proceed.\n\n'
+ 'If you\'re sure, reply with `confirm_delete_account` to proceed.\n\n'
'**There is no undo.** Your gacha luck will be lost to the void... 💀✨',
'attachment_urls': None
From 59915be66170ffcf5596a9d30d384c7d7e899646 Mon Sep 17 00:00:00 2001
From: VD15
Date: Sat, 7 Jun 2025 23:59:07 +0100
Subject: [PATCH 11/56] Enable WAL for DB connections
---
.gitignore | 4 ++--
bot/db_utils.py | 1 +
2 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/.gitignore b/.gitignore
index e5543ec..b0a1050 100644
--- a/.gitignore
+++ b/.gitignore
@@ -183,7 +183,7 @@ cython_debug/
# Custom stuff
gacha_game*.db
-gacha_game*.db.*
+gacha_game*.db*
config*.ini
-.idea
\ No newline at end of file
+.idea
diff --git a/bot/db_utils.py b/bot/db_utils.py
index 94e915e..72b431f 100644
--- a/bot/db_utils.py
+++ b/bot/db_utils.py
@@ -16,6 +16,7 @@ def connect() -> None:
CONNECTION = sqlite3.connect(DB_PATH, autocommit=True)
CONNECTION.row_factory = sqlite3.Row
CURSOR = CONNECTION.cursor()
+ CURSOR.execute('pragma journal_mode=wal')
def setup_administrators() -> None:
From 1368c907a222d02387c23d956b50005501315a65 Mon Sep 17 00:00:00 2001
From: VD15
Date: Sun, 8 Jun 2025 00:09:02 +0100
Subject: [PATCH 12/56] Revert "Enable WAL for DB connections"
This reverts commit 59915be66170ffcf5596a9d30d384c7d7e899646.
---
.gitignore | 4 ++--
bot/db_utils.py | 1 -
2 files changed, 2 insertions(+), 3 deletions(-)
diff --git a/.gitignore b/.gitignore
index b0a1050..e5543ec 100644
--- a/.gitignore
+++ b/.gitignore
@@ -183,7 +183,7 @@ cython_debug/
# Custom stuff
gacha_game*.db
-gacha_game*.db*
+gacha_game*.db.*
config*.ini
-.idea
+.idea
\ No newline at end of file
diff --git a/bot/db_utils.py b/bot/db_utils.py
index 72b431f..94e915e 100644
--- a/bot/db_utils.py
+++ b/bot/db_utils.py
@@ -16,7 +16,6 @@ def connect() -> None:
CONNECTION = sqlite3.connect(DB_PATH, autocommit=True)
CONNECTION.row_factory = sqlite3.Row
CURSOR = CONNECTION.cursor()
- CURSOR.execute('pragma journal_mode=wal')
def setup_administrators() -> None:
From bad06c4f231fa31b938613c875fdf9aa00530cbf Mon Sep 17 00:00:00 2001
From: w
Date: Mon, 9 Jun 2025 23:40:37 -0300
Subject: [PATCH 13/56] docs index
---
docs/index.md | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
create mode 100644 docs/index.md
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..42cc59c
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,21 @@
+# 🎲 Kemoverse Gacha Game Documentation
+
+Welcome to the developer documentation for **Kemoverse**, a gacha trading card game in the Fediverse!
+Features collectible cards, rarity-based pulls, and integration with Misskey.
+Name comes from Kemonomimi and Fediverse.
+---
+
+## 📁 Table of Contents
+
+- [Installation](./install.md)
+- [Game Design](./design.md)
+- [Bot Architecture](./bot.md)
+- [Database Structure](./database.md)
+- [Card System](./cards.md)
+- [Web UI](./web.md)
+- [Theming and Assets](./theme.md)
+- [Contributing](./contributing.md)
+- [FAQ](./faq.md)
+
+---
+
From 3626949020839ce5392f6b852dfafc0e6d218050 Mon Sep 17 00:00:00 2001
From: w
Date: Mon, 9 Jun 2025 23:59:12 -0300
Subject: [PATCH 14/56] cleaned readme
---
docs/index.md | 3 ++
docs/install.md | 83 ++++++++++++++++++++++++++++++++++++++++++++
readme.md | 92 ++-----------------------------------------------
3 files changed, 89 insertions(+), 89 deletions(-)
create mode 100644 docs/install.md
diff --git a/docs/index.md b/docs/index.md
index 42cc59c..3b6683c 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,8 +1,11 @@
# 🎲 Kemoverse Gacha Game Documentation
Welcome to the developer documentation for **Kemoverse**, a gacha trading card game in the Fediverse!
+
Features collectible cards, rarity-based pulls, and integration with Misskey.
+
Name comes from Kemonomimi and Fediverse.
+
---
## 📁 Table of Contents
diff --git a/docs/install.md b/docs/install.md
new file mode 100644
index 0000000..e5f8658
--- /dev/null
+++ b/docs/install.md
@@ -0,0 +1,83 @@
+
+## 🧪 Installation
+
+### Download and install dependencies
+
+Clone the repo
+
+```sh
+git clone https://git.waifuism.life/waifu/kemoverse.git
+cd kemoverse
+```
+
+Setup a virtual environment (Optional, recommended)
+
+```sh
+python3 -m venv venv
+source venv/bin/activate
+```
+
+Install project dependencies via pip
+
+```sh
+python3 -m pip install -r requirements.txt
+```
+
+### Setup config file
+
+A sample config file is included with the project as a template: `example_config.ini`
+
+Create a copy of this file and replace its' values with your own. Consult the
+template for more information about individual config values and their meaning.
+
+Config files are environment-specific. Use `config_dev.ini` for development and
+`config_prod.ini` for production. Switch between environments using the
+`KEMOVERSE_ENV` environment variable.
+
+```sh
+cp example_config.ini config_dev.ini
+# Edit config_dev.ini
+```
+
+### Setup database
+
+To set up the database, run:
+
+```sh
+KEMOVERSE_ENV=dev python3 setup_db.py
+```
+
+### Run the bot
+
+```sh
+KEMOVERSE_ENV=dev ./startup.sh
+```
+
+If all goes well, you should now be able to interact with the bot.
+
+### Running in production
+
+To run the the in a production environment, use `KEMOVERSE_ENV=prod`. You will
+also need to create a `config_prod.ini` file and run the database setup step
+again if pointing prod to a different database. (you are pointing dev and prod
+to different databases, right? 🤨)
+
+### Updating
+
+To update the bot, first pull new changes from upstream:
+
+```sh
+git pull
+```
+
+Then run any database migrations. We recommend testing in dev beforehand to
+make sure nothing breaks in the update process.
+
+**Always backup your prod database before running any migrations!**
+
+```sh
+# Backup database file
+cp gacha_game_dev.db gacha_game_dev.db.bak
+# Run migrations
+KEMOVERSE_ENV=dev python3 setup_db.py
+```
diff --git a/readme.md b/readme.md
index 40d723d..37b9849 100644
--- a/readme.md
+++ b/readme.md
@@ -1,12 +1,9 @@
# Kemoverse
A gacha-style bot for the Fediverse built with Python. Users can roll for characters, trade, duel, and perhaps engage with popularity-based mechanics. Currently designed for use with Misskey. Name comes from Kemonomimi and Fediverse.
-
-## Installation
-
-## Roadmap
-
-
+
+
+
## 🔧 Features
@@ -57,89 +54,6 @@ A gacha-style bot for the Fediverse built with Python. Users can roll for charac
The bot is meant to feel *light, fun, and competitive*. Mixing social, gacha and duel tactics.
-## 🧪 Installation
-
-### Download and install dependencies
-
-Clone the repo
-
-```sh
-git clone https://git.waifuism.life/waifu/kemoverse.git
-cd kemoverse
-```
-
-Setup a virtual environment (Optional, recommended)
-
-```sh
-python3 -m venv venv
-source venv/bin/activate
-```
-
-Install project dependencies via pip
-
-```sh
-python3 -m pip install -r requirements.txt
-```
-
-### Setup config file
-
-A sample config file is included with the project as a template: `example_config.ini`
-
-Create a copy of this file and replace its' values with your own. Consult the
-template for more information about individual config values and their meaning.
-
-Config files are environment-specific. Use `config_dev.ini` for development and
-`config_prod.ini` for production. Switch between environments using the
-`KEMOVERSE_ENV` environment variable.
-
-```sh
-cp example_config.ini config_dev.ini
-# Edit config_dev.ini
-```
-
-### Setup database
-
-To set up the database, run:
-
-```sh
-KEMOVERSE_ENV=dev python3 setup_db.py
-```
-
-### Run the bot
-
-```sh
-KEMOVERSE_ENV=dev ./startup.sh
-```
-
-If all goes well, you should now be able to interact with the bot.
-
-### Running in production
-
-To run the the in a production environment, use `KEMOVERSE_ENV=prod`. You will
-also need to create a `config_prod.ini` file and run the database setup step
-again if pointing prod to a different database. (you are pointing dev and prod
-to different databases, right? 🤨)
-
-### Updating
-
-To update the bot, first pull new changes from upstream:
-
-```sh
-git pull
-```
-
-Then run any database migrations. We recommend testing in dev beforehand to
-make sure nothing breaks in the update process.
-
-**Always backup your prod database before running any migrations!**
-
-```sh
-# Backup database file
-cp gacha_game_dev.db gacha_game_dev.db.bak
-# Run migrations
-KEMOVERSE_ENV=dev python3 setup_db.py
-```
-
```mermaid
flowchart TD
From 62cc80033db95a4df7f7b7e78c8158f0a1c95726 Mon Sep 17 00:00:00 2001
From: w
Date: Tue, 10 Jun 2025 00:23:28 -0300
Subject: [PATCH 15/56] docs
---
docs/index.md | 2 +-
readme.md | 9 ++++++++-
2 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/docs/index.md b/docs/index.md
index 3b6683c..292d673 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,4 +1,4 @@
-# 🎲 Kemoverse Gacha Game Documentation
+# 🎲 Kemoverse Documentation
Welcome to the developer documentation for **Kemoverse**, a gacha trading card game in the Fediverse!
diff --git a/readme.md b/readme.md
index 37b9849..437b09f 100644
--- a/readme.md
+++ b/readme.md
@@ -5,6 +5,12 @@ A gacha-style bot for the Fediverse built with Python. Users can roll for charac
+## 📝 Docs
+
+👉 [**Start reading the docs**](./docs/index.md)
+
+🤌 [**Install instructions for those in a rush**](docs/install.md)
+
## 🔧 Features
### ✅ Implemented
@@ -12,10 +18,11 @@ A gacha-style bot for the Fediverse built with Python. Users can roll for charac
- 🧠 Core database structure for cards
- 📦 Basic support for storing pulls per player
- ⏱️ Time-based limitations on rolls
+- ⚠️ Explicit account creation/deletion
### 🧩 In Progress
- 📝 Whitelist system to limit access
-- ⚠️ Explicit account creation/deletion
+
## 🧠 Roadmap
From fa21ce201dfed12814bde078025ab78139e07de0 Mon Sep 17 00:00:00 2001
From: w
Date: Tue, 10 Jun 2025 00:32:53 -0300
Subject: [PATCH 16/56] Theme and visual identity
---
docs/theme.md | 33 +++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
create mode 100644 docs/theme.md
diff --git a/docs/theme.md b/docs/theme.md
new file mode 100644
index 0000000..69e9ed3
--- /dev/null
+++ b/docs/theme.md
@@ -0,0 +1,33 @@
+Welcome to the **Visual Identity** guide for the Kemoverse. This page contains the standard colors, logos, and graphic elements used across the game (cards, UI, web presence, bots, etc). Please follow these guidelines to ensure consistency.
+
+---
+
+## 🟢 Primary Color Palette
+
+| Color Name | Hex Code | Usage |
+|----------------|------------|--------------------------------------|
+| Green | `#5aa02c` | Main buttons, links, headers |
+| Midnight Black | `#1A1A1A` | Backgrounds, dark mode |
+| Misty White | `#FAFAFA` | Default backgrounds, light text bg |
+| Soft Gray | `#CCCCCC` | Borders, placeholders, separators |
+| Highlight Green | `#8dd35f` | Alerts, emphasis, icons |
+| Rarity Gold | `#FFD700` | Special rare cards, SSR outlines |
+| Rarity Silver | `#C0C0C0` | Rare card text, stat glow effects |
+
+> ✅ Use `Green` and `Misty White` for the standard UI. Avoid mixing in extra palettes unless explicitly needed.
+
+---
+
+## 🖼 Logos
+
+### Main Logo
+
+
+
+
+
+- File: `web/static/logo.png`
+- Usage: Website header, favicon, bot avatar, watermark
+
+
+---
\ No newline at end of file
From 81c890a83dcd5720165eb413d785057705518a7e Mon Sep 17 00:00:00 2001
From: w
Date: Wed, 11 Jun 2025 22:06:17 -0300
Subject: [PATCH 17/56] license change
---
LICENSE | 722 +++++++++++++++++++++++++++-----------------------------
1 file changed, 354 insertions(+), 368 deletions(-)
diff --git a/LICENSE b/LICENSE
index f288702..c6f01c6 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,200 +1,192 @@
- GNU GENERAL PUBLIC LICENSE
- Version 3, 29 June 2007
+# GNU AFFERO GENERAL PUBLIC LICENSE
- Copyright (C) 2007 Free Software Foundation, Inc.
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
+Version 3, 19 November 2007
- Preamble
+Copyright (C) 2007 Free Software Foundation, Inc.
+
- The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
- The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works. By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users. We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors. You can apply it to
-your programs, too.
+## Preamble
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
+The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains
+free software for all its users.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
- To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights. Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
+Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
- For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received. You must make sure that they, too, receive
-or can get the source code. And you must show them these terms so they
-know their rights.
+A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+encouraged by the resulting cooperation. However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
- Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
+The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community. It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server. Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
- For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software. For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
+An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing
+under this license.
- Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so. This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software. The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable. Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products. If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
- Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary. To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
- The precise terms and conditions for copying, distribution and
+The precise terms and conditions for copying, distribution and
modification follow.
- TERMS AND CONDITIONS
+## TERMS AND CONDITIONS
- 0. Definitions.
+### 0. Definitions.
- "This License" refers to version 3 of the GNU General Public License.
+"This License" refers to version 3 of the GNU Affero General Public
+License.
- "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
+"Copyright" also means copyright-like laws that apply to other kinds
+of works, such as semiconductor masks.
- "The Program" refers to any copyrightable work licensed under this
-License. Each licensee is addressed as "you". "Licensees" and
+"The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
- To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy. The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
+To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of
+an exact copy. The resulting work is called a "modified version" of
+the earlier work or a work "based on" the earlier work.
- A "covered work" means either the unmodified Program or a work based
+A "covered work" means either the unmodified Program or a work based
on the Program.
- To "propagate" a work means to do anything with it that, without
+To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy. Propagation includes copying,
+computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
- To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies. Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
+To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user
+through a computer network, with no transfer of a copy, is not
+conveying.
- An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
+An interactive user interface displays "Appropriate Legal Notices" to
+the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License. If
+work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
- 1. Source Code.
+### 1. Source Code.
- The "source code" for a work means the preferred form of the work
-for making modifications to it. "Object code" means any non-source
-form of a work.
+The "source code" for a work means the preferred form of the work for
+making modifications to it. "Object code" means any non-source form of
+a work.
- A "Standard Interface" means an interface that either is an official
+A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
- The "System Libraries" of an executable work include anything, other
+The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form. A
+implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
- The "Corresponding Source" for a work in object code form means all
+The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
-control those activities. However, it does not include the work's
+control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
-which are not part of the work. For example, Corresponding Source
+which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
- The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
+The Corresponding Source need not include anything that users can
+regenerate automatically from other parts of the Corresponding Source.
- The Corresponding Source for a work in source code form is that
-same work.
+The Corresponding Source for a work in source code form is that same
+work.
- 2. Basic Permissions.
+### 2. Basic Permissions.
- All rights granted under this License are granted for the term of
+All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
-conditions are met. This License explicitly affirms your unlimited
-permission to run the unmodified Program. The output from running a
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
-content, constitutes a covered work. This License acknowledges your
+content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
- You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force. You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright. Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
+You may make, run and propagate covered works that you do not convey,
+without conditions so long as your license otherwise remains in force.
+You may convey covered works to others for the sole purpose of having
+them make modifications exclusively for you, or provide you with
+facilities for running those works, provided that you comply with the
+terms of this License in conveying all material for which you do not
+control copyright. Those thus making or running the covered works for
+you must do so exclusively on your behalf, under your direction and
+control, on terms that prohibit them from making any copies of your
+copyrighted material outside their relationship with you.
- Conveying under any other circumstances is permitted solely under
-the conditions stated below. Sublicensing is not allowed; section 10
-makes it unnecessary.
+Conveying under any other circumstances is permitted solely under the
+conditions stated below. Sublicensing is not allowed; section 10 makes
+it unnecessary.
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
- No covered work shall be deemed part of an effective technological
+No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
- When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such
+circumvention is effected by exercising rights under this License with
+respect to the covered work, and you disclaim any intention to limit
+operation or modification of the work as a means of enforcing, against
+the work's users, your or third parties' legal rights to forbid
+circumvention of technological measures.
- 4. Conveying Verbatim Copies.
+### 4. Conveying Verbatim Copies.
- You may convey verbatim copies of the Program's source code as you
+You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
@@ -202,59 +194,56 @@ non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
- You may charge any price or no price for each copy that you convey,
+You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
- 5. Conveying Modified Source Versions.
+### 5. Conveying Modified Source Versions.
- You may convey a work based on the Program, or the modifications to
+You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
+terms of section 4, provided that you also meet all of these
+conditions:
- a) The work must carry prominent notices stating that you modified
+- a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
-
- b) The work must carry prominent notices stating that it is
- released under this License and any conditions added under section
- 7. This requirement modifies the requirement in section 4 to
- "keep intact all notices".
-
- c) You must license the entire work, as a whole, under this
- License to anyone who comes into possession of a copy. This
+- b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under
+ section 7. This requirement modifies the requirement in section 4
+ to "keep intact all notices".
+- c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
- regardless of how they are packaged. This License gives no
+ regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
-
- d) If the work has interactive user interfaces, each must display
+- d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
- A compilation of a covered work with other separate and independent
+A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit. Inclusion of a covered work
+beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
- 6. Conveying Non-Source Forms.
+### 6. Conveying Non-Source Forms.
- You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
+You may convey a covered work in object code form under the terms of
+sections 4 and 5, provided that you also convey the machine-readable
+Corresponding Source under the terms of this License, in one of these
+ways:
- a) Convey the object code in, or embodied in, a physical product
+- a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
-
- b) Convey the object code in, or embodied in, a physical product
+- b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
@@ -263,196 +252,190 @@ in one of these ways:
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
- conveying of source, or (2) access to copy the
- Corresponding Source from a network server at no charge.
-
- c) Convey individual copies of the object code with a copy of the
- written offer to provide the Corresponding Source. This
+ conveying of source, or (2) access to copy the Corresponding
+ Source from a network server at no charge.
+- c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
-
- d) Convey the object code by offering access from a designated
+- d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
- further charge. You need not require recipients to copy the
- Corresponding Source along with the object code. If the place to
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
- Corresponding Source. Regardless of what server hosts the
+ Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
+- e) Convey the object code using peer-to-peer transmission,
+ provided you inform other peers where the object code and
+ Corresponding Source of the work are being offered to the general
+ public at no charge under subsection 6d.
- e) Convey the object code using peer-to-peer transmission, provided
- you inform other peers where the object code and Corresponding
- Source of the work are being offered to the general public at no
- charge under subsection 6d.
-
- A separable portion of the object code, whose source code is excluded
+A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
- A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling. In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage. For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product. A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
+A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal,
+family, or household purposes, or (2) anything designed or sold for
+incorporation into a dwelling. In determining whether a product is a
+consumer product, doubtful cases shall be resolved in favor of
+coverage. For a particular product received by a particular user,
+"normally used" refers to a typical or common use of that class of
+product, regardless of the status of the particular user or of the way
+in which the particular user actually uses, or expects or is expected
+to use, the product. A product is a consumer product regardless of
+whether the product has substantial commercial, industrial or
+non-consumer uses, unless such uses represent the only significant
+mode of use of the product.
- "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source. The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
+"Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to
+install and execute modified versions of a covered work in that User
+Product from a modified version of its Corresponding Source. The
+information must suffice to ensure that the continued functioning of
+the modified object code is in no case prevented or interfered with
+solely because modification has been made.
- If you convey an object code work under this section in, or with, or
+If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
-by the Installation Information. But this requirement does not apply
+by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
- The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed. Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
+The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or
+updates for a work that has been modified or installed by the
+recipient, or for the User Product in which it has been modified or
+installed. Access to a network may be denied when the modification
+itself materially and adversely affects the operation of the network
+or violates the rules and protocols for communication across the
+network.
- Corresponding Source conveyed, and Installation Information provided,
+Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
- 7. Additional Terms.
+### 7. Additional Terms.
- "Additional permissions" are terms that supplement the terms of this
+"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
-that they are valid under applicable law. If additional permissions
+that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
- When you convey a copy of a covered work, you may at your option
+When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
-it. (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.) You may place
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
- Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
+Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders
+of that material) supplement the terms of this License with terms:
- a) Disclaiming warranty or limiting liability differently from the
+- a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
-
- b) Requiring preservation of specified reasonable legal notices or
+- b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
-
- c) Prohibiting misrepresentation of the origin of that material, or
- requiring that modified versions of such material be marked in
+- c) Prohibiting misrepresentation of the origin of that material,
+ or requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
-
- d) Limiting the use for publicity purposes of names of licensors or
- authors of the material; or
-
- e) Declining to grant rights under trademark law for use of some
+- d) Limiting the use for publicity purposes of names of licensors
+ or authors of the material; or
+- e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
+- f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions
+ of it) with contractual assumptions of liability to the recipient,
+ for any liability that these contractual assumptions directly
+ impose on those licensors and authors.
- f) Requiring indemnification of licensors and authors of that
- material by anyone who conveys the material (or modified versions of
- it) with contractual assumptions of liability to the recipient, for
- any liability that these contractual assumptions directly impose on
- those licensors and authors.
-
- All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10. If the Program as you
+All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
-restriction, you may remove that term. If a license document contains
+restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
- If you add terms to a covered work in accord with this section, you
+If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
- Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
+Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions; the
+above requirements apply either way.
- 8. Termination.
+### 8. Termination.
- You may not propagate or modify a covered work except as expressly
-provided under this License. Any attempt otherwise to propagate or
+You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
- However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
+However, if you cease all violation of this License, then your license
+from a particular copyright holder is reinstated (a) provisionally,
+unless and until the copyright holder explicitly and finally
+terminates your license, and (b) permanently, if the copyright holder
+fails to notify you of the violation by some reasonable means prior to
+60 days after the cessation.
- Moreover, your license from a particular copyright holder is
+Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
- Termination of your rights under this section does not terminate the
+Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
-this License. If your rights have been terminated and not permanently
+this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
- 9. Acceptance Not Required for Having Copies.
+### 9. Acceptance Not Required for Having Copies.
- You are not required to accept this License in order to receive or
-run a copy of the Program. Ancillary propagation of a covered work
+You are not required to accept this License in order to receive or run
+a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance. However,
+to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
-modify any covered work. These actions infringe copyright if you do
-not accept this License. Therefore, by modifying or propagating a
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
- 10. Automatic Licensing of Downstream Recipients.
+### 10. Automatic Licensing of Downstream Recipients.
- Each time you convey a covered work, the recipient automatically
+Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License. You are not responsible
+propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
- An "entity transaction" is a transaction transferring control of an
+An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations. If propagation of a covered
+organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
@@ -460,43 +443,43 @@ give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
- You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License. For example, you may
+You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
- 11. Patents.
+### 11. Patents.
- A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based. The
+A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
- A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
+A contributor's "essential patent claims" are all patent claims owned
+or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version. For
+consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
- Each contributor grants you a non-exclusive, worldwide, royalty-free
+Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
- In the following three paragraphs, a "patent license" is any express
+In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
-sue for patent infringement). To "grant" such a patent license to a
+sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
- If you convey a covered work, knowingly relying on a patent license,
+If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
@@ -504,13 +487,13 @@ then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
-license to downstream recipients. "Knowingly relying" means you have
+license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
- If, pursuant to or in connection with a single transaction or
+If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
@@ -518,157 +501,160 @@ or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
- A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License. You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
+A patent license is "discriminatory" if it does not include within the
+scope of its coverage, prohibits the exercise of, or is conditioned on
+the non-exercise of one or more of the rights that are specifically
+granted under this License. You may not convey a covered work if you
+are a party to an arrangement with a third party that is in the
+business of distributing software, under which you make payment to the
+third party based on the extent of your activity of conveying the
+work, and under which the third party grants, to any of the parties
+who would receive the covered work from you, a discriminatory patent
+license (a) in connection with copies of the covered work conveyed by
+you (or copies made from those copies), or (b) primarily for and in
+connection with specific products or compilations that contain the
+covered work, unless you entered into that arrangement, or that patent
+license was granted, prior to 28 March 2007.
- Nothing in this License shall be construed as excluding or limiting
+Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
- 12. No Surrender of Others' Freedom.
+### 12. No Surrender of Others' Freedom.
- If conditions are imposed on you (whether by court order, agreement or
+If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all. For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under
+this License and any other pertinent obligations, then as a
+consequence you may not convey it at all. For example, if you agree to
+terms that obligate you to collect a royalty for further conveying
+from those to whom you convey the Program, the only way you could
+satisfy both those terms and this License would be to refrain entirely
+from conveying the Program.
- 13. Use with the GNU Affero General Public License.
+### 13. Remote Network Interaction; Use with the GNU General Public License.
- Notwithstanding any other provision of this License, you have
+Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your
+version supports such interaction) an opportunity to receive the
+Corresponding Source of your version by providing access to the
+Corresponding Source from a network server at no charge, through some
+standard or customary means of facilitating copying of software. This
+Corresponding Source shall include the Corresponding Source for any
+work covered by version 3 of the GNU General Public License that is
+incorporated pursuant to the following paragraph.
+
+Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work. The terms of this
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
- 14. Revised Versions of this License.
+### 14. Revised Versions of this License.
- The Free Software Foundation may publish revised and/or new versions of
-the GNU 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.
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Affero 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
-Program specifies that a certain numbered version of the GNU General
+Each version is given a distinguishing version number. If the Program
+specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
+Foundation. If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever
+published by the Free Software Foundation.
- If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
+If the Program specifies that a proxy can decide which future versions
+of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
- Later license versions may give you additional or different
-permissions. However, no additional obligations are imposed on any
+Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
- 15. Disclaimer of Warranty.
+### 15. Disclaimer of Warranty.
- THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
+WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
+PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
+DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+CORRECTION.
- 16. Limitation of Liability.
+### 16. Limitation of Liability.
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
+CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
+ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
+NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
+LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
+TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
+PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
- 17. Interpretation of Sections 15 and 16.
+### 17. Interpretation of Sections 15 and 16.
- If the disclaimer of warranty and limitation of liability provided
+If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
- END OF TERMS AND CONDITIONS
+END OF TERMS AND CONDITIONS
- How to Apply These Terms to Your New Programs
+## How to Apply These Terms to Your New Programs
- If you develop a new program, and you want it to be of the greatest
+If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
+free software which everyone can redistribute and change under these
+terms.
- To do so, attach the following notices to the program. It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
+To do so, attach the following notices to the program. It is safest to
+attach them to the start of each source file to most effectively state
+the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
-
- Copyright (C)
+
+ Copyright (C)
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as
+ published by the Free Software Foundation, either version 3 of the
+ License, or (at your option) any later version.
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Affero General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with this program. If not, see .
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see .
-Also add information on how to contact you by electronic and paper mail.
+Also add information on how to contact you by electronic and paper
+mail.
- If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
+If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for
+the specific requirements.
- Copyright (C)
- This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
- This is free software, and you are welcome to redistribute it
- under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License. Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
- You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-.
-
- The GNU General Public License does not permit incorporating your program
-into proprietary programs. If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library. If this is what you want to do, use the GNU Lesser General
-Public License instead of this License. But first, please read
-.
+You should also get your employer (if you work as a programmer) or
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. For more information on this, and how to apply and follow
+the GNU AGPL, see .
From df76fb91311939d34c0b5e5fe40649e2679b98b8 Mon Sep 17 00:00:00 2001
From: w
Date: Wed, 11 Jun 2025 22:29:06 -0300
Subject: [PATCH 18/56] adding license to main files
---
bot/bot_app.py | 16 ++++++++++++++++
setup_db.py | 16 ++++++++++++++++
startup.sh | 16 ++++++++++++++++
web/app.py | 16 ++++++++++++++++
4 files changed, 64 insertions(+)
diff --git a/bot/bot_app.py b/bot/bot_app.py
index 825695e..38ac5d6 100644
--- a/bot/bot_app.py
+++ b/bot/bot_app.py
@@ -1,3 +1,19 @@
+#Kemoverse - a gacha-style bot for the Fediverse.
+#Copyright © 2025 Waifu
+#
+#This program is free software: you can redistribute it and/or modify
+#it under the terms of the GNU Affero General Public License as
+#published by the Free Software Foundation, either version 3 of the
+#License, or (at your option) any later version.
+#
+#This program is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+#GNU Affero General Public License for more details.
+#
+#You should have received a copy of the GNU Affero General Public License
+#along with this program. If not, see https://www.gnu.org/licenses/.
+
import time
import misskey as misskey
from client import client_connection
diff --git a/setup_db.py b/setup_db.py
index 241bb4e..8cb5196 100644
--- a/setup_db.py
+++ b/setup_db.py
@@ -1,3 +1,19 @@
+#Kemoverse - a gacha-style bot for the Fediverse.
+#Copyright © 2025 Waifu
+#
+#This program is free software: you can redistribute it and/or modify
+#it under the terms of the GNU Affero General Public License as
+#published by the Free Software Foundation, either version 3 of the
+#License, or (at your option) any later version.
+#
+#This program is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+#GNU Affero General Public License for more details.
+#
+#You should have received a copy of the GNU Affero General Public License
+#along with this program. If not, see https://www.gnu.org/licenses/.
+
import sqlite3
import traceback
import os
diff --git a/startup.sh b/startup.sh
index 7c216b6..e8c3bed 100755
--- a/startup.sh
+++ b/startup.sh
@@ -1,5 +1,21 @@
#!/bin/bash
+#Kemoverse - a gacha-style bot for the Fediverse.
+#Copyright © 2025 Waifu
+#
+#This program is free software: you can redistribute it and/or modify
+#it under the terms of the GNU Affero General Public License as
+#published by the Free Software Foundation, either version 3 of the
+#License, or (at your option) any later version.
+#
+#This program is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+#GNU Affero General Public License for more details.
+#
+#You should have received a copy of the GNU Affero General Public License
+#along with this program. If not, see https://www.gnu.org/licenses/.
+
# Navigate to the project directory (optional)
cd "$(dirname "$0")"
diff --git a/web/app.py b/web/app.py
index 61ed38f..9ede0e4 100644
--- a/web/app.py
+++ b/web/app.py
@@ -1,3 +1,19 @@
+#Kemoverse - a gacha-style bot for the Fediverse.
+#Copyright © 2025 Waifu
+#
+#This program is free software: you can redistribute it and/or modify
+#it under the terms of the GNU Affero General Public License as
+#published by the Free Software Foundation, either version 3 of the
+#License, or (at your option) any later version.
+#
+#This program is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+#GNU Affero General Public License for more details.
+#
+#You should have received a copy of the GNU Affero General Public License
+#along with this program. If not, see https://www.gnu.org/licenses/.
+
import sqlite3
from flask import Flask, render_template, abort
From 2b194f3c9edf1868a25a50f951ab955a3a7685bb Mon Sep 17 00:00:00 2001
From: w
Date: Wed, 11 Jun 2025 22:42:57 -0300
Subject: [PATCH 19/56] readme changes for license
---
readme.md | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/readme.md b/readme.md
index 437b09f..ed33ec4 100644
--- a/readme.md
+++ b/readme.md
@@ -61,6 +61,23 @@ A gacha-style bot for the Fediverse built with Python. Users can roll for charac
The bot is meant to feel *light, fun, and competitive*. Mixing social, gacha and duel tactics.
+## 📝 License
+
+This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).
+
+This means:
+
+- You are free to use, modify, and redistribute this software under the same license.
+
+- If you modify and deploy the software (for example, as part of a web service), you must also make the source code of your modified version available to users of that service.
+
+You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.
+The full license text can be found here: https://www.gnu.org/licenses/agpl-3.0.html
+
+The AGPL is designed to ensure that software freedom is preserved, especially in networked environments. If you improve this project or build something on top of it, please give back to the community by sharing your changes too.
+
+Unless another license is listed, every file in the project is licensed under the GNU General Public License version 3 (or at your option), any later version.
+
```mermaid
flowchart TD
From e0cf42f8f60f7b6c933894d89ec7388708ef8b6c Mon Sep 17 00:00:00 2001
From: Moon
Date: Thu, 12 Jun 2025 11:03:12 +0900
Subject: [PATCH 20/56] baseline fedi abstraction stuff.
---
.tool-versions | 1 +
CLAUDE.md | 31 ++++++++
bot/config.py | 14 +++-
bot/fediverse_factory.py | 31 ++++++++
bot/fediverse_service.py | 57 ++++++++++++++
bot/fediverse_types.py | 73 ++++++++++++++++++
bot/misskey_service.py | 141 +++++++++++++++++++++++++++++++++++
bot/pleroma_service.py | 155 +++++++++++++++++++++++++++++++++++++++
requirements.txt | 1 +
9 files changed, 503 insertions(+), 1 deletion(-)
create mode 100644 .tool-versions
create mode 100644 CLAUDE.md
create mode 100644 bot/fediverse_factory.py
create mode 100644 bot/fediverse_service.py
create mode 100644 bot/fediverse_types.py
create mode 100644 bot/misskey_service.py
create mode 100644 bot/pleroma_service.py
diff --git a/.tool-versions b/.tool-versions
new file mode 100644
index 0000000..45e4b9f
--- /dev/null
+++ b/.tool-versions
@@ -0,0 +1 @@
+nodejs 23.4.0
diff --git a/CLAUDE.md b/CLAUDE.md
new file mode 100644
index 0000000..2e60baf
--- /dev/null
+++ b/CLAUDE.md
@@ -0,0 +1,31 @@
+# Kemoverse - Fediverse Gacha Bot
+
+A Python-based gacha-style bot for the Fediverse that interfaces with either Misskey or Pleroma instances.
+
+## Project Overview
+- **Language**: Python 3.11+
+- **Framework**: Flask for web interface
+- **Database**: SQLite
+- **Fediverse Support**: Configurable for Misskey or Pleroma instances
+- **API Integration**: Uses Misskey.py library for Fediverse API communication
+
+## Key Components
+- `bot/` - Core bot functionality including gacha mechanics, character management, and API interactions
+- `web/` - Flask web application for user interface and card management
+- `db.py` - Database utilities and schema management
+- `config.ini` - Instance configuration (API keys, instance URL, admin users)
+
+## Configuration
+The bot is configured via `config.ini` to connect to either a Misskey or Pleroma Fediverse instance. Key settings include:
+- Instance URL and API credentials
+- Bot user account details
+- Administrator user permissions
+- Database location
+
+## Development Commands
+- Install dependencies: `pip install -r requirements.txt`
+- Run bot: `python dev_runner.py`
+- Start web interface: `python web/app.py`
+
+## Testing
+Run tests with appropriate Python testing framework (check for pytest, unittest, or similar in project).
\ No newline at end of file
diff --git a/bot/config.py b/bot/config.py
index 227f949..5b5848f 100644
--- a/bot/config.py
+++ b/bot/config.py
@@ -38,9 +38,21 @@ config.read(get_config_file())
USER = config['credentials']['User'].lower()
# API key for the bot
KEY = config['credentials']['Token']
-# Bot's Misskey instance URL
+# Bot's Misskey/Pleroma instance URL
INSTANCE = config['credentials']['Instance'].lower()
+# Instance type validation
+if 'InstanceType' not in config['application']:
+ raise ValueError("InstanceType must be specified in config.ini")
+
+instance_type = config['application']['InstanceType'].lower()
+if instance_type not in ('misskey', 'pleroma'):
+ raise ValueError("InstanceType must be either 'misskey' or 'pleroma'")
+
+INSTANCE_TYPE = instance_type
+
+# Extra stuff for control of the bot
+
# TODO: move this to db
# Fedi handles in the traditional 'user@domain.tld' style, allows these users
# to use extra admin exclusive commands with the bot
diff --git a/bot/fediverse_factory.py b/bot/fediverse_factory.py
new file mode 100644
index 0000000..f2a9017
--- /dev/null
+++ b/bot/fediverse_factory.py
@@ -0,0 +1,31 @@
+from fediverse_service import FediverseService
+from misskey_service import MisskeyService
+from pleroma_service import PleromaService
+import config
+
+
+class FediverseServiceFactory:
+ """Factory for creating FediverseService implementations based on configuration"""
+
+ @staticmethod
+ def create_service() -> FediverseService:
+ """
+ Create a FediverseService implementation based on the configured instance type.
+
+ Returns:
+ FediverseService implementation (MisskeyService or PleromaService)
+
+ Raises:
+ ValueError: If the instance type is not supported
+ """
+ if config.INSTANCE_TYPE == "misskey":
+ return MisskeyService()
+ elif config.INSTANCE_TYPE == "pleroma":
+ return PleromaService()
+ else:
+ raise ValueError(f"Unsupported instance type: {config.INSTANCE_TYPE}")
+
+
+def get_fediverse_service() -> FediverseService:
+ """Convenience function to get a FediverseService instance"""
+ return FediverseServiceFactory.create_service()
\ No newline at end of file
diff --git a/bot/fediverse_service.py b/bot/fediverse_service.py
new file mode 100644
index 0000000..2d12d89
--- /dev/null
+++ b/bot/fediverse_service.py
@@ -0,0 +1,57 @@
+from abc import ABC, abstractmethod
+from typing import List, Optional
+from fediverse_types import FediverseNotification, FediversePost, Visibility
+
+
+class FediverseService(ABC):
+ """Abstract interface for Fediverse platform services (Misskey, Pleroma, etc.)"""
+
+ @abstractmethod
+ def get_notifications(self, since_id: Optional[str] = None) -> List[FediverseNotification]:
+ """
+ Retrieve notifications from the Fediverse instance.
+
+ Args:
+ since_id: Optional ID to get notifications newer than this ID
+
+ Returns:
+ List of FediverseNotification objects
+ """
+ pass
+
+ @abstractmethod
+ def create_post(
+ self,
+ text: str,
+ reply_to_id: Optional[str] = None,
+ visibility: Visibility = Visibility.HOME,
+ file_ids: Optional[List[str]] = None,
+ visible_user_ids: Optional[List[str]] = None
+ ) -> str:
+ """
+ Create a new post on the Fediverse instance.
+
+ Args:
+ text: The text content of the post
+ reply_to_id: Optional ID of post to reply to
+ visibility: Visibility level for the post
+ file_ids: Optional list of file IDs to attach
+ visible_user_ids: Optional list of user IDs who can see the post (for specified visibility)
+
+ Returns:
+ ID of the created post
+ """
+ pass
+
+ @abstractmethod
+ def get_post_by_id(self, post_id: str) -> Optional[FediversePost]:
+ """
+ Retrieve a specific post by its ID.
+
+ Args:
+ post_id: The ID of the post to retrieve
+
+ Returns:
+ FediversePost object if found, None otherwise
+ """
+ pass
\ No newline at end of file
diff --git a/bot/fediverse_types.py b/bot/fediverse_types.py
new file mode 100644
index 0000000..c1580b6
--- /dev/null
+++ b/bot/fediverse_types.py
@@ -0,0 +1,73 @@
+from dataclasses import dataclass
+from typing import Optional, List, Dict, Any
+from enum import Enum
+
+
+class NotificationType(Enum):
+ MENTION = "mention"
+ REPLY = "reply"
+ FOLLOW = "follow"
+ FAVOURITE = "favourite"
+ REBLOG = "reblog"
+ POLL = "poll"
+ OTHER = "other"
+
+
+class Visibility(Enum):
+ PUBLIC = "public"
+ UNLISTED = "unlisted"
+ HOME = "home"
+ FOLLOWERS = "followers"
+ SPECIFIED = "specified"
+ DIRECT = "direct"
+
+
+@dataclass
+class FediverseUser:
+ """Common user representation across Fediverse platforms"""
+ id: str
+ username: str
+ host: Optional[str] = None # None for local users
+ display_name: Optional[str] = None
+
+ @property
+ def full_handle(self) -> str:
+ """Returns the full fediverse handle (@user@domain or @user for local)"""
+ if self.host:
+ return f"@{self.username}@{self.host}"
+ return f"@{self.username}"
+
+
+@dataclass
+class FediverseFile:
+ """Common file/attachment representation"""
+ id: str
+ url: str
+ type: Optional[str] = None
+ name: Optional[str] = None
+
+
+@dataclass
+class FediversePost:
+ """Common post representation across Fediverse platforms"""
+ id: str
+ text: Optional[str]
+ user: FediverseUser
+ visibility: Visibility
+ created_at: Optional[str] = None
+ files: List[FediverseFile] = None
+ reply_to_id: Optional[str] = None
+
+ def __post_init__(self):
+ if self.files is None:
+ self.files = []
+
+
+@dataclass
+class FediverseNotification:
+ """Common notification representation across Fediverse platforms"""
+ id: str
+ type: NotificationType
+ user: FediverseUser
+ post: Optional[FediversePost] = None
+ created_at: Optional[str] = None
\ No newline at end of file
diff --git a/bot/misskey_service.py b/bot/misskey_service.py
new file mode 100644
index 0000000..845ed27
--- /dev/null
+++ b/bot/misskey_service.py
@@ -0,0 +1,141 @@
+import misskey
+from typing import List, Optional, Dict, Any
+from fediverse_service import FediverseService
+from fediverse_types import (
+ FediverseNotification, FediversePost, FediverseUser, FediverseFile,
+ NotificationType, Visibility
+)
+import config
+
+
+class MisskeyService(FediverseService):
+ """Misskey implementation of FediverseService"""
+
+ def __init__(self):
+ self.client = misskey.Misskey(address=config.INSTANCE, i=config.KEY)
+
+ def _convert_misskey_user(self, user_data: Dict[str, Any]) -> FediverseUser:
+ """Convert Misskey user data to FediverseUser"""
+ return FediverseUser(
+ id=user_data.get("id", ""),
+ username=user_data.get("username", "unknown"),
+ host=user_data.get("host"),
+ display_name=user_data.get("name")
+ )
+
+ def _convert_misskey_file(self, file_data: Dict[str, Any]) -> FediverseFile:
+ """Convert Misskey file data to FediverseFile"""
+ return FediverseFile(
+ id=file_data.get("id", ""),
+ url=file_data.get("url", ""),
+ type=file_data.get("type"),
+ name=file_data.get("name")
+ )
+
+ def _convert_misskey_visibility(self, visibility: str) -> Visibility:
+ """Convert Misskey visibility to our enum"""
+ visibility_map = {
+ "public": Visibility.PUBLIC,
+ "unlisted": Visibility.UNLISTED,
+ "home": Visibility.HOME,
+ "followers": Visibility.FOLLOWERS,
+ "specified": Visibility.SPECIFIED
+ }
+ return visibility_map.get(visibility, Visibility.HOME)
+
+ def _convert_to_misskey_visibility(self, visibility: Visibility) -> str:
+ """Convert our visibility enum to Misskey visibility"""
+ visibility_map = {
+ Visibility.PUBLIC: "public",
+ Visibility.UNLISTED: "unlisted",
+ Visibility.HOME: "home",
+ Visibility.FOLLOWERS: "followers",
+ Visibility.SPECIFIED: "specified",
+ Visibility.DIRECT: "specified" # Map direct to specified for Misskey
+ }
+ return visibility_map.get(visibility, "home")
+
+ def _convert_misskey_notification_type(self, notif_type: str) -> NotificationType:
+ """Convert Misskey notification type to our enum"""
+ type_map = {
+ "mention": NotificationType.MENTION,
+ "reply": NotificationType.REPLY,
+ "follow": NotificationType.FOLLOW,
+ "favourite": NotificationType.FAVOURITE,
+ "reblog": NotificationType.REBLOG,
+ "poll": NotificationType.POLL
+ }
+ return type_map.get(notif_type, NotificationType.OTHER)
+
+ def _convert_misskey_post(self, note_data: Dict[str, Any]) -> FediversePost:
+ """Convert Misskey note data to FediversePost"""
+ files = []
+ if note_data.get("files"):
+ files = [self._convert_misskey_file(f) for f in note_data["files"]]
+
+ return FediversePost(
+ id=note_data.get("id", ""),
+ text=note_data.get("text"),
+ user=self._convert_misskey_user(note_data.get("user", {})),
+ visibility=self._convert_misskey_visibility(note_data.get("visibility", "home")),
+ created_at=note_data.get("createdAt"),
+ files=files,
+ reply_to_id=note_data.get("replyId")
+ )
+
+ def _convert_misskey_notification(self, notification_data: Dict[str, Any]) -> FediverseNotification:
+ """Convert Misskey notification data to FediverseNotification"""
+ post = None
+ if notification_data.get("note"):
+ post = self._convert_misskey_post(notification_data["note"])
+
+ return FediverseNotification(
+ id=notification_data.get("id", ""),
+ type=self._convert_misskey_notification_type(notification_data.get("type", "")),
+ user=self._convert_misskey_user(notification_data.get("user", {})),
+ post=post,
+ created_at=notification_data.get("createdAt")
+ )
+
+ def get_notifications(self, since_id: Optional[str] = None) -> List[FediverseNotification]:
+ """Get notifications from Misskey instance"""
+ params = {}
+ if since_id:
+ params["sinceId"] = since_id
+
+ notifications = self.client.i_notifications(**params)
+ return [self._convert_misskey_notification(notif) for notif in notifications]
+
+ def create_post(
+ self,
+ text: str,
+ reply_to_id: Optional[str] = None,
+ visibility: Visibility = Visibility.HOME,
+ file_ids: Optional[List[str]] = None,
+ visible_user_ids: Optional[List[str]] = None
+ ) -> str:
+ """Create a post on Misskey instance"""
+ params = {
+ "text": text,
+ "visibility": self._convert_to_misskey_visibility(visibility)
+ }
+
+ if reply_to_id:
+ params["replyId"] = reply_to_id
+
+ if file_ids:
+ params["fileIds"] = file_ids
+
+ if visible_user_ids and visibility == Visibility.SPECIFIED:
+ params["visibleUserIds"] = visible_user_ids
+
+ response = self.client.notes_create(**params)
+ return response.get("createdNote", {}).get("id", "")
+
+ def get_post_by_id(self, post_id: str) -> Optional[FediversePost]:
+ """Get a specific post by ID from Misskey instance"""
+ try:
+ note = self.client.notes_show(noteId=post_id)
+ return self._convert_misskey_post(note)
+ except Exception:
+ return None
\ No newline at end of file
diff --git a/bot/pleroma_service.py b/bot/pleroma_service.py
new file mode 100644
index 0000000..1e53cd7
--- /dev/null
+++ b/bot/pleroma_service.py
@@ -0,0 +1,155 @@
+from mastodon import Mastodon
+from typing import List, Optional, Dict, Any
+from fediverse_service import FediverseService
+from fediverse_types import (
+ FediverseNotification, FediversePost, FediverseUser, FediverseFile,
+ NotificationType, Visibility
+)
+import config
+
+
+class PleromaService(FediverseService):
+ """Pleroma implementation of FediverseService using Mastodon.py"""
+
+ def __init__(self):
+ self.client = Mastodon(
+ access_token=config.KEY,
+ api_base_url=config.INSTANCE
+ )
+
+ def _convert_mastodon_user(self, user_data: Dict[str, Any]) -> FediverseUser:
+ """Convert Mastodon/Pleroma user data to FediverseUser"""
+ acct = user_data.get("acct", "")
+ if "@" in acct:
+ username, host = acct.split("@", 1)
+ else:
+ username = acct
+ host = None
+
+ return FediverseUser(
+ id=str(user_data.get("id", "")),
+ username=username,
+ host=host,
+ display_name=user_data.get("display_name")
+ )
+
+ def _convert_mastodon_file(self, file_data: Dict[str, Any]) -> FediverseFile:
+ """Convert Mastodon/Pleroma media attachment to FediverseFile"""
+ return FediverseFile(
+ id=str(file_data.get("id", "")),
+ url=file_data.get("url", ""),
+ type=file_data.get("type"),
+ name=file_data.get("description")
+ )
+
+ def _convert_mastodon_visibility(self, visibility: str) -> Visibility:
+ """Convert Mastodon/Pleroma visibility to our enum"""
+ visibility_map = {
+ "public": Visibility.PUBLIC,
+ "unlisted": Visibility.UNLISTED,
+ "private": Visibility.FOLLOWERS,
+ "direct": Visibility.DIRECT
+ }
+ return visibility_map.get(visibility, Visibility.PUBLIC)
+
+ def _convert_to_mastodon_visibility(self, visibility: Visibility) -> str:
+ """Convert our visibility enum to Mastodon/Pleroma visibility"""
+ visibility_map = {
+ Visibility.PUBLIC: "public",
+ Visibility.UNLISTED: "unlisted",
+ Visibility.HOME: "unlisted", # Map home to unlisted for Pleroma
+ Visibility.FOLLOWERS: "private",
+ Visibility.SPECIFIED: "direct", # Map specified to direct for Pleroma
+ Visibility.DIRECT: "direct"
+ }
+ return visibility_map.get(visibility, "public")
+
+ def _convert_mastodon_notification_type(self, notif_type: str) -> NotificationType:
+ """Convert Mastodon/Pleroma notification type to our enum"""
+ type_map = {
+ "mention": NotificationType.MENTION,
+ "follow": NotificationType.FOLLOW,
+ "favourite": NotificationType.FAVOURITE,
+ "reblog": NotificationType.REBLOG,
+ "poll": NotificationType.POLL
+ }
+ return type_map.get(notif_type, NotificationType.OTHER)
+
+ def _convert_mastodon_status(self, status_data: Dict[str, Any]) -> FediversePost:
+ """Convert Mastodon/Pleroma status data to FediversePost"""
+ files = []
+ if status_data.get("media_attachments"):
+ files = [self._convert_mastodon_file(f) for f in status_data["media_attachments"]]
+
+ # Extract plain text from HTML content
+ content = status_data.get("content", "")
+ # Basic HTML stripping - in production you might want to use a proper HTML parser
+ import re
+ plain_text = re.sub(r'<[^>]+>', '', content) if content else None
+
+ return FediversePost(
+ id=str(status_data.get("id", "")),
+ text=plain_text,
+ user=self._convert_mastodon_user(status_data.get("account", {})),
+ visibility=self._convert_mastodon_visibility(status_data.get("visibility", "public")),
+ created_at=status_data.get("created_at"),
+ files=files,
+ reply_to_id=str(status_data["in_reply_to_id"]) if status_data.get("in_reply_to_id") else None
+ )
+
+ def _convert_mastodon_notification(self, notification_data: Dict[str, Any]) -> FediverseNotification:
+ """Convert Mastodon/Pleroma notification data to FediverseNotification"""
+ post = None
+ if notification_data.get("status"):
+ post = self._convert_mastodon_status(notification_data["status"])
+
+ return FediverseNotification(
+ id=str(notification_data.get("id", "")),
+ type=self._convert_mastodon_notification_type(notification_data.get("type", "")),
+ user=self._convert_mastodon_user(notification_data.get("account", {})),
+ post=post,
+ created_at=notification_data.get("created_at")
+ )
+
+ def get_notifications(self, since_id: Optional[str] = None) -> List[FediverseNotification]:
+ """Get notifications from Pleroma instance"""
+ params = {}
+ if since_id:
+ params["since_id"] = since_id
+
+ notifications = self.client.notifications(**params)
+ return [self._convert_mastodon_notification(notif) for notif in notifications]
+
+ def create_post(
+ self,
+ text: str,
+ reply_to_id: Optional[str] = None,
+ visibility: Visibility = Visibility.HOME,
+ file_ids: Optional[List[str]] = None,
+ visible_user_ids: Optional[List[str]] = None
+ ) -> str:
+ """Create a post on Pleroma instance"""
+ params = {
+ "status": text,
+ "visibility": self._convert_to_mastodon_visibility(visibility)
+ }
+
+ if reply_to_id:
+ params["in_reply_to_id"] = reply_to_id
+
+ if file_ids:
+ params["media_ids"] = file_ids
+
+ # Note: Pleroma/Mastodon doesn't have direct equivalent to visible_user_ids
+ # For direct messages, you typically mention users in the status text
+
+ response = self.client.status_post(**params)
+ return str(response.get("id", ""))
+
+ def get_post_by_id(self, post_id: str) -> Optional[FediversePost]:
+ """Get a specific post by ID from Pleroma instance"""
+ try:
+ status = self.client.status(post_id)
+ return self._convert_mastodon_status(status)
+ except Exception:
+ return None
\ No newline at end of file
diff --git a/requirements.txt b/requirements.txt
index 1db6f9b..3d237b4 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -6,3 +6,4 @@ Jinja2==3.1.6
MarkupSafe==3.0.2
Werkzeug==3.1.3
Misskey.py==4.1.0
+Mastodon.py==1.8.1
From a47530180d3c074131a644015e2df1a6a11dafed Mon Sep 17 00:00:00 2001
From: Moon
Date: Thu, 12 Jun 2025 11:08:00 +0900
Subject: [PATCH 21/56] first whack at file upload
---
bot/fediverse_service.py | 19 ++++++++++++++++++-
bot/misskey_service.py | 16 ++++++++++++++--
bot/pleroma_service.py | 12 ++++++++++--
3 files changed, 42 insertions(+), 5 deletions(-)
diff --git a/bot/fediverse_service.py b/bot/fediverse_service.py
index 2d12d89..d4e32fe 100644
--- a/bot/fediverse_service.py
+++ b/bot/fediverse_service.py
@@ -1,5 +1,5 @@
from abc import ABC, abstractmethod
-from typing import List, Optional
+from typing import List, Optional, Union, BinaryIO
from fediverse_types import FediverseNotification, FediversePost, Visibility
@@ -54,4 +54,21 @@ class FediverseService(ABC):
Returns:
FediversePost object if found, None otherwise
"""
+ pass
+
+ @abstractmethod
+ def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> str:
+ """
+ Upload a file to the Fediverse instance.
+
+ Args:
+ file_data: File data as binary stream or bytes
+ filename: Optional filename for the uploaded file
+
+ Returns:
+ File ID that can be used in posts
+
+ Raises:
+ RuntimeError: If file upload fails
+ """
pass
\ No newline at end of file
diff --git a/bot/misskey_service.py b/bot/misskey_service.py
index 845ed27..e8bd396 100644
--- a/bot/misskey_service.py
+++ b/bot/misskey_service.py
@@ -1,5 +1,5 @@
import misskey
-from typing import List, Optional, Dict, Any
+from typing import List, Optional, Dict, Any, Union, BinaryIO
from fediverse_service import FediverseService
from fediverse_types import (
FediverseNotification, FediversePost, FediverseUser, FediverseFile,
@@ -138,4 +138,16 @@ class MisskeyService(FediverseService):
note = self.client.notes_show(noteId=post_id)
return self._convert_misskey_post(note)
except Exception:
- return None
\ No newline at end of file
+ return None
+
+ def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> str:
+ """Upload a file to Misskey Drive"""
+ try:
+ from misskey.exceptions import MisskeyAPIException
+
+ media = self.client.drive_files_create(file_data)
+ return media["id"]
+ except MisskeyAPIException as e:
+ raise RuntimeError(f"Failed to upload file to Misskey Drive: {e}") from e
+ except Exception as e:
+ raise RuntimeError(f"Unexpected error during file upload: {e}") from e
\ No newline at end of file
diff --git a/bot/pleroma_service.py b/bot/pleroma_service.py
index 1e53cd7..7333df0 100644
--- a/bot/pleroma_service.py
+++ b/bot/pleroma_service.py
@@ -1,5 +1,5 @@
from mastodon import Mastodon
-from typing import List, Optional, Dict, Any
+from typing import List, Optional, Dict, Any, Union, BinaryIO
from fediverse_service import FediverseService
from fediverse_types import (
FediverseNotification, FediversePost, FediverseUser, FediverseFile,
@@ -152,4 +152,12 @@ class PleromaService(FediverseService):
status = self.client.status(post_id)
return self._convert_mastodon_status(status)
except Exception:
- return None
\ No newline at end of file
+ return None
+
+ def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> str:
+ """Upload a file to Pleroma instance"""
+ try:
+ media = self.client.media_post(file_data, mime_type=None, description=filename)
+ return str(media["id"])
+ except Exception as e:
+ raise RuntimeError(f"Failed to upload file to Pleroma: {e}") from e
\ No newline at end of file
From fe8e7d246f35f4a632662daea016027530188b3a Mon Sep 17 00:00:00 2001
From: Moon
Date: Thu, 12 Jun 2025 11:10:18 +0900
Subject: [PATCH 22/56] actually use the abstracted type not just the id
---
bot/fediverse_service.py | 6 +++---
bot/misskey_service.py | 4 ++--
bot/pleroma_service.py | 4 ++--
3 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/bot/fediverse_service.py b/bot/fediverse_service.py
index d4e32fe..1292d63 100644
--- a/bot/fediverse_service.py
+++ b/bot/fediverse_service.py
@@ -1,6 +1,6 @@
from abc import ABC, abstractmethod
from typing import List, Optional, Union, BinaryIO
-from fediverse_types import FediverseNotification, FediversePost, Visibility
+from fediverse_types import FediverseNotification, FediversePost, FediverseFile, Visibility
class FediverseService(ABC):
@@ -57,7 +57,7 @@ class FediverseService(ABC):
pass
@abstractmethod
- def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> str:
+ def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> FediverseFile:
"""
Upload a file to the Fediverse instance.
@@ -66,7 +66,7 @@ class FediverseService(ABC):
filename: Optional filename for the uploaded file
Returns:
- File ID that can be used in posts
+ FediverseFile object with ID, URL, and other metadata
Raises:
RuntimeError: If file upload fails
diff --git a/bot/misskey_service.py b/bot/misskey_service.py
index e8bd396..3a16cd4 100644
--- a/bot/misskey_service.py
+++ b/bot/misskey_service.py
@@ -140,13 +140,13 @@ class MisskeyService(FediverseService):
except Exception:
return None
- def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> str:
+ def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> FediverseFile:
"""Upload a file to Misskey Drive"""
try:
from misskey.exceptions import MisskeyAPIException
media = self.client.drive_files_create(file_data)
- return media["id"]
+ return self._convert_misskey_file(media)
except MisskeyAPIException as e:
raise RuntimeError(f"Failed to upload file to Misskey Drive: {e}") from e
except Exception as e:
diff --git a/bot/pleroma_service.py b/bot/pleroma_service.py
index 7333df0..753b1dc 100644
--- a/bot/pleroma_service.py
+++ b/bot/pleroma_service.py
@@ -154,10 +154,10 @@ class PleromaService(FediverseService):
except Exception:
return None
- def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> str:
+ def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> FediverseFile:
"""Upload a file to Pleroma instance"""
try:
media = self.client.media_post(file_data, mime_type=None, description=filename)
- return str(media["id"])
+ return self._convert_mastodon_file(media)
except Exception as e:
raise RuntimeError(f"Failed to upload file to Pleroma: {e}") from e
\ No newline at end of file
From dac05a3ed81b8fe01d6ea1231b2e174d03566886 Mon Sep 17 00:00:00 2001
From: Moon
Date: Thu, 12 Jun 2025 11:22:20 +0900
Subject: [PATCH 23/56] completely untested refactor. bug fixes to come later.
---
bot/add_character.py | 74 ++++++++++++++++++++++---------------------
bot/bot_app.py | 75 ++++++++++++++++++++++++++++++++++++--------
bot/parsing.py | 68 ++++++++++++++++++++++++++++-----------
bot/response.py | 5 +--
4 files changed, 153 insertions(+), 69 deletions(-)
diff --git a/bot/add_character.py b/bot/add_character.py
index 18b0f98..7590c1b 100644
--- a/bot/add_character.py
+++ b/bot/add_character.py
@@ -1,32 +1,25 @@
import requests
-from misskey.exceptions import MisskeyAPIException
-from client import client_connection
-from db_utils import insert_character
-from custom_types import Character
+from fediverse_factory import get_fediverse_service
+from db_utils import get_db_connection
from config import RARITY_TO_WEIGHT
-
-def add_character(
- name: str,
- rarity: int,
- image_url: str) -> tuple[int, str]:
- '''
- Adds a character to the database, uploading the image from a public URL to
- the bot's Misskey Drive.
+def add_character(name: str, rarity: int, weight: float, image_url: str) -> tuple[int, str]:
+ """
+ Adds a character to the database, uploading the image from a public URL to the Fediverse instance.
Args:
name (str): Character name.
rarity (int): Character rarity (e.g., 1-5).
- image_url (str): Public URL of the image from the post (e.g., from
- note['files'][i]['url']).
+ weight (float): Pull weight (e.g., 0.02).
+ image_url (str): Public URL of the image from the post.
Returns:
- tuple[int, str]: Character ID and bot's Drive file_id.
+ tuple[int, str]: Character ID and file_id.
Raises:
ValueError: If inputs are invalid.
RuntimeError: If image download/upload or database operation fails.
- '''
+ """
stripped_name = name.strip()
@@ -40,25 +33,34 @@ def add_character(
if not image_url:
raise ValueError('Image URL must be provided.')
- # Download image
- response = requests.get(image_url, stream=True, timeout=30)
- if response.status_code != 200:
- raise RuntimeError(f'Failed to download image from {image_url}')
-
- # Upload to bot's Drive
- mk = client_connection()
try:
- media = mk.drive_files_create(response.raw)
- file_id = media['id']
- except MisskeyAPIException as e:
- raise RuntimeError(f'Failed to upload image to bot\'s Drive: {e}')\
- from e
+ # Download image
+ response = requests.get(image_url, stream=True, timeout=30)
+ if response.status_code != 200:
+ raise RuntimeError(f"Failed to download image from {image_url}")
- # Insert into database
- character_id = insert_character(
- stripped_name,
- rarity,
- RARITY_TO_WEIGHT[rarity],
- file_id
- )
- return character_id, file_id
+ # Upload to Fediverse instance
+ fediverse_service = get_fediverse_service()
+ try:
+ uploaded_file = fediverse_service.upload_file(response.raw)
+ file_id = uploaded_file.id
+ except RuntimeError as e:
+ raise RuntimeError(f"Failed to upload image: {e}") from e
+
+ # Insert into database
+ conn = get_db_connection()
+ cur = conn.cursor()
+ cur.execute(
+ 'INSERT INTO characters (name, rarity, weight, file_id) VALUES (?, ?, ?, ?)',
+ (stripped_name, rarity, float(weight), file_id)
+ )
+ conn.commit()
+ character_id = cur.lastrowid
+
+ return character_id, file_id
+
+ except Exception as e:
+ raise
+ finally:
+ if 'conn' in locals():
+ conn.close()
diff --git a/bot/bot_app.py b/bot/bot_app.py
index 825695e..fc8a66a 100644
--- a/bot/bot_app.py
+++ b/bot/bot_app.py
@@ -1,18 +1,67 @@
import time
-import misskey as misskey
-from client import client_connection
-import db_utils as db
+import traceback
+from parsing import parse_notification
+from db_utils import get_config, set_config
+from fediverse_factory import get_fediverse_service
+import config
-from config import NOTIFICATION_POLL_INTERVAL
-from notification import process_notifications
-
-if __name__ == '__main__':
- # Initialize the Misskey client
- client = client_connection()
- # Connect to DB
- db.connect()
+def stream_notifications():
+ # Initialize the Fediverse service
+ fediverse_service = get_fediverse_service()
+
+ # Get the last seen notification ID from the database
+ last_seen_id = get_config("last_seen_notif_id")
+ whitelisted_instances = getattr(config, 'WHITELISTED_INSTANCES', [])
print('Listening for notifications...')
while True:
- if not process_notifications(client):
- time.sleep(NOTIFICATION_POLL_INTERVAL)
+ try:
+ # Get notifications from the fediverse service
+ notifications = fediverse_service.get_notifications(since_id=last_seen_id)
+
+ if notifications:
+ new_last_seen_id = last_seen_id
+
+ for notification in notifications:
+ notif_id = notification.id
+
+ # Skip old or same ID notifications
+ if last_seen_id is not None and notif_id <= last_seen_id:
+ continue
+
+ username = notification.user.username
+ host = notification.user.host
+
+ instance = host if host else "local"
+
+ if instance in whitelisted_instances or instance == "local":
+ note = notification.post.text if notification.post else ""
+ notif_type = notification.type.value
+
+ print(f"📨 [{notif_type}] from @{username}@{instance}")
+ print(f"💬 {note}")
+ print("-" * 30)
+
+ # 🧠 Send to the parser
+ parse_notification(notification, fediverse_service)
+
+ else:
+ print(f"⚠️ Blocked notification from untrusted instance: {host}")
+
+ # Update only if this notif_id is greater
+ if new_last_seen_id is None or notif_id > new_last_seen_id:
+ new_last_seen_id = notif_id
+
+ # Save the latest seen ID
+ if new_last_seen_id and new_last_seen_id != last_seen_id:
+ set_config("last_seen_notif_id", new_last_seen_id)
+ last_seen_id = new_last_seen_id
+
+ time.sleep(5)
+
+ except Exception as e:
+ print(f"An exception has occured: {e}\n{traceback.format_exc()}")
+ time.sleep(5)
+
+if __name__ == "__main__":
+ stream_notifications()
diff --git a/bot/parsing.py b/bot/parsing.py
index eece077..66d6ed8 100644
--- a/bot/parsing.py
+++ b/bot/parsing.py
@@ -1,27 +1,38 @@
import re
-from typing import Dict, Any
-
-import misskey
-
import config
+from response import generate_response
+from fediverse_factory import get_fediverse_service
+from fediverse_types import FediverseNotification, NotificationType, Visibility
from custom_types import ParsedNotification
+def parse_notification(notification: FediverseNotification, fediverse_service=None):
+ '''Parses any notifications received by the bot and sends any commands to
+ generate_response()'''
+
+ if fediverse_service is None:
+ fediverse_service = get_fediverse_service()
-def parse_notification(
- notification: Dict[str, Any],
- client: misskey.Misskey) -> ParsedNotification | None:
- '''Parses any notifications received by the bot'''
+ # We get the type of notification to filter the ones that we actually want
+ # to parse
+ if notification.type not in (NotificationType.MENTION, NotificationType.REPLY):
+ return # Ignore anything that isn't a mention
+
+ # Return early if no post attached
+ if not notification.post:
+ return
+
+ # We want the visibility to be related to the type that was received (so if
+ # people don't want to dump a bunch of notes on home they don't have to)
+ if notification.post.visibility != Visibility.SPECIFIED:
+ visibility = Visibility.HOME
+ else:
+ visibility = Visibility.SPECIFIED
# Get the full Activitypub ID of the user
- user = notification.get("user", {})
- username = user.get("username", "unknown")
- host = user.get("host")
- # Local users may not have a hostname attached
- full_user = f"@{username}" if not host else f"@{username}@{host}"
+ full_user = notification.user.full_handle
- note_obj = notification.get("note", {})
- note_text = note_obj.get("text")
- note_id = note_obj.get("id")
+ note_text = notification.post.text
+ note_id = notification.post.id
note = note_text.strip().lower() if note_text else ""
@@ -44,9 +55,30 @@ def parse_notification(
command = parts[0].lower() if parts else None
arguments = parts[1:] if len(parts) > 1 else []
- return {
+ # Create ParsedNotification object for the new response system
+ parsed_notification: ParsedNotification = {
'author': full_user,
'command': command,
'arguments': arguments,
- 'note_obj': note_obj
+ 'note_obj': {
+ 'id': note_id,
+ 'text': note_text,
+ 'files': [{'url': f.url} for f in notification.post.files] if notification.post.files else []
+ }
}
+
+ # Generate response using the new system
+ response = generate_response(parsed_notification)
+ if not response:
+ return
+
+ # Handle attachment URLs (convert to file IDs if needed)
+ file_ids = response['attachment_urls'] if response['attachment_urls'] else None
+
+ fediverse_service.create_post(
+ text=response['message'],
+ reply_to_id=note_id,
+ visibility=visibility,
+ file_ids=file_ids
+ #visible_user_ids=[] #todo: write actual visible users ids so pleromers can use the bot privately
+ )
diff --git a/bot/response.py b/bot/response.py
index 3fde3ed..5632e2e 100644
--- a/bot/response.py
+++ b/bot/response.py
@@ -103,10 +103,10 @@ dumbass.',
'attachment_urls': None
}
- if len(arguments) != 2:
+ if len(arguments) != 3:
return {
'message': f'{author} Please specify the following attributes \
-in order: name, rarity',
+in order: name, rarity, weight',
'attachment_urls': None
}
@@ -126,6 +126,7 @@ must be a decimal value between 0.0 and 1.0',
character_id, file_id = add_character(
name=arguments[0],
rarity=int(arguments[1]),
+ weight=float(arguments[2]),
image_url=image_url
)
return {
From b2ca6dd59ad83f85018dfd416c0efd43845931f5 Mon Sep 17 00:00:00 2001
From: Moon
Date: Thu, 12 Jun 2025 11:26:10 +0900
Subject: [PATCH 24/56] documentation update for configurable backends
---
example_config.ini | 2 ++
readme.md | 14 +++++++-------
2 files changed, 9 insertions(+), 7 deletions(-)
diff --git a/example_config.ini b/example_config.ini
index af7e0f2..d4ba8bf 100644
--- a/example_config.ini
+++ b/example_config.ini
@@ -33,3 +33,5 @@ User = @bot@example.tld
; Generate one by going to Settings > API > Generate access token
Token = abcdefghijklmnopqrstuvwxyz012345
+; Instance type - either "misskey" or "pleroma"
+InstanceType = misskey
diff --git a/readme.md b/readme.md
index 437b09f..6ae910c 100644
--- a/readme.md
+++ b/readme.md
@@ -1,6 +1,6 @@
# Kemoverse
-A gacha-style bot for the Fediverse built with Python. Users can roll for characters, trade, duel, and perhaps engage with popularity-based mechanics. Currently designed for use with Misskey. Name comes from Kemonomimi and Fediverse.
+A gacha-style bot for the Fediverse built with Python. Users can roll for characters, trade, duel, and perhaps engage with popularity-based mechanics. Supports both Misskey and Pleroma instances. Name comes from Kemonomimi and Fediverse.
@@ -47,13 +47,13 @@ A gacha-style bot for the Fediverse built with Python. Users can roll for charac
- 🌐 Web app to generate cards from images
### 🌍 Fediverse Support
-✅ Anyone from the fediverse can play, but the server only works using a Misskey instance. Want to rewrite the program in Elixir for Pleroma? Let us know!
+✅ Anyone from the fediverse can play! The bot supports both Misskey and Pleroma instances through configurable backends.
## 🗃️ Tech Stack
- Python (3.12+)
- SQLite
-- Fediverse API integration (via Misskey endpoints)
+- Fediverse API integration (Misskey and Pleroma support)
- Flask
- Modular DB design for extensibility
@@ -65,12 +65,12 @@ The bot is meant to feel *light, fun, and competitive*. Mixing social, gacha and
flowchart TD
subgraph Player Interaction
- A1[Misskey bot]
+ A1[Fediverse bot]
A2[Web]
end
- subgraph Misskey
- B1[Misskey instance]
+ subgraph Fediverse
+ B1[Fediverse instance]
end
subgraph Bot
@@ -78,7 +78,7 @@ flowchart TD
C2[Notification parser]
C3[Gacha roll logic]
C4[Database interface]
- C5[Misskey API poster]
+ C5[Fediverse API poster]
end
subgraph Website
From 91376c0ebaad1338d4ffaee37915549e9331d7e5 Mon Sep 17 00:00:00 2001
From: Moon
Date: Thu, 12 Jun 2025 12:43:42 +0900
Subject: [PATCH 25/56] works now but may need to revert file upload change
---
bot/config.py | 3 ++
bot/pleroma_service.py | 66 ++++++++++++++++++++++++++++++++++++++++--
example_config.ini | 3 ++
web/app.py | 10 +++++--
4 files changed, 78 insertions(+), 4 deletions(-)
diff --git a/bot/config.py b/bot/config.py
index 5b5848f..2f9f4a3 100644
--- a/bot/config.py
+++ b/bot/config.py
@@ -51,6 +51,9 @@ if instance_type not in ('misskey', 'pleroma'):
INSTANCE_TYPE = instance_type
+# Web server port
+WEB_PORT = config['application'].getint('WebPort', 5000)
+
# Extra stuff for control of the bot
# TODO: move this to db
diff --git a/bot/pleroma_service.py b/bot/pleroma_service.py
index 753b1dc..4ec3496 100644
--- a/bot/pleroma_service.py
+++ b/bot/pleroma_service.py
@@ -1,5 +1,7 @@
from mastodon import Mastodon
from typing import List, Optional, Dict, Any, Union, BinaryIO
+import mimetypes
+import io
from fediverse_service import FediverseService
from fediverse_types import (
FediverseNotification, FediversePost, FediverseUser, FediverseFile,
@@ -157,7 +159,67 @@ class PleromaService(FediverseService):
def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> FediverseFile:
"""Upload a file to Pleroma instance"""
try:
- media = self.client.media_post(file_data, mime_type=None, description=filename)
- return self._convert_mastodon_file(media)
+ import requests
+
+ # Convert file_data to bytes if it's a stream
+ if hasattr(file_data, 'read'):
+ file_bytes = file_data.read()
+ else:
+ file_bytes = file_data
+
+ # Determine mime type from file header
+ mime_type = 'image/jpeg' # default
+ if file_bytes.startswith(b'\xff\xd8\xff'):
+ mime_type = 'image/jpeg'
+ ext = '.jpg'
+ elif file_bytes.startswith(b'\x89PNG\r\n\x1a\n'):
+ mime_type = 'image/png'
+ ext = '.png'
+ elif file_bytes.startswith(b'GIF8'):
+ mime_type = 'image/gif'
+ ext = '.gif'
+ elif file_bytes.startswith(b'RIFF') and b'WEBP' in file_bytes[:12]:
+ mime_type = 'image/webp'
+ ext = '.webp'
+ else:
+ ext = '.jpg'
+
+ # Create a filename if none provided
+ if not filename:
+ filename = f"upload{ext}"
+
+ # Direct HTTP POST to /api/v1/media with headers matching browser behavior
+ headers = {
+ 'Authorization': f'Bearer {self.client.access_token}',
+ 'Accept': '*/*',
+ 'Cache-Control': 'no-cache',
+ 'Pragma': 'no-cache',
+ 'User-Agent': 'Kemoverse-Bot/1.0'
+ }
+
+ # Use files parameter to let requests handle multipart/form-data and content-type
+ files = {
+ 'file': (filename, file_bytes, mime_type)
+ }
+
+ url = f"{self.client.api_base_url}/api/v1/media"
+
+ # Debug logging
+ print(f"DEBUG: Making POST request to: {url}")
+ print(f"DEBUG: Headers: {headers}")
+ print(f"DEBUG: Files keys: {list(files.keys())}")
+
+ response = requests.post(url, headers=headers, files=files)
+
+ print(f"DEBUG: Response status: {response.status_code}")
+ print(f"DEBUG: Response headers: {dict(response.headers)}")
+ print(f"DEBUG: Request method was: {response.request.method}")
+
+ if response.status_code in (200, 201):
+ media = response.json()
+ return self._convert_mastodon_file(media)
+ else:
+ raise Exception(f"Upload failed with {response.status_code}: {response.text}")
+
except Exception as e:
raise RuntimeError(f"Failed to upload file to Pleroma: {e}") from e
\ No newline at end of file
diff --git a/example_config.ini b/example_config.ini
index d4ba8bf..ec57058 100644
--- a/example_config.ini
+++ b/example_config.ini
@@ -35,3 +35,6 @@ Token = abcdefghijklmnopqrstuvwxyz012345
; Instance type - either "misskey" or "pleroma"
InstanceType = misskey
+
+; Web server port (default: 5000)
+WebPort = 5000
diff --git a/web/app.py b/web/app.py
index 61ed38f..9837741 100644
--- a/web/app.py
+++ b/web/app.py
@@ -1,10 +1,16 @@
import sqlite3
+import sys
+import os
+
+# Add bot directory to path to import config
+sys.path.append(os.path.join(os.path.dirname(__file__), '..', 'bot'))
+import config
from flask import Flask, render_template, abort
from werkzeug.exceptions import HTTPException
app = Flask(__name__)
-DB_PATH = "./gacha_game.db" # Adjust path if needed
+DB_PATH = config.DB_PATH
def get_db_connection():
conn = sqlite3.connect(DB_PATH)
@@ -68,4 +74,4 @@ def submit_character():
if __name__ == '__main__':
- app.run(host='0.0.0.0', port=5000, debug=True)
+ app.run(host='0.0.0.0', port=config.WEB_PORT, debug=True)
From 89ae8a7290b1bdb82a1a27a1def489a50c4d2f70 Mon Sep 17 00:00:00 2001
From: Moon
Date: Thu, 12 Jun 2025 12:47:51 +0900
Subject: [PATCH 26/56] back to using mastodon.py
---
bot/pleroma_service.py | 72 ++++++++++++------------------------------
1 file changed, 20 insertions(+), 52 deletions(-)
diff --git a/bot/pleroma_service.py b/bot/pleroma_service.py
index 4ec3496..d7c52b6 100644
--- a/bot/pleroma_service.py
+++ b/bot/pleroma_service.py
@@ -159,67 +159,35 @@ class PleromaService(FediverseService):
def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> FediverseFile:
"""Upload a file to Pleroma instance"""
try:
- import requests
-
- # Convert file_data to bytes if it's a stream
+ # Convert file_data to bytes if it's a stream for MIME detection
if hasattr(file_data, 'read'):
- file_bytes = file_data.read()
+ # Check if we can seek back
+ try:
+ current_pos = file_data.tell()
+ header = file_data.read(8)
+ file_data.seek(current_pos)
+ except (io.UnsupportedOperation, OSError):
+ # Non-seekable stream, read all data
+ remaining_data = file_data.read()
+ file_bytes = header + remaining_data
+ file_data = io.BytesIO(file_bytes)
+ header = file_bytes[:8]
else:
- file_bytes = file_data
+ header = file_data[:8] if len(file_data) >= 8 else file_data
# Determine mime type from file header
- mime_type = 'image/jpeg' # default
- if file_bytes.startswith(b'\xff\xd8\xff'):
+ if header.startswith(b'\xff\xd8\xff'):
mime_type = 'image/jpeg'
- ext = '.jpg'
- elif file_bytes.startswith(b'\x89PNG\r\n\x1a\n'):
+ elif header.startswith(b'\x89PNG\r\n\x1a\n'):
mime_type = 'image/png'
- ext = '.png'
- elif file_bytes.startswith(b'GIF8'):
+ elif header.startswith(b'GIF8'):
mime_type = 'image/gif'
- ext = '.gif'
- elif file_bytes.startswith(b'RIFF') and b'WEBP' in file_bytes[:12]:
+ elif header.startswith(b'RIFF') and len(header) >= 8 and b'WEBP' in header:
mime_type = 'image/webp'
- ext = '.webp'
else:
- ext = '.jpg'
+ mime_type = 'image/jpeg' # Default fallback
- # Create a filename if none provided
- if not filename:
- filename = f"upload{ext}"
-
- # Direct HTTP POST to /api/v1/media with headers matching browser behavior
- headers = {
- 'Authorization': f'Bearer {self.client.access_token}',
- 'Accept': '*/*',
- 'Cache-Control': 'no-cache',
- 'Pragma': 'no-cache',
- 'User-Agent': 'Kemoverse-Bot/1.0'
- }
-
- # Use files parameter to let requests handle multipart/form-data and content-type
- files = {
- 'file': (filename, file_bytes, mime_type)
- }
-
- url = f"{self.client.api_base_url}/api/v1/media"
-
- # Debug logging
- print(f"DEBUG: Making POST request to: {url}")
- print(f"DEBUG: Headers: {headers}")
- print(f"DEBUG: Files keys: {list(files.keys())}")
-
- response = requests.post(url, headers=headers, files=files)
-
- print(f"DEBUG: Response status: {response.status_code}")
- print(f"DEBUG: Response headers: {dict(response.headers)}")
- print(f"DEBUG: Request method was: {response.request.method}")
-
- if response.status_code in (200, 201):
- media = response.json()
- return self._convert_mastodon_file(media)
- else:
- raise Exception(f"Upload failed with {response.status_code}: {response.text}")
-
+ media = self.client.media_post(file_data, mime_type=mime_type, description=filename)
+ return self._convert_mastodon_file(media)
except Exception as e:
raise RuntimeError(f"Failed to upload file to Pleroma: {e}") from e
\ No newline at end of file
From 67b4d949fdee156a0529ae717d8d105b869e99b2 Mon Sep 17 00:00:00 2001
From: Moon
Date: Thu, 12 Jun 2025 12:53:37 +0900
Subject: [PATCH 27/56] use a library for content type detection instead of
handrolled
---
bot/pleroma_service.py | 33 ++++++++++++++-------------------
requirements.txt | 1 +
2 files changed, 15 insertions(+), 19 deletions(-)
diff --git a/bot/pleroma_service.py b/bot/pleroma_service.py
index d7c52b6..21320d1 100644
--- a/bot/pleroma_service.py
+++ b/bot/pleroma_service.py
@@ -1,7 +1,7 @@
from mastodon import Mastodon
from typing import List, Optional, Dict, Any, Union, BinaryIO
-import mimetypes
import io
+import filetype
from fediverse_service import FediverseService
from fediverse_types import (
FediverseNotification, FediversePost, FediverseUser, FediverseFile,
@@ -159,33 +159,28 @@ class PleromaService(FediverseService):
def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> FediverseFile:
"""Upload a file to Pleroma instance"""
try:
- # Convert file_data to bytes if it's a stream for MIME detection
+ # Convert file_data to bytes for MIME detection
if hasattr(file_data, 'read'):
# Check if we can seek back
try:
current_pos = file_data.tell()
- header = file_data.read(8)
+ file_bytes = file_data.read()
file_data.seek(current_pos)
- except (io.UnsupportedOperation, OSError):
- # Non-seekable stream, read all data
- remaining_data = file_data.read()
- file_bytes = header + remaining_data
file_data = io.BytesIO(file_bytes)
- header = file_bytes[:8]
+ except (io.UnsupportedOperation, OSError):
+ # Non-seekable stream, already read all data
+ file_data = io.BytesIO(file_bytes)
else:
- header = file_data[:8] if len(file_data) >= 8 else file_data
+ file_bytes = file_data
+ file_data = io.BytesIO(file_bytes)
- # Determine mime type from file header
- if header.startswith(b'\xff\xd8\xff'):
- mime_type = 'image/jpeg'
- elif header.startswith(b'\x89PNG\r\n\x1a\n'):
- mime_type = 'image/png'
- elif header.startswith(b'GIF8'):
- mime_type = 'image/gif'
- elif header.startswith(b'RIFF') and len(header) >= 8 and b'WEBP' in header:
- mime_type = 'image/webp'
+ # Use filetype library for robust MIME detection
+ kind = filetype.guess(file_bytes)
+ if kind is not None:
+ mime_type = kind.mime
else:
- mime_type = 'image/jpeg' # Default fallback
+ # Fallback to image/jpeg if detection fails
+ mime_type = 'image/jpeg'
media = self.client.media_post(file_data, mime_type=mime_type, description=filename)
return self._convert_mastodon_file(media)
diff --git a/requirements.txt b/requirements.txt
index 3d237b4..4a749b2 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -7,3 +7,4 @@ MarkupSafe==3.0.2
Werkzeug==3.1.3
Misskey.py==4.1.0
Mastodon.py==1.8.1
+filetype==1.2.0
From 8918b5205da5b6bc4c5d257950db5279c161d69f Mon Sep 17 00:00:00 2001
From: Moon
Date: Thu, 12 Jun 2025 13:25:04 +0900
Subject: [PATCH 28/56] named some damn properties wrong
---
.gitignore | 2 +-
bot/bot_app.py | 2 +-
bot/config.py | 4 ++++
bot/misskey_service.py | 13 ++++++++-----
example_config.ini | 4 ++++
5 files changed, 18 insertions(+), 7 deletions(-)
diff --git a/.gitignore b/.gitignore
index e5543ec..a05fd62 100644
--- a/.gitignore
+++ b/.gitignore
@@ -186,4 +186,4 @@ gacha_game*.db
gacha_game*.db.*
config*.ini
-.idea
\ No newline at end of file
+.idea
diff --git a/bot/bot_app.py b/bot/bot_app.py
index fc8a66a..f4bc1e0 100644
--- a/bot/bot_app.py
+++ b/bot/bot_app.py
@@ -11,7 +11,7 @@ def stream_notifications():
# Get the last seen notification ID from the database
last_seen_id = get_config("last_seen_notif_id")
- whitelisted_instances = getattr(config, 'WHITELISTED_INSTANCES', [])
+ whitelisted_instances = getattr(config, 'TRUSTED_INSTANCES', [])
print('Listening for notifications...')
while True:
diff --git a/bot/config.py b/bot/config.py
index 2f9f4a3..29a23a2 100644
--- a/bot/config.py
+++ b/bot/config.py
@@ -54,6 +54,10 @@ INSTANCE_TYPE = instance_type
# Web server port
WEB_PORT = config['application'].getint('WebPort', 5000)
+# Trusted instances
+trusted_instances_str = config['application'].get('TrustedInstances', '')
+TRUSTED_INSTANCES = [instance.strip() for instance in trusted_instances_str.split(',') if instance.strip()]
+
# Extra stuff for control of the bot
# TODO: move this to db
diff --git a/bot/misskey_service.py b/bot/misskey_service.py
index 3a16cd4..510b32b 100644
--- a/bot/misskey_service.py
+++ b/bot/misskey_service.py
@@ -99,9 +99,12 @@ class MisskeyService(FediverseService):
def get_notifications(self, since_id: Optional[str] = None) -> List[FediverseNotification]:
"""Get notifications from Misskey instance"""
- params = {}
+ params = {
+ 'include_types': ['mention', 'reply'],
+ 'limit': 50
+ }
if since_id:
- params["sinceId"] = since_id
+ params["since_id"] = since_id
notifications = self.client.i_notifications(**params)
return [self._convert_misskey_notification(notif) for notif in notifications]
@@ -121,13 +124,13 @@ class MisskeyService(FediverseService):
}
if reply_to_id:
- params["replyId"] = reply_to_id
+ params["reply_id"] = reply_to_id
if file_ids:
- params["fileIds"] = file_ids
+ params["file_ids"] = file_ids
if visible_user_ids and visibility == Visibility.SPECIFIED:
- params["visibleUserIds"] = visible_user_ids
+ params["visible_user_ids"] = visible_user_ids
response = self.client.notes_create(**params)
return response.get("createdNote", {}).get("id", "")
diff --git a/example_config.ini b/example_config.ini
index ec57058..58cf483 100644
--- a/example_config.ini
+++ b/example_config.ini
@@ -38,3 +38,7 @@ InstanceType = misskey
; Web server port (default: 5000)
WebPort = 5000
+
+; Comma-separated list of trusted fediverse instances (leave empty to allow only local users)
+; Example: TrustedInstances = mastodon.social,misskey.io,pleroma.example.com
+TrustedInstances =
From 298d7fda72773ec7735c4bb3473584673bd1c2da Mon Sep 17 00:00:00 2001
From: Moon
Date: Thu, 12 Jun 2025 13:29:12 +0900
Subject: [PATCH 29/56] rm needless file
---
CLAUDE.md | 31 -------------------------------
1 file changed, 31 deletions(-)
delete mode 100644 CLAUDE.md
diff --git a/CLAUDE.md b/CLAUDE.md
deleted file mode 100644
index 2e60baf..0000000
--- a/CLAUDE.md
+++ /dev/null
@@ -1,31 +0,0 @@
-# Kemoverse - Fediverse Gacha Bot
-
-A Python-based gacha-style bot for the Fediverse that interfaces with either Misskey or Pleroma instances.
-
-## Project Overview
-- **Language**: Python 3.11+
-- **Framework**: Flask for web interface
-- **Database**: SQLite
-- **Fediverse Support**: Configurable for Misskey or Pleroma instances
-- **API Integration**: Uses Misskey.py library for Fediverse API communication
-
-## Key Components
-- `bot/` - Core bot functionality including gacha mechanics, character management, and API interactions
-- `web/` - Flask web application for user interface and card management
-- `db.py` - Database utilities and schema management
-- `config.ini` - Instance configuration (API keys, instance URL, admin users)
-
-## Configuration
-The bot is configured via `config.ini` to connect to either a Misskey or Pleroma Fediverse instance. Key settings include:
-- Instance URL and API credentials
-- Bot user account details
-- Administrator user permissions
-- Database location
-
-## Development Commands
-- Install dependencies: `pip install -r requirements.txt`
-- Run bot: `python dev_runner.py`
-- Start web interface: `python web/app.py`
-
-## Testing
-Run tests with appropriate Python testing framework (check for pytest, unittest, or similar in project).
\ No newline at end of file
From f70b2147cda9cbe0022bb7571e097e95af654f7d Mon Sep 17 00:00:00 2001
From: Moon
Date: Fri, 13 Jun 2025 10:57:33 +0900
Subject: [PATCH 30/56] Remove legacy files that bypass FediverseService
abstraction
- Remove bot/client.py (replaced by fediverse factory)
- Remove bot/notification.py (replaced by bot_app.py)
- All functionality now properly uses FediverseService abstraction
---
bot/client.py | 6 ---
bot/notification.py | 122 --------------------------------------------
2 files changed, 128 deletions(-)
delete mode 100644 bot/client.py
delete mode 100644 bot/notification.py
diff --git a/bot/client.py b/bot/client.py
deleted file mode 100644
index 57f9f4e..0000000
--- a/bot/client.py
+++ /dev/null
@@ -1,6 +0,0 @@
-import misskey
-import config
-
-
-def client_connection() -> misskey.Misskey:
- return misskey.Misskey(address=config.INSTANCE, i=config.KEY)
diff --git a/bot/notification.py b/bot/notification.py
deleted file mode 100644
index 9427dbf..0000000
--- a/bot/notification.py
+++ /dev/null
@@ -1,122 +0,0 @@
-import traceback
-from typing import Dict, Any
-
-import misskey
-from misskey.exceptions import MisskeyAPIException
-
-from config import NOTIFICATION_BATCH_SIZE
-from parsing import parse_notification
-from db_utils import get_config, set_config
-from response import generate_response
-from custom_types import BotResponse
-
-# Define your whitelist
-# TODO: move to config
-WHITELISTED_INSTANCES: list[str] = []
-
-
-def process_notification(
- client: misskey.Misskey,
- notification: Dict[str, Any]) -> None:
- '''Processes an individual notification'''
- user = notification.get('user', {})
- username = user.get('username', 'unknown')
- host = user.get('host') # None if local user
- instance = host if host else 'local'
-
- if not (instance in WHITELISTED_INSTANCES or instance == 'local'):
- print(f'⚠️ Blocked notification from untrusted instance: {instance}')
- return
-
- # Copy visibility of the post that was received when replying (so if people
- # don't want to dump a bunch of notes on home they don't have to)
- visibility = notification['note']['visibility']
- if visibility != 'specified':
- visibility = 'home'
-
- notif_type = notification.get('type', 'unknown')
- notif_id = notification.get('id')
- print(f'📨 <{notif_id}> [{notif_type}] from @{username}@{instance}')
-
- # 🧠 Send to the parser
- parsed_notification = parse_notification(notification, client)
-
- if not parsed_notification:
- return
-
- # Get the note Id to reply to
- note_id = notification.get('note', {}).get('id')
-
- # Get the response
- response: BotResponse | None = generate_response(parsed_notification)
-
- if not response:
- return
-
- client.notes_create(
- text=response['message'],
- reply_id=note_id,
- visibility=visibility,
- file_ids=response['attachment_urls']
- # TODO: write actual visible users ids so pleromers can use the bot
- # privately
- # visible_user_ids=[]
- )
-
-
-def process_notifications(client: misskey.Misskey) -> bool:
- '''Processes a batch of unread notifications. Returns False if there are
- no more notifications to process.'''
-
- last_seen_id = get_config('last_seen_notif_id')
- # process_notification writes to last_seen_id, so make a copy
- new_last_seen_id = last_seen_id
-
- try:
- notifications = client.i_notifications(
- # Fetch notifications we haven't seen yet. This option is a bit
- # tempermental, sometimes it'll include since_id, sometimes it
- # won't. We need to keep track of what notifications we've
- # already processed.
- since_id=last_seen_id,
- # Let misskey handle the filtering
- include_types=['mention', 'reply'],
- # And handle the batch size while we're at it
- limit=NOTIFICATION_BATCH_SIZE
- )
-
- # No notifications. Wait the poll period.
- if not notifications:
- return False
-
- # Iterate oldest to newest
- for notification in notifications:
- try:
- # Skip if we've processed already
- notif_id = notification.get('id', '')
- if notif_id <= last_seen_id:
- continue
-
- # Update new_last_seen_id and process
- new_last_seen_id = notif_id
- process_notification(client, notification)
-
- except Exception as e:
- print(f'An exception has occured while processing a \
-notification: {e}')
- print(traceback.format_exc())
-
- # If we got as many notifications as we requested, there are probably
- # more in the queue
- return len(notifications) == NOTIFICATION_BATCH_SIZE
-
- except MisskeyAPIException as e:
- print(f'An exception has occured while reading notifications: {e}\n')
- print(traceback.format_exc())
- finally:
- # Quality jank right here, but finally lets us update the last_seen_id
- # even if we hit an exception or return early
- if new_last_seen_id > last_seen_id:
- set_config('last_seen_notif_id', new_last_seen_id)
-
- return False
From 7b32ee7fcf42c2e5d6c9048664df7b26dee3c1bc Mon Sep 17 00:00:00 2001
From: Moon
Date: Fri, 13 Jun 2025 11:23:34 +0900
Subject: [PATCH 31/56] had to change some things to get cursor for db working.
---
bot/add_character.py | 14 ++++----------
bot/bot_app.py | 5 ++++-
example_config.ini | 17 +++++++----------
3 files changed, 15 insertions(+), 21 deletions(-)
diff --git a/bot/add_character.py b/bot/add_character.py
index 7590c1b..55089fe 100644
--- a/bot/add_character.py
+++ b/bot/add_character.py
@@ -1,6 +1,6 @@
import requests
from fediverse_factory import get_fediverse_service
-from db_utils import get_db_connection
+import db_utils
from config import RARITY_TO_WEIGHT
def add_character(name: str, rarity: int, weight: float, image_url: str) -> tuple[int, str]:
@@ -47,20 +47,14 @@ def add_character(name: str, rarity: int, weight: float, image_url: str) -> tupl
except RuntimeError as e:
raise RuntimeError(f"Failed to upload image: {e}") from e
- # Insert into database
- conn = get_db_connection()
- cur = conn.cursor()
- cur.execute(
+ # Insert into database using the global connection pattern
+ db_utils.CURSOR.execute(
'INSERT INTO characters (name, rarity, weight, file_id) VALUES (?, ?, ?, ?)',
(stripped_name, rarity, float(weight), file_id)
)
- conn.commit()
- character_id = cur.lastrowid
+ character_id = db_utils.CURSOR.lastrowid
return character_id, file_id
except Exception as e:
raise
- finally:
- if 'conn' in locals():
- conn.close()
diff --git a/bot/bot_app.py b/bot/bot_app.py
index f4bc1e0..b4a95c8 100644
--- a/bot/bot_app.py
+++ b/bot/bot_app.py
@@ -1,11 +1,14 @@
import time
import traceback
from parsing import parse_notification
-from db_utils import get_config, set_config
+from db_utils import get_config, set_config, connect
from fediverse_factory import get_fediverse_service
import config
def stream_notifications():
+ # Initialize database connection
+ connect()
+
# Initialize the Fediverse service
fediverse_service = get_fediverse_service()
diff --git a/example_config.ini b/example_config.ini
index 58cf483..cb9aa89 100644
--- a/example_config.ini
+++ b/example_config.ini
@@ -5,6 +5,13 @@
DefaultAdmins = ['admin@example.tld']
; SQLite Database location
DatabaseLocation = ./gacha_game.db
+; Instance type - either "misskey" or "pleroma"
+InstanceType = misskey
+; Web server port (default: 5000)
+WebPort = 5000
+; Comma-separated list of trusted fediverse instances (leave empty to allow only local users)
+; Example: TrustedInstances = mastodon.social,misskey.io,pleroma.example.com
+TrustedInstances =
[gacha]
; Number of seconds players have to wait between rolls
@@ -32,13 +39,3 @@ User = @bot@example.tld
; API key for the bot
; Generate one by going to Settings > API > Generate access token
Token = abcdefghijklmnopqrstuvwxyz012345
-
-; Instance type - either "misskey" or "pleroma"
-InstanceType = misskey
-
-; Web server port (default: 5000)
-WebPort = 5000
-
-; Comma-separated list of trusted fediverse instances (leave empty to allow only local users)
-; Example: TrustedInstances = mastodon.social,misskey.io,pleroma.example.com
-TrustedInstances =
From 7161712f154ec37d4e7015691481b1bb91debd80 Mon Sep 17 00:00:00 2001
From: Moon
Date: Fri, 13 Jun 2025 13:26:01 +0900
Subject: [PATCH 32/56] rm unused function that bypassed server abstraction
---
bot/notification.py | 65 ++-------------------------------------------
1 file changed, 2 insertions(+), 63 deletions(-)
diff --git a/bot/notification.py b/bot/notification.py
index b69a496..ea544e2 100644
--- a/bot/notification.py
+++ b/bot/notification.py
@@ -1,9 +1,6 @@
-import traceback
-from typing import Dict, Any
-
-from config import NOTIFICATION_BATCH_SIZE, USE_WHITELIST
+from config import USE_WHITELIST
from parsing import parse_notification
-from db_utils import get_config, set_config, is_whitelisted, is_player_banned
+from db_utils import is_whitelisted, is_player_banned
from response import generate_response
from custom_types import BotResponse
from fediverse_factory import get_fediverse_service
@@ -71,61 +68,3 @@ def process_fediverse_notification(notification: FediverseNotification, fedivers
file_ids=file_ids
# visible_user_ids=[] # TODO: write actual visible users ids so pleromers can use the bot privately
)
-
-
-def process_notifications(client: misskey.Misskey) -> bool:
- '''Processes a batch of unread notifications. Returns False if there are
- no more notifications to process.'''
-
- last_seen_id = get_config('last_seen_notif_id')
- # process_notification writes to last_seen_id, so make a copy
- new_last_seen_id = last_seen_id
-
- try:
- notifications = client.i_notifications(
- # Fetch notifications we haven't seen yet. This option is a bit
- # tempermental, sometimes it'll include since_id, sometimes it
- # won't. We need to keep track of what notifications we've
- # already processed.
- since_id=last_seen_id,
- # Let misskey handle the filtering
- include_types=['mention', 'reply'],
- # And handle the batch size while we're at it
- limit=NOTIFICATION_BATCH_SIZE
- )
-
- # No notifications. Wait the poll period.
- if not notifications:
- return False
-
- # Iterate oldest to newest
- for notification in notifications:
- try:
- # Skip if we've processed already
- notif_id = notification.get('id', '')
- if notif_id <= last_seen_id:
- continue
-
- # Update new_last_seen_id and process
- new_last_seen_id = notif_id
- process_notification(client, notification)
-
- except Exception as e:
- print(f'An exception has occured while processing a \
-notification: {e}')
- print(traceback.format_exc())
-
- # If we got as many notifications as we requested, there are probably
- # more in the queue
- return len(notifications) == NOTIFICATION_BATCH_SIZE
-
- except MisskeyAPIException as e:
- print(f'An exception has occured while reading notifications: {e}\n')
- print(traceback.format_exc())
- finally:
- # Quality jank right here, but finally lets us update the last_seen_id
- # even if we hit an exception or return early
- if new_last_seen_id > last_seen_id:
- set_config('last_seen_notif_id', new_last_seen_id)
-
- return False
From a516a9b55a014fe41faaba2eaae85c053ccfec63 Mon Sep 17 00:00:00 2001
From: Moon
Date: Fri, 13 Jun 2025 13:36:38 +0900
Subject: [PATCH 33/56] minor change to make testing easier.
---
bot/fediverse_factory.py | 30 ++++++++++++++++++++++--------
1 file changed, 22 insertions(+), 8 deletions(-)
diff --git a/bot/fediverse_factory.py b/bot/fediverse_factory.py
index f2a9017..bee5f73 100644
--- a/bot/fediverse_factory.py
+++ b/bot/fediverse_factory.py
@@ -8,9 +8,13 @@ class FediverseServiceFactory:
"""Factory for creating FediverseService implementations based on configuration"""
@staticmethod
- def create_service() -> FediverseService:
+ def create_service(instance_type: str = None) -> FediverseService:
"""
- Create a FediverseService implementation based on the configured instance type.
+ Create a FediverseService implementation based on the instance type.
+
+ Args:
+ instance_type: The type of instance ("misskey" or "pleroma").
+ If None, reads from config.INSTANCE_TYPE
Returns:
FediverseService implementation (MisskeyService or PleromaService)
@@ -18,14 +22,24 @@ class FediverseServiceFactory:
Raises:
ValueError: If the instance type is not supported
"""
- if config.INSTANCE_TYPE == "misskey":
+ if instance_type is None:
+ instance_type = config.INSTANCE_TYPE
+
+ instance_type = instance_type.lower()
+
+ if instance_type == "misskey":
return MisskeyService()
- elif config.INSTANCE_TYPE == "pleroma":
+ elif instance_type == "pleroma":
return PleromaService()
else:
- raise ValueError(f"Unsupported instance type: {config.INSTANCE_TYPE}")
+ raise ValueError(f"Unsupported instance type: {instance_type}")
-def get_fediverse_service() -> FediverseService:
- """Convenience function to get a FediverseService instance"""
- return FediverseServiceFactory.create_service()
\ No newline at end of file
+def get_fediverse_service(instance_type: str = None) -> FediverseService:
+ """
+ Convenience function to get a FediverseService instance
+
+ Args:
+ instance_type: Optional instance type override for testing
+ """
+ return FediverseServiceFactory.create_service(instance_type)
\ No newline at end of file
From 40f018a83b3d7ab9224c0623c4f7f78ade677d59 Mon Sep 17 00:00:00 2001
From: Moon
Date: Fri, 13 Jun 2025 13:53:41 +0900
Subject: [PATCH 34/56] make instantiation explicit so easier to test.
---
bot/add_card.py | 6 +--
bot/bot_app.py | 3 +-
bot/fediverse_factory.py | 15 +++----
bot/mock_fediverse_service.py | 74 +++++++++++++++++++++++++++++++++++
bot/notification.py | 6 +--
bot/parsing.py | 2 +-
6 files changed, 88 insertions(+), 18 deletions(-)
create mode 100644 bot/mock_fediverse_service.py
diff --git a/bot/add_card.py b/bot/add_card.py
index ffa1120..2c91618 100644
--- a/bot/add_card.py
+++ b/bot/add_card.py
@@ -1,7 +1,7 @@
import requests
+import config
from fediverse_factory import get_fediverse_service
import db_utils
-from config import RARITY_TO_WEIGHT
def add_card(name: str, rarity: int, weight: float, image_url: str) -> tuple[int, str]:
"""
@@ -28,7 +28,7 @@ def add_card(name: str, rarity: int, weight: float, image_url: str) -> tuple[int
raise ValueError('Card name cannot be empty.')
if rarity < 1:
raise ValueError('Rarity must be a positive integer.')
- if rarity not in RARITY_TO_WEIGHT.keys():
+ if rarity not in config.RARITY_TO_WEIGHT.keys():
raise ValueError(f'Invalid rarity: {rarity}')
if not image_url:
raise ValueError('Image URL must be provided.')
@@ -40,7 +40,7 @@ def add_card(name: str, rarity: int, weight: float, image_url: str) -> tuple[int
raise RuntimeError(f"Failed to download image from {image_url}")
# Upload to Fediverse instance
- fediverse_service = get_fediverse_service()
+ fediverse_service = get_fediverse_service(config.INSTANCE_TYPE)
try:
uploaded_file = fediverse_service.upload_file(response.raw)
file_id = uploaded_file.id
diff --git a/bot/bot_app.py b/bot/bot_app.py
index dabc219..2609a1b 100644
--- a/bot/bot_app.py
+++ b/bot/bot_app.py
@@ -1,5 +1,6 @@
import time
import traceback
+import config
from notification import process_fediverse_notification
from db_utils import get_config, set_config, connect, setup_administrators
from fediverse_factory import get_fediverse_service
@@ -12,7 +13,7 @@ def stream_notifications():
setup_administrators()
# Initialize the Fediverse service
- fediverse_service = get_fediverse_service()
+ fediverse_service = get_fediverse_service(config.INSTANCE_TYPE)
# Get the last seen notification ID from the database
last_seen_id = get_config("last_seen_notif_id")
diff --git a/bot/fediverse_factory.py b/bot/fediverse_factory.py
index bee5f73..fe501db 100644
--- a/bot/fediverse_factory.py
+++ b/bot/fediverse_factory.py
@@ -1,20 +1,18 @@
from fediverse_service import FediverseService
from misskey_service import MisskeyService
from pleroma_service import PleromaService
-import config
class FediverseServiceFactory:
- """Factory for creating FediverseService implementations based on configuration"""
+ """Factory for creating FediverseService implementations"""
@staticmethod
- def create_service(instance_type: str = None) -> FediverseService:
+ def create_service(instance_type: str) -> FediverseService:
"""
Create a FediverseService implementation based on the instance type.
Args:
- instance_type: The type of instance ("misskey" or "pleroma").
- If None, reads from config.INSTANCE_TYPE
+ instance_type: The type of instance ("misskey" or "pleroma")
Returns:
FediverseService implementation (MisskeyService or PleromaService)
@@ -22,9 +20,6 @@ class FediverseServiceFactory:
Raises:
ValueError: If the instance type is not supported
"""
- if instance_type is None:
- instance_type = config.INSTANCE_TYPE
-
instance_type = instance_type.lower()
if instance_type == "misskey":
@@ -35,11 +30,11 @@ class FediverseServiceFactory:
raise ValueError(f"Unsupported instance type: {instance_type}")
-def get_fediverse_service(instance_type: str = None) -> FediverseService:
+def get_fediverse_service(instance_type: str) -> FediverseService:
"""
Convenience function to get a FediverseService instance
Args:
- instance_type: Optional instance type override for testing
+ instance_type: The instance type ("misskey" or "pleroma")
"""
return FediverseServiceFactory.create_service(instance_type)
\ No newline at end of file
diff --git a/bot/mock_fediverse_service.py b/bot/mock_fediverse_service.py
new file mode 100644
index 0000000..34a1c0c
--- /dev/null
+++ b/bot/mock_fediverse_service.py
@@ -0,0 +1,74 @@
+"""Mock FediverseService for testing purposes"""
+
+from typing import List, Optional, Union, BinaryIO
+from fediverse_service import FediverseService
+from fediverse_types import FediverseNotification, FediversePost, FediverseFile, Visibility
+
+
+class MockFediverseService(FediverseService):
+ """Mock implementation of FediverseService for testing"""
+
+ def __init__(self):
+ self.notifications = []
+ self.created_posts = []
+ self.uploaded_files = []
+
+ def get_notifications(self, since_id: Optional[str] = None) -> List[FediverseNotification]:
+ """Return mock notifications, optionally filtered by since_id"""
+ if since_id is None:
+ return self.notifications
+
+ # Filter notifications newer than since_id
+ filtered = []
+ for notif in self.notifications:
+ if notif.id > since_id:
+ filtered.append(notif)
+ return filtered
+
+ def create_post(
+ self,
+ text: str,
+ reply_to_id: Optional[str] = None,
+ visibility: Visibility = Visibility.HOME,
+ file_ids: Optional[List[str]] = None,
+ visible_user_ids: Optional[List[str]] = None
+ ) -> str:
+ """Mock post creation, returns fake post ID"""
+ post_id = f"mock_post_{len(self.created_posts)}"
+
+ # Store the post for assertions
+ self.created_posts.append({
+ 'id': post_id,
+ 'text': text,
+ 'reply_to_id': reply_to_id,
+ 'visibility': visibility,
+ 'file_ids': file_ids,
+ 'visible_user_ids': visible_user_ids
+ })
+
+ return post_id
+
+ def upload_file(self, file_data: Union[BinaryIO, bytes]) -> FediverseFile:
+ """Mock file upload, returns fake file"""
+ file_id = f"mock_file_{len(self.uploaded_files)}"
+
+ mock_file = FediverseFile(
+ id=file_id,
+ url=f"https://example.com/files/{file_id}",
+ type="image/png",
+ name="test_file.png"
+ )
+
+ self.uploaded_files.append(mock_file)
+ return mock_file
+
+ # Helper methods for testing
+ def add_mock_notification(self, notification: FediverseNotification):
+ """Add a mock notification for testing"""
+ self.notifications.append(notification)
+
+ def clear_all(self):
+ """Clear all mock data"""
+ self.notifications.clear()
+ self.created_posts.clear()
+ self.uploaded_files.clear()
\ No newline at end of file
diff --git a/bot/notification.py b/bot/notification.py
index ea544e2..f264718 100644
--- a/bot/notification.py
+++ b/bot/notification.py
@@ -1,4 +1,4 @@
-from config import USE_WHITELIST
+import config
from parsing import parse_notification
from db_utils import is_whitelisted, is_player_banned
from response import generate_response
@@ -10,7 +10,7 @@ from fediverse_types import FediverseNotification, NotificationType, Visibility
def process_fediverse_notification(notification: FediverseNotification, fediverse_service=None) -> None:
'''Processes an individual fediverse notification using the abstraction'''
if fediverse_service is None:
- fediverse_service = get_fediverse_service()
+ fediverse_service = get_fediverse_service(config.INSTANCE_TYPE)
# Get user and instance info
username = notification.user.username
@@ -18,7 +18,7 @@ def process_fediverse_notification(notification: FediverseNotification, fedivers
instance = host if host else 'local'
# Check whitelist
- if USE_WHITELIST and not is_whitelisted(instance):
+ if config.USE_WHITELIST and not is_whitelisted(instance):
print(f'⚠️ Blocked notification from untrusted instance: {instance}')
return
diff --git a/bot/parsing.py b/bot/parsing.py
index 476e774..d625980 100644
--- a/bot/parsing.py
+++ b/bot/parsing.py
@@ -10,7 +10,7 @@ def parse_notification(notification: FediverseNotification, fediverse_service=No
generate_response()'''
if fediverse_service is None:
- fediverse_service = get_fediverse_service()
+ fediverse_service = get_fediverse_service(config.INSTANCE_TYPE)
# We get the type of notification to filter the ones that we actually want
# to parse
From bd287b096ab6de4e3947e611b9517cd6767abdaa Mon Sep 17 00:00:00 2001
From: Moon
Date: Fri, 13 Jun 2025 18:47:54 +0900
Subject: [PATCH 35/56] rm reference to weight column.
---
bot/add_card.py | 1 -
bot/db_utils.py | 7 +++----
2 files changed, 3 insertions(+), 5 deletions(-)
diff --git a/bot/add_card.py b/bot/add_card.py
index fcaab43..16834a9 100644
--- a/bot/add_card.py
+++ b/bot/add_card.py
@@ -58,7 +58,6 @@ def add_card(
card_id = insert_card(
stripped_name,
rarity,
- RARITY_TO_WEIGHT[rarity],
file_id
)
return card_id, file_id
diff --git a/bot/db_utils.py b/bot/db_utils.py
index 94e915e..bdbd0d8 100644
--- a/bot/db_utils.py
+++ b/bot/db_utils.py
@@ -150,12 +150,11 @@ def is_player_administrator(username: str) -> bool:
def insert_card(
- name: str, rarity: int, weight: float, file_id: str) -> int:
+ name: str, rarity: int, file_id: str) -> int:
'''Inserts a card'''
CURSOR.execute(
- 'INSERT INTO cards (name, rarity, weight, file_id) VALUES \
-(?, ?, ?, ?)',
- (name, rarity, weight, file_id)
+ 'INSERT INTO cards (name, rarity, file_id) VALUES (?, ?, ?)',
+ (name, rarity, file_id)
)
card_id = CURSOR.lastrowid
return card_id if card_id else 0
From 77d4fa13bb44ca9b5322eaf8b12bb71cfb9a6cd8 Mon Sep 17 00:00:00 2001
From: Moon
Date: Fri, 13 Jun 2025 19:31:23 +0900
Subject: [PATCH 36/56] rm validation of removed weight
---
bot/response.py | 6 ------
1 file changed, 6 deletions(-)
diff --git a/bot/response.py b/bot/response.py
index b49de1e..e661bbf 100644
--- a/bot/response.py
+++ b/bot/response.py
@@ -120,12 +120,6 @@ in order: name, rarity',
be a number between 1 and 5',
'attachment_urls': None
}
- if not (is_float(arguments[2]) and 0.0 < float(arguments[2]) <= 1.0):
- return {
- 'message': f'{author} Invalid drop weight: \'{arguments[2]}\' \
-must be a decimal value between 0.0 and 1.0',
- 'attachment_urls': None
- }
card_id, file_id = add_card(
name=arguments[0],
From 3ad4edbc45e64689d9263f6108fa9f9b537a17d8 Mon Sep 17 00:00:00 2001
From: Moon
Date: Sat, 14 Jun 2025 04:10:16 +0900
Subject: [PATCH 37/56] ignore custom startup script
---
.gitignore | 1 +
1 file changed, 1 insertion(+)
diff --git a/.gitignore b/.gitignore
index a05fd62..2df4c91 100644
--- a/.gitignore
+++ b/.gitignore
@@ -185,5 +185,6 @@ cython_debug/
gacha_game*.db
gacha_game*.db.*
config*.ini
+run.sh
.idea
From 337a9896715f6f3f11c9354463e6e2af3a6e20f6 Mon Sep 17 00:00:00 2001
From: Moon
Date: Sat, 14 Jun 2025 04:34:20 +0900
Subject: [PATCH 38/56] rm vestigial trusted instances config.
---
bot/config.py | 4 ----
example_config.ini | 3 ---
2 files changed, 7 deletions(-)
diff --git a/bot/config.py b/bot/config.py
index 11541cd..4f1f907 100644
--- a/bot/config.py
+++ b/bot/config.py
@@ -57,10 +57,6 @@ INSTANCE_TYPE = instance_type
# Web server port
WEB_PORT = config['application'].getint('WebPort', 5000)
-# Trusted instances
-trusted_instances_str = config['application'].get('TrustedInstances', '')
-TRUSTED_INSTANCES = [instance.strip() for instance in trusted_instances_str.split(',') if instance.strip()]
-
# Fedi handles in the traditional 'user@domain.tld' style, allows these users
# to use extra admin exclusive commands with the bot
ADMINS = json.loads(config['application']['DefaultAdmins'])
diff --git a/example_config.ini b/example_config.ini
index 516d552..ab866fe 100644
--- a/example_config.ini
+++ b/example_config.ini
@@ -9,9 +9,6 @@ DatabaseLocation = ./gacha_game.db
InstanceType = misskey
; Web server port (default: 5000)
WebPort = 5000
-; Comma-separated list of trusted fediverse instances (leave empty to allow only local users)
-; Example: TrustedInstances = mastodon.social,misskey.io,pleroma.example.com
-TrustedInstances =
; Whether to limit access to the bot via an instance whitelist
; The whitelist can be adjusted via the application
UseWhitelist = False
From fdf21b3f5f71edafd9d41428ac5eb8e7adcab4a3 Mon Sep 17 00:00:00 2001
From: Moon
Date: Sat, 14 Jun 2025 04:43:43 +0900
Subject: [PATCH 39/56] rm check for env dev or prod so any can be used
---
bot/config.py | 2 --
1 file changed, 2 deletions(-)
diff --git a/bot/config.py b/bot/config.py
index 9737608..54689f3 100644
--- a/bot/config.py
+++ b/bot/config.py
@@ -13,8 +13,6 @@ def get_config_file() -> str:
env: str | None = environ.get('KEMOVERSE_ENV')
if not env:
raise ConfigError('Error: KEMOVERSE_ENV is unset')
- if not (env in ['prod', 'dev']):
- raise ConfigError(f'Error: Invalid environment: {env}')
config_path: str = f'config_{env}.ini'
From 2ef70801c70c30219ba0db12de277873c8a5f32a Mon Sep 17 00:00:00 2001
From: Moon
Date: Sat, 14 Jun 2025 05:08:59 +0900
Subject: [PATCH 40/56] fix config module ref
---
bot/config.py | 56 ++++++++++++++++++++++++++++++++++++++++++++--
example_config.ini | 5 +++++
web/app.py | 9 ++++++--
3 files changed, 66 insertions(+), 4 deletions(-)
diff --git a/bot/config.py b/bot/config.py
index 54689f3..e30d505 100644
--- a/bot/config.py
+++ b/bot/config.py
@@ -1,6 +1,7 @@
'''Essentials for the bot to function'''
import configparser
import json
+import re
from os import environ, path
@@ -21,6 +22,50 @@ def get_config_file() -> str:
return config_path
+def normalize_user(user_string: str) -> str:
+ """
+ Normalizes a user string to the format @user@domain.tld where domain is lowercase and user is case-sensitive
+
+ Args:
+ user_string: User string in various formats
+
+ Returns:
+ Normalized user string
+
+ Raises:
+ ValueError: If the user string is invalid or domain is malformed
+ """
+ if not user_string or not user_string.strip():
+ raise ValueError("User string cannot be empty")
+
+ user_string = user_string.strip()
+
+ # Add leading @ if missing
+ if not user_string.startswith('@'):
+ user_string = '@' + user_string
+
+ # Split into user and domain parts
+ parts = user_string[1:].split('@', 1) # Remove leading @ and split
+ if len(parts) != 2:
+ raise ValueError(f"Invalid user format: {user_string}. Expected @user@domain.tld")
+
+ username, domain = parts
+
+ if not username:
+ raise ValueError("Username cannot be empty")
+
+ if not domain:
+ raise ValueError("Domain cannot be empty")
+
+ # Validate domain format (basic check for valid domain structure)
+ domain_pattern = r'^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$'
+ if not re.match(domain_pattern, domain):
+ raise ValueError(f"Invalid domain format: {domain}")
+
+ # Return normalized format: @user@domain.tld (domain lowercase, user case-sensitive)
+ return f"@{username}@{domain.lower()}"
+
+
def get_rarity_to_weight(
config_section: configparser.SectionProxy) -> dict[int, float]:
"""Parses Rarity_X keys from config and returns a {rarity: weight} dict."""
@@ -36,17 +81,24 @@ config = configparser.ConfigParser()
config.read(get_config_file())
# Username for the bot
-USER = config['credentials']['User'].lower()
+if 'User' not in config['credentials'] or not config['credentials']['User'].strip():
+ raise ConfigError("User must be specified in config.ini under [credentials]")
+
+USER = normalize_user(config['credentials']['User'])
# API key for the bot
KEY = config['credentials']['Token']
# Bot's Misskey instance URL
INSTANCE = config['credentials']['Instance'].lower()
+# Web server port
+WEB_PORT = config['application'].getint('WebPort', 5000)
+BIND_ADDRESS = config['application'].get('BindAddress', '127.0.0.1')
+
# Fedi handles in the traditional 'user@domain.tld' style, allows these users
# to use extra admin exclusive commands with the bot
ADMINS = json.loads(config['application']['DefaultAdmins'])
# SQLite Database location
-DB_PATH = config['application']['DatabaseLocation']
+DB_PATH = config['application'].get('DatabaseLocation', './gacha_game.db')
# Whether to enable the instance whitelist
USE_WHITELIST = config['application']['UseWhitelist']
diff --git a/example_config.ini b/example_config.ini
index 0ea2422..8c18c28 100644
--- a/example_config.ini
+++ b/example_config.ini
@@ -5,6 +5,11 @@
DefaultAdmins = ["@localadmin", "@remoteadmin@example.tld"]
; SQLite Database location
DatabaseLocation = ./gacha_game.db
+; Web server port (default: 5000)
+WebPort = 5000
+; Web server bind address (default: 127.0.0.1, set to 0.0.0.0 to listen on all interfaces)
+BindAddress = 127.0.0.1
+
; Whether to lmit access to the bot via an instance whitelist
; The whitelist can be adjusted via the application
UseWhitelist = False
diff --git a/web/app.py b/web/app.py
index 61ed38f..fcd67a1 100644
--- a/web/app.py
+++ b/web/app.py
@@ -1,10 +1,15 @@
import sqlite3
+import sys
+from pathlib import Path
+# Add parent directory to Python path so we can import from bot/
+sys.path.append(str(Path(__file__).parent.parent))
+
+from bot.config import WEB_PORT, BIND_ADDRESS, DB_PATH
from flask import Flask, render_template, abort
from werkzeug.exceptions import HTTPException
app = Flask(__name__)
-DB_PATH = "./gacha_game.db" # Adjust path if needed
def get_db_connection():
conn = sqlite3.connect(DB_PATH)
@@ -68,4 +73,4 @@ def submit_character():
if __name__ == '__main__':
- app.run(host='0.0.0.0', port=5000, debug=True)
+ app.run(host=BIND_ADDRESS, port=WEB_PORT, debug=True)
From f4f847e5770a130271a1ed206bb36578236015b3 Mon Sep 17 00:00:00 2001
From: Moon
Date: Sat, 14 Jun 2025 05:14:40 +0900
Subject: [PATCH 41/56] make sure UseWhitelist is a boolean, default to True
---
bot/config.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/bot/config.py b/bot/config.py
index e30d505..5a1046d 100644
--- a/bot/config.py
+++ b/bot/config.py
@@ -100,7 +100,7 @@ ADMINS = json.loads(config['application']['DefaultAdmins'])
# SQLite Database location
DB_PATH = config['application'].get('DatabaseLocation', './gacha_game.db')
# Whether to enable the instance whitelist
-USE_WHITELIST = config['application']['UseWhitelist']
+USE_WHITELIST = config['application'].getboolean('UseWhitelist', True)
NOTIFICATION_POLL_INTERVAL = int(config['notification']['PollInterval'])
NOTIFICATION_BATCH_SIZE = int(config['notification']['BatchSize'])
From 7fd4d5db25e670704026f5cacbb8f9bd152f838c Mon Sep 17 00:00:00 2001
From: Moon
Date: Sat, 14 Jun 2025 05:17:39 +0900
Subject: [PATCH 42/56] indicate on startup if whitelisting is enabled.
---
bot/bot_app.py | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/bot/bot_app.py b/bot/bot_app.py
index ed2772b..54b70c8 100644
--- a/bot/bot_app.py
+++ b/bot/bot_app.py
@@ -3,7 +3,7 @@ import misskey as misskey
from client import client_connection
import db_utils as db
-from config import NOTIFICATION_POLL_INTERVAL
+from config import NOTIFICATION_POLL_INTERVAL, USE_WHITELIST
from notification import process_notifications
if __name__ == '__main__':
@@ -15,6 +15,10 @@ if __name__ == '__main__':
# Setup default administrators
db.setup_administrators()
+ # Show whitelist status
+ whitelist_status = "enabled" if USE_WHITELIST else "disabled"
+ print(f'Instance whitelisting: {whitelist_status}')
+
print('Listening for notifications...')
while True:
if not process_notifications(client):
From d416ae1b2da2dfe89c8145ac9d59f67121a34ab5 Mon Sep 17 00:00:00 2001
From: Moon
Date: Sat, 14 Jun 2025 05:47:43 +0900
Subject: [PATCH 43/56] rm limitation on KEMOVERSE_ENV from another place.
---
setup_db.py | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
diff --git a/setup_db.py b/setup_db.py
index 241bb4e..ae73c03 100644
--- a/setup_db.py
+++ b/setup_db.py
@@ -57,16 +57,14 @@ def perform_migration(cursor: sqlite3.Cursor, migration: tuple[int, str]) -> Non
def get_db_path() -> str | DBNotFoundError:
'''Gets the DB path from config.ini'''
env = os.environ.get('KEMOVERSE_ENV')
- if not (env and env in ['prod', 'dev']):
- raise KemoverseEnvUnset
-
- print(f'Running in "{env}" mode')
config_path = f'config_{env}.ini'
if not os.path.isfile(config_path):
raise ConfigError(f'Could not find {config_path}')
+ print(f'Running in "{env}" mode')
+
config = ConfigParser()
config.read(config_path)
db_path = config['application']['DatabaseLocation']
From 1a35750d0a1e843693aff22f9cdca5aff0231906 Mon Sep 17 00:00:00 2001
From: Moon
Date: Sat, 14 Jun 2025 05:51:49 +0900
Subject: [PATCH 44/56] restrict characters in KEMOVERSE_ENV
---
bot/config.py | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/bot/config.py b/bot/config.py
index 5a1046d..57cbfa9 100644
--- a/bot/config.py
+++ b/bot/config.py
@@ -14,6 +14,10 @@ def get_config_file() -> str:
env: str | None = environ.get('KEMOVERSE_ENV')
if not env:
raise ConfigError('Error: KEMOVERSE_ENV is unset')
+
+ # Validate environment name contains only alphanumeric, dash, and underscore
+ if not re.match(r'^[a-zA-Z0-9_-]+$', env):
+ raise ValueError(f'KEMOVERSE_ENV "{env}" contains invalid characters. Only alphanumeric, dash (-), and underscore (_) are allowed.')
config_path: str = f'config_{env}.ini'
From 24bfe88dc1e6887d5b8189718ece33bf720a64f4 Mon Sep 17 00:00:00 2001
From: Moon
Date: Sat, 14 Jun 2025 05:57:01 +0900
Subject: [PATCH 45/56] rm obsolete print
---
setup_db.py | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/setup_db.py b/setup_db.py
index ae73c03..f1e9085 100644
--- a/setup_db.py
+++ b/setup_db.py
@@ -64,7 +64,7 @@ def get_db_path() -> str | DBNotFoundError:
raise ConfigError(f'Could not find {config_path}')
print(f'Running in "{env}" mode')
-
+
config = ConfigParser()
config.read(config_path)
db_path = config['application']['DatabaseLocation']
@@ -94,7 +94,6 @@ def main():
return
except KemoverseEnvUnset:
print('Error: KEMOVERSE_ENV is either not set or has an invalid value.')
- print('Please set KEMOVERSE_ENV to either "dev" or "prod" before running.')
print(traceback.format_exc())
return
From 6494ac4909afada0f4147ad24448d31d4ea9ba6e Mon Sep 17 00:00:00 2001
From: w
Date: Sun, 15 Jun 2025 16:50:27 -0300
Subject: [PATCH 46/56] Typo that saves the west
---
readme.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/readme.md b/readme.md
index ed33ec4..7a939cc 100644
--- a/readme.md
+++ b/readme.md
@@ -76,7 +76,7 @@ The full license text can be found here: https://www.gnu.org/licenses/agpl-3.0.h
The AGPL is designed to ensure that software freedom is preserved, especially in networked environments. If you improve this project or build something on top of it, please give back to the community by sharing your changes too.
-Unless another license is listed, every file in the project is licensed under the GNU General Public License version 3 (or at your option), any later version.
+Unless another license is listed, every file in the project is licensed under the GNU Affero General Public License version 3 (or at your option), any later version.
```mermaid
flowchart TD
From 42180f4139e62358b3ae7c4aad6da462a32eec98 Mon Sep 17 00:00:00 2001
From: w
Date: Tue, 17 Jun 2025 23:54:55 -0300
Subject: [PATCH 47/56] Added copyright notice
---
.gitignore | 16 +++++++++
bot/add_card.py | 16 +++++++++
bot/bot_app.py | 30 ++++++++--------
bot/config.py | 16 +++++++++
bot/custom_types.py | 16 +++++++++
bot/db_utils.py | 16 +++++++++
bot/fediverse_factory.py | 16 +++++++++
bot/fediverse_service.py | 16 +++++++++
bot/fediverse_types.py | 16 +++++++++
bot/misskey_service.py | 16 +++++++++
bot/mock_fediverse_service.py | 16 +++++++++
bot/notification.py | 16 +++++++++
bot/parsing.py | 16 +++++++++
bot/pleroma_service.py | 16 +++++++++
bot/response.py | 16 +++++++++
contributing.md | 49 ++++++++++++++++++++++++++
dev_runner.py | 16 +++++++++
docs/index.md | 17 +++++++++
docs/install.md | 17 +++++++++
docs/theme.md | 17 +++++++++
example_config.ini | 17 +++++++++
migrations/0000_setup.sql | 17 +++++++++
migrations/0001_fix_notif_id.sql | 17 +++++++++
migrations/0002_weigh_infer.sql | 18 ++++++++++
migrations/0003_rename_tables.sql | 18 ++++++++++
migrations/0004_add_administrators.sql | 18 ++++++++++
migrations/0005_add_whitelist.sql | 18 ++++++++++
readme.md | 20 ++++++++++-
requirements.txt | 16 +++++++++
startup.sh | 30 ++++++++--------
web/static/style.css | 21 +++++++++--
web/templates/_base.html | 17 +++++++++
web/templates/_error.html | 17 +++++++++
web/templates/about.html | 17 +++++++++
web/templates/index.html | 18 ++++++++++
web/templates/submit.html | 17 +++++++++
web/templates/user.html | 17 +++++++++
37 files changed, 650 insertions(+), 33 deletions(-)
create mode 100644 contributing.md
diff --git a/.gitignore b/.gitignore
index 2df4c91..7e6735c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
diff --git a/bot/add_card.py b/bot/add_card.py
index ffa9601..39a1393 100644
--- a/bot/add_card.py
+++ b/bot/add_card.py
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
import requests
import config
from fediverse_factory import get_fediverse_service
diff --git a/bot/bot_app.py b/bot/bot_app.py
index ffbd413..2f448dc 100644
--- a/bot/bot_app.py
+++ b/bot/bot_app.py
@@ -1,18 +1,18 @@
-#Kemoverse - a gacha-style bot for the Fediverse.
-#Copyright © 2025 Waifu
-#
-#This program is free software: you can redistribute it and/or modify
-#it under the terms of the GNU Affero General Public License as
-#published by the Free Software Foundation, either version 3 of the
-#License, or (at your option) any later version.
-#
-#This program is distributed in the hope that it will be useful,
-#but WITHOUT ANY WARRANTY; without even the implied warranty of
-#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-#GNU Affero General Public License for more details.
-#
-#You should have received a copy of the GNU Affero General Public License
-#along with this program. If not, see https://www.gnu.org/licenses/.
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu VD15
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
import time
import traceback
diff --git a/bot/config.py b/bot/config.py
index 36177f9..5519ad9 100644
--- a/bot/config.py
+++ b/bot/config.py
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
'''Essentials for the bot to function'''
import configparser
import json
diff --git a/bot/custom_types.py b/bot/custom_types.py
index 7fc7885..61fc632 100644
--- a/bot/custom_types.py
+++ b/bot/custom_types.py
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
from typing import TypedDict, List, Dict, Any
BotResponse = TypedDict('BotResponse', {
diff --git a/bot/db_utils.py b/bot/db_utils.py
index bdbd0d8..7ce2f82 100644
--- a/bot/db_utils.py
+++ b/bot/db_utils.py
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
from random import choices
import sqlite3
import config
diff --git a/bot/fediverse_factory.py b/bot/fediverse_factory.py
index fe501db..3ed9561 100644
--- a/bot/fediverse_factory.py
+++ b/bot/fediverse_factory.py
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
from fediverse_service import FediverseService
from misskey_service import MisskeyService
from pleroma_service import PleromaService
diff --git a/bot/fediverse_service.py b/bot/fediverse_service.py
index 1292d63..5395841 100644
--- a/bot/fediverse_service.py
+++ b/bot/fediverse_service.py
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
from abc import ABC, abstractmethod
from typing import List, Optional, Union, BinaryIO
from fediverse_types import FediverseNotification, FediversePost, FediverseFile, Visibility
diff --git a/bot/fediverse_types.py b/bot/fediverse_types.py
index c1580b6..0218490 100644
--- a/bot/fediverse_types.py
+++ b/bot/fediverse_types.py
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
from dataclasses import dataclass
from typing import Optional, List, Dict, Any
from enum import Enum
diff --git a/bot/misskey_service.py b/bot/misskey_service.py
index 510b32b..50cf6fc 100644
--- a/bot/misskey_service.py
+++ b/bot/misskey_service.py
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Moon
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
import misskey
from typing import List, Optional, Dict, Any, Union, BinaryIO
from fediverse_service import FediverseService
diff --git a/bot/mock_fediverse_service.py b/bot/mock_fediverse_service.py
index 34a1c0c..7121ccf 100644
--- a/bot/mock_fediverse_service.py
+++ b/bot/mock_fediverse_service.py
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Moon
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
"""Mock FediverseService for testing purposes"""
from typing import List, Optional, Union, BinaryIO
diff --git a/bot/notification.py b/bot/notification.py
index f264718..2c4d9ad 100644
--- a/bot/notification.py
+++ b/bot/notification.py
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
import config
from parsing import parse_notification
from db_utils import is_whitelisted, is_player_banned
diff --git a/bot/parsing.py b/bot/parsing.py
index d625980..9365b58 100644
--- a/bot/parsing.py
+++ b/bot/parsing.py
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
import re
import config
from response import generate_response
diff --git a/bot/pleroma_service.py b/bot/pleroma_service.py
index 21320d1..a870ca5 100644
--- a/bot/pleroma_service.py
+++ b/bot/pleroma_service.py
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Moon
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
from mastodon import Mastodon
from typing import List, Optional, Dict, Any, Union, BinaryIO
import io
diff --git a/bot/response.py b/bot/response.py
index e661bbf..ab81faa 100644
--- a/bot/response.py
+++ b/bot/response.py
@@ -1,3 +1,19 @@
+#Kemoverse - a gacha-style bot for the Fediverse.
+#Copyright © 2025 Waifu and VD-15
+#
+#This program is free software: you can redistribute it and/or modify
+#it under the terms of the GNU Affero General Public License as
+#published by the Free Software Foundation, either version 3 of the
+#License, or (at your option) any later version.
+#
+#This program is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+#GNU Affero General Public License for more details.
+#
+#You should have received a copy of the GNU Affero General Public License
+#along with this program. If not, see https://www.gnu.org/licenses/.
+
from datetime import datetime, timedelta, timezone
from typing import TypedDict, Any, List, Dict
import db_utils as db
diff --git a/contributing.md b/contributing.md
new file mode 100644
index 0000000..5858d9e
--- /dev/null
+++ b/contributing.md
@@ -0,0 +1,49 @@
+
+
+# Contributing to Kemoverse
+
+Contributions are welcome with the following requirements:
+
+## Licensing
+
+- All contributions must be licensed under the **AGPLv3-or-later** or a compatible license.
+- If you include code from another project (e.g., MIT Expat), please **list the license and copyright holders** clearly.
+- If your contribution introduces code under a different license, you **must clarify this**, so the project can remain license-compliant.
+
+## Attribution
+
+- Please **add your name** to the license header of any file where you’ve made a **nontrivial change**.
+- Nontrivial changes include:
+ - New features
+ - Logic changes
+ - Major refactoring or structure changes
+ - Not: typo fixes or simple reformatting
+
+## Commit Messages (optional but appreciated)
+
+- Try to write clear, descriptive commit messages.
+
+## Communication
+
+- If you're planning a major change or feature, please open an issue or contact the maintainers first.
+- This helps avoid duplicated work and makes collaboration easier.
+
+---
+
+Thank you for helping grow the Kemoverse 💫
\ No newline at end of file
diff --git a/dev_runner.py b/dev_runner.py
index b39a434..92fd0aa 100644
--- a/dev_runner.py
+++ b/dev_runner.py
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
import subprocess
import os
from watchdog.observers import Observer
diff --git a/docs/index.md b/docs/index.md
index 292d673..ad9ec67 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,3 +1,20 @@
+
# 🎲 Kemoverse Documentation
Welcome to the developer documentation for **Kemoverse**, a gacha trading card game in the Fediverse!
diff --git a/docs/install.md b/docs/install.md
index e5f8658..82e37c1 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -1,3 +1,20 @@
+
## 🧪 Installation
diff --git a/docs/theme.md b/docs/theme.md
index 69e9ed3..929b673 100644
--- a/docs/theme.md
+++ b/docs/theme.md
@@ -1,3 +1,20 @@
+
Welcome to the **Visual Identity** guide for the Kemoverse. This page contains the standard colors, logos, and graphic elements used across the game (cards, UI, web presence, bots, etc). Please follow these guidelines to ensure consistency.
---
diff --git a/example_config.ini b/example_config.ini
index 1dd738e..b147f34 100644
--- a/example_config.ini
+++ b/example_config.ini
@@ -1,3 +1,20 @@
+; Kemoverse - a gacha-style bot for the Fediverse.
+; Copyright © 2025 Waifu and VD15
+
+; This program is free software: you can redistribute it and/or modify
+; it under the terms of the GNU Affero General Public License as
+; published by the Free Software Foundation, either version 3 of the
+; License, or (at your option) any later version.
+
+; This program is distributed in the hope that it will be useful,
+; but WITHOUT ANY WARRANTY; without even the implied warranty of
+; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+; GNU Affero General Public License for more details.
+
+; You should have received a copy of the GNU Affero General Public License
+; along with this program. If not, see https://www.gnu.org/licenses/.
+
+
; Rename me to config.ini and put your values in here
[application]
; Comma separated list of fedi handles for any administrator users
diff --git a/migrations/0000_setup.sql b/migrations/0000_setup.sql
index 4dcbc64..de62501 100644
--- a/migrations/0000_setup.sql
+++ b/migrations/0000_setup.sql
@@ -1,3 +1,20 @@
+/*
+Kemoverse - a gacha-style bot for the Fediverse.
+Copyright © 2025 VD15
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see https://www.gnu.org/licenses/.
+*/
CREATE TABLE IF NOT EXISTS users (
id INTEGER PRIMARY KEY AUTOINCREMENT,
username TEXT UNIQUE NOT NULL,
diff --git a/migrations/0001_fix_notif_id.sql b/migrations/0001_fix_notif_id.sql
index 3494d6e..d15db89 100644
--- a/migrations/0001_fix_notif_id.sql
+++ b/migrations/0001_fix_notif_id.sql
@@ -1 +1,18 @@
+/*
+Kemoverse - a gacha-style bot for the Fediverse.
+Copyright © 2025 VD15
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see https://www.gnu.org/licenses/.
+*/
INSERT OR IGNORE INTO config VALUES ("last_seen_notif_id", 0);
diff --git a/migrations/0002_weigh_infer.sql b/migrations/0002_weigh_infer.sql
index 28a1002..77f619e 100644
--- a/migrations/0002_weigh_infer.sql
+++ b/migrations/0002_weigh_infer.sql
@@ -1 +1,19 @@
+/*
+Kemoverse - a gacha-style bot for the Fediverse.
+Copyright © 2025 Waifu
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see https://www.gnu.org/licenses/.
+*/
+
ALTER TABLE characters DROP COLUMN weight;
diff --git a/migrations/0003_rename_tables.sql b/migrations/0003_rename_tables.sql
index a3ba3a7..0ca0d85 100644
--- a/migrations/0003_rename_tables.sql
+++ b/migrations/0003_rename_tables.sql
@@ -1,3 +1,21 @@
+/*
+Kemoverse - a gacha-style bot for the Fediverse.
+Copyright © 2025 VD15
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see https://www.gnu.org/licenses/.
+*/
+
ALTER TABLE users RENAME TO players;
ALTER TABLE characters RENAME TO cards;
ALTER TABLE pulls RENAME user_id TO player_id;
diff --git a/migrations/0004_add_administrators.sql b/migrations/0004_add_administrators.sql
index 7503e21..51bef49 100644
--- a/migrations/0004_add_administrators.sql
+++ b/migrations/0004_add_administrators.sql
@@ -1 +1,19 @@
+/*
+Kemoverse - a gacha-style bot for the Fediverse.
+Copyright © 2025 VD15
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see https://www.gnu.org/licenses/.
+*/
+
ALTER TABLE players ADD COLUMN is_administrator BOOLEAN NOT NULL DEFAULT 0;
diff --git a/migrations/0005_add_whitelist.sql b/migrations/0005_add_whitelist.sql
index d24f2e3..7769253 100644
--- a/migrations/0005_add_whitelist.sql
+++ b/migrations/0005_add_whitelist.sql
@@ -1,3 +1,21 @@
+/*
+Kemoverse - a gacha-style bot for the Fediverse.
+Copyright © 2025 VD15
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see https://www.gnu.org/licenses/.
+*/
+
CREATE TABLE IF NOT EXISTS instance_whitelist (
tld TEXT UNIQUE PRIMARY KEY
);
diff --git a/readme.md b/readme.md
index 7bedcea..43cb272 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,21 @@
+
+
# Kemoverse
A gacha-style bot for the Fediverse built with Python. Users can roll for characters, trade, duel, and perhaps engage with popularity-based mechanics. Supports both Misskey and Pleroma instances. Name comes from Kemonomimi and Fediverse.
@@ -63,7 +81,7 @@ The bot is meant to feel *light, fun, and competitive*. Mixing social, gacha and
## 📝 License
-This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).
+This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0-or-later).
This means:
diff --git a/requirements.txt b/requirements.txt
index 4a749b2..d747e71 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1,19 @@
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
blinker==1.9.0
click==8.1.8
Flask==3.1.0
diff --git a/startup.sh b/startup.sh
index e8c3bed..3741e71 100755
--- a/startup.sh
+++ b/startup.sh
@@ -1,20 +1,20 @@
#!/bin/bash
-#Kemoverse - a gacha-style bot for the Fediverse.
-#Copyright © 2025 Waifu
-#
-#This program is free software: you can redistribute it and/or modify
-#it under the terms of the GNU Affero General Public License as
-#published by the Free Software Foundation, either version 3 of the
-#License, or (at your option) any later version.
-#
-#This program is distributed in the hope that it will be useful,
-#but WITHOUT ANY WARRANTY; without even the implied warranty of
-#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-#GNU Affero General Public License for more details.
-#
-#You should have received a copy of the GNU Affero General Public License
-#along with this program. If not, see https://www.gnu.org/licenses/.
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu and VD15
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
# Navigate to the project directory (optional)
cd "$(dirname "$0")"
diff --git a/web/static/style.css b/web/static/style.css
index 74231c1..95380a8 100644
--- a/web/static/style.css
+++ b/web/static/style.css
@@ -1,13 +1,30 @@
+/*
+Kemoverse - a gacha-style bot for the Fediverse.
+Copyright © 2025 Waifu
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see https://www.gnu.org/licenses/.
+ */
body {
font-family: "Segoe UI", Tahoma, Geneva, Verdana, sans-serif;
- background-color: #f4f6fa;
+ background-color: #FAFAFA;
color: #333;
margin: 0;
padding: 0;
}
header {
- background-color: #7289da;
+ background-color: #5aa02c;
color: white;
padding: 20px;
text-align: center;
diff --git a/web/templates/_base.html b/web/templates/_base.html
index a1f1b22..f025c75 100644
--- a/web/templates/_base.html
+++ b/web/templates/_base.html
@@ -1,3 +1,20 @@
+
diff --git a/web/templates/_error.html b/web/templates/_error.html
index defc5d8..6d18f04 100644
--- a/web/templates/_error.html
+++ b/web/templates/_error.html
@@ -1,3 +1,20 @@
+
{% extends "_base.html" %}
{% block title %}
{{ error.code }}
diff --git a/web/templates/about.html b/web/templates/about.html
index 184fde9..b704664 100644
--- a/web/templates/about.html
+++ b/web/templates/about.html
@@ -1,3 +1,20 @@
+
{% extends "_base.html" %}
{% block content %}
diff --git a/web/templates/index.html b/web/templates/index.html
index f9bf7a0..6f2351d 100644
--- a/web/templates/index.html
+++ b/web/templates/index.html
@@ -1,3 +1,21 @@
+
+
{% extends "_base.html" %}
{% block header %}
diff --git a/web/templates/submit.html b/web/templates/submit.html
index d0424b8..ad36de4 100644
--- a/web/templates/submit.html
+++ b/web/templates/submit.html
@@ -1,3 +1,20 @@
+
{% extends "_base.html" %}
{% block content %}
diff --git a/web/templates/user.html b/web/templates/user.html
index 8010538..1ccb447 100644
--- a/web/templates/user.html
+++ b/web/templates/user.html
@@ -1,3 +1,20 @@
+
{% extends "_base.html" %}
{% block content %}
From 7f3e0e0f8b6f481a9f9124335d3c4a5510171ca6 Mon Sep 17 00:00:00 2001
From: w
Date: Wed, 18 Jun 2025 00:21:56 -0300
Subject: [PATCH 48/56] Update copyright notices to include all contributors in
various files
---
.gitignore | 2 +-
bot/add_card.py | 2 +-
bot/bot_app.py | 2 +-
bot/config.py | 2 +-
bot/custom_types.py | 2 +-
bot/db_utils.py | 2 +-
bot/fediverse_factory.py | 2 +-
bot/fediverse_service.py | 2 +-
bot/fediverse_types.py | 2 +-
bot/misskey_service.py | 2 +-
bot/mock_fediverse_service.py | 2 +-
bot/notification.py | 2 +-
bot/parsing.py | 2 +-
bot/pleroma_service.py | 2 +-
bot/response.py | 2 +-
docs/index.md | 2 +-
docs/install.md | 2 +-
docs/theme.md | 2 +-
migrations/0000_setup.sql | 2 +-
migrations/0001_fix_notif_id.sql | 2 +-
migrations/0002_weigh_infer.sql | 2 +-
migrations/0003_rename_tables.sql | 2 +-
readme.md | 27 ++++++++++++++++++---------
23 files changed, 40 insertions(+), 31 deletions(-)
diff --git a/.gitignore b/.gitignore
index 7e6735c..2ccf20c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,5 @@
# Kemoverse - a gacha-style bot for the Fediverse.
-# Copyright © 2025 Waifu
+# Copyright © 2025 Waifu, VD15 and contributors.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
diff --git a/bot/add_card.py b/bot/add_card.py
index 39a1393..def64f6 100644
--- a/bot/add_card.py
+++ b/bot/add_card.py
@@ -1,5 +1,5 @@
# Kemoverse - a gacha-style bot for the Fediverse.
-# Copyright © 2025 Waifu
+# Copyright © 2025 Waifu, Moon, VD15 and contributors.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
diff --git a/bot/bot_app.py b/bot/bot_app.py
index 2f448dc..9070415 100644
--- a/bot/bot_app.py
+++ b/bot/bot_app.py
@@ -1,5 +1,5 @@
# Kemoverse - a gacha-style bot for the Fediverse.
-# Copyright © 2025 Waifu VD15
+# Copyright © 2025 Waifu, VD15, Moon and contributors.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
diff --git a/bot/config.py b/bot/config.py
index 5519ad9..f226d45 100644
--- a/bot/config.py
+++ b/bot/config.py
@@ -1,5 +1,5 @@
# Kemoverse - a gacha-style bot for the Fediverse.
-# Copyright © 2025 Waifu
+# Copyright © 2025 Waifu, VD15, Moon and contributors.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
diff --git a/bot/custom_types.py b/bot/custom_types.py
index 61fc632..6aad962 100644
--- a/bot/custom_types.py
+++ b/bot/custom_types.py
@@ -1,5 +1,5 @@
# Kemoverse - a gacha-style bot for the Fediverse.
-# Copyright © 2025 Waifu
+# Copyright © 2025 VD15 and contributors.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
diff --git a/bot/db_utils.py b/bot/db_utils.py
index 7ce2f82..18e705f 100644
--- a/bot/db_utils.py
+++ b/bot/db_utils.py
@@ -1,5 +1,5 @@
# Kemoverse - a gacha-style bot for the Fediverse.
-# Copyright © 2025 Waifu
+# Copyright © 2025 Waifu VD15, Moon, and contributors.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
diff --git a/bot/fediverse_factory.py b/bot/fediverse_factory.py
index 3ed9561..d7d61b5 100644
--- a/bot/fediverse_factory.py
+++ b/bot/fediverse_factory.py
@@ -1,5 +1,5 @@
# Kemoverse - a gacha-style bot for the Fediverse.
-# Copyright © 2025 Waifu
+# Copyright © 2025 Moon and contributors.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
diff --git a/bot/fediverse_service.py b/bot/fediverse_service.py
index 5395841..4bb4169 100644
--- a/bot/fediverse_service.py
+++ b/bot/fediverse_service.py
@@ -1,5 +1,5 @@
# Kemoverse - a gacha-style bot for the Fediverse.
-# Copyright © 2025 Waifu
+# Copyright © 2025 Moon and contributors.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
diff --git a/bot/fediverse_types.py b/bot/fediverse_types.py
index 0218490..99d58ce 100644
--- a/bot/fediverse_types.py
+++ b/bot/fediverse_types.py
@@ -1,5 +1,5 @@
# Kemoverse - a gacha-style bot for the Fediverse.
-# Copyright © 2025 Waifu
+# Copyright © 2025 Moon and contributors.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
diff --git a/bot/misskey_service.py b/bot/misskey_service.py
index 50cf6fc..aad3944 100644
--- a/bot/misskey_service.py
+++ b/bot/misskey_service.py
@@ -1,5 +1,5 @@
# Kemoverse - a gacha-style bot for the Fediverse.
-# Copyright © 2025 Moon
+# Copyright © 2025 Moon and contributors.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
diff --git a/bot/mock_fediverse_service.py b/bot/mock_fediverse_service.py
index 7121ccf..bc6546d 100644
--- a/bot/mock_fediverse_service.py
+++ b/bot/mock_fediverse_service.py
@@ -1,5 +1,5 @@
# Kemoverse - a gacha-style bot for the Fediverse.
-# Copyright © 2025 Moon
+# Copyright © 2025 Moon and contributors.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
diff --git a/bot/notification.py b/bot/notification.py
index 2c4d9ad..95a3292 100644
--- a/bot/notification.py
+++ b/bot/notification.py
@@ -1,5 +1,5 @@
# Kemoverse - a gacha-style bot for the Fediverse.
-# Copyright © 2025 Waifu
+# Copyright © 2025 Waifu, Moon, VD15, and contributors.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
diff --git a/bot/parsing.py b/bot/parsing.py
index 9365b58..7cadd79 100644
--- a/bot/parsing.py
+++ b/bot/parsing.py
@@ -1,5 +1,5 @@
# Kemoverse - a gacha-style bot for the Fediverse.
-# Copyright © 2025 Waifu
+# Copyright © 2025 Waifu, Moon, VD15, and contributors.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
diff --git a/bot/pleroma_service.py b/bot/pleroma_service.py
index a870ca5..4886c90 100644
--- a/bot/pleroma_service.py
+++ b/bot/pleroma_service.py
@@ -1,5 +1,5 @@
# Kemoverse - a gacha-style bot for the Fediverse.
-# Copyright © 2025 Moon
+# Copyright © 2025 Moon and contributors.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
diff --git a/bot/response.py b/bot/response.py
index ab81faa..93cf614 100644
--- a/bot/response.py
+++ b/bot/response.py
@@ -1,5 +1,5 @@
#Kemoverse - a gacha-style bot for the Fediverse.
-#Copyright © 2025 Waifu and VD-15
+#Copyright © 2025 Waifu, VD15 and contributors.
#
#This program is free software: you can redistribute it and/or modify
#it under the terms of the GNU Affero General Public License as
diff --git a/docs/index.md b/docs/index.md
index ad9ec67..f6ad524 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,6 +1,6 @@
~g^Nz}Fw3n41Oy_*N*Gx=$J2wl7J7^tS#)1r5pVE?e;^BtVq
zL3eu4nEg{?3@Ek=m;mvqJhw6!NLs2U4U%cmG=_D0p&F|d<904AD(PXi
ziFGU)gvj;fy@Kqs9(`C0-&SK5PnsRC_`Xdm>CN^hDYX(6R3r+L@S1rd4VS_w{JTX8j
zFi7i)$&4&3D|F6|u
zE&?D{Tq1ve%KlpVy|H`*ZEt^7^}2o7f!BOK4bOGTFy(I2D)i#>EQcet8bhFPD(vj2GfOo1ah)N|_OYOTKjJm{bLY^3VKUj{K1z{(3U2tVQh
z=l=mUa+*iyZ#x<*YrEgLMwZxf29d?wvav+?vfZ>af8bkO3HsZus;*Tc!?45kN@d1i
z8;&IhUwQ`*l;#Gtm_|(f{^+!2mqe?j&BOi$Llg&xMa0Td{`XamQ0BK76}5_RUeenI
z<3WCT8y}WW3+b>bmf5gt(Rl7rxw@1|Q?cqLYsbJGu(N4uZvN`BL&wXrx>@4X~@Xeyto#u4I(Li%s^DHPIzLTB4)c^8tIbKRKmtETU*@p
z-Z(9}6jBDWDV|hVVc|FL`ui)zw?KjAn+)~antPU*BGA^um-65^i?sWtn%tgz0IWN8
ze9#o-KA1iAqzPEK;8ISWu`tT=#y<(_&gDl#Tt>EI5c?uS+I=`s$HF+0R9DXU*)0g;
zWv;hSoW#`078!)r08&RwrF>ho2G`6jUUm#51f4|yK%`-mc;$Hl{5+ph{a0E7)WsAi
zWXJ-tZ5z#P3ADaz`FqF|f~Ps|>GK*{nfmH#Gdz|?*Am&mc?`lq12R&)<~mCfD#LTz9mX1{
zDbR_q%)MUk&wv@bI6gNwXLkCXSVu<&SSRVs=;#|6nR$AqPVPpJ5U<~4+B
z@+@D7f;+*2%0UEIVBcfrnfcS{xfHOXZQPrI+wxojJmk+j&%sh>CsaN^l%s<(Bmxa8
z?ds{<9wkPz!_JNL-2RiDbD(zGMpTnB6>7kJ4@_qlt
z>~80f2BtmI3v{T9~{!Jd+aYv9FTGAlcpdxdkB5OZu<1pWD|s8Lty|d+&QY&z!3f
zDVN+dYa;IG8N6iQMCo*c&>7frR^limS`zn6Lc3hP4ez3V-m{0R7jxXLhi+cg2^Y?c
z1eSir78yrAY;?AzC+l6s?{n)PIB}h7SJD0Sx1}{kdivQjG3;+Xzj$R0oFR-aR!{>b
zvFY0442;wxI`>|zP%7dUsa1km1lKp4qn4;Hi(EKh5bUIU9_}vTk1{?!!S`%CF&CCK
zdV7s*VH=GPq#Cg2DOw52DV~)WJumQjXQx#->d>b-8;=j8q`4f;V}n(NkL%5DKKlF>
z;cr5WJVTUADzT|dl&Gt(?*S=oV<0{eU>Y{gc&xMVKJNPeTJDuO;PGIWU9_Wi@ix9&
z&{-QlDxfc{VA>p+VdY`#qggaH($<(27aSmmbLjfljzd*_84F5n=Lua^nBM;B
z$sFDPmuZ&Z`a9MhOOlmFC<9VVaLi*bRi?l45c#Y(aj;Bo`R!t2c>oaAcG)|(jTI}h
zyI%akENs-)S`EC)Ioo^Z9zW$%9at79J|HMWB$$Q>>$%?{3fiQGKd)Bc>hq4b3o$TpFxi@`V{P9
z-M{qTZ=3}c#|7w1)RGWlEU#?2kl9o~1;Y>K)9^R&?foeU>I4vb8Z^=@K~1as$WHoW
z%Fbhti$lTU3Sp#k5&syMQ1P*ZCR2iEO$k8+QgxmBXLB6j9sCK!;#od)yd|WIPRO
zl2%r0mNA0{Xo{V28%7iDm;io3VrFIrh0*1H6}gG+fP)m1
z`00~%-wsL@JwoJIWD?>9B{fPy88gBXD;371@S9)_q6FQ
zM_rAAZhO*RUI-AEJ4o{gEZ2}Gt76J!s{LY-moIu!DxVbAa;E=ezZd6TxNNVbk%ViE
zmpTWD3bneU`L=dK;NkY32t&t7V#vAD(s2DU%PHMA&;Atwtk4N2Ycx~IfrH))6Cfx1
zb9xA@LT*hS&O6;aJbG7FsK7uba@6LVt4|WYiFI&9-FUKq)0=QWt2_JAQsvzvY7)a5
zj-lG@pU4f1@r^tHxo6Feow+!#3UeDV|L-?`V=CEGo+n40#H8+n%@Ol13OQxjyH
zEeI_JQEuIPMZfdAcg&;yuk`Hs8N4-B1YG6i)bhB|1!9mspz*tgH_oCDXQja6uc_~i
zb-+bLBh25KIZg|gina=}PNY5Om#ypBZW`F=F!#eL>u7;C%pv-R@`Mw%XXfiTgBM{A
z^iMKFBl`YEh05ejs!-#gGH^6Olz2idO3yH_x?8vibzyp$-`vV-mB0DCSs;tjLNDeK
zRFIKCoWb+DY
z%s*Qk<>_$7RIlbJ)eMMcE(hJIM(Vt%(Kivc@@E$aq(ZzLvAPF61UF_V9x|6+f9+nG
z#DUX8z{D10*I4B`mPi|w`$Z7ByH7XDvnq-W7lUf^_odJR>ZP{!%M2BO5INchd(NYu
zGrU@&Bn=M)q{=8KiHWQwtO&`)zxNdIIJYEPUl#AphW!EXoxU#lZv-w489+~s`$QGi
zD+m}&mO80F`nesG$RJXYO`k|QOQb)BGbjh#HtjWwN}4xQ2?>zIz_hu&=r0eJwkVc-
zBS6;51I59wj<}?b>AKu4#*=jZ_q-fPOS
zYpC-KDvh$bflXAsC&?$a;Y>pl(T?o!5$f1xCRq_H_)jt@Yx>=Z*uqQk*u@1g5Iqe5P~*-xfmR->z+?YT%=X!r
z0pm`!Pfu?c2wgsYY+9bhcX)9u@tO%
zZH2dw%`0=C4B^@pe~J_5-(yJ2ta3)vGY_0?KQ%j$Kv#PGn`ZoN`AM?U?_b5x{mGn1
zJJeyO52m^0Rbc(Gx&{yeqRuPifn+!-&w3tz%{87|enP=4+!T5_KM-^4)%Iu!RW@e_
zt1Kl~pdqc?iJoR8X^urnl}#ln=SdoJ38uBd*-r5~+9eMi%ncjt`}@O=2i
zi|=t*tr#F02U@l**?%Vx0ZWzu-(*BXLn}*hZU30Z41}E%QC3N`R-sZIPgPIDJNAn_
z+*brNCA2W!q;w}I^~}oeCW1cH0r=x=&(qW
zk5f-bhN&8d9h8)6op<*tRElBU_rS3x+uYJJ`~zEiFUT4OOPO0dWGKHnF<4TJ=l;8s
zI|)7Qt=3j{{aS9H8*KVrVn`1~^*=5EN!wbO%!Y;CYe6P}|ksz5prWi(I$8
zibEIgQ>6qas&0XSf!u)ZrH8wv(?g2DK@VPOehwHn9&xv-rQD3ln-ouFeM0>DZlVu8
zu1n-gp*lbH3Yc+yviK(n!&xx*3@`4AqTKcNCgPU7bs5nvadszR`k|0S8zihS`??pm
z7Li&>wAym4lXuw`vkYVxgAuQigc&F<^o$G{M%*=WCdS=#P$Xr1bIlgbi$yJd>?Q9O
z?Qd!;^LaVirD%X=4O179wUfB4_$Ml;`CeyHm#w4X%{sIDoV(vHf8VS8S_C?u)VR>9cUzjp}bKQ^vS
zt_Z!~Yq8S7KTFBgk(z$)iiUEJN9ik0h_`ya+?r)1P9m6)(7{A98Gn!kHu7*;OfLj12a}Sk0^Jj;6
zogvTF=KMNFhcf!Y2WgwrC*v*`)sTkYD{9%uJ|S8GEH
zaNR%WagPs0Job3Gaj?iX<7B*b$4ud#Eh#!myb(B7=~(y5z}&s2f1`_eTZR+|(ZT&8
zwXz1LN-9scP~~LKGT%GHaq^R=;i*n=0x#Zef!Iwr5-=l#qEd(K!Xe~~8&ezN?q>Qkr
zipxT{gh!^ql%ipw|75Hd2z$UNOLM;-e2wSlyQp$1jQ~gBJBa@UA_pPjER8pUTc6_0
zgmcug`f-AWFd5(^B}bD#?Hfs0QBFNB85mA5LHc@P1@hWD9wbxF3~pZnbWMGc+wS^0^Knj7+nii{E3U(28byBfM#(NTw*VI&+XF9S^b#(O><}AK6
zNmMV%mf$AZ#2zga7F+O8)J&4NS$!GK_~|+Jl((%>r>4qnbg3-QOXO6FAByT=`AAKp
zAgju8i*$^?yyfH?!VoF8Vh!1l(DPf5LF-%IfMij2zcndIb?oIXX57u3e^JM>wHhAt
zR9E+l*PY<`%H!`o!z(^drbFF?&6)%)C&u$D5>=+AA?8
zN;3m|3|;~wDf80RR%Rn1Z8+WMd-#+2$2#1^lt4LPbljg_0{w%*5e%oZf}=>pMkE2<
z67c<4A6zr;!Q1mf^nCe+YI(AdKsyIzQLn(lTzubc%ml&b@Uv6u?t&s}v~WxW1?D8F
zGgLAl2nZ4q3g>bL&xcJ9??96mH6*|YM+Sb227N83R07u0pDrPb6*M#=4=og
z)l(CpKc*mJ+9>+Qy`h_O|D_z~U)%Twkw?a;Z|ylLD_$;oeXgBP(zpW2x@M)x*Kg~;
z#9!660mr+^hzH`GgX)3XjUHDF7f!V|sf!UCvdfV=OB
z6vj~cGkCEz!TOg-v5r6C^>r-0}POYdbzA?ycFK~o1~4&5hiY5Q=s
z4lZ3LY>la~Ea*;(JG1rdYyGu9yH5gB6Nkd2Y}IhXdgbM%U$GOesv75aYeha(*1`_`
zsh|pf9Z;L~@?5_&yz1Wbnc|kqM)dV+8AvN?#R`m%CCF>&|G}dG@Ql6R`f3u1>yo^F
zuXx`xlj?F+?JsV?4qjdKqkLI=+<^b-@z565;mL@huAHYr3AbcUeSJqC%;nvF9BUH{
zHfcb;X8+t5ld%}Ein*0Dl<0*6uAmFe&ZnvmXR1I&*=Z(B?tXJ`6yI;YTYjPGVLMDY
zuC7774Xh9K(dkrJ$g4{->>}+ar}6$=?Y6wp!58uWRJHXcX&Y5#G{^|E0Y#<3+iz0e
zCflY?6ihy>i$O>4D30I~SMUPOs7iq+bBM6KQs~vk7w}6n>)%V$O#!O0;-JPAkk-|Z
z{^q6QOYWNNjhX;o+7oVJ-
ze$Zs+N+_oPC*x=(yds@XQtvp7^Sm5&=)J_uVnyY;||IsbV%JkbO3J
z7DKkr!Z@~)?y($`Ja)Y%iAtN48X(p=GaxV_M@~vnBPvqDO%PrNv3|cc_ubGQp{HT|
zOSZZeK_iD&Q&H|ZBVf)Y+Qku;=McJ%5nbEa*WRz6T-ccjrBfJG38YKWl*MqE;bV5{
zymrU74_LDM*hk1!@p}aJR^ke}-%@25^BK;$+4=eTb{E(lTwg1fOz#MLOQ1Gr6bVvI
zzMxtU5R7K1<}(Y7-cx_~DC{gb0LHVm{l7dv@htXu%iEi&-oM%P!7tNR
z)eHf}fQd5)$^e0*@WdZX{Nw6{to4cG2B$nkY=_nqmxz?Z!H@ySn{@vI!)@E#+Qw7?
z<1Nk2by_8FG?c_ezB037cizf$u&A!NlSOkk)}unQaCdLL8Y_K0JVGSYzLzjk0oLqh
zd+uHAoWpy~g4(ZcvnAWkap%&3klHa^rjgY!M_d0R5?3+QsBhLDa&(in63#zpD4q^R
z2r$XNFq5Kb>_?0EjyJXPD3xwdiYir10U9PzBe@K{g0Ps#9(Vm%;oKtaM$@Pq@)+jW
zuTMJXudf@Mcj^7am-oR6W5JP7upmb?=bg{=wdfctzKO~Swdl^dZ{`T~_*m$KNB2gO
zuMVaMVlJ}Cv`h#WWh$+7%`3gqQchUJ=U;vw+zxc)iV5UeTT*Qp0
ze->d0l>yB^FKBfJAao7wZ~jDa&3tu7w)y7
zKv`asnvW}{B3Bd@5}^rgD^S7srsaqCqILalf3z&nLfe*TC@|$tQdmahA_6@`FXx{7
zV9+qMEw3C|nlm8HLt@XnzDY1y;Ke&u_Mt_n;5U6zmz$zBtL*IVAAYel=1@OHGNB0>
z?vwgBNG-ukVf=?wKQrmlotKwSPhX!3z=f9-BFlLnIa8ldi5tpWw&h(NnRbraY+w30
zY|<C4Wq>>n{zX4Hua9R+;z7~P7|=`q&uvNa-))()oNXID8sEYT
zx6mDPiR)9KJ!un|G#C=demNU&gV50TySzO8hi1?T*26cr8w}hjZV1Hm05h$Th}?i!
zg@$I|`X^=hb;pZd7)Cq!d5<+vHOe3(#PuyF(tLE{p}TZvr?GHV=%P>5fC^CFzTJFg&@hVw_awdH=RJoiXBV&2
zrx_})#g~J+68Q}$)12yGVv!`g>l*pZ6H~?HyXF?rNveZ$=bu;oS=^lQb^^=9)Ur=;
zUGlQ5FZM`i*9zVoy5xTL_kP~?z`ia~KegxXwf5AxAkS)lxiY=2~xm86#CW|_jG5kap@oo2FnK|2WtrkQo4O5u&4)nZI#m3
zok2OlR}sO>!#`E$mX@}Fa^Qz&oJJ6tVk6Njz^*eWA0THx*}##w3Y=dT{@Nd{f+}wL
ztiHfhm|T-DEpg?1pO+@=Ch8jhV@nkgl3+3ZU7PI3EerkkD%@bta=R0Jg%$A7x?~P^
zS9L5zVRR77>DaSpq8R{r6X^R7P1h7N3~*{Ih~xPlP29+XTGp{M8k0?(CZx3Wb~}zB
z0`)6O6)P{CxUDL3pALxkad527#`mz=Vrb;3ii_BE-)AgxG$;bY8Bg
zyu68{6nims_^sQ7F0lm0qR0)WP&>ha@UM-{cQ=2O6KckM_oxui53RHbQk5x5q=Z8
z}jSZ*Yv}X-u$8X4RPj5p)%HS_gBmRMI5g#F+(f_XEMb=xwA)@DWwQ1-V}<3xu(R
zYl^n(2Lb?wD|^u^h@NeZ=jb#8Ni-lJC1W++TD;w#ff
zmzUQL_gx!pMa=9Z!2efQVDX2oNAbDNcI1pBXS
zS_U4y{~(0qE2IB|`%t4OfQJgaKfVdKv-FH)1WN;6FsKJ%<0fmm`nQ&4lJ;sbyu3
z&ordaXipkz|3E0Dz98Q`YrDef9>u!Anr-)|ux8B-xCO}VVqx~^qg=A2qIpAWPov*$
z(II%tDPoYgsZ5q}Ih0p^3wvj>lJ7rD))^-heW2EiOGbQ0#BPz5Ceo?sOtD@sQe;!`
z(TI^SR4p#`gC~{D3p%GzSirV(3F1z4C#=XQ{BnXlSdh1uw(2vvsFgX@E
zX_aq05)w7QPyKZ0J-rioxx@FNf^SRM&TQjxzwPF)oYG=jezE1V6uf_ZX~j4OeK#IU8Udku2-o
z7IHpq?3u!m(%06qsLsl|I&{+78Y$XYs;(OMvX@?o((^kE_K6ykBY}j2rW|lxHJdBa
zG>Znwz$OLyy@cyv>Fday&}9wG6{N<~uesv6ut5!`_AY^LCyBNTZKriI5c=ei2J@6K
z-QLC-O5k66W{0-FxJ>HzSIvYjaoVJEGgtbJbL2rJhMtH^`{ehh2-`s?y;1!tQjg@=
zLl{R5cuhUI-?&=>+Ko2suOu#QH-8awC4r9IQacF?@TQx>H*Vv^WmTYdm%tW4%te{fWcq4gYTWi9XX#8P4~BG`np1~S$|?*nQ^Y2Q%4kv%(n{QDd%
z{NWr)BXGXIcLJ)?5Hn@$qmt4M=>N2pcS-eCqbTYMjR|<+
z@zsPBA;w&+R>qHN-4TlH0||m=?u0rBV?2?Upd`}(D#4-Qx!XnC6>uHQLlGoNv(T;L2DI=7nHlavBS$@(=V6gCs
zd$LGgMu7Q?{~p_oe*y>pa7zhiM;7OZhRmM*b2B~t9j@okaH9GlPzCA+2|4-9()AvM
zcC&>0yo8D9mpoPHjhEL{mCsVo3-WEp6Qsw_!plJj$ublj$P%$0%Ct9m?ZM*Qt;otd_PPa
zmXt?uNssa;@CswBqQccFFy;e$Py`o=wH`%fjmYyv)ER>x@<^DX$|2FzgNGOrS2K4&
z@ECzb0bj+w16LFHwBR-y;D?}j1`)qUUu)C2m2t$%@o;k*u2om~wd2HaF^)`Lsfg+8
zC|PlpNY`@su4VVYo=~+HgS*`?fRzw!z&5kw?1UT+$oT_1Aulg4a954Ku$xe5UX`6)
zGDDPwg!7#9-Ts4$o#FnwiB&-W5Q$~@k4(S?D#wj!K63rSkA{0apW&^8oP--ug%)>Q%DRfpR-8T_n6n;iO7r65N~e(@FpWclQDqe
zGLUInfBSJ(i6zH3>X8CP&t&tAA+i9Q$p;%0$=9;Q-&7NyN7Mj~kYg&xgd(oajim9s
z;K>3#w+tvhvx{_Gm%4SRP#=Q#0r}CPcNLeylWcwcHQ5iHBMVDkzcZ4Ac;4UYgo;Uz8!k?ZORHnNqdZv#-^TdyHEwryVNBS*92ZMMddp7!WIs
z#ev#cWk^*PIbgBpJrU?R*9PB0iyo0ij_1E5mOnk-?Ke=+gI;wurt*{0J2a;#lgrX@
z=s^ejfvzvd@j#gcHN38N$W3E8MarPdFUdVl?sWC4p9zDkW$p%u{d4{ltAI{X)YGjkoww>t95_MDv
zWB7H8*L8E|#-DhnNZ(6Avp0ncmE_S&%cU!ifTxYqQpYH8wjL~e_m4oi{>C%`@O2v)
zKPl}~lr}hi2q@q&uy4>(Whr1cd?_vbMjpC-PsVmx5I8MnniYjf1ud`5{A>?Ytg^|+
z-GM@_HvT^iI9c1DU>p{fuAe7P@tIy(#X|Qi%l76M90X;l3EH{Me;k6qHwo1HGtqk#
z@NNDQaP6t1tAkyYVdZ#X#urRCJ1O)3R~Y*LTVZ?)MsWY3E$tXPPK-^NZQmM1lV~m8
zVx>?3Nzp?Y(-*sPKq!Ms@OG>}(VQ{0D}pkHB_KE>Jt`wWL+chOay4a<9T@mSE>bXt
ztWs1_FKKBnRW5(?$|B9@GX<4ehY4mJcn9
z4VEw)7lctNy1V5hl|uBBl6H{j2zt1!9XTwZ=i9{s1!zcKlNSsptOE;OXk(6!(|eaY
z&;0(73%>~tkW&93N2eau&%ZD~FeD@9I<_S=k?p?xjlUrU73oGcB1O7uaglsRM@OLf
z>*%oQ;D&oOR8V=Gj*(^%VW({)D;Y7S`03l-G3VR{Q^&%1RPmi}0+PZ#!U=Qdtd^+Z
zBa$EdF1>#{#LM2G0Ii=pP;86b{NWP$dO`x^MmH!oz@%lkuJ;EI>;)2H4y{e`yr@Pw
zGIQSGbbVWAnlu_!Ti#0MC1+U{+GF#!pSJp(%rVvO$-#$c-F+upZ>x+9t7q)p#bgQ}
za@+a*ooHL9goC$?O=_@d-_>q**j4K^{(zZt!5m+4!44fy6JYL!&2i_F+8N4?sU>#h
zT1gti!xi5LV`IZ{EL%
z(S5|?Dd=<0Lp+~Qp`sQ@OqUVMU$-
zpk+f*rLBWQPmmgqyu_hhf}M>u!_FQ`kl_B2iNb8_`KE(IG>xqSZ6dvFQsDT|90aVK
z0`A#!Pj^HgxZuI>wXa=xbEmnV(R+O%QvU;I#4;A>38!a{AP#zWXQr=@Ka2`0+6w}6
zRa-+r^AqVU0Z8=fFW1EQ{5lrmIJ;e@NXo*=NWg_#3^-NZEib6rtTX#i8RuQ{Lc;3;3nZxUJUN=~QwE8Zh_*!3~ba=em
zH;5Rr5SbByu!sN>PW<=m!V;=boBy}~$>s-SAd3yNR6Jq#N*Geu)2Fg-V@t5cNqV-o
z9s$G44}68c?SPG}jW3~*uZ_A_+9-XvpAul?%(QT5hA
zQNI88u!VHGbc0Bj0@6r{bayvM_tHrBBHbO*-6buxl+r9EC9xo}G|!E{`MkgL?8pq`
z9}dIq{kqO|&Uu})+Y-wsfF)=@e$ABNsr{8mhYhM~JsxvtBR6O|=oZ5rN-u@X1>5LH
z45c7AMWj$^82<`JWV|Nin+!b7E_%;Zxz!>hE_gdy-~c|omM4gM2U}<#j@iRnI)71#
zF2NNpcGClT9w_d(QQ(`2d{VfcAmSD(I$P>}moFVH-_C-Pbv(L-w?n3wEw~PNHGi-7
zh51}BSUxt*(<^3k7_vR#2#OA(3C&0`Cw{RlnkT%#Zhn(ferl)sPMn%qUpKmuOMkS^
z+G;5o>Z%2w%+G23HWskn|5Jy`Co`So7qGAa)SGc;DF6oatrd?|p!$`NwQQne7*i5>
zV^04jNX7v#&ajz*Wxjq~iqh_GbWiK0x%_T-i}`5e*s00J&)`#vy(q(4$2C!A(Gj$e
zwMyM9)0DiRrEn=`$vmW@HQUzT{`Y?#Hcy6ehfZH*q7U%wW2!4p8qGzDWatm(>1GOh
zh?^x*8&wQwhrNG^n>QI)|K>MV;X_0|3tCyenF?f{+|J3@19G^)1H3T>`4X+)iu!MZ
ze*Fv|TGUdL^E(u0zxVMmH!vZ~hLZeg8}wFOa#hQ3srSy>v+6DAqxZT0l|sh4)6j(O
zES1@R3_bV6W709AQ_p8-y9kjCi{hgTY4$narMQ70T7{RkDl?j|hLKk{EBBk{OD)&Q
zrWcG#OSlzsU9etZ+Z+n1kJZbJj=kVP`Z~@SXLg!k4{wVF5bEE{6Vv-Y)%TG=Yg%AJ
z!Yk;u3&AK7lyCc#Psb(`0oVe+m0e56!E~Y+{4n0;y`316gs(^rxZxiXq>Lh2MoC%;
zI`Ba!&{
za5^&0a9=;ZO=)vP@SaO0Is5kHCOb~(#tpwS^u=(;6Pn%pU3AW8yrw6EYd8%kNg6$V
zF-kS4?);7|yqmCl@z@Q&eM2I|Av
zFH1ejiOan(k+n_%pyA}anP`A*zskl5Ja~>`$x>C%ASh$A=mS2tC77DA+q87d`%&DR=UcQ_q~IG%_K>G9WXXVrE(zEt?xMQbDUCU>67|33Y`RN(e@M`UOGJDu$)!D!2*YV%;OE;P*XteNa>*sAx$BHnl;*P(u
zdN&c`QI+#TT9TA5uxf5Gb~6VV*f`Uh0xLt?}PmZz8VSe@NlYp7RP}%=
zRib1FBDU(V<^{E}Zj9J$xRY*obzQVl*((X^F%
zXhDy6g*B&LST$P3>6#d#k%>#zp~b`bdx8IDj@pCTai;+MZ>I;a(bK%TwSB?;Grxy5
z1tb~4E}IF)h{LYIEH8Z8XJi)ubRZ5odU?srxjiP${L(Z$0lu7^oqGY>ZWbq4@ZT1F
z&_Et1OUh`MQiU15k8r~(8Z&NP{#*7zNw{%$<(Fa`ZI%?4WZ4RAK5dwHrpNj{+6UF9J=XFgX5Qw=|vDU82{ZJz5H*s6bux6cw8;n^X$K67LEcNQiu?6pa5
z4;Up(P0+mAE)52^)p{n6c6x%4eSoMvpOXPXpTEQOJ{Jp?V>_q!PUg51)_4OP@bBIu
z`O)@4)`_m2M%~0sSPK-po-Jc&%=o*Njjppb;ZJu5NhZs%w~}#^laeo_yveIcW)}^{
zzKg5R0hU7`5t;>UumIPg^NN7d{}Pwd{}xzD4{ow!9F4Eqr^+Tx(%{X(Uw8z8Y5##h
zKA3kRivFB&R^PhI7n)P=0zn*sF2Yfyp{RE{mfEhY45(RUhnWR4rdSZjZl)wY((D4&
z_koR~z_{x5pzl=t@(L1Pd!9n4q|x4Kf(x-%)n&e#q{&vM#lDH&$1N!PNSm0S8a*gC
z^vWWEv7pSNodSV`9Z@EO^StlGC`$^2V%*tZqURRjjySm_zU{UwAWc_-)U`6idm`bq
zk2oIV)FWy91z(pYnRp8pv2f`Ypl+6Jz&67&-7r6HIN=h~owT^x@KM+9F9yfjcs-p#
z^!kJ^JCSjhWHzB=DM02$gnt8vt^<5!WA@1HqRD-}jJ}WILd25|?{z5B*_N~P4A;M+
z#m5l{gbc0$847?F_pChjvQg95)YA7PevRa~|Z)bvFVq7w3XxeU8r>)9#p^3}x
zm7Toil@@gvTK~@BeFsMUheQ=%{lLAc84!e&_3N9Php_#QePR9&zQErx=6^~(qJ--6
zJ%4;(43O$jfbhMyX=66AI07j0VW(K^ev>Q=o-coMuQNSGWcbS)E=bNkv@FQBF$G`q
zp5X8|iyCKcS^15;SEO*N%XIN^4=s~TuNv?st+VQoL_-ScZF(6_6ONaN-~V!-F$}pV
zkcb8^^4s9LKv3merM_TKvo513Ztz!WZ5Q9B(W48V_IkUIk|EC7Vm4^{FKj4Y*ohWs
z_?=5X!R?{rd`UfU7kV8pA)CV`jgJ;A9LYc-W+1(sJ4``~FY}1a;U}}SoSMkmheK?4
zQ(*5SM>;>ze2FJ|88o8a*x=im2C&`FZD$
zo1tx38sO*SGqySO|8fX=dY%Hi3BYJGIQ!I!VojVe+F`X|gVZ;YYyHwT_a}dh-PrX)%XGpyD?sc!f^9?2Sb<@4(ZW+zOehq*Q
z9f{mH%&UMejS7PP{bW@5^v^pymech&7cbZpv9Ra;{|2*TQye!44d{k7vPEL#eGpDu
zE<)MVq*&Gc!Jv(QAsI{~4?=OR>WkRQm>F93zK-+nxY6xGtV{VE4+?bXuKr%Uz?%6C
ziafg8G{Mytlw{W#)MOClI8mm<%^B=5fIV||SP;h%Rl#xLA8NV0#}HU*uiE^7B}bj38ochjYV4fY;b()bH!ublCl1@JcJ;QesRDj=7e60ly@(bndkJzWjIvmd|M`QcyX^%vFzW32Xdhd%~%Xt&MqGu#qY*pe=
zCsCdz?CU^)Nu8f0qMdBf1STTcQ;nSQuox)q;;FUzXmfZ$
zF7j?|rq4hXEan@0%vnQvcoH)bK^|7>YeHl>*~j~eetmb|h*s}YyZhT4k&R6O2UU`g
zw^%1wQzZ0}gRWZmP}b6fC88h#N$tdjN>pO0jaqhNKgcYJsoW3kDSo+^{Yu+;-!q^H
zNoAliZXdYsu0O&?AQZ=c+`<1wH+hr}NZJ9;7~x|
zfu*H8@8|n7JXb=GGgC8+CGhdW{N|J-q0Ls2@N}|sb}7B0t7VJbu^M?#*6*PU@Ak&H
zb9AniN`fl4frE*;LkFqu&579pS0>wzpy2$@+VAj!)GOnT0=Jjq3@l*M3wr&}4YMGc
z@Gu#!!J99Q>NVe)+%7LmQOLIlCYD{FQ0u9^*b2H*%j42bKn3pcx&i`nQl@VT7~Qlv
zr|EzjnSiJ_Ls7qMs@%!!G$y~0%NO>9tGlnREKeC2GJC;cHUbSQwlRY~t~YitSm$t0
zrK#WfmgTa5PxRarlfsKkadcOh>FuA)B7k)HP{&VL)b06!wqe!?S1k{hvOmTF3vqS5
z_sS13zH_@Xisk^=uUm6iNz!~im1dne2*$>ANcQ9<^@vIw_B@lglZV8?-C$*D5xiIsCvQRH?
zLk_tmOx`y(@}OZ%&C2YSuwV!i(Bk)Oj2KsbVGB2()!{#BfH^z6k7(DM*$a@6$vRl;
zg`M!A&{>N__OxO-&IZRhlLkX_n~Lt_RN8o9eEd7tL&;P5V$VtBm93c6l~U;HPZHaz
z78vQHM>%Ic%N30ZuLgk}k4&lpJWi~|w^4rRaK4W6OB;)t(&Zeu#iT|_!FeH7QGz3>
z9mDAQl+x-W!2E?l(wawiRq*@K_0>D+Fau~Ye9lyw*YD$JBM5ZVk4+~rtC@tdeFzXy1*+A
z76c5Z0z)PXjy}%4%MF=}p#=rB1ml3Kh-7Ixl?R22n&E|$F!*u^;IZY>!qEc5RhYD<
zF(Q#+H&i42mWnIuBcY{9GS+|cO?a~FxF7%2aHlB|An8iVD}xfvBM3qWet8snQ=WQ+
z2(K0+hUw9%(#AY`u1_`#LK&@;@2*~FQh?l)olR|!kHGFjuP7)*w)Pe{Eytft@rToI
zNSA`F(d3K9z9u^1L=DQ63ZpDyI)nSeqN(;Vq~wRvtof`7$Ci?tFYNzrA7R=%7+Uhc
z^204@i+X=eNK!xfUfyU{m=c+nG*J_m(KNcSKn!@Ze6F@qmfJlb?H=&Ik8aq^%*?Y8
zm~m*21(7QaI+efH^(Nyz7j%mF)w4;UP+7cBw9CGeH-lz%Tg^%tbYKeyme{pf2mt=W
zmS^*#Qup>Zy@)Y?R_FxiB(7!bB{L-;!oE5E9QQw#$+QFEI=kk`U{Y)PD;F|qxNLyU
z^QQlsK7-}dW!R5x!;|X$7-oaPwD}7lIg68opZHM%3G3-i9%B}nhQp~LCiRw
zu{77pvtVM$zj?ndyh?UZ-|*5>9;7m}DV9f3H0eb0I^sh3P97wz;3Ex^2?h!b*E3BV
z$+F4o^>~*3|HduNRh_~};eV%Kq|1v71xzwjW*9|At^j^DSgd+tD(A41@Wvc3Y9J6O
za?X7GGQ9hv>2v-|69_c$ubdPZ6D5hH?(+#sd>{Yjqx1Tmz~Ine5GHz&V+>j|x1H=#
zldHazrQD?tPpX0pTz~sBMzealk4zdrPQ?~L=RY1Ss~+y|;GHaw%iRLVA5w~d~Rj{b{h3tCKGz6nmFa4d^2hic)VRqAH8HShqXzCylR=3@b_H;@$x-e(``~$ZW~_q9A(^I
zA^iG*D27^rh5T8%BsMQ)uFoCpML7A5!kYa;e0=Mdm#L5SbGML(6Oqe}DE8Eeold1`
zH*$0BDtY(U)N~=XeV*RMECIL7>o?k^H8JWng|5)^o)!8Mdg^*+ZGn+Cw^tP;WN#;=
z>iT7poh6ky08;``01hync1wUMmD2C{DezCP00
zkTtq&cNM9}ev})#LV4QH&-Sxbbf=6a5j}z3H%|-}rV~RD@uH_7{DPN>;CF+H6)1#h
zocVX+{7ZFmH=e{xVz({%MTMUYnv9$
zZR*z$PPHn19TsGNV<4--`<@dB@s4eLT}qEmLalZ5rQ~mVv%CEmOOcxrB
z>*Okn$)^2*CI0Dh4oB=+WYM3xg!IZE_5#KB95ZS~GnMh~qxLTbW`Nl=hq%04L0m0h
zKSV=TeF$fGqDRr-qWk%TU_&02HP5=n&r8Y30H9yJU-I8%2Ug)Z2hRrPs`i1CAm2Lu
z{-m$F=p#y{8~eA{L7L%Lydo8&&{1q>3?>MQopLkM)
zs=n8;G2)g7f@uMD8!%uKNX~FQIv)=Y4{_rC>>y$xLl~@^f1SPpP_3Hh|KPOuYFG)0
zrKa((=d;D)Z>wLI-tcLQE+h_6i`if(LLiraU_yT0uGQG&3J_e}NCx{)ET1=ezz~%{
z5E3-4<^d-#PQ6rn(P%2)#HmMM&O^Q|m4CBQ%zFG=MXH+Vg+;s1<=~Pn1W
z=hAe;siLv?=fGz#>MJ8+h&lzjQfREh;nRKGO$Po^W$WBv!_^1EF2Az?h(p&v_th>?
zP1HyEVaIWMtFc2mZ&$~LLddJ1-R}hbeuMo!utYIuy6I5oYZHs?zn(sBPE%e<6;R#_
z0I_{w4|mmXe)G+&i*&lN=>d7&%et~?pC2IF(~Ct@28#0b6tu`q)0jCkZ{vDe&3Q6v
zJ3E1O(>^|_xkf;>^t-6fIoSaqwYRr7wK(gdMX79Y(R+H4zfS)MJdyuBDtt+^IBy&m
zLJll_5HEbU!q}QLxwyxhurhkuG(Y7gv>UuF(EDoim^0X*6n5jSl~@POpCLS8Pzc`0
zK12GL;&beagV~@mRX0*?n-$0}x`|=9e3L%dn8`{=#tz+$9^fDKX(f_#3-;~7l?dr7
z7g*3AuttM#s)are5sS+0FmhsGeesayn4yv`7V_cuN+q#w0%N^1p0n^DTyx?B%RhDb
z$9dn=WY9BuwlWAF)M0I5yLuInMsd1TaC49&DEX`0Mw41uFJ@G(7ibYcc^{@nL+M+i
zhM`Kh6DXPzd@6>lCR`DQJ5+1u|NQS<5+`teN1Rn?7
zAmFD!v%x74)E65Yd;K!(SFwm;+zN&R1&_0(yWwO5{iXG>lEPFOfg4!BG*Mm?J$ZYov<&bp;~Vt@@S
ztC-X=j=`Lvy8jERy}jc5|3ScV8Llt|a|XIVQ+%%@)B&3PgAi=}J6ivUn<`w?o^_mN
zw}v`iLNf&7RRnkP!@
zO|IhxEGZ3kONv)|d#zm=>VAjPy)X-cSVVSN86d@|sfXZ&xB=afK)A8r_jaJ98VDkm
z2{8pTbQB}lAK%db8>UI-zl3DQu6Nr7Hxb+jyz7hy#z~KPe!^nx+X11>w{aD>i>8`L
zB3Y5%c)xLWgfs*RCbZ{*D~#d{+q&CIlMj
zFw~_4M(0zknWU&4fT&=&;N$SzUxAJjl50@}15B5}<$m#i4ag?lU8soNcKB-SyUZIz@e8YqT*#pi!
z06hTYx%mM7#kWU5g(1Kh0dCT4LC;2x+(c3mI{W)NnqG)O9PWs{^*-zo)riCyNN*(
z;$EX0v(PHMJvfUcP=Jbv#p2b@tZiVO4YU3T7oDrn(EXnmU@s1_Ua?;yQKitq!z5XR
z&JVY;4O2rZfgZQtdHdX73hSPSQ+D3qQmz0T?1lZi(vOKMp;eAWlWqM(VYx~==dWni
z1IeHnBke{L&9#0RJKrVJU-I(v18}cv4Upp>??;c3=28#}CwKQ*5wBKs!ACesfEL-iwxRt6xI-8}L4=W6n;wk?Z~n7rB99
zdrmY0Y1t3t2rLBd7qLC1%>HVzUb@WH(5HhFVhsVhSv!UGEE#mV_2jPF961wH6#O%P
zHM?(-x^HirZ{hy;-NywU!W$p8*Rx7o$gKv{m~=>c7s<=_5^1)Bd3SIc?bXjKTvX9m
zAC|iBbnmwv?n57`9U$eP0&`#SNGetAFIIJ^k;Z5Wz-zr&2=}E&b0mGaNPbAkyxgJ
z#b20cRU}Vl{Xx>1sk2S-41RzNP*HLF=1~w-NdymDMLQAL*j)xzip4cEgm8xrx-JVW
zTf(@t;8t=&`PwE@NNwM~FW|KNv2}pFt@^yk`?N4_lKW6FM1?326GNsq2kh?qTUA(_dl15*WBAAxs7~x{SuAGZ
zk|E3m@gN!A7^!|@u_~!IO#ew_fnWI0R<*e|QzGbl-GD75A|!N3kK8Z|*lwdy^JURI
zG-Q;Mw>~>_M1A)MU9bIJZ)BBcX{9>imham$5w&cCUC0c#r6x&M!n4i%nNJ3{gb_5TQ4ffdU0K@rMc|YKM;k
z0tl%<0bCo_QrdmzHSp`7)Bzk%QJ9i@zS3~rfASFa|JXEUd4|tXn#%jfVAN#l!L$R@
z+o61HBDjsQ&4yH6o{G*CUthj;>U+#6_u&O+X;U2l?7s``n=vKOCk>8CJvHtWvP9j~
zUJyBx?D-w@CXi4xKRmA?*VJArk9!kv#E{f;XQ|)=RxP3=d^dH@@}WdYQR*^mf{Xkb
zDD4J-LN9*3{M6G!__FsQyLWk8VqCJ>6432ZUhiIux`v7Y-AT^ei6**=4DQ^f`kYlZ
zU0!Da3EK^X37vX(sfvM>C}7+Qgc0WY?WfdY5abo%gk|7qY>1teoUA3k0^y@}|99;~
z7$Cpdm@E=l?cpnCP22?)BaVYJB$*Hrc$@t6G1&?iCSaV~dQ3M4n#1TIlp;qi!c_A{
zm;y61&OEFbr=D=gkkSj(_mheTg-_0^_K%&e-!9K(jiQah*F7LAk-*B~xP?{a&2Xl&
zI#6H?WVZl3gwn2we8Vz`%>}0Lcg334DepWZPu&CZkLcvOz@`VAa#3E9;m5(+Q~%}#*RdWpQTa4
z1bphIoUtTKjFrWblu;SRwL*?|+L+RQZc@2|=w`|+Y`BaqZ9b|e?ppoIi!&<4r~jxF
z7!@Lgnn(YM>4)fUIKg!^Nl3pa1ienVH`37ap+g3jhL9Q1E}j>Bh{*NHd~uphW1-hL
zy9SgI8<(VWtduXLjT6bg@oDtWnHeCKpEJqndnQBM0)06piHy#?PhN&`|L}&Ocwi_K
zcQ?f11=O~0LA$T>irVL1cTjR5HE?B$0KVdrkkJk(MfjO{XHTdIH&
zRA;Tll0v;hi{|dm(VAElC5~WOMoNfu^qt~SYB02
zFHCY&aIUB`m^S@KZF>DjZCaa1E{D;0?uwncX7y-gRMr?gk-m`Y4168*VeFi}udi|+
zSwuZ@`e5ZpAd!g^SCe^{9*5x=pB7oYE$Q}QyyRTnfsW3qF`e95a5Fa=R-KnZ(a+B#
zeeDJus9k5dw`FU^i7)9uI`#VUr6chtR{a-dBQ0g6uEU=Q)g*^Mg)L*pf5$caI<$#=
z6aO3yAB`_QGL`WISEr*QN~rwOK+bBU@k~c5`K+X#FJm8ZmY=)<7}%5Ua@cJ5?1CGh
zT(eD3`~Ns^TXeBILS?_U)$|{n%W0@&Tco)2d~5M4;&~=KL_chRS5{j+9DOHO3^en(
zU!eI&DdzK$h}ZYcg69euTc1m%ZDV$FlQs5>n2VA26`~4;U~Q1Uj^e84Cn)_MDQ@
z%@dK8J6qnmP(xKg`~(9Vgig4&V{2{!@jbtT4Bcqb86OI@sjgnjxGc5|Nyeoi#29zJ@mV9c3DS6OR<<`^q
zx%XRH+D}vWLEV2I6s#}1!*hb2EnhBYbae&-Gv1)E?X+|F&VRCA0xF_JMV)uUj;iV)
z1~j`_-oJANyj)hX_et+b38dM5+M-grYFVy#ytWTDPl^&OMOL@}vU@AwqOJ_--7i)}
zB7zY2X!~?2w%(|p7mQj{x}j0`?)Pp#lA20Q8zBZ-f}y_}rUzZB$)kcQ9n*Yc!j1AB
z!P+Txe}kXhAnkkEd+K$`PiP<8Rtz<>-q5gl>)R|D(56Ob;jn4_LVuo7O6dMQ#
z53fLhjd_<^RxwY=u_|3_?sQ4q)yL1@!z?wTC#{liu&sQ;KGmev4d$!iP6!!$?|}vK
z1@g
ze98PMXF84Ka8mdVdL~|WBQ{nJqRwTyeC!H!u&bW>Hv1s{7%<@OEf7ap5L1-6EtmAF
z6)KE6=UGeU=CqCF%xKtdSDa}x2Q5irzp<2XoD~JJsbGB)qM+8{6ww7%xb>Ib0@gFY
zoC~NY%dNf{PWnM8Ws~K@WE*C&0Zu&OT8x)|ad!n;BG`spC+Uwjgp{cNZV0a;6a6ZQ
zrig<$sV_O-6B&@h#R*G5B-Ka`LAUPolIYA(Fnh(O?}6;2t*`
zJA@4JJif$LR0Nbi*$NLp9c_A(S{0Q{)Wz;|0mKtnq1Mw4*9~BzJ=fV+dR>_7LQay$
zB=bjk_*=z%n%tuWsvP)fdK)WktcoUSK;ODrGI~F({~0K^L~0W*|CHef)z{%_Id)1}
zMyTL!;^Dqws}SK)nc7@F6*g_{%gLx-&v!%2GgqFfw>Vy`r}FIvG09t2E3GfzDvJl!o_bj
zu4j{);DP<{)?lSrf+6bfvKPjjBICd}lIoQvPs%mD;(l|zE#3n|DM9xcPg8I=N7DAS
z9R*8v@9!WttbKAkdY(iy;k&`m8$wA@p)x0Eh%E-tJiU==$wl(i(cNp1bk5%KZjr*_
zXm$JOz2WJ=y^w1WE}iRazzb5+r-6oOqU?|@K2qf
z|DQVXvXI>|SxHYZq~vz%=1+LA5^R#-s31v|rBEt^(Ue7}+(0%L?BJ;|fRC0iv7YE%g%
z_^Iv%E&ylVx70*#0GK;zEB^^}Qdix7D@aKFdSz%YY20K%9bJ>q4T{K0Cl&iqlW?j%
zP(K>{6&-!ZY3aPXu1f#M_GrroA~^(VhPSU!b|XI9(nrlh=mU@FMqRhQ&tLq7h{>Z|augGgZ$sAv6uKvBwA)IOGd{H8ihbGzj&b+;9G9j`)
zLG|}uy!p(ALU#TI`Uei^+Z=WVWfleK<)0({?I=(GP><(RpI&P*@C(A`{V0Dbqe%0}
ziV`W;P%}ADP^KK#XKZ}*Lhp+Ug4btEQ&3OY$i4VYEOuGW;`h44&3I|#x(nN>Jz~vR^S|bV!VVs!K{fN@a`;uEF*zRytj+>ZeXdEiiKHuH$RsJO~Msa7_9r=!TEHS
z^?p3(ju^0V;?^$!_g`Ej8RiaMZU0cppdFAX2$Zi0FF?^
z4-`|oO2~c|#|rTxeS>rDV422DOVgs&FjM+uZ!f4PDVR-3x#tb~)1AP>*q$j**&TkY
z?IA&4uU?bZ+&%ux7LL44R<^`O#}Qg6!Z5e9f<;dZmkFQNciKGAH&{GeOee>C;lHnNd{v~$Y&}kc|bwTF!L{d0B?2UGKz+dAwYW(6Pv=Gh+BwO4(
zH6$63wU?Ykp4)ZvpD1e`*W329QOE?ycVG1M@Yydur{BZ~UGH&H48&m++MhcIvF^M|
z7vAQP7Ds7bYBReAyU}U)o-Sn#U^v|M2OY7VitTu4CxdtLxaA@vO)MdcF?o$X_ve}{
za<48HUN@CBh^?-)Do`_2Zlsa1h;nJ_;un~_oWbL^)+VEH@p2CJty5%7ud?R#@d?M1
zoNFSZAe(g6_lGHlxa{<*_j-k0#8y=g$vA|iULb|72FG|430fH=APHmtR3+*0sv18#y#9P;1)StkCG>#mGuHmnlyy)CFiY~L=NOsHN*yP}63_*0w5!(5hIIaE(}x#IeTY(G
zlGp$BlRs5^{0$&i#GP`g(1ozgr^_+8iIzrD1%yj1q2Ln=fvaK`$4)`}Iow%}%82b_
z&I#S03X&z~q&FfLUO8dt0-QH)#GqF*6X=HZ0hi1mh`Bln>Zoe@(W=%ML8Afd^1&Fq
zc>t+^WrzPpDDS!Zq5aOBib*4E=<|44gyFS|WH)91-Ho$uy;7$9O05mabnf@;i$|yD|Ee~(t^Au$c(pz_OvwI%4@+LNQieZenunS-B0kF2=*m2M
ziC6qYg6^xhaz9OavXalM-^=cECl_7byu$8{oqhGpvvw7;eu~WQzxvK4Ki9B3KV8tG
zuhyWr?(>~`o=|5t#YM)dpxuBOV_gdycw(|AJ|*ta7|e(#Xs*7#85}_{(DIF8(zg4C
zvysWuv1VfZHgU%N=`(Yn;hIkb^~`%sy+K4Ge?YTlMih0cPz-`Lk9&3${CADW#WB*3
z6+!{;+Z=Mu8X)O&ZY@0Iuc*KKnKZQdTJE~_GCizGa6P4^bw-#7iHrO&D0JmaT%e%=
zQkCOpeyBH1`Sy;_`EFc(XjPpJKPB7HkUBKk^b=lkuAMHh>JziaF&k&@}{yI#Ax$-A|hf^;(VW1>rEa%yO{}0V)lIgBy+qIOW
zR}Rw3fz0hz8IZ6>R(y)@E>lw`8}u4$WzaQ~1qyaO4h9Gog$&90d*3`OoIiU)r5((5
zOfs#!T~wtFiMAgll$r41=sMPDMQLiZ#haYM)#07e;Aye)ane0bs)}Y6w|F>ebj~SW$`MSlqe_jAUc5lrI
z?5j%MId(GZtNf{(xZ8s-Jy7r;%j)Mge54oM8mW+$?o4lPdeMD_z22I=;d#}WoK=k6
z`#?Ws^{JFTQ9XnSy=)+JWYn3mnw^6i&|Ph1MLx`g6z^{x$B|6FGeb(U$TMFVq=IoF-po
zB-tjCr`YTlcV5&9~
zEG}dE$b>@sdDDx)?@gXa_uQi~tL{HCRrxh0!zE73J_?ezshtC9oT_M5EP}#P+#?UN
z5!SaEA`IUIHWRq?`|518+*vKh;}Zr1wb~d==&e#2rZ~rz7k_S*YtFK9D$N%;0LkmU
zAeuxxTZN|L8IC(;je}^*vB6hw)MK2pm2rzj(27b6QB>)Lpcn)uB7c|C0y4yxIWb$d0t
z-L2z1IW`OdXMrPw7xTa0a+;m)sP~r{#|}yMP9N7!;FYl9v4{FE`M|xL*a^^PnuuO5
zV?iRu-Cp6!fkb(bU{Sa0GyHZhT@gdo70)`t;G-O_n&mWFigZ0PHUNN2sSWREGvWz`
zoZpF}Xn1|*mWtPK_PzO3GuIm4_;Hh&45BI2Zn(wo2&DiPwLG_-UvB)lcGyYL_!GHe
zJdUW_cRpCvz3g8(F
zPq-pBz=ejae#KBxqnp)nH11aVK=w*+^iwU(rHYcbu3Gymi+Wthgo4&Q9Z8f1l|6n-
zmTg}=L#llcm64%q*MeZOW&(PbAtf%dvaa)NrP%D|z3?p~O=8e$*aTs$n^s10TYzQO
zs3GHPGr>=wh)fSIyU_(7g&D59Lm9I}vNY(c8ZX5z0o0>&db>XAzPl+tDeWX8)9ZaX
z?y7I}+>hP!n-G!ho7D&5&As5^Sx^vCH81!!Ey7vc&yb3MoZk51|9O^@ejG>VQ`cs1qD=ug@H
zHec*p@hQcoIOhmhc85&XGWESI1-l}jb|&!qw33&y4APHCOjoItz_ww<^70N*3vPV=
zMaCw^qI1d6r>3JUGEiAt*=k%4lD3Om;M`x4&Qac+`jhrJXz~x&7n-wyW!}L_c2fA1
zc`BY0MwEH^bZ$S|oO*=-8#+v%Ih8mHg*sU6MPgUYcj_RT=^7LPkX$753s>~O7EGJG
zb(ewAGmvvxl0o}K4X>8WlwuS{N{ZjA-b0i`T-UDOmztX4VqVvUJ9a$A&{6QLi=a&_
zAzO~9)3V`h*C!^BJ?JWaV4_&7?rL@0EA`7{e7241lM|S6)?QRBqmMUOB&8qQM`Xe6
zD~gJG!LdU`Pn%P`>B`4Xvlk)bhhN`>Hgp+L#>{YO@(~(d_!)RTFcWCxlsvhqxas=Q
zFke(n9bpN3$Heq;$=f#O4Ov$9@$bukVjEF099|k;L4Nmz4Cq=1gyJ44D}brDbtWyA
zbOxA#4{=NF-nZMQ{uai`T(InB9dFULD)B3|RP|2s*eFl>^;F1Az=m-}t-`l`{rkhi
zha`6YE8UCk+w`k-)S|>rtJF8Tfm%E`rdzkK<^2UKKK6N)7mwe$GT<;3)xeA^`!X!U
zhxfET@u5nJDubADCvR}V2kIxR|Df$0rr__8;X$l7S)#V$uS}pOtuJ!Pei=9b;E*dG)`c;0<^5lVfSJVSu6jOd^I?~XoYOI1HAgvOS(OZ@@z(SunfXD^&ZYGF>
z{wmSra+fCBytn<5dHQ!E4p?$wo=
zOFZx28oz$&>+6Lc6n`ro`{*@Uey=0+N4c0VX4p(T#$xaXG1jjG`#PHmA=4Ag@0~dm
zM@VEx#9x!tlk~HcJBC=^(JZe!KEXmhx`TQ^spE}xY`oYJQwng02^2=84zDWaw9
z&Zg$~zKmO#6ETPJzcbKn`Wn|W9Br5p;IBe-Xze$?OP}TVL-z(I9cCD4&F9t`@6A+tJb
zjW}27iOv17=1DU(FRbZ%b1gCBv;TPkPC1wVrh_X$efDUHP$wV9Pm^Evf5q=_#q&g0
z@iBCw^Q$
z@0&&$h4`nv|CFChP|$qsKNwEq^qhaNKj-=2_0UR+x+@TVpFZuTuNF|D;o227;EGQP
zueX_B+JVhFP&L$vtyR`m3$l#HpPsrvCnj1w;1qyS`}UUI4_a6Sh;(IDX;6zG^3qwS
z%#aser0;AFp*u7F6Fzg2?J~G(B%Fv%)U#cR9SoWpE!G7tOlHlu8FGyJ(#9+96<;4e
zCkC_$RK)*29w2ecI+Ge!?=;jCL@DV=t)q?P7c$9g{|atnDUHG_;GQuF{8h>!2>Kq9MHY6}
zRfu@iL|Saba2~i)OZeWBO*<<`o2y;A
z!d+{ugkH?{o8APbu;afDMZ)vuUz_|_B~X@KJ7CW5-5Fz-vRjGo8l4gCx9&?$v=JX^
zKCa$QzpsM7`FoA6Z{VGR)X}Ux6V1-+VACG*Q#E8RLmW)dG(d!NCerqMWMf!MWE!w
z#xg}_R_n?1E4q{D$vp#BwB?H4StNUvFW@aDamggqFiu_Nr%2a!4*5JiHB8yPB0X
zdj>oY!|@t);-(V(K>m*oH8?Sx}01PETIt%
zMSQtbb?w^R-3?bZVcNc@EE5PFS@i2Uz|fKygxWNTPsY&$~DE
zefZEH;WL&!sZ&6$t%uLKre~e$q^2%iDTlGb!u0guW!_9W78YHBMPH?uk$!(n&+
z{dKpFeTHmf!K~dI$(yi3r$;8W-!#Q_%~Z^OVnE6!hl
z5@0_25Xq5J2`p_QZKir}rgg@upgrRC(|_4)j=TlUNIJbO9MUmRSF#
zFi)NUMbpl3xf6X>yf$S$6V6TZ+F;Zl4*=p$L%pjE9<=w+oml
z?{`|{B*KZG{FkTJY@SmMZ%q=qM2GGEB%kd^Pj9@5plig4F^>s2Pw1?9^I%Bw!d`&+
zNK3q1Uarv8EL2_B%x0atqvN>ZtfneB!T(<4Khx*gY2n?ovy|gL!qcys&a}X)MR$LD
zc&u&?!xNWvKK4XZ9zU0R!}$b>Pu8WydTqF^{SNl__cLkoI9HyB4K}YO$LPD
zE8H%X)fOh3?9?cv25d?~XC3`QbEr;A?_f`vQu~Qug*2s$a0(IF5Qj{mVIAjl#P_dR
ze@{(8CHo%#kecmJQVdAJyGHQ#DeGxB*F0M|PuG%1mpnHoIcoXSj$6_abxNeP8Pqqm
z$5ovyG$h@t81VbP8Ou@s0th`M{L__Svup+OZ!T@BI)Ej;f3s~0o>$RIZPIqh(Y0z(
zWg09ZQ#EyGVLpF8jGW3*7EsTp!i@6?HSBVnjft+RfwaYCI
z0%)XrZ!s_<8$HXuU-o|~g=+N1C-wyL)K-gFYM+|qsJD~HYt-Oj8O}e&9{Ubo9ixNy
zdf(b!C%0asi|Rh~eHP2+rM6k~u%3D(V}vxf?rN|Hc>io(=E5=lDs?A~ONVRhy0!onQ#b>U^gjQ;-jwHM=hvujNR>++m>
zV!u8Mi&7~BB{C+3k31k!Tz1ftg<8M;-Bm5WAyy$Jt??V5A5Ztae`H|B)~Q)X&a)mh
zPBGcwwyrk&-571S>4#&8~L^iIiU*wfrK
zGPu6r56JpK*H=<*n(JLtpC)Ff1+0(sj(0$g_XT$B9PX*J^j^)U()O+%<9Ti`5)l0C
z35(^2LB+yl4mwGgdH9h#s0%SUz2%yaw*m>H~l;Peyy;h^1KLlir6n
zbHh~RPIk#!x)BPJf%5rm`WYld&aU45Gy&J}ByVR{udm7Z9Jx!phpo+1{!{HyAE*tAD;SznE_d)z5MalSFq`IY7p^7HGzFIAEFGxIW)t_Av{I>70)cnw&
zjqtHEe~%|WAhR8E@V$^n6^!VV&gF^oHqC@HuU~foG5cH&%cPL7-ga~v75t75x7{rR
z(So5~yP8k_ObAg}e>--1nk)y4>uI^qq1Yz%gtG7hNI$6tZJVjK0}pb~^3p~3gsL!e
zFqEfN9!cKQ!I|SYID#*`48kvWpmtyXpt2HLgcfaCf>BqqUoqv##D|3Ip@}50PUQU~
z(|4hBEALeSN&(aU=dHw=ZS}m0_h}SKC7^Z^9?TV?>Y;ZlCjeh;OusB&W}cm&%sgk!
zlAZSHil(c^{E*U%FOCalp(nu;8>du>s0(_bf>|LNw3Zffex*38wpt3r>}~h}=@5;D
z*Q#-8TPkCU<`v?;DF6|L3K)I+j9PJm5LEGD2|r)hsdQn=C)MIfdGvQ%pF>qu(UPhRMQX)r{M6wac{?PvV)J$OKqG6i1wpDNIn+vbckb0OoX_H$oJuf0K>P18XYlG@f{9rmh-6H
z8F}ms>+0H%mKaM4Q{$Q48{JgsLRsC>LW)>X;-pi=DbJL>B#;D_<%=<|*jKy@Dx#C*
z)HHAa&9?m|6|~X8;xg9*Fs$;0niIRUU&Y9Tm5P#kIc7;Va53AY?BoxDl(OnBgLg+M
zPd`$~L!@LG*XT?*#WwG2dxq4k>QS!w`(|IVVvW8j;F$h9`koS9*msmQuvJaFf439o
z`0B8i*;+a_3Sz~w9m;RxiPGj^O4TrEdZ~Z?sC^pG_YKwvpU(4FI_>o8#^^(46|<`mi+A!>BpMaaWm9-W7h7s!u|H
z9Eyo_G)p-hCScb&kqw-fyhApYdYb;$ZS8qrwep-DKHlIl6c%x<15--EWQPH>9aDS}
zt!YJ(K%Fo*#qxPsUb>+(9y6Y}%S#
zqwlqCv!{hJdrj{-U7Ix;i5+6%2*ki4Db~I&j5-
zbnTZIv$-J8^7wx6>0PukboFG`zU9yuk4sV&+52*Yds0_b+Y`C%?R$5gI81Csq1SFr
zOyNOY$xQfnAq#DlikRpq2D-QygDUDyOD!;ikYnGJQ0&_y*-Ht3_Rv?Au(bHTdYWLs|QU0
z%=srXqU^em62Zo>p-ehU?hyi$t7F7Gk?&)7Mmb`yL#hLoyKz8qh8x>
zR^LGlhYyQ~p7vV|4PQZ(JTI{|-G9)NFPilk)}|o3ho_U_5Qe7Q@hXGu$oiETnaF17
z+ga;-=STzS3sse}hdaM4rJ!`0?$Qw3oH@G*d*=}au)<;Wo3`)qFK~^okD7{|+&Yl}N7xXKZ##|(LG;z?z@B`~?
zem5$QQO$CVdgRm4B2{|KDX#NoDo36q7Istyn(Ki<_O@G`8Z!7Vs@oXsc
zR64%^A4t#(k2`L&uIv_%-d5GZ1N%|aB>dqX!&mHsyx-hF*%aH3R>8i>L(8J#vMuH8
zblaV6o=n22H*ES-qaH@FN?T!F2hqV~Z1HK&y!7tNHIu@U;qNhSw@P8HkeZu>gi?$6#jYU9AUm_4KZk8$
z3VEC*8`T&7$xYt}U>%K*Bcx`lSD
z!4@mKtk4m^swi5!YH1@QXde8YmGv*mQGEPgXwDsK$DR)pHoleNT$M`$B+2F}tvA?n
z*K~$UHSa85M=yF$mKrrBB5z_K%3@shCih|
znWJQ(hKFEj(vo!Kv&Dze;47jHE1~|Zcy&E`B!feAJG5dr1h~APOy6f2Gl&-ib6!KE
zm>y3&^RI_M!ULX=F?wl+i63Fhs6jlRiW5v0nCbeEhgRQowk#vK{6S7*P3`dO{j6*f
zr7ZUe*D}K}qAGJ|Tb-1v_)+%LL!FV0{N*Ctdw=4DlWSPo(=8xSKHl%dj=G35R1F(t
z2>YF1pe$?gsGn4MKE^=+ph`KX{Gr&U1G^eBHrE0b7mZd8P?|4NoRGyVJ{A{+h5^iZ
zfE#Y-R}QLZXdY^3cQdT=k;vlLrOP1*1P78tuliRbS@YRTLX4<&(wb~8hxNuLJ9!;d
z0HBm1BW*E`zPbkPUrpHlzf|7~bymgL@r09r`j~bNO$)u+Bg8dpTL`TdQ8gNE(iUuVTR&4f|t7Q#dA
zQ(Wm6iWPOR()KZAs9(}Fe-?Zkg3lN7nb>-}C;92f0|Tu;^6Pet7oX`$n7io`@5`(^
z#?hUhQ?Rs}v>rk(bZq?T?UjGnoW1x+5QBAgxHQ%cDoBlZl1>@raWdff^V%Y8IcKi6
z7rG*v;s*;;lxUq`HH74gtsQF9V}Wf4#F|19vNIB-yZcr8ts(JKrPEcllGsHeAM@x{
ziX+dwfDo!V&mq=$Jcn_Alqmec9`@(9m#n;B)*8Qjz&wEu#F2kfLeZ~GkmO|6&
z^Y4If_zssD{m%E>IX6=yS&BTjRdJR*%2;AWp{x^
z23v3vZ>A3ayuK#kH7l{=^t6X-7(nQ}YTI_*$tMP_o_^*S_De4km
zG(6AiazwA7{g7rKn60bTTn0kX9wPQ22KCdzDP
zmI_m-z4|mik-UwLEC9Ec!B-#~9Rhb8=Zp$>wr#(NdF+^?Q$Zy-T&pd=I=Nv1i2xK(
z!ixu1zDbSlESnK|A<4scl90_fHr~U_O_@1nt{gAWXDY=Xt`o6rSW;qoslKmQ(|o)c
z9RE~{L@c=Tp`wczGZbmsi+*9V-TvW^a6#!yz8VmhJUTkkpDxpD{>nsGQ+x#fqv#i(
z%>1|Gud{Rtl$r5y3o3ix<`_I8ZGT=JS2$&8nh(iAQg{RL|C1DKO2j(g4JX6}z@jf@
zBUdjXrKTit~X(X*|*|Uh5zaf
z5+r#%glgU_5{UTJeAB_=-KXkF{!I>btJc_sNFm9Q7llGjZNB%jJ{2!#uYR2A{L2KR
zcf@*bM9pJbezC4{1(wC)7h^b+3sqU#S2CgbV2)dQM=A;PX6WS9VTWdd#mD5!ZAS
z1ZQAG{#b?J#B$?W*+^_BV3j6bVXx?X*jhlsiV@v!`jR5v&|2Ib(PBRQ#uWg{}B=UA=q<&9(QUGhE6ru4sy7y;$CvJA*g$U_zB)
zaiIrSb00i84_xIUP&AtXkRrAtQPn2myo4aXsB=uwSnwj!e07GP6(Uv-$8qqx;
zHwbV4>zlNNhkCtvt`)@4V|-Y0cKP0C+FgVgga*S%>wpF_<84+SWtN{2Ekq6ucMZnl
z{uVX#c{v49Ryg@2@qHQe{kOeAB@`@0LR}!IgA?V^}|2qt`+*dZmc~dG}5FPbLiq0Va@C{{eGSQ9d643Z|QGC
z(gsN3r+g%^M`l=6yOdEhs2`H%wX9pC!)ZWp3IrzLsaaz|$x+Hr$Xa*8QuWWeORLGu
zedP(F(W#f^DNBi=lK9oAOfQB9DC=brpD)anvWWwo+hVoM?bwcw4se{TBGq%fH?!Cn
zeJzv_4Qv1U!5yt-Ft#@K0h8y`FA&8+S1Ee@5=2U(%f&w@{_k&dbq#HZcjIS88ja{C
zNjoKj<$s#Kn)A`cdld01@tM^bKWo=DhaH}{U$V6$sxtBOh(gtYY3*OJ~f&Qw~3ON9In`045~p$K5qc#M{>b-5u`
zWgY4NfxAFtjufK92|Nx8%dL?Zv5hYM`2CQhq2Q=j
z#WOf_@G#lr3n`V4%I`vxk8?t7gPY@vS92oDA9yRM6{E8{Drn;*rZI>AT`^B+69UzqyZu#+gD_wYF>&FymXM!c4Vy3YQ$np#i#hdo
z6(pMUzrJ9n^runLW_%za&T|2=pgei@z6;dV*RPhm)U)HOjS5r4P2pYIuA9CI6$Tds
z8^?;FU+y+8p^0ywoMb(@5Bsu*6&2)Z`#z!enmqm0S}V^mC`~EaXrWC834s`f_k!22
zw|Du_MvT;;Fkrt-`SZz*`@LR`7;7^3_YzICuD5hB|CoNt
z1<_8gQvk}^{+>O~w#RDZlS*LvDgGh(Tm+1Z`=uE924*Fb#kk0|#=sMTnAS}u&7~45
zT4`D+9V67t$s$Pd3?rG#Vx^8uYtxATeW-WqmTQNxcvP+}9@RuUyFPGXhrE#5P*)kw-;#)=ADKYecgh;sNjM+ude
znMT(R0(v*whD)hgD^w!n(9OO7>8T&MA`#)MP{z$8h$MH^p8VI%G4B$vUbrXbb0$5$
zSl+5`Iq>oyEXi|j=sH*($AL6i#V;e5yq<%}B`hP=5mb?MhIB;W#2I#!+y@h0bXZjf1JFDP9qg
z!+&^%d4I7?!pssx-W9^&gs2KKAVN$LXvQfZI0*U9Va~^2coNIsL{+?4ee0iHY*eB}
zCw}}cUqnUyWDO;^%+Ez0C>6TxXCKS1wpwPd2y@-n{FOzQhah$d*MZhR?D(raVU=x7
zYh=P01>6tXC2G1^!x4w*yMKrL0r`JDuaCH{G~No(5ETq;5|~*87BXc?8BFw@4SE#V
z<2UP#FQ%f_emLin2$LOlx~&9t+{=P~cRAxjToCLr&dIt1g$IS6c-pDp2yNN4s*o6<~Xsfz6f51VPE|*-Z>p_%euDa}{~>CirT~dF^N&f;h0b
zYGk%>&3)EO92Gv4k`(jp%!J{9y{txr|4TAGZXbTUKg?o&fC0_wYv7J|<&lx8>W-Us
z7a$8`heg;4Q!0~4hHu{}Lr+=`1u;J*L%eAP1-7fLR36Wcbr{#Vr0r4`?bq&e4Z%9+
zunx$St>sJjRz$lW$M_|o^`YfI4boNZ;gNt(a0K%L#`d=SS-9IIJi)*Fuelcz(i=26)wxpplZ-Okx9`paY2q3z9n!y2>6`zi}
zVnlyusCzQw7O@!nPQ91qE(V2oNkK2DRQm$SP-d^Sx?-CzhRn=Q8_g_wPTXEwJ5)1|
z;Xpf^5E9=a&2qJ(2Fmry59GoJ9*I~0GPIQb5>Zz>q_9S;VYT+)j;hM&;LK`Xe!;)i
z9-uj@H$wf?A>-ummUXux421zc(~vQInURh<<559#
zBmReQ4|fi{a}lg`^L`ey%Z=`2<9ze-|Lx1Zx4Q3EmxhQv$?u_rnV(K7fzwKRM7bt-
zGN)cIR9a0Nubin3Vb)(g?n9Ul-KO&`DN7EBaUfH0>@bCObp&|}MjU&VCFUqm?uAK^
zZe`vdk=>n^K_cbvcTZ;62}avEcH%vtt~T7W@_U3y`by4Nwh7b&L9g3L2q8=Oahr_f
z^{)g9>Y?tT^OSV|K*!2Xe)Kk-6l~;Jyfqy?TW2`0ho(G4x>-wYdmV*i%r!=0tb`S%
zSk)ci=B`iD@YMB8AzH*Pam=|HE14qe>uVp=x_4B?HFle3D-K7b1pca8(-B_12wjXc
z#e32e9~udv0DN5)(TT7u^CkWls}BDMGWkU5%8~fI-sgTFv(>KtMlPn_ZBX=vA@3mY
zGItu@FsN2&{fCRdjR^=6(*TAn0>zHEgzpfKh36r;wU4eHlma`xT?U
zzFZDtv6+pubTSoSE}Sa=lb9;M{QZmWw_2nn-q<-!DY0|5xGMjk3T(+@}WZWD;ovheg+M
z=~$SQj!|gtWe=&=$&KX55By>fxxTy}fL#26G>H;Qj8pRl{*XkdgqDznVPq&>#fF8)
z3ncb{okogLgu!89@;ypEgh;A5_Kf&p7*Rw!mPziVcZ5E!r~MBmk{|P=F`yK8n1sh~
zE#&*`Olfa*9oLeoimkG;3Ll?<33s*&q)!a#^ZhethY(Kok}-3*t~eB;mrOd_NH#9j
z9D1Rza=aY^D3Q&8U)qRh?j|XYjh?+<`&y*dT~3zF-B)q&JbEUn-1oa<03|zjh
zf12LEjz%$=A0q7N$4(hm>r7fT50~4yt^x~}>|rJK>rgSRQAw66eFh(<+f?dDNp1$bJJ0lt2Hdj>Y!@!Yp|``6Zd&!h=XP>5Q{ytGecr;w=U=2Ut{G=x$y6y`KFhU&PgnTB=I`fQa{@;
z!0;#YF%zM^f-LpUq>c*Stf@>T>J;E0p2AMF3Ats9bj+HvQ*<-L%U?%
zm9zY8Zx;==cbYFOSM{!@z(Xg+IISvzt+V)Y3wGJ7jjlPq9FL4ah{9JpzKIN-MLsP*
z9GgR5Y(%SXEvmAExJ!6F_I(t7K34e&J`#q=d`%p>Q76Ms@#VN#7sCt5a9=!cf!?6O1m2hVW2T<5Ndgq5JM!BWn+Gi~b6WZ7-GuGT^N
zNH-_{S|H>}_%_#D6%CWasz}MwlB_mO%QlId3i>br7^z=HtkyNS@(!7q!Ts1diYUB!
zB+l#truvHuQbWG%7V64q=r!E4b3r}SWCJaZuRi~<3+Z89JUuPIFz#TmPSC!s)ajR&
zW{DrXlnjz~jOS%0>dUm~Yh_gKd1C;@1CEC9GMmSfeN0Jy_px4tzK@NOy1G0SG%pRi
zpqLpR7TmZwxwu63fs^Bujw;>?tFIGzjgR%S
zGSQ$7mdR|4{3qbZjL(kjlvWe>nrFrer+WgHQqsl
z%{I=B;QbQ-OP%4>?IMSEHDIHU?Y_c7A78(>gi$$h3R7^@Uu)>9Vor8>a4TfQI-(DK
zaJSnMO`y8n7cJokH(_`Fdr@+~UTI%Lq_Ny#!UJ2j1&oqC>>6r5No1=~XA8-*o8vlm
zDHf6K@6T$LYU9>%OIhEAis>1miwd08DlvltLoKn1^A`Nn;%h*NGjFR$;(%uq?{Vknm?BX+sdb<|H-Y>q
zIUhNhzD?X{&y*(W;ij%JLw0jK6cJE`Q)`QhD`U}-+mKa**bPs_D(;#>=PI9_i-a)?;%Iz-+
z+W5ts$;lt9iY3eqFK-|6-L9T6`#V077-3QtDBz4HC)T9K4(o?J@&ae%HS}>F9*7)X
zUJwp<+pUfG)|0UtWr-46mrhzOfMI92`dcD2^p>tGbLuL#Q=pB1^xWR(>fYVi&k4M}
zo(Tg3A-Ui9tuW!6tStDOPS*lJozZ^l)U`$O6iGkWVufg9WFwLSwF2qkc4;l6d*4{V
zI04{wa71swE6L;C4R~zLNmaYBw$P?yC6S_WXBbcBbeWd3RCwF#JyM1yVCw3YOlJON
z;UKXp>-zBX$R82GgQKI2B1Sd*wV9$%HQLrBs+$@m^^$-5iALGB$h^cO_neKEA|*SU
z*?y2h_t>D9&aN4!$lbjM9^PHOlYA61Aqxa8GKhJ|?gJ557BTFYAOu`p1vO1xvqnpW
zO`FvuFY<0`>7WYh$#MX>|I0yl!J&1_Sr1uUB>Dgf8Cz8`4x8}rR6yfrkKfS2rt64d6+?$iy*Jpd$ehNX4|Ip
zBfK>c4LxKgql7_ClmEbb5MF))T1~zO7
zpo_IQp^t6k-P@J)stHk{R7iCAVBTU#tVi{CRPDbgM0|fk+_I!=k%7haOse1YJFLNG
z=@HFTPH58Y3(?HCOXU2r9_3{8)<
z+|`LoCPIaqw@2a)At#CWEu&H=G!jmF-P*my%x)-NU#AoaS&X(idN0{b_;pkTa)PEH
zo{{C{D`OUE*RWx*=d{SyE%?sEg7bjx(r5$A2^9kP!`@X_Z}Wx)Gda1LeSAz
zoB0&iRJd@%ngI-OqF?}#p&4GHJ1t`FlpW7+pH=0}lFIdsU!LCC-~)3X7NdHOPY+^Go*jo!ig2aA`J+2M^T;z6BQBVW7$2YWE~qXBnrf
ztD__pg)OVh;fgNOfF{4%q$xLAtmIqxHu~&9$#41)uCyZB3~iTS5skF(T>G0>d?Pm!
zmRggeuNmLDq>5+gm1A$MP46JG>wiRqyuaQNfBnnc_^%|7Wg316$>u*uRo6vIZYqi>2pyln77ZSdN6?4t%kF^oGX{b)C@KzoYPNF`ZUFp2OkLtLO$y5^(
z39M