mirror of
https://github.com/apache/superset.git
synced 2024-09-12 16:49:40 -04:00
319 lines
8.8 KiB
Python
319 lines
8.8 KiB
Python
"""Utility functions used across Caravel"""
|
|
from __future__ import absolute_import
|
|
from __future__ import division
|
|
from __future__ import print_function
|
|
from __future__ import unicode_literals
|
|
|
|
from datetime import datetime
|
|
import decimal
|
|
import functools
|
|
import json
|
|
import logging
|
|
import numpy
|
|
import time
|
|
|
|
import parsedatetime
|
|
import sqlalchemy as sa
|
|
from dateutil.parser import parse
|
|
from flask import flash, Markup
|
|
from flask_appbuilder.security.sqla import models as ab_models
|
|
from markdown import markdown as md
|
|
from sqlalchemy.types import TypeDecorator, TEXT
|
|
|
|
|
|
class CaravelException(Exception):
|
|
pass
|
|
|
|
|
|
class CaravelSecurityException(CaravelException):
|
|
pass
|
|
|
|
|
|
class MetricPermException(Exception):
|
|
pass
|
|
|
|
|
|
def flasher(msg, severity=None):
|
|
"""Flask's flash if available, logging call if not"""
|
|
try:
|
|
flash(msg, severity)
|
|
except RuntimeError:
|
|
if severity == 'danger':
|
|
logging.error(msg)
|
|
else:
|
|
logging.info(msg)
|
|
|
|
|
|
class memoized(object): # noqa
|
|
|
|
"""Decorator that caches a function's return value each time it is called
|
|
|
|
If called later with the same arguments, the cached value is returned, and
|
|
not re-evaluated.
|
|
"""
|
|
|
|
def __init__(self, func):
|
|
self.func = func
|
|
self.cache = {}
|
|
|
|
def __call__(self, *args):
|
|
try:
|
|
return self.cache[args]
|
|
except KeyError:
|
|
value = self.func(*args)
|
|
self.cache[args] = value
|
|
return value
|
|
except TypeError:
|
|
# uncachable -- for instance, passing a list as an argument.
|
|
# Better to not cache than to blow up entirely.
|
|
return self.func(*args)
|
|
|
|
def __repr__(self):
|
|
"""Return the function's docstring."""
|
|
return self.func.__doc__
|
|
|
|
def __get__(self, obj, objtype):
|
|
"""Support instance methods."""
|
|
return functools.partial(self.__call__, obj)
|
|
|
|
|
|
def list_minus(l, minus):
|
|
"""Returns l without what is in minus
|
|
|
|
>>> list_minus([1, 2, 3], [2])
|
|
[1, 3]
|
|
"""
|
|
return [o for o in l if o not in minus]
|
|
|
|
|
|
def parse_human_datetime(s):
|
|
"""
|
|
Returns ``datetime.datetime`` from human readable strings
|
|
|
|
>>> from datetime import date, timedelta
|
|
>>> from dateutil.relativedelta import relativedelta
|
|
>>> parse_human_datetime('2015-04-03')
|
|
datetime.datetime(2015, 4, 3, 0, 0)
|
|
>>> parse_human_datetime('2/3/1969')
|
|
datetime.datetime(1969, 2, 3, 0, 0)
|
|
>>> parse_human_datetime("now") <= datetime.now()
|
|
True
|
|
>>> parse_human_datetime("yesterday") <= datetime.now()
|
|
True
|
|
>>> date.today() - timedelta(1) == parse_human_datetime('yesterday').date()
|
|
True
|
|
>>> year_ago_1 = parse_human_datetime('one year ago').date()
|
|
>>> year_ago_2 = (datetime.now() - relativedelta(years=1) ).date()
|
|
>>> year_ago_1 == year_ago_2
|
|
True
|
|
"""
|
|
try:
|
|
dttm = parse(s)
|
|
except Exception:
|
|
try:
|
|
cal = parsedatetime.Calendar()
|
|
dttm = dttm_from_timtuple(cal.parse(s)[0])
|
|
except Exception as e:
|
|
logging.exception(e)
|
|
raise ValueError("Couldn't parse date string [{}]".format(s))
|
|
return dttm
|
|
|
|
|
|
def dttm_from_timtuple(d):
|
|
return datetime(
|
|
d.tm_year, d.tm_mon, d.tm_mday, d.tm_hour, d.tm_min, d.tm_sec)
|
|
|
|
|
|
def merge_perm(sm, permission_name, view_menu_name):
|
|
pv = sm.find_permission_view_menu(permission_name, view_menu_name)
|
|
if not pv:
|
|
sm.add_permission_view_menu(permission_name, view_menu_name)
|
|
|
|
|
|
def parse_human_timedelta(s):
|
|
"""
|
|
Returns ``datetime.datetime`` from natural language time deltas
|
|
|
|
>>> parse_human_datetime("now") <= datetime.now()
|
|
True
|
|
"""
|
|
cal = parsedatetime.Calendar()
|
|
dttm = dttm_from_timtuple(datetime.now().timetuple())
|
|
d = cal.parse(s, dttm)[0]
|
|
d = datetime(
|
|
d.tm_year, d.tm_mon, d.tm_mday, d.tm_hour, d.tm_min, d.tm_sec)
|
|
return d - dttm
|
|
|
|
|
|
class JSONEncodedDict(TypeDecorator):
|
|
|
|
"""Represents an immutable structure as a json-encoded string."""
|
|
|
|
impl = TEXT
|
|
|
|
def process_bind_param(self, value, dialect):
|
|
if value is not None:
|
|
value = json.dumps(value)
|
|
|
|
return value
|
|
|
|
def process_result_value(self, value, dialect):
|
|
if value is not None:
|
|
value = json.loads(value)
|
|
return value
|
|
|
|
|
|
def init(caravel):
|
|
"""Inits the Caravel application with security roles and such"""
|
|
db = caravel.db
|
|
models = caravel.models
|
|
sm = caravel.appbuilder.sm
|
|
alpha = sm.add_role("Alpha")
|
|
admin = sm.add_role("Admin")
|
|
config = caravel.app.config
|
|
|
|
merge_perm(sm, 'all_datasource_access', 'all_datasource_access')
|
|
|
|
perms = db.session.query(ab_models.PermissionView).all()
|
|
for perm in perms:
|
|
if perm.permission.name == 'datasource_access':
|
|
continue
|
|
if perm.view_menu and perm.view_menu.name not in (
|
|
'UserDBModelView', 'RoleModelView', 'ResetPasswordView',
|
|
'Security'):
|
|
sm.add_permission_role(alpha, perm)
|
|
sm.add_permission_role(admin, perm)
|
|
gamma = sm.add_role("Gamma")
|
|
public_role = sm.find_role("Public")
|
|
public_role_like_gamma = \
|
|
public_role and config.get('PUBLIC_ROLE_LIKE_GAMMA', False)
|
|
for perm in perms:
|
|
if (
|
|
perm.view_menu and perm.view_menu.name not in (
|
|
'ResetPasswordView',
|
|
'RoleModelView',
|
|
'UserDBModelView',
|
|
'Security') and
|
|
perm.permission.name not in (
|
|
'all_datasource_access',
|
|
'can_add',
|
|
'can_download',
|
|
'can_delete',
|
|
'can_edit',
|
|
'can_save',
|
|
'datasource_access',
|
|
'muldelete',
|
|
)):
|
|
sm.add_permission_role(gamma, perm)
|
|
if public_role_like_gamma:
|
|
sm.add_permission_role(public_role, perm)
|
|
session = db.session()
|
|
table_perms = [
|
|
table.perm for table in session.query(models.SqlaTable).all()]
|
|
table_perms += [
|
|
table.perm for table in session.query(models.DruidDatasource).all()]
|
|
for table_perm in table_perms:
|
|
merge_perm(sm, 'datasource_access', table_perm)
|
|
|
|
init_metrics_perm(caravel)
|
|
|
|
|
|
def init_metrics_perm(caravel, metrics=None):
|
|
db = caravel.db
|
|
models = caravel.models
|
|
sm = caravel.appbuilder.sm
|
|
|
|
if metrics is None:
|
|
metrics = []
|
|
for model in [models.SqlMetric, models.DruidMetric]:
|
|
metrics += list(db.session.query(model).all())
|
|
|
|
metric_perms = filter(None, [metric.perm for metric in metrics])
|
|
for metric_perm in metric_perms:
|
|
merge_perm(sm, 'metric_access', metric_perm)
|
|
|
|
|
|
def datetime_f(dttm):
|
|
"""Formats datetime to take less room when it is recent"""
|
|
if dttm:
|
|
dttm = dttm.isoformat()
|
|
now_iso = datetime.now().isoformat()
|
|
if now_iso[:10] == dttm[:10]:
|
|
dttm = dttm[11:]
|
|
elif now_iso[:4] == dttm[:4]:
|
|
dttm = dttm[5:]
|
|
return "<nobr>{}</nobr>".format(dttm)
|
|
|
|
|
|
def base_json_conv(obj):
|
|
|
|
if isinstance(obj, numpy.int64):
|
|
return int(obj)
|
|
elif isinstance(obj, set):
|
|
return list(obj)
|
|
elif isinstance(obj, decimal.Decimal):
|
|
return float(obj)
|
|
|
|
|
|
def json_iso_dttm_ser(obj):
|
|
"""
|
|
json serializer that deals with dates
|
|
|
|
>>> dttm = datetime(1970, 1, 1)
|
|
>>> json.dumps({'dttm': dttm}, default=json_iso_dttm_ser)
|
|
'{"dttm": "1970-01-01T00:00:00"}'
|
|
"""
|
|
val = base_json_conv(obj)
|
|
if val is not None:
|
|
return val
|
|
if isinstance(obj, datetime):
|
|
obj = obj.isoformat()
|
|
else:
|
|
raise TypeError(
|
|
"Unserializable object {} of type {}".format(obj, type(obj))
|
|
)
|
|
return obj
|
|
|
|
|
|
def json_int_dttm_ser(obj):
|
|
"""json serializer that deals with dates"""
|
|
val = base_json_conv(obj)
|
|
if val is not None:
|
|
return val
|
|
if isinstance(obj, datetime):
|
|
obj = int(time.mktime(obj.timetuple())) * 1000
|
|
else:
|
|
raise TypeError(
|
|
"Unserializable object {} of type {}".format(obj, type(obj))
|
|
)
|
|
return obj
|
|
|
|
|
|
def markdown(s, markup_wrap=False):
|
|
s = s or ''
|
|
s = md(s, [
|
|
'markdown.extensions.tables',
|
|
'markdown.extensions.fenced_code',
|
|
'markdown.extensions.codehilite',
|
|
])
|
|
if markup_wrap:
|
|
s = Markup(s)
|
|
return s
|
|
|
|
|
|
def readfile(filepath):
|
|
with open(filepath) as f:
|
|
content = f.read()
|
|
return content
|
|
|
|
|
|
def generic_find_constraint_name(table, columns, referenced, db):
|
|
"""Utility to find a constraint name in alembic migrations"""
|
|
t = sa.Table(table, db.metadata, autoload=True, autoload_with=db.engine)
|
|
|
|
for fk in t.foreign_key_constraints:
|
|
if (
|
|
fk.referred_table.name == referenced and
|
|
set(fk.column_keys) == columns):
|
|
return fk.name
|