master
/ .localenv / lib / python3.5 / site-packages / jupyterlab_launcher / settings_handler.py

settings_handler.py @master

4d078e2
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
"""Tornado handlers for frontend config storage."""

# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.
import json
import os
from jsonschema import ValidationError
from jsonschema import Draft4Validator as Validator
from tornado import web
from .json_minify import json_minify

from notebook.base.handlers import APIHandler, json_errors


_file_extension = '.jupyterlab-settings'


class SettingsHandler(APIHandler):

    def initialize(self, app_settings_dir, schemas_dir, settings_dir):
        self.schemas_dir = schemas_dir
        self.settings_dir = settings_dir
        self.overrides = dict()
        overrides_file = os.path.join(app_settings_dir, 'overrides.json')
        if os.path.exists(overrides_file):
            with open(overrides_file) as fid:
                try:
                    self.overrides = json.load(fid)
                except Exception as e:
                    self.log.warn(str(e))

    @json_errors
    @web.authenticated
    def get(self, section_name):
        self.set_header('Content-Type', 'application/json')

        schema = _get_schema(self.schemas_dir, section_name, self.overrides)
        path = _path(self.settings_dir, section_name, _file_extension)
        raw = '{}'
        settings = dict()

        if os.path.exists(path):
            with open(path) as fid:
                # Attempt to load and parse the settings file.
                try:
                    raw = fid.read() or raw
                    settings = json.loads(json_minify(raw))
                except Exception as e:
                    self.log.warn(str(e))

        # Validate the parsed data against the schema.
        if len(settings):
            validator = Validator(schema)
            try:
                validator.validate(settings)
            except ValidationError as e:
                self.log.warn(str(e))
                raw = '{}'

        # Send back the raw data to the client.
        resp = dict(id=section_name, raw=raw, schema=schema)

        self.finish(json.dumps(resp))

    @json_errors
    @web.authenticated
    def put(self, section_name):
        if not self.settings_dir:
            raise web.HTTPError(404, 'No current settings directory')

        raw = self.request.body.strip().decode(u'utf-8')

        # Validate the data against the schema.
        schema = _get_schema(self.schemas_dir, section_name, self.overrides)
        validator = Validator(schema)
        try:
            validator.validate(json.loads(json_minify(raw)))
        except ValidationError as e:
            raise web.HTTPError(400, str(e))

        # Write the raw data (comments included) to a file.
        path = _path(self.settings_dir, section_name, _file_extension, True)
        with open(path, 'w') as fid:
            fid.write(raw)

        self.set_status(204)


def _get_schema(schemas_dir, section_name, overrides):
    """Retrieve and parse a JSON schema."""

    path = _path(schemas_dir, section_name)

    if not os.path.exists(path):
        raise web.HTTPError(404, 'Schema not found: %r' % path)

    with open(path) as fid:
        # Attempt to load the schema file.
        try:
            schema = json.load(fid)
        except Exception as e:
            name = section_name
            message = 'Failed parsing schema ({}): {}'.format(name, str(e))
            raise web.HTTPError(500, message)

    # Override default values in the schema if necessary.
    if section_name in overrides:
        defaults = overrides[section_name]
        for key in defaults:
            if key in schema['properties']:
                schema['properties'][key]['default'] = defaults[key]
            else:
                schema['properties'][key] = dict(default=defaults[key])

    # Validate the schema.
    try:
        Validator.check_schema(schema)
    except Exception as e:
        name = section_name
        message = 'Failed validating schema ({}): {}'.format(name, str(e))
        raise web.HTTPError(500, message)

    return schema


def _path(root_dir, section_name, file_extension='.json', make_dirs=False):
    """Parse the URL section name and find the local file system path."""

    parent_dir = root_dir

    # Try to parse path, e.g. @jupyterlab/apputils-extension:themes.
    try:
        package_dir, plugin = section_name.split(':')
        parent_dir = os.path.join(root_dir, package_dir)
        path = os.path.join(parent_dir, plugin + file_extension)
    except Exception:
        message = 'Settings not found ({})'.format(section_name)
        raise web.HTTPError(404, message)

    if make_dirs and not os.path.exists(parent_dir):
        try:
            os.makedirs(parent_dir)
        except Exception as e:
            name = section_name
            message = 'Failed writing settings ({}): {}'.format(name, str(e))
            raise web.HTTPError(500, message)

    return path