From 7b194920702358b65739a6e8bd3adb765ffa346a Mon Sep 17 00:00:00 2001 From: Simon Willison Date: Mon, 2 Nov 2020 10:27:25 -0800 Subject: [PATCH] database_actions() plugin hook, closes #1077 --- datasette/hookspecs.py | 5 +++++ datasette/static/app.css | 6 +++--- datasette/templates/database.html | 25 ++++++++++++++++++++++++- datasette/templates/table.html | 6 +++--- datasette/views/database.py | 15 +++++++++++++++ docs/plugin_hooks.rst | 16 ++++++++++++++++ tests/fixtures.py | 1 + tests/plugins/my_plugin.py | 11 +++++++++++ tests/test_api.py | 1 + tests/test_plugins.py | 19 ++++++++++++++++++- 10 files changed, 97 insertions(+), 8 deletions(-) diff --git a/datasette/hookspecs.py b/datasette/hookspecs.py index 78070e67..a305ca6a 100644 --- a/datasette/hookspecs.py +++ b/datasette/hookspecs.py @@ -107,3 +107,8 @@ def menu_links(datasette, actor): @hookspec def table_actions(datasette, actor, database, table): "Links for the table actions menu" + + +@hookspec +def database_actions(datasette, actor, database): + "Links for the database actions menu" diff --git a/datasette/static/app.css b/datasette/static/app.css index a1eb2099..675285c1 100644 --- a/datasette/static/app.css +++ b/datasette/static/app.css @@ -360,11 +360,11 @@ details .nav-menu-inner { display: block; } -/* Table actions menu */ -.table-menu-links { +/* Table/database actions menu */ +.actions-menu-links { position: relative; } -.table-menu-links .dropdown-menu { +.actions-menu-links .dropdown-menu { position: absolute; top: 2rem; right: 0; diff --git a/datasette/templates/database.html b/datasette/templates/database.html index 3b89d68b..7065f2c2 100644 --- a/datasette/templates/database.html +++ b/datasette/templates/database.html @@ -18,7 +18,30 @@ {% block content %} -

{{ metadata.title or database }}{% if private %} 🔒{% endif %}

+ +
+

{{ metadata.title or database }}{% if private %} 🔒{% endif %}

+ {% set links = database_actions() %}{% if links %} +
+ + Table actions + + + +
+ {% if links %} + + {% endif %} +
+
{% endif %} +
{% block description_source_license %}{% include "_description_source_license.html" %}{% endblock %} diff --git a/datasette/templates/table.html b/datasette/templates/table.html index 13f6a832..5034b62e 100644 --- a/datasette/templates/table.html +++ b/datasette/templates/table.html @@ -28,12 +28,12 @@

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

{% set links = table_actions() %}{% if links %} -
- + - Table actions + Table actions diff --git a/datasette/views/database.py b/datasette/views/database.py index 3ed60f4e..9a7b96fd 100644 --- a/datasette/views/database.py +++ b/datasette/views/database.py @@ -6,6 +6,7 @@ import json from urllib.parse import parse_qsl, urlencode from datasette.utils import ( + await_me_maybe, check_visibility, to_css_class, validate_sql_select, @@ -101,6 +102,19 @@ class DatabaseView(DataView): ) if visible: canned_queries.append(dict(query, private=private)) + + async def database_actions(): + links = [] + for hook in pm.hook.database_actions( + datasette=self.ds, + database=database, + actor=request.actor, + ): + extra_links = await await_me_maybe(hook) + if extra_links: + links.extend(extra_links) + return links + return ( { "database": database, @@ -118,6 +132,7 @@ class DatabaseView(DataView): ), }, { + "database_actions": database_actions, "show_hidden": request.args.get("_show_hidden"), "editable": True, "metadata": metadata, diff --git a/docs/plugin_hooks.rst b/docs/plugin_hooks.rst index 1c28c72e..6f8d269d 100644 --- a/docs/plugin_hooks.rst +++ b/docs/plugin_hooks.rst @@ -1057,3 +1057,19 @@ This example adds a new table action if the signed in user is ``"root"``: "href": datasette.urls.path("/-/edit-schema/{}/{}".format(database, table)), "label": "Edit schema for this table", }] + +.. _plugin_hook_database_actions: + +database_actions(datasette, actor, database) +-------------------------------------------- + +``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. + +This hook is similar to :ref:`plugin_hook_table_actions` but populates an actions menu on the database page. diff --git a/tests/fixtures.py b/tests/fixtures.py index d2ac661d..a48cfb46 100644 --- a/tests/fixtures.py +++ b/tests/fixtures.py @@ -38,6 +38,7 @@ EXPECTED_PLUGINS = [ "actor_from_request", "asgi_wrapper", "canned_queries", + "database_actions", "extra_body_script", "extra_css_urls", "extra_js_urls", diff --git a/tests/plugins/my_plugin.py b/tests/plugins/my_plugin.py index cd2c8e23..4ac3953b 100644 --- a/tests/plugins/my_plugin.py +++ b/tests/plugins/my_plugin.py @@ -333,3 +333,14 @@ def table_actions(datasette, database, table, actor): }, {"href": datasette.urls.instance(), "label": "Table: {}".format(table)}, ] + + +@hookimpl +def database_actions(datasette, database, actor): + if actor: + return [ + { + "href": datasette.urls.instance(), + "label": "Database: {}".format(database), + } + ] diff --git a/tests/test_api.py b/tests/test_api.py index 3365bf57..1a43e7f4 100644 --- a/tests/test_api.py +++ b/tests/test_api.py @@ -60,6 +60,7 @@ def test_homepage_sort_by_relationships(app_client): def test_database_page(app_client): response = app_client.get("/fixtures.json") + assert response.status == 200 data = response.json assert "fixtures" == data["database"] assert [ diff --git a/tests/test_plugins.py b/tests/test_plugins.py index 5e3d6dc3..3819c872 100644 --- a/tests/test_plugins.py +++ b/tests/test_plugins.py @@ -788,7 +788,7 @@ def test_hook_menu_links(app_client): def test_hook_table_actions(app_client, table_or_view): def get_table_actions_links(html): soup = Soup(html, "html.parser") - details = soup.find("details", {"class": "table-menu-links"}) + details = soup.find("details", {"class": "actions-menu-links"}) if details is None: return [] return [{"label": a.text, "href": a["href"]} for a in details.select("a")] @@ -802,3 +802,20 @@ def test_hook_table_actions(app_client, table_or_view): {"label": "Database: fixtures", "href": "/"}, {"label": "Table: {}".format(table_or_view), "href": "/"}, ] + + +def test_hook_database_actions(app_client): + def get_table_actions_links(html): + soup = Soup(html, "html.parser") + details = soup.find("details", {"class": "actions-menu-links"}) + if details is None: + return [] + return [{"label": a.text, "href": a["href"]} for a in details.select("a")] + + response = app_client.get("/fixtures") + assert get_table_actions_links(response.text) == [] + + response_2 = app_client.get("/fixtures?_bot=1") + assert get_table_actions_links(response_2.text) == [ + {"label": "Database: fixtures", "href": "/"}, + ]