superset/charts/filters.py
# 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.
from typing import Any
from flask_babel import lazy_gettext as _
from sqlalchemy import and_, or_
from sqlalchemy.orm import aliased
from sqlalchemy.orm.query import Query
from superset import db, security_manager
from superset.connectors.sqla import models
from superset.connectors.sqla.models import SqlaTable
from superset.models.core import FavStar
from superset.models.slice import Slice
from superset.tags.filters import BaseTagIdFilter, BaseTagNameFilter
from superset.utils.core import get_user_id
from superset.utils.filters import get_dataset_access_filters
from superset.views.base import BaseFilter
from superset.views.base_api import BaseFavoriteFilter
class ChartAllTextFilter(BaseFilter): # pylint: disable=too-few-public-methods
name = _("All Text")
arg_name = "chart_all_text"
def apply(self, query: Query, value: Any) -> Query:
if not value:
return query
ilike_value = f"%{value}%"
return query.filter(
or_(
Slice.slice_name.ilike(ilike_value),
Slice.description.ilike(ilike_value),
Slice.viz_type.ilike(ilike_value),
SqlaTable.table_name.ilike(ilike_value),
)
)
class ChartFavoriteFilter(BaseFavoriteFilter): # pylint: disable=too-few-public-methods
"""
Custom filter for the GET list that filters all charts that a user has favored
"""
arg_name = "chart_is_favorite"
class_name = "slice"
model = Slice
class ChartTagNameFilter(BaseTagNameFilter): # pylint: disable=too-few-public-methods
"""
Custom filter for the GET list that filters all charts associated with
a certain tag (by its name).
"""
arg_name = "chart_tags"
class_name = "slice"
model = Slice
class ChartTagIdFilter(BaseTagIdFilter): # pylint: disable=too-few-public-methods
"""
Custom filter for the GET list that filters all charts associated with
a certain tag (by its ID).
"""
arg_name = "chart_tag_id"
class_name = "slice"
model = Slice
class ChartCertifiedFilter(BaseFilter): # pylint: disable=too-few-public-methods
"""
Custom filter for the GET list that filters all certified charts
"""
name = _("Is certified")
arg_name = "chart_is_certified"
def apply(self, query: Query, value: Any) -> Query:
if value is True:
return query.filter(and_(Slice.certified_by.isnot(None)))
if value is False:
return query.filter(and_(Slice.certified_by.is_(None)))
return query
class ChartFilter(BaseFilter): # pylint: disable=too-few-public-methods
def apply(self, query: Query, value: Any) -> Query:
if security_manager.can_access_all_datasources():
return query
table_alias = aliased(SqlaTable)
query = query.join(table_alias, self.model.datasource_id == table_alias.id)
query = query.join(
models.Database, table_alias.database_id == models.Database.id
)
return query.filter(get_dataset_access_filters(self.model))
class ChartHasCreatedByFilter(BaseFilter): # pylint: disable=too-few-public-methods
"""
Custom filter for the GET list that filters all charts created by user
"""
name = _("Has created by")
arg_name = "chart_has_created_by"
def apply(self, query: Query, value: Any) -> Query:
if value is True:
return query.filter(and_(Slice.created_by_fk.isnot(None)))
if value is False:
return query.filter(and_(Slice.created_by_fk.is_(None)))
return query
class ChartCreatedByMeFilter(BaseFilter): # pylint: disable=too-few-public-methods
name = _("Created by me")
arg_name = "chart_created_by_me"
def apply(self, query: Query, value: Any) -> Query:
return query.filter(
or_(
Slice.created_by_fk # pylint: disable=comparison-with-callable
== get_user_id(),
Slice.changed_by_fk # pylint: disable=comparison-with-callable
== get_user_id(),
)
)
class ChartOwnedCreatedFavoredByMeFilter(BaseFilter): # pylint: disable=too-few-public-methods
"""
Custom filter for the GET chart that filters all charts the user
owns, created, changed or favored.
"""
name = _("Owned Created or Favored")
arg_name = "chart_owned_created_favored_by_me"
def apply(self, query: Query, value: Any) -> Query:
# If anonymous user filter nothing
if security_manager.current_user is None:
return query
owner_ids_query = (
db.session.query(Slice.id)
.join(Slice.owners)
.filter(security_manager.user_model.id == get_user_id())
)
return query.join(
FavStar,
and_(
FavStar.user_id == get_user_id(),
FavStar.class_name == "slice",
Slice.id == FavStar.obj_id,
),
isouter=True,
).filter(
# pylint: disable=comparison-with-callable
or_(
Slice.id.in_(owner_ids_query),
Slice.created_by_fk == get_user_id(),
Slice.changed_by_fk == get_user_id(),
FavStar.user_id == get_user_id(),
)
)