From 909c85cd2b64646edaaa8e3c19f5cd4e51a13fad Mon Sep 17 00:00:00 2001 From: Simon Willison Date: Tue, 12 Mar 2024 14:25:07 -0700 Subject: [PATCH] view_actions plugin hook, closes #2297 --- datasette/hookspecs.py | 5 +++++ datasette/templates/table.html | 6 +++--- datasette/views/table.py | 30 ++++++++++++++++++------------ docs/plugin_hooks.rst | 26 +++++++++++++++++++++++++- tests/fixtures.py | 1 + tests/plugins/my_plugin.py | 12 ++++++++++++ tests/test_plugins.py | 26 +++++++++++++++++++++----- 7 files changed, 85 insertions(+), 21 deletions(-) diff --git a/datasette/hookspecs.py b/datasette/hookspecs.py index 5a8439b4..6ce1e85e 100644 --- a/datasette/hookspecs.py +++ b/datasette/hookspecs.py @@ -145,6 +145,11 @@ def table_actions(datasette, actor, database, table, request): """Links for the table actions menu""" +@hookspec +def view_actions(datasette, actor, database, view, request): + """Links for the view actions menu""" + + @hookspec def query_actions(datasette, actor, database, query_name, request, sql, params): """Links for the query and canned query actions menu""" diff --git a/datasette/templates/table.html b/datasette/templates/table.html index 1d328366..505335d6 100644 --- a/datasette/templates/table.html +++ b/datasette/templates/table.html @@ -24,17 +24,17 @@

{{ metadata.get("title") or table }}{% if is_view %} (view){% endif %}{% if private %} 🔒{% endif %}

-{% set links = table_actions() %}{% if links %} +{% set links = actions() %}{% if links %}
- Table actions + {% if is_view %}View{% else %}Table{% endif %} actions - Table actions + {% if is_view %}View{% else %}Table{% endif %} actions
diff --git a/datasette/views/table.py b/datasette/views/table.py index 6d0d9885..ba03241d 100644 --- a/datasette/views/table.py +++ b/datasette/views/table.py @@ -1401,22 +1401,28 @@ async def table_view_data( "Primary keys for this table" return pks - async def extra_table_actions(): - async def table_actions(): + async def extra_actions(): + async def actions(): links = [] - for hook in pm.hook.table_actions( - datasette=datasette, - table=table_name, - database=database_name, - actor=request.actor, - request=request, - ): + kwargs = { + "datasette": datasette, + "database": database_name, + "actor": request.actor, + "request": request, + } + if is_view: + kwargs["view"] = table_name + method = pm.hook.view_actions + else: + kwargs["table"] = table_name + method = pm.hook.table_actions + for hook in method(**kwargs): extra_links = await await_me_maybe(hook) if extra_links: links.extend(extra_links) return links - return table_actions + return actions async def extra_is_view(): return is_view @@ -1606,7 +1612,7 @@ async def table_view_data( "database", "table", "database_color", - "table_actions", + "actions", "filters", "renderers", "custom_table_templates", @@ -1647,7 +1653,7 @@ async def table_view_data( extra_database, extra_table, extra_database_color, - extra_table_actions, + extra_actions, extra_filters, extra_renderers, extra_custom_table_templates, diff --git a/docs/plugin_hooks.rst b/docs/plugin_hooks.rst index 4ac391ef..d08ea57a 100644 --- a/docs/plugin_hooks.rst +++ b/docs/plugin_hooks.rst @@ -1521,6 +1521,28 @@ This example adds a new table action if the signed in user is ``"root"``: Example: `datasette-graphql `_ +.. _plugin_hook_view_actions: + +view_actions(datasette, actor, database, view, request) +------------------------------------------------------- + +``datasette`` - :ref:`internals_datasette` + You can use this to access plugin configuration options via ``datasette.plugin_config(your_plugin_name)``, or to execute SQL queries. + +``actor`` - dictionary or None + The currently authenticated :ref:`actor `. + +``database`` - string + The name of the database. + +``view`` - string + The name of the SQL view. + +``request`` - :ref:`internals_request` or None + The current HTTP request. This can be ``None`` if the request object is not available. + +Like :ref:`plugin_hook_table_actions` but for SQL views. + .. _plugin_hook_query_actions: query_actions(datasette, actor, database, query_name, request, sql, params) @@ -1657,7 +1679,9 @@ This example adds a link an imagined tool for editing the homepage, only for sig if actor: return [ { - "href": datasette.urls.path("/-/customize-homepage"), + "href": datasette.urls.path( + "/-/customize-homepage" + ), "label": "Customize homepage", } ] diff --git a/tests/fixtures.py b/tests/fixtures.py index 61d240da..d668a8ea 100644 --- a/tests/fixtures.py +++ b/tests/fixtures.py @@ -56,6 +56,7 @@ EXPECTED_PLUGINS = [ "skip_csrf", "startup", "table_actions", + "view_actions", ], }, { diff --git a/tests/plugins/my_plugin.py b/tests/plugins/my_plugin.py index 94267f04..509418d4 100644 --- a/tests/plugins/my_plugin.py +++ b/tests/plugins/my_plugin.py @@ -391,6 +391,18 @@ def table_actions(datasette, database, table, actor): ] +@hookimpl +def view_actions(datasette, database, view, actor): + if actor: + return [ + { + "href": datasette.urls.instance(), + "label": f"Database: {database}", + }, + {"href": datasette.urls.instance(), "label": f"View: {view}"}, + ] + + @hookimpl def query_actions(datasette, database, query_name, sql): # Don't explain an explain diff --git a/tests/test_plugins.py b/tests/test_plugins.py index dcc5de20..88af3999 100644 --- a/tests/test_plugins.py +++ b/tests/test_plugins.py @@ -923,18 +923,34 @@ async def test_hook_menu_links(ds_client): @pytest.mark.asyncio -@pytest.mark.parametrize("table_or_view", ["facetable", "simple_view"]) -async def test_hook_table_actions(ds_client, table_or_view): - response = await ds_client.get(f"/fixtures/{table_or_view}") +async def test_hook_table_actions(ds_client): + response = await ds_client.get("/fixtures/facetable") assert get_actions_links(response.text) == [] - response_2 = await ds_client.get(f"/fixtures/{table_or_view}?_bot=1&_hello=BOB") + response_2 = await ds_client.get("/fixtures/facetable?_bot=1&_hello=BOB") assert sorted( get_actions_links(response_2.text), key=lambda link: link["label"] ) == [ {"label": "Database: fixtures", "href": "/", "description": None}, {"label": "From async BOB", "href": "/", "description": None}, - {"label": f"Table: {table_or_view}", "href": "/", "description": None}, + {"label": "Table: facetable", "href": "/", "description": None}, + ] + + +@pytest.mark.asyncio +async def test_hook_view_actions(ds_client): + response = await ds_client.get("/fixtures/simple_view") + assert get_actions_links(response.text) == [] + + response_2 = await ds_client.get( + "/fixtures/simple_view", + cookies={"ds_actor": ds_client.actor_cookie({"id": "bob"})}, + ) + assert sorted( + get_actions_links(response_2.text), key=lambda link: link["label"] + ) == [ + {"label": "Database: fixtures", "href": "/", "description": None}, + {"label": "View: simple_view", "href": "/", "description": None}, ]