photoprism/internal/api/places_reverse.go

package api

import (
	"encoding/json"
	"fmt"
	"net/http"
	"time"

	"github.com/gin-gonic/gin"

	"github.com/photoprism/photoprism/internal/auth/acl"
	"github.com/photoprism/photoprism/internal/event"
	"github.com/photoprism/photoprism/pkg/txt"
)

// ReverseGeocodeResponse represents the response structure for the reverse geocode API.
type ReverseGeocodeResponse struct {
	Formatted string `json:"formatted"`
	Street    string `json:"street"`
}

// PhotoPrismPlacesResponse represents the response from the PhotoPrism Places API
type PhotoPrismPlacesResponse struct {
	Street string `json:"street"`
	Place  struct {
		Label    string `json:"label"`
		District string `json:"district"`
		City     string `json:"city"`
		State    string `json:"state"`
		Country  string `json:"country"`
	} `json:"place"`
}

// GetPlacesReverse performs a reverse geocoding lookup using PhotoPrism Places API.
//
// GET /api/v1/places/reverse?lat=12.444526469291622&lng=-69.94435584903263
//
//	@Summary	Reverse geocodes coordinates to a place name
//	@Id			GetPlacesReverse
//	@Tags		Maps
//	@Produce	json
//	@Param		lat	query		string	true	"Latitude"
//	@Param		lng	query		string	true	"Longitude"
//	@Success	200	{object}	ReverseGeocodeResponse
//	@Failure	400	{object}	gin.H	"Missing latitude or longitude"
//	@Failure	401	{object}	i18n.Response
//	@Failure	500	{object}	gin.H	"Geocoding service error"
//	@Router		/api/v1/places/reverse [get]
func GetPlacesReverse(router *gin.RouterGroup) {
	handler := func(c *gin.Context) {
		s := AuthAny(c, acl.ResourcePlaces, acl.Permissions{acl.ActionSearch, acl.ActionView})

		// Abort if permission is not granted.
		if s.Abort(c) {
			return
		}

		// Parse latitude and longitude
		var lat, lng string

		if lat = txt.Numeric(c.Query("lat")); lat == "" {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing latitude"})
			return
		}

		if lng = txt.Numeric(c.Query("lng")); lng == "" {
			lng = txt.Numeric(c.Query("lon"))
		}

		if lng == "" {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing longitude"})
			return
		}

		// Log request
		event.AuditInfo([]string{ClientIP(c), "session %s", "reverse geocoding", "lat %s, lng %s"}, s.RefID, lat, lng)

		// Create HTTP client with timeout
		client := &http.Client{Timeout: 30 * time.Second}

		// Create PhotoPrism Places API request
		url := fmt.Sprintf("https://places.photoprism.app/v1/reverse?lat=%s&lng=%s", lat, lng)
		req, err := http.NewRequest("GET", url, nil)
		if err != nil {
			event.AuditWarn([]string{ClientIP(c), "session %s", "reverse geocoding", "error creating request: %s"}, s.RefID, err)
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": "Failed to create geocoding request"})
			return
		}

		// Execute request
		resp, err := client.Do(req)
		if err != nil {
			event.AuditWarn([]string{ClientIP(c), "session %s", "reverse geocoding", "request failed: %s"}, s.RefID, err)
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": "Geocoding service unavailable"})
			return
		}
		defer resp.Body.Close()

		// Check status code
		if resp.StatusCode != http.StatusOK {
			event.AuditWarn([]string{ClientIP(c), "session %s", "reverse geocoding", "status code %d"}, s.RefID, resp.StatusCode)
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": fmt.Sprintf("Geocoding service returned status code %d", resp.StatusCode)})
			return
		}

		// Parse response
		var placesResponse PhotoPrismPlacesResponse
		if err = json.NewDecoder(resp.Body).Decode(&placesResponse); err != nil {
			event.AuditWarn([]string{ClientIP(c), "session %s", "reverse geocoding", "decode failed: %s"}, s.RefID, err)
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": "Failed to decode geocoding response"})
			return
		}

		// Prepare response
		geocodeResponse := ReverseGeocodeResponse{
			Formatted: placesResponse.Place.Label,
			Street:    placesResponse.Street,
		}

		c.JSON(http.StatusOK, geocodeResponse)
	}

	router.GET("/places/reverse", handler)
}