wrolpi/modules/archive/api.py

import multiprocessing
import queue
from http import HTTPStatus

from sanic import response, Request, Blueprint
from sanic_ext import validate
from sanic_ext.extensions.openapi import openapi
from sqlalchemy.exc import IntegrityError

from wrolpi.api_utils import json_response, api_app
from wrolpi.cmd import get_installed_browsers
from wrolpi.common import logger, wrol_mode_check, api_param_limiter, TRACE_LEVEL
from wrolpi.db import get_db_session
from wrolpi.events import Events
from wrolpi.schema import JSONErrorResponse
from wrolpi.switches import register_switch_handler, ActivateSwitchMethod
from wrolpi.vars import DOCKERIZED
from . import lib, schema

NAME = 'archive'

archive_bp = Blueprint('Archive', '/api/archive')

logger = logger.getChild(__name__)


@archive_bp.get('/statistics')
@openapi.response(HTTPStatus.OK, schema.ArchiveStatisticsResponse)
async def statistics(_: Request):
    ret = await lib.get_statistics()
    return json_response(ret, HTTPStatus.OK)


@archive_bp.get('/<file_group_id:int>')
@openapi.description('Get an archive by its FileGroup ID')
@openapi.response(HTTPStatus.NOT_FOUND, JSONErrorResponse)
async def get_archive(request: Request, file_group_id: int):
    session = request.ctx.session
    skip_viewed = request.args.get('skip_viewed', '').lower() == 'true'
    archive = lib.get_archive_by_file_group_id(session, file_group_id, skip_viewed=skip_viewed)
    archive_file_group = archive.file_group.__json__()
    history = [i.file_group.__json__() for i in archive.history]
    return json_response({'file_group': archive_file_group, 'history': history})


archive_limit_limiter = api_param_limiter(100)


@archive_bp.post('/search')
@openapi.definition(
    summary='A File search with more filtering related to Archives',
    body=schema.ArchiveSearchRequest,
)
@openapi.response(HTTPStatus.OK, schema.ArchiveSearchResponse)
@openapi.response(HTTPStatus.NOT_FOUND, JSONErrorResponse)
@validate(schema.ArchiveSearchRequest)
async def search_archives(_: Request, body: schema.ArchiveSearchRequest):
    search_str = body.search_str
    domain = body.domain
    limit = archive_limit_limiter(body.limit)
    offset = body.offset or 0

    file_groups, total = lib.search_archives(search_str, domain, limit, offset, body.order_by, body.tag_names,
                                             body.headline, body.deep)
    ret = dict(file_groups=file_groups, totals=dict(file_groups=total))
    return json_response(ret)


@archive_bp.post('/file_format')
@openapi.definition(
    description='Preview the archive file format',
    body=schema.ArchiveFileFormatRequest,
)
@validate(schema.ArchiveFileFormatRequest)
async def post_file_format(_: Request, body: schema.ArchiveFileFormatRequest):
    try:
        preview = lib.preview_archive_filename(body.archive_file_format)
        return json_response(dict(
            archive_file_format=body.archive_file_format,
            preview=preview,
        ))
    except RuntimeError as e:
        return json_response(dict(
            error=str(e),
            archive_file_format=body.archive_file_format,
        ), status=HTTPStatus.BAD_REQUEST)


@archive_bp.get('/browsers')
@openapi.definition(
    summary='Get list of installed browsers that can be used for archiving.',
    description='Returns browsers installed on the system. Only available on native deployments (not Docker).',
)
async def get_browsers(_: Request):
    """Get list of installed browsers for SingleFile."""
    if DOCKERIZED:
        # Browser configuration is not available in Docker
        return json_response(dict(
            browsers=[],
            available=False,
            message='Browser configuration is not available in Docker deployments.',
        ))

    browsers = get_installed_browsers()
    return json_response(dict(
        browsers=browsers,
        available=True,
    ))


