probo/pkg/coredata/document.go

// Copyright (c) 2025 Probo Inc <hello@getprobo.com>.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

package coredata

import (
	"context"
	"errors"
	"fmt"
	"maps"
	"time"

	"github.com/jackc/pgx/v5"
	"go.gearno.de/kit/pg"
	"go.probo.inc/probo/pkg/gid"
	"go.probo.inc/probo/pkg/mail"
	"go.probo.inc/probo/pkg/page"
)

type (
	Document struct {
		ID                      gid.GID                `db:"id"`
		OrganizationID          gid.GID                `db:"organization_id"`
		OwnerID                 gid.GID                `db:"owner_id"`
		Title                   string                 `db:"title"`
		DocumentType            DocumentType           `db:"document_type"`
		Classification          DocumentClassification `db:"classification"`
		CurrentPublishedVersion *int                   `db:"current_published_version"`
		TrustCenterVisibility   TrustCenterVisibility  `db:"trust_center_visibility"`
		CreatedAt               time.Time              `db:"created_at"`
		UpdatedAt               time.Time              `db:"updated_at"`
	}

	Documents []*Document

	ErrDocumentNotFound struct {
		Identifier string
	}

	ErrDocumentAlreadyExists struct {
		message string
	}
)

func (e ErrDocumentNotFound) Error() string {
	return fmt.Sprintf("document not found: %q", e.Identifier)
}

func (e ErrDocumentAlreadyExists) Error() string {
	return e.message
}

func (p Document) CursorKey(orderBy DocumentOrderField) page.CursorKey {
	switch orderBy {
	case DocumentOrderFieldCreatedAt:
		return page.NewCursorKey(p.ID, p.CreatedAt)
	case DocumentOrderFieldTitle:
		return page.NewCursorKey(p.ID, p.Title)
	case DocumentOrderFieldDocumentType:
		return page.NewCursorKey(p.ID, p.DocumentType)
	}

	panic(fmt.Sprintf("unsupported order by: %s", orderBy))
}

func (p *Document) LoadByID(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
	documentID gid.GID,
) error {
	q := `
SELECT
    id,
    organization_id,
    owner_id,
    title,
    document_type,
    classification,
    current_published_version,
    trust_center_visibility,
    created_at,
    updated_at
FROM
    documents
WHERE
    %s
    AND deleted_at IS NULL
    AND id = @document_id
LIMIT 1;
`

	q = fmt.Sprintf(q, scope.SQLFragment())

	args := pgx.StrictNamedArgs{"document_id": documentID}
	maps.Copy(args, scope.SQLArguments())

	rows, err := conn.Query(ctx, q, args)
	if err != nil {
		return fmt.Errorf("cannot query documents: %w", err)
	}

	document, err := pgx.CollectExactlyOneRow(rows, pgx.RowToStructByName[Document])
	if err != nil {
		if errors.Is(err, pgx.ErrNoRows) {
			return &ErrDocumentNotFound{Identifier: documentID.String()}
		}

		return fmt.Errorf("cannot collect document: %w", err)
	}

	*p = document

	return nil
}

func (p *Document) LoadByIDWithFilter(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
	documentID gid.GID,
	filter *DocumentFilter,
) error {
	q := `
SELECT
    id,
    organization_id,
    owner_id,
    title,
    document_type,
    classification,
    current_published_version,
    trust_center_visibility,
    created_at,
    updated_at
FROM
    documents
WHERE
    %s
    AND deleted_at IS NULL
AND id = @document_id
    AND %s
LIMIT 1;
`

	q = fmt.Sprintf(q, scope.SQLFragment(), filter.SQLFragment())

	args := pgx.StrictNamedArgs{"document_id": documentID}
	maps.Copy(args, scope.SQLArguments())
	maps.Copy(args, filter.SQLArguments())

	rows, err := conn.Query(ctx, q, args)
	if err != nil {
		return fmt.Errorf("cannot query documents: %w", err)
	}

	document, err := pgx.CollectExactlyOneRow(rows, pgx.RowToStructByName[Document])
	if err != nil {
		if errors.Is(err, pgx.ErrNoRows) {
			return &ErrDocumentNotFound{Identifier: documentID.String()}
		}

		return fmt.Errorf("cannot collect document: %w", err)
	}

	*p = document

	return nil
}

