vikunja/pkg/routes/api/v2/backgrounds.go

// Vikunja is a to-do list application to facilitate your life.
// Copyright 2018-present Vikunja and contributors. All rights reserved.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

package apiv2

import (
	"context"
	"net/http"

	"code.vikunja.io/api/pkg/config"
	"code.vikunja.io/api/pkg/db"
	"code.vikunja.io/api/pkg/models"
	"code.vikunja.io/api/pkg/modules/background"
	"code.vikunja.io/api/pkg/modules/background/unsplash"

	"github.com/danielgtaylor/huma/v2"
)

type backgroundSearchBody struct {
	Body Paginated[*background.Image]
}

// RegisterBackgroundRoutes wires the project-background actions onto the Huma
// API. BackgroundsEnabled / BackgroundsUnsplashEnabled are static config, so the
// registrar early-returns instead of gating per request.
func RegisterBackgroundRoutes(api huma.API) {
	if !config.BackgroundsEnabled.GetBool() {
		return
	}

	tags := []string{"project"}

	Register(api, huma.Operation{
		OperationID: "projects-background-delete",
		Summary:     "Remove a project background",
		Description: "Removes a project's background, whichever provider set it. Succeeds even when the project has no background. Requires write access to the project. Returns the updated project.",
		Method:      http.MethodDelete,
		Path:        "/projects/{project}/background",
		// Return the updated project with 200, not the wrapper's DELETE default 204.
		DefaultStatus: http.StatusOK,
		Tags:          tags,
	}, backgroundRemove)

	if config.BackgroundsUnsplashEnabled.GetBool() {
		Register(api, huma.Operation{
			OperationID: "backgrounds-unsplash-search",
			Summary:     "Search Unsplash backgrounds",
			Description: "Searches Unsplash for background images. With an empty query it returns the featured wallpaper collection. Results are paginated by Unsplash; total counts are not available.",
			Method:      http.MethodGet,
			Path:        "/backgrounds/unsplash/search",
			Tags:        tags,
		}, backgroundUnsplashSearch)

		Register(api, huma.Operation{
			OperationID: "projects-background-unsplash-set",
			Summary:     "Set an Unsplash image as project background",
			Description: "Sets a previously searched Unsplash image as the project's background, identified by the image id from the search results. Requires write access to the project.",
			Method:      http.MethodPut,
			Path:        "/projects/{project}/backgrounds/unsplash",
			Tags:        tags,
		}, backgroundUnsplashSet)
	}
}

func init() { AddRouteRegistrar(RegisterBackgroundRoutes) }

func backgroundUnsplashSearch(ctx context.Context, in *struct {
	Q    string `query:"q" doc:"Search query; empty returns the featured wallpaper collection."`
	Page int64  `query:"page" default:"1" minimum:"1" doc:"1-based page number."`
}) (*backgroundSearchBody, error) {
	if _, err := authFromCtx(ctx); err != nil {
		return nil, err
	}

	page := in.Page
	if page < 1 {
		page = 1
	}

	s := db.NewSession()
	defer s.Close()

	p := &unsplash.Provider{}
	result, err := p.Search(s, in.Q, page)
	if err != nil {
		_ = s.Rollback()
		return nil, translateDomainError(err)
	}
	if err := s.Commit(); err != nil {
		return nil, translateDomainError(err)
	}

	// Unsplash paginates server-side and p.Search discards the total, so the
	// envelope's total is just this page's length (v1 returned a bare array).
	return &backgroundSearchBody{Body: NewPaginated(result, int64(len(result)), int(page), len(result))}, nil
}

func backgroundUnsplashSet(ctx context.Context, in *struct {
	ProjectID int64 `path:"project"`
	Body      background.Image
}) (*singleBody[models.Project], error) {
	a, err := authFromCtx(ctx)
	if err != nil {
		return nil, err
	}

	s := db.NewSession()
	defer s.Close()

	project := &models.Project{ID: in.ProjectID}
	can, err := project.CanUpdate(s, a)
	if err != nil {
		_ = s.Rollback()
		return nil, translateDomainError(err)
	}
	if !can {
		_ = s.Rollback()
		return nil, huma.Error403Forbidden("forbidden")
	}
	project, err = models.GetProjectSimpleByID(s, in.ProjectID)
	if err != nil {
		_ = s.Rollback()
		return nil, translateDomainError(err)
	}

	p := &unsplash.Provider{}
	if err := p.Set(s, &in.Body, project, a); err != nil {
		_ = s.Rollback()
		return nil, translateDomainError(err)
	}
	if err := project.ReadOne(s, a); err != nil {
		_ = s.Rollback()
		return nil, translateDomainError(err)
	}
	if err := s.Commit(); err != nil {
		return nil, translateDomainError(err)
	}

	return &singleBody[models.Project]{Body: project}, nil
}

func backgroundRemove(ctx context.Context, in *struct {
	ProjectID int64 `path:"project"`
}) (*singleBody[models.Project], error) {
	a, err := authFromCtx(ctx)
	if err != nil {
		return nil, err
	}

	s := db.NewSession()
	defer s.Close()

	project := &models.Project{ID: in.ProjectID}
	can, err := project.CanUpdate(s, a)
	if err != nil {
		_ = s.Rollback()
		return nil, translateDomainError(err)
	}
	if !can {
		_ = s.Rollback()
		return nil, huma.Error403Forbidden("forbidden")
	}

	if err := project.DeleteBackgroundFileIfExists(s); err != nil {
		_ = s.Rollback()
		return nil, translateDomainError(err)
	}
	if err := models.ClearProjectBackground(s, project.ID); err != nil {
		_ = s.Rollback()
		return nil, translateDomainError(err)
	}
	if err := s.Commit(); err != nil {
		return nil, translateDomainError(err)
	}

	return &singleBody[models.Project]{Body: project}, nil
}