SteamGridDB integration

backend/alembic/versions/0020_created_and_updated.py

@@ -0,0 +1,137 @@
+"""empty message
+
+Revision ID: 0020_created_and_updated
+Revises: 0019_resources_refactor
+Create Date: 2024-06-27 12:08:13.886766
+
+"""
+
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import mysql
+
+# revision identifiers, used by Alembic.
+revision = "0020_created_and_updated"
+down_revision = "0019_resources_refactor"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("firmware", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column(
+                "created_at",
+                sa.DateTime(timezone=True),
+                server_default=sa.text("now()"),
+                nullable=False,
+            )
+        )
+        batch_op.add_column(
+            sa.Column(
+                "updated_at",
+                sa.DateTime(timezone=True),
+                server_default=sa.text("now()"),
+                nullable=False,
+            )
+        )
+
+    with op.batch_alter_table("platforms", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column(
+                "created_at",
+                sa.DateTime(timezone=True),
+                server_default=sa.text("now()"),
+                nullable=False,
+            )
+        )
+        batch_op.add_column(
+            sa.Column(
+                "updated_at",
+                sa.DateTime(timezone=True),
+                server_default=sa.text("now()"),
+                nullable=False,
+            )
+        )
+
+    with op.batch_alter_table("rom_notes", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column(
+                "updated_at",
+                sa.DateTime(timezone=True),
+                server_default=sa.text("now()"),
+                nullable=False,
+            )
+        )
+        batch_op.drop_column("last_edited_at")
+
+    with op.batch_alter_table("roms", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column(
+                "created_at",
+                sa.DateTime(timezone=True),
+                server_default=sa.text("now()"),
+                nullable=False,
+            )
+        )
+        batch_op.add_column(
+            sa.Column(
+                "updated_at",
+                sa.DateTime(timezone=True),
+                server_default=sa.text("now()"),
+                nullable=False,
+            )
+        )
+
+    with op.batch_alter_table("users", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column(
+                "created_at",
+                sa.DateTime(timezone=True),
+                server_default=sa.text("now()"),
+                nullable=False,
+            )
+        )
+        batch_op.add_column(
+            sa.Column(
+                "updated_at",
+                sa.DateTime(timezone=True),
+                server_default=sa.text("now()"),
+                nullable=False,
+            )
+        )
+
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("users", schema=None) as batch_op:
+        batch_op.drop_column("updated_at")
+        batch_op.drop_column("created_at")
+
+    with op.batch_alter_table("roms", schema=None) as batch_op:
+        batch_op.drop_column("updated_at")
+        batch_op.drop_column("created_at")
+
+    with op.batch_alter_table("rom_notes", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column(
+                "last_edited_at",
+                mysql.DATETIME(),
+                server_default=sa.text("current_timestamp()"),
+                nullable=False,
+            )
+        )
+        batch_op.drop_column("updated_at")
+
+    with op.batch_alter_table("platforms", schema=None) as batch_op:
+        batch_op.drop_column("updated_at")
+        batch_op.drop_column("created_at")
+
+    with op.batch_alter_table("firmware", schema=None) as batch_op:
+        batch_op.drop_column("updated_at")
+        batch_op.drop_column("created_at")
+
+    # ### end Alembic commands ###

backend/endpoints/heartbeat.py

@@ -11,6 +11,7 @@
 from handler.filesystem import fs_platform_handler
 from handler.metadata.igdb_handler import IGDB_API_ENABLED
 from handler.metadata.moby_handler import MOBY_API_ENABLED
+from handler.metadata.sgdb_handler import STEAMGRIDDB_API_ENABLED
 from utils import get_version
 
 router = APIRouter()