func (p *Documents) LoadByIDs(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
	documentIDs []gid.GID,
) error {
	q := `
SELECT
    id,
    organization_id,
    owner_id,
    title,
    document_type,
    classification,
    current_published_version,
    trust_center_visibility,
    created_at,
    updated_at
FROM
    documents
WHERE
    %s
    AND deleted_at IS NULL
    AND id = ANY(@document_ids)
`

	q = fmt.Sprintf(q, scope.SQLFragment())

	args := pgx.StrictNamedArgs{"document_ids": documentIDs}
	maps.Copy(args, scope.SQLArguments())

	rows, err := conn.Query(ctx, q, args)
	if err != nil {
		return fmt.Errorf("cannot query documents: %w", err)
	}

	documents, err := pgx.CollectRows(rows, pgx.RowToAddrOfStructByName[Document])
	if err != nil {
		return fmt.Errorf("cannot collect documents: %w", err)
	}

	*p = documents

	return nil
}

func (p *Documents) CountByOrganizationID(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
	organizationID gid.GID,
	filter *DocumentFilter,
) (int, error) {
	q := `
SELECT
	COUNT(id)
FROM
    documents
WHERE
    %s
    AND deleted_at IS NULL
    AND organization_id = @organization_id
    AND %s
`

	q = fmt.Sprintf(q, scope.SQLFragment(), filter.SQLFragment())

	args := pgx.NamedArgs{"organization_id": organizationID}
	maps.Copy(args, scope.SQLArguments())
	maps.Copy(args, filter.SQLArguments())

	row := conn.QueryRow(ctx, q, args)
	var count int
	if err := row.Scan(&count); err != nil {
		return 0, fmt.Errorf("cannot scan count: %w", err)
	}

	return count, nil
}

func (p *Documents) LoadByOrganizationID(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
	organizationID gid.GID,
	cursor *page.Cursor[DocumentOrderField],
	filter *DocumentFilter,
) error {
	q := `
SELECT
	id,
    organization_id,
    owner_id,
    title,
    document_type,
    classification,
    current_published_version,
    trust_center_visibility,
    created_at,
    updated_at
FROM
    documents
WHERE
    %s
    AND deleted_at IS NULL
    AND organization_id = @organization_id
    AND %s
    AND %s
`

	q = fmt.Sprintf(q, scope.SQLFragment(), filter.SQLFragment(), cursor.SQLFragment())

	args := pgx.NamedArgs{"organization_id": organizationID}
	maps.Copy(args, scope.SQLArguments())
	maps.Copy(args, filter.SQLArguments())
	maps.Copy(args, cursor.SQLArguments())

	rows, err := conn.Query(ctx, q, args)
	if err != nil {
		return fmt.Errorf("cannot query documents: %w", err)
	}

	documents, err := pgx.CollectRows(rows, pgx.RowToAddrOfStructByName[Document])
	if err != nil {
		return fmt.Errorf("cannot collect documents: %w", err)
	}

	*p = documents

	return nil
}

func (p *Documents) LoadAllByOrganizationID(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
	organizationID gid.GID,
	filter *DocumentFilter,
) error {
	q := `
SELECT
	id,
    organization_id,
    owner_id,
    title,
    document_type,
    classification,
    current_published_version,
    trust_center_visibility,
    created_at,
    updated_at
FROM
    documents
WHERE
    %s
    AND deleted_at IS NULL
    AND organization_id = @organization_id
    AND %s
ORDER BY title ASC
`

	q = fmt.Sprintf(q, scope.SQLFragment(), filter.SQLFragment())

	args := pgx.NamedArgs{"organization_id": organizationID}
	maps.Copy(args, scope.SQLArguments())
	maps.Copy(args, filter.SQLArguments())

	rows, err := conn.Query(ctx, q, args)
	if err != nil {
		return fmt.Errorf("cannot query documents: %w", err)
	}

	documents, err := pgx.CollectRows(rows, pgx.RowToAddrOfStructByName[Document])
	if err != nil {
		return fmt.Errorf("cannot collect documents: %w", err)
	}

	*p = documents

	return nil
}

func (p Document) Insert(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
) error {
	q := `
INSERT INTO
    documents (
        tenant_id,
		id,
		organization_id,
		owner_id,
		title,
		document_type,
		classification,
		current_published_version,
		trust_center_visibility,
		created_at,
		updated_at
    )
VALUES (
    @tenant_id,
    @document_id,
    @organization_id,
    @owner_id,
    @title,
    @document_type,
    @classification,
    @current_published_version,
    @trust_center_visibility,
    @created_at,
    @updated_at
);
`

	args := pgx.StrictNamedArgs{
		"tenant_id":                 scope.GetTenantID(),
		"document_id":               p.ID,
		"organization_id":           p.OrganizationID,
		"owner_id":                  p.OwnerID,
		"title":                     p.Title,
		"document_type":             p.DocumentType,
		"classification":            p.Classification,
		"current_published_version": p.CurrentPublishedVersion,
		"trust_center_visibility":   p.TrustCenterVisibility,
		"created_at":                p.CreatedAt,
		"updated_at":                p.UpdatedAt,
	}
	_, err := conn.Exec(ctx, q, args)
	return err
}

