# Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. import logging from flask import request, Response, url_for from flask_appbuilder.api import expose, protect, safe from marshmallow import ValidationError from superset.commands.chart.exceptions import ( ChartAccessDeniedError, ChartNotFoundError, ) from superset.commands.dataset.exceptions import ( DatasetAccessDeniedError, DatasetNotFoundError, ) from superset.commands.explore.permalink.create import CreateExplorePermalinkCommand from superset.commands.explore.permalink.get import GetExplorePermalinkCommand from superset.constants import MODEL_API_RW_METHOD_PERMISSION_MAP from superset.explore.permalink.exceptions import ExplorePermalinkInvalidStateError from superset.explore.permalink.schemas import ExplorePermalinkStateSchema from superset.extensions import event_logger from superset.key_value.exceptions import KeyValueAccessDeniedError from superset.views.base_api import BaseSupersetApi, requires_json, statsd_metrics logger = logging.getLogger(__name__) class ExplorePermalinkRestApi(BaseSupersetApi): add_model_schema = ExplorePermalinkStateSchema() method_permission_name = MODEL_API_RW_METHOD_PERMISSION_MAP allow_browser_login = True class_permission_name = "ExplorePermalinkRestApi" resource_name = "explore" openapi_spec_tag = "Explore Permanent Link" openapi_spec_component_schemas = (ExplorePermalinkStateSchema,) @expose("/permalink", methods=("POST",)) @protect() @safe @statsd_metrics @event_logger.log_this_with_context( action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.post", log_to_statsd=False, ) @requires_json def post(self) -> Response: """Create a new permanent link. --- post: summary: Create a new permanent link requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExplorePermalinkStateSchema' responses: 201: description: The permanent link was stored successfully. content: application/json: schema: type: object properties: key: type: string description: The key to retrieve the permanent link data. url: type: string description: permanent link. 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 422: $ref: '#/components/responses/422' 500: $ref: '#/components/responses/500' """ try: state = self.add_model_schema.load(request.json) key = CreateExplorePermalinkCommand(state=state).run() url = url_for("ExplorePermalinkView.permalink", key=key, _external=True) return self.response(201, key=key, url=url) except ValidationError as ex: return self.response(400, message=ex.messages) except ( ChartAccessDeniedError, DatasetAccessDeniedError, KeyValueAccessDeniedError, ) as ex: return self.response(403, message=str(ex)) except (ChartNotFoundError, DatasetNotFoundError) as ex: return self.response(404, message=str(ex)) @expose("/permalink/", methods=("GET",)) @protect() @safe @statsd_metrics @event_logger.log_this_with_context( action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.get", log_to_statsd=False, ) def get(self, key: str) -> Response: """Get chart's permanent link state. --- get: summary: Get chart's permanent link state parameters: - in: path schema: type: string name: key responses: 200: description: Returns the stored form_data. content: application/json: schema: type: object properties: state: type: object description: The stored state 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 422: $ref: '#/components/responses/422' 500: $ref: '#/components/responses/500' """ try: value = GetExplorePermalinkCommand(key=key).run() if not value: return self.response_404() return self.response(200, **value) except ExplorePermalinkInvalidStateError as ex: return self.response(400, message=str(ex)) except ( ChartAccessDeniedError, DatasetAccessDeniedError, ) as ex: return self.response(403, message=str(ex)) except (ChartNotFoundError, DatasetNotFoundError) as ex: return self.response(404, message=str(ex))