Files
photoprism/internal/api/places_search.go
2025-07-03 12:58:20 +02:00

72 lines
2.1 KiB
Go

package api
import (
"net/http"
"github.com/gin-gonic/gin"
"github.com/photoprism/photoprism/internal/auth/acl"
"github.com/photoprism/photoprism/internal/photoprism/get"
"github.com/photoprism/photoprism/internal/service/hub/places"
"github.com/photoprism/photoprism/pkg/clean"
"github.com/photoprism/photoprism/pkg/txt"
)
// GetPlacesSearch returns locations that match the specified search query.
//
// GET /api/v1/places/search?q=query&locale=en&count=10
//
// @Summary returns locations that match the specified search query
// @Id GetPlacesSearch
// @Tags Places
// @Produce json
// @Param q query string true "Search query"
// @Param locale query string false "Locale for results (default: en)"
// @Param count query int false "Maximum number of results (default: 10, max: 50)"
// @Success 200 {object} places.SearchResults
// @Failure 400 {object} gin.H "Missing search query"
// @Failure 401 {object} i18n.Response
// @Failure 500 {object} gin.H "Search service error"
// @Router /api/v1/places/search [get]
func GetPlacesSearch(router *gin.RouterGroup) {
handler := func(c *gin.Context) {
// Allow request if user is allowed to search places.
s := AuthAny(c, acl.ResourcePlaces, acl.Permissions{acl.ActionSearch, acl.ActionView, acl.ActionUse})
// Abort if permission is not granted.
if s.Abort(c) {
return
}
// Abort if geocoding is disabled.
conf := get.Config()
if conf.DisablePlaces() {
AbortFeatureDisabled(c)
return
}
// Get the search string, locale, and result count limit from the query parameters.
query := clean.SearchString(c.Query("q"))
locale := clean.WebLocale(c.Query("locale"), conf.PlacesLocale())
count := txt.IntVal(c.Query("count"), 1, 50, 10)
if query == "" {
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "Missing search query"})
return
}
results, err := places.Search(query, locale, count)
if err != nil {
log.Errorf("places: failed to find locations for query %s", clean.Log(query))
c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err})
return
}
c.JSON(http.StatusOK, results)
}
router.GET("/places/search", handler)
}