promote to 1.2.1

milestone needs to be handled first

README.md

@@ -2,7 +2,7 @@
 Tlapbot is an [Owncast](https://owncast.online/) bot that adds channel points and
 channel point redeems to your Owncast page.
 
-This bot is currently in-development. The goal is to have an experience similar
+The goal is to have an experience similar
 to [Twitch channel points](https://help.twitch.tv/s/article/viewer-channel-point-guide) by making use of [Owncast webhooks](https://owncast.online/thirdparty/webhooks/) and 
 [External actions](https://owncast.online/thirdparty/actions/).
 ## Features
@@ -27,6 +27,31 @@ Tlapbot has these basic commands:
 use the new prefix instead.)
 
 Tlapbot also automatically adds a command for each redeem in the redeems file.
+### Passive mode
+Tlapbot can also be run in passive mode. In passive mode, no redeems will be available, and Tlapbot will not send any messages.
+
+However, it will still give points to viewers, and track username changes.
+
+The Tlapbot dashboard will display a passive mode disclaimer instead of redeems.
+
+### Tlapbot dashboard
+Tlapbot dashboard is a standalone page available at `/dashboard`, made to be easily viewable as an owncast external action. The Tlapbot dashboard shows all redeems and active counters.
+
+Counters are at the top, followed by a list of active milestones and their progress.
+
+Tlapbot dashboard also shows the chatter's points balance when they open it as an external action.
+
+![Tlapbot dashboard](https://ak.kawen.space/media/f9e29757f02996f363f25226f04a97ac711a95831bfaba9dcfd42158e78831c4.png)
+
+*Tlapbot dashboard when viewed as an external action.*
+#### Redeem queue tab
+The redeem queue shows a chronological list of note and list redeems with timestamps, the redeemer's username, and the note sent.
+![Redeem queue tab](https://ak.kawen.space/media/a1f44cc1a4011309a08361ca7f2ce24837d5daadd045910bf33fcd40b01d0a27.png)
+
+*Redeem queue tab.*
+#### Redeems help tab
+The dashboard also has a "Redeems help" tab. It shows an explanation of redeem types,
+and lists all active redeems, along with their price, type and description.
 ### Tlapbot redeems types
 Tlapbot currently supports three different redeem types. Each type of a redeem
 works slightly differently, and displays differently on the redeems dashboard.
@@ -52,19 +77,19 @@ Instead, the tlapbot dashboard keeps a number for each "counter", and each redee
 
 Counter redeems can be used to gauge interest, tally up votes, or to keep track of how many emotes should be added to an OBS scene.
 
-### Tlapbot dashboard
+#### Milestone
-Tlapbot dashboard is a standalone page available at `/dashboard`, made to be easily viewable as an owncast external action. The Tlapbot dashboard shows all redeems and active counters.
+Milestone redeems are long-term goals that are reset separately from other redeems.
+Viewers donate variable amounts of points that add up together to fulfill the milestone goal.
 
-Counters are at the top, followed by a chronological list of recent List and Note redeems.
+Each milestone has a goal, a number of points required to send, and the points from
+all users add together to progress and reach the goal.
 
-Tlapbot dashboard also shows the chatter's points balance when they open it as an external action.
+Milestones show as a progress bar on the dashboard.
+
+Milestone redeems can be used as long-term community challenges, to start streamer
+challenges, decide new games to play, etc.
 
-![Tlapbot dashboard](https://ak.kawen.space/media/67c1ac6ed0d2f4efb09937c1cbfe864102182e990796853507860f50db7ff5f5.png)
 
-*Tlapbot dashboard when viewed as an external action.*
-#### Redeems help tab
-The dashboard also has a "Redeems help" tab. It shows an explanation of redeem types,
-and lists all active redeems, along with their price, type and description.
 ## License & Contributions
 Tlapbot as it currently is does not come with a license. If you're a content creator, streamer, vtuber, etc. I'll be happy to give you permission to use Tlapbot, or make changes that'd fit your stream.
 
@@ -89,8 +114,8 @@ as a package in editable more.
     ```bash
     python -m flask init-db
     ```
-5. Create a `instance/config.py` file and fill it in as needed.
+5. Create an `instance/config.py` file and fill it in as needed.
-Default values are included in `tlapbot/default_config`, and values in
+Default values are included in `tlapbot/default_config.py`, and values in
 `config.py` overwrite them. (The database also lives in the instance folder
 by default.)
 
@@ -103,10 +128,13 @@ by default.)
 6. OPTIONAL: Create an `instance/redeems.py` file and add your custom redeems.  
   If you don't add a redeems file, the bot will initialize the default redeems from `tlapbot/default_redeems.py`.  
   More details on how to write the config and redeems files are written later in the readme.
+7. If you've added any new counters or milestones, run `refresh-counters` or `refresh-milestones` commands to initialize them into the database.
 
 This installation is fine both for just running Tlapbot as it is, but it also works as a dev setup if you want to make changes or contribute.
 
 Updating should be as easy as `git pull`ing the new version.
+Sometimes, if an update adds new database tables or columns, you will also need to
+rerun the `init-db` CLI command.
 ## Owncast  configuration
 In the Owncast web interface, navigate to the admin interface at `/admin`,
 and then go to Integrations.
@@ -205,7 +233,8 @@ Tlapbot comes with a few Click CLI commands. The commands let you clear out coun
 #### init-db
 The init-db command initializes the database.
 
-**This command should only be run when first installing tlapbot.**
+**This command should only be run when first installing tlapbot,
+or when updating to a tlapbot version that changed the database schema.**
 #### clear-queue
 The clear-queue command clears the redeem queue and resets all active counters to zero.
 You should run this command if you're about to start a new stream, and want to start with empty counters and queue.
@@ -229,11 +258,34 @@ Does the same as `clear-queue` and `refresh-counters` together.
 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.
+#### refresh-milestones
+Deletes old milestones and initializes new ones from the redeems file.
+```bash
+python -m flask refresh-milestones
+```
+Running this command shouldn't reset progress on milestones that are already in the database
+and are still in the redeems file.
+#### reset-milestone
+Resets progress on a milestone, but only if the milestone had been completed.
+```bash
+python -m flask reset-milestone milestone
+```
+#### hard-reset-milestone
+Resets progress on a milestone, regardless of completion status.
+```bash
+python -m flask hard-reset-milestone milestone
+```
 ## Configuration files
+Configuration files should be in the instance folder. For folder installation of tlapbot,
+that's `instance/` from the root of the Github repository.
+
+Take care not to replace `tlapbot/redeems.py` with your redeems config.
+`tlapbot/redeems.py` contains functions that handle redeems interactions with the db,
+and not the redeems config.
 ### config.py
 Values you can include in `config.py` to change how the bot behaves.
 
-(`config.py` should be in the instance folder: `/instance/config.py` for folder install.)
+(`config.py` should be in the instance folder: `instance/config.py` for folder install.)
 #### Mandatory
 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())'`
@@ -244,6 +296,7 @@ Including these values will overwrite their defaults from `/tlapbot/default_conf
 - `POINTS_CYCLE_TIME` decides how often channel points are given to users in chat,
 in seconds. 
 - `POINTS_AMOUNT_GIVEN` decides how many channel points users receive.
+- `PASSIVE` if `True`, sets Tlapbot into passive mode, where no redeems are available. The bot will still track username changes and give out points.
 - `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.
@@ -262,7 +315,7 @@ 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.)
+(`redeems.py` should be in the instance folder: `instance/redeems.py` for folder install.)
 #### `default_redeems.py`:
 ```python
 REDEEMS={
@@ -270,16 +323,22 @@ REDEEMS={
     "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."},
+    "go_nap": {"type": "milestone", "info": "Streamer will go nap when the goal is reached.", "goal": 1000},
     "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"` and `"category"`.
+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 `"type"`,
+an entry for `"price"` unless the redeem is a milestone,
+and optionally `"info"` and `"category"`.
+If the `"type"` is `"milestone"`, there's an additional required `"goal"` field as well.
 
-- `"price"` value should be an integer that decides how many points the redeem will cost.
+- `"price"` value should be an integer that decides how many points the redeem will cost. Milestone redeems don't use the `"price"` value.
-- `"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.
+- `"type"` value should be either `"list"`, `"counter"`, `"note"` or `"milestone"`. 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).
+- `"info"` value should be a string that describes what the command does. It's optional, but I recommend writing one for all `"list"`, `"note"` and `"milestone"` redeems (so that chatters know what they're redeeming and whether they should leave a note).
+- `"goal"` is a required field for milestone goals. It should be an integer, deciding the amount of points required to complete the milestone.
 - `"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

setup.py

@@ -2,7 +2,7 @@ from setuptools import find_packages, setup
 
 setup(
     name='tlapbot',
-    version='1.1.0',
+    version='1.2.1',
     packages=find_packages(),
     include_package_data=True,
     install_requires=[

tlapbot/__init__.py

@@ -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_requests import is_stream_live, give_points_to_chat
-        remove_inactive_redeems)
+from tlapbot.redeems import remove_inactive_redeems 
 
 def create_app(test_config=None):
     app = Flask(__name__, instance_relative_config=True)
@@ -24,10 +24,6 @@ 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']:
@@ -42,9 +38,9 @@ def create_app(test_config=None):
 
     # prepare webhooks and redeem dashboard blueprints
     from . import owncast_webhooks
-    from . import owncast_redeem_dashboard
+    from . import tlapbot_dashboard
     app.register_blueprint(owncast_webhooks.bp)
-    app.register_blueprint(owncast_redeem_dashboard.bp)
+    app.register_blueprint(tlapbot_dashboard.bp)
 
     # add db CLI commands
     from . import db
@@ -52,6 +48,9 @@ def create_app(test_config=None):
     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)
+    app.cli.add_command(db.refresh_milestones_command)
+    app.cli.add_command(db.reset_milestone_command)
+    app.cli.add_command(db.hard_reset_milestone_command)
     
     # scheduler job for giving points to users
     def proxy_job():

tlapbot/db.py

@@ -4,6 +4,7 @@ import click
 from flask import current_app, g
 from flask.cli import with_appcontext
 
+from tlapbot.redeems import milestone_complete
 
 def get_db():
     if 'db' not in g:
@@ -32,8 +33,10 @@ def insert_counters(db):
                     (redeem,)
                 )
                 db.commit()
-            except Error as e:
+            except sqlite3.Error as e:
                 print("Failed inserting counters to db:", e.args[0])
+                return False
+    return True
 
 
 def init_db():
@@ -42,7 +45,8 @@ def init_db():
     with current_app.open_resource('schema.sql') as f:
         db.executescript(f.read().decode('utf8'))
 
-    insert_counters(db)
+    if insert_counters(db):
+        return True
 
 
 def clear_redeem_queue():
@@ -56,8 +60,10 @@ def clear_redeem_queue():
             """UPDATE counters SET count = 0"""
         )
         db.commit()
