Skip to content

Speakr is a personal, self-hosted web application designed for transcribing audio recordings

Python
2.9 KB
Raw Blame
"""Per-user archive state (#394).

Archive works like inbox and star: the owner's value lives on the recording,
and each user a recording is shared with keeps their own value on their
SharedRecordingState row, so archiving a shared recording never hides it for
anyone else.
"""

from sqlalchemy import select

from src.database import db
from src.models.sharing import SharedRecordingState


def _state(recording, user):
    return SharedRecordingState.query.filter_by(recording_id=recording.id, user_id=user.id).first()


def get_user_archived(recording, user):
    if recording.user_id == user.id:
        return bool(recording.is_archived)
    state = _state(recording, user)
    return bool(state and state.is_archived)


def set_user_archived(recording, user, value, commit=True):
    value = bool(value)
    if recording.user_id == user.id:
        recording.is_archived = value
    else:
        state = _state(recording, user)
        if not state:
            state = SharedRecordingState(recording_id=recording.id, user_id=user.id,
                                         is_inbox=True, is_highlighted=False)
            db.session.add(state)
        state.is_archived = value
    if commit:
        db.session.commit()
    return value


def parse_archived_flag(value):
    """Strict boolean for an API is_archived field; None when it is not one.

    bool("false") is True, so a string must be parsed, not cast.
    """
    if isinstance(value, bool):
        return value
    if isinstance(value, int) and value in (0, 1):
        return bool(value)
    if isinstance(value, str) and value.strip().lower() in ('true', '1', 'false', '0'):
        return value.strip().lower() in ('true', '1')
    return None


def archived_condition(recording_model, user_id):
    """SQL condition: the recording is archived for this user.

    NULL counts as not archived, so rows written before the column existed
    can never disappear from the list.
    """
    shared_archived = select(SharedRecordingState.recording_id).where(
        db.and_(SharedRecordingState.user_id == user_id,
                db.func.coalesce(SharedRecordingState.is_archived, False) == True)  # noqa: E712
    ).scalar_subquery()
    return db.or_(
        db.and_(recording_model.user_id == user_id,
                db.func.coalesce(recording_model.is_archived, False) == True),  # noqa: E712
        recording_model.id.in_(shared_archived),
    )


def set_user_notes(recording, user, notes):
    """The owner writes the recording's notes; anyone else writes their own
    personal notes and never sees or changes the owner's (mailr spec Q2)."""
    if recording.user_id == user.id:
        recording.notes = notes
        return
    state = _state(recording, user)
    if not state:
        state = SharedRecordingState(recording_id=recording.id, user_id=user.id,
                                     is_inbox=True, is_highlighted=False)
        db.session.add(state)
    state.personal_notes = notes