List Backgrounds (#568)

Return the updated list when setting a list background

Add swagger docs for unsplash methods

Add unsplash info to search results

Fix misspell

Fix lint

Add rights check for setting and getting backgrounds

Show unsplash information when loading a single list

Make application id for pingbacks configurable

Remove old backgrounds when setting a new one

Return 404 if the list does not have a background

Implement getting list backgrounds

Implement actually setting a photo from unsplash as list background

go mod tidy

Add migration for background file id

Roughly implement setting a list background from unsplash

Implement saving a background

Add migration for unsplash photo table

Add unsplash search

Fix parsing page param

Fix parsing page param

Fix background config

Add unsplash wrapper library

Add enabled background providers to info endpoint

Add config options for backgrounds

Add unsplash background provider

Add routing handler for backgrounds

Add basic background provider interface

Co-authored-by: kolaente <k@knt.li>
Reviewed-on: https://kolaente.dev/vikunja/api/pulls/568

pkg/models/list.go

@@ -17,6 +17,7 @@
 package models
 
 import (
+	"code.vikunja.io/api/pkg/files"
 	"code.vikunja.io/api/pkg/metrics"
 	"code.vikunja.io/api/pkg/timeutil"
 	"code.vikunja.io/api/pkg/user"
@@ -51,6 +52,11 @@ type List struct {
 	// Whether or not a list is archived.
 	IsArchived bool `xorm:"not null default false" json:"is_archived" query:"is_archived"`
 
+	// The id of the file this list has set as background
+	BackgroundFileID int64 `xorm:"null" json:"-"`
+	// Holds extra information about the background set since some background providers require attribution or similar. If not null, the background can be accessed at /lists/{listID}/background
+	BackgroundInformation interface{} `xorm:"-" json:"background_information"`
+
 	// A timestamp when this list was created. You cannot change this value.
 	Created timeutil.TimeStamp `xorm:"created not null" json:"created"`
 	// A timestamp when this list was last updated. You cannot change this value.
@@ -166,6 +172,16 @@ func (l *List) ReadOne() (err error) {
 			l.IsArchived = true
 		}
 	}
+
+	// Get any background information if there is one set
+	if l.BackgroundFileID != 0 {
+		// Currently unsplash only
+		l.BackgroundInformation, err = GetUnsplashPhotoByFileID(l.BackgroundFileID)
+		if err != nil && !files.IsErrFileIsNotUnsplashFile(err) {
+			return
+		}
+	}
+
 	return nil
 }
 
@@ -560,3 +576,16 @@ func (l *List) Delete() (err error) {
 	_, err = x.Where("list_id = ?", l.ID).Delete(&Task{})
 	return
 }
+
+// SetListBackground sets a background file as list background in the db
+func SetListBackground(listID int64, background *files.File) (err error) {
+	l := &List{
+		ID:               listID,
+		BackgroundFileID: background.ID,
+	}
+	_, err = x.
+		Where("id = ?", l.ID).
+		Cols("background_file_id").
+		Update(l)
+	return
+}

pkg/models/unsplash.go

@@ -0,0 +1,64 @@
+// Vikunja is a to-do list application to facilitate your life.
+// Copyright 2018-2020 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 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 General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package models
+
+import "code.vikunja.io/api/pkg/files"
+
+// Unsplash requires us to do pingbacks to their site and also name the image author.
+// To do this properly, we need to save these information somewhere.
+
+// UnsplashPhoto is an unsplash photo in the db
+type UnsplashPhoto struct {
+	ID         int64  `xorm:"autoincr not null unique pk" json:"id,omitempty"`
+	FileID     int64  `xorm:"not null" json:"-"`
+	UnsplashID string `xorm:"varchar(50)" json:"unsplash_id"`
+	Author     string `xorm:"text" json:"author"`
+	AuthorName string `xorm:"text" json:"author_name"`
+}
+
+// TableName contains the table name for an unsplash photo
+func (u *UnsplashPhoto) TableName() string {
+	return "unsplash_photos"
+}
+
+// Save persists an unsplash photo to the db
+func (u *UnsplashPhoto) Save() error {
+	_, err := x.Insert(u)
+	return err
+}
+
+// GetUnsplashPhotoByFileID returns an unsplash photo by its saved file id
+func GetUnsplashPhotoByFileID(fileID int64) (u *UnsplashPhoto, err error) {
+	u = &UnsplashPhoto{}
+	exists, err := x.Where("file_id = ?", fileID).Get(u)
+	if err != nil {
+		return
+	}
+	if !exists {
+		return nil, files.ErrFileIsNotUnsplashFile{FileID: fileID}
+	}
+	return
+}
+
+// RemoveUnsplashPhoto removes an unsplash photo from the db
+func RemoveUnsplashPhoto(fileID int64) (err error) {
+	// This is intentionally "fire and forget" which is why we don't check if we have an
+	// unsplash entry for that file at all. If there is one, it will be deleted.
+	// We do this to keep the function simple.
+	_, err = x.Where("file_id = ?", fileID).Delete(&UnsplashPhoto{})
+	return
+}