-    except Error as e:
+    except sqlite3.Error as e:
         print("Error occured deleting redeem queue:", e.args[0])
+        return False
+    return True
 
 
 def refresh_counters():
@@ -66,26 +72,87 @@ def refresh_counters():
     try:
         db.execute("DELETE FROM counters")
         db.commit()
-    except Error as e:
+    except sqlite3.Error as e:
         print("Error occured deleting old counters:", e.args[0])
+        return False
+    if insert_counters(db):
+        return True
 
-    for redeem, redeem_info in current_app.config['REDEEMS'].items():
+
-        if redeem_info["type"] == "counter":
+def refresh_milestones():
+    db = get_db()
+    # delete old milestones
     try:
+        cursor = db.execute("SELECT name FROM milestones")
+        milestones = cursor.fetchall()
+        to_delete = []
+        for milestone in milestones:
+            milestone = milestone[0]
+            if milestone not in current_app.config['REDEEMS'].keys():
+                to_delete.append(milestone)
+            elif current_app.config['REDEEMS'][milestone]['type'] != "milestone":
+                to_delete.append(milestone)
+        for milestone in to_delete:
+            cursor.execute("DELETE FROM milestones WHERE name = ?", (milestone,))
+        db.commit()
+    except sqlite3.Error as e:
+        print("Failed deleting old milestones from db:", e.args[0])
+        return False
+
+    # add new milestones
+    try:
+        for redeem, redeem_info in current_app.config['REDEEMS'].items():
+            if redeem_info["type"] == "milestone":
                 cursor = db.execute(
-                    "INSERT INTO counters(name, count) VALUES(?, 0)",
+                    "SELECT goal FROM milestones WHERE name = ?",
                     (redeem,)
                 )
