shit ton of refactoring

README.md

@@ -5,10 +5,14 @@ Widevine Utility Website and Remote Widevine Device API.
 # Setup
 
 -   Install Python Poetry: https://python-poetry.org/docs/master/#installation
--   Install depdencies: `poetry install`
+-   Install Dependencies:
+    -   For MySQL: `poetry install -E mysql`
+    -   For MariaDB: `poetry install -E mariadb`
 -   Copy `.env.example` to `.env`.(#environment-variables)
--   Copy `getwvkeys/config.py.example` to `getwvkeys/config.py`
--   Edit `config.py` and `.env`
+-   Copy `getwvkeys/config.toml.example` to `getwvkeys/config.toml`
+-   Edit `config.toml`
+    -   For a MySQL Database, use the prefix `mysql+mariadbconnector`
+    -   For a MariaDB Database, use the prefix `mariadb+mariadbconnector`
 -   Run database migrations. see [Database Migrations](#database-migrations)
 -   See [Deploy](#deploy)
 

alembic.ini

@@ -0,0 +1,117 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = alembic
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+# this is overwritten in getwvkeys!!!
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+hooks = black
+black.type = console_scripts
+black.entrypoint = black
+black.options = -l 79
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

alembic/README

@@ -0,0 +1 @@
+Generic single-database configuration.

alembic/env.py

@@ -0,0 +1,86 @@
+import os
+from logging.config import fileConfig
+
+import toml
+from sqlalchemy import engine_from_config, pool
+
+from alembic import context
+from getwvkeys.models import APIKey, Base, Device, Key, User
+
+IS_DEVELOPMENT = bool(os.environ.get("DEVELOPMENT", False))
+IS_STAGING = bool(os.environ.get("STAGING", False))
+CONFIG = toml.load("config.dev.toml" if IS_DEVELOPMENT else "config.staging.toml" if IS_STAGING else "config.toml")
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = Base.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    # url = config.get_main_option("sqlalchemy.url")
+    url = CONFIG["general"]["database_uri"]
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    url = CONFIG["general"]["database_uri"]
+    cfg = config.get_section(config.config_ini_section, {})
+    cfg["sqlalchemy.url"] = url
+    connectable = engine_from_config(
+        cfg,
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(connection=connection, target_metadata=target_metadata)
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

alembic/script.py.mako

@@ -0,0 +1,26 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

alembic/versions/af5d6ca3a942_update_device_model.py

@@ -0,0 +1,83 @@
+"""update_device_model
+
+Revision ID: af5d6ca3a942
+Revises: c8ce82d0c054
+Create Date: 2024-05-22 18:37:39.203649
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+
+from alembic import op
+
+revision: str = "af5d6ca3a942"
+down_revision: Union[str, None] = "c8ce82d0c054"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = "c8ce82d0c054"
+
+
+def upgrade() -> None:
+    op.alter_column("devices", "code", new_column_name="info", existing_type=sa.String(255))  # rename code to info
+    op.add_column(
+        "devices",
+        sa.Column(
+            "code",
+            sa.String(length=255),
+            nullable=True,
+            default=sa.text(
+                "sha2(concat(convert(sha2(convert(`client_id_blob_filename` using utf8mb4),256) using utf8mb4),':',convert(sha2(convert(`client_id_blob_filename` using utf8mb4),256) using utf8mb4),':',convert(`uploaded_by` using utf8mb4)),256)"
+            ),
+        ),
+    )  # add new code column
+
+    # remove all rows where updated_by is null
+    op.execute("DELETE FROM devices WHERE uploaded_by IS NULL")
+
+    # set uploaded_by to non nullable
+    op.alter_column("devices", "uploaded_by", nullable=False, existing_type=sa.String(255))
+
+    # generate code for rows as a sha256 in the format of "client_id_blob_filename sha256:device_private_key sha265:uploaded_by"
+    op.execute(
+        """
+        UPDATE devices 
+        SET code = SHA2(
+            CONCAT(
+                SHA2(CONVERT(client_id_blob_filename USING utf8mb4), 256), 
+                ':', 
+                SHA2(CONVERT(client_id_blob_filename USING utf8mb4), 256), 
+                ':', 
+                CONVERT(uploaded_by USING utf8mb4)
+            ), 
+            256
+        )
+        """
+    )
+
+    # remove any rows that are duplicates of code, keeping one. this will fix issues with the unique constraint added next
+    op.execute(
+        """
+        DELETE FROM devices 
+        WHERE id NOT IN (
+            SELECT id 
+            FROM (
+                SELECT id 
+                FROM devices 
+                GROUP BY code 
+                HAVING COUNT(*) > 1
+            ) 
+            AS t
+        )
+        """
+    )
+
+    op.create_unique_constraint(None, "devices", ["code"])  # create the unique constraint on code
+
+    # remove useless columns
+    op.drop_column("devices", "security_level")
+    op.drop_column("devices", "session_id_type")
+
+
+def downgrade() -> None:
+    raise NotImplementedError("Downgrade is not supported for this migration.")

alembic/versions/c8ce82d0c054_rename_cdm_table.py

@@ -0,0 +1,27 @@
+"""rename_cdm_table
+
+Revision ID: c8ce82d0c054
+Revises: f3df682d6393
+Create Date: 2024-05-21 22:34:31.031258
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "c8ce82d0c054"
+down_revision: Union[str, None] = "f3df682d6393"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = "f3df682d6393"
+
+
+def upgrade() -> None:
+    op.rename_table("cdms", "devices")
+
+
+def downgrade() -> None:
+    op.rename_table("devices", "cdms")