api: serve mbox content at advertised URLs

The API responses include mbox URLs (e.g. /api/1.4/patches/N/mbox) but
no routes handle them. Register mbox endpoints for patches, covers,
series and bundles under each API version prefix so that the advertised
URLs work.

Signed-off-by: Robin Jarry <robin@jarry.cc>

Author: rjarry

pkg/api/api.go

@@ -241,6 +241,11 @@ func NewRouter(cfg *config.Config, database *bun.DB, baseURL string, bus db.Even
 		registerBundleRoutes(api, h, prefix, mw)
 		registerWebhookRoutes(api, h, prefix, mw)
 		registerEventRoutes(api, h, prefix, mw)
+
+		r.Get(prefix+"/patches/{id}/mbox", h.patchMbox)
+		r.Get(prefix+"/covers/{id}/mbox", h.coverMbox)
+		r.Get(prefix+"/series/{id}/mbox", h.seriesMbox)
+		r.Get(prefix+"/bundles/{id}/mbox", h.bundleMbox)
 	}
 
 	latest := supportedVersions[len(supportedVersions)-1]

pkg/api/mbox.go

@@ -0,0 +1,183 @@
+// Patchwork - automated patch tracking system
+// Copyright (C) The Patchwork Contributors (see CONTRIBUTORS)
+//
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+package api
+
+import (
+	"bytes"
+	"fmt"
+	"net/http"
+	"strconv"
+
+	"github.com/go-chi/chi/v5"
+	"github.com/uptrace/bun"
+
+	"github.com/getpatchwork/patchwork/pkg/db"
+	"github.com/getpatchwork/patchwork/pkg/mbox"
+)
+
+func (h *handler) patchMbox(w http.ResponseWriter, r *http.Request) {
+	ctx := r.Context()
+	q := db.GetQueries(ctx)
+	id, err := strconv.Atoi(chi.URLParam(r, "id"))
+	if err != nil {
+		http.NotFound(w, r)
+		return
+	}
+
+	var patch db.Patch
+	if err := q.DB.NewSelect().Model(&patch).
+		Where("id = ?", id).Scan(ctx); err != nil {
+		http.NotFound(w, r)
+		return
+	}
+
+	var project db.Project
+	if err := q.DB.NewSelect().Model(&project).
+		Where("id = ?", patch.ProjectID).Scan(ctx); err != nil {
+		http.Error(w, "Internal Server Error", http.StatusInternalServerError)
+		return
+	}
+
+	sub := mbox.BuildPatchSubmission(ctx, q.DB, &patch, project.Listemail)
+	body := mbox.Format(sub)
+
+	w.Header().Set("Content-Type", "text/plain; charset=utf-8")
+	w.Header().Set("Content-Disposition",
+		fmt.Sprintf("attachment; filename=%s.patch",
+			mbox.SanitizeFilename(patch.Name)))
+	_, _ = w.Write(body)
+}
+
+func (h *handler) coverMbox(w http.ResponseWriter, r *http.Request) {
+	ctx := r.Context()
+	q := db.GetQueries(ctx)
+	id, err := strconv.Atoi(chi.URLParam(r, "id"))
+	if err != nil {
+		http.NotFound(w, r)
+		return
+	}
+
+	var cover db.Cover
+	if err := q.DB.NewSelect().Model(&cover).
+		Where("id = ?", id).Scan(ctx); err != nil {
+		http.NotFound(w, r)
+		return
+	}
+
+	var project db.Project
+	if err := q.DB.NewSelect().Model(&project).
+		Where("id = ?", cover.ProjectID).Scan(ctx); err != nil {
+		http.Error(w, "Internal Server Error", http.StatusInternalServerError)
+		return
+	}
+
+	sub := mbox.BuildCoverSubmission(ctx, q.DB, &cover, project.Listemail)
+	body := mbox.Format(sub)
+
+	w.Header().Set("Content-Type", "text/plain; charset=utf-8")
+	w.Header().Set("Content-Disposition",
+		fmt.Sprintf("attachment; filename=%s.mbox",
+			mbox.SanitizeFilename(cover.Name)))
+	_, _ = w.Write(body)
+}
+
+func (h *handler) seriesMbox(w http.ResponseWriter, r *http.Request) {
+	ctx := r.Context()
+	q := db.GetQueries(ctx)
+	id, err := strconv.Atoi(chi.URLParam(r, "id"))
+	if err != nil {
+		http.NotFound(w, r)
+		return
+	}
+
+	var series db.Series
+	if err := q.DB.NewSelect().Model(&series).
+		Where("id = ?", id).Scan(ctx); err != nil {
+		http.NotFound(w, r)
+		return
+	}
+
+	var project db.Project
+	if series.ProjectID != nil {
+		if err := q.DB.NewSelect().Model(&project).
+			Where("id = ?", *series.ProjectID).Scan(ctx); err != nil {
+			http.Error(w, "Internal Server Error", http.StatusInternalServerError)
+			return
+		}
+	}
+
+	var patches []db.Patch
+	if err := q.DB.NewSelect().Model(&patches).
+		Where("series_id = ?", series.ID).
+		OrderBy("number", bun.OrderAsc).
+		Scan(ctx); err != nil {
+		http.Error(w, "Internal Server Error", http.StatusInternalServerError)
+		return
+	}
+
+	var parts [][]byte
+	for i := range patches {
+		sub := mbox.BuildPatchSubmission(ctx, q.DB, &patches[i], project.Listemail)
+		parts = append(parts, mbox.Format(sub))
+	}
+
+	name := "series"
+	if series.Name != nil {
+		name = *series.Name
+	}
+
+	w.Header().Set("Content-Type", "text/plain; charset=utf-8")
+	w.Header().Set("Content-Disposition",
+		fmt.Sprintf("attachment; filename=%s.patch",
+			mbox.SanitizeFilename(name)))
+	_, _ = w.Write(bytes.Join(parts, []byte("\n")))
+}
+
+func (h *handler) bundleMbox(w http.ResponseWriter, r *http.Request) {
+	ctx := r.Context()
+	q := db.GetQueries(ctx)
+	id, err := strconv.Atoi(chi.URLParam(r, "id"))
+	if err != nil {
+		http.NotFound(w, r)
+		return
+	}
+
+	var bundle db.Bundle
+	if err := q.DB.NewSelect().Model(&bundle).
+		Where("id = ?", id).Scan(ctx); err != nil {
+		http.NotFound(w, r)
+		return
+	}
+
+	var project db.Project
+	if err := q.DB.NewSelect().Model(&project).
+		Where("id = ?", bundle.ProjectID).Scan(ctx); err != nil {
+		http.Error(w, "Internal Server Error", http.StatusInternalServerError)
+		return
+	}
+
+	var patches []db.Patch
+	if err := q.DB.NewSelect().Model(&patches).
+		Join("JOIN bundle_patch AS bp ON bp.patch_id = patch.id").
+		Where("bp.bundle_id = ?", bundle.ID).
+		OrderBy("bp.order", bun.OrderAsc).
+		Scan(ctx); err != nil {
+		http.Error(w, "Internal Server Error", http.StatusInternalServerError)
+		return
+	}
+
+	var parts [][]byte
+	for i := range patches {
+		sub := mbox.BuildPatchSubmission(ctx, q.DB, &patches[i], project.Listemail)
+		parts = append(parts, mbox.Format(sub))
+	}
+
+	w.Header().Set("Content-Type", "text/plain; charset=utf-8")
+	w.Header().Set("Content-Disposition",
+		fmt.Sprintf("attachment; filename=bundle-%d-%s.mbox",
+			bundle.ID, mbox.SanitizeFilename(bundle.Name)))
+	_, _ = w.Write(bytes.Join(parts, []byte("\n")))
+}