+                result = cursor.fetchone()
+                if result is None:
+                    cursor.execute(
+                        "INSERT INTO milestones(name, progress, goal, complete) VALUES(?, 0, ?, FALSE)",
+                        (redeem, redeem_info['goal'])
+                    )
+                # update existing milestone to new goal
+                elif result != redeem_info["goal"]:
+                    cursor.execute(
+                        "UPDATE milestones SET goal = ? WHERE name = ?",
+                        (redeem_info["goal"], redeem)
+                    )
         db.commit()
-            except Error as e:
+    except sqlite3.Error as e:
-                print("Failed inserting counters to db:", e.args[0])
+        print("Failed inserting milestones to db:", e.args[0])
+        return False
+    return True
+
+
+def reset_milestone(milestone):
+    if not milestone in current_app.config['REDEEMS']:
+        print(f"Failed resetting milestone, {milestone} not in redeems file.")
+        return False
+    try:
+        db = get_db()
+        db.execute(
+            "DELETE FROM milestones WHERE name = ?",
+            (milestone,)
+        )
+        db.execute(
+            "INSERT INTO milestones(name, progress, goal, complete) VALUES(?, ?, ?, FALSE)",
+            (milestone, 0, current_app.config['REDEEMS'][milestone]['goal'])
+        )
+        db.commit()
+        return True
+    except sqlite3.Error as e:
+        current_app.logger.error(f"Error occured adding a milestone: {e.args[0]}")
+        return False
+
 
 
 @click.command('init-db')
 @with_appcontext
 def init_db_command():
     """Clear the existing data and create new tables."""
