Compare commits

...

22 commits

Author SHA1 Message Date
Simon Willison
cd65558aee setup-gcloud 318.0.0
Refs https://til.simonwillison.net/googlecloud/gcloud-error-workaround
2023-01-09 16:02:28 -08:00
Simon Willison
0084daa50a Release 0.64, with a warning against arbitrary SQL with SpatiaLite
Refs #1409, #1771, #1979

Refs https://github.com/simonw/datasette.io/issues/132
2023-01-09 08:37:21 -08:00
Simon Willison
02987e342d Explicitly explain allow_sql: false 2023-01-09 08:25:19 -08:00
Simon Willison
fdb4d975a1 Better error for --load-extensions, refs #1979 2023-01-07 15:58:30 -08:00
Simon Willison
3b88ac671e What to do if extensions will not load, refs #1979 2023-01-07 15:48:08 -08:00
Simon Willison
1ec9c9995c Backported default_allow_sql for 0.63.x, closes #1409 2023-01-05 09:21:07 -08:00
Simon Willison
b8cf864fa6 Fixed broken example links in _where= docs 2023-01-04 16:53:39 -08:00
Simon Willison
1bff3f1a70 Fixed table_action example in docs 2023-01-04 16:53:31 -08:00
Simon Willison
7402294018 .select-wrapper:focus-within for accessibility, closes #1771 2023-01-04 16:53:16 -08:00
Simon Willison
9ec58da6ec Deploy docs on publish using Python 3.9
A workaround for gcloud setup, see:

https://til.simonwillison.net/googlecloud/gcloud-error-workaround

Refs #1963
2022-12-17 19:24:34 -08:00
Simon Willison
e05998bc85 Added missing word, refs #1963 2022-12-17 19:08:01 -08:00
Simon Willison
a9ffcbd42e Release 0.63.3
Refs #1955, #1958, #1963
2022-12-17 19:06:03 -08:00
Simon Willison
d93f975b3d On publish run tests same way as for test 2022-12-17 18:52:52 -08:00
Simon Willison
e6d94f9ffa Run new HTTPS test in CI, refs #1955 2022-12-17 18:51:17 -08:00
Simon Willison
0bd3eaa2dd Move HTTPS test to a bash script
See https://github.com/simonw/datasette/issues/1955#issuecomment-1356627931
2022-12-17 18:51:17 -08:00
Simon Willison
5649e547ef Put AsgiLifestyle back so server starts up again, refs #1955 2022-12-17 18:51:17 -08:00
Simon Willison
96b3a86d7f Replace AsgiLifespan with AsgiRunOnFirstRequest, refs #1955 2022-12-17 18:51:17 -08:00
Simon Willison
4ba8d57bb1 Try click.echo() instead
This ensures the URL is output correctly when running under Docker.

Closes #1958
2022-12-15 16:57:45 -08:00
Simon Willison
d67f812b73 Release 0.63.2
Refs #1904, #1905
2022-11-18 16:53:05 -08:00
Simon Willison
c4d002fef5 Pin httpx in Pyodide test, refs #1904
Should help get tests to pass for #1896 too
2022-11-18 16:52:09 -08:00
Simon Willison
a93ccc63c7 Upgrade to Python 3.11 on Heroku, refs #1905 2022-11-18 16:49:08 -08:00
Simon Willison
9cca381033 --generate-dir option to publish heroku, refs #1905 2022-11-18 16:49:02 -08:00
26 changed files with 359 additions and 99 deletions

View file

@ -31,7 +31,10 @@ jobs:
pip install -e '.[test]' pip install -e '.[test]'
- name: Run tests - name: Run tests
run: | run: |
pytest pytest -n auto -m "not serial"
pytest -m "serial"
# And the test that exceeds a localhost HTTPS server
tests/test_datasette_https_server.sh
deploy: deploy:
runs-on: ubuntu-latest runs-on: ubuntu-latest
@ -69,7 +72,7 @@ jobs:
- name: Set up Python - name: Set up Python
uses: actions/setup-python@v2 uses: actions/setup-python@v2
with: with:
python-version: '3.10' python-version: '3.9'
- uses: actions/cache@v2 - uses: actions/cache@v2
name: Configure pip caching name: Configure pip caching
with: with:
@ -90,7 +93,7 @@ jobs:
- name: Set up Cloud Run - name: Set up Cloud Run
uses: google-github-actions/setup-gcloud@v0 uses: google-github-actions/setup-gcloud@v0
with: with:
version: '275.0.0' version: '318.0.0'
service_account_email: ${{ secrets.GCP_SA_EMAIL }} service_account_email: ${{ secrets.GCP_SA_EMAIL }}
service_account_key: ${{ secrets.GCP_SA_KEY }} service_account_key: ${{ secrets.GCP_SA_KEY }}
- name: Deploy stable-docs.datasette.io to Cloud Run - name: Deploy stable-docs.datasette.io to Cloud Run

View file

