47 Commits
Author SHA1 Message Date
lili 0d56521602 add prefix info to readme 2023-01-18 17:08:56 +01:00
lili a5b38865eb promote beta build to full release 2023-01-18 16:44:36 +01:00
lili fd66271a4c more readme updates 2023-01-18 14:30:16 +01:00
lili af66b9f839 more readme updates 2023-01-18 14:27:27 +01:00
lili 2f13ffabe9 readme: more domain changes to .example, wording 2023-01-18 10:57:05 +01:00
lili 2d0976f441 readme update: change example domain to .example 2023-01-18 10:54:23 +01:00
lili c6542515aa readme update: add more about categories 2023-01-18 10:53:35 +01:00
lili ddaa111c84 promote build to beta 1
all features are about done, let's goooooooooooooooooooo
2023-01-16 13:31:52 +01:00
lili c047ec94ac add auto-refresh to dashboard + fix bug
selected "tab"/"button" is now properly highlighted
dashboard refreshes every 30 seconds
2023-01-16 13:30:43 +01:00
lili 0c678d8988 add a safeguard for empty list categories redeems
remove warnings in readme about it as well
2023-01-16 13:30:15 +01:00
lili dc68887c82 change redeem categories to list format 2023-01-13 18:51:44 +01:00
lili 02bf3223c4 draft of updated readme
currently it says that categories are a list but they are not.
i hope to make them a list before release lol
2023-01-13 15:12:56 +01:00
lili f3d088d6fb change types to categories
to avoid confusion with actual types of redeems like list
2023-01-13 12:57:43 +01:00
lili ae792192e8 add a category example to default redeems 2023-01-13 11:04:30 +01:00
lili ef2f6910e6 add a refresh+clear command 2023-01-13 11:04:01 +01:00
lili 625d37209c promote build to alpha 2 2023-01-12 14:40:19 +01:00
lili 10c4f6f514 split long line 2023-01-12 14:40:05 +01:00
lili 27812b9480 add first implementation of redeem categories 2023-01-12 14:23:32 +01:00
lili 2138650f91 reorganize helpers file 2023-01-12 13:20:28 +01:00
lili d3763d51c3 fix regex to be non-greedy 2023-01-11 10:25:48 +01:00
lili 05f28b71bd promote develop build to 1.1.0a1
very early alpha, still missing 2 things from the checklist
2023-01-10 12:23:59 +01:00
lili 6283a8f948 split long line in db.py 2023-01-09 15:21:20 +01:00
lili 537fa01aef split long lines in redeems_handler.py 2023-01-09 15:17:45 +01:00
lili 25589ff69e add emoji html junk removing function
emoji in redeem notes now show up as their shortcodes
2023-01-09 15:08:33 +01:00
lili 85c4df9250 add an error message to points read too 2023-01-05 14:32:53 +01:00
lili 543dc3e5b9 change logger logs to f-strings
I read on a webpage the way it used to be would work
but the webpage lied and I got not all arguments converted error
2023-01-05 14:26:18 +01:00
lili b666211142 better handling of errors in redeems situations
short circuit execution that doesnt take away points + better message
2023-01-05 11:27:10 +01:00
lili c978b27799 remove unnecessary import 2023-01-05 11:01:54 +01:00
lili efd773e2e8 fix typo that broke check_counter_exists 2023-01-04 13:53:46 +01:00
lili 7625d9b959 check if counter exists before incrementing
nonexistant counter prints warning + recommends running refresh-counters
2023-01-04 13:22:47 +01:00
lili f1dfb79f2c remove prefix comment 2023-01-04 12:41:12 +01:00
lili 6a3e74cdec add prefix sanity check to init
tlapbot will throw runtime error if prefix isn't a single character
longer prefixes would break the bot bc of how redeems_handler.py works
2023-01-04 12:38:58 +01:00
lili 92a2a77c80 add customized prefix to dashboard 2023-01-04 12:37:56 +01:00
lili 3caaed4b35 add customizable prefix 2023-01-04 12:37:45 +01:00
lili a5463c09ee simplify dashboard file
removed redundant assignments to variables
2023-01-04 12:30:38 +01:00
lili 3282072b42 split long line
was over 100 characters
2023-01-03 13:38:15 +01:00
lili b34524334c rewrite error message
make it clear that read_all_users_with_username reads multiple values
2023-01-03 13:34:06 +01:00
lili 8e461c5076 remove redundant list conversion
unique_users is only used to iterate over and set is an iterable
so i do not need to convert it to list
2023-01-03 13:32:07 +01:00
lili e65ffae8ce promote 1.0.1alpha to 1.0.1 2022-12-07 11:14:33 +01:00
lili c6d94f9d5f version 1.0.1alpha for my next stream 2022-12-05 16:06:39 +01:00
lili bafa1eca16 fix behavior with 2 commands + new user crashes
issue #5
crash i discovered when testing (users joining when bot is resetting)
2022-12-05 11:36:25 +01:00
Lili (Lin) Pavelů 9c0e709c63 Merge pull request #8 from trwnh/patch-3
Fix: Change POST to GET for certain API calls
2022-12-05 11:23:12 +01:00
Lili (Lin) Pavelů 99bdcc16cc Merge pull request #7 from trwnh/patch-2
Fix: Remove strict "is True" check
2022-12-05 11:22:58 +01:00
Lili (Lin) Pavelů 89c9d5945a Merge pull request #6 from trwnh/patch-1
Refactor: reduce nesting
2022-12-05 11:22:45 +01:00
trwnh 65b68f886e Fix: Change POST to GET for certain API calls
I'm not sure why Owncast responds to a POST when it should be a GET, but this is probably not reliable behaviour
2022-11-30 11:29:00 -06:00
trwnh fe57550de2 Fix: Remove strict "is True" check
`is True` checks that the value points to the same memory. To check for truthiness, use `== True` or simply `if condition`
2022-11-30 11:00:30 -06:00
trwnh 420d954568 Refactor: reduce nesting
We can reduce cyclomatic complexity (how far we indented) by checking for a negative condition and exiting early, instead of checking for a positive condition and continuing
2022-11-30 10:45:52 -06:00
12 changed files with 213 additions and 105 deletions
+37 -13
View File
@@ -23,9 +23,18 @@ Tlapbot has these basic commands:
- `!points` shows a chatter how many points they have.
- `!name_update` is a special debug command, to be used with the user's name displays wrong in the redeem dashboard. Normally, it shouldn't have to be used at all, as display names get updated automatically when the bot is running.
(If you change the default prefix of `!` to something else, these commands will
use the new prefix instead.)
Tlapbot also automatically adds a command for each redeem in the redeems file.
### Tlapbot redeems types
Tlapbot currently supports three different redeem types.
Tlapbot currently supports three different redeem types. Each type of a redeem
works slightly differently, and displays differently on the redeems dashboard.
Redeems can also optionally be sorted into "categories" that can be turned on
or off in the config file. This means that the redeems file can list redeems
for different types of streams, and you can turn them on or off. Examples on how
to do that are listed later in the config file examples.
#### List
List redeems are basic redeems, most similar to the ones on Twitch.
@@ -125,7 +134,7 @@ it will work because the ngrok connection is https.
**External Action config example:**
```
URL: MyTlapbotServer.com/dashboard
URL: MyTlapbotServer.example/dashboard
Action Title: Redeems Dashboard
```
#### Note about https and reverse proxying
@@ -136,14 +145,14 @@ The Owncast documentation about SSL and Reverse proxying is here: https://owncas
If your followed the [Owncast recommendation to use Caddy](https://owncast.online/docs/sslproxies/caddy/) you'd only need to include this in your caddyfile to make the tlapbot dashboard work:
```
MyTlapbotServer.com {
MyTlapbotServer.example {
reverse_proxy localhost:8000
}
```
then MyTlapbotServer.com/owncastWebhook is the URL for webhooks,
and MyTlapbotServer.com/dashboard is the URL for the dashboard.
then MyTlapbotServer.example/owncastWebhook is the URL for webhooks,
and MyTlapbotServer.example/dashboard is the URL for the dashboard.
(And, obviously, you'd need to own the MyTlapbotServer.com domain, and have an A record pointing to your server's IP address.)
(And, obviously, you'd need to own the MyTlapbotServer.example domain, and have an A record pointing to your server's IP address.)
## Running the bot
### Running in debug:
Set the FLASK_APP variable:
@@ -190,7 +199,7 @@ get given points by each worker. (So running the app with `-w 4` means users get
I'd like to fix this shortcoming of tlapbot at some point in the future (so that it can take advantage of extra workers), but for now it's broken like this.
## CLI commands: updating config + redeems
## CLI commands: Updating redeems, clearing the queue
Tlapbot comes with a few Click CLI commands. The commands let you clear out counters and the redeems dashboard.
#### init-db
@@ -212,7 +221,14 @@ You should run this command every time you've added or removed counters from `re
```bash
python -m flask refresh-counters
```
This command only changes counters, so if you want to clear the queue with list and note redeems too, you should run `clear-queue` after it.
This command only changes counters, so if you want to clear the queue with list and note redeems too, you should run `clear-queue` after it, or run `clear-refresh` to do both actions together.
#### clear-refresh
Does the same as `clear-queue` and `refresh-counters` together.
```bash
python -m flask clear-refresh
```
Run this if you're adding/removing counters, want to reset them to zero and want to clear all redeems as well.
## Configuration files
### config.py
Values you can include in `config.py` to change how the bot behaves.
@@ -222,7 +238,7 @@ Values you can include in `config.py` to change how the bot behaves.
Including these values is mandatory if you want tlapbot to work.
- `SECRET_KEY` is your secret key. Get one from running `python -c 'import secrets; print(secrets.token_hex())'`
- `OWNCAST_ACCESS_TOKEN` is the owncast access token that owncast will use to get list of users in chat. Generate one in your owncast instance.
- `OWNCAST_INSTANCE_URL` is the full URL of your owncast instance, like `"http://MyTlapbotServer.com"`
- `OWNCAST_INSTANCE_URL` is the full URL of your owncast instance, like `"http://MyTlapbotServer.example"`
#### Optional
Including these values will overwrite their defaults from `/tlapbot/default_config.py`.
- `POINTS_CYCLE_TIME` decides how often channel points are given to users in chat,
@@ -231,32 +247,40 @@ in seconds.
- `LIST_REDEEMS` if `True`, all redeems will be listed after the `!help` command in chat.
This makes the !help output quite long, so it's `False` by default.
- `GUNICORN` if `True`, sets logging to use gunicorn's logger. Only set this to True if you're using Gunicorn to run tlapbot.
- `ACTIVE_CATEGORIES` can be an empty list `[]`, or a list of strings of activated categories (i.e. `["chatting", "singing"]`). Redeems with a category included in the list will be active, redeems from other categories will not be active. Redeems with no category are always active.
- `PREFIX` is a *single character string* that decides what character gets used as a prefix for tlapbot commands. (i.e. you can use `?` instead of `!`). Symbols are recommended. Prefix cannot be longer than one character.
#### Example config:
An example to show what your config like could look like
```python
SECRET_KEY= # string with secret key would be here.
OWNCAST_ACCESS_TOKEN="5AT0gbe9ZuzDunsBG0rcwfalQNTi3fvV70NPvvQHk3I="
OWNCAST_INSTANCE_URL="http://MyTlapbotServer.com"
OWNCAST_INSTANCE_URL="http://MyTlapbotServer.example"
POINTS_CYCLE_TIME=300
LIST_REDEEMS=True
ACTIVE_CATEGORIES=["gaming"]
```
### redeems.py
`redeems.py` is a file where you define all your custom redeems. Tlapbot will work without it, but it will load a few default, generic redeems from `tlapbot/default_redeems.py`.
(`redeems.py` should be in the instance folder: `/instance/redeems.py` for folder install.)
#### Default `redeems.py`:
#### `default_redeems.py`:
```python
REDEEMS={
"hydrate": {"price": 60, "type": "list"},
"lurk": {"price": 1, "type": "counter", "info": "Let us know you're going to lurk."},
"react": {"price": 200, "type": "note", "info": "Attach link to a video for me to react to."},
"request": {"price": 100, "type": "note", "info": "Request a level, gamemode, skin, etc."}
"request": {"price": 100, "type": "note", "info": "Request a level, gamemode, skin, etc."},
"inactive": {"price": 100, "type": "note", "info": "Example redeem that is inactive by default", "category": ["inactive"]}
}
```
#### File format
`redeems.py` is a config file with just a `REDEEMS` key, that assigns a dictionary of redeems to it.
Each dictionary entry is a redeem, and the dictionary keys are strings that decides the chat command for the redeem. The value is another dictionary that needs to have entries for `"price"`, `"type"` and optionally `"info"`.
Each dictionary entry is a redeem, and the dictionary keys are strings that decides the chat command for the redeem. The value is another dictionary that needs to have entries for `"price"`, `"type"` and optionally `"info"` and `"category"`.
- `"price"` value should be an integer that decides how many points the redeem will cost.
- `"type"` value should be either `"list"`, `"counter"` or `"note"`. This decided the redeem's type, and whether it will show up as a counter at the top of the dashboard or as an entry in the "recent redeems" chart.
- `"info"` value should be a string that describes what the command does. It's optional, but I recommend writing one for all `"list"` and `"note"` redeems (so that chatters know that they should write a note).
- `"category"` is an optional list of strings, the categories the redeem is in.
If a category from the list is in `ACTIVE_CATEGORIES` from `config.py`,
then the redeem will be active. It will not be active if none of the categories
are in `ACTIVE_CATEGORIES`. Redeems with no category are always active.
+1 -1
View File
@@ -2,7 +2,7 @@ from setuptools import find_packages, setup
setup(
name='tlapbot',
version='1.0.0',
version='1.1.0',
packages=find_packages(),
include_package_data=True,
install_requires=[
+13 -3
View File
@@ -3,8 +3,8 @@ import logging
from flask import Flask
from apscheduler.schedulers.background import BackgroundScheduler
from tlapbot.db import get_db
from tlapbot.owncast_helpers import is_stream_live, give_points_to_chat
from tlapbot.owncast_helpers import (is_stream_live, give_points_to_chat,
remove_inactive_redeems)
def create_app(test_config=None):
app = Flask(__name__, instance_relative_config=True)
@@ -24,13 +24,22 @@ def create_app(test_config=None):
app.config.from_object('tlapbot.default_redeems')
app.config.from_pyfile('config.py', silent=True)
app.config.from_pyfile('redeems.py', silent=True)
app.config.from_mapping(
REDEEMS=remove_inactive_redeems(app.config['REDEEMS'],
app.config['ACTIVE_CATEGORIES'])
)
# Make logging work for gunicorn-ran instances of tlapbot.
if app.config['GUNICORN'] is True:
if app.config['GUNICORN']:
gunicorn_logger = logging.getLogger('gunicorn.error')
app.logger.handlers = gunicorn_logger.handlers
app.logger.setLevel(gunicorn_logger.level)
# Check for wrong config that would break Tlapbot
if len(app.config['PREFIX']) != 1:
raise RuntimeError("Prefix is >1 character. "
"Change your config to set 1-character prefix.")
# prepare webhooks and redeem dashboard blueprints
from . import owncast_webhooks
from . import owncast_redeem_dashboard
@@ -42,6 +51,7 @@ def create_app(test_config=None):
db.init_app(app)
app.cli.add_command(db.clear_queue_command)
app.cli.add_command(db.refresh_counters_command)
app.cli.add_command(db.refresh_and_clear_command)
# scheduler job for giving points to users
def proxy_job():
+11 -1
View File
@@ -100,11 +100,21 @@ def clear_queue_command():
@click.command('refresh-counters')
@with_appcontext
def refresh_counters_command():
"""Refresh counters from current config file. (Remove old ones, add new ones.)"""
"""Refresh counters from current config file.
(Remove old ones, add new ones.)"""
refresh_counters()
click.echo('Counters refreshed.')
@click.command('clear-refresh')
@with_appcontext
def refresh_and_clear_command():
"""Refresh counters and clear queue."""
refresh_counters()
clear_redeem_queue()
click.echo('Counters refreshed and queue cleared.')
def init_app(app):
app.teardown_appcontext(close_db)
app.cli.add_command(init_db_command)
+2
View File
@@ -4,4 +4,6 @@ OWNCAST_INSTANCE_URL='http://localhost:8080'
POINTS_CYCLE_TIME=600
POINTS_AMOUNT_GIVEN=10
LIST_REDEEMS=False
ACTIVE_CATEGORIES=[]
GUNICORN=False
PREFIX='!'
+2 -1
View File
@@ -2,5 +2,6 @@ REDEEMS={
"hydrate": {"price": 60, "type": "list"},
"lurk": {"price": 1, "type": "counter", "info": "Let us know you're going to lurk."},
"react": {"price": 200, "type": "note", "info": "Attach link to a video for me to react to."},
"request": {"price": 100, "type": "note", "info": "Request a level, gamemode, skin, etc."}
"request": {"price": 100, "type": "note", "info": "Request a level, gamemode, skin, etc."},
"inactive": {"price": 100, "type": "note", "info": "Example redeem that is inactive by default", "category": ["inactive"]}
}
+72 -26
View File
@@ -1,20 +1,20 @@
from flask import current_app
import requests
from sqlite3 import Error
from re import sub
# # # requests stuff # # #
def is_stream_live():
url = current_app.config['OWNCAST_INSTANCE_URL'] + '/api/status'
r = requests.post(url)
r = requests.get(url)
return r.json()["online"]
def give_points_to_chat(db):
url = current_app.config['OWNCAST_INSTANCE_URL'] + '/api/integrations/clients'
headers = {"Authorization": "Bearer " + current_app.config['OWNCAST_ACCESS_TOKEN']}
r = requests.post(url, headers=headers)
unique_users = list(set(map(lambda user_object: user_object["user"]["id"], r.json())))
r = requests.get(url, headers=headers)
unique_users = set(map(lambda user_object: user_object["user"]["id"], r.json()))
for user_id in unique_users:
give_points_to_user(db,
user_id,
@@ -38,8 +38,8 @@ def read_users_points(db, user_id):
)
return cursor.fetchone()[0]
except Error as e:
current_app.logger.error("Error occured reading points:", e.args[0])
current_app.logger.error("To user:", user_id)
current_app.logger.error(f"Error occured reading points: {e.args[0]}")
current_app.logger.error(f"To user: {user_id}")
def read_all_users_with_username(db, username):
@@ -51,8 +51,8 @@ def read_all_users_with_username(db, username):
users = cursor.fetchall()
return users
except Error as e:
current_app.logger.error("Error occured reading points from username:", e.args[0])
current_app.logger.error("To user:", username)
current_app.logger.error(f"Error occured reading points by username: {e.args[0]}")
current_app.logger.error(f"To everyone with username: {username}")
def give_points_to_user(db, user_id, points):
@@ -63,8 +63,8 @@ def give_points_to_user(db, user_id, points):
)
db.commit()
except Error as e:
current_app.logger.error("Error occured giving points:", e.args[0])
current_app.logger.error("To user:", user_id, " amount of points:", points)
current_app.logger.error(f"Error occured giving points: {e.args[0]}")
current_app.logger.error(f"To user: {user_id} amount of points: {points}")
def use_points(db, user_id, points):
@@ -76,8 +76,8 @@ def use_points(db, user_id, points):
db.commit()
return True
except Error as e:
current_app.logger.error("Error occured using points:", e.args[0])
current_app.logger.error("From user:", user_id, " amount of points:", points)
current_app.logger.error(f"Error occured using points: {e.args[0]}")
current_app.logger.error(f"From user: {user_id} amount of points: {points}")
return False
@@ -91,8 +91,8 @@ def user_exists(db, user_id):
return False
return True
except Error as e:
current_app.logger.error("Error occured checking if user exists:", e.args[0])
current_app.logger.error("To user:", user_id)
current_app.logger.error(f"Error occured checking if user exists: {e.args[0]}")
current_app.logger.error(f"To user: {user_id}")
def add_user_to_database(db, user_id, display_name):
@@ -117,8 +117,8 @@ def add_user_to_database(db, user_id, display_name):
)
db.commit()
except Error as e:
current_app.logger.error("Error occured adding user to db:", e.args[0])
current_app.logger.error("To user:", user_id, display_name)
current_app.logger.error(f"Error occured adding user to db: {e.args[0]}")
current_app.logger.error(f"To user id: {user_id}, with display name: {display_name}")
def change_display_name(db, user_id, new_name):
@@ -129,20 +129,41 @@ def change_display_name(db, user_id, new_name):
)
db.commit()
except Error as e:
current_app.logger.error("Error occured changing display name:", e.args[0])
current_app.logger.error("To user:", user_id, new_name)
current_app.logger.error(f"Error occured changing display name: {e.args[0]}")
current_app.logger.error(f"To user id: {user_id}, with display name: {new_name}")
def check_counter_exists(db, counter_name):
try:
cursor = db.execute(
"SELECT count FROM counters WHERE name = ?",
(counter_name,)
)
counter = cursor.fetchone()
if counter is None:
current_app.logger.warning("Counter not found in database.")
current_app.logger.warning("Maybe you forgot to run the refresh-counters CLI command "
"after you added a new counter to the config?")
return False
return True
except Error as e:
current_app.logger.error(f"Error occured checking if counter exists: {e.args[0]}")
current_app.logger.error(f"For counter: {counter_name}")
def add_to_counter(db, counter_name):
if check_counter_exists(db, counter_name):
try:
cursor = db.execute(
"UPDATE counters SET count = count + 1 WHERE name = ?",
(counter_name,)
)
db.commit()
return True
except Error as e:
current_app.logger.error("Error occured adding to counter:", e.args[0])
current_app.logger.error("To counter:", counter_name)
current_app.logger.error(f"Error occured adding to counter: {e.args[0]}")
current_app.logger.error(f"To counter: {counter_name}")
return False
def add_to_redeem_queue(db, user_id, redeem_name, note=None):
@@ -152,9 +173,11 @@ def add_to_redeem_queue(db, user_id, redeem_name, note=None):
(redeem_name, user_id, note)
)
db.commit()
return True
except Error as e:
current_app.logger.error("Error occured adding to redeem queue:", e.args[0])
current_app.logger.error("To user:", user_id, " with redeem:", redeem_name, "with note:", note)
current_app.logger.error(f"Error occured adding to redeem queue: {e.args[0]}")
current_app.logger.error(f"To user: {user_id} with redeem: {redeem_name} with note: {note}")
return False
def all_counters(db):
@@ -164,7 +187,7 @@ def all_counters(db):
)
return cursor.fetchall()
except Error as e:
current_app.logger.error("Error occured selecting all counters:", e.args[0])
current_app.logger.error(f"Error occured selecting all counters: {e.args[0]}")
def pretty_redeem_queue(db):
@@ -177,7 +200,7 @@ def pretty_redeem_queue(db):
)
return cursor.fetchall()
except Error as e:
current_app.logger.error("Error occured selecting pretty redeem queue:", e.args[0])
current_app.logger.error(f"Error occured selecting pretty redeem queue: {e.args[0]}")
def whole_redeem_queue(db):
@@ -187,7 +210,7 @@ def whole_redeem_queue(db):
)
return cursor.fetchall()
except Error as e:
current_app.logger.error("Error occured selecting redeem queue:", e.args[0])
current_app.logger.error(f"Error occured selecting redeem queue: {e.args[0]}")
def remove_duplicate_usernames(db, user_id, username):
@@ -200,4 +223,27 @@ def remove_duplicate_usernames(db, user_id, username):
)
db.commit()
except Error as e:
current_app.logger.error("Error occured removing duplicate usernames:", e.args[0])
current_app.logger.error(f"Error occured removing duplicate usernames: {e.args[0]}")
# # # misc. stuff # # #
def remove_emoji(message):
return sub(
r'<img class="emoji" alt="(:.*?:)" title=":.*?:" src="/img/emoji/.*?">',
r'\1',
message
)
def is_redeem_active(redeem, active_categories):
if "category" in redeem[1] and redeem[1]["category"]:
for category in redeem[1]["category"]:
if category in active_categories:
return True
return False
return True
def remove_inactive_redeems(redeems, active_categories):
return dict(filter(lambda redeem: is_redeem_active(redeem, active_categories),
redeems.items()))
+4 -6
View File
@@ -10,9 +10,6 @@ bp = Blueprint('redeem_dashboard', __name__)
@bp.route('/dashboard', methods=['GET'])
def dashboard():
db = get_db()
queue = pretty_redeem_queue(db)
counters = all_counters(db)
redeems = current_app.config['REDEEMS']
username = request.args.get("username")
if username is not None:
users = read_all_users_with_username(db, username)
@@ -20,9 +17,10 @@ def dashboard():
users = []
utc_timezone = timezone.utc
return render_template('dashboard.html',
queue=queue,
counters=counters,
redeems=redeems,
queue=pretty_redeem_queue(db),
counters=all_counters(db),
redeems=current_app.config['REDEEMS'],
prefix=current_app.config['PREFIX'],
username=username,
users=users,
utc_timezone=utc_timezone)
+15 -11
View File
@@ -1,7 +1,7 @@
from flask import Flask, request, json, Blueprint, current_app
from tlapbot.db import get_db
from tlapbot.owncast_helpers import (add_user_to_database, change_display_name,
user_exists, send_chat, read_users_points, remove_duplicate_usernames)
send_chat, read_users_points, remove_duplicate_usernames)
from tlapbot.help_message import send_help
from tlapbot.redeems_handler import handle_redeem
@@ -13,11 +13,14 @@ bp = Blueprint('owncast_webhooks', __name__)
def owncast_webhook():
data = request.json
db = get_db()
if data["type"] == "USER_JOINED":
# Make sure user is in db before doing anything else.
if data["type"] in ["CHAT", "NAME_CHANGED", "USER_JOINED"]:
user_id = data["eventData"]["user"]["id"]
display_name = data["eventData"]["user"]["displayName"]
# CONSIDER: join points for joining stream
add_user_to_database(db, user_id, display_name)
if data["type"] == "USER_JOINED":
if data["eventData"]["user"]["authenticated"]:
remove_duplicate_usernames(db, user_id, display_name)
elif data["type"] == "NAME_CHANGE":
@@ -27,25 +30,26 @@ def owncast_webhook():
if data["eventData"]["user"]["authenticated"]:
remove_duplicate_usernames(db, user_id, new_name)
elif data["type"] == "CHAT":
prefix = current_app.config['PREFIX']
user_id = data["eventData"]["user"]["id"]
display_name = data["eventData"]["user"]["displayName"]
current_app.logger.debug(f'New chat message from {display_name}:')
current_app.logger.debug(f'{data["eventData"]["body"]}')
if "!help" in data["eventData"]["body"]:
if data["eventData"]["body"].startswith(f"{prefix}help"):
send_help()
elif "!points" in data["eventData"]["body"]:
if not user_exists(db, user_id):
add_user_to_database(db, user_id, display_name)
elif data["eventData"]["body"].startswith(f"{prefix}points"):
points = read_users_points(db, user_id)
message = f"{display_name}'s points: {points}"
send_chat(message)
elif "!name_update" in data["eventData"]["body"]:
if points is None:
send_chat("Error reading points.")
else:
send_chat(f"{display_name}'s points: {points}")
elif data["eventData"]["body"].startswith(f"{prefix}name_update"):
# Forces name update in case bot didn't catch the NAME_CHANGE
# event. Also removes saved usernames from users with same name
# if user is authenticated.
change_display_name(db, user_id, display_name)
if data["eventData"]["user"]["authenticated"]:
remove_duplicate_usernames(db, user_id, display_name)
elif data["eventData"]["body"].startswith("!"): # TODO: make prefix configurable
elif data["eventData"]["body"].startswith(prefix):
handle_redeem(data["eventData"]["body"], user_id)
return data
+30 -22
View File
@@ -1,7 +1,7 @@
from flask import current_app
from tlapbot.db import get_db
from tlapbot.owncast_helpers import (use_points, add_to_redeem_queue,
add_to_counter, read_users_points, send_chat)
add_to_counter, read_users_points, send_chat, remove_emoji)
def handle_redeem(message, user_id):
@@ -12,30 +12,38 @@ def handle_redeem(message, user_id):
else:
note = split_message[1]
if redeem in current_app.config['REDEEMS']:
if redeem not in current_app.config['REDEEMS']:
send_chat("Can't redeem, redeem not found.")
return
db = get_db()
price = current_app.config['REDEEMS'][redeem]["price"]
redeem_type = current_app.config['REDEEMS'][redeem]["type"]
points = read_users_points(db, user_id)
if points is not None and points >= price:
if redeem_type == "counter":
add_to_counter(db, redeem)
use_points(db, user_id, price)
send_chat(f"{redeem} redeemed for {price} points.")
elif redeem_type == "list":
add_to_redeem_queue(db, user_id, redeem)
use_points(db, user_id, price)
send_chat(f"{redeem} redeemed for {price} points.")
elif redeem_type == "note":
if note is not None:
add_to_redeem_queue(db, user_id, redeem, note)
use_points(db, user_id, price)
send_chat(f"{redeem} redeemed for {price} points.")
else:
send_chat(f"Cannot redeem {redeem}, no note included.")
else:
send_chat(f"{redeem} not redeemed because of an error.")
else:
if not points or points < price:
send_chat(f"Can't redeem {redeem}, you don't have enough points.")
return
if redeem_type == "counter":
if add_to_counter(db, redeem) and use_points(db, user_id, price):
send_chat(f"{redeem} redeemed for {price} points.")
else:
send_chat("Can't redeem, redeem not found.")
send_chat(f"Redeeming {redeem} failed.")
elif redeem_type == "list":
if (add_to_redeem_queue(db, user_id, redeem) and
use_points(db, user_id, price)):
send_chat(f"{redeem} redeemed for {price} points.")
else:
send_chat(f"Redeeming {redeem} failed.")
elif redeem_type == "note":
if not note:
send_chat(f"Cannot redeem {redeem}, no note included.")
return
if (add_to_redeem_queue(db, user_id, redeem, remove_emoji(note)) and
use_points(db, user_id, price)):
send_chat(f"{redeem} redeemed for {price} points.")
else:
send_chat(f"Redeeming {redeem} failed.")
else:
send_chat(f"{redeem} not redeemed, type of redeem not found.")
+5 -1
View File
@@ -15,5 +15,9 @@ function openTab(event, tabName) {
// Show the current tab, and add an "active" class to the button that opened the tab
document.getElementById(tabName).style.display = "block";
evt.currentTarget.className += " active";
event.currentTarget.className += " active";
}
function refreshPage() {
window.location.reload();
}
+6 -5
View File
@@ -97,7 +97,7 @@
</thead>
{% for redeem, redeem_info in redeems.items() %}
<tbody>
<td>!{{ redeem }}</td>
<td>{{ prefix }}{{ redeem }}</td>
<td>{{ redeem_info["price"] }}</td>
<td>{{ redeem_info["type"] }}</td>
{% if redeem_info["info"] %}
@@ -110,10 +110,11 @@
</body>
</div>
<script>
document.getElementById("defaultOpen").click();
setTimeout(refreshPage, 30 * 1000);
</script>
</div>
<script>
document.getElementById("defaultOpen").click();
</script>
</html>