-    init_db()
+    if init_db():
         click.echo('Initialized the database.')
 
 
@@ -93,7 +160,7 @@ def init_db_command():
 @with_appcontext
 def clear_queue_command():
     """Remove all redeems from the redeem queue."""
-    clear_redeem_queue()
+    if clear_redeem_queue():
         click.echo('Cleared redeem queue.')
 
 
@@ -102,7 +169,7 @@ def clear_queue_command():
 def refresh_counters_command():
     """Refresh counters from current config file.
     (Remove old ones, add new ones.)"""
-    refresh_counters()
+    if refresh_counters():
         click.echo('Counters refreshed.')
 
 
@@ -110,11 +177,39 @@ def refresh_counters_command():
 @with_appcontext
 def refresh_and_clear_command():
     """Refresh counters and clear queue."""
-    refresh_counters()
+    if refresh_counters() and clear_redeem_queue():
-    clear_redeem_queue()
         click.echo('Counters refreshed and queue cleared.')
 
 
+@click.command('refresh-milestones')
+@with_appcontext
+def refresh_milestones_command():
+    """Initialize all milestones from the redeems file, 
+    delete milestones not in redeem file."""
+    if refresh_milestones():
+        click.echo('Refreshed milestones.')
+
+
+@click.command('reset-milestone')
+@click.argument('milestone')
+def reset_milestone_command(milestone):
+    """Resets a completed milestone back to zero."""
+    if milestone_complete(get_db(), milestone):
+        if reset_milestone(milestone):
+            click.echo(f"Reset milestone {milestone}.")
+    else:
+        click.echo(f"Could not reset milestone {milestone}, milestone not completed.")
+        click.echo("(You can hard-reset-milestone if you really want to reset it.)")
+
+
+@click.command('hard-reset-milestone')
+@click.argument('milestone')
+def hard_reset_milestone_command(milestone):
+    """Resets any milestone back to zero."""
+    if reset_milestone(milestone):
+        click.echo(f"Hard reset milestone {milestone}.")
+
+
 def init_app(app):
     app.teardown_appcontext(close_db)
     app.cli.add_command(init_db_command)

tlapbot/default_config.py

@@ -3,6 +3,7 @@ OWNCAST_ACCESS_TOKEN=''
 OWNCAST_INSTANCE_URL='http://localhost:8080'
 POINTS_CYCLE_TIME=600
 POINTS_AMOUNT_GIVEN=10
+PASSIVE=False
 LIST_REDEEMS=False
 ACTIVE_CATEGORIES=[]
 GUNICORN=False

tlapbot/default_redeems.py

@@ -3,5 +3,6 @@ REDEEMS={
     "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."},
+    "go_nap": {"type": "milestone", "info": "Streamer will go nap when the goal is reached.", "goal": 1000},
     "inactive": {"price": 100, "type": "note", "info": "Example redeem that is inactive by default", "category": ["inactive"]}
 }

tlapbot/help_message.py

@@ -1,5 +1,5 @@
 from flask import current_app
-from tlapbot.owncast_helpers import send_chat
+from tlapbot.owncast_requests import send_chat
 
 
 def send_help():

tlapbot/owncast_helpers.py

@@ -1,33 +1,7 @@
 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.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.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,
-                            current_app.config['POINTS_AMOUNT_GIVEN'])
-
-
-def send_chat(message):
-    url = current_app.config['OWNCAST_INSTANCE_URL'] + '/api/integrations/chat/send'
-    headers = {"Authorization": "Bearer " + current_app.config['OWNCAST_ACCESS_TOKEN']}
-    r = requests.post(url, headers=headers, json={"body": message})
-    return r.json()
-
-
 # # # db stuff # # #
 def read_users_points(db, user_id):
     """Errors out if user doesn't exist."""
