rhodecode/apps/channelstream/__init__.py

# Copyright (C) 2010-2024 RhodeCode GmbH
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3
# (only), as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# This program is dual-licensed. If you wish to learn more about the
# RhodeCode Enterprise Edition, including its added features, Support services,
# and proprietary license terms, please see https://rhodecode.com/licenses/

import os

from pyramid.events import ApplicationCreated
from pyramid.settings import asbool

from rhodecode.apps._base import ADMIN_PREFIX
from rhodecode.lib.ext_json import str_json



def url_gen(request):
    registry = request.registry
    longpoll_url = registry.settings.get('channelstream.longpoll_url', '')
    ws_url = registry.settings.get('channelstream.ws_url', '')
    proxy_url = request.route_url('channelstream_proxy')
    urls = {
        'connect': request.route_path('channelstream_connect'),
        'subscribe': request.route_path('channelstream_subscribe'),
        'longpoll': longpoll_url or proxy_url,
        'ws': ws_url or proxy_url.replace('http', 'ws')
    }
    return str_json(urls)


PLUGIN_DEFINITION = {
    'name': 'channelstream',
    'config': {
        'javascript': [],
        'css': [],
        'template_hooks': {
            'plugin_init_template': 'rhodecode:templates/channelstream/plugin_init.mako'
        },
        'url_gen': url_gen,
        'static': None,
        'enabled': False,
        'server': '',
        'secret': ''
    }
}


def maybe_create_history_store(event):
    # create plugin history location
    settings = event.app.registry.settings
    history_dir = settings.get('channelstream.history.location', '')
    if history_dir and not os.path.exists(history_dir):
        os.makedirs(history_dir, 0o750)


def includeme(config):
    from rhodecode.apps.channelstream.views import ChannelstreamView

    settings = config.registry.settings
    PLUGIN_DEFINITION['config']['enabled'] = asbool(
        settings.get('channelstream.enabled'))
    PLUGIN_DEFINITION['config']['server'] = settings.get(
        'channelstream.server', '')
    PLUGIN_DEFINITION['config']['secret'] = settings.get(
        'channelstream.secret', '')
    PLUGIN_DEFINITION['config']['history.location'] = settings.get(
        'channelstream.history.location', '')
    config.register_rhodecode_plugin(
        PLUGIN_DEFINITION['name'],
        PLUGIN_DEFINITION['config']
    )
    config.add_subscriber(maybe_create_history_store, ApplicationCreated)

    config.add_route(
        name='channelstream_connect',
        pattern=ADMIN_PREFIX + '/channelstream/connect')
    config.add_view(
        ChannelstreamView,
        attr='channelstream_connect',
        route_name='channelstream_connect', renderer='json_ext')

    config.add_route(
        name='channelstream_subscribe',
        pattern=ADMIN_PREFIX + '/channelstream/subscribe')
    config.add_view(
        ChannelstreamView,
        attr='channelstream_subscribe',
        route_name='channelstream_subscribe', renderer='json_ext')

    config.add_route(
        name='channelstream_proxy',
        pattern=settings.get('channelstream.proxy_path') or '/_channelstream')