byceps/byceps

"""
byceps.blueprints.site.news.views
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:Copyright: 2014-2024 Jochen Kupperschmidt
:License: Revised BSD (see `LICENSE` file for details)
"""

from flask import abort, g

from byceps.blueprints.site.site.navigation import subnavigation_for_view
from byceps.services.news import news_item_service
from byceps.services.news.models import NewsChannelID, RenderedNewsItem
from byceps.services.site import site_service, site_setting_service
from byceps.services.site.models import SiteID
from byceps.util.authz import has_current_user_permission
from byceps.util.framework.blueprint import create_blueprint
from byceps.util.framework.templating import templated


blueprint = create_blueprint('news', __name__)


DEFAULT_ITEMS_PER_PAGE = 4
DEFAULT_HEADLINES_PER_PAGE = 25


@blueprint.get('/', defaults={'page': 1})
@blueprint.get('/pages/<int:page>')
@templated
@subnavigation_for_view('news')
def index(page):
    """Show a page of news items."""
    channel_ids = _get_channel_ids()
    items_per_page = _get_items_per_page_value()
    published_only = not _may_current_user_view_drafts()

    items = news_item_service.get_rendered_items_paginated(
        channel_ids, page, items_per_page, published_only=published_only
    )

    return {
        'items': items,
        'page': page,
        'per_page': items_per_page,
    }


@blueprint.get('/archive', defaults={'page': 1})
@blueprint.get('/archive/pages/<int:page>')
@templated
@subnavigation_for_view('news')
def archive(page):
    """Show a page of news items."""
    channel_ids = _get_channel_ids()
    items_per_page = DEFAULT_HEADLINES_PER_PAGE
    published_only = not _may_current_user_view_drafts()

    headlines = news_item_service.get_headlines_paginated(
        channel_ids, page, items_per_page, published_only=published_only
    )

    return {
        'headlines': headlines,
        'page': page,
        'per_page': items_per_page,
    }


@blueprint.get('/<slug>')
@templated
@subnavigation_for_view('news')
def view(slug):
    """Show a single news item."""
    channel_ids = _get_channel_ids()
    published_only = not _may_current_user_view_drafts()

    item = news_item_service.find_rendered_item_by_slug(
        channel_ids, slug, published_only=published_only
    )

    if item is None:
        abort(404)

    external_item_url = _get_external_url(item)

    if item.published_at:
        older_headline = news_item_service.find_latest_headline_before(
            channel_ids, item.published_at
        )
        newer_headline = news_item_service.find_oldest_headline_after(
            channel_ids, item.published_at
        )
    else:
        older_headline = None
        newer_headline = None

    return {
        'item': item,
        'external_item_url': external_item_url,
        'older_headline': older_headline,
        'newer_headline': newer_headline,
    }


def _get_channel_ids() -> frozenset[NewsChannelID] | set[NewsChannelID]:
    channel_ids = g.site.news_channel_ids
    if not channel_ids:
        abort(404)

    return channel_ids


def _get_items_per_page_value() -> int:
    items_per_page = site_setting_service.find_setting_value(
        g.site_id, 'news_items_per_page'
    )

    if items_per_page is None:
        return DEFAULT_ITEMS_PER_PAGE

    return int(items_per_page)


def _may_current_user_view_drafts() -> bool:
    return has_current_user_permission('news_item.view_draft')


def _get_external_url(item: RenderedNewsItem) -> str | None:
    announcement_site_id = item.channel.announcement_site_id
    if announcement_site_id is None:
        return None

    announcement_site = site_service.get_site(SiteID(announcement_site_id))
    return f'https://{announcement_site.server_name}/news/{item.slug}'