@@ -133,86 +107,6 @@ def change_display_name(db, user_id, new_name):
         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(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):
-    try:
-        cursor = db.execute(
-            "INSERT INTO redeem_queue(redeem, redeemer_id, note) VALUES(?, ?, ?)",
-            (redeem_name, user_id, note)
-            )
-        db.commit()
-        return True
-    except Error as e:
-        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):
-    try:
-        cursor = db.execute(
-            """SELECT counters.name, counters.count FROM counters"""
-        )
-        return cursor.fetchall()
-    except Error as e:
-        current_app.logger.error(f"Error occured selecting all counters: {e.args[0]}")
-
-
-def pretty_redeem_queue(db):
-    try:
-        cursor = db.execute(
-            """SELECT redeem_queue.created, redeem_queue.redeem, redeem_queue.note, points.name
-            FROM redeem_queue
-            INNER JOIN points
-            on redeem_queue.redeemer_id = points.id"""
-        )
-        return cursor.fetchall()
-    except Error as e:
-        current_app.logger.error(f"Error occured selecting pretty redeem queue: {e.args[0]}")
-
-
-def whole_redeem_queue(db):
-    try:
-        cursor = db.execute(
-            "SELECT * from redeem_queue"
-        )
-        return cursor.fetchall()
-    except Error as e:
-        current_app.logger.error(f"Error occured selecting redeem queue: {e.args[0]}")
-
-
 def remove_duplicate_usernames(db, user_id, username):
     try:
         cursor = db.execute(
@@ -233,17 +127,3 @@ def remove_emoji(message):
         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()))

tlapbot/owncast_requests.py

@@ -0,0 +1,48 @@
+import requests
+from flask import current_app
+from tlapbot.owncast_helpers import give_points_to_user
+
+
+def is_stream_live():
+    url = current_app.config['OWNCAST_INSTANCE_URL'] + '/api/status'
+    try:
+        r = requests.get(url)
+    except requests.exceptions.RequestException as e:
+        current_app.logger.error(f"Error occured checking if stream is live: {e.args[0]}")
+        return False
+    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']}
+    try:
+        r = requests.get(url, headers=headers)
+    except requests.exceptions.RequestException as e:
+        current_app.logger.error(f"Error occured getting users to give points to: {e.args[0]}")
+        return
+    if r.status_code != 200:
+        current_app.logger.error(f"Error occured when giving points: Response code not 200.")
+        current_app.logger.error(f"Response code received: {r.status_code}.")
+        current_app.logger.error(f"Check owncast instance url and access key.")
+        return
+    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, current_app.config['POINTS_AMOUNT_GIVEN'])
+
+
+def send_chat(message):
+    url = current_app.config['OWNCAST_INSTANCE_URL'] + '/api/integrations/chat/send'
+    headers = {"Authorization": "Bearer " + current_app.config['OWNCAST_ACCESS_TOKEN']}
+    try:
+        r = requests.post(url, headers=headers, json={"body": message})
+    except requests.exceptions.RequestException as e:
+        current_app.logger.error(f"Error occured sending chat message: {e.args[0]}")
+        return
+    if r.status_code != 200:
+        current_app.logger.error(f"Error occured when sending chat: Response code not 200.")
+        current_app.logger.error(f"Response code received: {r.status_code}.")
+        current_app.logger.error(f"Check owncast instance url and access key.")
+        return
+    return r.json()
+

tlapbot/owncast_webhooks.py

@@ -1,7 +1,8 @@
 from flask import Flask, request, json, Blueprint, current_app
 from tlapbot.db import get_db
+from tlapbot.owncast_requests import send_chat
 from tlapbot.owncast_helpers import (add_user_to_database, change_display_name,
-        send_chat, read_users_points, remove_duplicate_usernames)
+        read_users_points, remove_duplicate_usernames)
 from tlapbot.help_message import send_help
 from tlapbot.redeems_handler import handle_redeem
 
@@ -30,6 +31,7 @@ def owncast_webhook():
         if data["eventData"]["user"]["authenticated"]:
             remove_duplicate_usernames(db, user_id, new_name)
     elif data["type"] == "CHAT":
+        if not current_app.config['PASSIVE']:
             prefix = current_app.config['PREFIX']
             user_id = data["eventData"]["user"]["id"]
             display_name = data["eventData"]["user"]["displayName"]

tlapbot/redeems.py

