Compare commits

..
9 Commits
Author SHA1 Message Date
Phil 191c99b59b Merge branch 'feat/v2.17.0-article-urls' for v2.17.0 release
Build Container / build (push) Failing after 9m31s
2026-11-12 12:27:55 -07:00
PhilandClaude Opus 5.5 b7f8e1612c feat: articles at /article/<slug> with slugs from their titles (v2.17.0, ADR-077)
Articles (notes with a title) move from /note/<slug> to /article/<slug>;
the other prefix 301-redirects. New articles take their slug from the
title (mp-slug still wins; notes keep timestamp slugs). A Micropub update
that adds or removes a title answers 201 with the new Location.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 12:27:31 -07:00
Phil 66aecc2bcb Merge branch 'feat/v2.16.0-articles' for v2.16.0 release
Build Container / build (push) Successful in 9m35s
2026-11-11 17:25:39 -07:00
PhilandClaude Opus 5.5 ccb9f6dce2 fix: keep inline images in Micropub articles (v2.16.0)
- Content sent as both html and text is stored as the HTML; the text is
  usually a plain fallback, so images, links and headings were lost.
- Images embedded from other sites are copied into the media library
  (SSRF-checked fetcher, best effort, max 20) and the text points at the
  copies, on create and on content replace.
- HTML content is sanitized as is instead of going through Markdown, which
  added stray <br>s and empty paragraphs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 17:11:46 -07:00
PhilandClaude Opus 5.5 978c13358b feat: article titles and summaries stored apart from the text (v2.16.0, ADR-076)
Articles as the IndieWeb defines them: a name separate from the content.

- Migration 023 adds notes.title and notes.summary. A one-time Python data
  step (migrations.DATA_MIGRATIONS) moves each note's '# Heading' first line
  into title, rewrites the file and hash, empties FTS for a rebuild, and puts
  files back if the migration fails. Trashed notes included.
- Micropub: name -> title, summary stored when sent with content, summary
  updatable, q=source returns both. MCP tools take a summary.
- Feeds: titles only for articles (RSS/JSON none, Atom empty); Atom and
  JSON Feed summaries; the title is no longer repeated in the content.
- Pages: p-name/p-summary on the article page. Homepage and tag pages show
  articles as title, summary and "Read more" without images (hidden u-photo
  keeps the post type for parsers).
- Crossposts: articles go out as title, summary, link and hashtags, no
  images; the Bluesky card is the article. Notes unchanged.
- Editor: Title and Summary fields; an article may have no body.
- Fix: a line starting with a hashtag ('#indieweb ...') was rendered as a
  heading and crossposted without its '#' (HashtagLineExtension).
- Fix: excerpts showed raw Markdown; they are plain text now.

Back up the database and the data folder before deploying: the migration
rewrites note files.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 17:05:38 -07:00
Phil 9a0d82bab2 Merge branch 'feat/v2.15.0-mcp' for v2.15.0 release
Build Container / build (push) Successful in 9m40s
2026-11-11 16:39:39 -07:00
PhilandClaude Opus 5.5 84411a16d9 feat: MCP server for AI clients (v2.15.0, ADR-075)
Add an MCP server at SITE_URL/mcp so AI assistants (claude.ai connectors,
Claude Code) can search, read and write notes.

- starpunk/mcp_server: official MCP SDK 2.3, stateless Streamable HTTP with
  JSON responses, served by uvicorn as a sidecar from the same image.
  Ten tools; writes go through the Micropub handlers.
- IndieAuth: RFC 8707 resource indicators bound to codes and tokens
  (migration 022), client ID metadata document + public client metadata,
  draft in scopes_supported, default MCP scopes, consent screen note.
