internal/api/cluster_summary.go - develop - githubmirror/photoprism

internal/api/cluster_summary.go
112 строк3 KB
Michael Mayer
Cluster: Revalidate portal proxy cache & tighten OAuth scope usage
27 фев 2026, 00:42
27 фев 2026, 00:426bc8527
package api

import (
	"net/http"
	"strings"
	"time"

	"github.com/gin-gonic/gin"

	"github.com/photoprism/photoprism/internal/auth/acl"
	"github.com/photoprism/photoprism/internal/event"
	"github.com/photoprism/photoprism/internal/photoprism/get"
	"github.com/photoprism/photoprism/internal/service/cluster"
	reg "github.com/photoprism/photoprism/internal/service/cluster/registry"
	"github.com/photoprism/photoprism/internal/service/cluster/theme"
	"github.com/photoprism/photoprism/pkg/http/header"
	"github.com/photoprism/photoprism/pkg/log/status"
)

// ClusterSummary returns a minimal overview of the cluster/portal.
//
//	@Summary	cluster summary
//	@Id			ClusterSummary
//	@Tags		Cluster
//	@Produce	json
//	@Success	200			{object}	cluster.SummaryResponse
//	@Failure	401,403,429	{object}	i18n.Response
//	@Router		/api/v1/cluster [get]
func ClusterSummary(router *gin.RouterGroup) {
	router.GET("/cluster", func(c *gin.Context) {
		s := Auth(c, acl.ResourceCluster, acl.ActionView)
		if s.Abort(c) {
			return
		}

		conf := get.Config()

		if !conf.Portal() {
			AbortFeatureDisabled(c)
			return
		}

		regy, err := reg.NewClientRegistryWithConfig(conf)

		if err != nil {
			AbortUnexpectedError(c)
			return
		}

		nodes, _ := regy.List()
		themeVersion := ""

		if v, err := theme.DetectVersion(conf.PortalThemePath()); err == nil {
			themeVersion = v
		}

		resp := cluster.SummaryResponse{
			UUID:        conf.ClusterUUID(),
			ClusterCIDR: conf.ClusterCIDR(),
			Nodes:       len(nodes),
			Database:    cluster.DatabaseInfo{Driver: conf.DatabaseDriverName(), Host: conf.DatabaseHost(), Port: conf.DatabasePort()},
			Theme:       themeVersion,
			Time:        time.Now().UTC().Format(time.RFC3339),
		}

		event.AuditDebug(
			[]string{ClientIP(c), "session %s", string(acl.ResourceCluster), "get summary for cluster uuid %s", status.Succeeded},
			s.RefID,
			conf.ClusterUUID(),
		)

		c.JSON(http.StatusOK, resp)
	})
}

// ClusterHealth returns minimal health information.
//
//	@Summary	cluster health
//	@Id			ClusterHealth
//	@Tags		Cluster
//	@Produce	json
//	@Success	200			{object}	HealthResponse
//	@Failure	401,403,429	{object}	i18n.Response
//	@Router		/api/v1/cluster/health [get]
func ClusterHealth(router *gin.RouterGroup) {
	router.GET("/cluster/health", func(c *gin.Context) {
		conf := get.Config()
		clientIp := ClientIP(c)

		// Align headers with server-level health endpoints.
		c.Header(header.CacheControl, header.CacheControlNoStore)

		// Return error if not a portal node.
		if !conf.Portal() {
			AbortFeatureDisabled(c)
			return
		}

		// Optional IP-based allowance via ClusterCIDR.
		if cidr := strings.TrimSpace(conf.ClusterCIDR()); cidr != "" {
			if !clusterCIDRAllowsClientIP(cidr, clientIp) {
				event.AuditWarn([]string{clientIp, string(acl.ResourceCluster), "health check", "client ip outside cluster-cidr", status.Denied})
				AbortUnauthorized(c)
				return
			}
		}

		event.AuditDebug([]string{clientIp, string(acl.ResourceCluster), "health check", status.Succeeded})

		c.JSON(http.StatusOK, NewHealthResponse("ok"))
	})
}