@@ -0,0 +1,227 @@
+from flask import current_app
+from sqlite3 import Error
+from tlapbot.owncast_helpers import use_points
+
+def 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 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(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):
+    try:
+        cursor = db.execute(
+            "INSERT INTO redeem_queue(redeem, redeemer_id, note) VALUES(?, ?, ?)",
+            (redeem_name, user_id, note)
+            )
+        db.commit()
+        return True
+    except Error as e:
+        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 add_to_milestone(db, user_id, redeem_name, points_donated):
+    try:
+        cursor = db.execute(
+            "SELECT progress, goal FROM milestones WHERE name = ?",
+            (redeem_name,)
+        )
+        row = cursor.fetchone()
+        if row is None:
+            current_app.logger.warning("Milestone not found in database.")
+            current_app.logger.warning("Maybe you forgot to run the refresh-milestones CLI command "
+                                       "after you added a new milestone to the config?")
+            return False
+        progress, goal = row
+        if progress + points_donated > goal:
+            points_donated = goal - progress
+            if points_donated < 0:
+                points_donated = 0
+        if use_points(db, user_id, points_donated):
+            cursor = db.execute(
+                "UPDATE milestones SET progress = ? WHERE name = ?",
+                (progress + points_donated, redeem_name)
+            )
+            db.commit()
+            return True
+    except Error as e:
+        current_app.logger.error(f"Error occured updating milestone: {e.args[0]}")
+    return False
+
+
+def milestone_complete(db, redeem_name):
+    try:
+        cursor = db.execute(
+            "SELECT complete FROM milestones WHERE name = ?",
+            (redeem_name,)
+        )
+        row = cursor.fetchone()
+        if row is None:
+            current_app.logger.warning("Milestone not found in database.")
+            current_app.logger.warning("Maybe you forgot to run the refresh-milestones CLI command "
+                                       "after you added a new milestone to the config?")
+        else:
+            return row[0]
+    except Error as e:
+        current_app.logger.error(f"Error occured checking if milestone is complete: {e.args[0]}")
+
+
+def check_apply_milestone_completion(db, redeem_name):
+    try:
+        cursor = db.execute(
+            "SELECT progress, goal FROM milestones WHERE name = ?",
+            (redeem_name,)
+        )
+        row = cursor.fetchone()
+        if row is None:
+            current_app.logger.warning("Milestone not found in database.")
+            current_app.logger.warning("Maybe you forgot to run the refresh-milestones CLI command "
+                                       "after you added a new milestone to the config?")
+        else:
+            progress, goal = row
+            if progress == goal:
+                cursor = db.execute(
+                    "UPDATE milestones SET complete = TRUE WHERE name = ?",
+                    (redeem_name,)
+                )
+                db.commit()
+                return True
+        return False
+    except Error as e:
+        current_app.logger.error(f"Error occured applying milestone completion: {e.args[0]}")
+        return False
+
+
+def all_milestones(db):
+    try:
+        cursor = db.execute(
+            """SELECT name, progress, goal FROM milestones"""
+        )
+        return cursor.fetchall()
+    except Error as e:
+        current_app.logger.error(f"Error occured selecting all milestones: {e.args[0]}")
+
+
+def all_counters(db):
+    try:
+        cursor = db.execute(
+            """SELECT counters.name, counters.count FROM counters"""
+        )
+        return cursor.fetchall()
+    except Error as e:
+        current_app.logger.error(f"Error occured selecting all counters: {e.args[0]}")
+
+
+def all_active_counters(db):
+    counters = all_counters(db)
+    all_active_counters = []
+    for name, count in counters:
+        if is_redeem_active(name):
+            all_active_counters.append((name, count))
+    return all_active_counters
+
+
+def all_active_milestones(db):
+    milestones = all_milestones(db)
+    all_active_milestones = []
+    for name, progress, goal in milestones:
+        if is_redeem_active(name):
+            all_active_milestones.append((name, progress, goal))
+    return all_active_milestones
+
+
+def all_active_redeems(db):
+    redeems = current_app.config['REDEEMS']
+    all_active_redeems = {}
+    for redeem_name, redeem_dict in redeems.items():
+        if redeem_dict.get('category', None):
+            for category in redeem_dict['category']:
+                if category in current_app.config['ACTIVE_CATEGORIES']:
+                    all_active_redeems[redeem_name] = redeem_dict
+                    break
+        else:
+            all_active_redeems[redeem_name] = redeem_dict
+    return all_active_redeems
+
+
+def pretty_redeem_queue(db):
+    try:
+        cursor = db.execute(
+            """SELECT redeem_queue.created, redeem_queue.redeem, redeem_queue.note, points.name
+            FROM redeem_queue
+            INNER JOIN points
+            on redeem_queue.redeemer_id = points.id"""
+        )
+        return cursor.fetchall()
+    except Error as e:
+        current_app.logger.error(f"Error occured selecting pretty redeem queue: {e.args[0]}")
+
+
+def whole_redeem_queue(db):
+    try:
+        cursor = db.execute(
+            "SELECT * from redeem_queue"
+        )
+        return cursor.fetchall()
+    except Error as e:
+        current_app.logger.error(f"Error occured selecting redeem queue: {e.args[0]}")
+
+
+def is_redeem_active(redeem_name):
+    """Checks if redeem is active. Pulls the redeem by name from config."""
+    active_categories = current_app.config['ACTIVE_CATEGORIES']
+    redeem_dict = current_app.config['REDEEMS'].get(redeem_name, None)
+    if redeem_dict:
+        if "category" in redeem_dict:
+            for category in redeem_dict["category"]:
+                if category in active_categories:
+                    return True
+            return False
+        else:
+            return True
+    return None # redeem does not exist, unknown active state
+
+
+
+def is_redeem_from_config_active(redeem, active_categories):
+    """Checks if redeem is active. `redeem` is a whole key:value pair from redeems config."""
+    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_from_config_active(redeem, active_categories),
+                       redeems.items()))