func (p Document) SoftDelete(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
) error {
	q := `
UPDATE documents SET deleted_at = @deleted_at WHERE %s AND id = @document_id
`

	q = fmt.Sprintf(q, scope.SQLFragment())

	args := pgx.StrictNamedArgs{"document_id": p.ID, "deleted_at": time.Now()}
	maps.Copy(args, scope.SQLArguments())

	_, err := conn.Exec(ctx, q, args)
	return err
}

func (p Document) DeleteByOrganizationID(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
	organizationID gid.GID,
) error {
	q := `
DELETE FROM documents WHERE %s AND organization_id = @organization_id
`

	q = fmt.Sprintf(q, scope.SQLFragment())

	args := pgx.StrictNamedArgs{"organization_id": organizationID}
	maps.Copy(args, scope.SQLArguments())

	_, err := conn.Exec(ctx, q, args)
	return err
}

func (p *Document) Update(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
) error {
	q := `
UPDATE
	documents
SET
	title = @title,
	current_published_version = @current_published_version,
	owner_id = @owner_id,
	document_type = @document_type,
	classification = @classification,
	trust_center_visibility = @trust_center_visibility,
	updated_at = @updated_at
WHERE
	%s
	AND id = @document_id
	AND deleted_at IS NULL
`
	q = fmt.Sprintf(q, scope.SQLFragment())

	args := pgx.StrictNamedArgs{
		"document_id":               p.ID,
		"updated_at":                time.Now(),
		"title":                     p.Title,
		"current_published_version": p.CurrentPublishedVersion,
		"owner_id":                  p.OwnerID,
		"document_type":             p.DocumentType,
		"classification":            p.Classification,
		"trust_center_visibility":   p.TrustCenterVisibility,
	}
	maps.Copy(args, scope.SQLArguments())

	_, err := conn.Exec(ctx, q, args)
	if err != nil {
		return fmt.Errorf("cannot update document: %w", err)
	}

	return nil
}

func (p *Documents) CountByControlID(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
	controlID gid.GID,
	filter *DocumentFilter,
) (int, error) {
	q := `
WITH scoped_documents AS (
	SELECT *
	FROM documents
	WHERE %s
		AND deleted_at IS NULL
		AND %s
)
SELECT COUNT(scoped_documents.id)
FROM scoped_documents
INNER JOIN controls_documents cp ON scoped_documents.id = cp.document_id
WHERE cp.control_id = @control_id
`

	q = fmt.Sprintf(q, scope.SQLFragment(), filter.SQLFragment())

	args := pgx.NamedArgs{"control_id": controlID}
	maps.Copy(args, scope.SQLArguments())
	maps.Copy(args, filter.SQLArguments())

	row := conn.QueryRow(ctx, q, args)
	var count int
	if err := row.Scan(&count); err != nil {
		return 0, fmt.Errorf("cannot scan count: %w", err)
	}

	return count, nil
}

func (p *Documents) LoadByControlID(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
	controlID gid.GID,
	cursor *page.Cursor[DocumentOrderField],
	filter *DocumentFilter,
) error {
	q := `
WITH scoped_documents AS (
	SELECT *
	FROM documents
	WHERE %s
		AND deleted_at IS NULL
		AND %s
		AND %s
)
SELECT
	scoped_documents.id,
	scoped_documents.organization_id,
	scoped_documents.owner_id,
	scoped_documents.title,
	scoped_documents.document_type,
	scoped_documents.classification,
	scoped_documents.current_published_version,
	scoped_documents.trust_center_visibility,
	scoped_documents.created_at,
	scoped_documents.updated_at
FROM scoped_documents
INNER JOIN controls_documents cp ON scoped_documents.id = cp.document_id
WHERE cp.control_id = @control_id
`
	q = fmt.Sprintf(q, scope.SQLFragment(), filter.SQLFragment(), cursor.SQLFragment())

	args := pgx.NamedArgs{"control_id": controlID}
	maps.Copy(args, scope.SQLArguments())
	maps.Copy(args, filter.SQLArguments())
	maps.Copy(args, cursor.SQLArguments())

	rows, err := conn.Query(ctx, q, args)
	if err != nil {
		return fmt.Errorf("cannot query documents: %w", err)
	}

	documents, err := pgx.CollectRows(rows, pgx.RowToAddrOfStructByName[Document])
	if err != nil {
		return fmt.Errorf("cannot collect documents: %w", err)
	}

	*p = documents

	return nil
}