@archive_bp.get('/upload')
@openapi.definition(
    summary='A message to confirm to the user that they have the correct upload URL.'
)
async def get_upload_singlefile(request: Request):
    return response.text('This is the URL to upload files using the SingleFile browser extension.'
                         ' This requires a POST request.')


@register_switch_handler('singlefile_upload_switch_handler')
async def singlefile_upload_switch_handler(url=None):
    """Used by `post_upload_singlefile` to upload a single file"""
    # Local imports to avoid circular import: downloader -> archive -> api -> downloader
    from wrolpi.downloader import Download
    from wrolpi.files.models import FileGroup
    from wrolpi.tags import Tag
    from . import ArchiveDownloader

    q: multiprocessing.Queue = api_app.shared_ctx.archive_singlefiles

    trace_enabled = __debug__ and logger.isEnabledFor(TRACE_LEVEL)
    if trace_enabled:
        logger.trace(f'singlefile_upload_switch_handler called for {url}')
    try:
        payload = q.get_nowait()
    except queue.Empty:
        if trace_enabled:
            logger.trace(f'singlefile_upload_switch_handler called on empty queue')
        return

    # Payload is (singlefile_bytes, tag_names) tuple. Older callers may have put raw bytes;
    # tolerate that shape so an in-flight queue across an upgrade does not crash.
    if isinstance(payload, tuple):
        singlefile, tag_names = payload
    else:
        singlefile, tag_names = payload, []

    try:
        q_size = q.qsize()
    except NotImplementedError:
        # qsize() is not implemented on macOS
        q_size = '?'
    logger.info(f'singlefile_upload_switch_handler queue size: {q_size}')

    try:
        # Get URL from singlefile to determine destination
        url = lib.get_url_from_singlefile(singlefile)

        # Get/create domain collection and get/set its directory
        destination = None
        with get_db_session(commit=True) as session:
            collection = lib.get_or_create_domain_collection(session, url)
            if collection:
                destination = collection.get_or_set_directory(session)

        archive = await lib.singlefile_to_archive(singlefile, destination=destination)
    except Exception as e:
        logger.error(f'singlefile_upload_switch_handler failed', exc_info=e)
        Events.send_upload_archive_failed(f'Failed to convert singlefile to archive: {e}')
        raise

    if tag_names:
        # Apply tags to the new FileGroup. Auto-create unknown tag names so any
        # API caller (the browser extension does not, but third-party callers
        # might) can introduce a new tag at upload time.
        #
        # Each tag insert sits inside a SAVEPOINT so a concurrent caller
        # racing on the same novel name (Tag.name has unique=True) doesn't
        # abort the whole transaction — the loser of the race rolls back its
        # own savepoint, set_tags() re-resolves the name, and finds the row
        # the winner just committed.
        file_group_id = archive.file_group.id
        with get_db_session(commit=True) as session:
            for name in tag_names:
                if Tag.get_by_name(session, name):
                    continue
                try:
                    with session.begin_nested():
                        session.add(Tag(name=name))
                        session.flush()
                except IntegrityError:
                    # Another writer created the tag first. Tag.name's unique
                    # constraint did its job; set_tags() below will find it.
                    pass
            fg = session.query(FileGroup).filter_by(id=file_group_id).one()
            fg.set_tags(session, list(tag_names))

    name = archive.file_group.title or archive.file_group.url
    logger.info(f'Created Archive from upload ({q_size}): {archive}')
    Events.send_archive_uploaded(f'Created Archive from upload: {name}', url=archive.location)
    url = archive.file_group.url
    with get_db_session(commit=True) as session:
        if url and (download := Download.get_by_url(session, url)):
            if (download.is_failed or download.is_deferred) and download.downloader == ArchiveDownloader.name:
                # Download was attempted and failed, user manually archived the URL.
                download.complete()
                download.location = archive.location

    # Call this function again so any new singlefiles can be archived.
    singlefile_upload_switch_handler.activate_switch()


singlefile_upload_switch_handler: ActivateSwitchMethod


