| # 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 json |
| import logging |
| from typing import Any, Dict, List, Optional |
| |
| from flask_appbuilder.models.sqla import Model |
| from marshmallow import ValidationError |
| |
| from superset import security_manager |
| from superset.commands.base import BaseCommand, UpdateMixin |
| from superset.commands.utils import populate_roles |
| from superset.dao.exceptions import DAOUpdateFailedError |
| from superset.dashboards.commands.exceptions import ( |
| DashboardForbiddenError, |
| DashboardInvalidError, |
| DashboardNotFoundError, |
| DashboardSlugExistsValidationError, |
| DashboardUpdateFailedError, |
| ) |
| from superset.dashboards.dao import DashboardDAO |
| from superset.exceptions import SupersetSecurityException |
| from superset.extensions import db |
| from superset.models.dashboard import Dashboard |
| |
| logger = logging.getLogger(__name__) |
| |
| |
| class UpdateDashboardCommand(UpdateMixin, BaseCommand): |
| def __init__(self, model_id: int, data: Dict[str, Any]): |
| self._model_id = model_id |
| self._properties = data.copy() |
| self._model: Optional[Dashboard] = None |
| |
| def run(self) -> Model: |
| self.validate() |
| try: |
| dashboard = DashboardDAO.update(self._model, self._properties, commit=False) |
| dashboard = DashboardDAO.update_charts_owners(dashboard, commit=False) |
| if self._properties.get("json_metadata"): |
| dashboard = DashboardDAO.set_dash_metadata( |
| dashboard, |
| data=json.loads(self._properties.get("json_metadata", "{}")), |
| commit=False, |
| ) |
| db.session.commit() |
| except DAOUpdateFailedError as ex: |
| logger.exception(ex.exception) |
| raise DashboardUpdateFailedError() from ex |
| return dashboard |
| |
| def validate(self) -> None: |
| exceptions: List[ValidationError] = [] |
| owners_ids: Optional[List[int]] = self._properties.get("owners") |
| roles_ids: Optional[List[int]] = self._properties.get("roles") |
| slug: Optional[str] = self._properties.get("slug") |
| |
| # Validate/populate model exists |
| self._model = DashboardDAO.find_by_id(self._model_id) |
| if not self._model: |
| raise DashboardNotFoundError() |
| # Check ownership |
| try: |
| security_manager.raise_for_ownership(self._model) |
| except SupersetSecurityException as ex: |
| raise DashboardForbiddenError() from ex |
| |
| # Validate slug uniqueness |
| if not DashboardDAO.validate_update_slug_uniqueness(self._model_id, slug): |
| exceptions.append(DashboardSlugExistsValidationError()) |
| |
| # Validate/Populate owner |
| if owners_ids is None: |
| owners_ids = [owner.id for owner in self._model.owners] |
| try: |
| owners = self.populate_owners(owners_ids) |
| self._properties["owners"] = owners |
| except ValidationError as ex: |
| exceptions.append(ex) |
| if exceptions: |
| exception = DashboardInvalidError() |
| exception.add_list(exceptions) |
| raise exception |
| |
| # Validate/Populate role |
| if roles_ids is None: |
| roles_ids = [role.id for role in self._model.roles] |
| try: |
| roles = populate_roles(roles_ids) |
| self._properties["roles"] = roles |
| except ValidationError as ex: |
| exceptions.append(ex) |
| if exceptions: |
| exception = DashboardInvalidError() |
| exception.add_list(exceptions) |
| raise exception |