tlapbot/redeems_handler.py

@@ -1,7 +1,9 @@
 from flask import current_app
 from tlapbot.db import get_db
-from tlapbot.owncast_helpers import (use_points, add_to_redeem_queue,
+from tlapbot.owncast_requests import send_chat
-        add_to_counter, read_users_points, send_chat, remove_emoji)
+from tlapbot.redeems import (add_to_redeem_queue, add_to_counter, add_to_milestone, 
+        check_apply_milestone_completion, milestone_complete, is_redeem_active)
+from tlapbot.owncast_helpers import use_points, read_users_points, remove_emoji
 
 
 def handle_redeem(message, user_id):
@@ -15,12 +17,34 @@ def handle_redeem(message, user_id):
     if redeem not in current_app.config['REDEEMS']:
         send_chat("Can't redeem, redeem not found.")
         return
+    if not is_redeem_active(redeem):
+        send_chat("Can't redeem, redeem is currently not active.")
+        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)
 
+    # handle milestone first because it doesn't have a price
+    if redeem_type == "milestone":
+        if milestone_complete(db, redeem):
+            send_chat(f"Can't redeem {redeem}, that milestone was already completed!")
+        elif not note:
+            send_chat(f"Cannot redeem {redeem}, no amount of points specified.")
+        elif not note.isdigit():
+            send_chat(f"Cannot redeem {redeem}, amount of points is not an integer.")
+        elif int(note) > points:
+            send_chat(f"Can't redeem {redeem}, you're donating more points than you have.")
+        elif add_to_milestone(db, user_id, redeem, int(note)):
+            send_chat(f"Succesfully donated to {redeem} milestone!")
+            if check_apply_milestone_completion(db, redeem):
+                send_chat(f"Milestone goal {redeem} complete!")
+        else:
+            send_chat(f"Redeeming milestone {redeem} failed.")
+        return
+    
+    # handle redeems with price argument
+    price = current_app.config['REDEEMS'][redeem]["price"]
     if not points or points < price:
         send_chat(f"Can't redeem {redeem}, you don't have enough points.")
         return

tlapbot/schema.sql

@@ -1,5 +1,6 @@
 DROP TABLE IF EXISTS counters;
 DROP TABLE IF EXISTS redeem_queue;