- BACKGROUND_WORKERS_ENABLED flag so the sidecar runs no workers.
- Docs: ADR-075, architecture/mcp.md and updates; CHANGELOG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 16:36:58 -07:00
Phil 4ed2033cf9 Merge branch 'fix/v2.14.2-quotes-cleanup' for v2.14.2 release
Build Container / build (push) Successful in 9m37s
2026-11-10 15:54:55 -07:00
PhilandClaude Opus 5.5 d354dc9733 fix: quote counts in the counts line; remove dead editor scripts and files (v2.14.2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 15:54:46 -07:00
87 changed files with 2692 additions and 505 deletions

No files matched your search

+63
View File
@@ -7,6 +7,69 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
## [2.17.0] - 2026-11-12
Articles get URLs of their own (ADR-077).
### Changed
- Articles live at `/article/<slug>` instead of `/note/<slug>`. The other address redirects (301), so links keep working when a note gains or loses a title. Feeds, pages, Micropub, crossposts, webmentions, notifications, search and the MCP tools all give the new URLs
- A new article's slug comes from its title (`Why I Left Twitter` → `why-i-left-twitter`; `-2` if taken). An `mp-slug` still wins, notes keep timestamp slugs, and slugs don't change when a title is edited later
- A Micropub update that adds or removes a title answers 201 with the post's new URL in `Location`, as the spec requires
## [2.16.0] - 2026-11-11
Articles as the IndieWeb defines them: titles and summaries stored apart from the text (ADR-076).
**Before upgrading, back up the database and the `data` folder (notes and `.trash`).** Migration 023 moves each note's `# Heading` title out of its Markdown file into the database.
### Added
- Notes have a title and a summary of their own. A note with a title is an article. The editor has Title and Summary fields, and an article may have no body text
- Micropub `summary` is stored when sent with `content`, can be replaced and deleted, and comes back from `q=source`. A summary on its own is still the content, as Post Type Discovery reads it. The MCP `create_note` and `update_note` tools take a `summary`
- Article pages mark up the summary as `p-summary`; Atom entries have `<summary>` and JSON Feed items `summary`
### Changed
- A `# Heading` at the top of a note is now just a heading, not a title. Micropub `name` is stored as the title instead of being added to the text; a heading that repeats it is dropped
- Feed items have a title only for articles. RSS items and JSON Feed items for notes have none, and Atom entries an empty one, so feed readers no longer show notes as headlines
- On the homepage and tag pages an article shows its title, its summary (or the start of its text) and "Read more", without its images
- Micropub content sent as both `html` and `text` is stored as the HTML. The text is usually a plain fallback, so articles lost their images, links and headings
- Images embedded in Micropub content from other sites are copied into the media library and the text points at the copies, so an article doesn't break when the client's or a CDN's host goes away. Best effort: an image that can't be fetched keeps its URL (up to 20 per post)
- Articles are crossposted to GoToSocial, Bluesky and Threads as title, summary (or the start of the text), link and hashtags, without images. On Bluesky the link card is the article. Notes are crossposted in full as before
### Fixed
- Feeds showed an article's title twice: as the item title and again at the top of the content
- A line starting with a hashtag (`#indieweb is fun`) was shown as a heading on pages and in feeds, and crossposted without its `#`. Only `#` followed by a space starts a heading now, as in CommonMark
- HTML content from Micropub is sanitized as is instead of going through Markdown, which added stray line breaks and empty paragraphs
- Previews, image alt text and crosspost teasers showed raw Markdown (`**bold**`, `[link](url)`); the excerpt is now plain text
## [2.15.0] - 2026-11-11
MCP server for AI clients (ADR-075).
### Added
- An [MCP](https://modelcontextprotocol.io/) server at `SITE_URL/mcp`. AI assistants such as claude.ai custom connectors and Claude Code can search, list and read notes and drafts, list tags, create notes (drafts by default), update, delete and undelete them, and upload photos. Writes go through the Micropub handlers, so scopes, crossposting, webmentions and WebSub behave the same as with any Micropub app
- The MCP server runs as a sidecar from the same image (`uvicorn starpunk.mcp_server.app:app --port 8001`) with `BACKGROUND_WORKERS_ENABLED=false`; the proxy sends `/mcp*` and `/.well-known/oauth-protected-resource*` to it. New dependencies: `mcp` 2.3 and `uvicorn` 0.54
- The IndieAuth server accepts RFC 8707 `resource` for the MCP endpoint and binds codes and tokens to it (migration 022). Its metadata advertises client ID metadata documents and public clients (`token_endpoint_auth_methods_supported: ["none"]`), so Claude connects without dynamic client registration. The consent screen says when an AI assistant is asking, and Connected Apps marks MCP tokens
- `BACKGROUND_WORKERS_ENABLED` (default `true`) turns off the webmention, WebSub and syndication workers
### Fixed
- `scopes_supported` in the IndieAuth metadata lists `draft`, which Micropub already honoured
## [2.14.2] - 2026-11-10
### Added
- Quotes have a count in the line under each note (❝) and in the counts on the home, tag and Likes pages. It includes quotes a silo reports without names (Threads, and people who opted out of backfeed), which were stored but shown nowhere
### Removed
- The editor pages no longer load `marked` from a CDN and an empty `static/js/preview.js`; nothing used them
- The empty `templates/feed.xml`, the v1 `static/indielogin-test.html`, and the `THREADS_API` setting that crossposting read but nothing could set
## [2.14.1] - 2026-11-10
### Fixed
+2
View File
@@ -78,6 +78,8 @@ USER starpunk
# Expose application port
EXPOSE 8000
# MCP sidecar (same image, run with: uvicorn starpunk.mcp_server.app:app --host 0.0.0.0 --port 8001)
EXPOSE 8001
# Health check
# Uses httpx (already in requirements) to verify app is responding
+3
View File
@@ -23,6 +23,9 @@ what changed in each release is in [CHANGELOG.md](CHANGELOG.md).
- Built-in [IndieAuth](https://indieauth.spec.indieweb.org/) server for
Micropub apps (consent screen, tokens, revocation, Connected Apps page)
- Admin login through any OpenID Connect provider (e.g. Pocket ID)
- [MCP](https://modelcontextprotocol.io/) server at `/mcp` so AI assistants
(claude.ai connectors, Claude Code…) can search, read and write notes
after you approve them, run as an optional sidecar (ADR-075)
- [Webmention](https://www.w3.org/TR/webmention/): receiving (verified,
moderated, rate-limited) and sending; replies, quotes and mentions shown
on each note, with likes, reposts and replies as a line of counts with
+2 -1
View File
@@ -13,10 +13,11 @@ original v0.x technology choices are kept in
|----------|-------------|
| [overview.md](overview.md) | System overview: purpose, request flow, modules and routes, background workers, storage, auth model, URL surface, caching, security posture |
| [technology-stack.md](technology-stack.md) | Current runtime, Python dependencies, standards implemented, testing and CI |
| [database.md](database.md) | SQLite schema after migrations 001–021, migration runner and its lock, connection pool |
| [database.md](database.md) | SQLite schema after migrations 001–022, migration runner and its lock, connection pool |
| [deployment.md](deployment.md) | Container image stages, CI workflow, release process, `/data` layout, reverse proxy, all environment variables |
| [simplified-auth-architecture.md](simplified-auth-architecture.md) | Admin login via OpenID Connect and the built-in IndieAuth server that issues Micropub tokens (ADR-064) |
| [indieweb-protocols.md](indieweb-protocols.md) | How Micropub, IndieAuth, Webmention, microformats2, WebSub and the feeds are implemented (including backfeed responses, web actions and notifications), with compliance status and known gaps |
| [mcp.md](mcp.md) | The MCP server for AI clients: sidecar, authorization flow, tools (ADR-075) |
| [syndication-architecture.md](syndication-architecture.md) | Crossposting (POSSE) to GoToSocial, Bluesky and Threads: syndications table, worker, reconcile rules, backfeed of responses (ADR-073) |
## Where to start
+5 -4
View File
@@ -2,7 +2,7 @@
**Version**: 2.14.0 (2026-11-10)
**Status**: Current. Verified against a database created by `create_app()`
with migrations 001–021.
with migrations 001–022.
StarPunk uses one SQLite file, `starpunk.db` under `DATA_PATH` (`/data` in
the container), in WAL mode. Note *content* is not in the database: it lives
@@ -75,6 +75,7 @@ Background: [ADR-031](../decisions/ADR-031-database-migration-system-redesign.md
| `019_shared_rate_limits.sql` | 2.11.0 | `rate_limits` (counters shared by all processes) |
| `020_backfeed.sql` | 2.13.0 | Rebuilds `webmentions` adding `origin`, `remote_id`, the `quote` type and an index on (`target_note_id`, `origin`); `syndications.backfeed_next_at`, `backfeed_checked_at`, `backfeed_claimed_until`, `backfeed_attempts`, `backfeed_error`, `backfeed_backfill`, `likes_count`, `reposts_count`, `quotes_count` |
| `021_notifications.sql` | 2.14.0 | `webmentions.notified_at`; existing rows are marked as notified |
| `022_indieauth_resource.sql` | 2.15.0 | `indieauth_codes.resource` and `indieauth_tokens.resource` (RFC 8707, MCP tokens; ADR-075) |
New migrations are numbered `NNN_description.sql`, must be safe to run inside
one transaction, and should use `IF NOT EXISTS` where SQLite allows it.
@@ -128,12 +129,12 @@ value), `me`, `created_at`, `expires_at`, `last_used_at`, `user_agent`,
(primary key), `nonce`, `code_verifier` (PKCE), `next_url`, `expires_at`.
Consumed once on callback.
**`indieauth_codes`**: authorization codes issued to Micropub clients:
**`indieauth_codes`**: authorization codes issued to Micropub and MCP clients:
`code_hash`, `client_id`, `redirect_uri`, `scope`, `code_challenge`,
`expires_at`, `used_at` (single use).
`resource` (`SITE_URL/mcp` or NULL), `expires_at`, `used_at` (single use).
**`indieauth_tokens`**: access tokens: `token_hash`, `client_id`, `scope`,
`created_at`, `expires_at`, `last_used_at`, `revoked_at`. Listed and revoked
`resource` (`SITE_URL/mcp` for MCP tokens, NULL for Micropub), `created_at`, `expires_at`, `last_used_at`, `revoked_at`. Listed and revoked
in `/admin/tokens`.
**Legacy tables, unused**: `auth_state` (v1 IndieLogin login state), `tokens`
+9
View File
@@ -125,6 +125,14 @@ WebSub rate limits need; without it, every client appears as the proxy's
address and shares one limit. Do not set it if the container port can be
reached without the proxy, because the header could then be forged.
The MCP sidecar (v2.15.0, ADR-075) is a second container from the same
image, with the same environment and `/data` volume plus
`BACKGROUND_WORKERS_ENABLED=false`, running
`uvicorn starpunk.mcp_server.app:app --host 0.0.0.0 --port 8001`. The proxy
sends `/mcp*` and `/.well-known/oauth-protected-resource*` to it, keeping the
`Host` header; everything else goes to port 8000. Without the sidecar the
site simply has no MCP endpoint. See [mcp.md](mcp.md).
`SITE_URL` must be the public `https://` URL: it is used for absolute links,
feed and WebSub topic URLs, the IndieAuth issuer and redirect URIs, and to
decide whether the session cookie is `Secure`.
@@ -175,6 +183,7 @@ ignored with a warning.
| `FLASK_DEBUG` | `0` | Debug off unless `1` (`flask run --debug` sets it locally); the image sets `0` |
| `LOG_LEVEL` | `INFO` | `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` |
| `VERSION` | package `__version__` | Overrides the reported version; normally unset |
| `BACKGROUND_WORKERS_ENABLED` | `true` | `false` stops the webmention, WebSub and syndication workers; set in the MCP sidecar (v2.15.0) |
### Feeds
+1 -1
View File
@@ -266,7 +266,7 @@ tombstone, so a re-sent webmention or backfeed doesn't bring it back.
Changes that alter what is shown also re-send the note's webmentions.
Note pages show approved, valid responses. Under the note, a line of counts
(♥ likes, 🔁 reposts, 💬 replies, bookmarks) opens a card on hover or focus
(♥ likes, 🔁 reposts, 💬 replies, ❝ quotes (v2.14.2), bookmarks) opens a card on hover or focus
listing who responded and where from, including anonymous silo counts. Each
like, repost and reply count holds an `<indie-action do with>` web action
whose fallback links to the note's crossposts (v2.13.2). The Responses
+77
View File
@@ -0,0 +1,77 @@
# MCP server (v2.15.0)
How AI clients use StarPunk through the
[Model Context Protocol](https://modelcontextprotocol.io/). The decision and
alternatives are in [ADR-075](../decisions/ADR-075-mcp-server.md).
## Shape
```
client ──HTTPS──> reverse proxy
/mcp*, /.well-known/oauth-protected-resource* ──> starpunk-mcp:8001 (uvicorn, MCP SDK)
everything else (incl. /auth/*, /.well-known/oauth-authorization-server)
──> starpunk:8000 (gunicorn, Flask)
starpunk and starpunk-mcp: same image, same environment, same /data volume
```
| Module | Role |
|---|---|
| `starpunk/mcp_server/app.py` | ASGI entry: `uvicorn starpunk.mcp_server.app:app --host 0.0.0.0 --port 8001` |
| `starpunk/mcp_server/server.py` | `create_mcp_server(app)` and `create_asgi_app(app=None)`: stateless Streamable HTTP, JSON responses, 16 MB request limit, DNS rebinding protection |
| `starpunk/mcp_server/auth.py` | `StarPunkTokenVerifier`: StarPunk tokens to SDK `AccessToken`s |
| `starpunk/mcp_server/tools.py` | The tools; each runs in a thread inside `app.test_request_context(base_url=SITE_URL)` |
`create_asgi_app()` with no argument builds the Flask app from the
environment with `BACKGROUND_WORKERS_ENABLED=false`. The sidecar container
should also set that variable, for clarity.
## Authorization flow
1. The client POSTs to `/mcp` without a token and gets `401` with
`WWW-Authenticate: Bearer ... resource_metadata="SITE_URL/.well-known/oauth-protected-resource/mcp"`.
2. That document names `SITE_URL/mcp` as the resource and `SITE_URL/` as
the authorization server. The client reads
`/.well-known/oauth-authorization-server`, which says it accepts client ID
metadata documents and public clients.
3. The client sends the owner to `/auth/authorize` with its `client_id` URL,
PKCE and `resource=SITE_URL/mcp`. StarPunk fetches the client's metadata
document to check `redirect_uri` (unless it has the same origin as the
`client_id`), and the owner logs in with OIDC and approves. With no
`scope`, the default MCP scopes are offered.
4. The token endpoint exchanges the code. The token is bound to the
resource.
5. Each MCP request carries the token. The verifier looks it up and the SDK
refuses it unless its resource is `SITE_URL/mcp`.
Details of codes, tokens and scopes are in
[simplified-auth-architecture.md](simplified-auth-architecture.md).
## Tools
| Tool | Does | Scope |
|---|---|---|
| `search_notes(query, include_drafts, limit)` | FTS5 search, with snippets | any; drafts need a posting scope |
| `list_notes(include_drafts, limit, offset)` | Newest first, summaries | any; drafts need a posting scope |
| `get_note(url_or_slug)` | Microformats2 properties (as Micropub `q=source`) | any; drafts need a posting scope |
| `list_tags(filter)` | Tags in use, most used first | posting scope |
| `get_site_config()` | Micropub `q=config`, including `syndicate-to` targets | any |
| `create_note(content, title, tags, draft=True, photos, in_reply_to, like_of, repost_of, bookmark_of, syndicate_to, slug, published_at)` | Micropub create | `create` or `draft` |
| `update_note(url, content, title, tags, add_tags, remove_tags, draft, photos, in_reply_to)` | Micropub update | `update` |
| `delete_note(url)`, `undelete_note(url)` | Soft delete and restore | `delete` |
| `upload_media(filename, data_base64)` | Save an image, return its URL | `media` or `create` |
"Posting scope" means `create`, `update`, `delete` or `draft`. Limits are
capped at 100. Micropub errors come back as tool errors (`isError`) with the
Micropub error description.
## Operating it
- Environment: the same as the main container, plus
`BACKGROUND_WORKERS_ENABLED=false`.
- Proxy: route `/mcp*` and `/.well-known/oauth-protected-resource*` to port
8001, keeping the `Host` header (DNS rebinding protection checks it
against `SITE_URL`).
- Connecting: claude.ai Settings → Connectors → Add custom connector with
`SITE_URL/mcp`; Claude Code: `claude mcp add --transport http starpunk
SITE_URL/mcp`, then `/mcp` to authenticate.
- Revoking: Admin → Connected Apps (MCP tokens are marked "(MCP)").
+11 -1
View File
@@ -223,6 +223,9 @@ coordinated through the data volume:
| WebSub worker (`websub_worker.py`) | `WEBSUB_ENABLED` and not testing | Same pattern with `websub-worker.lock` | Verifies subscription intents, delivers topic content (signed with `X-Hub-Signature` when the subscriber gave a secret), retries, expires leases; pings an external hub instead if `WEBSUB_HUB_URL` is set |
| Syndication worker (`syndication.py`) | At least one crosspost target configured, and not testing | No file lock. Rows in `syndications` are claimed with a 5-minute `claimed_until` lease by an atomic `UPDATE`, so any process may work a row but only one at a time; a `version` column keeps edits made during a send. Threads token refreshes are serialised with a lock file next to `threads_token.json`. | Creates, updates or deletes the remote post for each (note, target) pair; up to 8 attempts. Then, only when `BACKFEED_ENABLED`, backfeed: checks copies for responses, each claimed with a `backfeed_claimed_until` lease (v2.13.0, `backfeed.py`, ADR-073) |
`BACKGROUND_WORKERS_ENABLED=false` starts none of them; the MCP sidecar
(below) sets it so the workers only run in the main container.
All workers run inside an app context, are daemon threads (they end with the
process) and sleep for their poll interval when there is nothing to do. Under
the test suite (`TESTING=True`) none of them start; tests call the processing
@@ -273,7 +276,14 @@ are in [simplified-auth-architecture.md](simplified-auth-architecture.md).
OIDC) approves; the client exchanges the code at `/auth/token` (PKCE
required). Codes and tokens are stored hashed. Tokens last
`INDIEAUTH_TOKEN_LIFETIME_DAYS` and can be revoked at `/auth/revoke` or in
`/admin/tokens`. Scopes: `create`, `update`, `delete`, `media`, `profile`.
`/admin/tokens`. Scopes: `create`, `update`, `delete`, `media`, `draft`,
`profile`.
- **MCP (v2.15.0, ADR-075)**: AI clients use the same flow, identified by a
client ID metadata document and asking for `resource=SITE_URL/mcp`. Their
tokens are bound to that resource and checked by the MCP sidecar, a second
container (uvicorn, official MCP SDK) that the proxy sends `/mcp` to. Its
tools read, search and write notes through the Micropub handlers. See
[mcp.md](mcp.md).
- **Development**: `DEV_MODE=true` adds `/dev/login`, which logs in as
`DEV_ADMIN_ME` without any checks. Never enabled in production; start-up
logs a warning when it is on.
@@ -137,8 +137,10 @@ form `{"error", "error_description"}`.
"token_endpoint": "<SITE_URL>/auth/token",
"revocation_endpoint": "<SITE_URL>/auth/revoke",
"revocation_endpoint_auth_methods_supported": ["none"],
"scopes_supported": ["create", "update", "delete", "media", "profile"],
"scopes_supported": ["create", "update", "delete", "media", "draft", "profile"],
"response_types_supported": ["code"],
"token_endpoint_auth_methods_supported": ["none"],
"client_id_metadata_document_supported": true,
"grant_types_supported": ["authorization_code"],
"code_challenge_methods_supported": ["S256"],
"authorization_response_iss_parameter_supported": true
@@ -192,7 +194,7 @@ requested and left checked, issues a code, and redirects with `code`,
| Value | 32 random bytes, URL-safe | 32 random bytes, URL-safe |
| Stored as | SHA-256 hash | SHA-256 hash |
| Lifetime | 10 minutes | `INDIEAUTH_TOKEN_LIFETIME_DAYS` (default 90) |
| Bound to | `client_id`, `redirect_uri`, `scope`, `code_challenge` | `client_id`, `scope` |
| Bound to | `client_id`, `redirect_uri`, `scope`, `code_challenge`, `resource` | `client_id`, `scope`, `resource` |
`redeem_authorization_code` handles redemption for both `POST /auth/token`
and `POST /auth/authorize`:
@@ -213,11 +215,22 @@ refresh tokens: a client re-authorizes when its token expires.
Expired codes are deleted whenever a new code is issued.
**Resource indicators (v2.15.0, ADR-075).** An authorization request may
include `resource` (RFC 8707). The only accepted value is `SITE_URL/mcp`
(a trailing slash is ignored); anything else is `invalid_target`. With it,
a request without `scope` is offered `create update delete media draft`, and
the consent screen says the client is an AI assistant using MCP. The resource
is stored on the code and then on the token. A token request that names a
different resource gets `invalid_target`. Micropub clients send no resource
and their tokens have none. The MCP endpoint only accepts tokens for its
resource; see [mcp.md](mcp.md).
### Verification and revocation
- `verify_access_token(token)` hashes the token and accepts it if it is
neither revoked nor expired, then updates `last_used_at`. It returns
`{me: ADMIN_ME, client_id, scope}`.
`{me: ADMIN_ME, client_id, scope, resource, expires_at}`. The legacy
`GET /auth/token` still answers with only `me`, `client_id` and `scope`.
- `check_scope(required, scope)` matches whole words in the space-separated
scope string.
- Revocation sets `revoked_at`. It can happen by token value, through
@@ -308,8 +321,8 @@ enough. If it is another page, that page must advertise StarPunk's
|---|---|---|
| `sessions` | Admin browser sessions | `session_token_hash`, `me`, `expires_at`, `last_used_at`, `user_agent`, `ip_address` |
| `oidc_login_state` | One pending OIDC login | `state` (PK), `nonce`, `code_verifier`, `next_url`, `expires_at` |
| `indieauth_codes` | Authorization codes | `code_hash`, `client_id`, `redirect_uri`, `scope`, `code_challenge`, `expires_at`, `used_at` |
| `indieauth_tokens` | Access tokens | `token_hash`, `client_id`, `scope`, `expires_at`, `last_used_at`, `revoked_at` |
| `indieauth_codes` | Authorization codes | `code_hash`, `client_id`, `redirect_uri`, `scope`, `code_challenge`, `resource` (migration 022), `expires_at`, `used_at` |
| `indieauth_tokens` | Access tokens | `token_hash`, `client_id`, `scope`, `resource` (migration 022), `expires_at`, `last_used_at`, `revoked_at` |
The legacy v1 tables `auth_state`, `tokens` and `authorization_codes` are
not used (see the migration's header comment).
@@ -338,7 +351,6 @@ connection pinned, a 5-second limit).
Known gaps:
- `scopes_supported` leaves out `draft`, although Micropub honours it and
the consent screen grants it when requested. Unknown scopes are also shown
and granted as requested; they just have no effect.
- Unknown scopes are shown and granted as requested; they just have no
effect. (`draft` has been listed in `scopes_supported` since v2.15.0.)
- No token introspection endpoint and no refresh tokens.
+3
View File
@@ -48,6 +48,8 @@ vulnerabilities (`pip-audit`); check again before each release.
| python-dotenv | `1.2.*` | Loading `.env` |
| Pillow | `13.0.*` | Image validation, resizing and variants; converting response avatars to 96 px WebP (`avatars.py`) |
| pillow-heif | `1.8.*` | HEIC/HEIF uploads (iPhone photos) |
| mcp | `2.3.*` | MCP server for AI clients (`starpunk/mcp_server/`, ADR-075); brings Starlette, pydantic and anyio. Only the sidecar imports it |
| uvicorn | `0.54.*` | ASGI server for the MCP sidecar |
`markupsafe` comes with Flask/Jinja2.
@@ -72,6 +74,7 @@ front-end framework or bundler, no separate search server.
| IndieWeb | Micropub (create, update, delete, undelete, queries, media endpoint), IndieAuth (authorization server with PKCE, metadata endpoint, token revocation), Webmention (send and receive), WebSub (publisher and built-in hub), microformats2 (h-entry, h-feed, h-card markup and parsing), rel=me, web actions (`<indie-action>`), backfeed of responses from the silos |
| Login | OpenID Connect authorization code flow with PKCE (provider: Pocket ID) |
| Feeds | RSS 2.0, Atom 1.0, JSON Feed 1.1, OPML 2.0, HTTP content negotiation |
| AI clients | Model Context Protocol (Streamable HTTP, stateless), OAuth 2.0 Protected Resource Metadata (RFC 9728), Resource Indicators (RFC 8707), Client ID Metadata Documents |
| Crossposting | Mastodon client API (GoToSocial), AT Protocol (Bluesky XRPC), Threads Graph API; the same APIs are read for backfeed |
Protocol details: [indieweb-protocols.md](indieweb-protocols.md),
@@ -6,6 +6,8 @@ Accepted
> Its deferral of WebSub is superseded by ADR-071 (v2.10.0), and "no feed caching" by the feed cache added in v1.1.2. RSS is now one of three feed formats (ADR-038) and is served at `/feed.rss` (`/feed.xml` still works). (status updated 2026-11-03)
> Item titles: since v2.16.0 only articles (notes with a title) have one; notes have none, and no first-line or date title is made up (ADR-076).
## Context
Phase 5 requires implementing RSS feed generation for syndicating published notes. We need to decide on the implementation approach, feed format, caching strategy, and technical details for generating a standards-compliant RSS feed.
@@ -3,6 +3,8 @@
## Status
Accepted (implemented in v1.3.0, reviewed in v2.8.0; was: Proposed)
> Since v2.16.0 `p-name` is the stored title and `p-summary` the author's summary or, in previews, the start of the text (ADR-076).
## Context
StarPunk currently implements basic microformats2 markup:
- h-entry on note articles
@@ -1,7 +1,7 @@
# ADR-062: Timestamp-Based Slug Format
## Status
Accepted (Supersedes ADR-007)
Accepted (Supersedes ADR-007). Articles take their slug from the title since v2.17.0 ([ADR-077](ADR-077-article-urls-and-title-slugs.md)).
## Context
+121
View File
@@ -0,0 +1,121 @@
# ADR-075: MCP server for AI clients
## Status
Accepted (v2.15.0, 2026-11-11)
## Context
The owner wants AI assistants (claude.ai custom connectors, Claude Code and
other [Model Context Protocol](https://modelcontextprotocol.io/) clients) to
read, search and write notes. Micropub already covers writing, but MCP
clients don't speak Micropub: they discover tools over MCP and get tokens
through OAuth 2.1 with protected resource metadata (RFC 9728), resource
indicators (RFC 8707), and either dynamic client registration or a Client ID
Metadata Document (CIMD).
StarPunk already runs an OAuth/IndieAuth authorization server (ADR-064) with
PKCE, public clients only, and clients identified by a `client_id` URL whose
JSON document lists `redirect_uris`. That is what MCP calls CIMD. Claude uses
CIMD when the server's metadata says `client_id_metadata_document_supported:
true` and lists `none` in `token_endpoint_auth_methods_supported`.
StarPunk is Flask on gunicorn sync workers (WSGI). The official MCP Python
SDK is ASGI.
Options considered:
1. **Local stdio bridge** that calls `/micropub` with a stored token, like
existing Micropub MCP servers. No server changes, but every client needs
the bridge installed, claude.ai and mobile can't use it, and reading is
limited to what Micropub queries expose.
2. **Hand-written MCP route in Flask**, stateless JSON only. No new
dependencies or processes, but StarPunk would own the protocol details
(version negotiation, JSON-RPC, Origin checks, auth metadata) and track
the spec itself.
3. **Official SDK in a sidecar process** from the same image, behind the
same reverse proxy, sharing the data volume.
4. **Dynamic client registration** (RFC 7591) in the authorization server.
Every connection would register a new client, and nothing needs it once
CIMD works.
## Decision
### 1. A sidecar running the official SDK (option 3)
`starpunk/mcp_server/` builds an `mcp.server.MCPServer` (SDK 2.3) and serves
it with uvicorn (`uvicorn starpunk.mcp_server.app:app --port 8001`), as a
second container from the same image. The reverse proxy sends `/mcp*` and
`/.well-known/oauth-protected-resource*` to it and everything else to
gunicorn. The endpoint is `SITE_URL/mcp`.
The transport is stateless Streamable HTTP with plain JSON responses. No
session lives in the process, so restarts and several workers are harmless.
The sidecar builds the Flask app with `BACKGROUND_WORKERS_ENABLED=false`, so
only the main container runs the webmention, WebSub and syndication
workers. Each tool runs in a worker thread inside a Flask request context
for `SITE_URL`, and calls the same service functions as the web app.
SQLite (WAL) handles the second process like another gunicorn worker.
### 2. StarPunk is the authorization server; the sidecar only checks tokens
- The authorization server metadata adds
`client_id_metadata_document_supported: true` and
`token_endpoint_auth_methods_supported: ["none"]`, and `scopes_supported`
now includes `draft`.
- An authorization request may carry `resource` (RFC 8707). The only resource
StarPunk names is `SITE_URL/mcp`; anything else is `invalid_target`. The
resource is stored on the code and the token (migration 022), shown on the
consent screen, and must match if the token request repeats it.
- An MCP request with no `scope` is offered `create update delete media
draft`. The owner unticks what they don't want on the consent screen.
(The SDK publishes the resource's `scopes_supported` from its
required scopes, which StarPunk leaves empty so any token can connect.)
- The sidecar's `TokenVerifier` looks tokens up with `verify_access_token`
and reports their resource. With `validate_token_resource`, the SDK
refuses tokens not issued for `/mcp`, so a Micropub app's token can't be
replayed against MCP. MCP tokens still work at `/micropub`; both stay the
owner's own clients, and the Connected Apps page marks MCP tokens.
- DNS rebinding protection allows only the `SITE_URL` host and origin
(plus localhost in `DEV_MODE`).
### 3. Tools: reading and writing notes, nothing else
| Tool | Scope |
|---|---|
| `search_notes`, `list_notes`, `get_note`, `get_site_config` | any token; drafts need `create`, `update`, `delete` or `draft` |
| `list_tags` | `create`, `update`, `delete` or `draft` (as Micropub `q=category`) |
| `create_note` | `create` or `draft` (draft-only tokens always make drafts) |
| `update_note` | `update` |
| `delete_note`, `undelete_note` | `delete` |
| `upload_media` | `media` or `create` |
Writing tools build a Micropub JSON request and call `handle_create`,
`handle_update` and `handle_delete`. Scope rules, validation, crossposting,
webmentions and WebSub notifications are therefore identical to Micropub.
`create_note` makes a draft unless told otherwise. Tool annotations mark
reading tools read-only and update and delete as destructive.
Syndication management, webmention moderation and other admin functions are
not exposed.
## Consequences
- AI clients connect with just the URL: claude.ai via Settings → Connectors,
Claude Code via `claude mcp add --transport http starpunk SITE_URL/mcp`.
The owner approves them on the usual consent screen, and they appear (and
can be revoked) under Connected Apps.
- New runtime dependencies: `mcp` (with Starlette, pydantic and anyio) and
`uvicorn`. They are only imported by the sidecar.
- Deployments run a second container and need two proxy routes. A site that
doesn't run the sidecar just has no MCP; nothing else changes.
- There are still no refresh tokens. MCP clients re-authorize after
`INDIEAUTH_TOKEN_LIFETIME_DAYS`.
- SDK upgrades need care: 3.0 is expected to change defaults (for example
`validate_token_resource`, which StarPunk already sets).
## Alternatives
Options 1, 2 and 4 above. A stdio bridge could still be added later for
clients that can't do OAuth; it would use a token from this flow.
@@ -0,0 +1,74 @@
# ADR-076: Article titles and summaries stored apart from the text
## Status
Accepted (v2.16.0, 2026-11-11)
Article URLs (`/article/<slug>`) and title slugs: [ADR-077](ADR-077-article-urls-and-title-slugs.md) (v2.17.0).
Supersedes the v2.3.3 design ([micropub-title-and-source-url](../design/v2.3.3/2026-10-31-micropub-title-and-source-url.md))
and Q22's "a note has a title when its content starts with `#`". Amends
ADR-014 (feed item titles) and ADR-040 (`p-name` and `p-summary`).
## Context
An IndieWeb article is an h-entry with a `name` that isn't just the start of
its content (W3C Post Type Discovery). Since v1.2.0, StarPunk marked an article
by a `# Heading` first line in the Markdown, and v2.3.3 stored a Micropub `name`
as that heading. A review against IndieWeb practice found four gaps:
1. Feeds repeated an article's title: the item title, then the same heading
rendered at the top of the content.
2. Every feed item had a title, made from a note's first line (or the date),
so feed readers showed notes as headlines and couldn't tell them from
articles.
3. Micropub `summary` was used only when `content` was missing; sent
together with content, it was dropped.
4. Any note that happened to start with a heading became an article, and its
`q=source` changed from what the client sent. Micropub and mf2 treat `name`
and `content` as separate properties.
## Decision
- **Columns.** `notes.title` and `notes.summary` (migration 023). A note with
a title is an article; its Markdown file holds only the body. A heading in
the body is just a heading.
- **Moving existing titles.** Migration 023 has a Python data step
(`migrations.DATA_MIGRATIONS`) that runs once, in the migration's
transaction: for each note whose file starts with a heading (`split_title`,
trashed files included), it moves the heading into `title`, rewrites the file
and updates `content_hash`, then empties `notes_fts` so startup rebuilds it.
If anything fails, the changed files are written back and the transaction is
rolled back, so 023 is retried on the next start. Tying it to the migration
matters: run on every start it would turn new notes' headings into titles.
- **Micropub.** `name` → `title`; `summary` → `summary` when `content` is also
sent. A summary on its own is still stored as the content, which is how Post
Type Discovery reads it. `summary` can be replaced and deleted; `q=source`
returns `name` and `summary` when set. If the content starts with a heading
equal to `name`, that heading is dropped so it isn't shown twice.
- **Feeds.** Only articles have a title: RSS leaves `<title>` out (an item
needs a title or a description, and every item has a description), JSON Feed
leaves `title` out, and Atom, which requires `<title>`, has an empty one.
Atom `<summary>` and JSON Feed `summary` carry the author's summary. Content
no longer contains the title, so it isn't repeated.
- **Pages.** The article page has `p-name`, `p-summary` (when set) and the body
as `e-content`. On the homepage and tag pages an article shows its title,
summary (or the start of its text) and "Read more", without images. The
photos stay in the markup as hidden `u-photo` values so parsers read the same
post type there as on the article page.
- **Crossposting.** Articles go to GoToSocial, Bluesky and Threads as title,
summary (or the start of the text), link and hashtags, without images, the
usual POSSE form for articles. On Bluesky the link card is the article
itself. Notes are posted in full as before.
- **Editor.** Title and Summary fields; a titled note may have no body.
## Consequences
- The migration rewrites note files. Back up the database *and* `data/notes`
(and `.trash`) before deploying.
- `Note.title` is `None` for notes. Places that need a name for any post use
`Note.label` (title, else excerpt, else slug): notifications and the
Bluesky card. `Note.has_title` and `Note.body_html` are gone.
- Search indexes the title column; untitled notes are still listed by their
first line.
- A crossposted article that is edited is re-posted as a teaser.
@@ -0,0 +1,46 @@
# ADR-077: Article URLs and slugs from titles
## Status
Accepted (v2.17.0, 2026-11-12)
Amends ADR-062 (default slugs) for articles and ADR-076 (articles).
## Context
ADR-076 (v2.16.0) made a note with a title an article, but articles still got
a `/note/<timestamp>` URL like any other note. An article is not a note, and
its URL should say so. ADR-062 chose timestamp slugs because short notes have
no good words for a URL and their text may be private; an article has a title
written to be read, and that is the usual source of its slug on the IndieWeb.
## Decision
- **URLs.** Articles live at `/article/<slug>`, other notes at `/note/<slug>`.
`Note.permalink`, `Note.url`, `Note.endpoint` and `utils.post_path` /
`post_url` build them; nothing else writes `/note/` by hand. Slugs stay
unique across both, so a slug still names one post.
- **One URL each, the other redirects.** `/note/<slug>` for an article and
`/article/<slug>` for a note answer 301 to the right one. Adding or removing
a title changes the URL, and links made before (webmentions sent, crossposts,
bookmarks) keep working. A deleted post is 410 at either.
- **Slug from the title.** When a post is created with a title and no
`mp-slug`, the slug is the title made URL-safe (`sanitize_slug`: accents
folded, lowercase, hyphens), cut at a word boundary to 80 characters, `-2`,
`-3`… if taken, `-article` if reserved. A title with nothing usable (only
emoji, say) falls back to the timestamp slug. Notes keep timestamp slugs.
- **Slugs don't follow later title changes.** Editing an article's title, or
making a note an article, keeps its slug: a slug is the stable part of the
URL.
- **Micropub.** `Location` and `q=source` give the new URLs. Updates accept
either URL. An update that adds or removes a title answers 201 with the new
URL in `Location`, as the Micropub spec requires when a post's URL changes;
other updates are still 204.
- **Incoming webmentions** to either URL find the post.
## Consequences
- Production had no articles when this shipped, so no published URL changed.
- A note given a title later keeps its timestamp slug under `/article/`.
- Stored URLs (webmention sources, crosspost records) are not rewritten; the
redirects cover them.
+11 -8
View File
@@ -5,8 +5,8 @@ records one decision: its context, what was decided, and the consequences.
Superseded ADRs are kept as history; their Status line names the ADR that
replaced them.
**Total ADR files**: 70 (69 numbers: ADR-001 to ADR-044 and ADR-050 to
ADR-074, with two files numbered ADR-012). See [Numbering](#numbering).
**Total ADR files**: 73 (72 numbers: ADR-001 to ADR-044 and ADR-050 to
ADR-077, with two files numbered ADR-012). See [Numbering](#numbering).
Status values: **Accepted** (in force), **Superseded** (replaced by a later
ADR), **Deprecated** (withdrawn, nothing replaces it; none at present),
@@ -48,7 +48,7 @@ See also [database architecture](../architecture/database.md).
| ADR | Title | Status | Summary |
|---|---|---|---|
| [062](ADR-062-timestamp-based-slug-format.md) | Timestamp-Based Slug Format | Accepted | Default slugs are `YYYYMMDDHHMMSS` timestamps (v1.5.0); replaces ADR-007. |
| [062](ADR-062-timestamp-based-slug-format.md) | Timestamp-Based Slug Format | Accepted* | Default slugs are `YYYYMMDDHHMMSS` timestamps (v1.5.0); replaces ADR-007. Articles take theirs from the title (ADR-077). |
| [035](ADR-035-custom-slugs.md) | Custom Slugs in Micropub | Accepted* | Honour `mp-slug`, sanitized, with reserved names protected (v1.1.0). |
| [034](ADR-034-full-text-search.md) | Full-Text Search with SQLite FTS5 | Accepted | FTS5 search over note content (v1.1.0). |
| [057](ADR-057-media-attachment-model.md) | Media Attachment Model | Accepted | Social-media-style image attachments: up to 4 per note, ordered, with captions. |
@@ -58,7 +58,7 @@ See also [database architecture](../architecture/database.md).
| ADR | Title | Status | Summary |
|---|---|---|---|
| [014](ADR-014-rss-feed-implementation.md) | RSS Feed Implementation Strategy | Accepted* | RSS 2.0 feed; its WebSub deferral is superseded by ADR-071. |
| [014](ADR-014-rss-feed-implementation.md) | RSS Feed Implementation Strategy | Accepted* | RSS 2.0 feed; its WebSub deferral is superseded by ADR-071, and item titles by ADR-076. |
| [038](ADR-038-syndication-formats.md) | Multiple Syndication Format Support | Accepted | RSS, Atom and JSON Feed side by side (v1.1.2). |
| [071](ADR-071-websub.md) | WebSub publishing with a built-in hub | Accepted | Built-in WebSub hub at `/websub` for StarPunk's own feeds (v2.10.0, amended v2.10.1). |
| [059](ADR-059-full-feed-media-standardization.md) | Full Feed Media Standardization (Option 3) | Proposed | Full Media RSS, podcasts, video and thumbnails in feeds; not scheduled. |
@@ -67,7 +67,9 @@ See also [database architecture](../architecture/database.md).
| ADR | Title | Status | Summary |
|---|---|---|---|
| [040](ADR-040-microformats2-compliance.md) | Strict Microformats2 Compliance | Accepted | Full h-entry, h-card and h-feed markup (v1.3.0, reviewed v2.8.0). |
| [040](ADR-040-microformats2-compliance.md) | Strict Microformats2 Compliance | Accepted* | Full h-entry, h-card and h-feed markup (v1.3.0, reviewed v2.8.0); `p-name`/`p-summary` per ADR-076. |
| [076](ADR-076-note-title-and-summary-columns.md) | Article titles and summaries stored apart from the text | Accepted | `notes.title`/`summary` columns; feeds title only articles; article previews and crossposts are title + summary (v2.16.0). |
| [077](ADR-077-article-urls-and-title-slugs.md) | Article URLs and slugs from titles | Accepted | Articles at `/article/<slug>` with slugs from their titles; the other prefix redirects (v2.17.0). |
| [061](ADR-061-author-discovery.md) | Author Profile Discovery from IndieAuth | Accepted | The author h-card is read from `ADMIN_ME` and cached. |
| [063](ADR-063-webmention-implementation.md) | Webmention Implementation | Accepted | Async receiving (202) and sending via a background worker, SSRF guard, rate limits, moderation (v1.6.0, revised up to v2.10.1). *Reconstructed.* |
| [028](ADR-028-micropub-implementation.md) | Micropub Implementation Strategy | Accepted* | `/micropub` endpoint for creating posts (v1.0.0-rc.1); tokens now per ADR-064. |
@@ -95,6 +97,7 @@ See also [IndieWeb protocols](../architecture/indieweb-protocols.md).
| [010](ADR-010-authentication-module-design.md) | Authentication Module Design | Accepted* | Single `auth.py` module and server-side sessions; the login flow is now ADR-064. |
| [011](ADR-011-development-authentication-mechanism.md) | Development Authentication Mechanism | Accepted | `DEV_MODE` login bypass for local development only. |
| [022](ADR-022-auth-route-prefix-fix.md) | Fix IndieAuth Callback Route Mismatch | Accepted | Auth routes live under `/auth` (v0.9.2). |
| [075](ADR-075-mcp-server.md) | MCP server for AI clients | Accepted | `/mcp` served by the official MCP SDK in a sidecar; StarPunk's IndieAuth server issues resource-bound tokens via client ID metadata documents (v2.15.0). |
### Operations, errors and monitoring
@@ -169,7 +172,7 @@ was carried out and is not itself superseded.
## How to create a new ADR
1. Use the next number after the highest existing one (currently ADR-075).
1. Use the next number after the highest existing one (currently ADR-077).
2. Name it `ADR-NNN-brief-descriptive-title.md`.
3. Follow the format of recent ADRs (e.g. ADR-070, ADR-071):
@@ -202,5 +205,5 @@ was carried out and is not itself superseded.
---
**Last Updated**: 2026-11-10
**Total ADR files**: 70
**Last Updated**: 2026-11-11
**Total ADR files**: 72
+5 -1
View File
@@ -21,7 +21,7 @@ is in `../architecture/`; decisions are in `../decisions/` (ADRs).
## Contents
[v0.x](#v0x) · [v1.0.0](#v100) · [v1.1.1](#v111) · [v1.1.2](#v112) · [v1.2.0](#v120) · [v1.3.0](#v130) · [v1.3.1](#v131) · [v1.4.0](#v140) · [v1.4.1](#v141) · [v1.4.2](#v142) · [v1.5.0](#v150) · [v1.6.0](#v160) · [v2.0.0](#v200) · [v2.0.1](#v201) · [v2.0.2](#v202) · [v2.1.0](#v210) · [v2.2.0](#v220) · [v2.3.0](#v230) · [v2.3.1](#v231) · [v2.3.2](#v232) · [v2.3.3](#v233) · [v2.4.0](#v240) · [v2.5.0](#v250) · [v2.6.0](#v260) · [v2.6.1](#v261) · [v2.6.2](#v262) · [v2.6.3](#v263) · [v2.6.4](#v264) · [v2.6.5](#v265) · [v2.6.6](#v266) · [v2.6.7](#v267) · [v2.6.8](#v268) · [v2.6.9](#v269) · [v2.7.0](#v270) · [v2.7.1](#v271) · [v2.7.2](#v272) · [v2.8.0](#v280) · [v2.8.1](#v281) · [v2.9.0](#v290) · [v2.10.0](#v2100) · [v2.10.1](#v2101) · [v2.10.2](#v2102) · [v2.11.0](#v2110) · [v2.12.0](#v2120) · [v2.12.1](#v2121) · [v2.13.0](#v2130) · [v2.13.1](#v2131) · [v2.13.2](#v2132) · [v2.13.3](#v2133) · [v2.13.4](#v2134) · [v2.14.0](#v2140) · [v2.14.1](#v2141) · [hotfix](#hotfix)
[v0.x](#v0x) · [v1.0.0](#v100) · [v1.1.1](#v111) · [v1.1.2](#v112) · [v1.2.0](#v120) · [v1.3.0](#v130) · [v1.3.1](#v131) · [v1.4.0](#v140) · [v1.4.1](#v141) · [v1.4.2](#v142) · [v1.5.0](#v150) · [v1.6.0](#v160) · [v2.0.0](#v200) · [v2.0.1](#v201) · [v2.0.2](#v202) · [v2.1.0](#v210) · [v2.2.0](#v220) · [v2.3.0](#v230) · [v2.3.1](#v231) · [v2.3.2](#v232) · [v2.3.3](#v233) · [v2.4.0](#v240) · [v2.5.0](#v250) · [v2.6.0](#v260) · [v2.6.1](#v261) · [v2.6.2](#v262) · [v2.6.3](#v263) · [v2.6.4](#v264) · [v2.6.5](#v265) · [v2.6.6](#v266) · [v2.6.7](#v267) · [v2.6.8](#v268) · [v2.6.9](#v269) · [v2.7.0](#v270) · [v2.7.1](#v271) · [v2.7.2](#v272) · [v2.8.0](#v280) · [v2.8.1](#v281) · [v2.9.0](#v290) · [v2.10.0](#v2100) · [v2.10.1](#v2101) · [v2.10.2](#v2102) · [v2.11.0](#v2110) · [v2.12.0](#v2120) · [v2.12.1](#v2121) · [v2.13.0](#v2130) · [v2.13.1](#v2131) · [v2.13.2](#v2132) · [v2.13.3](#v2133) · [v2.13.4](#v2134) · [v2.14.0](#v2140) · [v2.14.1](#v2141) · [v2.14.2](#v2142) · [hotfix](#hotfix)
## v0.x
@@ -456,6 +456,10 @@ OIDC admin login and built-in IndieAuth server.
- [2026-11-10-tags-and-captions.md](v2.14.1/2026-11-10-tags-and-captions.md) — Clearing tags in the editor; captions escaped in feeds
## v2.14.2
- [2026-11-10-quotes-cleanup.md](v2.14.2/2026-11-10-quotes-cleanup.md) — Quote counts; dead files removed
## hotfix
Not a release folder.
@@ -343,6 +343,8 @@ Priority order:
3. First h-card found (fallback)
### p-name Only With Explicit Title
> Superseded in v2.16.0 (ADR-076): the title is `notes.title`, not a `#` first line. p-name still appears only for titled notes.
**Per Q22**:
- Detected by checking if content starts with `#`
- Matches note model's title extraction logic
@@ -0,0 +1,31 @@
# v2.14.2: Quote counts; dead files removed
The two remaining items from the v2.14.0 documentation review.
## Quote counts
Backfeed stored anonymous quote counts (`syndications.quotes_count`: all
Threads quotes, and quotes by people who opted out elsewhere) that nothing
displayed. The counts line (`partials/responses.html` `reactions`) now has a
quote count after replies: named quotes plus those counts. Its card shows
only the anonymous part ("2 on Threads"); named quotes stay listed under
Responses. Quotes have no web action (there is no standard verb).
`webmention_queries.response_counts` adds `quotes`, so lists of notes show
them too.
## Removed
- `static/js/preview.js` (empty since the first commit) and the jsDelivr
`marked` script the editor pages loaded with it.
- `templates/feed.xml` (empty, never rendered) and `static/indielogin-test.html`
(a v1 IndieLogin test page).
- `syndication.get_targets()` read `THREADS_API` from the config, which
`config.py` never loads; the client now always uses the `THREADS_API`
constant.
## Verification
`tests/test_backfeed.py::test_quote_counts_include_anonymous_ones`; backfeed,
syndication, admin, template, public-route, microformats, notification,
webmention and feed tests pass. Rendered the counts line with the quote card
open in headless Chromium.
@@ -0,0 +1,42 @@
# v2.16.0: Article titles and summaries
Implements ADR-076. Prompted by a review of how StarPunk handles IndieWeb
articles: titles were repeated in feeds, every feed item had a made-up title,
Micropub `summary` was dropped, and any note starting with a heading became an
article.
## What changed
| Area | Change |
|---|---|
| Storage | Migration 023 adds `notes.title` and `notes.summary`; `create_note`/`update_note` take `title` and `summary` (`UNCHANGED` sentinel on update; `None`/"" clears) |
| Migration data step | `migrations.DATA_MIGRATIONS["023_note_titles.sql"] = _move_note_titles`; `run_migrations(..., data_dir=)` gets `DATA_PATH` from `init_db`. Moves `# Heading` first lines (via `split_title`) into `title`, finds trashed files with `utils.find_trashed_file` (shared with `undelete_note`), updates `content_hash`, empties `notes_fts`. Files are restored if the migration fails |
| Model | `Note.title`/`summary` fields; `Note.label` for places that need some name; `has_title`, `body_html` and the first-line `title` property removed |
| Micropub | `name` → title, `summary` → summary (only with content), `summary` updatable, `q=source` returns both; a heading repeating `name` is dropped (`drop_title_heading`) |
| Feeds | Titles only for articles (RSS none, JSON none, Atom empty); Atom/JSON summaries |
| Templates | Article page: `p-name`, `p-summary`, `e-content` without the title. Previews: title, summary or excerpt, "Read more", no images (hidden `u-photo` data kept for Post Type Discovery) |
| Crossposting | `compose_text` posts articles as title + `article_teaser` (summary, or 200 characters of plain text) + link + hashtags; no images for articles; Bluesky card is the article |
| Editor | Title and Summary fields on new/edit; content not required when titled |
| Search | FTS indexes `title`; untitled notes still use their first line |
| MCP | `create_note`/`update_note` take `summary`; note summaries include it |
## Fixes found along the way
- **Hashtag lines.** Python-Markdown made `#indieweb is fun` an `<h1>`; CommonMark needs a space after `#`. `markdown_ext.HashtagLineExtension` escapes the first `#` of a line where `#`s run straight into text, after fenced code and raw HTML are set aside. It is used for pages and feeds (`MARKDOWN_EXTENSIONS`) and crosspost plain text (`syndication._note_soup`), so the hashtag also reaches Bluesky as a tag. Search's first-line label keeps hashtags too.
- **Plain-text excerpt.** `Note.excerpt` only stripped `#` marks, so previews showed `**bold**` and `[link](url)`. It is now `syndication.plain_text` of the content, cut to 200 characters with `…`; `article_teaser` is the summary or this excerpt.
- **Inline images in Micropub articles.** (1) `extract_content` prefers `html` over `text` and marks it `content_format = 'html'`: clients send `text` as a plain fallback, so images, links and headings were lost. (2) `localize_inline_images` copies images from other sites (Markdown `![]()` or `<img>`) into the media library through the SSRF-checked fetcher used for `photo`, on create and on content replace, and rewrites their URLs; failures keep the original URL, at most 20 per post. Images stay inline (not `u-photo`), so the post remains an article. (3) `Note.html` sanitizes HTML content with nh3 directly instead of passing it through Markdown.
## Choices made with the owner
- Title column rather than an editor-only field, as the most standards-compliant option.
- Atom entries for notes keep an empty `<title>` (required by RFC 4287).
- Homepage and tag pages: articles show title and summary without images.
- Crossposts: articles as title + summary + link, no images.
## Tests
- `tests/test_articles.py` (new): feeds per format, article page mf2, homepage and tag-page previews, admin create/edit/clear, title-only article.
- `tests/test_migration_023.py` (new): titles moved (including trashed notes), hashtag first line untouched, hashes and FTS, runs once, files restored on failure, schema-only without `data_dir`.
- Updated for the new behaviour: `test_feed.py`, `test_feeds_{atom,json,rss}.py`, `test_routes_feed.py`, `test_models.py`, `test_microformats.py`, `test_microformats_v280.py`, `test_micropub.py`, `test_micropub_v240.py` (plus new summary and empty-body tests), `test_syndication.py` and `test_syndication_bluesky.py` (article crossposts).
- Locally: the 35 affected test files, 872+ tests, pass. CI runs the full suite on the tag.
@@ -0,0 +1,23 @@
# v2.17.0: Article URLs and title slugs
Implements ADR-077. Follow-up to v2.16.0 (ADR-076): articles had `/note/`
URLs and timestamp slugs.
## What changed
| Area | Change |
|---|---|
| URL helpers | `utils.post_path(slug, title)` and `post_url(slug, title)`; `Note.permalink` uses them, `Note.endpoint` (`public.article`/`public.note`) and `Note.url` (absolute) are new |
| Routes | `public.article` at `/article/<slug>`; `note` and `article` share `_permalink(slug, endpoint)`, which 301s to the other route when the post's type doesn't match. `_note_was_deleted` checks both URLs for hard-deleted posts |
| Slugs | `slug_utils.generate_title_slug(title, existing)`; `create_note` uses it for titled posts without `custom_slug`, else the timestamp slug |
| Micropub | `Location`, `q=source` url via `note.url`; `_note_from_url` accepts `/article/`; update answers 201 + `Location` when a title is added or removed |
| Other URL builders | Templates (`note.url`), webmention sending (`post_url`/`note.url`), crosspost permalink, backfeed target, notification links, search results (`article_title` from `notes.title`), MCP tools |
| Webmention receiving | `resolve_target_note` accepts `/note/` and `/article/` |
## Tests
`tests/test_articles.py::TestArticleUrls`: Micropub URL and slug, timestamp
slugs for notes, redirects both ways, updates via the old URL, slug rules
(accents, duplicates, reserved, `mp-slug`, emoji, long titles), 201 on
adding/removing a title, 410 for a deleted article, webmention targets and
homepage links, search result URLs.
@@ -1,5 +1,7 @@
# v2.3.3: Micropub titles, q=source URL, single title display
> Superseded in v2.16.0 by ADR-076: titles are stored in `notes.title`, not as a `# Heading` in the content, and `split_title` is used only to move old headings and drop a heading that repeats `name`.
Found while building tuipub, a terminal Micropub client, against StarPunk.
## Problems
+1 -10
View File
@@ -73,16 +73,6 @@ None open.
## Low
### Quote counts without names are not shown
- **Description**: Backfeed stores anonymous quote counts (`syndications.quotes_count`: Threads quotes, and quotes by people who opted out elsewhere), but the counts line only adds likes and reposts, so these quotes are counted nowhere on the page.
- **Where**: `templates/partials/responses.html` (`reactions`), `starpunk/webmention_queries.py` (`response_counts`)
- **Source**: Documentation review 2026-11-10
### Dead files and settings
- **Description**: `static/js/preview.js` is empty, yet the editor pages load it and `marked` from jsDelivr for nothing. `templates/feed.xml` is empty and `static/indielogin-test.html` is a v1 leftover. `syndication.get_targets()` reads a `THREADS_API` setting that `config.py` never loads, so it can't be set.
- **Where**: `templates/admin/new.html`, `templates/admin/edit.html`, `static/`, `templates/feed.xml`, `starpunk/syndication.py`
- **Source**: Documentation review 2026-11-10
### Micropub: `location` / `checkin` ignored
- **Description**: These properties are accepted but dropped, which spec 3.3.5 allows.
- **Where**: `starpunk/micropub.py`
@@ -175,6 +165,7 @@ None open.
These items were removed from the backlog because they have shipped:
- v2.14.2: quote counts (with anonymous ones) shown; dead editor scripts, files and the `THREADS_API` read removed
- v2.14.1: the editor can clear all tags; image captions escaped in RSS, Atom and JSON Feed HTML
- v2.14.0: notifications of new responses and crosspost/backfeed problems through Apprise (ADR-074)
+1
View File
@@ -57,3 +57,4 @@ Future work and per-release plans. See `../DOCUMENTATION.md` (PROJECTPLAN).
- **[v2.13.4](v2.13.4/RELEASE.md)** - Counts on lists of notes, reply cards link out (Released 2026-11-10)
- **[v2.14.0](v2.14.0/RELEASE.md)** - Notifications through Apprise (Released 2026-11-10)
- **[v2.14.1](v2.14.1/RELEASE.md)** - Clearing tags in the editor; captions escaped in feeds (Released 2026-11-10)
- **[v2.14.2](v2.14.2/RELEASE.md)** - Quote counts; dead files removed (Released 2026-11-10)
+18
View File
@@ -0,0 +1,18 @@
# v2.14.2
- **Date**: 2026-11-10
- **Status**: Released
- **Focus**: Quote counts; dead files removed
## Added
- Quote counts (with anonymous ones) in the counts line and on lists of notes
## Removed
- Unused editor scripts (`marked` from a CDN, empty `preview.js`), `templates/feed.xml`, `static/indielogin-test.html`, the `THREADS_API` config read
## Related
- [CHANGELOG](../../../CHANGELOG.md)
- [Design note](../../design/v2.14.2/2026-11-10-quotes-cleanup.md)
+6
View File
@@ -0,0 +1,6 @@
-- Migration 022: RFC 8707 resource indicators for IndieAuth codes and tokens
-- Version: 2.15.0 (ADR-075)
-- Tokens for the MCP endpoint are bound to it; Micropub tokens leave it NULL.
ALTER TABLE indieauth_codes ADD COLUMN resource TEXT;
ALTER TABLE indieauth_tokens ADD COLUMN resource TEXT;
+6
View File
@@ -0,0 +1,6 @@
-- Migration 023: Note titles and summaries (v2.16.0, ADR-076)
-- An article's title moves out of its Markdown ('# Heading' first line) into
-- notes.title; migrations.py moves existing headings right after this runs.
-- notes.summary holds an author-written summary (Micropub 'summary').
ALTER TABLE notes ADD COLUMN title TEXT;
ALTER TABLE notes ADD COLUMN summary TEXT;
+5 -1
View File
@@ -1,4 +1,4 @@
# StarPunk runtime dependencies (v2.11.0)
# StarPunk runtime dependencies (v2.15.0)
# Pinned to a minor series; see docs/architecture/technology-stack.md.
# Web framework and server
@@ -25,3 +25,7 @@ apprise==2.2.*
# Images
Pillow==13.0.*
pillow-heif==1.8.*
# MCP server sidecar (v2.15.0, ADR-075): official SDK, served by uvicorn
mcp==2.3.*
uvicorn==0.54.*
+8 -5
View File
@@ -325,9 +325,12 @@ def create_app(config=None):
register_error_handlers(app)
# Background workers, unless this process is the MCP sidecar (v2.15.0, ADR-075)
workers = app.config.get("BACKGROUND_WORKERS_ENABLED", True)
# Start webmention worker thread (v1.6.0 Phase 2)
# Per background-worker.md: Skip in test mode
if app.config.get('WEBMENTION_WORKER_ENABLED', True) and not app.config.get('TESTING', False):
if workers and app.config.get('WEBMENTION_WORKER_ENABLED', True) and not app.config.get('TESTING', False):
from starpunk.webmention_worker import WebmentionWorker
webmention_worker = WebmentionWorker(
app,
@@ -348,13 +351,13 @@ def create_app(config=None):
# Start WebSub worker (v2.10.0)
from starpunk.websub_worker import start_worker
app.websub_worker = start_worker(app)
app.websub_worker = start_worker(app) if workers else None
if app.websub_worker:
app.logger.info("WebSub worker started")
# Start syndication worker when a target is configured (v2.1.0)
from starpunk.syndication import SyndicationWorker, targets_configured
if targets_configured(app.config) and not app.config.get("TESTING", False):
if workers and targets_configured(app.config) and not app.config.get("TESTING", False):
app.syndication_worker = SyndicationWorker(
app, poll_interval=app.config["SYNDICATION_POLL_INTERVAL"]
)
@@ -465,5 +468,5 @@ def create_app(config=None):
# Package version (Semantic Versioning 2.0.0)
# See docs/standards/versioning-strategy.md for details
__version__ = "2.14.1"
__version_info__ = (2, 14, 1)
__version__ = "2.17.0"
__version_info__ = (2, 17, 0)
+4 -3
View File
@@ -25,6 +25,7 @@ from typing import Dict, List, Optional
from flask import current_app
from starpunk.database import get_db
from starpunk.utils import post_path
DAY = 24 * 3600
SCHEDULE = [ # (note younger than, check every), in seconds
@@ -164,7 +165,7 @@ def _due(db, limit: int) -> list:
lease = "(s.backfeed_claimed_until IS NULL OR s.backfeed_claimed_until < datetime('now'))"
rows = db.execute(
f"""
SELECT s.*, n.created_at AS note_created, n.slug AS note_slug {_ELIGIBLE}
SELECT s.*, n.created_at AS note_created, n.slug AS note_slug, n.title AS note_title {_ELIGIBLE}
AND {lease}
AND n.created_at >= datetime('now', ?)
AND (s.backfeed_next_at IS NULL OR s.backfeed_next_at <= datetime('now'))
@@ -176,7 +177,7 @@ def _due(db, limit: int) -> list:
return rows
backfill = db.execute(
f"""
SELECT s.*, n.created_at AS note_created, n.slug AS note_slug {_ELIGIBLE}
SELECT s.*, n.created_at AS note_created, n.slug AS note_slug, n.title AS note_title {_ELIGIBLE}
AND {lease} AND s.backfeed_backfill = 1
AND (s.backfeed_next_at IS NULL OR s.backfeed_next_at <= datetime('now'))
ORDER BY s.id LIMIT 1
@@ -381,7 +382,7 @@ def check(row, target) -> None:
# older note (e.g. one linked after the fact). ADR-074 Decision 5.
quiet = bool(row["backfeed_backfill"]) or (
row["backfeed_checked_at"] is None and _age_seconds(row["note_created"]) > DAY)
store(db, row["note_id"], f"{site}/note/{row['note_slug']}", row["target"], harvest, quiet=quiet)
store(db, row["note_id"], site + post_path(row["note_slug"], row["note_title"]), row["target"], harvest, quiet=quiet)
_store_counts(db, row["id"], hidden_counts(harvest))
+2
View File
@@ -113,6 +113,8 @@ def load_config(app, config_override=None):
app.config["WEBSUB_MAX_SUBSCRIPTIONS"] = int(os.getenv("WEBSUB_MAX_SUBSCRIPTIONS", "1000"))
app.config["WEBSUB_MAX_PER_HOST"] = int(os.getenv("WEBSUB_MAX_PER_HOST", "25"))
app.config["WEBSUB_POLL_INTERVAL"] = int(os.getenv("WEBSUB_POLL_INTERVAL", "5"))
# Off in the MCP sidecar so it never runs a second set of workers (v2.15.0, ADR-075)
app.config["BACKGROUND_WORKERS_ENABLED"] = os.getenv("BACKGROUND_WORKERS_ENABLED", "true").lower() == "true"
app.config["WEBMENTION_WORKER_ENABLED"] = os.getenv("WEBMENTION_WORKER_ENABLED", "true").lower() == "true"
app.config["WEBMENTION_POLL_INTERVAL"] = int(os.getenv("WEBMENTION_POLL_INTERVAL", "10"))
app.config["WEBMENTION_ERROR_BACKOFF"] = int(os.getenv("WEBMENTION_ERROR_BACKOFF", "60"))
+3 -1
View File
@@ -17,10 +17,12 @@ def init_db(app=None):
if app:
db_path = app.config["DATABASE_PATH"]
logger = app.logger
data_dir = app.config.get("DATA_PATH")
else:
# Fallback to default path
db_path = Path("./data/starpunk.db")
logger = None
data_dir = None
# Ensure parent directory exists
db_path.parent.mkdir(parents=True, exist_ok=True)
@@ -41,4 +43,4 @@ def init_db(app=None):
# Run migrations
from starpunk.migrations import run_migrations
run_migrations(db_path, logger=logger)
run_migrations(db_path, logger=logger, data_dir=data_dir)
+4 -1
View File
@@ -161,7 +161,10 @@ def generate_atom_streaming(
# Required elements
yield f' <id>{_escape_xml(permalink)}</id>\n'
yield f' <title>{_escape_xml(note.title)}</title>\n'
# atom:title is required but may be empty: untitled notes (ADR-076)
yield f' <title>{_escape_xml(note.title or "")}</title>\n'
if note.summary:
yield f' <summary>{_escape_xml(note.summary)}</summary>\n'
# Use created_at for both published and updated
# (Note model doesn't have updated_at tracking yet)
+6 -2
View File
@@ -229,8 +229,12 @@ def _build_item_object(site_url: str, note: Note) -> Dict[str, Any]:
"url": permalink,
}
# Add title
item["title"] = note.title
# Title and summary only when the note has them: untitled notes have
# no title (JSON Feed 1.1; v2.16.0, ADR-076)
if note.title:
item["title"] = note.title
if note.summary:
item["summary"] = note.summary
# Add image field (URL of first/main image) - per JSON Feed 1.1 spec
# Per Q7: Field should be absent (not null) when no media
+14 -37
View File
@@ -108,7 +108,9 @@ def generate_rss(
# Set required item elements
fe.id(permalink)
fe.title(get_note_title(note))
title = get_note_title(note)
if title: # untitled notes have only a description (RSS 2.0, ADR-076)
fe.title(title)
fe.link(href=permalink)
fe.guid(permalink, permalink=True)
@@ -263,8 +265,8 @@ def generate_rss_streaming(
html_content += clean_html_for_rss(note.feed_html)
# Build item XML
item_xml = f""" <item>
<title>{_escape_xml(title)}</title>
title_xml = f"\n <title>{_escape_xml(title)}</title>" if title else ""
item_xml = f""" <item>{title_xml}
<link>{_escape_xml(permalink)}</link>
<guid isPermaLink="true">{_escape_xml(permalink)}</guid>
<pubDate>{pub_date_str}</pubDate>"""
@@ -494,48 +496,23 @@ def format_rfc822_date(dt: datetime) -> str:
return dt.strftime("%a, %d %b %Y %H:%M:%S %z")
def get_note_title(note: Note) -> str:
def get_note_title(note: Note) -> Optional[str]:
"""
Extract title from note content
An item's title: the note's title (articles), cut to 100 characters
Attempts to extract a meaningful title from the note. Uses the first
line of content (stripped of markdown heading syntax) or falls back
to a formatted timestamp if content is unavailable.
Algorithm:
1. Try note.title property (first line, stripped of # syntax)
2. Fall back to timestamp if title is unavailable
Untitled notes get none (v2.16.0, ADR-076), so readers can tell notes
from articles; RSS 2.0 lets an item have just a description.
Args:
note: Note object
Returns:
Title string (max 100 chars, truncated if needed)
Examples:
>>> # Note with heading
>>> note = Note(...) # content: "# My First Note\\n\\n..."
>>> get_note_title(note)
'My First Note'
>>> # Note without heading (timestamp fallback)
>>> note = Note(...) # content: "Just some text"
>>> get_note_title(note)
'November 18, 2024 at 12:00 PM'
Title string, or None for an untitled note
"""
try:
# Use Note's title property (handles extraction logic)
title = note.title
# Truncate to 100 characters for RSS compatibility
if len(title) > 100:
title = title[:100].strip() + "..."
return title
except (FileNotFoundError, OSError, AttributeError):
# If title extraction fails, use timestamp
return note.created_at.strftime("%B %d, %Y at %I:%M %p")
title = note.title
if title and len(title) > 100:
title = title[:100].strip() + "..."
return title or None
def clean_html_for_rss(html: str) -> str:
+57 -17
View File
@@ -25,7 +25,11 @@ from starpunk.database import get_db
from starpunk.utils import absolute_url_for
CODE_LIFETIME_MINUTES = 10
SUPPORTED_SCOPES = ["create", "update", "delete", "media", "profile"]
SUPPORTED_SCOPES = ["create", "update", "delete", "media", "draft", "profile"]
# Scopes offered to an MCP client that asks for none (v2.15.0, ADR-075):
# the owner unticks what they don't want on the consent screen
MCP_DEFAULT_SCOPES = ["create", "update", "delete", "media", "draft"]
class AuthorizationRequestError(Exception):
@@ -56,6 +60,11 @@ def issuer() -> str:
return current_app.config["SITE_URL"].rstrip("/") + "/"
def mcp_resource() -> str:
"""The MCP endpoint's resource identifier (RFC 8707, v2.15.0)"""
return current_app.config["SITE_URL"].rstrip("/") + "/mcp"
def admin_me() -> str:
"""The single identity StarPunk issues tokens for"""
return current_app.config["ADMIN_ME"]
@@ -134,7 +143,7 @@ def validate_authorization_request(params: Dict[str, str]) -> Dict[str, Any]:
Returns:
Normalized request: client_id, redirect_uri, state, scopes,
code_challenge
code_challenge, resource
Raises:
AuthorizationRequestError
@@ -176,17 +185,31 @@ def validate_authorization_request(params: Dict[str, str]) -> Dict[str, Any]:
scopes = [s for s in (params.get("scope") or "").split() if s]
# RFC 8707 resource indicator: only the MCP endpoint is a named resource
# here (v2.15.0, ADR-075). Micropub clients don't send one.
resource = (params.get("resource") or "").strip() or None
if resource is not None:
if resource.rstrip("/") != mcp_resource():
raise AuthorizationRequestError(
"invalid_target", "Unknown resource; this server only issues tokens for its MCP endpoint"
)
resource = mcp_resource()
if not scopes:
scopes = list(MCP_DEFAULT_SCOPES)
return {
"client_id": client_id,
"redirect_uri": redirect_uri,
"state": params["state"],
"scopes": scopes,
"code_challenge": code_challenge,
"resource": resource,
}
def create_authorization_code(
client_id: str, redirect_uri: str, scope: str, code_challenge: str
client_id: str, redirect_uri: str, scope: str, code_challenge: str,
resource: Optional[str] = None,
) -> str:
"""Issue a single-use authorization code (stored hashed)"""
code = secrets.token_urlsafe(32)
@@ -195,8 +218,8 @@ def create_authorization_code(
db.execute(
"""
INSERT INTO indieauth_codes
(code_hash, client_id, redirect_uri, scope, code_challenge, expires_at)
VALUES (?, ?, ?, ?, ?, ?)
(code_hash, client_id, redirect_uri, scope, code_challenge, expires_at, resource)
VALUES (?, ?, ?, ?, ?, ?, ?)
""",
(
_hash(code),
@@ -205,6 +228,7 @@ def create_authorization_code(
scope,
code_challenge,
datetime.now(timezone.utc).replace(tzinfo=None) + timedelta(minutes=CODE_LIFETIME_MINUTES),
resource,
),
)
db.commit()
@@ -218,7 +242,7 @@ def redeem_authorization_code(
Redeem an authorization code exactly once
Returns:
{"me": ..., "scope": ..., "client_id": ...}
{"me": ..., "scope": ..., "client_id": ..., "resource": ...}
Raises:
InvalidGrantError
@@ -240,7 +264,7 @@ def redeem_authorization_code(
raise InvalidGrantError("Authorization code is invalid, expired or already used")
row = db.execute(
"SELECT client_id, redirect_uri, scope, code_challenge FROM indieauth_codes WHERE code_hash = ?",
"SELECT client_id, redirect_uri, scope, code_challenge, resource FROM indieauth_codes WHERE code_hash = ?",
(_hash(code),),
).fetchone()
@@ -252,11 +276,20 @@ def redeem_authorization_code(
if not secrets.compare_digest(challenge, row["code_challenge"]):
raise InvalidGrantError("PKCE verification failed")
return {"me": admin_me(), "scope": row["scope"], "client_id": row["client_id"]}
return {
"me": admin_me(),
"scope": row["scope"],
"client_id": row["client_id"],
"resource": row["resource"],
}
def create_access_token(client_id: str, scope: str) -> Dict[str, Any]:
"""Issue an access token (stored hashed); returns the token response"""
def create_access_token(client_id: str, scope: str, resource: Optional[str] = None) -> Dict[str, Any]:
"""Issue an access token (stored hashed); returns the token response
resource is the RFC 8707 resource the token is for (the MCP endpoint),
or None for Micropub tokens.
"""
token = secrets.token_urlsafe(32)
lifetime_days = current_app.config.get("INDIEAUTH_TOKEN_LIFETIME_DAYS", 90)
expires_at = datetime.now(timezone.utc).replace(tzinfo=None) + timedelta(days=lifetime_days)
@@ -264,10 +297,10 @@ def create_access_token(client_id: str, scope: str) -> Dict[str, Any]:
db = get_db(current_app)
db.execute(
"""
INSERT INTO indieauth_tokens (token_hash, client_id, scope, expires_at)
VALUES (?, ?, ?, ?)
INSERT INTO indieauth_tokens (token_hash, client_id, scope, expires_at, resource)
VALUES (?, ?, ?, ?, ?)
""",
(_hash(token), client_id, scope, expires_at),
(_hash(token), client_id, scope, expires_at, resource),
)
db.commit()
@@ -286,14 +319,15 @@ def verify_access_token(token: str) -> Optional[Dict[str, Any]]:
Check a bearer token issued by StarPunk
Returns:
{"me", "client_id", "scope"} if active, otherwise None
{"me", "client_id", "scope", "resource", "expires_at"} if active,
otherwise None
"""
if not token:
return None
db = get_db(current_app)
row = db.execute(
"""
SELECT id, client_id, scope FROM indieauth_tokens
SELECT id, client_id, scope, resource, expires_at FROM indieauth_tokens
WHERE token_hash = ? AND revoked_at IS NULL AND expires_at > datetime('now')
""",
(_hash(token),),
@@ -306,7 +340,13 @@ def verify_access_token(token: str) -> Optional[Dict[str, Any]]:
(row["id"],),
)
db.commit()
return {"me": admin_me(), "client_id": row["client_id"], "scope": row["scope"]}
return {
"me": admin_me(),
"client_id": row["client_id"],
"scope": row["scope"],
"resource": row["resource"],
"expires_at": row["expires_at"],
}
def revoke_access_token(token: str) -> None:
@@ -334,7 +374,7 @@ def list_active_tokens() -> List[Dict[str, Any]]:
db = get_db(current_app)
rows = db.execute(
"""
SELECT id, client_id, scope, created_at, expires_at, last_used_at
SELECT id, client_id, scope, resource, created_at, expires_at, last_used_at
FROM indieauth_tokens
WHERE revoked_at IS NULL AND expires_at > datetime('now')
ORDER BY created_at DESC
+25 -2
View File
@@ -1,7 +1,12 @@
"""
Markdown extension: turn bare URLs into links (v2.3.0)
Markdown extensions for notes
Python-Markdown only links <https://...>; notes often contain pasted URLs.
BareUrlExtension: turn bare URLs into links (v2.3.0). Python-Markdown only
links <https://...>; notes often contain pasted URLs.
HashtagLineExtension: a line starting with a hashtag stays text (v2.16.0).
Python-Markdown makes '#indieweb is fun' a heading; CommonMark (and every
other Markdown a client may use) needs a space after the '#'.
"""
import re
@@ -9,6 +14,7 @@ import xml.etree.ElementTree as etree
from markdown.extensions import Extension
from markdown.inlinepatterns import InlineProcessor
from markdown.preprocessors import Preprocessor
from markdown.treeprocessors import Treeprocessor
from markdown.util import AtomicString
@@ -40,3 +46,20 @@ class BareUrlExtension(Extension):
# Below links (160) and <autolinks> (120), so those win
md.inlinePatterns.register(_BareUrl(BARE_URL_RE, md), "bare_url", 105)
md.treeprocessors.register(_UnnestLinks(md), "unnest_links", 0)
# Up to 3 spaces, then '#'s straight followed by text: a hashtag, not a heading
_HASHTAG_LINE_RE = re.compile(r"^( {0,3})(?=#+[^\s#])")
class _HashtagLines(Preprocessor):
"""Escape the first '#' of such a line, so it renders as text"""
def run(self, lines):
return [_HASHTAG_LINE_RE.sub(r"\1\\", line) for line in lines]
class HashtagLineExtension(Extension):
def extendMarkdown(self, md):
# After fenced code (25) and raw HTML (20) are set aside, so code is untouched
md.preprocessors.register(_HashtagLines(md), "hashtag_lines", 15)
+13
View File
@@ -0,0 +1,13 @@
"""
MCP server for StarPunk (v2.15.0, ADR-075)
AI clients (claude.ai connectors, Claude Code, ...) read and write notes
through the Model Context Protocol at SITE_URL/mcp. It runs as a sidecar
process (uvicorn, the official MCP Python SDK) next to the Flask app and
calls the same service functions. StarPunk's own IndieAuth server issues the
tokens; this server only checks them (an OAuth resource server).
"""
from starpunk.mcp_server.server import create_asgi_app, create_mcp_server
__all__ = ["create_asgi_app", "create_mcp_server"]
+13
View File
@@ -0,0 +1,13 @@
"""
ASGI entry point for the MCP sidecar (v2.15.0, ADR-075)
uvicorn starpunk.mcp_server.app:app --host 0.0.0.0 --port 8001
Run it with BACKGROUND_WORKERS_ENABLED=false and the same environment and
data volume as the main app. Route /mcp and
/.well-known/oauth-protected-resource/mcp to it.
"""
from starpunk.mcp_server.server import create_asgi_app
app = create_asgi_app()
+56
View File
@@ -0,0 +1,56 @@
"""
Bearer token checks for the MCP endpoint (v2.15.0, ADR-075)
Tokens are StarPunk IndieAuth tokens bound to the MCP resource (RFC 8707).
The SDK's bearer middleware turns a missing or rejected token into a 401
that points the client at the protected resource metadata, and refuses
tokens whose resource isn't this endpoint (validate_token_resource).
"""
from datetime import datetime, timezone
from typing import Optional
import anyio.to_thread
from flask import Flask
from mcp.server.auth.provider import AccessToken
from starpunk.indieauth import verify_access_token
def _epoch(value) -> Optional[int]:
"""SQLite timestamp (datetime or 'YYYY-MM-DD HH:MM:SS' UTC) -> epoch seconds"""
if value is None:
return None
if isinstance(value, str):
try:
value = datetime.fromisoformat(value)
except ValueError:
return None
if value.tzinfo is None:
value = value.replace(tzinfo=timezone.utc)
return int(value.timestamp())
class StarPunkTokenVerifier:
"""TokenVerifier backed by the indieauth_tokens table"""
def __init__(self, app: Flask):
self.app = app
def _verify(self, token: str) -> Optional[AccessToken]:
with self.app.app_context():
info = verify_access_token(token)
if not info:
return None
return AccessToken(
token=token,
client_id=info["client_id"],
scopes=(info["scope"] or "").split(),
expires_at=_epoch(info.get("expires_at")),
resource=info.get("resource"),
subject=info["me"],
)
async def verify_token(self, token: str) -> Optional[AccessToken]:
# Database work happens off the event loop
return await anyio.to_thread.run_sync(self._verify, token)
+95
View File
@@ -0,0 +1,95 @@
"""
The MCP server and its ASGI app (v2.15.0, ADR-075)
Stateless Streamable HTTP with plain JSON responses: every request stands
alone, so any number of uvicorn workers can serve it and nothing is lost on
restart.
"""
from typing import Optional
from urllib.parse import urlparse
from flask import Flask
from mcp.server import MCPServer
from mcp.server.auth.settings import AuthSettings
from mcp.server.transport_security import TransportSecuritySettings
from pydantic import AnyHttpUrl
from starlette.applications import Starlette
from starpunk.mcp_server.auth import StarPunkTokenVerifier
from starpunk.mcp_server.tools import register_tools
INSTRUCTIONS = """\
StarPunk is an IndieWeb site: a personal blog of short notes and longer
articles, owned by one person. Notes are Markdown. A note whose first line
is '# Heading' is an article with that title. Notes can be drafts
(unpublished) or published; publishing may crosspost them to social
networks chosen with syndicate_to (see get_site_config). Prefer drafts unless
the owner asked to publish. Deleting is a soft delete that undelete_note
reverses.
"""
def _site(app: Flask) -> str:
return app.config["SITE_URL"].rstrip("/")
def create_mcp_server(app: Flask) -> MCPServer:
"""The MCP server, with StarPunk's tools and token checks"""
site = _site(app)
server = MCPServer(
name="StarPunk",
instructions=INSTRUCTIONS,
website_url=site,
version=app.config.get("VERSION", ""),
token_verifier=StarPunkTokenVerifier(app),
auth=AuthSettings(
# Same string as the issuer in /.well-known/oauth-authorization-server
issuer_url=AnyHttpUrl(site + "/"),
resource_server_url=AnyHttpUrl(site + "/mcp"),
# Tools check their own scopes; any StarPunk token may connect
required_scopes=[],
validate_token_resource=True,
),
)
register_tools(server, app)
return server
def _transport_security(app: Flask) -> TransportSecuritySettings:
"""Only requests for this site's host and from its origin (DNS rebinding)"""
site = urlparse(_site(app))
hosts = [site.netloc]
origins = [f"{site.scheme}://{site.netloc}"]
if app.config.get("DEV_MODE"):
hosts += ["localhost:*", "127.0.0.1:*"]
origins += ["http://localhost:*", "http://127.0.0.1:*"]
return TransportSecuritySettings(
enable_dns_rebinding_protection=True,
allowed_hosts=hosts,
allowed_origins=origins,
)
def create_asgi_app(app: Optional[Flask] = None) -> Starlette:
"""
ASGI app serving /mcp and its protected resource metadata
Args:
app: The Flask app to call into. Built from the environment if not
given, with background workers off (the main app runs those).
"""
if app is None:
from starpunk import create_app
app = create_app({"BACKGROUND_WORKERS_ENABLED": False})
server = create_mcp_server(app)
return server.streamable_http_app(
streamable_http_path="/mcp",
stateless_http=True,
json_response=True,
# Base64 photos for upload_media: 10 MB of image is ~14 MB encoded
max_request_body_size=16 * 1024 * 1024,
transport_security=_transport_security(app),
)
+370
View File
@@ -0,0 +1,370 @@
"""
MCP tools for StarPunk (v2.15.0, ADR-075)
Reading tools call the notes, tags and search services. Writing tools build
a Micropub request and hand it to the Micropub handlers, so an MCP post goes
through exactly the same checks and side effects (scopes, drafts-only
tokens, crossposting, webmentions, WebSub) as one from any Micropub client.
Scopes are the Micropub ones: reading needs any StarPunk token; drafts and
tags need create, update, delete or draft; writing needs create (or draft),
update, delete or media.
"""
import base64
import binascii
from pathlib import Path
from typing import Any, Callable, Optional
from urllib.parse import urlparse
import anyio.to_thread
from flask import Flask
from mcp.server import MCPServer
from mcp.server.auth.middleware.auth_context import get_access_token
from mcp.server.mcpserver.exceptions import ToolError
from mcp.types import ToolAnnotations
from pydantic import BaseModel, Field
from starpunk.indieauth import check_scope
from starpunk.micropub import MicropubError
DRAFT_SCOPES = ("create", "update", "delete", "draft")
MAX_LIMIT = 100
class Photo(BaseModel):
"""A photo for a note"""
url: str = Field(description="URL from upload_media, or any public image URL")
alt: str = Field(default="", description="Alt text describing the photo")
def _token_info() -> dict:
"""The caller's token as the Micropub handlers expect it"""
token = get_access_token()
if token is None:
raise ToolError("Not authenticated")
return {"me": token.subject, "client_id": token.client_id, "scope": " ".join(token.scopes)}
def _require(info: dict, *scopes: str) -> None:
if not any(check_scope(s, info["scope"]) for s in scopes):
raise ToolError(f"This needs the {' or '.join(scopes)} scope; reconnect and grant it")
def _sees_drafts(info: dict) -> bool:
return any(check_scope(s, info["scope"]) for s in DRAFT_SCOPES)
def _clamp(limit: int) -> int:
return max(1, min(int(limit), MAX_LIMIT))
def _note_url(slug: str, title=None) -> str:
from starpunk.utils import post_url
return post_url(slug, title)
def _summary(note) -> dict:
from starpunk.utils import iso_utc
return {
"url": note.url,
"slug": note.slug,
"title": note.title,
"summary": note.summary,
"kind": note.kind,
"status": "published" if note.published else "draft",
"published": iso_utc(note.created_at),
"excerpt": note.excerpt,
}
def _find_note(url_or_slug: str):
"""A note by its URL on this site or its slug"""
from starpunk.micropub import _note_from_url
from starpunk.notes import get_note
value = (url_or_slug or "").strip()
if urlparse(value).scheme:
return _note_from_url(value)
note = get_note(slug=value.strip("/").split("/")[-1]) if value else None
if note is None:
raise ToolError("Note not found")
return note
def _status_after(url: str) -> dict:
"""Summary of the note at url, as it is now"""
return _summary(_find_note(url))
def register_tools(server: MCPServer, app: Flask) -> None:
"""Add StarPunk's tools to the MCP server"""
site = app.config["SITE_URL"].rstrip("/")
async def run(fn: Callable[..., Any], *args, **kwargs) -> Any:
"""Run fn in a worker thread inside a Flask request context for SITE_URL"""
def call():
with app.test_request_context(base_url=site):
try:
return fn(*args, **kwargs)
except MicropubError as e:
raise ToolError(e.error_description or e.error) from e
except ValueError as e:
raise ToolError(str(e)) from e
return await anyio.to_thread.run_sync(call)
read_only = ToolAnnotations(read_only_hint=True, open_world_hint=False)
# Reading
@server.tool(annotations=read_only)
async def search_notes(query: str, include_drafts: bool = False, limit: int = 20) -> dict:
"""Full-text search of the site's notes. Returns matches with a snippet;
use get_note for the whole note."""
info = _token_info()
if include_drafts:
_require(info, *DRAFT_SCOPES)
def search():
from starpunk.search import has_fts_table, search_notes as fts
db_path = Path(app.config["DATABASE_PATH"])
if not has_fts_table(db_path):
raise ToolError("Search is not available on this server")
results = fts(query=query, db_path=db_path, published_only=not include_drafts, limit=_clamp(limit))
return {
"results": [
{"url": _note_url(r["slug"], r.get("article_title")), "slug": r["slug"], "title": r.get("title"),
"snippet": r.get("snippet")}
for r in results
]
}
return await run(search)
@server.tool(annotations=read_only)
async def list_notes(include_drafts: bool = False, limit: int = 20, offset: int = 0) -> dict:
"""The site's notes, newest first. Drafts are left out unless
include_drafts is true."""
info = _token_info()
if include_drafts:
_require(info, *DRAFT_SCOPES)
def notes():
from starpunk.notes import list_notes as list_all
found = list_all(published_only=not include_drafts, limit=_clamp(limit), offset=max(0, offset))
return {"notes": [_summary(n) for n in found], "offset": max(0, offset)}
return await run(notes)
@server.tool(annotations=read_only)
async def get_note(url_or_slug: str) -> dict:
"""One note in full: Markdown content, title (name), tags (category),
photos, status, reply/like/repost/bookmark target and crosspost links,
as Microformats2 properties."""
info = _token_info()
def one():
from starpunk.micropub import note_to_mf2
note = _find_note(url_or_slug)
if not note.published and not _sees_drafts(info):
raise ToolError("Note not found")
return {"url": note.url, "slug": note.slug,
"properties": note_to_mf2(note)["properties"]}
return await run(one)
@server.tool(annotations=read_only)
async def list_tags(filter: str = "") -> dict:
"""Tags in use on the site, most used first, optionally only those
containing filter."""
info = _token_info()
_require(info, *DRAFT_SCOPES)
def tags():
from starpunk.micropub import _all_categories
return {"tags": _all_categories(filter)}
return await run(tags)
@server.tool(annotations=read_only)
async def get_site_config() -> dict:
"""What the site supports: post types and the crosspost targets
(syndicate-to uids) that create_note's syndicate_to accepts."""
info = _token_info()
def config():
from starpunk.micropub import handle_query
response = handle_query({"q": "config"}, info)
# Flask views may return (response, status[, headers])
if isinstance(response, tuple):
response = response[0]
return response.get_json()
return await run(config)
# Writing
@server.tool(annotations=ToolAnnotations(destructive_hint=False, open_world_hint=True))
async def create_note(
content: str = "",
title: Optional[str] = None,
summary: Optional[str] = None,
tags: Optional[list[str]] = None,
draft: bool = True,
photos: Optional[list[Photo]] = None,
in_reply_to: Optional[str] = None,
like_of: Optional[str] = None,
repost_of: Optional[str] = None,
bookmark_of: Optional[str] = None,
syndicate_to: Optional[list[str]] = None,
slug: Optional[str] = None,
published_at: Optional[str] = None,
) -> dict:
"""Create a note (Markdown). It is a draft unless draft is false;
publishing makes it public and crossposts it to the syndicate_to
targets. A title makes it an article; summary is its short summary,
shown on the homepage and in feeds and crossposts. At most one of like_of,
repost_of and bookmark_of. published_at is an ISO 8601 date."""
info = _token_info()
_require(info, "create", "draft")
props: dict[str, list] = {"post-status": ["draft" if draft else "published"]}
if content:
props["content"] = [content]
if title:
props["name"] = [title]
if summary:
props["summary"] = [summary]
if tags:
props["category"] = list(tags)
if photos:
props["photo"] = [{"value": p.url, "alt": p.alt} for p in photos]
for name, value in (("in-reply-to", in_reply_to), ("like-of", like_of),
("repost-of", repost_of), ("bookmark-of", bookmark_of),
("published", published_at)):
if value:
props[name] = [value]
data: dict[str, Any] = {"type": ["h-entry"], "properties": props}
if syndicate_to:
data["mp-syndicate-to"] = list(syndicate_to)
if slug:
data["mp-slug"] = slug
def create():
from starpunk.micropub import handle_create
_, _, headers = handle_create(data, info)
return _status_after(headers["Location"])
return await run(create)
@server.tool(annotations=ToolAnnotations(destructive_hint=True, idempotent_hint=True, open_world_hint=True))
async def update_note(
url: str,
content: Optional[str] = None,
title: Optional[str] = None,
summary: Optional[str] = None,
tags: Optional[list[str]] = None,
add_tags: Optional[list[str]] = None,
remove_tags: Optional[list[str]] = None,
draft: Optional[bool] = None,
photos: Optional[list[Photo]] = None,
in_reply_to: Optional[str] = None,
) -> dict:
"""Change a note. Only the fields given change: content replaces the
text, title replaces the title ("" removes it), summary likewise, tags replaces all
tags, add_tags/remove_tags adjust them, photos replaces all photos,
draft false publishes a draft (and crossposts it) and true unpublishes.
Edits to published notes follow to their crossposts."""
info = _token_info()
_require(info, "update")
replace: dict[str, list] = {}
if content is not None:
replace["content"] = [content]
if title is not None:
replace["name"] = [title]
if summary is not None:
replace["summary"] = [summary]
if tags is not None:
replace["category"] = list(tags)
if draft is not None:
replace["post-status"] = ["draft" if draft else "published"]
if photos is not None:
replace["photo"] = [{"value": p.url, "alt": p.alt} for p in photos]
if in_reply_to is not None:
replace["in-reply-to"] = [in_reply_to]
data: dict[str, Any] = {"action": "update", "url": url, "replace": replace}
if add_tags:
data["add"] = {"category": list(add_tags)}
if remove_tags:
data["delete"] = {"category": list(remove_tags)}
def update():
from starpunk.micropub import handle_update
note = _find_note(url)
data["url"] = note.url
handle_update(data, info)
return _status_after(data["url"])
return await run(update)
@server.tool(annotations=ToolAnnotations(destructive_hint=True, idempotent_hint=True, open_world_hint=False))
async def delete_note(url: str) -> dict:
"""Delete a note. It can be restored with undelete_note."""
info = _token_info()
_require(info, "delete")
def delete():
from starpunk.micropub import handle_delete
note_url = _find_note(url).url
handle_delete({"url": note_url}, info)
return {"url": note_url, "status": "deleted"}
return await run(delete)
@server.tool(annotations=ToolAnnotations(destructive_hint=False, idempotent_hint=True, open_world_hint=False))
async def undelete_note(url: str) -> dict:
"""Restore a deleted note."""
info = _token_info()
_require(info, "delete")
note_url = url if urlparse(url).scheme else f"{site}/note/{url.strip('/')}"
def undelete():
from starpunk.micropub import handle_delete
handle_delete({"url": note_url}, info, undelete=True)
return _status_after(note_url)
return await run(undelete)
@server.tool(annotations=ToolAnnotations(destructive_hint=False, open_world_hint=False))
async def upload_media(filename: str, data_base64: str) -> dict:
"""Upload an image (JPEG, PNG, GIF, WebP or HEIC, base64-encoded) and
get its URL, to use as a photo in create_note or update_note."""
info = _token_info()
_require(info, "media", "create")
try:
data = base64.b64decode(data_base64, validate=True)
except (binascii.Error, ValueError):
raise ToolError("data_base64 is not valid base64")
def upload():
from starpunk.media import save_media
media = save_media(data, filename)
return {"url": f"{site}/media/{media['path']}"}
return await run(upload)
+98 -40
View File
@@ -7,7 +7,8 @@ interface for creating posts via external clients.
Functions:
normalize_properties: Convert form/JSON data to Micropub properties format
extract_content: Get content from Micropub properties
extract_title: Get the explicit title (name) from Micropub properties
extract_title: Get the title (name) from Micropub properties
extract_summary: Get the author's summary from Micropub properties
extract_tags: Get category tags from Micropub properties
handle_create: Process Micropub create action
handle_update: Process Micropub update action (v2.4.0)
@@ -204,10 +205,11 @@ def extract_content(properties: dict) -> str:
content = content_list[0]
# Handle structured content ({"html": "...", "text": "..."})
# Handle structured content ({"html": "...", "text": "..."}). The HTML is
# what was written; clients send text as a plain fallback, which loses
# images, links and headings (v2.16.0; before, text was preferred)
if isinstance(content, dict):
# Prefer text over html for markdown storage
content = content.get("text") or content.get("html", "")
content = content.get("html") or content.get("text", "")
if not isinstance(content, str) or not content.strip():
raise MicropubValidationError("Content cannot be empty")
@@ -216,9 +218,9 @@ def extract_content(properties: dict) -> str:
def content_format(properties: dict) -> Optional[str]:
"""'html' if the content was sent only as HTML (returned as such by q=source)"""
"""'html' if the content was sent as HTML (returned as such by q=source)"""
content = _first(properties.get("content"))
if isinstance(content, dict) and content.get("html") and not content.get("text"):
if isinstance(content, dict) and content.get("html"):
return "html"
return None
@@ -235,10 +237,7 @@ def _has_text(content) -> bool:
def extract_title(properties: dict) -> Optional[str]:
"""
Extract the explicit title (Micropub 'name' property)
StarPunk has no title field: a note's title is a '# Heading' first line
(see Note.title), so the caller stores the name as that heading.
Extract the title (Micropub 'name' property), stored in notes.title (ADR-076)
Args:
properties: Normalized Micropub properties dict
@@ -252,14 +251,22 @@ def extract_title(properties: dict) -> Optional[str]:
return " ".join(name.split()) or None
def add_title_heading(content: str, title: Optional[str]) -> str:
"""Prefix content with '# title' unless it already starts with that heading"""
if not title:
return content
first_line = content.lstrip().split("\n", 1)[0]
if first_line.startswith("#") and first_line.lstrip("#").strip() == title:
return content
return f"# {title}\n\n{content}"
def extract_summary(properties: dict) -> Optional[str]:
"""The author's summary (Micropub 'summary' property, v2.16.0), as plain text"""
summary = _first(properties.get("summary"))
if isinstance(summary, dict):
summary = summary.get("text") or summary.get("value") or ""
if not isinstance(summary, str):
return None
return summary.strip() or None
def drop_title_heading(content: str, title: Optional[str]) -> str:
"""Content without a '# heading' first line that only repeats the title"""
heading, rest = split_title(content)
if title and heading == title:
return rest
return content
def extract_tags(properties: dict) -> list[str]:
@@ -308,7 +315,7 @@ MAX_PHOTOS = 4 # ADR-057
MAX_REMOTE_PHOTO_BYTES = 20 * 1024 * 1024
# Properties we can store, and so can be updated (v2.4.0)
UPDATABLE = {"content", "name", "category", "in-reply-to", "post-status", "photo"}
UPDATABLE = {"content", "name", "summary", "category", "in-reply-to", "post-status", "photo"}
def _first(value):
@@ -407,9 +414,10 @@ def _public_address(host: str) -> bool:
return bool(infos)
def _fetch_remote_photo(url: str) -> Optional[int]:
def _fetch_remote_photo(url: str) -> Optional[dict]:
"""
Download a photo hosted elsewhere into the media library. Returns media id.
Download a photo hosted elsewhere into the media library. Returns the
saved media ({'id', 'path', ...}), or None if it couldn't be fetched.
Uses the webmention fetcher (v2.9.0): every redirect is checked against
private addresses and the connection is pinned to the checked address.
@@ -426,7 +434,7 @@ def _fetch_remote_photo(url: str) -> Optional[int]:
if result.status_code != 200:
raise ValueError(f"HTTP {result.status_code}")
name = urlparse(result.url).path.rsplit("/", 1)[-1] or "photo.jpg"
return save_media(result.content, name)["id"]
return save_media(result.content, name)
except Exception as e:
current_app.logger.warning(f"Could not fetch photo {url}: {e}")
return None
@@ -446,7 +454,35 @@ def _media_id_for_url(url: str) -> Optional[int]:
return row[0]
current_app.logger.warning(f"Photo URL not found in media: {url}")
return None
return _fetch_remote_photo(url)
media = _fetch_remote_photo(url)
return media["id"] if media else None
MAX_INLINE_IMAGES = 20
def localize_inline_images(content: str) -> str:
"""
Copy images embedded in the text from other sites into the media library
and point the text at the copies (v2.16.0), so an article doesn't depend
on the client's or a CDN's host staying up. Best effort: an image that
can't be fetched keeps its URL.
"""
from html import escape
from starpunk.syndication import inline_images
if not content or "<img" not in content and "![" not in content:
return content
site_url = current_app.config.get("SITE_URL", "").rstrip("/")
remote = [url for url, _ in inline_images(content)
if url.startswith(("http://", "https://")) and not url.startswith(site_url + "/")]
for url in list(dict.fromkeys(remote))[:MAX_INLINE_IMAGES]:
media = _fetch_remote_photo(url)
if media:
local = f"{site_url}/media/{media['path']}"
# As written in Markdown, and as it may be escaped in HTML attributes
content = content.replace(url, local).replace(escape(url), local)
return content
def _save_uploads(files) -> list[dict]:
@@ -513,7 +549,7 @@ def _check_type(data: dict) -> None:
def _note_from_url(url: Optional[str], deleted: bool = False):
"""Find the note a URL points at (/note/<slug> on this site)"""
"""Find the note a URL points at (/note/<slug> or /article/<slug> on this site)"""
from urllib.parse import urlparse
from starpunk.database import get_db
@@ -524,7 +560,7 @@ def _note_from_url(url: Optional[str], deleted: bool = False):
if parsed.netloc and site.netloc and parsed.netloc != site.netloc:
raise MicropubValidationError("URL is not on this site")
parts = [p for p in parsed.path.split("/") if p]
if len(parts) != 2 or parts[0] not in ("note", "notes"):
if len(parts) != 2 or parts[0] not in ("note", "notes", "article", "articles"):
raise MicropubValidationError("URL is not a post on this site")
slug = parts[1]
if deleted:
@@ -596,6 +632,10 @@ def handle_create(data: dict, token_info: dict, files=None):
if has_content or not (like_of or repost_of or bookmark_of or photos or title)
else ""
)
content = localize_inline_images(drop_title_heading(content, title))
# A summary with content is the author's summary; alone it is the
# content (Post Type Discovery), as extract_content does (v2.16.0)
summary = extract_summary(properties) if _has_text(properties.get("content")) else None
tags = extract_tags(properties)
published_date = extract_published_date(properties)
published = extract_post_status(properties) and not extract_visibility_draft(properties)
@@ -615,7 +655,9 @@ def handle_create(data: dict, token_info: dict, files=None):
note = None
try:
note = create_note(
content=add_title_heading(content, title),
content=content,
title=title,
summary=summary,
published=published,
created_at=published_date,
custom_slug=custom_slug,
@@ -636,7 +678,7 @@ def handle_create(data: dict, token_info: dict, files=None):
from starpunk.syndication import resolve_targets, select_targets
select_targets(note.id, resolve_targets(requested_targets))
return "", 201, {"Location": absolute_url_for("public.note", slug=note.slug)}
return "", 201, {"Location": note.url}
except InvalidNoteDataError as e:
raise MicropubValidationError(str(e))
@@ -686,7 +728,7 @@ def handle_update(data: dict, token_info: dict):
from starpunk.tags import get_note_tags
title, body = split_title(note.content)
title, summary, body = note.title, note.summary, note.content
tags = [t["display_name"] for t in get_note_tags(note.id, entered_order=True)]
photos = _note_photos(note)
changes = {}
@@ -696,6 +738,8 @@ def handle_update(data: dict, token_info: dict):
for prop in delete:
if prop == "name":
title = None
elif prop == "summary":
summary = None
elif prop == "content":
body = ""
elif prop == "category":
@@ -719,10 +763,12 @@ def handle_update(data: dict, token_info: dict):
if "content" in replace:
# Empty text is fine if the note keeps its photos; update_note checks (v2.6.5)
body = extract_content(replace) if _has_text(replace["content"]) else ""
body = localize_inline_images(extract_content(replace)) if _has_text(replace["content"]) else ""
changes["content_format"] = content_format(replace) if body else None
if "name" in replace:
title = extract_title(replace)
if "summary" in replace:
summary = extract_summary(replace)
if "category" in replace:
tags = extract_tags(replace)
if "photo" in replace:
@@ -738,17 +784,22 @@ def handle_update(data: dict, token_info: dict):
if "photo" in add:
photos += extract_photos(add)
# Text may go only if photos stay (or it's a like, repost or bookmark) (v2.6.5)
if not (body or "").strip() and not (photos or note.reacts_to):
raise MicropubValidationError("A post needs text or a photo")
# Text may go only if photos stay, it has a title, or it's a like, repost
# or bookmark (v2.6.5)
if not (body or "").strip() and not (photos or title or note.reacts_to):
raise MicropubValidationError("A post needs text, a title or a photo")
# Photos must all resolve before anything changes (v2.9.0)
if "photo" in touched:
media_ids, captions = _resolve_photos(photos)
new_content = add_title_heading(body, title)
if new_content != note.content:
changes["content"] = new_content
if title != note.title:
changes["title"] = title
if summary != note.summary:
changes["summary"] = summary
body = drop_title_heading(body, title)
if body != note.content:
changes["content"] = body
elif "content_format" in changes and changes["content_format"] == note.content_format:
del changes["content_format"]
if {"category"} & touched:
@@ -769,6 +820,11 @@ def handle_update(data: dict, token_info: dict):
current_app.logger.error(f"Failed to update note via Micropub: {e}")
raise MicropubError("server_error", "Failed to update post", status_code=500)
# Adding or removing a title moves the post between /note/ and /article/:
# the spec says to answer 201 with the new URL (v2.17.0)
if bool(title) != bool(note.title):
from starpunk.utils import post_url
return "", 201, {"Location": post_url(note.slug, title)}
return "", 204
@@ -800,20 +856,22 @@ def note_to_mf2(note, wanted: Optional[list] = None) -> dict:
"""
A note as Microformats2 JSON, the inverse of create
A '# Heading' first line is the title, returned as name.
The title is returned as name and the author's summary as summary.
"""
from starpunk.syndication import get_note_syndications
title, content = split_title(note.content)
content = note.content
props = {
# HTML-authored content comes back as HTML (3.7.2, v2.9.0)
"content": [{"html": content} if note.content_format == "html" else content],
"published": [iso_utc(note.created_at)],
"url": [absolute_url_for("public.note", slug=note.slug)],
"url": [note.url],
"post-status": ["published" if note.published else "draft"],
}
if title:
props["name"] = [title]
if note.title:
props["name"] = [note.title]
if note.summary:
props["summary"] = [note.summary]
from starpunk.tags import get_note_tags
tags = get_note_tags(note.id, entered_order=True)
+67 -1
View File
@@ -344,7 +344,65 @@ def apply_migration(conn, migration_name, migration_path, logger=None):
raise MigrationError(error_msg)
def run_migrations(db_path, logger=None):
def _move_note_titles(conn, data_dir, logger):
"""
Migration 023 data step: move each note's '# Heading' title into notes.title
Runs once, inside the migration transaction. Rewrites the note files without
the heading and returns [(path, original text)] so a failed migration can
put them back (see _restore_files).
"""
from starpunk.models import split_title
from starpunk.utils import calculate_content_hash, find_trashed_file, write_note_file
data_dir = Path(data_dir)
written = []
try:
rows = conn.execute(
"SELECT id, slug, file_path FROM notes WHERE title IS NULL"
).fetchall()
for note_id, slug, file_path in rows:
path = data_dir / file_path
if not path.exists():
path = find_trashed_file(data_dir, file_path)
if path is None:
logger.warning(f"Migration 023: no file for note {slug}, title not moved")
continue
text = path.read_text(encoding="utf-8")
title, body = split_title(text)
if title is None:
continue
conn.execute(
"UPDATE notes SET title = ?, content_hash = ? WHERE id = ?",
(title, calculate_content_hash(body), note_id),
)
write_note_file(path, body)
written.append((path, text))
if written and table_exists(conn, "notes_fts"):
# Emptied so startup rebuilds it with the titles (starpunk/__init__.py)
conn.execute("DELETE FROM notes_fts")
logger.info(f"Migration 023: moved {len(written)} titles out of note files")
return written
except Exception:
_restore_files(written, logger)
raise
def _restore_files(written, logger):
"""Put back note files changed by a data step whose migration failed"""
for path, text in written:
try:
path.write_text(text, encoding="utf-8")
except OSError as e:
logger.critical(f"Could not restore {path} after failed migration: {e}")
# Python steps run right after a migration's SQL, in the same transaction.
# Each returns [(path, original text)] for files it changed.
DATA_MIGRATIONS = {"023_note_titles.sql": _move_note_titles}
def run_migrations(db_path, logger=None, data_dir=None):
"""
Run all pending database migrations with concurrency protection
@@ -374,6 +432,8 @@ def run_migrations(db_path, logger=None):
Args:
db_path: Path to SQLite database file
logger: Optional logger for output
data_dir: Data directory, for migrations that also change note files
(DATA_MIGRATIONS); skipped when None
Raises:
MigrationError: If any migration fails to apply or lock cannot be acquired
@@ -407,6 +467,7 @@ def run_migrations(db_path, logger=None):
# BEGIN IMMEDIATE acquires RESERVED lock, preventing other writes
# but allowing reads. Escalates to EXCLUSIVE during actual writes.
conn.execute("BEGIN IMMEDIATE")
written = [] # note files changed by DATA_MIGRATIONS, restored on failure
try:
# Ensure migrations tracking table exists
@@ -510,6 +571,9 @@ def run_migrations(db_path, logger=None):
# Execute migration inside the locked transaction
execute_in_transaction(conn, migration_sql)
data_step = DATA_MIGRATIONS.get(migration_name)
if data_step and data_dir is not None:
written += data_step(conn, data_dir, logger)
# Record migration as applied
conn.execute(
@@ -547,6 +611,7 @@ def run_migrations(db_path, logger=None):
except MigrationError:
# Migration error - rollback and re-raise
_restore_files(written, logger)
try:
conn.rollback()
except Exception as rollback_error:
@@ -556,6 +621,7 @@ def run_migrations(db_path, logger=None):
except Exception as e:
# Unexpected error during migration - rollback and wrap
_restore_files(written, logger)
try:
conn.rollback()
except Exception as rollback_error:
+54 -112
View File
@@ -36,9 +36,9 @@ DEFAULT_AUTH_STATE_EXPIRY_MINUTES = 5
DEFAULT_TOKEN_EXPIRY_DAYS = 90
# Constants - Markdown rendering
from starpunk.markdown_ext import BareUrlExtension
from starpunk.markdown_ext import BareUrlExtension, HashtagLineExtension
MARKDOWN_EXTENSIONS = ["extra", "codehilite", "nl2br", BareUrlExtension()]
MARKDOWN_EXTENSIONS = ["extra", "codehilite", "nl2br", BareUrlExtension(), HashtagLineExtension()]
# Constants - Content limits
MAX_TITLE_LENGTH = 200
@@ -76,11 +76,14 @@ EXCERPT_LENGTH = 200
def split_title(content: str) -> tuple[Optional[str], str]:
"""
Split a note's '# Heading' first line (its title, per Q22) off its content
Split a '# Heading' first line off Markdown content
Before v2.16.0 an article's title was its '# Heading' first line (Q22).
Titles now live in notes.title (ADR-076); migration 023 uses this to move
the old headings there, and Micropub to drop a heading that repeats 'name'.
The first line must be a Markdown heading: 1-6 '#' then a space and text.
'#indieweb ...' (a hashtag) or a bare '#' is not a title. This is the one
place that decides whether a note has a title (templates use has_title).
'#indieweb ...' (a hashtag) or a bare '#' is not a title.
Returns:
(title, remaining content); title is None if the note has no heading
@@ -171,6 +174,8 @@ class Note:
repost_of: Optional[str] = None # v2.5.0: URL reposted (this note is a repost)
bookmark_of: Optional[str] = None # v2.9.0: URL bookmarked (this note is a bookmark)
content_format: Optional[str] = None # v2.9.0: 'html' if sent as HTML via Micropub
title: Optional[str] = None # v2.16.0: an article's title (p-name), ADR-076
summary: Optional[str] = None # v2.16.0: author-written summary (p-summary)
_cached_content: Optional[str] = field(
default=None, repr=False, compare=False, init=False
)
@@ -233,6 +238,8 @@ class Note:
repost_of=data.get("repost_of"),
bookmark_of=data.get("bookmark_of"),
content_format=data.get("content_format"),
title=data.get("title"),
summary=data.get("summary"),
)
@property
@@ -291,8 +298,13 @@ class Note:
<p>This is my note content...</p>
"""
if self._cached_html is None:
# Render markdown to sanitized HTML (v2.9.0)
html = render_markdown(self.content) # triggers lazy load of content
if self.content_format == "html":
# Sent as HTML via Micropub: sanitize it as is. Through Markdown
# it picked up stray <br>s and empty paragraphs (v2.16.0)
html = nh3.clean(self.content, tags=ALLOWED_TAGS, attributes=ALLOWED_ATTRIBUTES)
else:
# Render markdown to sanitized HTML (v2.9.0)
html = render_markdown(self.content) # triggers lazy load of content
# Cache it
object.__setattr__(self, "_cached_html", html)
@@ -300,124 +312,40 @@ class Note:
return self._cached_html
@property
def body_html(self) -> str:
"""
Rendered HTML without the title heading
Pages show a titled note's title as their own heading, so the body
leaves it out to avoid showing it twice. Untitled notes: same as html.
"""
title, body = split_title(self.content)
if title is None:
return self.html
return render_markdown(body)
@property
def has_title(self) -> bool:
"""True if the note starts with a '# Heading' title (an article)"""
try:
return split_title(self.content)[0] is not None
except (FileNotFoundError, OSError):
return False
@property
def title(self) -> str:
"""
Extract title from content
Returns first line of content, or uses slug as fallback.
Strips markdown heading syntax (# ) if present.
Returns:
Title string
Examples:
>>> # Content: "# My First Note\\n\\nContent here..."
>>> note.title
'My First Note'
>>> # Content: "Just a note without heading"
>>> note.title
'Just a note without heading'
"""
try:
# Get content (may trigger lazy load)
content = self.content
# Split into lines and get first non-empty line
lines = content.strip().split("\n")
first_line = ""
for line in lines:
if line.strip():
first_line = line.strip()
break
if not first_line:
# No content, use slug
return self.slug
# Strip markdown heading syntax
if first_line.startswith("#"):
# Remove leading # characters and whitespace
first_line = first_line.lstrip("#").strip()
# Truncate to max length
if len(first_line) > MAX_TITLE_LENGTH:
first_line = first_line[:MAX_TITLE_LENGTH]
return first_line if first_line else self.slug
except (FileNotFoundError, OSError):
# If file doesn't exist, use slug
return self.slug
def label(self) -> str:
"""A name for places that always need one: the title, else the excerpt, else the slug"""
return self.title or " ".join(self.excerpt.split())[:MAX_TITLE_LENGTH] or self.slug
@property
def excerpt(self) -> str:
"""
Generate short excerpt for previews
Returns first 200 characters of content (plain text, no markdown).
Strips markdown formatting and adds ellipsis if truncated.
The first 200 characters of the note as plain text: Markdown (or
HTML) rendered and stripped, images left out, links as their text
(v2.16.0). Cut at a word boundary with an ellipsis if longer.
Returns:
Excerpt string
Examples:
>>> note.excerpt
'This is my note content. It has some interesting points...'
'This is my note content. It has some interesting points…'
"""
from starpunk.syndication import plain_text
try:
# Leave out the title; previews show it separately
_, content = split_title(self.content)
# Remove markdown heading syntax
lines = content.split("\n")
cleaned_lines = []
for line in lines:
if line.strip().startswith("#"):
# Remove heading syntax
cleaned_lines.append(line.lstrip("#").strip())
else:
cleaned_lines.append(line)
cleaned_content = "\n".join(cleaned_lines)
# Take first EXCERPT_LENGTH characters
excerpt = cleaned_content.strip()[:EXCERPT_LENGTH]
# Truncate to word boundary
if len(cleaned_content.strip()) > EXCERPT_LENGTH:
# Find last space in excerpt
text = " ".join(plain_text(self.content).split())
if len(text) > EXCERPT_LENGTH:
excerpt = text[:EXCERPT_LENGTH]
last_space = excerpt.rfind(" ")
if last_space > 0:
excerpt = excerpt[:last_space]
excerpt += "..."
text = (excerpt[:last_space] if last_space > 0 else excerpt).rstrip() + "…"
if not excerpt and self.reacts_to:
if not text and self.reacts_to:
# A like, repost or bookmark with no comment
return f"{REACTION_VERBS[self.kind]} {self.reacts_to}"
return excerpt
return text
except (FileNotFoundError, OSError):
# If file doesn't exist, return slug
@@ -455,14 +383,27 @@ class Note:
"""
Generate permalink (public URL path)
Returns:
URL path string (e.g., '/note/my-first-note')
Articles (notes with a title) live under /article/, other notes
under /note/ (v2.17.0).
Examples:
>>> note.permalink
'/note/my-first-note'
Returns:
URL path string (e.g., '/note/my-first-note', '/article/my-essay')
"""
return f"/note/{self.slug}"
from starpunk.utils import post_path
return post_path(self.slug, self.title)
@property
def endpoint(self) -> str:
"""The route that shows this note: public.article or public.note (v2.17.0)"""
return "public.article" if self.title else "public.note"
@property
def url(self) -> str:
"""Absolute permalink, built from SITE_URL (needs an app context)"""
from starpunk.utils import post_url
return post_url(self.slug, self.title)
@property
def is_published(self) -> bool:
@@ -533,6 +474,7 @@ class Note:
"id": self.id,
"slug": self.slug,
"title": self.title,
"summary": self.summary,
"published": self.published,
"created_at": self.created_at.strftime("%Y-%m-%dT%H:%M:%SZ"),
"updated_at": self.updated_at.strftime("%Y-%m-%dT%H:%M:%SZ"),
+49 -26
View File
@@ -40,6 +40,7 @@ from starpunk.utils import (
calculate_content_hash,
validate_note_path,
validate_slug,
post_url,
)
@@ -149,6 +150,8 @@ def create_note(
has_media: bool = False,
bookmark_of: Optional[str] = None,
content_format: Optional[str] = None,
title: Optional[str] = None,
summary: Optional[str] = None,
) -> Note:
"""
Create a new note
@@ -164,6 +167,8 @@ def create_note(
custom_slug: Optional custom slug (from Micropub mp-slug property)
tags: Optional list of tag display names (v1.3.0)
in_reply_to: Optional URL being replied to (v1.6.0)
title: Optional title; a titled note is an article (v2.16.0, ADR-076)
summary: Optional author-written summary (v2.16.0)
Returns:
Note object with all metadata and content loaded
@@ -176,7 +181,7 @@ def create_note(
Examples:
>>> # Create unpublished draft
>>> note = create_note("# My First Note\\n\\nContent here.", published=False)
>>> note = create_note("Content here.", title="My First Note", published=False)
>>> print(note.slug)
'my-first-note'
@@ -219,7 +224,9 @@ def create_note(
"like_of", like_of, "A note can only be one of a like, repost or bookmark"
)
content = content or ""
if not content.strip() and not (like_of or repost_of or bookmark_of or has_media):
title = (title or "").strip() or None
summary = (summary or "").strip() or None
if not content.strip() and not (like_of or repost_of or bookmark_of or has_media or title):
raise InvalidNoteDataError(
"content", content, "Content cannot be empty or whitespace-only"
)
@@ -244,9 +251,11 @@ def create_note(
if not success:
raise InvalidNoteDataError("slug", custom_slug, error)
else:
# Generate timestamp-based slug (ADR-062)
from starpunk.slug_utils import generate_timestamp_slug
slug = generate_timestamp_slug(created_at, existing_slugs)
# Articles take their slug from the title (v2.17.0); other notes, or a
# title with nothing usable in it, get a timestamp slug (ADR-062)
from starpunk.slug_utils import generate_timestamp_slug, generate_title_slug
slug = (generate_title_slug(title, existing_slugs) if title else None) \
or generate_timestamp_slug(created_at, existing_slugs)
# 4. GENERATE FILE PATH
note_path = generate_note_path(slug, created_at, data_dir)
@@ -281,11 +290,12 @@ def create_note(
db.execute(
"""
INSERT INTO notes (slug, file_path, published, created_at, updated_at, content_hash,
in_reply_to, like_of, repost_of, bookmark_of, content_format)
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
in_reply_to, like_of, repost_of, bookmark_of, content_format,
title, summary)
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
""",
(slug, file_path_rel, published, created_at, updated_at, content_hash,
in_reply_to, like_of, repost_of, bookmark_of, content_format),
in_reply_to, like_of, repost_of, bookmark_of, content_format, title, summary),
)
db.commit()
except Exception as e:
@@ -327,7 +337,7 @@ def create_note(
from starpunk.search import update_fts_index, has_fts_table
db_path = Path(current_app.config["DATABASE_PATH"])
if has_fts_table(db_path):
update_fts_index(db, note_id, slug, content)
update_fts_index(db, note_id, slug, content, title)
db.commit()
except Exception as e:
# FTS update failure should not prevent note creation
@@ -341,7 +351,7 @@ def create_note(
db_path = Path(current_app.config["DATABASE_PATH"])
site_url = current_app.config["SITE_URL"]
from starpunk.utils import absolute_url_for
note_url = absolute_url_for("public.note", slug=slug)
note_url = post_url(slug, title)
# Get rendered HTML from note
html_content = note.html
@@ -641,11 +651,14 @@ def update_note(
in_reply_to: Optional[str] = None,
has_media: bool = False,
content_format=UNCHANGED,
title=UNCHANGED,
summary=UNCHANGED,
) -> Note:
"""
Update a note's content and/or published status
content_format (v2.9.0): 'html' or None (Markdown); left alone unless given
title, summary (v2.16.0): new value, None or "" to remove; left alone unless given
Updates note content and/or metadata, maintaining atomic synchronization
between file and database. At least one of content or published must
@@ -713,8 +726,15 @@ def update_note(
if slug is not None and id is not None:
raise ValueError("Cannot provide both slug and id")
if content is None and published is None and tags is None and in_reply_to is None:
raise ValueError("Must provide at least one of content, published, tags, or in_reply_to to update")
if (content is None and published is None and tags is None and in_reply_to is None
and title is UNCHANGED and summary is UNCHANGED):
raise ValueError(
"Must provide at least one of content, published, tags, in_reply_to, title or summary to update"
)
if title is not UNCHANGED:
title = (title or "").strip() or None
if summary is not UNCHANGED:
summary = (summary or "").strip() or None
# Validate content if provided (checked against the note below for
# likes/reposts, whose comment may be empty)
@@ -729,7 +749,8 @@ def update_note(
raise NoteNotFoundError(identifier)
old_tag_names = _tag_names(existing_note.id) # for WebSub tag topics (v2.10.0)
if empty_content and not (existing_note.reacts_to or has_media):
new_title = existing_note.title if title is UNCHANGED else title
if empty_content and not (existing_note.reacts_to or has_media or new_title):
raise InvalidNoteDataError(
"content", content, "Content cannot be empty or whitespace-only"
)
@@ -797,6 +818,14 @@ def update_note(
update_fields.append("content_format = ?")
params.append(content_format)
if title is not UNCHANGED:
update_fields.append("title = ?")
params.append(title)
if summary is not UNCHANGED:
update_fields.append("summary = ?")
params.append(summary)
# Add WHERE clause parameter
if slug is not None:
where_clause = "slug = ?"
@@ -832,13 +861,14 @@ def update_note(
# Tag update failure should not prevent note update
current_app.logger.warning(f"Failed to update tags for note {existing_note.slug}: {e}")
# 7. UPDATE FTS INDEX (if available and content changed)
if content is not None:
# 7. UPDATE FTS INDEX (if available and content or title changed)
if content is not None or title is not UNCHANGED:
try:
from starpunk.search import update_fts_index, has_fts_table
db_path = Path(current_app.config["DATABASE_PATH"])
if has_fts_table(db_path):
update_fts_index(db, existing_note.id, existing_note.slug, content)
update_fts_index(db, existing_note.id, existing_note.slug,
existing_note.content if content is None else content, new_title)
db.commit()
except Exception as e:
# FTS update failure should not prevent note update
@@ -876,7 +906,7 @@ def update_note(
db_path = Path(current_app.config["DATABASE_PATH"])
site_url = current_app.config["SITE_URL"]
from starpunk.utils import absolute_url_for
note_url = absolute_url_for("public.note", slug=updated_note.slug)
note_url = updated_note.url
# Get rendered HTML from updated note (if published)
html_content = updated_note.html if updated_note.published else None
@@ -1129,7 +1159,7 @@ def undelete_note(slug: str) -> Note:
NoteNotFoundError: If there is no soft-deleted note with this slug
"""
import shutil
from starpunk.utils import TRASH_DIR_NAME
from starpunk.utils import find_trashed_file
db = get_db(current_app)
row = db.execute(
@@ -1142,14 +1172,7 @@ def undelete_note(slug: str) -> Note:
data_dir = Path(current_app.config["DATA_PATH"])
note_path = data_dir / row["file_path"]
if not note_path.exists():
# delete_note_file put it in .trash/<year>/<month>/<name>
parts = Path(row["file_path"]).parts
candidates = []
if "notes" in parts and len(parts) > parts.index("notes") + 2:
i = parts.index("notes")
candidates.append(data_dir / TRASH_DIR_NAME / parts[i + 1] / parts[i + 2] / note_path.name)
candidates += sorted((data_dir / TRASH_DIR_NAME).glob(f"*/*/{note_path.name}"))
source = next((c for c in candidates if c.exists()), None)
source = find_trashed_file(data_dir, row["file_path"])
if source is None:
raise NoteSyncError("undelete", f"Trashed file not found for {slug}", "Cannot restore note file")
note_path.parent.mkdir(parents=True, exist_ok=True)
+5 -3
View File
@@ -24,6 +24,8 @@ import time
from typing import Dict, List, Optional, Tuple
from urllib.parse import parse_qsl, urlsplit
from starpunk.utils import post_path
logger = logging.getLogger(__name__)
RESPONSE_EVENTS = ("reply", "mention", "quote", "like", "repost", "bookmark")
@@ -142,7 +144,7 @@ def _note_label(conn, note_id: int) -> str:
try:
note = get_note(id=note_id, load_content=True)
label = " ".join((note.title or "").split()) if note else ""
label = note.label if note else ""
except Exception:
label = ""
return (label[:57] + "…") if len(label) > 60 else (label or "a note")
@@ -158,7 +160,7 @@ def _messages(rows, site_url: str, conn) -> List[Tuple[str, str, List[int]]]:
who = (row["author_name"] or "someone") + (f" via {via}" if via else "")
pending = row["moderation_status"] == "pending"
link = (f"{site}/admin/webmentions/{row['id']}" if pending
else f"{site}/note/{row['slug']}#responses")
else f"{site}{post_path(row['slug'], row['note_title'])}#responses")
if row["mention_type"] in GROUPED:
groups.setdefault((row["target_note_id"], row["mention_type"], row["slug"], pending), []).append(
(row["id"], row["author_name"] or "someone", link))
@@ -206,7 +208,7 @@ class Sweeper:
logger.warning(f"Dropped {dropped} notification(s) older than {DROP_AFTER_HOURS} hours")
rows = conn.execute(
"""
SELECT w.*, n.slug FROM webmentions w JOIN notes n ON n.id = w.target_note_id
SELECT w.*, n.slug, n.title AS note_title FROM webmentions w JOIN notes n ON n.id = w.target_note_id
WHERE w.notified_at IS NULL AND w.validation_status = 'valid'
AND w.moderation_status IN ('approved', 'pending')
ORDER BY w.id LIMIT 100
+20 -7
View File
@@ -128,6 +128,7 @@ def create_note_submit():
media_files: Multiple file upload (v1.2.0 Phase 3)
captions[]: Captions for each media file (v1.2.0 Phase 3)
tags: Comma-separated tag list (v1.3.0 Phase 3)
title, summary: Optional; a title makes it an article (v2.16.0)
Returns:
Redirect to dashboard on success, back to form on error
@@ -141,17 +142,19 @@ def create_note_submit():
published = "published" in request.form
custom_slug = request.form.get("custom_slug", "").strip()
tags_input = request.form.get("tags", "")
title = request.form.get("title", "").strip() or None
summary = request.form.get("summary", "").strip() or None
if not content:
flash("Content cannot be empty", "error")
# With photos, WebSub hears about the note once they're attached (v2.10.1)
has_uploads = any(f.filename for f in request.files.getlist('media_files'))
if not (content or title or has_uploads):
flash("A note needs text, a title or an image", "error")
return redirect(url_for("admin.new_note_form"))
# Parse tags (v1.3.0 Phase 3)
tags = parse_tag_input(tags_input)
# With photos, WebSub hears about the note once they're attached (v2.10.1)
has_uploads = any(f.filename for f in request.files.getlist('media_files'))
try:
# Create note first (per Q4)
note = create_note(
@@ -160,6 +163,8 @@ def create_note_submit():
custom_slug=custom_slug if custom_slug else None,
tags=tags if tags else None,
has_media=has_uploads,
title=title,
summary=summary,
)
# Handle media uploads (v1.2.0 Phase 3)
@@ -279,12 +284,14 @@ def update_note_submit(note_id: int):
content: Updated markdown content (required)
published: Checkbox for published status (optional)
tags: Comma-separated tag list (v1.3.0 Phase 3)
title, summary: Empty removes them; a form without the field leaves them (v2.16.0)
Returns:
Redirect to dashboard on success, back to form on error
Decorator: @require_auth
"""
from starpunk.notes import UNCHANGED
from starpunk.tags import parse_tag_input
# Check if note exists first
@@ -296,8 +303,12 @@ def update_note_submit(note_id: int):
content = request.form.get("content", "").strip()
published = "published" in request.form
tags_input = request.form.get("tags", "")
title = request.form["title"].strip() if "title" in request.form else UNCHANGED
summary = request.form["summary"].strip() if "summary" in request.form else UNCHANGED
has_title = existing_note.title if title is UNCHANGED else title
if not content and not existing_note.reacts_to: # likes/reposts may have no comment
# Likes/reposts may have no comment, articles no body
if not content and not (existing_note.reacts_to or has_title):
flash("Content cannot be empty", "error")
return redirect(url_for("admin.edit_note_form", note_id=note_id))
@@ -311,7 +322,9 @@ def update_note_submit(note_id: int):
published=published,
# An empty Tags field removes all tags (v2.14.1); a form without
# the field leaves them alone
tags=tags if "tags" in request.form else None
tags=tags if "tags" in request.form else None,
title=title,
summary=summary,
)
if "syndication_form" in request.form:
from starpunk.syndication import select_targets
+14 -2
View File
@@ -51,6 +51,7 @@ _REQUEST_FIELDS = (
"code_challenge",
"code_challenge_method",
"scope",
"resource",
)
@@ -95,6 +96,11 @@ def metadata():
"revocation_endpoint_auth_methods_supported": ["none"],
"scopes_supported": SUPPORTED_SCOPES,
"response_types_supported": ["code"],
# Public clients only (PKCE); clients identify with a client_id
# URL whose JSON metadata lists redirect_uris, which is what MCP
# calls a Client ID Metadata Document (v2.15.0, ADR-075)
"token_endpoint_auth_methods_supported": ["none"],
"client_id_metadata_document_supported": True,
"grant_types_supported": ["authorization_code"],
"code_challenge_methods_supported": ["S256"],
"authorization_response_iss_parameter_supported": True,
@@ -158,6 +164,7 @@ def approve():
auth_request["redirect_uri"],
" ".join(granted),
auth_request["code_challenge"],
resource=auth_request["resource"],
)
current_app.logger.info(
f"IndieAuth: approved {auth_request['client_id']} (scope: {' '.join(granted) or 'none'})"
@@ -209,7 +216,12 @@ def token():
# Spec: a code issued without scope cannot be used for an access token
return _oauth_error("invalid_grant", "No scope was granted; use the authorization endpoint")
return _json(create_access_token(result["client_id"], result["scope"]))
# RFC 8707: a resource named here must be the one the code was issued for
requested = (request.form.get("resource") or "").strip().rstrip("/")
if requested and requested != (result["resource"] or ""):
return _oauth_error("invalid_target", "resource does not match the authorization request")
return _json(create_access_token(result["client_id"], result["scope"], resource=result["resource"]))
@bp.route("/auth/token", methods=["GET"])
@@ -222,7 +234,7 @@ def token_verify():
info = verify_access_token(token)
if not info:
return _oauth_error("unauthorized", "Invalid or expired access token", 401)
return _json(info)
return _json({k: info[k] for k in ("me", "client_id", "scope")})
@bp.route("/auth/revoke", methods=["POST"])
+22 -4
View File
@@ -8,7 +8,7 @@ No authentication required for these routes.
import hashlib
from datetime import datetime, timedelta, timezone
from flask import Blueprint, abort, render_template, Response, current_app, request, send_from_directory
from flask import Blueprint, abort, redirect, render_template, Response, current_app, request, send_from_directory, url_for
from starpunk.notes import list_notes, get_note
from starpunk.websub import embed_hub
@@ -354,18 +354,30 @@ def _note_was_deleted(slug: str) -> bool:
).fetchone():
return True
return db.execute(
"SELECT 1 FROM webmention_queue WHERE source_url = ? AND source_note_id IS NULL",
(absolute_url_for("public.note", slug=slug),),
"SELECT 1 FROM webmention_queue WHERE source_url IN (?, ?) AND source_note_id IS NULL",
(absolute_url_for("public.note", slug=slug), absolute_url_for("public.article", slug=slug)),
).fetchone() is not None
@bp.route("/note/<slug>")
def note(slug: str):
"""A note's permalink page; an article's /note/ URL redirects to /article/"""
return _permalink(slug, "public.note")
@bp.route("/article/<slug>")
def article(slug: str):
"""An article's permalink page (v2.17.0); a note's /article/ URL redirects to /note/"""
return _permalink(slug, "public.article")
def _permalink(slug: str, endpoint: str):
"""
Individual note permalink page
Individual note or article permalink page
Args:
slug: URL-safe note identifier
endpoint: The route the request came in on
Returns:
Rendered note template with full content
@@ -390,6 +402,12 @@ def note(slug: str):
abort(410)
abort(404)
# Each post has one URL: /article/ for articles, /note/ for notes (v2.17.0).
# The other one redirects, so links made before a title was added or
# removed keep working.
if note_obj.endpoint != endpoint:
return redirect(url_for(note_obj.endpoint, slug=slug), code=301)
# Get media for note (v1.2.0 Phase 3)
media = get_note_media(note_obj.id)
+3 -2
View File
@@ -10,6 +10,7 @@ from pathlib import Path
from flask import Blueprint, current_app, g, jsonify, render_template, request
from starpunk.search import has_fts_table, search_notes
from starpunk.utils import post_path
logger = logging.getLogger(__name__)
@@ -108,7 +109,7 @@ def api_search():
"title": r["title"] or f"Note from {r['created_at'][:10]}",
"excerpt": r["snippet"], # Already has <mark> tags
"published_at": r["created_at"],
"url": f"/note/{r['slug']}",
"url": post_path(r["slug"], r.get("article_title")),
}
for r in results
],
@@ -176,7 +177,7 @@ def search_page():
"title": r["title"] or f"Note from {r['created_at'][:10]}",
"excerpt": Markup(safe_snippet), # Mark as safe since we've escaped it ourselves
"published_at": r["created_at"],
"url": f"/note/{r['slug']}",
"url": post_path(r["slug"], r.get("article_title")),
})
results = formatted_results
except Exception as e:
+4 -3
View File
@@ -139,9 +139,10 @@ def resolve_target_note(target_url: str) -> int | None:
# Strip query params and fragments for matching
target_path = target_parsed.path.rstrip('/')
# Check if it's a note URL pattern: /note/{slug}
if target_path.startswith('/note/'):
slug = target_path[6:] # Remove '/note/' prefix
# A note or article URL: /note/{slug} or /article/{slug} (v2.17.0).
# Either prefix finds the post, as the page redirects to the right one.
prefix, _, slug = target_path.lstrip('/').partition('/')
if prefix in ('note', 'article') and '/' not in slug:
if slug:
try:
note = get_note(slug=slug)
+23 -20
View File
@@ -98,29 +98,32 @@ def has_fts_table(db_path: Path) -> bool:
return False
def update_fts_index(conn: sqlite3.Connection, note_id: int, slug: str, content: str):
def _first_line(content: str) -> str:
"""A note's first line without heading marks (result label for untitled notes).
A hashtag ('#indieweb ...') is kept."""
line = content.split('\n', 1)[0].strip()
return re.sub(r'^#{1,6}\s+', '', line)
def update_fts_index(conn: sqlite3.Connection, note_id: int, slug: str, content: str,
title: Optional[str] = None):
"""
Update FTS index for a note (insert or replace)
Extracts title from first line of content and updates the FTS index.
Uses REPLACE to handle both new notes and updates.
Indexes the note's title (articles, v2.16.0) or, for untitled notes, its
first line. Uses REPLACE to handle both new notes and updates.
Args:
conn: SQLite database connection
note_id: Note ID (used as FTS rowid)
slug: Note slug
content: Full markdown content
content: Markdown content
title: The note's title, if it has one
Raises:
sqlite3.Error: If FTS update fails
"""
# Extract title from first line
lines = content.split('\n', 1)
title = lines[0].strip() if lines else ''
# Remove markdown heading syntax (# ## ###)
if title.startswith('#'):
title = title.lstrip('#').strip()
title = title or _first_line(content)
# Limit title length
if len(title) > 100:
@@ -170,7 +173,7 @@ def rebuild_fts_index(db_path: Path, data_dir: Path):
# Get all non-deleted notes
cursor = conn.execute(
"SELECT id, slug, file_path FROM notes WHERE deleted_at IS NULL"
"SELECT id, slug, file_path, title FROM notes WHERE deleted_at IS NULL"
)
indexed_count = 0
@@ -188,7 +191,7 @@ def rebuild_fts_index(db_path: Path, data_dir: Path):
content = note_path.read_text(encoding='utf-8')
# Update FTS index
update_fts_index(conn, row['id'], row['slug'], content)
update_fts_index(conn, row['id'], row['slug'], content, row['title'])
indexed_count += 1
except Exception as e:
@@ -327,6 +330,7 @@ def search_notes_fts5(
notes.id,
notes.slug,
notes_fts.title,
notes.title AS article_title,
notes.published,
notes.created_at,
rank AS relevance,
@@ -353,6 +357,7 @@ def search_notes_fts5(
'id': row['id'],
'slug': row['slug'],
'title': row['title'],
'article_title': row['article_title'],
'snippet': row['snippet'], # Plain string - route must escape HTML while preserving <mark> tags
'relevance': row['relevance'],
'published': bool(row['published']),
@@ -408,6 +413,7 @@ def search_notes_fallback(
id,
slug,
file_path,
title,
published,
created_at
FROM notes
@@ -446,8 +452,8 @@ def search_notes_fallback(
file_path = data_dir / row['file_path']
content = read_note_file(file_path)
# Check if query matches content (case-insensitive)
content_lower = content.lower()
# Check if query matches title or content (case-insensitive)
content_lower = f"{row['title'] or ''}\n{content}".lower()
query_lower = query.lower()
matches = query_lower in content_lower
@@ -456,16 +462,13 @@ def search_notes_fallback(
matches = any(term.lower() in content_lower for term in terms)
if matches:
# Extract title from first line
lines = content.split('\n', 1)
title = lines[0].strip() if lines else row['slug']
if title.startswith('#'):
title = title.lstrip('#').strip()
title = row['title'] or _first_line(content) or row['slug']
results.append({
'id': row['id'],
'slug': row['slug'],
'title': title,
'article_title': row['title'],
'snippet': generate_snippet(content, query),
'relevance': 0.0, # No ranking in fallback mode
'published': bool(row['published']),
+29
View File
@@ -288,6 +288,35 @@ def generate_timestamp_slug(
return f"{base_slug}-{suffix}"
TITLE_SLUG_LENGTH = 80
def generate_title_slug(title: str, existing_slugs: Set[str]) -> Optional[str]:
"""
A slug made from an article's title (v2.17.0)
"Why I Left Twitter" becomes 'why-i-left-twitter'; long titles are cut at
a word boundary, and a taken slug gets -2, -3, ...
Returns:
The slug, or None when the title has nothing usable (e.g. only emoji),
so the caller falls back to a timestamp slug.
"""
slug = sanitize_slug(title or "")
if len(slug) > TITLE_SLUG_LENGTH:
cut = slug[:TITLE_SLUG_LENGTH + 1]
slug = cut.rsplit("-", 1)[0] if "-" in cut else slug[:TITLE_SLUG_LENGTH]
slug = slug.strip("-")
if not slug:
return None
if is_reserved_slug(slug):
slug = f"{slug}-article"
try:
return make_slug_unique_with_suffix(slug, existing_slugs)
except ValueError: # 99 articles with this title
return None
def validate_and_sanitize_custom_slug(custom_slug: str, existing_slugs: Set[str]) -> tuple[bool, Optional[str], Optional[str]]:
"""
Validate and sanitize a custom slug from Micropub
+28 -10
View File
@@ -357,7 +357,9 @@ class BlueskyClient:
def _record(self, post: "Post", text: Optional[str] = None, embed: Optional[dict] = None,
anchors: List[tuple] = ()) -> dict:
if text is None:
body, anchors = plain_text_links(post.note.content, links="anchor")
# An article is posted as a teaser (compose_text), so its links aren't in the text
body, anchors = (None, []) if post.note.title else \
plain_text_links(post.note.content, links="anchor")
text = compose_text(post.note, post.permalink, post.tags, post.max_chars, body=body)
record = {"$type": self.POST, "text": text, "createdAt": self._now()}
facets = bluesky_facets(text, anchors)
@@ -368,14 +370,16 @@ class BlueskyClient:
elif post.media:
record["embed"] = {"$type": "app.bsky.embed.images",
"images": [self._image(m) for m in post.media]}
elif note_links(post.note.content):
elif not post.note.title and note_links(post.note.content):
# The note links somewhere: the card shows that page, not the note
record["embed"] = self._link_card(note_links(post.note.content)[0])
else:
# Articles always get a card for the article itself (v2.16.0)
description = article_teaser(post.note) if post.note.title else plain_text(post.note.content)
record["embed"] = {"$type": "app.bsky.embed.external", "external": {
"uri": post.permalink,
"title": post.note.title[:300],
"description": plain_text(post.note.content)[:300],
"title": post.note.label[:300],
"description": description[:300],
}}
return record
@@ -1074,8 +1078,7 @@ def get_targets() -> Dict[str, Target]:
if token:
client = _client_cache.get("threads")
if client is None or client.config_token != token:
client = ThreadsClient(token, Path(config["DATA_PATH"]) / "threads_token.json",
api=config.get("THREADS_API") or THREADS_API)
client = ThreadsClient(token, Path(config["DATA_PATH"]) / "threads_token.json")
_client_cache["threads"] = client
username = (config.get("THREADS_USERNAME") or "").lstrip("@")
targets["threads"] = Target(
@@ -1186,19 +1189,30 @@ def _hashtag(display_name: str) -> str:
return f"#{word}" if word else ""
def article_teaser(note) -> str:
"""An article's summary, or the start of its text (v2.16.0)"""
return note.summary or note.excerpt
def compose_text(note, permalink: str, tags: List[str], max_chars: int,
body: Optional[str] = None) -> str:
"""
Full note (Markdown unless `body` is given), then the permalink and
hashtags; shortened at a word boundary if too long. On short targets the
hashtags may use at most a third of the space.
An article (a note with a title) is posted as its title and teaser
instead of its full text, the usual POSSE form for articles (v2.16.0).
"""
hashtags = ""
for h in (_hashtag(t) for t in tags):
if h and len(hashtags) + len(h) + 1 <= max(max_chars // 3, 1):
hashtags = f"{hashtags} {h}".strip()
tail = f"\n\n{permalink}" + (f"\n\n{hashtags}" if hashtags else "")
body = (note.content if body is None else body).strip()
if getattr(note, "title", None):
body = f"{note.title}\n\n{article_teaser(note)}".strip()
else:
body = (note.content if body is None else body).strip()
if getattr(note, "bookmark_of", None):
# A bookmark leads with what it bookmarks (v2.9.0)
body = f"🔖 {note.bookmark_of}\n\n{body}".strip()
@@ -1216,7 +1230,10 @@ def _note_soup(markdown_text: str):
import markdown
from bs4 import BeautifulSoup
return BeautifulSoup(markdown.markdown(markdown_text, extensions=["fenced_code"]), "html.parser")
from starpunk.markdown_ext import HashtagLineExtension
html = markdown.markdown(markdown_text, extensions=["fenced_code", HashtagLineExtension()])
return BeautifulSoup(html, "html.parser")
def _clean_url(url: str) -> str:
@@ -1507,11 +1524,12 @@ def _reconcile(row, target: Target) -> tuple:
site = current_app.config["SITE_URL"].rstrip("/")
post = Post(
note=note,
permalink=f"{site}/note/{note.slug}",
permalink=note.url,
tags=[t["display_name"] for t in get_note_tags(note.id, entered_order=True)],
max_chars=target.max_chars,
# Articles are posted as a teaser without images (v2.16.0)
media=_media_files(note.id, target.max_media, note.content)
if note.kind == "note" else [],
if note.kind == "note" and not note.title else [],
kind=note.kind,
target_url=note.reacts_to,
target_title=_target_title(note.reacts_to),
+31
View File
@@ -480,6 +480,27 @@ def validate_note_path(file_path: Path, data_dir: Path) -> bool:
# Atomic File Operations
def find_trashed_file(data_dir: Path, file_path: str) -> Optional[Path]:
"""
Where delete_note_file put a note's file: .trash/<year>/<month>/<name>
Args:
data_dir: Data directory
file_path: The note's file_path as stored in the database
Returns:
Path of the trashed file, or None if it can't be found
"""
parts = Path(file_path).parts
name = Path(file_path).name
candidates = []
if "notes" in parts and len(parts) > parts.index("notes") + 2:
i = parts.index("notes")
candidates.append(data_dir / TRASH_DIR_NAME / parts[i + 1] / parts[i + 2] / name)
candidates += sorted((data_dir / TRASH_DIR_NAME).glob(f"*/*/{name}"))
return next((c for c in candidates if c.exists()), None)
def write_note_file(file_path: Path, content: str) -> None:
"""
Write note content to file atomically
@@ -695,6 +716,16 @@ def absolute_url_for(endpoint: str, **values) -> str:
return current_app.config["SITE_URL"].rstrip("/") + url_for(endpoint, **values)
def post_path(slug: str, title: Optional[str] = None) -> str:
"""A post's URL path: /article/<slug> when it has a title, else /note/<slug> (v2.17.0)"""
return f"/{'article' if title else 'note'}/{slug}"
def post_url(slug: str, title: Optional[str] = None) -> str:
"""A post's absolute URL (see post_path)"""
return absolute_url_for("public.article" if title else "public.note", slug=slug)
def iso_utc(value) -> str:
"""
Format a timestamp as RFC 3339 UTC for dt-* and Micropub (v2.8.0)
+8 -5
View File
@@ -112,7 +112,8 @@ def get_webmentions_for_note(note_id: int) -> Dict[str, List[Dict[str, Any]]]:
def response_counts(note_ids: List[int]) -> Dict[int, Dict[str, int]]:
"""
Likes, reposts and replies per note, for lists of notes (v2.13.4).
Likes, reposts, replies and quotes per note, for lists of notes
(v2.13.4; quotes v2.14.2).
Shown responses (valid and approved) plus the counts silos give without
names (Threads; people who opted out of backfeed) on synced crossposts.
@@ -126,21 +127,22 @@ def response_counts(note_ids: List[int]) -> Dict[int, Dict[str, int]]:
def add(note_id, key, n):
if n:
counts.setdefault(note_id, {'likes': 0, 'reposts': 0, 'replies': 0})[key] += n
counts.setdefault(note_id, {'likes': 0, 'reposts': 0, 'replies': 0, 'quotes': 0})[key] += n
for row in db.execute(
f"""
SELECT target_note_id, mention_type, COUNT(*) FROM webmentions
WHERE target_note_id IN ({marks}) AND validation_status = 'valid'
AND moderation_status = 'approved' AND mention_type IN ('like', 'repost', 'reply')
AND moderation_status = 'approved' AND mention_type IN ('like', 'repost', 'reply', 'quote')
GROUP BY target_note_id, mention_type
""",
note_ids,
):
add(row[0], {'like': 'likes', 'repost': 'reposts', 'reply': 'replies'}[row[1]], row[2])
add(row[0], {'like': 'likes', 'repost': 'reposts', 'reply': 'replies', 'quote': 'quotes'}[row[1]], row[2])
for row in db.execute(
f"""
SELECT note_id, SUM(COALESCE(likes_count, 0)), SUM(COALESCE(reposts_count, 0))
SELECT note_id, SUM(COALESCE(likes_count, 0)), SUM(COALESCE(reposts_count, 0)),
SUM(COALESCE(quotes_count, 0))
FROM syndications WHERE note_id IN ({marks}) AND state = 'synced'
GROUP BY note_id
""",
@@ -148,6 +150,7 @@ def response_counts(note_ids: List[int]) -> Dict[int, Dict[str, int]]:
):
add(row[0], 'likes', row[1])
add(row[0], 'reposts', row[2])
add(row[0], 'quotes', row[3])
return counts
-27
View File
@@ -1,27 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>IndieLogin Test Form</title>
</head>
<body>
<h1>IndieLogin Test Form</h1>
<p>This is the exact form from IndieLogin.com API docs</p>
<form action="https://indielogin.com/authorize" method="get">
<label for="url">Web Address:</label>
<input id="url" type="text" name="me" placeholder="yourdomain.com" value="https://thesatelliteoflove.com" />
<p><button type="submit">Sign In</button></p>
<input type="hidden" name="client_id" value="https://starpunk.thesatelliteoflove.com/" />
<input type="hidden" name="redirect_uri" value="https://starpunk.thesatelliteoflove.com/auth/callback" />
<input type="hidden" name="state" value="TESTSTATE123456789" />
<input type="hidden" name="code_challenge" value="E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM" />
<input type="hidden" name="code_challenge_method" value="S256" />
</form>
<hr>
<p><strong>Note:</strong> This uses a fixed code_challenge for testing. In production, this should be generated fresh each time.</p>
<p><strong>Form will submit to:</strong> https://indielogin.com/authorize</p>
</body>
</html>
View File
Whitespace-only changes.
+5
View File
@@ -14,6 +14,11 @@
<strong>{{ auth_request.client_id }}</strong> wants to sign in as
<strong>{{ me }}</strong>.
</p>
{% if auth_request.resource %}
<p>This is an AI assistant asking to use your site through MCP
(<code>{{ auth_request.resource }}</code>). It can read your notes and drafts,
and do whatever you allow below.</p>
{% endif %}
<p><small>After approval you will be sent to {{ auth_request.redirect_uri }}</small></p>
<form action="{{ url_for('indieauth.approve') }}" method="POST" class="login-form"><input type="hidden" name="csrf_token" value="{{ csrf_token() }}">
+2 -2
View File
@@ -51,7 +51,7 @@
<tr>
<td class="note-content-preview">
<div class="note-excerpt">
{{ note.content[:100] }}{% if note.content|length > 100 %}...{% endif %}
{% if note.title %}<strong>{{ note.title }}</strong>{% else %}{{ note.content[:100] }}{% if note.content|length > 100 %}...{% endif %}{% endif %}
</div>
<small class="note-slug">{{ note.slug }}</small>
</td>
@@ -67,7 +67,7 @@
</td>
<td class="note-actions">
{% if note.published %}
<a href="{{ url_for('public.note', slug=note.slug) }}" class="button button-small" target="_blank">
<a href="{{ note.url }}" class="button button-small" target="_blank">
View
</a>
{% endif %}
+13 -6
View File
@@ -11,6 +11,12 @@
</p>
<form action="{{ url_for('admin.update_note_submit', note_id=note.id) }}" method="POST" class="note-form"><input type="hidden" name="csrf_token" value="{{ csrf_token() }}">
<div class="form-group">
<label for="title">Title (optional)</label>
<input type="text" id="title" name="title" value="{{ note.title or '' }}" maxlength="200"
placeholder="Leave blank for a note; a title makes it an article">
</div>
<div class="form-group">
{% if note.reacts_to %}
<p class="note-meta">{{ {'like': '★ Like of', 'repost': '🔁 Repost of', 'bookmark': '🔖 Bookmark of'}[note.kind] }} <a href="{{ note.reacts_to }}">{{ note.reacts_to }}</a></p>
@@ -20,12 +26,18 @@
id="content"
name="content"
rows="{{ 6 if note.reacts_to else 20 }}"
{% if not note.reacts_to %}required{% endif %}
autofocus
>{{ note.content }}</textarea>
<small>Use Markdown syntax for formatting</small>
</div>
<div class="form-group">
<label for="summary">Summary (optional)</label>
<textarea id="summary" name="summary" rows="2"
placeholder="A sentence or two for the homepage, feeds and crossposts">{{ note.summary or '' }}</textarea>
<small>Articles only. Leave blank to use the start of the text.</small>
</div>
<div class="form-group">
<label for="slug">Slug (permanent)</label>
<input type="text"
@@ -116,8 +128,3 @@
</div>
{% endblock %}
{% block head %}
{{ super() }}
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
<script src="{{ url_for('static', filename='js/preview.js') }}"></script>
{% endblock %}
+13 -3
View File
@@ -7,6 +7,12 @@
<h2>Create New Note</h2>
<form action="{{ url_for('admin.create_note_submit') }}" method="POST" enctype="multipart/form-data" class="note-form"><input type="hidden" name="csrf_token" value="{{ csrf_token() }}">
<div class="form-group">
<label for="title">Title (optional)</label>
<input type="text" id="title" name="title" value="" maxlength="200"
placeholder="Leave blank for a note; a title makes it an article">
</div>
<div class="form-group">
<label for="content">Content (Markdown)</label>
<textarea
@@ -14,12 +20,18 @@
name="content"
rows="20"
placeholder="Write your note in markdown..."
required
autofocus
></textarea>
<small>Use Markdown syntax for formatting</small>
</div>
<div class="form-group">
<label for="summary">Summary (optional)</label>
<textarea id="summary" name="summary" rows="2"
placeholder="A sentence or two for the homepage, feeds and crossposts"></textarea>
<small>Articles only. Leave blank to use the start of the text.</small>
</div>
<div class="form-group">
<label for="custom_slug">Custom Slug (optional)</label>
<input type="text"
@@ -88,8 +100,6 @@
{% block head %}
{{ super() }}
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
<script src="{{ url_for('static', filename='js/preview.js') }}"></script>
<style>
.media-preview {
+2 -2
View File
@@ -5,7 +5,7 @@
{% block admin_content %}
<div class="tokens-admin">
<h2>Connected Apps</h2>
<p>Micropub apps you have approved. Revoke any you no longer use.</p>
<p>Micropub apps and AI assistants (MCP) you have approved. Revoke any you no longer use.</p>
{% if tokens %}
<div class="table-scroll">
@@ -23,7 +23,7 @@
<tbody>
{% for t in tokens %}
<tr>
<td>{{ t.client_id }}</td>
<td>{{ t.client_id }}{% if t.resource %} <small>(MCP)</small>{% endif %}</td>
<td>{{ t.scope }}</td>
<td>{{ t.created_at }}</td>
<td>{{ t.last_used_at or "never" }}</td>
View File
Whitespace-only changes.
+9 -9
View File
@@ -3,17 +3,17 @@
{% from "partials/reaction.html" import reaction %}
{% import "partials/responses.html" as responses with context %}
{% block title %}{% if note.has_title %}{{ note.title }}{% elif note.excerpt.strip() %}{{ note.excerpt|truncate(60) }}{% elif note.repost_of %}Repost{% elif note.like_of %}Like{% elif note.bookmark_of %}Bookmark{% elif note.in_reply_to %}Reply{% else %}Photo{% endif %} · {{ config.SITE_NAME }}{% endblock %}
{% block title %}{% if note.title %}{{ note.title }}{% elif note.excerpt.strip() %}{{ note.excerpt|truncate(60) }}{% elif note.repost_of %}Repost{% elif note.like_of %}Like{% elif note.bookmark_of %}Bookmark{% elif note.in_reply_to %}Reply{% else %}Photo{% endif %} · {{ config.SITE_NAME }}{% endblock %}
{% block content %}
<article class="h-entry">
{# Notes starting with a '# Heading' have a title (Q22; Note.has_title) #}
{% set has_explicit_title = note.has_title %}
{# p-name only if note has explicit title (per Q22) #}
{% if has_explicit_title %}
{# Titled notes are articles: p-name only then, so notes get no implied name (ADR-076) #}
{% if note.title %}
<h1 class="p-name">{{ note.title }}</h1>
{% endif %}
{% if note.summary %}
<p class="p-summary">{{ note.summary }}</p>
{% endif %}
{# Reply context (v1.6.0 Phase 4) - displayed if this is a reply post #}
{% if note.in_reply_to %}
@@ -49,12 +49,12 @@
{# e-content: note content BELOW media (per ADR-057) #}
<div class="e-content">
{{ note.body_html|safe }}
{{ note.html|safe }}
</div>
<footer class="note-meta">
{# u-url and u-uid same for notes (per Q23) #}
<a class="u-url u-uid" href="{{ absolute_url_for('public.note', slug=note.slug) }}"><time class="dt-published" datetime="{{ note.created_at|iso_utc }}">{{ note.created_at.strftime('%B %-d, %Y · %-I:%M %p') }}</time></a>
<a class="u-url u-uid" href="{{ note.url }}"><time class="dt-published" datetime="{{ note.created_at|iso_utc }}">{{ note.created_at.strftime('%B %-d, %Y · %-I:%M %p') }}</time></a>
{% if note.updated_at and note.updated_at != note.created_at %}
<span class="updated">Updated <time class="dt-updated" datetime="{{ note.updated_at|iso_utc }}">{{ note.updated_at.strftime('%b %-d, %Y') }}</time></span>
{% endif %}
@@ -79,7 +79,7 @@
</footer>
<div id="responses"></div>
{{ responses.reactions(likes, reposts, replies, bookmarks, syndications, absolute_url_for('public.note', slug=note.slug)) }}
{{ responses.reactions(likes, reposts, replies, bookmarks, syndications, note.url, quotes) }}
<nav class="note-nav">
<a href="/">← All notes</a>
+15 -12
View File
@@ -4,10 +4,9 @@
{% from "partials/responses.html" import list_counts %}
{% macro note_preview(note, author) %}
<article class="h-entry note-preview">
{# Notes starting with a '# Heading' have a title (Q22; Note.has_title) #}
{% set has_explicit_title = note.has_title %}
{% if has_explicit_title %}
<h2 class="p-name"><a href="{{ absolute_url_for('public.note', slug=note.slug) }}">{{ note.title }}</a></h2>
{# Titled notes are articles (ADR-076) #}
{% if note.title %}
<h2 class="p-name"><a href="{{ note.url }}">{{ note.title }}</a></h2>
{% endif %}
{% if note.in_reply_to %}
@@ -16,15 +15,19 @@
{{ reaction(note) }}
{{ display_media(note.media, note.excerpt|truncate(150)) }}
{% if has_explicit_title %}
{# Titled notes are articles: show a summary and link through #}
{% if note.title %}
{# Articles: title, summary and a link through; images stay on the article page (v2.16.0).
The photos stay in the markup, unseen, so parsers read the same post type here as on the page. #}
{% for item in note.media or [] %}<data class="u-photo" value="{{ url_for('public.media_file', path=item.path) }}"></data>{% endfor %}
{% set summary = note.summary or note.excerpt %}
{% if summary.strip() %}
<div class="p-summary">
<p>{{ note.excerpt }}</p>
<p>{{ summary }}</p>
</div>
<p class="read-more"><a href="{{ absolute_url_for('public.note', slug=note.slug) }}">Read more →</a></p>
{% endif %}
<p class="read-more"><a href="{{ note.url }}">Read more →</a></p>
{% else %}
{{ display_media(note.media, note.excerpt|truncate(150)) }}
{# Always present, even empty: without it a text-free photo post gets an implied name (mf2) #}
<div class="e-content">
{{ note.html|safe }}
@@ -32,13 +35,13 @@
{% endif %}
<footer class="note-meta">
<a class="u-url u-uid" href="{{ absolute_url_for('public.note', slug=note.slug) }}"><time class="dt-published" datetime="{{ note.created_at|iso_utc }}">{{ note.created_at.strftime('%b %-d, %Y') }}</time></a>
<a class="u-url u-uid" href="{{ note.url }}"><time class="dt-published" datetime="{{ note.created_at|iso_utc }}">{{ note.created_at.strftime('%b %-d, %Y') }}</time></a>
{% if note.tags %}
<span class="note-tags">
{% for tag in note.tags %}<a class="p-category" rel="tag" href="{{ url_for('public.tag', tag=tag.name) }}">{{ tag.display_name }}</a>{% endfor %}
</span>
{% endif %}
{{ list_counts(note.response_counts if note.response_counts is defined else None, absolute_url_for('public.note', slug=note.slug)) }}
{{ list_counts(note.response_counts if note.response_counts is defined else None, note.url) }}
{% if author %}
{# Single-author site: keep the h-card for parsers, hide it from readers #}
<span class="p-author h-card visually-hidden"><a class="p-name u-url" href="{{ author.url or author.me }}">{{ author.name or author.url or author.me }}</a></span>
+8 -4
View File
@@ -64,6 +64,7 @@
'like': '<svg viewBox="0 0 24 24" fill="currentColor" aria-hidden="true"><path d="M12 21.35l-1.45-1.32C5.4 15.36 2 12.28 2 8.5 2 5.42 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.09C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.42 22 8.5c0 3.78-3.4 6.86-8.55 11.54L12 21.35z"/></svg>',
'repost': '<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M17 1l4 4-4 4"/><path d="M3 11V9a4 4 0 0 1 4-4h14"/><path d="M7 23l-4-4 4-4"/><path d="M21 13v2a4 4 0 0 1-4 4H3"/></svg>',
'reply': '<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M21 11.5a8.4 8.4 0 0 1-9 8.4 8.6 8.6 0 0 1-3.9-.9L3 21l1.9-5.1A8.4 8.4 0 0 1 12 3.1a8.4 8.4 0 0 1 9 8.4z"/></svg>',
'quote': '<svg viewBox="0 0 24 24" fill="currentColor" aria-hidden="true"><path d="M7.2 5C4.3 6.4 3 8.9 3 12.3V19h7v-7H6.3c.1-2.2 1-3.7 2.9-4.6L7.2 5zm10 0c-2.9 1.4-4.2 3.9-4.2 7.3V19h7v-7h-3.7c.1-2.2 1-3.7 2.9-4.6L17.2 5z"/></svg>',
'bookmark': '<svg viewBox="0 0 24 24" fill="currentColor" aria-hidden="true"><path d="M6 2h12a1 1 0 0 1 1 1v19l-7-4-7 4V3a1 1 0 0 1 1-1z"/></svg>',
} %}
{% set VERBS = {'like': 'Like', 'repost': 'Repost', 'reply': 'Reply'} %}
@@ -95,19 +96,22 @@
{% endif %}
{%- endmacro %}
{% macro reactions(likes, reposts, replies, bookmarks, syndications, permalink) %}
{% set anon_likes, anon_reposts = [], [] %}
{% macro reactions(likes, reposts, replies, bookmarks, syndications, permalink, quotes=[]) %}
{% set anon_likes, anon_reposts, anon_quotes = [], [], [] %}
{% for s in syndications or [] %}
{% if s.likes_count %}{% set _ = anon_likes.append((s.name, s.likes_count)) %}{% endif %}
{% if s.reposts_count %}{% set _ = anon_reposts.append((s.name, s.reposts_count)) %}{% endif %}
{% if s.quotes_count %}{% set _ = anon_quotes.append((s.name, s.quotes_count)) %}{% endif %}
{% endfor %}
{% set copies = (syndications or [])|selectattr('remote_url')|list %}
{% if copies or likes or reposts or replies or bookmarks or anon_likes or anon_reposts %}
{% if copies or likes or reposts or replies or quotes or bookmarks or anon_likes or anon_reposts or anon_quotes %}
<div class="response-counts">
{{ reaction('like', likes or [], 'u-like', anon_likes, 'like', 'likes', copies, permalink) }}
{{ reaction('repost', reposts or [], 'u-repost', anon_reposts, 'repost', 'reposts', copies, permalink) }}
{# Replies are listed in full below; here just the count and where to reply #}
{{ reaction('reply', replies or [], '', [], 'reply', 'replies', copies, permalink, people=False) }}
{# Quotes: named ones are listed below; the card shows those without names (v2.14.2) #}
{{ reaction('quote', quotes or [], '', anon_quotes, 'quote', 'quotes', people=False) }}
{{ reaction('bookmark', bookmarks or [], 'u-bookmark', [], 'bookmark', 'bookmarks') }}
</div>
{% endif %}
@@ -118,7 +122,7 @@
{% macro list_counts(counts, permalink) %}
{% if counts %}
<a class="list-counts" href="{{ permalink }}#responses">
{%- for key, kind, one, many in [('likes', 'like', 'like', 'likes'), ('reposts', 'repost', 'repost', 'reposts'), ('replies', 'reply', 'reply', 'replies')] if counts[key] -%}
{%- for key, kind, one, many in [('likes', 'like', 'like', 'likes'), ('reposts', 'repost', 'repost', 'reposts'), ('replies', 'reply', 'reply', 'replies'), ('quotes', 'quote', 'quote', 'quotes')] if counts.get(key) -%}
<span class="list-count list-count-{{ kind }}" title="{{ counts[key] }} {{ one if counts[key] == 1 else many }}">{{ ICONS[kind]|safe }}{{ counts[key] }}<span class="visually-hidden"> {{ one if counts[key] == 1 else many }}</span></span>
{%- endfor -%}
</a>
+275
View File
@@ -0,0 +1,275 @@
"""
Articles: titles and summaries stored apart from the text (v2.16.0, ADR-076).
Feeds give only articles a title and never repeat it in the content; the
homepage and tag pages show an article as title, summary and "Read more"
without its images; the admin editor has Title and Summary fields.
"""
import json
import xml.etree.ElementTree as ET
import httpx
import mf2py
from starpunk.auth import create_session
from starpunk.notes import create_note, get_note
from tests.test_micropub_v240 import SITE, app, client, h, jpeg, source # noqa: F401
from tests.test_micropub_v265 import upload
ATOM = {"a": "http://www.w3.org/2005/Atom"}
def micropub(client, h, **props):
response = client.post("/micropub", json={"type": ["h-entry"], "properties": props}, headers=h)
assert response.status_code == 201, response.get_json()
return response.headers["Location"]
def make_both(app):
with app.app_context():
article = create_note(content="The **body**.", title="An Article", summary="The gist.",
published=True, tags=["essay"])
note = create_note(content="# Just a heading\n\nin a note", published=True, tags=["essay"])
return article, note
class TestFeeds:
def test_rss_title_only_for_articles(self, app, client):
article, note = make_both(app)
items = {i.find("link").text: i for i in ET.fromstring(client.get("/feed.rss").data).iter("item")}
a, n = items[f"{SITE}/article/{article.slug}"], items[f"{SITE}/note/{note.slug}"]
assert a.find("title").text == "An Article"
assert "An Article" not in a.find("description").text # not repeated in the body
assert n.find("title") is None
assert n.find("description") is not None
def test_atom_empty_title_and_summary(self, app, client):
article, note = make_both(app)
entries = {e.find("a:id", ATOM).text: e
for e in ET.fromstring(client.get("/feed.atom").data).findall("a:entry", ATOM)}
a, n = entries[f"{SITE}/article/{article.slug}"], entries[f"{SITE}/note/{note.slug}"]
assert a.find("a:title", ATOM).text == "An Article"
assert a.find("a:summary", ATOM).text == "The gist."
assert "An Article" not in a.find("a:content", ATOM).text
assert n.find("a:title", ATOM) is not None and not n.find("a:title", ATOM).text
assert n.find("a:summary", ATOM) is None
def test_json_feed(self, app, client):
article, note = make_both(app)
items = {i["url"]: i for i in json.loads(client.get("/feed.json").data)["items"]}
a, n = items[f"{SITE}/article/{article.slug}"], items[f"{SITE}/note/{note.slug}"]
assert (a["title"], a["summary"]) == ("An Article", "The gist.")
assert "An Article" not in a["content_html"]
assert "title" not in n and "summary" not in n
assert "<h1>Just a heading</h1>" in n["content_html"]
class TestPages:
def test_article_page(self, app, client):
article, _ = make_both(app)
(entry,) = [i for i in mf2py.parse(doc=client.get(f"/article/{article.slug}").data.decode(),
url=f"{SITE}/article/{article.slug}")["items"]
if "h-entry" in i["type"]]
props = entry["properties"]
assert props["name"] == ["An Article"]
assert props["summary"] == ["The gist."]
assert not props["content"][0]["value"].startswith("An Article")
def test_homepage_and_tag_page(self, app, client, h):
photo = upload(client, h)
url = micropub(client, h, name=["Trip"], content=["Day one of the trip."], photo=[photo],
category=["essay"])
micropub(client, h, content=["A photo note"], photo=[upload(client, h, "blue")], category=["essay"])
with app.app_context():
slug = url.rsplit("/", 1)[1]
article = get_note(slug=slug)
for path in ("/", "/tag/essay"):
html = client.get(path).data.decode()
start = html.index(f'href="{url}"')
section = html[html.rindex("<article", 0, start):html.index("</article>", start)]
assert "Trip" in section and "Day one of the trip." in section and "Read more" in section
assert "<img" not in section and "e-content" not in section
assert 'class="u-photo"' in section # parsers still see a photo post
assert html.count("<img") >= 1 # the photo note still shows its image
assert article.title == "Trip"
def test_preview_uses_summary_over_excerpt(self, app, client):
make_both(app)
html = client.get("/").data.decode()
assert "The gist." in html and "The <strong>body</strong>." not in html
class TestAdmin:
def login(self, app, client):
with app.test_request_context():
client.set_cookie("starpunk_session", create_session(app.config["ADMIN_ME"]))
def test_create_and_edit_article(self, app, client):
self.login(app, client)
response = client.post("/admin/new", data={
"title": "From the editor", "summary": "Short.", "content": "Body", "published": "on"})
assert response.status_code == 302
with app.app_context():
from starpunk.notes import list_notes
(note,) = list_notes()
assert (note.title, note.summary, note.content) == ("From the editor", "Short.", "Body")
form = client.get(f"/admin/edit/{note.id}").data.decode()
assert 'value="From the editor"' in form and ">Short.</textarea>" in form
client.post(f"/admin/edit/{note.id}", data={"title": "", "summary": "", "content": "Body",
"published": "on"})
with app.app_context():
note = get_note(id=note.id)
assert (note.title, note.summary) == (None, None)
def test_title_only_article(self, app, client):
self.login(app, client)
client.post("/admin/new", data={"title": "Only a title", "content": "", "published": "on"})
with app.app_context():
from starpunk.notes import list_notes
(note,) = list_notes()
assert note.title == "Only a title" and note.content == ""
class TestInlineImages:
"""Articles posted with images in their text (v2.16.0)"""
def remote_host(self, monkeypatch, ok=("/a.jpg",)):
fetched = []
def serve(request): # the fetcher connects to the pinned address, so match on path
fetched.append(request.url.path)
if request.url.path in ok:
return httpx.Response(200, content=jpeg("green"))
return httpx.Response(404)
monkeypatch.setattr("starpunk.webmention_ssrf.TRANSPORT", httpx.MockTransport(serve))
monkeypatch.setattr("starpunk.webmention_ssrf.socket.getaddrinfo",
lambda *a, **k: [(2, 1, 6, "", ("93.184.216.34", 0))])
return fetched
def test_html_is_kept_over_text_fallback(self, app, client, h, monkeypatch):
self.remote_host(monkeypatch)
html = '<p>Intro <a href="https://x.example">link</a></p><img src="https://cdn.example/a.jpg" alt="A">'
url = micropub(client, h, name=["T"], content=[{"html": html, "text": "Intro link"}])
(content,) = source(client, h, url)["properties"]["content"]
assert "html" in content and 'href="https://x.example"' in content["html"]
assert "<img" in content["html"]
def test_remote_images_are_copied(self, app, client, h, monkeypatch):
fetched = self.remote_host(monkeypatch)
url = micropub(client, h, name=["T"], content=[
"Intro\n\n![A](https://cdn.example/a.jpg)\n\n![B](https://cdn.example/gone.jpg)\n\n"
"Again ![A](https://cdn.example/a.jpg)"])
with app.app_context():
note = get_note(slug=url.rsplit("/", 1)[1])
assert fetched.count("/a.jpg") == 1 # each image once
assert "https://cdn.example/a.jpg" not in note.content
assert note.content.count(f"]({SITE}/media/") == 2
assert "https://cdn.example/gone.jpg" in note.content # couldn't fetch: left as is
assert client.get(note.content.split(f"]({SITE}")[1].split(")")[0]).status_code == 200
def test_html_images_copied_and_rendered_cleanly(self, app, client, h, monkeypatch):
self.remote_host(monkeypatch)
url = micropub(client, h, name=["T"], content=[{"html":
'<p>Intro</p><img src="https://cdn.example/a.jpg" alt="A"><p>More</p><script>x()</script>'}])
with app.app_context():
note = get_note(slug=url.rsplit("/", 1)[1])
assert note.content_format == "html"
assert note.html.startswith("<p>Intro</p><img") and f'src="{SITE}/media/' in note.html
assert "<br" not in note.html and "<p></p>" not in note.html and "script" not in note.html
def test_own_images_not_fetched(self, app, client, h, monkeypatch):
fetched = self.remote_host(monkeypatch)
micropub(client, h, content=[f"![A]({SITE}/media/2026/11/x.jpg)"])
assert fetched == []
def test_update_copies_new_images(self, app, client, h, monkeypatch):
self.remote_host(monkeypatch)
url = micropub(client, h, name=["T"], content=["Before"])
client.post("/micropub", json={"action": "update", "url": url,
"replace": {"content": ["![A](https://cdn.example/a.jpg)"]}}, headers=h)
with app.app_context():
assert f"]({SITE}/media/" in get_note(slug=url.rsplit("/", 1)[1]).content
class TestArticleUrls:
"""Articles live at /article/<title-slug>, notes at /note/<slug> (v2.17.0)"""
def test_micropub_article_gets_article_url_from_title(self, app, client, h):
url = micropub(client, h, name=["Why I Left Twitter!"], content=["Long story."])
assert url == f"{SITE}/article/why-i-left-twitter"
assert source(client, h, url)["properties"]["url"] == [url]
assert client.get("/article/why-i-left-twitter").status_code == 200
def test_note_keeps_note_url_and_timestamp_slug(self, app, client, h):
url = micropub(client, h, content=["Just a note"])
assert url.startswith(f"{SITE}/note/") and url.rsplit("/", 1)[1][:8].isdigit()
def test_wrong_prefix_redirects(self, app, client, h):
article = micropub(client, h, name=["Moved"], content=["Body"])
note = micropub(client, h, content=["Plain"])
slug, note_slug = article.rsplit("/", 1)[1], note.rsplit("/", 1)[1]
response = client.get(f"/note/{slug}")
assert (response.status_code, response.location) == (301, f"/article/{slug}")
response = client.get(f"/article/{note_slug}")
assert (response.status_code, response.location) == (301, f"/note/{note_slug}")
assert client.get("/article/no-such-post").status_code == 404
def test_micropub_accepts_either_url(self, app, client, h):
url = micropub(client, h, name=["Either"], content=["Body"])
old_style = url.replace("/article/", "/note/")
response = client.post("/micropub", json={"action": "update", "url": old_style,
"replace": {"summary": ["S"]}}, headers=h)
assert response.status_code == 204
assert source(client, h, url)["properties"]["summary"] == ["S"]
def test_title_slugs(self, app):
with app.test_request_context():
def slug(title, **kw):
return create_note(content="Body", title=title, published=True, **kw).slug
assert slug("Café Culture") == "cafe-culture"
assert slug("Café Culture") == "cafe-culture-2"
assert slug("Search") == "search-article" # reserved
assert slug("Mine", custom_slug="chosen") == "chosen" # mp-slug wins
assert slug("🎉🎉").isdigit() # nothing usable: timestamp
long = slug("word " * 40)
assert len(long) <= 80 and long.endswith("word") and "--" not in long
def test_update_that_adds_or_removes_title_returns_new_url(self, app, client, h):
note = micropub(client, h, content=["Starts as a note"])
slug = note.rsplit("/", 1)[1]
response = client.post("/micropub", json={"action": "update", "url": note,
"replace": {"name": ["Now an Article"]}}, headers=h)
assert (response.status_code, response.headers["Location"]) == (201, f"{SITE}/article/{slug}")
response = client.post("/micropub", json={"action": "update", "url": f"{SITE}/article/{slug}",
"replace": {"content": ["Edited"]}}, headers=h)
assert response.status_code == 204 # URL unchanged
response = client.post("/micropub", json={"action": "update", "url": f"{SITE}/article/{slug}",
"delete": ["name"]}, headers=h)
assert (response.status_code, response.headers["Location"]) == (201, f"{SITE}/note/{slug}")
def test_deleted_article_is_gone(self, app, client, h):
url = micropub(client, h, name=["Short-lived"], content=["Body"])
assert client.post("/micropub", data={"action": "delete", "url": url}, headers=h).status_code == 204
assert client.get("/article/short-lived").status_code == 410
def test_webmention_target_and_links(self, app, client):
article, note = make_both(app)
from starpunk.routes.webmention import resolve_target_note
with app.test_request_context():
assert resolve_target_note(f"{SITE}/article/{article.slug}") == article.id
assert resolve_target_note(f"{SITE}/note/{article.slug}") == article.id
assert resolve_target_note(f"{SITE}/article/{article.slug}/x") is None
html = client.get("/").data.decode()
assert f'href="{SITE}/article/{article.slug}"' in html
assert f'href="{SITE}/note/{note.slug}"' in html
assert f"/note/{article.slug}" not in html
def test_search_links_to_article(self, app, client):
article, _ = make_both(app)
results = client.get("/api/search?q=body").get_json()["results"]
assert [r["url"] for r in results if r["slug"] == article.slug] == [f"/article/{article.slug}"]
+18
View File
@@ -639,3 +639,21 @@ def test_home_page_shows_counts(app, client):
assert 'title="3 likes"' in page and 'title="2 reposts"' in page and 'title="1 reply"' in page
assert f"/note/{quiet.slug}#responses" not in page
assert 'id="responses"' in app.test_client().get(f"/note/{note.slug}").get_data(as_text=True)
def test_quote_counts_include_anonymous_ones(app, client):
"""v2.14.2: quotes have a count, including those without names (Threads, opted out)"""
note, sid = crossposted(app)
client.harvest = Harvest([Response(kind="quote", source_url="https://bsky.app/profile/q/post/1",
remote_id="at://q/1", author_name="Quoter",
content_html="<p>Look</p>")])
run(app)
with app.app_context():
get_db(app).execute("UPDATE syndications SET quotes_count = 2 WHERE id = ?", (sid,))
get_db(app).commit()
page = app.test_client().get(f"/note/{note.slug}").get_data(as_text=True)
quote = page.split('response-count-quote')[1].split('</span>\n</span>')[0]
assert '<span class="response-count-n">3</span>' in quote and "2 on GoToSocial" in quote
assert "Quoter" in page, "the named quote is listed under Responses"
home = app.test_client().get("/").get_data(as_text=True)
assert 'title="3 quotes"' in home
+15 -29
View File
@@ -55,7 +55,8 @@ def sample_notes(app):
notes = []
for i in range(5):
note = create_note(
content=f"# Test Note {i}\n\nThis is test content for note {i}.",
content=f"This is test content for note {i}.",
title=f"Test Note {i}",
published=True,
)
notes.append(note)
@@ -141,7 +142,8 @@ class TestGenerateFeed:
import time
for i in range(3):
create_note(
content=f"# Note {i}\n\nContent {i}.",
content=f"Content {i}.",
title=f"Note {i}",
published=True,
)
time.sleep(0.01) # Ensure distinct timestamps
@@ -342,41 +344,25 @@ class TestFormatRFC822Date:
class TestGetNoteTitle:
"""Test get_note_title() function"""
def test_get_note_title_with_heading(self, app):
"""Test title extraction from note with heading"""
def test_get_note_title_article(self, app):
"""An article's item title is its title"""
with app.app_context():
note = create_note(content="# My First Note\n\nContent here.", published=True)
title = get_note_title(note)
assert title == "My First Note"
note = create_note(content="Content here.", title="My First Note", published=True)
assert get_note_title(note) == "My First Note"
def test_get_note_title_without_heading(self, app):
"""Test title extraction from note without heading"""
def test_get_note_title_untitled_note(self, app):
"""Untitled notes have no item title (v2.16.0, ADR-076)"""
with app.app_context():
note = create_note(content="Just some content without heading.", published=True)
title = get_note_title(note)
# Should use first line (Note.title handles this)
assert len(title) > 0
assert "Just some content" in title
assert get_note_title(note) is None
note = create_note(content="# A heading in the body\n\nis not a title", published=True)
assert get_note_title(note) is None
def test_get_note_title_truncates_long_titles(self, app):
"""Test title truncation for long titles"""
with app.app_context():
long_title = "A" * 150
note = create_note(content=f"# {long_title}\n\nContent.", published=True)
title = get_note_title(note)
# Should truncate to reasonable length
assert len(title) <= 103 # 100 chars + "..."
def test_get_note_title_minimal_content(self, app):
"""Test title extraction with minimal content"""
with app.app_context():
note = create_note(content="x", published=True)
title = get_note_title(note)
# Should extract something (single character or slug)
assert len(title) > 0
note = create_note(content="Content.", title="A" * 150, published=True)
assert len(get_note_title(note)) <= 103 # 100 chars + "..."
class TestCleanHTMLForRSS:
+4 -4
View File
@@ -49,7 +49,7 @@ def sample_notes(app):
notes = []
for i in range(5):
note = create_note(
content=f"# Test Note {i}\n\nThis is test content for note {i}.",
title=f"Test Note {i}", content=f"This is test content for note {i}.",
published=True,
)
notes.append(note)
@@ -138,7 +138,7 @@ class TestGenerateAtom:
# Create notes with distinct timestamps
for i in range(3):
create_note(
content=f"# Note {i}\n\nContent {i}.",
title=f"Note {i}", content=f"Content {i}.",
published=True,
)
time.sleep(0.01)
@@ -216,7 +216,7 @@ class TestGenerateAtom:
"""Test ATOM feed includes HTML content properly escaped"""
with app.app_context():
note = create_note(
content="# Test\n\nThis is **bold** and *italic*.",
title="Test", content="This is **bold** and *italic*.",
published=True,
)
@@ -243,7 +243,7 @@ class TestGenerateAtom:
"""Test ATOM feed escapes special XML characters"""
with app.app_context():
note = create_note(
content="# Test & Special <Characters>\n\nContent with 'quotes' and \"doubles\".",
title="Test & Special <Characters>", content="Content with 'quotes' and \"doubles\".",
published=True,
)
+3 -3
View File
@@ -49,7 +49,7 @@ def sample_notes(app):
notes = []
for i in range(5):
note = create_note(
content=f"# Test Note {i}\n\nThis is test content for note {i}.",
title=f"Test Note {i}", content=f"This is test content for note {i}.",
published=True,
)
notes.append(note)
@@ -121,7 +121,7 @@ class TestGenerateJsonFeed:
# Create notes with distinct timestamps
for i in range(3):
create_note(
content=f"# Note {i}\n\nContent {i}.",
title=f"Note {i}", content=f"Content {i}.",
published=True,
)
time.sleep(0.01)
@@ -195,7 +195,7 @@ class TestGenerateJsonFeed:
"""Test JSON Feed includes HTML content"""
with app.app_context():
note = create_note(
content="# Test\n\nThis is **bold** and *italic*.",
title="Test", content="This is **bold** and *italic*.",
published=True,
)
+3 -3
View File
@@ -81,7 +81,7 @@ def note_with_single_media(app):
with app.app_context():
# Create note
note = create_note(
content="# Test Note\n\nNote with one image.",
title="Test Note", content="Note with one image.",
published=True
)
@@ -106,7 +106,7 @@ def note_with_multiple_media(app):
with app.app_context():
# Create note
note = create_note(
content="# Gallery Note\n\nNote with three images.",
title="Gallery Note", content="Note with three images.",
published=True
)
@@ -135,7 +135,7 @@ def note_without_media(app):
"""Create note without media"""
with app.app_context():
note = create_note(
content="# Plain Note\n\nNote without images.",
title="Plain Note", content="Note without images.",
published=True
)
notes = list_notes(published_only=True, limit=1)
+79 -1
View File
@@ -184,7 +184,9 @@ class TestCodesAndTokens:
with app.test_request_context():
code = create_authorization_code(CLIENT_ID, REDIRECT_URI, "create", challenge_for(verifier))
result = redeem_authorization_code(code, CLIENT_ID, REDIRECT_URI, verifier)
assert result == {"me": "https://example.com", "scope": "create", "client_id": CLIENT_ID}
assert result == {
"me": "https://example.com", "scope": "create", "client_id": CLIENT_ID, "resource": None,
}
token = create_access_token(CLIENT_ID, "create")
info = verify_access_token(token["access_token"])
@@ -354,3 +356,79 @@ class TestEndpoints:
admin_client.post(f"/admin/tokens/{token_id}/revoke")
with app.test_request_context():
assert verify_access_token(token) is None
MCP_RESOURCE = "https://blog.example.com/mcp"
class TestResourceIndicators:
"""RFC 8707 resource binding for MCP clients (v2.15.0, ADR-075)"""
def test_metadata_advertises_cimd_and_draft(self, client):
data = client.get("/.well-known/oauth-authorization-server").get_json()
assert data["client_id_metadata_document_supported"] is True
assert data["token_endpoint_auth_methods_supported"] == ["none"]
assert "draft" in data["scopes_supported"]
def test_mcp_resource_accepted(self, app):
with app.test_request_context():
result = validate_authorization_request(auth_params(resource=MCP_RESOURCE + "/"))
assert result["resource"] == MCP_RESOURCE
def test_no_resource_is_micropub(self, app):
with app.test_request_context():
assert validate_authorization_request(auth_params())["resource"] is None
def test_unknown_resource_rejected(self, app):
with app.test_request_context():
with pytest.raises(AuthorizationRequestError) as e:
validate_authorization_request(auth_params(resource="https://other.example/mcp"))
assert e.value.error == "invalid_target"
assert e.value.redirectable
def test_mcp_client_without_scope_is_offered_defaults(self, app):
with app.test_request_context():
result = validate_authorization_request(auth_params(scope="", resource=MCP_RESOURCE))
assert result["scopes"] == ["create", "update", "delete", "media", "draft"]
def test_consent_page_names_mcp(self, admin_client):
response = admin_client.get("/auth/authorize?" + urlencode(auth_params(resource=MCP_RESOURCE)))
assert response.status_code == 200
assert b"MCP" in response.data
assert b'name="resource" value="https://blog.example.com/mcp"' in response.data
def _token_form(self, query, **extra):
return {
"grant_type": "authorization_code",
"code": query["code"][0],
"client_id": CLIENT_ID,
"redirect_uri": REDIRECT_URI,
"code_verifier": "v" * 50,
**extra,
}
def test_resource_carried_to_token(self, app, admin_client, client):
query = approve(admin_client, granted=["create"], resource=MCP_RESOURCE)
body = client.post("/auth/token", data=self._token_form(query, resource=MCP_RESOURCE)).get_json()
with app.test_request_context():
info = verify_access_token(body["access_token"])
assert info["resource"] == MCP_RESOURCE
assert info["scope"] == "create"
def test_token_request_resource_must_match(self, admin_client, client):
query = approve(admin_client, granted=["create"], resource=MCP_RESOURCE)
response = client.post("/auth/token", data=self._token_form(query, resource="https://other.example/"))
assert response.status_code == 400
assert response.get_json()["error"] == "invalid_target"
def test_micropub_token_has_no_resource(self, app, admin_client, client):
query = approve(admin_client, granted=["create"])
body = client.post("/auth/token", data=self._token_form(query)).get_json()
with app.test_request_context():
assert verify_access_token(body["access_token"])["resource"] is None
def test_legacy_verification_shape_unchanged(self, app, client):
with app.test_request_context():
token = create_access_token(CLIENT_ID, "create", resource=MCP_RESOURCE)["access_token"]
data = client.get("/auth/token", headers={"Authorization": f"Bearer {token}"}).get_json()
assert data == {"me": "https://example.com", "client_id": CLIENT_ID, "scope": "create"}
+259
View File
@@ -0,0 +1,259 @@
"""
Tests for the MCP server (starpunk/mcp_server, v2.15.0, ADR-075)
Requests go through the real ASGI app (Streamable HTTP, stateless JSON) with
real StarPunk tokens, so the SDK's bearer checks, resource binding and DNS
rebinding protection are exercised along with the tools.
"""
import base64
import io
import json
import pytest
from PIL import Image
from starlette.testclient import TestClient
from starpunk.indieauth import create_access_token, revoke_access_token
from starpunk.mcp_server import create_asgi_app
SITE = "https://blog.example.com"
RESOURCE = SITE + "/mcp"
ALL_SCOPES = "create update delete media draft"
HEADERS = {
"Accept": "application/json, text/event-stream",
"Content-Type": "application/json",
"MCP-Protocol-Version": "2025-11-25",
}
@pytest.fixture
def app(tmp_path):
from starpunk import create_app
data = tmp_path / "data"
return create_app(
{
"TESTING": True,
"SITE_URL": SITE,
"ADMIN_ME": "https://example.com",
"SESSION_SECRET": "test-secret",
"DATA_PATH": data,
"NOTES_PATH": data / "notes",
"DATABASE_PATH": data / "starpunk.db",
}
)
@pytest.fixture
def http(app):
with TestClient(create_asgi_app(app), base_url=SITE) as client:
yield client
@pytest.fixture
def token(app):
"""Make a token bound to the MCP resource (or another) with given scopes"""
def make(scope=ALL_SCOPES, resource=RESOURCE):
with app.app_context():
return create_access_token("https://claude.ai/client.json", scope, resource=resource)["access_token"]
return make
def rpc(http, token, method, params=None, headers=None):
body = {"jsonrpc": "2.0", "id": 1, "method": method}
if params is not None:
body["params"] = params
auth = {"Authorization": f"Bearer {token}"} if token else {}
return http.post("/mcp", json=body, headers={**HEADERS, **auth, **(headers or {})})
def call(http, token, name, **arguments):
"""Call a tool; returns (is_error, parsed JSON result or error text)"""
response = rpc(http, token, "tools/call", {"name": name, "arguments": arguments})
assert response.status_code == 200, response.text
result = response.json()["result"]
text = result["content"][0]["text"]
if result.get("isError"):
return True, text
return False, json.loads(text)
def ok(http, token, name, **arguments):
is_error, result = call(http, token, name, **arguments)
assert not is_error, result
return result
class TestAuth:
def test_no_token_points_to_resource_metadata(self, http):
response = rpc(http, None, "tools/list")
assert response.status_code == 401
assert f'resource_metadata="{SITE}/.well-known/oauth-protected-resource/mcp"' in (
response.headers["www-authenticate"]
)
def test_protected_resource_metadata(self, http):
data = http.get("/.well-known/oauth-protected-resource/mcp").json()
assert data["resource"] == RESOURCE
# Must equal the issuer in /.well-known/oauth-authorization-server
assert data["authorization_servers"] == [SITE + "/"]
def test_micropub_token_refused(self, http, token):
assert rpc(http, token(resource=None), "tools/list").status_code == 401
def test_other_resource_refused(self, http, token):
assert rpc(http, token(resource="https://other.example/mcp"), "tools/list").status_code == 401
def test_revoked_token_refused(self, app, http, token):
value = token()
with app.app_context():
revoke_access_token(value)
assert rpc(http, value, "tools/list").status_code == 401
def test_unknown_host_refused(self, http, token):
response = rpc(http, token(), "tools/list", headers={"Host": "evil.example"})
assert response.status_code in (400, 403, 421)
def test_lists_tools(self, http, token):
response = rpc(http, token(), "tools/list")
names = {t["name"] for t in response.json()["result"]["tools"]}
assert names == {
"search_notes", "list_notes", "get_note", "list_tags", "get_site_config",
"create_note", "update_note", "delete_note", "undelete_note", "upload_media",
}
def test_read_tools_are_marked_read_only(self, http, token):
tools = {t["name"]: t for t in rpc(http, token(), "tools/list").json()["result"]["tools"]}
assert tools["list_notes"]["annotations"]["readOnlyHint"] is True
assert tools["delete_note"]["annotations"]["destructiveHint"] is True
class TestWriting:
def test_create_defaults_to_draft(self, http, token):
note = ok(http, token(), "create_note", content="Hello from MCP", tags=["ai"])
assert note["status"] == "draft"
assert note["url"].startswith(SITE + "/note/")
def test_create_published_article(self, http, token):
tok = token()
note = ok(http, tok, "create_note", content="Body", title="An article", draft=False)
assert note["status"] == "published"
props = ok(http, tok, "get_note", url_or_slug=note["url"])["properties"]
assert props["name"] == ["An article"]
assert props["post-status"] == ["published"]
def test_draft_only_token_cannot_publish(self, http, token):
note = ok(http, token("draft"), "create_note", content="Sneaky", draft=False)
assert note["status"] == "draft"
def test_create_needs_scope(self, http, token):
is_error, message = call(http, token("update"), "create_note", content="x")
assert is_error and "create or draft" in message
def test_update_tags_and_publish(self, http, token):
tok = token()
note = ok(http, tok, "create_note", content="Tagged", tags=["one", "two"])
updated = ok(http, tok, "update_note", url=note["slug"], add_tags=["three"],
remove_tags=["one"], draft=False)
assert updated["status"] == "published"
props = ok(http, tok, "get_note", url_or_slug=note["slug"])["properties"]
assert props["category"] == ["two", "three"]
def test_update_content_and_remove_title(self, http, token):
tok = token()
note = ok(http, tok, "create_note", content="Old", title="Title")
ok(http, tok, "update_note", url=note["url"], content="New", title="")
props = ok(http, tok, "get_note", url_or_slug=note["url"])["properties"]
assert props["content"] == ["New"]
assert "name" not in props
def test_update_needs_scope(self, http, token):
note = ok(http, token(), "create_note", content="x")
is_error, _ = call(http, token("create"), "update_note", url=note["url"], content="y")
assert is_error
def test_delete_and_undelete(self, http, token):
tok = token()
note = ok(http, tok, "create_note", content="Gone soon", draft=False)
assert ok(http, tok, "delete_note", url=note["url"])["status"] == "deleted"
assert call(http, tok, "get_note", url_or_slug=note["slug"])[0]
assert ok(http, tok, "undelete_note", url=note["slug"])["status"] == "published"
def test_note_on_other_site_refused(self, http, token):
is_error, message = call(http, token(), "delete_note", url="https://other.example/note/x")
assert is_error and "not on this site" in message
def test_upload_media_then_attach(self, http, token):
tok = token()
buffer = io.BytesIO()
Image.new("RGB", (40, 30), "red").save(buffer, format="PNG")
media = ok(http, tok, "upload_media", filename="red.png",
data_base64=base64.b64encode(buffer.getvalue()).decode())
assert media["url"].startswith(SITE + "/media/")
note = ok(http, tok, "create_note", photos=[{"url": media["url"], "alt": "A red square"}])
props = ok(http, tok, "get_note", url_or_slug=note["slug"])["properties"]
assert props["photo"][0]["alt"] == "A red square"
def test_upload_rejects_bad_base64(self, http, token):
is_error, message = call(http, token(), "upload_media", filename="x.png", data_base64="!!!")
assert is_error and "base64" in message
class TestReading:
def test_list_hides_drafts_by_default(self, http, token):
tok = token()
ok(http, tok, "create_note", content="Draft")
ok(http, tok, "create_note", content="Public", draft=False)
assert [n["excerpt"] for n in ok(http, tok, "list_notes")["notes"]] == ["Public"]
assert len(ok(http, tok, "list_notes", include_drafts=True)["notes"]) == 2
def test_drafts_need_a_posting_scope(self, http, token):
ok(http, token(), "create_note", content="Secret draft")
reader = token("media")
assert call(http, reader, "list_notes", include_drafts=True)[0]
assert ok(http, reader, "list_notes")["notes"] == []
def test_draft_hidden_from_get_without_scope(self, http, token):
note = ok(http, token(), "create_note", content="Secret draft")
is_error, _ = call(http, token("media"), "get_note", url_or_slug=note["slug"])
assert is_error
def test_search(self, http, token):
tok = token()
ok(http, tok, "create_note", content="Pancakes on Sunday", draft=False)
ok(http, tok, "create_note", content="Waffles", draft=False)
results = ok(http, tok, "search_notes", query="pancakes")["results"]
assert len(results) == 1 and results[0]["url"].startswith(SITE + "/note/")
def test_tags(self, http, token):
tok = token()
ok(http, tok, "create_note", content="x", tags=["Cats", "dogs"])
assert set(ok(http, tok, "list_tags")["tags"]) == {"Cats", "dogs"}
assert ok(http, tok, "list_tags", filter="cat")["tags"] == ["Cats"]
def test_site_config(self, http, token):
config = ok(http, token("media"), "get_site_config")
assert config["media-endpoint"] == SITE + "/micropub/media"
assert "syndicate-to" in config
class TestSidecarApp:
def test_workers_off_when_built_from_environment(self, monkeypatch, tmp_path):
"""create_asgi_app() without an app never starts background workers"""
import starpunk
seen = {}
real = starpunk.create_app
def spy(config=None):
seen.update(config or {})
return real({**(config or {}), "TESTING": True, "SITE_URL": SITE,
"SESSION_SECRET": "x", "ADMIN_ME": "https://example.com", "DATA_PATH": tmp_path,
"NOTES_PATH": tmp_path / "notes", "DATABASE_PATH": tmp_path / "db.sqlite"})
monkeypatch.setattr(starpunk, "create_app", spy)
create_asgi_app()
assert seen["BACKGROUND_WORKERS_ENABLED"] is False
+6 -5
View File
@@ -57,20 +57,21 @@ class TestNoteHEntry:
assert props['url'][0] == props['uid'][0], "u-url and u-uid should match"
def test_hentry_pname_only_with_explicit_title(self, client, app, data_dir):
"""p-name only present when note has explicit title (per Q22)"""
"""p-name only present when note has a title (ADR-076, was Q22)"""
from starpunk.notes import create_note
# Create note WITH heading (explicit title)
# Create note WITH a title (an article)
with app.app_context():
note_with_title = create_note(
content="# Explicit Title\n\nThis note has a heading.",
content="This note has a title.",
title="Explicit Title",
custom_slug="note-with-title",
published=True
)
response = client.get('/note/note-with-title')
response = client.get('/article/note-with-title')
assert response.status_code == 200, f"Failed to get note: {response.status_code}"
parsed = mf2py.parse(doc=response.data.decode(), url='http://localhost/note/note-with-title')
parsed = mf2py.parse(doc=response.data.decode(), url='http://localhost/article/note-with-title')
entries = [item for item in parsed['items'] if 'h-entry' in item.get('type', [])]
assert len(entries) > 0, "No h-entry found in parsed HTML"
+2 -1
View File
@@ -142,7 +142,8 @@ def test_split_title(content, title):
@pytest.mark.parametrize("content,kind", [
("#indieweb is great, posting from my phone", "note"),
("#\n\nbody text", "note"),
("# A Title\n\nThe body", "article"),
# A heading in the text is no longer a title (v2.16.0, ADR-076)
("# A Title\n\nThe body", "note"),
])
def test_post_type_of_hash_notes(app, client, content, kind):
note = make_note(app, content)
+4 -3
View File
@@ -167,11 +167,11 @@ def test_micropub_create_with_name(client, app, mock_valid_token):
assert response.status_code == 201
assert 'Location' in response.headers
# StarPunk titles are a '# Heading' first line, so name must land there
# name is stored as the title, apart from the content (v2.16.0, ADR-076)
slug = response.headers['Location'].rstrip('/').split('/')[-1]
with app.app_context():
note = get_note(slug)
assert note.content == '# My Test Title\n\nContent goes here'
assert note.content == 'Content goes here'
assert note.title == 'My Test Title'
@@ -193,7 +193,8 @@ def test_micropub_create_with_name_already_heading(client, app, mock_valid_token
assert response.status_code == 201
slug = response.headers['Location'].rstrip('/').split('/')[-1]
with app.app_context():
assert get_note(slug).content == '# Same Title\n\nBody'
note = get_note(slug)
assert (note.title, note.content) == ('Same Title', 'Body')
def test_micropub_create_with_categories(client, app, mock_valid_token):
+21 -1
View File
@@ -114,9 +114,29 @@ class TestUpdate:
def test_replace_and_delete_name(self, app, client, h):
url = create(client, h)
self.update(client, h, url, replace={"name": ["Added"]})
assert note_at(app, url).content.startswith("# Added")
note = note_at(app, url)
assert note.title == "Added" and not note.content.startswith("#")
self.update(client, h, url, delete=["name"])
assert "name" not in source(client, h, url)["properties"]
assert note_at(app, url).title is None
def test_summary(self, app, client, h):
"""summary is stored alongside content, updatable and returned by q=source (v2.16.0)"""
url = create(client, h, name=["Title"], summary=["Short version"])
props = source(client, h, url)["properties"]
assert props["summary"] == ["Short version"] and props["name"] == ["Title"]
assert self.update(client, h, url, replace={"summary": ["Shorter"]}).status_code == 204
assert note_at(app, url).summary == "Shorter"
assert self.update(client, h, url, delete=["summary"]).status_code == 204
assert "summary" not in source(client, h, url)["properties"]
def test_article_body_may_go(self, app, client, h):
"""A titled post may have no text, like a photo post (v2.16.0)"""
url = create(client, h, name=["Only a title"])
assert self.update(client, h, url, delete=["content"]).status_code == 204
assert note_at(app, url).content == ""
url = create(client, h)
assert self.update(client, h, url, delete=["content"]).status_code == 400
def test_categories(self, app, client, h):
url = create(client, h, category=["one", "two"])
+127
View File
@@ -0,0 +1,127 @@
"""
Migration 023 moves '# Heading' titles out of note files into notes.title (v2.16.0, ADR-076).
Starts from a fully migrated database, takes it back to before 023, then
runs the migrations again with the data directory.
"""
import sqlite3
import pytest
from starpunk import create_app
from starpunk.migrations import MigrationError, run_migrations
from starpunk.utils import calculate_content_hash
MIGRATION = "023_note_titles.sql"
TITLED = "# Old Title\n\nThe body."
@pytest.fixture
def setup(tmp_path):
data = tmp_path / "data"
data.mkdir()
db_path = data / "starpunk.db"
create_app(config={"TESTING": True, "DATABASE_PATH": db_path, "DATA_PATH": data,
"SESSION_SECRET": "x", "ADMIN_ME": "https://example.com",
"SITE_URL": "https://blog.example.com"})
files = {
"titled": ("notes/2026/11/titled.md", TITLED, None),
"untitled": ("notes/2026/11/untitled.md", "#indieweb is great", None),
"trashed": ("notes/2026/10/trashed.md", "# Gone\n\nBin.", "2026-11-01"),
}
conn = sqlite3.connect(db_path)
for slug, (rel, text, deleted_at) in files.items():
path = data / rel
if deleted_at: # delete_note_file put it in .trash/<year>/<month>/
path = data / ".trash" / "2026" / "10" / "trashed.md"
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text(text)
conn.execute(
"INSERT INTO notes (slug, file_path, published, created_at, updated_at, deleted_at,"
" content_hash) VALUES (?, ?, 1, '2026-11-01', '2026-11-01', ?, ?)",
(slug, rel, deleted_at, calculate_content_hash(text)),
)
conn.execute("INSERT INTO notes_fts (rowid, slug, title, content) VALUES (1, 'titled', 'x', 'y')")
# Back to before migration 023
conn.execute("ALTER TABLE notes DROP COLUMN title")
conn.execute("ALTER TABLE notes DROP COLUMN summary")
conn.execute("DELETE FROM schema_migrations WHERE migration_name = ?", (MIGRATION,))
conn.commit()
conn.close()
return db_path, data
def notes(db_path):
conn = sqlite3.connect(db_path)
conn.row_factory = sqlite3.Row
rows = {r["slug"]: dict(r) for r in conn.execute("SELECT * FROM notes")}
conn.close()
return rows
def test_titles_move_out_of_files(setup):
db_path, data = setup
run_migrations(db_path, data_dir=data)
rows = notes(db_path)
assert rows["titled"]["title"] == "Old Title"
assert (data / "notes/2026/11/titled.md").read_text() == "The body."
assert rows["titled"]["content_hash"] == calculate_content_hash("The body.")
assert rows["untitled"]["title"] is None # a hashtag isn't a heading
assert (data / "notes/2026/11/untitled.md").read_text() == "#indieweb is great"
assert rows["trashed"]["title"] == "Gone" # found in .trash, so undelete still works
assert (data / ".trash/2026/10/trashed.md").read_text() == "Bin."
conn = sqlite3.connect(db_path)
assert conn.execute("SELECT COUNT(*) FROM notes_fts").fetchone()[0] == 0 # rebuilt at startup
assert conn.execute("SELECT 1 FROM schema_migrations WHERE migration_name = ?",
(MIGRATION,)).fetchone()
conn.close()
def test_runs_once(setup):
"""Afterwards a heading in a note's text is just a heading"""
db_path, data = setup
run_migrations(db_path, data_dir=data)
(data / "notes/2026/11/untitled.md").write_text("# Now a heading\n\nNew text")
run_migrations(db_path, data_dir=data)
assert notes(db_path)["untitled"]["title"] is None
assert (data / "notes/2026/11/untitled.md").read_text() == "# Now a heading\n\nNew text"
def test_failure_puts_files_back(setup, monkeypatch):
db_path, data = setup
import starpunk.utils as utils
real_write = utils.write_note_file
written = []
def write_then_fail(path, content):
if written:
raise OSError("disk full")
written.append(path)
real_write(path, content)
monkeypatch.setattr(utils, "write_note_file", write_then_fail)
with pytest.raises(MigrationError):
run_migrations(db_path, data_dir=data)
assert written # one file was changed before the failure...
assert (data / "notes/2026/11/titled.md").read_text() == TITLED # ...and put back
assert (data / ".trash/2026/10/trashed.md").read_text() == "# Gone\n\nBin."
conn = sqlite3.connect(db_path)
assert not conn.execute("SELECT 1 FROM schema_migrations WHERE migration_name = ?",
(MIGRATION,)).fetchone()
assert "title" not in [r[1] for r in conn.execute("PRAGMA table_info(notes)")]
conn.close()
def test_without_data_dir_only_schema(setup):
db_path, data = setup
run_migrations(db_path)
assert notes(db_path)["titled"]["title"] is None
assert (data / "notes/2026/11/titled.md").read_text() == TITLED
+34 -48
View File
@@ -11,6 +11,7 @@ Organized by model:
import pytest
from datetime import datetime, timedelta, timezone
from pathlib import Path
from dataclasses import replace
from starpunk.models import Note, Session, Token, AuthState, split_title
from starpunk.utils import calculate_content_hash
@@ -139,13 +140,12 @@ class TestNoteModel:
html2 = note.html
assert html1 == html2
def test_title_extraction_from_heading(self, tmp_path):
"""Test title extraction from markdown heading"""
def test_title_is_the_column_not_the_content(self, tmp_path):
"""A title comes from notes.title; a heading in the content is just a heading (ADR-076)"""
note_file = tmp_path / "notes" / "2024" / "11" / "test.md"
note_file.parent.mkdir(parents=True)
note_file.write_text("# My Note Title\n\nContent.")
note = Note(
note_file.write_text("# A Heading\n\nContent.")
kwargs = dict(
id=1,
slug="test",
file_path="notes/2024/11/test.md",
@@ -154,29 +154,13 @@ class TestNoteModel:
updated_at=datetime.now(timezone.utc).replace(tzinfo=None),
_data_dir=tmp_path,
)
assert Note(**kwargs).title is None
assert "<h1>A Heading</h1>" in Note(**kwargs).html
assert Note(**kwargs, title="My Note Title").title == "My Note Title"
assert note.title == "My Note Title"
def test_title_extraction_from_first_line(self, tmp_path):
"""Test title extraction from first line without heading"""
note_file = tmp_path / "notes" / "2024" / "11" / "test.md"
note_file.parent.mkdir(parents=True)
note_file.write_text("Just a note without heading\n\nMore content.")
note = Note(
id=1,
slug="test",
file_path="notes/2024/11/test.md",
published=True,
created_at=datetime.now(timezone.utc).replace(tzinfo=None),
updated_at=datetime.now(timezone.utc).replace(tzinfo=None),
_data_dir=tmp_path,
)
assert note.title == "Just a note without heading"
def test_title_fallback_to_slug(self):
"""Test title falls back to slug if no content"""
def test_label(self, tmp_path):
"""label: title, else excerpt, else slug"""
assert self._note_with(tmp_path, "Just a note\n\nMore.").label == "Just a note More."
note = Note(
id=1,
slug="my-test-note",
@@ -185,10 +169,10 @@ class TestNoteModel:
created_at=datetime.now(timezone.utc).replace(tzinfo=None),
updated_at=datetime.now(timezone.utc).replace(tzinfo=None),
_data_dir=Path("/nonexistent"),
title="Titled",
)
# Should fall back to slug (file doesn't exist)
assert note.title == "my-test-note"
assert note.label == "Titled"
assert replace(note, title=None).label == "my-test-note"
def test_excerpt_generation(self, tmp_path):
"""Test excerpt generation"""
@@ -208,8 +192,8 @@ class TestNoteModel:
)
excerpt = note.excerpt
assert len(excerpt) <= 203 # EXCERPT_LENGTH + "..."
assert excerpt.endswith("...")
assert len(excerpt) <= 201 # EXCERPT_LENGTH + "…"
assert excerpt.endswith("…")
def test_excerpt_short_content(self, tmp_path):
"""Test excerpt with short content (no ellipsis)"""
@@ -259,6 +243,24 @@ class TestNoteModel:
_data_dir=tmp_path,
)
def test_excerpt_is_plain_text(self, tmp_path):
"""No Markdown in previews, alt text or crosspost teasers (v2.16.0)"""
note = self._note_with(
tmp_path, "Some **bold** and a [link](https://x.example).\n\n![pic](/m.jpg)\n\n- one\n- two")
assert note.excerpt == "Some bold and a link. • one • two"
def test_hashtag_line_is_not_a_heading(self, tmp_path):
"""'#indieweb ...' renders as text; '# Heading' still a heading (v2.16.0)"""
note = self._note_with(tmp_path, "#indieweb is fun\n\n##two\n\n# Real heading")
assert "<p>#indieweb is fun</p>" in note.html
assert "<p>##two</p>" in note.html
assert "<h1>Real heading</h1>" in note.html
assert note.excerpt.startswith("#indieweb is fun ##two")
def test_hashtag_in_code_untouched(self, tmp_path):
note = self._note_with(tmp_path, "```\n#include <x>\n```")
assert "\\" not in note.html and "include" in note.html
def test_split_title(self):
"""A '# Heading' first line is split off as the title"""
assert split_title("# My Title\n\nBody") == ("My Title", "Body")
@@ -266,22 +268,6 @@ class TestNoteModel:
assert split_title("No heading\n# later") == (None, "No heading\n# later")
assert split_title("#\nBody") == (None, "#\nBody")
def test_body_html_leaves_out_title(self, tmp_path):
"""Pages show the title themselves, so the body must not repeat it"""
note = self._note_with(tmp_path, "# My Title\n\nBody text.")
assert "My Title" not in note.body_html
assert "<p>Body text.</p>" in note.body_html
assert "<h1>My Title</h1>" in note.html # html is unchanged
def test_body_html_untitled_matches_html(self, tmp_path):
note = self._note_with(tmp_path, "Plain note.")
assert note.body_html == note.html
def test_excerpt_leaves_out_title(self, tmp_path):
"""Previews show the title above the excerpt, so it is not repeated"""
note = self._note_with(tmp_path, "# Title\n\nShort content.")
assert note.excerpt == "Short content."
def test_permalink(self):
"""Test permalink generation"""
note = Note(
+3 -3
View File
@@ -68,7 +68,7 @@ def sample_notes(app):
notes = []
for i in range(10):
note = create_note(
content=f"# Test Note {i}\n\nContent for note {i}.",
title=f"Test Note {i}", content=f"Content for note {i}.",
published=(i < 7), # First 7 published, last 3 drafts
)
notes.append(note)
@@ -316,7 +316,7 @@ class TestFeedEdgeCases:
"""Test feed handles special characters correctly"""
with app.app_context():
create_note(
content="# Test & Special <Characters>\n\n'Quotes' and \"doubles\".",
title="Test & Special <Characters>", content="'Quotes' and \"doubles\".",
published=True,
)
@@ -330,7 +330,7 @@ class TestFeedEdgeCases:
def test_feed_with_unicode_content(self, client, app):
"""Test feed handles Unicode content"""
with app.app_context():
create_note(content="# Test Unicode 你好 🚀\n\nEmojis and ümlauts.", published=True)
create_note(title="Test Unicode 你好 🚀", content="Emojis and ümlauts.", published=True)
response = client.get("/feed.xml")
assert response.status_code == 200
+34
View File
@@ -121,6 +121,40 @@ class TestCompose:
assert "…" in text
class TestArticles:
"""Articles are crossposted as title, teaser and link, without images (v2.16.0)"""
LINK = "https://blog.example.com/note/x"
def test_title_summary_and_link(self, app):
with app.app_context():
note = create_note(content="Long body " * 100, title="My Article",
summary="The gist.", published=True)
text = compose_text(note, self.LINK, ["IndieWeb"], 500)
assert text == f"My Article\n\nThe gist.\n\n{self.LINK}\n\n#IndieWeb"
def test_without_summary_the_start_of_the_text(self, app):
with app.app_context():
note = create_note(content="Some *markdown* " + "word " * 100, title="T", published=True)
title, teaser, link = compose_text(note, self.LINK, [], 5000).split("\n\n")
assert (title, link) == ("T", self.LINK)
assert teaser.startswith("Some markdown word") and teaser.endswith("…")
assert len(teaser) <= 201
def test_edit_follows_and_no_images(self, app, server, monkeypatch):
looked_up = []
monkeypatch.setattr(syndication, "_media_files", lambda *a, **k: looked_up.append(a) or [])
with app.test_request_context():
note = create_note(content="Body", title="Before", published=True)
select_targets(note.id, ["gotosocial"])
process_due()
update_note(id=note.id, title="After")
process_due()
assert server.statuses["1"]["status"].startswith("After\n\nBody")
assert not server.statuses["1"].get("media_ids")
assert looked_up == []
class TestLifecycle:
def test_publish_creates_status(self, app, server):
note = publish(app, tags=["Test"])
+18
View File
@@ -179,12 +179,30 @@ class TestText:
assert raw[tag["index"]["byteStart"]:tag["index"]["byteEnd"]] == b"#IndieWeb"
assert tag["features"][0]["tag"] == "IndieWeb"
def test_hashtag_at_line_start_stays_a_tag(self):
"""Not turned into a heading and lost (v2.16.0)"""
assert plain_text("#indieweb is fun") == "#indieweb is fun"
assert [f["features"][0]["tag"] for f in bluesky_facets(plain_text("#indieweb is fun"))] == ["indieweb"]
def test_fragment_in_url_is_not_a_tag(self):
facets = bluesky_facets("see https://x.example/page#section and #42 too")
assert [f["features"][0]["$type"] for f in facets] == ["app.bsky.richtext.facet#link"]
class TestLifecycle:
def test_article_posts_teaser_with_its_own_card(self, app, pds):
"""An article's card is the article, even when its text links elsewhere (v2.16.0)"""
with app.test_request_context():
note = create_note(content="See [this](https://elsewhere.example/x) for more.",
title="My Article", summary="The gist.", published=True)
select_targets(note.id, ["bluesky"])
process_due()
record = only_record(pds)
permalink = f"https://blog.example.com/article/{note.slug}"
assert record["text"] == f"My Article\n\nThe gist.\n\n{permalink}"
assert record["embed"]["external"] == {
"uri": permalink, "title": "My Article", "description": "The gist."}
def test_publish_posts_with_link_card(self, app, pds):
note = publish(app, content="Hello **Bluesky**", tags=["IndieWeb"])
record = only_record(pds)