@register_switch_handler('generate_screenshot_switch_handler')
async def generate_screenshot_switch_handler(archive_id=None):
    """Used by `post_generate_screenshot` to generate screenshots in the background"""
    q: multiprocessing.Queue = api_app.shared_ctx.archive_screenshots

    trace_enabled = __debug__ and logger.isEnabledFor(TRACE_LEVEL)
    if trace_enabled:
        logger.trace(f'generate_screenshot_switch_handler called for archive_id={archive_id}')
    try:
        archive_id = q.get_nowait()
    except queue.Empty:
        if trace_enabled:
            logger.trace(f'generate_screenshot_switch_handler called on empty queue')
        return

    try:
        q_size = q.qsize()
    except NotImplementedError:
        # qsize() is not implemented on macOS
        q_size = '?'
    logger.info(f'generate_screenshot_switch_handler queue size: {q_size}')

    try:
        await lib.generate_archive_screenshot(archive_id)
        # Always send success event since exceptions are raised on failure
        with get_db_session() as session:
            archive = lib.get_archive(session, archive_id)
            location = archive.location
            name = archive.file_group.title or archive.file_group.url
        logger.info(f'Generated screenshot for Archive ({q_size}): {archive_id}')
        Events.send_screenshot_generated(f'Generated screenshot for: {name}', url=location)
    except Exception as e:
        logger.error(f'generate_screenshot_switch_handler failed for Archive {archive_id}', exc_info=e)
        Events.send_screenshot_generation_failed(f'Failed to generate screenshot: {e}')
        raise

    # Call this function again so any new screenshot requests can be processed.
    generate_screenshot_switch_handler.activate_switch()


generate_screenshot_switch_handler: ActivateSwitchMethod


@archive_bp.post('/upload')
@openapi.definition(
    summary='Upload SingleFile from SingleFile browser extension and convert it to an Archive.'
)
async def post_upload_singlefile(request: Request):
    url = request.form['url'][0]
    singlefile = request.files['singlefile_contents'][0].body
    # Optional repeated form field; matches the convention used by /api/files/upload.
    tag_names = [str(i) for i in (request.form.getlist('tagNames') or [])]
    logger.info(f'Got Archive upload of {len(singlefile)} bytes for URL: {url} '
                f'with {len(tag_names)} tag(s)')

    # Extract the URL to ensure that the singlefile is valid.
    lib.get_url_from_singlefile(singlefile)

    # Send processing to background task so the extension can continue.
    api_app.shared_ctx.archive_singlefiles.put((singlefile, tag_names))
    singlefile_upload_switch_handler.activate_switch(context=dict(url=url))
    # Return empty json response because SingleFile extension expects a JSON response.
    return json_response(dict(), status=HTTPStatus.OK)


@archive_bp.post('/<file_group_id:int>/generate_screenshot')
@openapi.description('Generate a screenshot for an Archive that does not have one')
@openapi.response(HTTPStatus.OK, description='Screenshot generation queued')
@openapi.response(HTTPStatus.NOT_FOUND, JSONErrorResponse)
@openapi.response(HTTPStatus.BAD_REQUEST, JSONErrorResponse)
@wrol_mode_check
async def post_generate_screenshot(request: Request, file_group_id: int):
    """Queue a screenshot generation request for an Archive."""
    session = request.ctx.session
    # Verify archive exists
    try:
        archive = lib.get_archive_by_file_group_id(session, file_group_id)
    except Exception:
        return json_response({'error': f'Archive with FileGroup {file_group_id} not found'}, status=HTTPStatus.NOT_FOUND)

    if not archive.singlefile_path:
        return json_response({'error': 'Archive has no singlefile'}, status=HTTPStatus.BAD_REQUEST)

    # Queue the screenshot generation request using internal archive ID
    archive_id = archive.id
    logger.info(f'Queueing screenshot generation for Archive {archive_id}')
    api_app.shared_ctx.archive_screenshots.put(archive_id)
    generate_screenshot_switch_handler.activate_switch(context=dict(archive_id=archive_id))

    return json_response({'message': 'Screenshot generation queued'}, status=HTTPStatus.OK)