+DROP TABLE IF EXISTS milestones;
 
 CREATE TABLE IF NOT EXISTS points (
   id TEXT PRIMARY KEY,
@@ -7,6 +8,14 @@ CREATE TABLE IF NOT EXISTS points (
   points INTEGER
 );
 
+CREATE TABLE milestones (
+  id INTEGER PRIMARY KEY AUTOINCREMENT,
+  name TEXT NOT NULL,
+  progress INTEGER NOT NULL,
+  goal INTEGER NOT NULL,
+  complete BOOLEAN NOT NULL
+);
+
 CREATE TABLE counters (
   id INTEGER PRIMARY KEY AUTOINCREMENT,
   name TEXT NOT NULL,

tlapbot/templates/dashboard.html

@@ -1,6 +1,7 @@
 <!DOCTYPE html>
 <html lang="en">
 <link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}">
+
 <head>
     <title>Redeems Dashboard</title>
 </head>
@@ -10,10 +11,16 @@
 
     <div class="tab">
         <button class="tablinks" onclick="openTab(event, 'dashboard')" , id="defaultOpen">Tlapbot dashboard</button>
+        {% if not passive %}
+        {% if queue %}
+        <button class="tablinks" onclick="openTab(event, 'redeem-queue')">Redeem queue</button>
+        {% endif %}
         <button class="tablinks" onclick="openTab(event, 'redeems-list')">Redeems help</button>
+        {% endif %}
     </div>
 
     <div id='dashboard' class="tabcontent">
+
         <body>
             <h3>Redeems Dashboard</h3>
             {% if (username and users ) %}
@@ -32,6 +39,12 @@
             </table>
             {% endif %}
 
+            {% if passive %}
+            <h3>Tlapbot is currently in passive mode.</h3>
+            <p>You can't make any redeems, but you will receive points for watching.</p>
+            {% endif %}
+
+            {% if not passive %}
             {% if counters %}
             <table>
                 <thead>
@@ -47,12 +60,37 @@
                 {% endfor %}
             </table>
             {% endif %}
+            {% if milestones %}
+            <table>
+                <thead>
+                    <tr>
+                        <th colspan="2">Active milestones</th>
+                        <th>Progress</th>
+                    </tr>
+                </thead>
+                {% for milestone in milestones %}
+                <tbody>
+                    <td> {{ milestone[0] }} </td>
+                    <td> <progress id="file" max={{ milestone[2] }} value={{ milestone[1] }}></progress></td>
+                    <td> {{ milestone[1] }} / {{ milestone[2] }}</td>
+                </tbody>
+                {% endfor %}
+            </table>
+            {% endif %}
+            {% endif %}
+        </body>
+    </div>
 
+    <div id='redeem-queue' class="tabcontent">
+
+        <body>
+            <h3>Redeems Queue</h3>
+            <p>Past redeemed redeems with timestamps and notes.</p>
             {% if queue %}
             <table>
                 <thead>
                     <tr>
-                        <th>Recent redeems</th>
+                        <th colspan="2">Recent redeems</th>
                     </tr>
                     <tr>
                         <th>Time</th>
@@ -83,7 +121,10 @@
             <li><strong>Counter</strong> redeems add +1 to their counter.</li>
             <li><strong>List</strong> redeems get added to the list of recent redeems (without a note).</li>
             <li><strong>Note</strong> redeems require you to send a message together with the redeem.</li>
+            <li><strong>Milestone</strong> redeems are long-term goals to which you can donate any amount of points you
+                want. They will be completed once the amount of points donated reaches the goal.</li>
         </ul>
+
         <body>
             {% if redeems %}
             <table>
@@ -98,7 +139,11 @@
                 {% for redeem, redeem_info in redeems.items() %}
                 <tbody>
                     <td>{{ prefix }}{{ redeem }}</td>
+                    {% if redeem_info["type"] == "milestone" %}
+                    <td></td>
+                    {% else %}
                     <td>{{ redeem_info["price"] }}</td>
+                    {% endif %}
                     <td>{{ redeem_info["type"] }}</td>
                     {% if redeem_info["info"] %}
                     <td>{{ redeem_info["info"] }}</td>

tlapbot/tlapbot_dashboard.py

@@ -1,7 +1,7 @@
 from flask import render_template, Blueprint, request, current_app
 from tlapbot.db import get_db
-from tlapbot.owncast_helpers import (pretty_redeem_queue, all_counters,
+from tlapbot.redeems import all_active_counters, all_active_milestones, all_active_redeems, pretty_redeem_queue
-        read_all_users_with_username)
+from tlapbot.owncast_helpers import  read_all_users_with_username
 from datetime import datetime, timezone
 
 bp = Blueprint('redeem_dashboard', __name__)
@@ -18,9 +18,11 @@ def dashboard():
     utc_timezone = timezone.utc
     return render_template('dashboard.html',
                            queue=pretty_redeem_queue(db),
-                           counters=all_counters(db),
+                           counters=all_active_counters(db),
-                           redeems=current_app.config['REDEEMS'],
+                           milestones=all_active_milestones(db),
+                           redeems=all_active_redeems(db),
                            prefix=current_app.config['PREFIX'],
+                           passive=current_app.config['PASSIVE'],
                            username=username,
                            users=users,
                            utc_timezone=utc_timezone)