@@ -27,6 +28,7 @@ def heartbeat() -> HeartbeatResponse:
     return {
         "VERSION": get_version(),
         "ANY_SOURCE_ENABLED": IGDB_API_ENABLED or MOBY_API_ENABLED,
+        "STEAMGRIDDB_ENABLED": STEAMGRIDDB_API_ENABLED,
         "METADATA_SOURCES": {
             "IGDB_API_ENABLED": IGDB_API_ENABLED,
             "MOBY_API_ENABLED": MOBY_API_ENABLED,

backend/endpoints/responses/firmware.py

@@ -1,3 +1,5 @@
+from datetime import datetime
+
 from pydantic import BaseModel
 from typing_extensions import TypedDict
 
@@ -18,6 +20,9 @@ class FirmwareSchema(BaseModel):
     md5_hash: str
     sha1_hash: str
 
+    created_at: datetime
+    updated_at: datetime
+
     class Config:
         from_attributes = True
 

backend/endpoints/responses/heartbeat.py

@@ -27,4 +27,5 @@ class HeartbeatResponse(TypedDict):
     SCHEDULER: SchedulerDict
     ANY_SOURCE_ENABLED: bool
     METADATA_SOURCES: MetadataSourcesDict
+    STEAMGRIDDB_ENABLED: bool
     FS_PLATFORMS: list

backend/endpoints/responses/identity.py

@@ -14,5 +14,8 @@ class UserSchema(BaseModel):
     last_login: datetime | None
     last_active: datetime | None
 
+    created_at: datetime
+    updated_at: datetime
+
     class Config:
         from_attributes = True

backend/endpoints/responses/platform.py

@@ -1,3 +1,5 @@
+from datetime import datetime
+
 from pydantic import BaseModel, Field
 
 from .firmware import FirmwareSchema
@@ -15,5 +17,8 @@ class PlatformSchema(BaseModel):
     logo_path: str | None = ""
     firmware: list[FirmwareSchema] = Field(default_factory=list)
 
+    created_at: datetime
+    updated_at: datetime
+
     class Config:
         from_attributes = True

backend/endpoints/responses/rom.py

@@ -30,7 +30,7 @@ class RomNoteSchema(BaseModel):
     id: int
     user_id: int
     rom_id: int
-    last_edited_at: datetime
+    updated_at: datetime
     raw_markdown: str
     is_public: bool
     user__username: str
@@ -94,6 +94,9 @@ class RomSchema(BaseModel):
     files: list[str]
     full_path: str
 
+    created_at: datetime
+    updated_at: datetime
+
     class Config:
         from_attributes = True
 

backend/endpoints/responses/search.py

@@ -9,3 +9,8 @@ class SearchRomSchema(BaseModel):
     summary: str
     igdb_url_cover: str = ""
     moby_url_cover: str = ""
+
+
+class SearchCoverSchema(BaseModel):
+    name: str
+    resources: list

backend/endpoints/search.py

@@ -1,9 +1,9 @@
 import emoji
 from decorators.auth import protected_route
-from endpoints.responses.search import SearchRomSchema
+from endpoints.responses.search import SearchCoverSchema, SearchRomSchema
 from fastapi import APIRouter, HTTPException, Request, status
 from handler.database import db_rom_handler
-from handler.metadata import meta_igdb_handler, meta_moby_handler
+from handler.metadata import meta_igdb_handler, meta_moby_handler, meta_sgdb_handler
 from handler.metadata.igdb_handler import IGDB_API_ENABLED
 from handler.metadata.moby_handler import MOBY_API_ENABLED
 from handler.scan_handler import _get_main_platform_igdb_id
@@ -107,3 +107,12 @@ async def search_rom(
         log.info(f"\t - {m_rom['name']}")
 
     return matched_roms
+
+
+@protected_route(router.get, "/search/cover", ["roms.read"])
+async def search_cover(
+    request: Request,
+    search_term: str | None = None,
+) -> list[SearchCoverSchema]:
+
+    return meta_sgdb_handler.get_details(search_term)

backend/handler/filesystem/resources_handler.py

@@ -38,8 +38,12 @@ def _cover_exists(rom: Rom, size: CoverSize):
     def resize_cover_to_small(cover_path: str):
         """Path of the cover image to resize"""
         cover = Image.open(cover_path)
-        small_width = int(cover.width * 0.1)
-        small_height = int(cover.height * 0.1)
+        if cover.height >= 1000:
+            ratio = 0.2
+        else:
+            ratio = 0.4
+        small_width = int(cover.width * ratio)
+        small_height = int(cover.height * ratio)
         small_size = (small_width, small_height)
         small_img = cover.resize(small_size)
         small_img.save(cover_path)

backend/handler/metadata/igdb_handler.py

@@ -179,13 +179,14 @@ def extract_metadata_from_igdb_rom(rom: dict) -> IGDBMetadata:
 
 class IGDBBaseHandler(MetadataHandler):
     def __init__(self) -> None:
-        self.platform_endpoint = "https://api.igdb.com/v4/platforms"
-        self.platform_version_endpoint = "https://api.igdb.com/v4/platform_versions"
-        self.platforms_fields = ["id", "name"]
-        self.games_endpoint = "https://api.igdb.com/v4/games"
+        self.BASE_URL = "https://api.igdb.com/v4"
+        self.platform_endpoint = f"{self.BASE_URL}/platforms"
+        self.platform_version_endpoint = f"{self.BASE_URL}/platform_versions"
+        self.platforms_fields = PLATFORMS_FIELDS
+        self.games_endpoint = f"{self.BASE_URL}/games"
         self.games_fields = GAMES_FIELDS
-        self.search_endpoint = "https://api.igdb.com/v4/search"
-        self.search_fields = ["game.id", "name"]
+        self.search_endpoint = f"{self.BASE_URL}/search"
+        self.search_fields = SEARCH_FIELDS
         self.pagination_limit = 200
         self.twitch_auth = TwitchAuth()
         self.headers = {
@@ -617,6 +618,8 @@ def get_oauth_token(self) -> str:
         return token
 
 
+PLATFORMS_FIELDS = ["id", "name"]
+
 GAMES_FIELDS = [
     "id",
     "name",
@@ -667,6 +670,8 @@ def get_oauth_token(self) -> str:
     "similar_games.cover.url",
 ]
 
+SEARCH_FIELDS = ["game.id", "name"]
+
 # Generated from the following code on https://www.igdb.com/platforms/:
 # Array.from(document.querySelectorAll(".media-body a")).map(a => ({
 #   slug: a.href.split("/")[4],