@ -35,6 +35,8 @@ jobs:
run: | run: |
pytest -n auto -m "not serial" pytest -n auto -m "not serial"
pytest -m "serial" pytest -m "serial"
# And the test that exceeds a localhost HTTPS server
tests/test_datasette_https_server.sh
- name: Check if cog needs to be run - name: Check if cog needs to be run
run: | run: |
cog --check docs/*.rst cog --check docs/*.rst

View file

@ -64,16 +64,14 @@ from .utils import (
) )
from .utils.asgi import ( from .utils.asgi import (
AsgiLifespan, AsgiLifespan,
Base400,
Forbidden, Forbidden,
NotFound, NotFound,
Request, Request,
Response, Response,
AsgiRunOnFirstRequest,
asgi_static, asgi_static,
asgi_send, asgi_send,
asgi_send_file, asgi_send_file,
asgi_send_html,
asgi_send_json,
asgi_send_redirect, asgi_send_redirect,
) )
from .utils.internal_db import init_internal_db, populate_schema_tables from .utils.internal_db import init_internal_db, populate_schema_tables
@ -118,6 +116,11 @@ SETTINGS = (
True, True,
"Allow users to specify columns to facet using ?_facet= parameter", "Allow users to specify columns to facet using ?_facet= parameter",
), ),
Setting(
"default_allow_sql",
True,
"Allow anyone to run arbitrary SQL queries",
),
Setting( Setting(
"allow_download", "allow_download",
True, True,
@ -1260,7 +1263,7 @@ class Datasette:
async def setup_db(): async def setup_db():
# First time server starts up, calculate table counts for immutable databases # First time server starts up, calculate table counts for immutable databases
for dbname, database in self.databases.items(): for database in self.databases.values():
if not database.is_mutable: if not database.is_mutable:
await database.table_counts(limit=60 * 60 * 1000) await database.table_counts(limit=60 * 60 * 1000)
@ -1274,10 +1277,8 @@ class Datasette:
) )
if self.setting("trace_debug"): if self.setting("trace_debug"):
asgi = AsgiTracer(asgi) asgi = AsgiTracer(asgi)
asgi = AsgiLifespan( asgi = AsgiLifespan(asgi)
asgi, asgi = AsgiRunOnFirstRequest(asgi, on_startup=[setup_db, self.invoke_startup])
on_startup=setup_db,
)
for wrapper in pm.hook.asgi_wrapper(datasette=self): for wrapper in pm.hook.asgi_wrapper(datasette=self):
asgi = wrapper(asgi) asgi = wrapper(asgi)
return asgi return asgi
@ -1566,42 +1567,34 @@ class DatasetteClient:
return path return path
async def get(self, path, **kwargs): async def get(self, path, **kwargs):
await self.ds.invoke_startup()
async with httpx.AsyncClient(app=self.app) as client: async with httpx.AsyncClient(app=self.app) as client:
return await client.get(self._fix(path), **kwargs) return await client.get(self._fix(path), **kwargs)
async def options(self, path, **kwargs): async def options(self, path, **kwargs):
await self.ds.invoke_startup()
async with httpx.AsyncClient(app=self.app) as client: async with httpx.AsyncClient(app=self.app) as client:
return await client.options(self._fix(path), **kwargs) return await client.options(self._fix(path), **kwargs)
async def head(self, path, **kwargs): async def head(self, path, **kwargs):
await self.ds.invoke_startup()
async with httpx.AsyncClient(app=self.app) as client: async with httpx.AsyncClient(app=self.app) as client:
return await client.head(self._fix(path), **kwargs) return await client.head(self._fix(path), **kwargs)
async def post(self, path, **kwargs): async def post(self, path, **kwargs):
await self.ds.invoke_startup()
async with httpx.AsyncClient(app=self.app) as client: async with httpx.AsyncClient(app=self.app) as client:
return await client.post(self._fix(path), **kwargs) return await client.post(self._fix(path), **kwargs)
async def put(self, path, **kwargs): async def put(self, path, **kwargs):
await self.ds.invoke_startup()
async with httpx.AsyncClient(app=self.app) as client: async with httpx.AsyncClient(app=self.app) as client:
return await client.put(self._fix(path), **kwargs) return await client.put(self._fix(path), **kwargs)
async def patch(self, path, **kwargs): async def patch(self, path, **kwargs):
await self.ds.invoke_startup()
async with httpx.AsyncClient(app=self.app) as client: async with httpx.AsyncClient(app=self.app) as client:
return await client.patch(self._fix(path), **kwargs) return await client.patch(self._fix(path), **kwargs)
async def delete(self, path, **kwargs): async def delete(self, path, **kwargs):
await self.ds.invoke_startup()
async with httpx.AsyncClient(app=self.app) as client: async with httpx.AsyncClient(app=self.app) as client:
return await client.delete(self._fix(path), **kwargs) return await client.delete(self._fix(path), **kwargs)
async def request(self, method, path, **kwargs): async def request(self, method, path, **kwargs):
await self.ds.invoke_startup()
avoid_path_rewrites = kwargs.pop("avoid_path_rewrites", None) avoid_path_rewrites = kwargs.pop("avoid_path_rewrites", None)
async with httpx.AsyncClient(app=self.app) as client: async with httpx.AsyncClient(app=self.app) as client:
return await client.request( return await client.request(

View file

@ -4,6 +4,7 @@ import click
from click import formatting from click import formatting
from click.types import CompositeParamType from click.types import CompositeParamType
from click_default_group import DefaultGroup from click_default_group import DefaultGroup
import functools
import json import json
import os import os
import pathlib import pathlib
@ -11,6 +12,7 @@ import shutil
from subprocess import call from subprocess import call
import sys import sys
from runpy import run_module from runpy import run_module
import textwrap
import webbrowser import webbrowser
from .app import ( from .app import (
OBSOLETE_SETTINGS, OBSOLETE_SETTINGS,
@ -126,7 +128,7 @@ class Setting(CompositeParamType):
def sqlite_extensions(fn): def sqlite_extensions(fn):
return click.option( fn = click.option(
"sqlite_extensions", "sqlite_extensions",
"--load-extension", "--load-extension",
type=LoadExtension(), type=LoadExtension(),
@ -134,6 +136,25 @@ def sqlite_extensions(fn):
multiple=True, multiple=True,
help="Path to a SQLite extension to load, and optional entrypoint", help="Path to a SQLite extension to load, and optional entrypoint",
)(fn) )(fn)
# Wrap it in a custom error handler
@functools.wraps(fn)
def wrapped(*args, **kwargs):
try:
return fn(*args, **kwargs)
except AttributeError as e:
if "enable_load_extension" in str(e):
raise click.ClickException(
textwrap.dedent(
"""
Your Python installation does not have the ability to load SQLite extensions.
More information: https://datasette.io/help/extensions
"""
).strip()
)
raise
return wrapped
@click.group(cls=DefaultGroup, default="serve", default_if_no_args=True) @click.group(cls=DefaultGroup, default="serve", default_if_no_args=True)
@ -607,7 +628,7 @@ def serve(
url = "http://{}:{}{}?token={}".format( url = "http://{}:{}{}?token={}".format(
host, port, ds.urls.path("-/auth-token"), ds._root_token host, port, ds.urls.path("-/auth-token"), ds._root_token
) )
print(url) click.echo(url)
if open_browser: if open_browser:
if url is None: if url is None:
# Figure out most convenient URL - to table, database or homepage # Figure out most convenient URL - to table, database or homepage

View file

@ -36,12 +36,16 @@ def permission_allowed(datasette, actor, action, resource):
return None return None
return actor_matches_allow(actor, allow) return actor_matches_allow(actor, allow)
elif action == "execute-sql": elif action == "execute-sql":
# Only use default_allow_sql setting if it is set to False:
default_allow_sql = (
None if datasette.setting("default_allow_sql") else False
)
# Use allow_sql block from database block, or from top-level # Use allow_sql block from database block, or from top-level
database_allow_sql = datasette.metadata("allow_sql", database=resource) database_allow_sql = datasette.metadata("allow_sql", database=resource)
if database_allow_sql is None: if database_allow_sql is None:
database_allow_sql = datasette.metadata("allow_sql") database_allow_sql = datasette.metadata("allow_sql")
if database_allow_sql is None: if database_allow_sql is None:
return None return default_allow_sql
return actor_matches_allow(actor, database_allow_sql) return actor_matches_allow(actor, database_allow_sql)
return inner return inner

View file

@ -3,7 +3,9 @@ from datasette import hookimpl
import click import click
import json import json
import os import os
import pathlib
import shlex import shlex
import shutil
from subprocess import call, check_output from subprocess import call, check_output
import tempfile import tempfile
@ -28,6 +30,11 @@ def publish_subcommand(publish):
"--tar", "--tar",
help="--tar option to pass to Heroku, e.g. --tar=/usr/local/bin/gtar", help="--tar option to pass to Heroku, e.g. --tar=/usr/local/bin/gtar",
) )
@click.option(
"--generate-dir",
type=click.Path(dir_okay=True, file_okay=False),
help="Output generated application files and stop without deploying",
)
def heroku( def heroku(
files, files,
metadata, metadata,
@ -49,6 +56,7 @@ def publish_subcommand(publish):
about_url, about_url,
name, name,
tar, tar,
generate_dir,
): ):
"Publish databases to Datasette running on Heroku" "Publish databases to Datasette running on Heroku"
fail_if_publish_binary_not_installed( fail_if_publish_binary_not_installed(
@ -105,6 +113,16 @@ def publish_subcommand(publish):
secret, secret,
extra_metadata, extra_metadata,
): ):
if generate_dir:
# Recursively copy files from current working directory to it
if pathlib.Path(generate_dir).exists():
raise click.ClickException("Directory already exists")
shutil.copytree(".", generate_dir)
click.echo(
f"Generated files written to {generate_dir}, stopping without deploying",
err=True,
)
return
app_name = None app_name = None
if name: if name:
# Check to see if this app already exists # Check to see if this app already exists
@ -176,7 +194,7 @@ def temporary_heroku_directory(
fp.write(json.dumps(metadata_content, indent=2)) fp.write(json.dumps(metadata_content, indent=2))
with open("runtime.txt", "w") as fp: with open("runtime.txt", "w") as fp:
fp.write("python-3.8.10") fp.write("python-3.11.0")
if branch: if branch:
install = [ install = [

View file

@ -573,6 +573,9 @@ form button[type=button] {
display: inline-block; display: inline-block;
margin-right: 0.3em; margin-right: 0.3em;
} }
.select-wrapper:focus-within {
border: 1px solid black;
}
.select-wrapper.filter-op { .select-wrapper.filter-op {
width: 80px; width: 80px;
} }

View file

@ -428,3 +428,18 @@ class AsgiFileDownload:
content_type=self.content_type, content_type=self.content_type,
headers=self.headers, headers=self.headers,
) )
class AsgiRunOnFirstRequest:
def __init__(self, asgi, on_startup):
assert isinstance(on_startup, list)
self.asgi = asgi
self.on_startup = on_startup
self._started = False
async def __call__(self, scope, receive, send):
if not self._started:
self._started = True
for hook in self.on_startup:
await hook()
return await self.asgi(scope, receive, send)

View file

@ -1,2 +1,2 @@
__version__ = "0.63.1" __version__ = "0.64"
__version_info__ = tuple(__version__.split(".")) __version_info__ = tuple(__version__.split("."))

View file

@ -307,7 +307,21 @@ To limit access to the ``add_name`` canned query in your ``dogs.db`` database to
Controlling the ability to execute arbitrary SQL Controlling the ability to execute arbitrary SQL
------------------------------------------------ ------------------------------------------------
The ``"allow_sql"`` block can be used to control who is allowed to execute arbitrary SQL queries, both using the form on the database page e.g. https://latest.datasette.io/fixtures or by appending a ``?_where=`` parameter to the table page as seen on https://latest.datasette.io/fixtures/facetable?_where=city_id=1. Datasette defaults to allowing any site visitor to execute their own custom SQL queries, for example using the form on `the database page <https://latest.datasette.io/fixtures>`__ or by appending a ``?_where=`` parameter to the table page `like this <https://latest.datasette.io/fixtures/facetable?_where=_city_id=1>`__.
Access to this ability is controlled by the :ref:`permissions_execute_sql` permission.
The easiest way to disable arbitrary SQL queries is using the :ref:`default_allow_sql setting <setting_default_allow_sql>` when you first start Datasette running.
You can alternatively use an ``"allow_sql"`` block to control who is allowed to execute arbitrary SQL queries.
To prevent any user from executing arbitrary SQL queries, use this:
.. code-block:: json
{
"allow_sql": false
}
To enable just the :ref:`root user<authentication_root>` to execute SQL for all databases in your instance, use the following: To enable just the :ref:`root user<authentication_root>` to execute SQL for all databases in your instance, use the following:
@ -515,7 +529,7 @@ Actor is allowed to run arbitrary SQL queries against a specific database, e.g.
``resource`` - string ``resource`` - string
The name of the database The name of the database
Default *allow*. Default *allow*. See also :ref:`the default_allow_sql setting <setting_default_allow_sql>`.
.. _permissions_permissions_debug: .. _permissions_permissions_debug:

View file

@ -4,6 +4,33 @@
Changelog Changelog
========= =========
.. _v0_64:
0.64 (2023-01-09)
-----------------
- Datasette now **strongly recommends against allowing arbitrary SQL queries if you are using SpatiaLite**. SpatiaLite includes SQL functions that could cause the Datasette server to crash. See :ref:`spatialite` for more details.
- New :ref:`setting_default_allow_sql` setting, providing an easier way to disable all arbitrary SQL execution by end users: ``datasette --setting default_allow_sql off``. See also :ref:`authentication_permissions_execute_sql`. (:issue:`1409`)
- `Building a location to time zone API with SpatiaLite <https://datasette.io/tutorials/spatialite>`__ is a new Datasette tutorial showing how to safely use SpatiaLite to create a location to time zone API.
- New documentation about :ref:`how to debug problems loading SQLite extensions <installation_extensions>`. The error message shown when an extension cannot be loaded has also been improved. (:issue:`1979`)
- Fixed an accessibility issue: the ``<select>`` elements in the table filter form now show an outline when they are currently focused. (:issue:`1771`)
.. _v0_63_3:
0.63.3 (2022-12-17)
-------------------
- Fixed a bug where ``datasette --root``, when running in Docker, would only output the URL to sign in as root when the server shut down, not when it started up. (:issue:`1958`)
- You no longer need to ensure ``await datasette.invoke_startup()`` has been called in order for Datasette to start correctly serving requests - this is now handled automatically the first time the server receives a request. This fixes a bug experienced when Datasette is served directly by an ASGI application server such as Uvicorn or Gunicorn. It also fixes a bug with the `datasette-gunicorn <https://datasette.io/plugins/datasette-gunicorn>`__ plugin. (:issue:`1955`)
.. _v0_63_2:
0.63.2 (2022-11-18)
-------------------
- Fixed a bug in ``datasette publish heroku`` where deployments failed due to an older version of Python being requested. (:issue:`1905`)
- New ``datasette publish heroku --generate-dir <dir>`` option for generating a Heroku deployment directory without deploying it.
.. _v0_63_1: .. _v0_63_1:
0.63.1 (2022-11-10) 0.63.1 (2022-11-10)

View file

@ -224,6 +224,8 @@ These can be passed to ``datasette serve`` using ``datasette serve --setting nam
(default=50) (default=50)
allow_facet Allow users to specify columns to facet using allow_facet Allow users to specify columns to facet using
?_facet= parameter (default=True) ?_facet= parameter (default=True)
default_allow_sql Allow anyone to run arbitrary SQL queries
(default=True)
allow_download Allow users to download the original SQLite allow_download Allow users to download the original SQLite
database files (default=True) database files (default=True)
suggest_facets Calculate and display suggested facets suggest_facets Calculate and display suggested facets
@ -501,6 +503,8 @@ See :ref:`publish_heroku`.
-n, --name TEXT Application name to use when deploying -n, --name TEXT Application name to use when deploying
--tar TEXT --tar option to pass to Heroku, e.g. --tar TEXT --tar option to pass to Heroku, e.g.
--tar=/usr/local/bin/gtar --tar=/usr/local/bin/gtar
--generate-dir DIRECTORY Output generated application files and stop
without deploying
--help Show this message and exit. --help Show this message and exit.

View file

@ -230,3 +230,60 @@ Some plugins such as `datasette-ripgrep <https://datasette.io/plugins/datasette-
pip install datasette-ripgrep' pip install datasette-ripgrep'
docker commit $(docker ps -lq) datasette-with-ripgrep docker commit $(docker ps -lq) datasette-with-ripgrep
.. _installation_extensions:
A note about extensions
=======================
SQLite supports extensions, such as :ref:`spatialite` for geospatial operations.
These can be loaded using the ``--load-extension`` argument, like so::
datasette --load-extension=/usr/local/lib/mod_spatialite.dylib
Some Python installations do not include support for SQLite extensions. If this is the case you will see the following error when you attempt to load an extension:
Your Python installation does not have the ability to load SQLite extensions.
In some cases you may see the following error message instead::
AttributeError: 'sqlite3.Connection' object has no attribute 'enable_load_extension'
On macOS the easiest fix for this is to install Datasette using Homebrew::
brew install datasette
Use ``which datasette`` to confirm that ``datasette`` will run that version. The output should look something like this::
/usr/local/opt/datasette/bin/datasette
If you get a different location here such as ``/Library/Frameworks/Python.framework/Versions/3.10/bin/datasette`` you can run the following command to cause ``datasette`` to execute the Homebrew version instead::
alias datasette=$(echo $(brew --prefix datasette)/bin/datasette)
You can undo this operation using::
unalias datasette
If you need to run SQLite with extension support for other Python code, you can do so by install Python itself using Homebrew::
brew install python
Then executing Python using::
/usr/local/opt/python@3/libexec/bin/python
A more convenient way to work with this version of Python may be to use it to create a virtual environment::
/usr/local/opt/python@3/libexec/bin/python -m venv datasette-venv
Then activate it like this::
source datasette-venv/bin/activate
Now running ``python`` and ``pip`` will work against a version of Python 3 that includes support for SQLite extensions::
pip install datasette
which datasette
datasette --version

View file

@ -357,8 +357,8 @@ Special table arguments
Some examples: Some examples:
* `facetable?_where=neighborhood like "%c%"&_where=city_id=3 <https://latest.datasette.io/fixtures/facetable?_where=neighborhood%20like%20%22%c%%22&_where=city_id=3>`__ * `facetable?_where=_neighborhood like "%c%"&_where=_city_id=3 <https://latest.datasette.io/fixtures/facetable?_where=_neighborhood%20like%20%22%c%%22&_where=_city_id=3>`__
* `facetable?_where=city_id in (select id from facet_cities where name != "Detroit") <https://latest.datasette.io/fixtures/facetable?_where=city_id%20in%20(select%20id%20from%20facet_cities%20where%20name%20!=%20%22Detroit%22)>`__ * `facetable?_where=_city_id in (select id from facet_cities where name != "Detroit") <https://latest.datasette.io/fixtures/facetable?_where=_city_id%20in%20(select%20id%20from%20facet_cities%20where%20name%20!=%20%22Detroit%22)>`__
``?_through={json}`` ``?_through={json}``
This can be used to filter rows via a join against another table. This can be used to filter rows via a join against another table.

View file

@ -855,13 +855,14 @@ Potential use-cases:
.. note:: .. note::
If you are writing :ref:`unit tests <testing_plugins>` for a plugin that uses this hook you will need to explicitly call ``await ds.invoke_startup()`` in your tests. An example: If you are writing :ref:`unit tests <testing_plugins>` for a plugin that uses this hook and doesn't exercise Datasette by sending
any simulated requests through it you will need to explicitly call ``await ds.invoke_startup()`` in your tests. An example:
.. code-block:: python .. code-block:: python
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_my_plugin(): async def test_my_plugin():
ds = Datasette([], metadata={}) ds = Datasette()
await ds.invoke_startup() await ds.invoke_startup()
# Rest of test goes here # Rest of test goes here
@ -1345,7 +1346,7 @@ This example adds a new table action if the signed in user is ``"root"``:
@hookimpl @hookimpl
def table_actions(datasette, actor): def table_actions(datasette, actor, database, table):
if actor and actor.get("id") == "root": if actor and actor.get("id") == "root":
return [ return [
{ {

View file

@ -73,6 +73,10 @@ This will output some details about the new deployment, including a URL like thi
You can specify a custom app name by passing ``-n my-app-name`` to the publish command. This will also allow you to overwrite an existing app. You can specify a custom app name by passing ``-n my-app-name`` to the publish command. This will also allow you to overwrite an existing app.
Rather than deploying directly you can use the ``--generate-dir`` option to output the files that would be deployed to a directory::
datasette publish heroku mydatabase.db --generate-dir=/tmp/deploy-this-to-heroku
See :ref:`cli_help_publish_heroku___help` for the full list of options for this command. See :ref:`cli_help_publish_heroku___help` for the full list of options for this command.
.. _publish_vercel: .. _publish_vercel:

View file

@ -59,6 +59,21 @@ Settings
The following options can be set using ``--setting name value``, or by storing them in the ``settings.json`` file for use with :ref:`config_dir`. The following options can be set using ``--setting name value``, or by storing them in the ``settings.json`` file for use with :ref:`config_dir`.
.. _setting_default_allow_sql:
default_allow_sql
~~~~~~~~~~~~~~~~~
Should users be able to execute arbitrary SQL queries by default?
Setting this to ``off`` causes permission checks for :ref:`permissions_execute_sql` to fail by default.
::
datasette mydatabase.db --setting default_allow_sql off
There are two ways to achieve this: the other is to add ``"allow_sql": false`` to your ``metadata.json`` file, as described in :ref:`authentication_permissions_execute_sql`. This setting offers a more convenient way to do this.
.. _setting_default_page_size: .. _setting_default_page_size:
default_page_size default_page_size

View file

@ -4,17 +4,37 @@
SpatiaLite SpatiaLite
============ ============
The `SpatiaLite module <https://www.gaia-gis.it/fossil/libspatialite/index>`_ for SQLite adds features for handling geographic and spatial data. For an example of what you can do with it, see the tutorial `Building a location to time zone API with SpatiaLite, OpenStreetMap and Datasette <https://simonwillison.net/2017/Dec/12/location-time-zone-api/>`_. The `SpatiaLite module <https://www.gaia-gis.it/fossil/libspatialite/index>`_ for SQLite adds features for handling geographic and spatial data. For an example of what you can do with it, see the tutorial `Building a location to time zone API with SpatiaLite <https://datasette.io/tutorials/spatialite>`__.
To use it with Datasette, you need to install the ``mod_spatialite`` dynamic library. This can then be loaded into Datasette using the ``--load-extension`` command-line option. To use it with Datasette, you need to install the ``mod_spatialite`` dynamic library. This can then be loaded into Datasette using the ``--load-extension`` command-line option.
Datasette can look for SpatiaLite in common installation locations if you run it like this:: Datasette can look for SpatiaLite in common installation locations if you run it like this::
datasette --load-extension=spatialite datasette --load-extension=spatialite --setting default_allow_sql off
If SpatiaLite is in another location, use the full path to the extension instead:: If SpatiaLite is in another location, use the full path to the extension instead::
datasette --load-extension=/usr/local/lib/mod_spatialite.dylib datasette --setting default_allow_sql off \
--load-extension=/usr/local/lib/mod_spatialite.dylib
.. _spatialite_warning:
Warning
=======
.. warning::
The SpatiaLite extension adds `a large number of additional SQL functions <https://www.gaia-gis.it/gaia-sins/spatialite-sql-5.0.1.html>`__, some of which are not be safe for untrusted users to execute: they may cause the Datasette server to crash.
You should not expose a SpatiaLite-enabled Datasette instance to the public internet without taking extra measures to secure it against potentially harmful SQL queries.
The following steps are recommended:
- Disable arbitrary SQL queries by untrusted users. See :ref:`authentication_permissions_execute_sql` for ways to do this. The easiest is to start Datasette with the ``datasette --setting default_allow_sql off`` option.
- Define :ref:`canned_queries` with the SQL queries that use SpatiaLite functions that you want people to be able to execute.
The `Datasette SpatiaLite tutorial <https://datasette.io/tutorials/spatialite>`__ includes detailed instructions for running SpatiaLite safely using these techniques
.. _spatialite_installation:
Installation Installation
============ ============

View file

@ -80,7 +80,7 @@ Creating a ``Datasette()`` instance like this as useful shortcut in tests, but t
This method registers any :ref:`plugin_hook_startup` or :ref:`plugin_hook_prepare_jinja2_environment` plugins that might themselves need to make async calls. This method registers any :ref:`plugin_hook_startup` or :ref:`plugin_hook_prepare_jinja2_environment` plugins that might themselves need to make async calls.
If you are using ``await datasette.client.get()`` and similar methods then you don't need to worry about this - those method calls ensure that ``.invoke_startup()`` has been called for you. If you are using ``await datasette.client.get()`` and similar methods then you don't need to worry about this - Datasette automatically calls ``invoke_startup()`` the first time it handles a request.
.. _testing_plugins_pdb: .. _testing_plugins_pdb:

View file

@ -25,6 +25,7 @@ async () => {
let output = await pyodide.runPythonAsync(\` let output = await pyodide.runPythonAsync(\`
import micropip import micropip
await micropip.install('h11==0.12.0') await micropip.install('h11==0.12.0')
await micropip.install('httpx==0.23')
await micropip.install('http://localhost:8529/$wheel') await micropip.install('http://localhost:8529/$wheel')
import ssl import ssl
import setuptools import setuptools

View file

@ -23,6 +23,17 @@ UNDOCUMENTED_PERMISSIONS = {
} }
def wait_until_responds(url, timeout=5.0, client=httpx, **kwargs):
start = time.time()
while time.time() - start < timeout:
try:
client.get(url, **kwargs)
return
except httpx.ConnectError:
time.sleep(0.1)
raise AssertionError("Timed out waiting for {} to respond".format(url))
def pytest_report_header(config): def pytest_report_header(config):
return "SQLite: {}".format( return "SQLite: {}".format(
sqlite3.connect(":memory:").execute("select sqlite_version()").fetchone()[0] sqlite3.connect(":memory:").execute("select sqlite_version()").fetchone()[0]
@ -111,13 +122,7 @@ def ds_localhost_http_server():
# Avoid FileNotFoundError: [Errno 2] No such file or directory: # Avoid FileNotFoundError: [Errno 2] No such file or directory:
cwd=tempfile.gettempdir(), cwd=tempfile.gettempdir(),
) )
# Loop until port 8041 serves traffic wait_until_responds("http://localhost:8041/")
while True:
try:
httpx.get("http://localhost:8041/")
break
except httpx.ConnectError:
time.sleep(0.1)
# Check it started successfully # Check it started successfully
assert not ds_proc.poll(), ds_proc.stdout.read().decode("utf-8") assert not ds_proc.poll(), ds_proc.stdout.read().decode("utf-8")
yield ds_proc yield ds_proc
@ -125,46 +130,6 @@ def ds_localhost_http_server():
ds_proc.terminate() ds_proc.terminate()
@pytest.fixture(scope="session")
def ds_localhost_https_server(tmp_path_factory):
cert_directory = tmp_path_factory.mktemp("certs")
ca = trustme.CA()
server_cert = ca.issue_cert("localhost")
keyfile = str(cert_directory / "server.key")
certfile = str(cert_directory / "server.pem")
client_cert = str(cert_directory / "client.pem")
server_cert.private_key_pem.write_to_path(path=keyfile)
for blob in server_cert.cert_chain_pems:
blob.write_to_path(path=certfile, append=True)
ca.cert_pem.write_to_path(path=client_cert)
ds_proc = subprocess.Popen(
[
"datasette",
"--memory",
"-p",
"8042",
"--ssl-keyfile",
keyfile,
"--ssl-certfile",
certfile,
],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
cwd=tempfile.gettempdir(),
)
while True:
try:
httpx.get("https://localhost:8042/", verify=client_cert)
break
except httpx.ConnectError:
time.sleep(0.1)
# Check it started successfully
assert not ds_proc.poll(), ds_proc.stdout.read().decode("utf-8")
yield ds_proc, client_cert
# Shut it down at the end of the pytest session
ds_proc.terminate()
@pytest.fixture(scope="session") @pytest.fixture(scope="session")
def ds_unix_domain_socket_server(tmp_path_factory): def ds_unix_domain_socket_server(tmp_path_factory):
# This used to use tmp_path_factory.mktemp("uds") but that turned out to # This used to use tmp_path_factory.mktemp("uds") but that turned out to
@ -181,12 +146,7 @@ def ds_unix_domain_socket_server(tmp_path_factory):
# Poll until available # Poll until available
transport = httpx.HTTPTransport(uds=uds) transport = httpx.HTTPTransport(uds=uds)
client = httpx.Client(transport=transport) client = httpx.Client(transport=transport)
while True: wait_until_responds("http://localhost/_memory.json", client=client)
try:
client.get("http://localhost/_memory.json")
break
except httpx.ConnectError:
time.sleep(0.1)
# Check it started successfully # Check it started successfully
assert not ds_proc.poll(), ds_proc.stdout.read().decode("utf-8") assert not ds_proc.poll(), ds_proc.stdout.read().decode("utf-8")
yield ds_proc, uds yield ds_proc, uds

View file

@ -805,6 +805,7 @@ def test_settings_json(app_client):
assert { assert {
"default_page_size": 50, "default_page_size": 50,
"default_facet_size": 30, "default_facet_size": 30,
"default_allow_sql": True,
"facet_suggest_time_limit_ms": 50, "facet_suggest_time_limit_ms": 50,
"facet_time_limit_ms": 200, "facet_time_limit_ms": 200,
"max_returned_rows": 100, "max_returned_rows": 100,

View file

@ -215,6 +215,28 @@ def test_setting_type_validation():
assert '"default_page_size" should be an integer' in result.stderr assert '"default_page_size" should be an integer' in result.stderr
@pytest.mark.parametrize("default_allow_sql", (True, False))
def test_setting_default_allow_sql(default_allow_sql):
runner = CliRunner()
result = runner.invoke(
cli,
[
"--setting",
"default_allow_sql",
"on" if default_allow_sql else "off",
"--get",
"/_memory.json?sql=select+21&_shape=objects",
],
)
if default_allow_sql:
assert result.exit_code == 0, result.output
assert json.loads(result.output)["rows"][0] == {"21": 21}
else:
assert result.exit_code == 1, result.output
# This isn't JSON at the moment, maybe it should be though
assert "Forbidden" in result.output
def test_config_deprecated(): def test_config_deprecated():
# The --config option should show a deprecation message # The --config option should show a deprecation message
runner = CliRunner(mix_stderr=False) runner = CliRunner(mix_stderr=False)

View file

@ -13,17 +13,6 @@ def test_serve_localhost_http(ds_localhost_http_server):
}.items() <= response.json().items() }.items() <= response.json().items()
@pytest.mark.serial
def test_serve_localhost_https(ds_localhost_https_server):
_, client_cert = ds_localhost_https_server
response = httpx.get("https://localhost:8042/_memory.json", verify=client_cert)
assert {
"database": "_memory",
"path": "/_memory",
"tables": [],
}.items() <= response.json().items()
@pytest.mark.serial @pytest.mark.serial
@pytest.mark.skipif( @pytest.mark.skipif(
not hasattr(socket, "AF_UNIX"), reason="Requires socket.AF_UNIX support" not hasattr(socket, "AF_UNIX"), reason="Requires socket.AF_UNIX support"

View file

@ -0,0 +1,33 @@
#!/bin/bash
# Generate certificates
python -m trustme
# This creates server.pem, server.key, client.pem
# Start the server in the background
datasette --memory \
--ssl-keyfile=server.key \
--ssl-certfile=server.pem \
-p 8152 &
# Store the background process ID in a variable
server_pid=$!
# Wait for the server to start
sleep 2
# Make a test request using curl
curl -f --cacert client.pem 'https://localhost:8152/_memory.json'
# Save curl's exit code (-f option causes it to return one on HTTP errors)
curl_exit_code=$?
# Shut down the server
kill $server_pid
sleep 1
# Clean up the certificates
rm server.pem server.key client.pem
echo $curl_exit_code
exit $curl_exit_code

View file

@ -2,6 +2,7 @@ from click.testing import CliRunner
from datasette import cli from datasette import cli
from unittest import mock from unittest import mock
import os import os
import pathlib
import pytest import pytest
@ -128,3 +129,55 @@ def test_publish_heroku_plugin_secrets(
mock.call(["heroku", "builds:create", "-a", "f", "--include-vcs-ignore"]), mock.call(["heroku", "builds:create", "-a", "f", "--include-vcs-ignore"]),
] ]
) )
@pytest.mark.serial
@mock.patch("shutil.which")
@mock.patch("datasette.publish.heroku.check_output")
@mock.patch("datasette.publish.heroku.call")
def test_publish_heroku_generate_dir(
mock_call, mock_check_output, mock_which, tmp_path_factory
):
mock_which.return_value = True
mock_check_output.side_effect = lambda s: {
"['heroku', 'plugins']": b"heroku-builds",
}[repr(s)]
runner = CliRunner()
os.chdir(tmp_path_factory.mktemp("runner"))
with open("test.db", "w") as fp:
fp.write("data")
output = str(tmp_path_factory.mktemp("generate_dir") / "output")
result = runner.invoke(
cli.cli,
[
"publish",
"heroku",
"test.db",
"--generate-dir",
output,
],
)
assert result.exit_code == 0
path = pathlib.Path(output)
assert path.exists()
file_names = {str(r.relative_to(path)) for r in path.glob("*")}
assert file_names == {
"requirements.txt",
"bin",
"runtime.txt",
"Procfile",
"test.db",
}
for name, expected in (
("requirements.txt", "datasette"),
("runtime.txt", "python-3.11.0"),
(
"Procfile",
(
"web: datasette serve --host 0.0.0.0 -i test.db "
"--cors --port $PORT --inspect-file inspect-data.json"
),
),
):
with open(path / name) as fp:
assert fp.read().strip() == expected