kopia lustrzana https://github.com/simonw/datasette
555 wiersze
20 KiB
Python
555 wiersze
20 KiB
Python
import asyncio
|
|
import click
|
|
import collections
|
|
import hashlib
|
|
import importlib
|
|
import itertools
|
|
import os
|
|
import sqlite3
|
|
import sys
|
|
import threading
|
|
import traceback
|
|
import urllib.parse
|
|
from concurrent import futures
|
|
from pathlib import Path
|
|
|
|
from markupsafe import Markup
|
|
import pluggy
|
|
from jinja2 import ChoiceLoader, Environment, FileSystemLoader, PrefixLoader
|
|
from sanic import Sanic, response
|
|
from sanic.exceptions import InvalidUsage, NotFound
|
|
|
|
from .views.base import (
|
|
DatasetteError,
|
|
ureg
|
|
)
|
|
from .views.database import DatabaseDownload, DatabaseView
|
|
from .views.index import IndexView
|
|
from .views.special import JsonDataView
|
|
from .views.table import RowView, TableView
|
|
|
|
from . import hookspecs
|
|
from .utils import (
|
|
InterruptedError,
|
|
Results,
|
|
escape_css_string,
|
|
escape_sqlite,
|
|
get_plugins,
|
|
module_from_path,
|
|
sqlite_timelimit,
|
|
to_css_class
|
|
)
|
|
from .inspect import inspect_hash, inspect_views, inspect_tables
|
|
from .version import __version__
|
|
|
|
default_plugins = (
|
|
"datasette.publish.heroku",
|
|
"datasette.publish.now",
|
|
)
|
|
|
|
app_root = Path(__file__).parent.parent
|
|
|
|
connections = threading.local()
|
|
|
|
pm = pluggy.PluginManager("datasette")
|
|
pm.add_hookspecs(hookspecs)
|
|
pm.load_setuptools_entrypoints("datasette")
|
|
|
|
# Load default plugins
|
|
for plugin in default_plugins:
|
|
mod = importlib.import_module(plugin)
|
|
pm.register(mod, plugin)
|
|
|
|
|
|
ConfigOption = collections.namedtuple(
|
|
"ConfigOption", ("name", "default", "help")
|
|
)
|
|
CONFIG_OPTIONS = (
|
|
ConfigOption("default_page_size", 100, """
|
|
Default page size for the table view
|
|
""".strip()),
|
|
ConfigOption("max_returned_rows", 1000, """
|
|
Maximum rows that can be returned from a table or custom query
|
|
""".strip()),
|
|
ConfigOption("num_sql_threads", 3, """
|
|
Number of threads in the thread pool for executing SQLite queries
|
|
""".strip()),
|
|
ConfigOption("sql_time_limit_ms", 1000, """
|
|
Time limit for a SQL query in milliseconds
|
|
""".strip()),
|
|
ConfigOption("default_facet_size", 30, """
|
|
Number of values to return for requested facets
|
|
""".strip()),
|
|
ConfigOption("facet_time_limit_ms", 200, """
|
|
Time limit for calculating a requested facet
|
|
""".strip()),
|
|
ConfigOption("facet_suggest_time_limit_ms", 50, """
|
|
Time limit for calculating a suggested facet
|
|
""".strip()),
|
|
ConfigOption("allow_facet", True, """
|
|
Allow users to specify columns to facet using ?_facet= parameter
|
|
""".strip()),
|
|
ConfigOption("allow_download", True, """
|
|
Allow users to download the original SQLite database files
|
|
""".strip()),
|
|
ConfigOption("suggest_facets", True, """
|
|
Calculate and display suggested facets
|
|
""".strip()),
|
|
ConfigOption("allow_sql", True, """
|
|
Allow arbitrary SQL queries via ?sql= parameter
|
|
""".strip()),
|
|
ConfigOption("default_cache_ttl", 365 * 24 * 60 * 60, """
|
|
Default HTTP cache TTL (used in Cache-Control: max-age= header)
|
|
""".strip()),
|
|
ConfigOption("cache_size_kb", 0, """
|
|
SQLite cache size in KB (0 == use SQLite default)
|
|
""".strip()),
|
|
ConfigOption("allow_csv_stream", True, """
|
|
Allow .csv?_stream=1 to download all rows (ignoring max_returned_rows)
|
|
""".strip()),
|
|
ConfigOption("max_csv_mb", 100, """
|
|
Maximum size allowed for CSV export in MB - set 0 to disable this limit
|
|
""".strip()),
|
|
ConfigOption("truncate_cells_html", 2048, """
|
|
Truncate cells longer than this in HTML table view - set 0 to disable
|
|
""".strip()),
|
|
ConfigOption("force_https_urls", False, """
|
|
Force URLs in API output to always use https:// protocol
|
|
""".strip()),
|
|
)
|
|
DEFAULT_CONFIG = {
|
|
option.name: option.default
|
|
for option in CONFIG_OPTIONS
|
|
}
|
|
|
|
|
|
async def favicon(request):
|
|
return response.text("")
|
|
|
|
|
|
class Datasette:
|
|
|
|
def __init__(
|
|
self,
|
|
files,
|
|
cache_headers=True,
|
|
cors=False,
|
|
inspect_data=None,
|
|
metadata=None,
|
|
sqlite_extensions=None,
|
|
template_dir=None,
|
|
plugins_dir=None,
|
|
static_mounts=None,
|
|
config=None,
|
|
version_note=None,
|
|
):
|
|
self.files = files
|
|
self.cache_headers = cache_headers
|
|
self.cors = cors
|
|
self._inspect = inspect_data
|
|
self.metadata = metadata or {}
|
|
self.sqlite_functions = []
|
|
self.sqlite_extensions = sqlite_extensions or []
|
|
self.template_dir = template_dir
|
|
self.plugins_dir = plugins_dir
|
|
self.static_mounts = static_mounts or []
|
|
self.config = dict(DEFAULT_CONFIG, **(config or {}))
|
|
self.version_note = version_note
|
|
self.executor = futures.ThreadPoolExecutor(
|
|
max_workers=self.config["num_sql_threads"]
|
|
)
|
|
self.max_returned_rows = self.config["max_returned_rows"]
|
|
self.sql_time_limit_ms = self.config["sql_time_limit_ms"]
|
|
self.page_size = self.config["default_page_size"]
|
|
# Execute plugins in constructor, to ensure they are available
|
|
# when the rest of `datasette inspect` executes
|
|
if self.plugins_dir:
|
|
for filename in os.listdir(self.plugins_dir):
|
|
filepath = os.path.join(self.plugins_dir, filename)
|
|
mod = module_from_path(filepath, name=filename)
|
|
try:
|
|
pm.register(mod)
|
|
except ValueError:
|
|
# Plugin already registered
|
|
pass
|
|
|
|
def app_css_hash(self):
|
|
if not hasattr(self, "_app_css_hash"):
|
|
self._app_css_hash = hashlib.sha1(
|
|
open(
|
|
os.path.join(str(app_root), "datasette/static/app.css")
|
|
).read().encode(
|
|
"utf8"
|
|
)
|
|
).hexdigest()[
|
|
:6
|
|
]
|
|
return self._app_css_hash
|
|
|
|
def get_canned_queries(self, database_name):
|
|
names = self.metadata.get("databases", {}).get(database_name, {}).get(
|
|
"queries", {}
|
|
).keys()
|
|
return [
|
|
self.get_canned_query(database_name, name) for name in names
|
|
]
|
|
|
|
def get_canned_query(self, database_name, query_name):
|
|
query = self.metadata.get("databases", {}).get(database_name, {}).get(
|
|
"queries", {}
|
|
).get(
|
|
query_name
|
|
)
|
|
if query:
|
|
if not isinstance(query, dict):
|
|
query = {"sql": query}
|
|
query["name"] = query_name
|
|
return query
|
|
|
|
async def get_table_definition(self, database_name, table, type_="table"):
|
|
table_definition_rows = list(
|
|
await self.execute(
|
|
database_name,
|
|
'select sql from sqlite_master where name = :n and type=:t',
|
|
{"n": table, "t": type_},
|
|
)
|
|
)
|
|
if not table_definition_rows:
|
|
return None
|
|
return table_definition_rows[0][0]
|
|
|
|
def get_view_definition(self, database_name, view):
|
|
return self.get_table_definition(database_name, view, 'view')
|
|
|
|
def asset_urls(self, key):
|
|
# Flatten list-of-lists from plugins:
|
|
seen_urls = set()
|
|
for url_or_dict in itertools.chain(
|
|
itertools.chain.from_iterable(getattr(pm.hook, key)()),
|
|
(self.metadata.get(key) or [])
|
|
):
|
|
if isinstance(url_or_dict, dict):
|
|
url = url_or_dict["url"]
|
|
sri = url_or_dict.get("sri")
|
|
else:
|
|
url = url_or_dict
|
|
sri = None
|
|
if url in seen_urls:
|
|
continue
|
|
seen_urls.add(url)
|
|
if sri:
|
|
yield {"url": url, "sri": sri}
|
|
else:
|
|
yield {"url": url}
|
|
|
|
def extra_css_urls(self):
|
|
return self.asset_urls("extra_css_urls")
|
|
|
|
def extra_js_urls(self):
|
|
return self.asset_urls("extra_js_urls")
|
|
|
|
def update_with_inherited_metadata(self, metadata):
|
|
# Fills in source/license with defaults, if available
|
|
metadata.update(
|
|
{
|
|
"source": metadata.get("source") or self.metadata.get("source"),
|
|
"source_url": metadata.get("source_url")
|
|
or self.metadata.get("source_url"),
|
|
"license": metadata.get("license") or self.metadata.get("license"),
|
|
"license_url": metadata.get("license_url")
|
|
or self.metadata.get("license_url"),
|
|
}
|
|
)
|
|
|
|
def prepare_connection(self, conn):
|
|
conn.row_factory = sqlite3.Row
|
|
conn.text_factory = lambda x: str(x, "utf-8", "replace")
|
|
for name, num_args, func in self.sqlite_functions:
|
|
conn.create_function(name, num_args, func)
|
|
if self.sqlite_extensions:
|
|
conn.enable_load_extension(True)
|
|
for extension in self.sqlite_extensions:
|
|
conn.execute("SELECT load_extension('{}')".format(extension))
|
|
if self.config["cache_size_kb"]:
|
|
conn.execute('PRAGMA cache_size=-{}'.format(self.config["cache_size_kb"]))
|
|
pm.hook.prepare_connection(conn=conn)
|
|
|
|
def table_exists(self, database, table):
|
|
return table in self.inspect().get(database, {}).get("tables")
|
|
|
|
def inspect(self):
|
|
" Inspect the database and return a dictionary of table metadata "
|
|
if self._inspect:
|
|
return self._inspect
|
|
|
|
self._inspect = {}
|
|
for filename in self.files:
|
|
path = Path(filename)
|
|
name = path.stem
|
|
if name in self._inspect:
|
|
raise Exception("Multiple files with same stem %s" % name)
|
|
try:
|
|
with sqlite3.connect(
|
|
"file:{}?immutable=1".format(path), uri=True
|
|
) as conn:
|
|
self.prepare_connection(conn)
|
|
self._inspect[name] = {
|
|
"hash": inspect_hash(path),
|
|
"file": str(path),
|
|
"views": inspect_views(conn),
|
|
"tables": inspect_tables(conn, self.metadata.get("databases", {}).get(name, {}))
|
|
}
|
|
except sqlite3.OperationalError as e:
|
|
if (e.args[0] == 'no such module: VirtualSpatialIndex'):
|
|
raise click.UsageError(
|
|
"It looks like you're trying to load a SpatiaLite"
|
|
" database without first loading the SpatiaLite module."
|
|
"\n\nRead more: https://datasette.readthedocs.io/en/latest/spatialite.html"
|
|
)
|
|
else:
|
|
raise
|
|
return self._inspect
|
|
|
|
def register_custom_units(self):
|
|
"Register any custom units defined in the metadata.json with Pint"
|
|
for unit in self.metadata.get("custom_units", []):
|
|
ureg.define(unit)
|
|
|
|
def versions(self):
|
|
conn = sqlite3.connect(":memory:")
|
|
self.prepare_connection(conn)
|
|
sqlite_version = conn.execute("select sqlite_version()").fetchone()[0]
|
|
sqlite_extensions = {}
|
|
for extension, testsql, hasversion in (
|
|
("json1", "SELECT json('{}')", False),
|
|
("spatialite", "SELECT spatialite_version()", True),
|
|
):
|
|
try:
|
|
result = conn.execute(testsql)
|
|
if hasversion:
|
|
sqlite_extensions[extension] = result.fetchone()[0]
|
|
else:
|
|
sqlite_extensions[extension] = None
|
|
except Exception as e:
|
|
pass
|
|
# Figure out supported FTS versions
|
|
fts_versions = []
|
|
for fts in ("FTS5", "FTS4", "FTS3"):
|
|
try:
|
|
conn.execute(
|
|
"CREATE VIRTUAL TABLE v{fts} USING {fts} (data)".format(fts=fts)
|
|
)
|
|
fts_versions.append(fts)
|
|
except sqlite3.OperationalError:
|
|
continue
|
|
datasette_version = {"version": __version__}
|
|
if self.version_note:
|
|
datasette_version["note"] = self.version_note
|
|
return {
|
|
"python": {
|
|
"version": ".".join(map(str, sys.version_info[:3])), "full": sys.version
|
|
},
|
|
"datasette": datasette_version,
|
|
"sqlite": {
|
|
"version": sqlite_version,
|
|
"fts_versions": fts_versions,
|
|
"extensions": sqlite_extensions,
|
|
},
|
|
}
|
|
|
|
def plugins(self):
|
|
return [
|
|
{
|
|
"name": p["name"],
|
|
"static": p["static_path"] is not None,
|
|
"templates": p["templates_path"] is not None,
|
|
"version": p.get("version"),
|
|
}
|
|
for p in get_plugins(pm)
|
|
]
|
|
|
|
async def execute(
|
|
self,
|
|
db_name,
|
|
sql,
|
|
params=None,
|
|
truncate=False,
|
|
custom_time_limit=None,
|
|
page_size=None,
|
|
):
|
|
"""Executes sql against db_name in a thread"""
|
|
page_size = page_size or self.page_size
|
|
|
|
def sql_operation_in_thread():
|
|
conn = getattr(connections, db_name, None)
|
|
if not conn:
|
|
info = self.inspect()[db_name]
|
|
conn = sqlite3.connect(
|
|
"file:{}?immutable=1".format(info["file"]),
|
|
uri=True,
|
|
check_same_thread=False,
|
|
)
|
|
self.prepare_connection(conn)
|
|
setattr(connections, db_name, conn)
|
|
|
|
time_limit_ms = self.sql_time_limit_ms
|
|
if custom_time_limit and custom_time_limit < time_limit_ms:
|
|
time_limit_ms = custom_time_limit
|
|
|
|
with sqlite_timelimit(conn, time_limit_ms):
|
|
try:
|
|
cursor = conn.cursor()
|
|
cursor.execute(sql, params or {})
|
|
max_returned_rows = self.max_returned_rows
|
|
if max_returned_rows == page_size:
|
|
max_returned_rows += 1
|
|
if max_returned_rows and truncate:
|
|
rows = cursor.fetchmany(max_returned_rows + 1)
|
|
truncated = len(rows) > max_returned_rows
|
|
rows = rows[:max_returned_rows]
|
|
else:
|
|
rows = cursor.fetchall()
|
|
truncated = False
|
|
except sqlite3.OperationalError as e:
|
|
if e.args == ('interrupted',):
|
|
raise InterruptedError(e)
|
|
print(
|
|
"ERROR: conn={}, sql = {}, params = {}: {}".format(
|
|
conn, repr(sql), params, e
|
|
)
|
|
)
|
|
raise
|
|
|
|
if truncate:
|
|
return Results(rows, truncated, cursor.description)
|
|
|
|
else:
|
|
return Results(rows, False, cursor.description)
|
|
|
|
return await asyncio.get_event_loop().run_in_executor(
|
|
self.executor, sql_operation_in_thread
|
|
)
|
|
|
|
def app(self):
|
|
app = Sanic(__name__)
|
|
default_templates = str(app_root / "datasette" / "templates")
|
|
template_paths = []
|
|
if self.template_dir:
|
|
template_paths.append(self.template_dir)
|
|
template_paths.extend(
|
|
[
|
|
plugin["templates_path"]
|
|
for plugin in get_plugins(pm)
|
|
if plugin["templates_path"]
|
|
]
|
|
)
|
|
template_paths.append(default_templates)
|
|
template_loader = ChoiceLoader(
|
|
[
|
|
FileSystemLoader(template_paths),
|
|
# Support {% extends "default:table.html" %}:
|
|
PrefixLoader(
|
|
{"default": FileSystemLoader(default_templates)}, delimiter=":"
|
|
),
|
|
]
|
|
)
|
|
self.jinja_env = Environment(loader=template_loader, autoescape=True)
|
|
self.jinja_env.filters["escape_css_string"] = escape_css_string
|
|
self.jinja_env.filters["quote_plus"] = lambda u: urllib.parse.quote_plus(u)
|
|
self.jinja_env.filters["escape_sqlite"] = escape_sqlite
|
|
self.jinja_env.filters["to_css_class"] = to_css_class
|
|
pm.hook.prepare_jinja2_environment(env=self.jinja_env)
|
|
app.add_route(IndexView.as_view(self), "/<as_format:(\.jsono?)?$>")
|
|
# TODO: /favicon.ico and /-/static/ deserve far-future cache expires
|
|
app.add_route(favicon, "/favicon.ico")
|
|
app.static("/-/static/", str(app_root / "datasette" / "static"))
|
|
for path, dirname in self.static_mounts:
|
|
app.static(path, dirname)
|
|
# Mount any plugin static/ directories
|
|
for plugin in get_plugins(pm):
|
|
if plugin["static_path"]:
|
|
modpath = "/-/static-plugins/{}/".format(plugin["name"])
|
|
app.static(modpath, plugin["static_path"])
|
|
app.add_route(
|
|
JsonDataView.as_view(self, "inspect.json", self.inspect),
|
|
"/-/inspect<as_format:(\.json)?$>",
|
|
)
|
|
app.add_route(
|
|
JsonDataView.as_view(self, "metadata.json", lambda: self.metadata),
|
|
"/-/metadata<as_format:(\.json)?$>",
|
|
)
|
|
app.add_route(
|
|
JsonDataView.as_view(self, "versions.json", self.versions),
|
|
"/-/versions<as_format:(\.json)?$>",
|
|
)
|
|
app.add_route(
|
|
JsonDataView.as_view(self, "plugins.json", self.plugins),
|
|
"/-/plugins<as_format:(\.json)?$>",
|
|
)
|
|
app.add_route(
|
|
JsonDataView.as_view(self, "config.json", lambda: self.config),
|
|
"/-/config<as_format:(\.json)?$>",
|
|
)
|
|
app.add_route(
|
|
DatabaseDownload.as_view(self), "/<db_name:[^/]+?><as_db:(\.db)$>"
|
|
)
|
|
app.add_route(
|
|
DatabaseView.as_view(self), "/<db_name:[^/]+?><as_format:(\.jsono?|\.csv)?$>"
|
|
)
|
|
app.add_route(
|
|
TableView.as_view(self),
|
|
"/<db_name:[^/]+>/<table_and_format:[^/]+?$>",
|
|
)
|
|
app.add_route(
|
|
RowView.as_view(self),
|
|
"/<db_name:[^/]+>/<table:[^/]+?>/<pk_path:[^/]+?><as_format:(\.jsono?)?$>",
|
|
)
|
|
self.register_custom_units()
|
|
# On 404 with a trailing slash redirect to path without that slash:
|
|
@app.middleware("response")
|
|
def redirect_on_404_with_trailing_slash(request, original_response):
|
|
if original_response.status == 404 and request.path.endswith("/"):
|
|
path = request.path.rstrip("/")
|
|
if request.query_string:
|
|
path = "{}?{}".format(path, request.query_string)
|
|
return response.redirect(path)
|
|
|
|
@app.exception(Exception)
|
|
def on_exception(request, exception):
|
|
title = None
|
|
help = None
|
|
if isinstance(exception, NotFound):
|
|
status = 404
|
|
info = {}
|
|
message = exception.args[0]
|
|
elif isinstance(exception, InvalidUsage):
|
|
status = 405
|
|
info = {}
|
|
message = exception.args[0]
|
|
elif isinstance(exception, DatasetteError):
|
|
status = exception.status
|
|
info = exception.error_dict
|
|
message = exception.message
|
|
if exception.messagge_is_html:
|
|
message = Markup(message)
|
|
title = exception.title
|
|
else:
|
|
status = 500
|
|
info = {}
|
|
message = str(exception)
|
|
traceback.print_exc()
|
|
templates = ["500.html"]
|
|
if status != 500:
|
|
templates = ["{}.html".format(status)] + templates
|
|
info.update(
|
|
{"ok": False, "error": message, "status": status, "title": title}
|
|
)
|
|
if request is not None and request.path.split("?")[0].endswith(".json"):
|
|
return response.json(info, status=status)
|
|
|
|
else:
|
|
template = self.jinja_env.select_template(templates)
|
|
return response.html(template.render(info), status=status)
|
|
|
|
return app
|