func (p *Documents) CountByRiskID(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
	riskID gid.GID,
	filter *DocumentFilter,
) (int, error) {
	q := `
WITH scoped_documents AS (
	SELECT *
	FROM documents
	WHERE %s
		AND deleted_at IS NULL
		AND %s
)
SELECT COUNT(scoped_documents.id)
FROM scoped_documents
INNER JOIN risks_documents rp ON scoped_documents.id = rp.document_id
WHERE rp.risk_id = @risk_id
`

	q = fmt.Sprintf(q, scope.SQLFragment(), filter.SQLFragment())

	args := pgx.NamedArgs{"risk_id": riskID}
	maps.Copy(args, scope.SQLArguments())
	maps.Copy(args, filter.SQLArguments())

	row := conn.QueryRow(ctx, q, args)
	var count int
	if err := row.Scan(&count); err != nil {
		return 0, fmt.Errorf("cannot scan count: %w", err)
	}

	return count, nil
}

func (p *Documents) LoadByRiskID(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
	riskID gid.GID,
	cursor *page.Cursor[DocumentOrderField],
	filter *DocumentFilter,
) error {
	q := `
WITH scoped_documents AS (
	SELECT *
	FROM documents
	WHERE %s
		AND deleted_at IS NULL
		AND %s
		AND %s
)
SELECT
	scoped_documents.id,
	scoped_documents.organization_id,
	scoped_documents.owner_id,
	scoped_documents.title,
	scoped_documents.document_type,
	scoped_documents.classification,
	scoped_documents.current_published_version,
	scoped_documents.trust_center_visibility,
	scoped_documents.created_at,
	scoped_documents.updated_at
FROM scoped_documents
INNER JOIN risks_documents rp ON scoped_documents.id = rp.document_id
WHERE rp.risk_id = @risk_id
`
	q = fmt.Sprintf(q, scope.SQLFragment(), filter.SQLFragment(), cursor.SQLFragment())

	args := pgx.NamedArgs{"risk_id": riskID}
	maps.Copy(args, scope.SQLArguments())
	maps.Copy(args, filter.SQLArguments())
	maps.Copy(args, cursor.SQLArguments())

	rows, err := conn.Query(ctx, q, args)
	if err != nil {
		return fmt.Errorf("cannot query documents: %w", err)
	}

	documents, err := pgx.CollectRows(rows, pgx.RowToAddrOfStructByName[Document])
	if err != nil {
		return fmt.Errorf("cannot collect documents: %w", err)
	}

	*p = documents

	return nil
}

func (p *Documents) BulkSoftDelete(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
) error {
	q := `
UPDATE documents SET deleted_at = @deleted_at WHERE %s AND id = ANY(@document_ids)
`
	q = fmt.Sprintf(q, scope.SQLFragment())

	ids := make([]gid.GID, len(*p))
	for i, doc := range *p {
		ids[i] = doc.ID
	}

	args := pgx.StrictNamedArgs{
		"document_ids": ids,
		"deleted_at":   time.Now()}
	maps.Copy(args, scope.SQLArguments())

	_, err := conn.Exec(ctx, q, args)
	return err
}

func (p *Document) IsLastSignableVersionSignedByUserEmail(
	ctx context.Context,
	conn pg.Conn,
	scope Scoper,
	documentID gid.GID,
	userEmail mail.Addr,
) (bool, error) {
	q := `
WITH last_signable_version AS (
	SELECT
		d.id AS document_id,
		d.tenant_id,
		dv.version_number,
		dvs.state
	FROM documents d
	INNER JOIN document_versions dv ON dv.document_id = d.id
	INNER JOIN document_version_signatures dvs ON dvs.document_version_id = dv.id
	INNER JOIN peoples p ON dvs.signed_by = p.id
	WHERE d.id = @document_id
		AND p.primary_email_address = @user_email
		AND dv.version_number = (
			SELECT MAX(dv2.version_number)
			FROM document_versions dv2
			INNER JOIN document_version_signatures dvs2 ON dvs2.document_version_id = dv2.id
			INNER JOIN peoples p2 ON dvs2.signed_by = p2.id
			WHERE dv2.document_id = d.id
				AND p2.primary_email_address = @user_email
		)
)
SELECT EXISTS (
	SELECT 1
	FROM last_signable_version
	WHERE %s
		AND state = 'SIGNED'
) AS signed
`

	q = fmt.Sprintf(q, scope.SQLFragment())

	args := pgx.StrictNamedArgs{
		"document_id": documentID,
		"user_email":  userEmail,
	}
	maps.Copy(args, scope.SQLArguments())

	rows, err := conn.Query(ctx, q, args)
	if err != nil {
		return false, fmt.Errorf("cannot query document signed status: %w", err)
	}

	signed, err := pgx.CollectOneRow(rows, pgx.RowTo[bool])
	if err != nil {
		return false, fmt.Errorf("cannot collect signed status: %w", err)
	}

	return signed, nil
}