Files
superset2/superset/commands/sql_lab/permalink/get.py
T

65 lines
2.7 KiB
Python

# 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 typing import Optional
from superset.commands.dataset.exceptions import DatasetNotFoundError
from superset.commands.sql_lab.permalink.base import BaseSqlLabPermalinkCommand
from superset.daos.key_value import KeyValueDAO
from superset.key_value.exceptions import (
KeyValueCodecDecodeException,
KeyValueGetFailedError,
KeyValueParseKeyError,
)
from superset.key_value.utils import decode_permalink_id
from superset.sqllab.permalink.exceptions import SqlLabPermalinkGetFailedError
from superset.sqllab.permalink.types import SqlLabPermalinkValue
logger = logging.getLogger(__name__)
class GetSqlLabPermalinkCommand(BaseSqlLabPermalinkCommand):
def __init__(self, key: str):
self.key = key
def run(self) -> Optional[SqlLabPermalinkValue]:
self.validate()
# Legacy `kv:<int>` keys (from the pre-permalink `keyvalue` table) are
# no longer resolved here: that table has sequential integer primary
# keys and no owner column, so any authenticated caller could
# enumerate other users' saved editor state (SQL text and
# connection/schema context) by incrementing the id. Such keys now
# fall through to `decode_permalink_id` below, which rejects them
# (they don't decode against the salted hashid scheme), leaving the
# modern salted-hashid store as the only way to resolve a permalink.
try:
key = decode_permalink_id(self.key, salt=self.salt)
value = KeyValueDAO.get_value(self.resource, key, self.codec)
if value:
return value
return None
except (
DatasetNotFoundError,
KeyValueCodecDecodeException,
KeyValueGetFailedError,
KeyValueParseKeyError,
) as ex:
raise SqlLabPermalinkGetFailedError(message=ex.message) from ex
def validate(self) -> None:
pass