add info to README

this will definitely need some more work.

README.md

@@ -1 +1,11 @@
-# slop-farmer-server
+# slop-farmer-server
+FastAPI-based server to form the backend of the Slop Farmer browser extension.
+Handles user authentication, requests to check search result URLs against reported slop,
+and new reports of slop URLs from users.
+
+## Docker Container
+run the server with `docker run -P --env-file <env file> slopfarmer`
+
+## Environment Variables
+DB_URL - The url connection string to pass to SQLAlchemy
+TOKEN_SECRET - the secret used for signing JWTs used for user auth after login

slopserver/alembic/versions/2eee353294c6_user_path_association.py

@@ -0,0 +1,47 @@
+"""user_path_association
+
+Revision ID: 2eee353294c6
+Revises: 12eca4bad288
+Create Date: 2025-10-25 23:17:50.734413
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+import sqlmodel.sql.sqltypes
+
+
+# revision identifiers, used by Alembic.
+revision: str = '2eee353294c6'
+down_revision: Union[str, Sequence[str], None] = '12eca4bad288'
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    """Upgrade schema."""
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('report',
+    sa.Column('path_id', sa.Integer(), nullable=False),
+    sa.Column('user_id', sa.Integer(), nullable=False),
+    sa.ForeignKeyConstraint(['path_id'], ['path.id'], name=op.f('fk_report_path_id_path')),
+    sa.ForeignKeyConstraint(['user_id'], ['user.id'], name=op.f('fk_report_user_id_user')),
+    sa.PrimaryKeyConstraint('path_id', 'user_id', name=op.f('pk_report'))
+    )
+    op.alter_column('path', 'domain_id',
+               existing_type=sa.INTEGER(),
+               nullable=True)
+    op.drop_column('user', 'salt')
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    """Downgrade schema."""
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('user', sa.Column('salt', sa.VARCHAR(), autoincrement=False, nullable=False))
+    op.alter_column('path', 'domain_id',
+               existing_type=sa.INTEGER(),
+               nullable=False)
+    op.drop_table('report')
+    # ### end Alembic commands ###

slopserver/alembic/versions/b26c87d1f838_report_table_timestamp.py

@@ -0,0 +1,33 @@
+"""report table timestamp
+
+Revision ID: b26c87d1f838
+Revises: 2eee353294c6
+Create Date: 2025-10-26 15:30:51.268150
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+import sqlmodel.sql.sqltypes
+
+
+# revision identifiers, used by Alembic.
+revision: str = 'b26c87d1f838'
+down_revision: Union[str, Sequence[str], None] = '2eee353294c6'
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    """Upgrade schema."""
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('report', sa.Column('timestamp', sa.DateTime(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    """Downgrade schema."""
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('report', 'timestamp')
+    # ### end Alembic commands ###

slopserver/db.py

@@ -1,9 +1,10 @@
 from collections.abc import Iterable
+from datetime import datetime
 from urllib.parse import ParseResult
 from sqlalchemy import select
 from sqlalchemy.engine import Engine
 from sqlalchemy.orm import Session
-from slopserver.models import Domain, Path, User
+from slopserver.models import Domain, Path, User, Report
 
 def select_slop(urls: list[ParseResult], engine: Engine) -> Iterable[Domain]:
     query = select(Domain).where(Domain.domain_name.in_(url[1] for url in urls))
@@ -11,7 +12,7 @@ def select_slop(urls: list[ParseResult], engine: Engine) -> Iterable[Domain]:
         rows = session.scalars(query).all()
         return rows
     
-def insert_slop(urls: list[ParseResult], engine: Engine):
+def insert_slop(urls: list[ParseResult], engine: Engine, user: User | None = None):
     domain_dict: dict[str. set[str]] = dict()
     for url in urls:
         if not domain_dict.get(url[1]):
@@ -35,13 +36,25 @@ def insert_slop(urls: list[ParseResult], engine: Engine):
                 new_domain = Domain(domain_name=domain, paths=list())
                 new_domain.paths = [Path(path=path) for path in paths]
                 session.add(new_domain)
+                if user:
+                    for path in new_domain.paths:
+                        new_report = Report(path_id=path.id, user_id=user.id)
+                        session.add(new_report)
             
             else:
                 existing_domain = existing_dict[domain]
                 existing_paths = set((path.path for path in existing_domain.paths))
                 for path in paths:
                     if not path in existing_paths:
-                        existing_domain.paths.append(Path(path=path))
+                        new_path = Path(path=path)
+                        existing_domain.paths.append(new_path)
+                        session.add(new_path)
+                        session.flush([new_path])
+                        session.refresh(new_path)
+                        if user:
+                            new_report = Report(
+                                path_id=new_path.id, user_id=user.id, timestamp=datetime.now())
+                            session.add(new_report)
 
         session.commit()
 

slopserver/models.py

@@ -2,6 +2,8 @@ from typing import Annotated
 from sqlmodel import Field, SQLModel, create_engine, Relationship
 from pydantic import AfterValidator, Base64Str, BaseModel, EmailStr, Json, SecretStr
 
+from datetime import datetime
+
 from altcha import Payload as AltchaPayload, verify_solution
 
 from urllib.parse import urlparse, ParseResult
@@ -43,6 +45,11 @@ class User(SQLModel, table=True):
 
     email_verified: bool = Field(default=False)
 
+class Report(SQLModel, table=True):
+    path_id: int | None = Field(default=None, primary_key=True, foreign_key="path.id")
+    user_id: int | None = Field(default=None, primary_key=True, foreign_key="user.id")
+    timestamp: datetime | None = Field(default=datetime.now())
+
 ################################################
 #           API Models
 ################################################

slopserver/server.py

@@ -95,15 +95,21 @@ def generate_auth_token(username):
     encoded_jwt = jwt.encode(bearer_token, TOKEN_SECRET, ALGO)   
     return encoded_jwt
 
+def get_token_user(decoded_token):
+    user = get_user(decoded_token["sub"], DB_ENGINE)
+    return user
+
 def verify_auth_token(token: str):
     try:
         token = jwt.decode(token, TOKEN_SECRET, ALGO, audience="slopserver")
+        return token
     except:
         raise HTTPException(status_code=401, detail="invalid access token")
 
 @app.post("/report")
 async def report_slop(report: SlopReport, bearer: Annotated[str, AfterValidator(verify_auth_token), Header()]):
-    insert_slop(report.slop_urls, DB_ENGINE)
+    user = get_token_user(bearer)
+    insert_slop(report.slop_urls, DB_ENGINE, user)
 
 @app.post("/check")
 async def check_slop(check: Annotated[SlopReport, Body()], bearer: Annotated[str, AfterValidator(verify_auth_token), Header()]):