#############################################################################
# Copyright (c) 2018, Voilà Contributors                                    #
# Copyright (c) 2018, QuantStack                                            #
#                                                                           #
# Distributed under the terms of the BSD 3-Clause License.                  #
#                                                                           #
# The full license is in the file LICENSE, distributed with this software.  #
#############################################################################

import gettext
import os
from typing import Optional

from jinja2 import Environment, FileSystemLoader
from jupyter_server.base.handlers import FileFindHandler, path_regex
from jupyter_server.utils import url_path_join
from jupyterlab_server.themes_handler import ThemesHandler
from jupyter_core.paths import jupyter_config_path
from jupyter_server.serverapp import ServerApp

from .tornado.execution_request_handler import ExecutionRequestHandler, JUPYTER_SERVER_2
from .tornado.contentshandler import VoilaContentsHandler
from traitlets.config import (
    JSONFileConfigLoader,
    PyFileConfigLoader,
    Config,
    ConfigFileNotFound,
)
from .configuration import VoilaConfiguration
from .tornado.handler import TornadoVoilaHandler
from .paths import ROOT, collect_static_paths, collect_template_paths
from .shutdown_kernel_handler import VoilaShutdownKernelHandler
from .static_file_handler import (
    MultiStaticFileHandler,
    TemplateStaticFileHandler,
    AllowListFileHandler,
)
from .tornado.treehandler import TornadoVoilaTreeHandler
from .utils import (
    get_data_dir,
    get_server_root_dir,
    pjoin,
    get_voila_labextensions_path,
)

_kernel_id_regex = r"(?P<kernel_id>\w+-\w+-\w+-\w+-\w+)"


def _jupyter_server_extension_points():
    """
    Returns a list of dictionaries with metadata describing
    where to find the `_load_jupyter_server_extension` function.
    """
    return [{"module": "voila.server_extension"}]


def load_config_file() -> Optional[Config]:
    """
    Loads voila.json and voila.py config file from current working
    directory and other Jupyter paths
    """

    new_config = None
    base_file_name = "voila"
    config_file_paths = [*jupyter_config_path(), os.getcwd()]

    for current in config_file_paths:
        py_loader = PyFileConfigLoader(filename=f"{base_file_name}.py", path=current)
        try:
            py_config = py_loader.load_config()

            if new_config is None:
                new_config = Config()

            new_config.merge(py_config)
        except ConfigFileNotFound:
            pass

        json_loader = JSONFileConfigLoader(
            filename=f"{base_file_name}.json", path=current
        )
        try:
            json_config = json_loader.load_config()

            if new_config is None:
                new_config = Config()

            new_config.merge(json_config)
        except ConfigFileNotFound:
            pass

    return new_config


def _load_jupyter_server_extension(server_app: ServerApp):
    web_app = server_app.web_app
    # common configuration options between the server extension and the application

    voila_configuration = VoilaConfiguration(parent=server_app)

    local_config = load_config_file()
    if local_config is not None:
        voila_configuration.update_config(local_config)

    template_name = voila_configuration.template
    template_paths = collect_template_paths(["voila", "nbconvert"], template_name)
    static_paths = collect_static_paths(["voila", "nbconvert"], template_name)

    jenv_opt = {"autoescape": True}
    env = Environment(
        loader=FileSystemLoader(template_paths),
        extensions=["jinja2.ext.i18n"],
        **jenv_opt,
    )
    web_app.settings["voila_jinja2_env"] = env

    nbui = gettext.translation(
        "nbui", localedir=os.path.join(ROOT, "i18n"), fallback=True
    )
    env.install_gettext_translations(nbui, newstyle=False)

    host_pattern = ".*$"
    base_url = url_path_join(web_app.settings["base_url"])

    tree_handler_conf = {"voila_configuration": voila_configuration}

    themes_dir = pjoin(get_data_dir(), "themes")
    labextensions_path = get_voila_labextensions_path(
        voila_configuration.extra_labextensions_path
    )

    handlers = [
        (
            url_path_join(base_url, "/voila/render/(.*)"),
            TornadoVoilaHandler,
            {
                "config": server_app.config,
                "template_paths": template_paths,
                "voila_configuration": voila_configuration,
            },
        ),
        (
            url_path_join(base_url, "/voila"),
            TornadoVoilaTreeHandler,
            tree_handler_conf,
        ),
        (
            url_path_join(base_url, "/voila/tree" + path_regex),
            TornadoVoilaTreeHandler,
            tree_handler_conf,
        ),
        (
            url_path_join(base_url, "/voila/templates/(.*)"),
            TemplateStaticFileHandler,
        ),
        (
            url_path_join(base_url, r"/voila/api/themes/(.*)"),
            ThemesHandler,
            {
                "themes_url": "/voila/api/themes",
                "path": themes_dir,
                "labextensions_path": labextensions_path,
                "no_cache_paths": ["/"],
            },
        ),
        (
            url_path_join(base_url, "/voila/static/(.*)"),
            MultiStaticFileHandler,
            {"paths": static_paths},
        ),
        (
            url_path_join(base_url, r"/voila/api/shutdown/(.*)"),
            VoilaShutdownKernelHandler,
        ),
        (
            url_path_join(base_url, r"/voila/files/(.*)"),
            AllowListFileHandler,
            {
                "allowlist": voila_configuration.file_allowlist,
                "denylist": voila_configuration.file_denylist,
                "path": os.path.expanduser(get_server_root_dir(web_app.settings)),
            },
        ),
        (
            url_path_join(base_url, r"/voila/api/contents%s" % path_regex),
            VoilaContentsHandler,
            tree_handler_conf,
        ),
    ]
    if JUPYTER_SERVER_2 and voila_configuration.progressive_rendering:
        handlers.append(
            (
                url_path_join(base_url, r"/voila/execution/%s" % _kernel_id_regex),
                ExecutionRequestHandler,
            )
        )
    web_app.add_handlers(host_pattern, handlers)

    web_app.add_handlers(
        host_pattern,
        [
            (
                # TODO: update handler
                url_path_join(base_url, r"/voila/labextensions/(.*)"),
                FileFindHandler,
                {
                    "path": labextensions_path,
                    "no_cache_paths": ["/"],  # don't cache anything
                },
            )
        ],
    )


# For backward compatibility
load_jupyter_server_extension = _load_jupyter_server_extension