Properly ping unsplash when using unsplash images
This commit is contained in:
parent
8f35b9d579
commit
03ef48a0ae
2 changed files with 65 additions and 33 deletions
|
@ -17,10 +17,22 @@
|
||||||
package unsplash
|
package unsplash
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"code.vikunja.io/web/handler"
|
||||||
"github.com/labstack/echo/v4"
|
"github.com/labstack/echo/v4"
|
||||||
"net/http"
|
"net/http"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
func unsplashImage(url string, c echo.Context) error {
|
||||||
|
resp, err := http.Get(url)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if resp.StatusCode > 399 {
|
||||||
|
return echo.ErrNotFound
|
||||||
|
}
|
||||||
|
return c.Stream(http.StatusOK, "image/jpg", resp.Body)
|
||||||
|
}
|
||||||
|
|
||||||
// ProxyUnsplashImage proxies a thumbnail from unsplash for privacy reasons.
|
// ProxyUnsplashImage proxies a thumbnail from unsplash for privacy reasons.
|
||||||
// @Summary Get an unsplash image
|
// @Summary Get an unsplash image
|
||||||
// @Description Get an unsplash image. **Returns json on error.**
|
// @Description Get an unsplash image. **Returns json on error.**
|
||||||
|
@ -33,15 +45,12 @@ import (
|
||||||
// @Failure 500 {object} models.Message "Internal error"
|
// @Failure 500 {object} models.Message "Internal error"
|
||||||
// @Router /backgrounds/unsplash/image/{image} [get]
|
// @Router /backgrounds/unsplash/image/{image} [get]
|
||||||
func ProxyUnsplashImage(c echo.Context) error {
|
func ProxyUnsplashImage(c echo.Context) error {
|
||||||
imageID := c.Param("image")
|
photo, err := getUnsplashPhotoInfoByID(c.Param("image"))
|
||||||
resp, err := http.Get("https://images.unsplash.com/photo-" + imageID + "?ixlib=rb-1.2.1&fm=jpg&ixid=eyJhcHBfaWQiOjcyODAwfQ")
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return handler.HandleHTTPError(err, c)
|
||||||
}
|
}
|
||||||
if resp.StatusCode > 399 {
|
pingbackByPhotoID(photo.ID)
|
||||||
return echo.ErrNotFound
|
return unsplashImage(photo.Urls.Raw, c)
|
||||||
}
|
|
||||||
return c.Stream(http.StatusOK, "image/jpg", resp.Body)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// ProxyUnsplashThumb proxies a thumbnail from unsplash for privacy reasons.
|
// ProxyUnsplashThumb proxies a thumbnail from unsplash for privacy reasons.
|
||||||
|
@ -56,13 +65,10 @@ func ProxyUnsplashImage(c echo.Context) error {
|
||||||
// @Failure 500 {object} models.Message "Internal error"
|
// @Failure 500 {object} models.Message "Internal error"
|
||||||
// @Router /backgrounds/unsplash/image/{image}/thumb [get]
|
// @Router /backgrounds/unsplash/image/{image}/thumb [get]
|
||||||
func ProxyUnsplashThumb(c echo.Context) error {
|
func ProxyUnsplashThumb(c echo.Context) error {
|
||||||
imageID := c.Param("image")
|
photo, err := getUnsplashPhotoInfoByID(c.Param("image"))
|
||||||
resp, err := http.Get("https://images.unsplash.com/photo-" + imageID + "?ixlib=rb-1.2.1&q=80&fm=jpg&crop=entropy&cs=tinysrgb&w=200&fit=max&ixid=eyJhcHBfaWQiOjcyODAwfQ")
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return handler.HandleHTTPError(err, c)
|
||||||
}
|
}
|
||||||
if resp.StatusCode > 399 {
|
pingbackByPhotoID(photo.ID)
|
||||||
return echo.ErrNotFound
|
return unsplashImage("https://images.unsplash.com/photo-"+getImageID(photo.Urls.Raw)+"?ixlib=rb-1.2.1&q=80&fm=jpg&crop=entropy&cs=tinysrgb&w=200&fit=max&ixid=eyJhcHBfaWQiOjcyODAwfQ", c)
|
||||||
}
|
|
||||||
return c.Stream(http.StatusOK, "image/jpg", resp.Body)
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -31,6 +31,8 @@ import (
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const unsplashAPIURL = `https://api.unsplash.com/`
|
||||||
|
|
||||||
// Provider represents an unsplash image provider
|
// Provider represents an unsplash image provider
|
||||||
type Provider struct {
|
type Provider struct {
|
||||||
}
|
}
|
||||||
|
@ -65,6 +67,7 @@ type Photo struct {
|
||||||
Self string `json:"self"`
|
Self string `json:"self"`
|
||||||
HTML string `json:"html"`
|
HTML string `json:"html"`
|
||||||
Download string `json:"download"`
|
Download string `json:"download"`
|
||||||
|
DownloadLocation string `json:"download_location"`
|
||||||
} `json:"links"`
|
} `json:"links"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -87,8 +90,8 @@ func init() {
|
||||||
photos = make(map[string]*Photo)
|
photos = make(map[string]*Photo)
|
||||||
}
|
}
|
||||||
|
|
||||||
func doGet(url string, result interface{}) (err error) {
|
func doGet(url string, result ...interface{}) (err error) {
|
||||||
req, err := http.NewRequest("GET", "https://api.unsplash.com/"+url, nil)
|
req, err := http.NewRequest("GET", unsplashAPIURL+url, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
@ -100,7 +103,10 @@ func doGet(url string, result interface{}) (err error) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
err = json.NewDecoder(resp.Body).Decode(result)
|
if len(result) > 0 {
|
||||||
|
return json.NewDecoder(resp.Body).Decode(result[0])
|
||||||
|
}
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -116,6 +122,21 @@ func getImageID(fullURL string) string {
|
||||||
return parts[1]
|
return parts[1]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Gets an unsplash photo either from cache or directly from the unsplash api
|
||||||
|
func getUnsplashPhotoInfoByID(photoID string) (photo *Photo, err error) {
|
||||||
|
var exists bool
|
||||||
|
photo, exists = photos[photoID]
|
||||||
|
if !exists {
|
||||||
|
log.Debugf("Image information for unsplash photo %s not cached, requesting from unsplash...", photoID)
|
||||||
|
photo = &Photo{}
|
||||||
|
err = doGet("photos/"+photoID, photo)
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
// Search is the implementation to search on unsplash
|
// Search is the implementation to search on unsplash
|
||||||
// @Summary Search for a background from unsplash
|
// @Summary Search for a background from unsplash
|
||||||
// @Description Search for a list background from unsplash
|
// @Description Search for a list background from unsplash
|
||||||
|
@ -219,17 +240,10 @@ func (p *Provider) Search(search string, page int64) (result []*background.Image
|
||||||
func (p *Provider) Set(image *background.Image, list *models.List, auth web.Auth) (err error) {
|
func (p *Provider) Set(image *background.Image, list *models.List, auth web.Auth) (err error) {
|
||||||
|
|
||||||
// Find the photo
|
// Find the photo
|
||||||
var photo *Photo
|
photo, err := getUnsplashPhotoInfoByID(image.ID)
|
||||||
var exists bool
|
|
||||||
photo, exists = photos[image.ID]
|
|
||||||
if !exists {
|
|
||||||
log.Debugf("Image information for unsplash photo %s not cached, requesting from unsplash...", image.ID)
|
|
||||||
photo = &Photo{}
|
|
||||||
err = doGet("photos/"+image.ID, photo)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
// Download the photo from unsplash
|
// Download the photo from unsplash
|
||||||
// The parameters crop the image to a max width of 2560 and a max height of 2048 to save bandwidth and storage.
|
// The parameters crop the image to a max width of 2560 and a max height of 2048 to save bandwidth and storage.
|
||||||
|
@ -246,7 +260,14 @@ func (p *Provider) Set(image *background.Image, list *models.List, auth web.Auth
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Debugf("Downloaded Unsplash Photo %s", image.ID)
|
log.Debugf("Downloaded unsplash photo %s", image.ID)
|
||||||
|
|
||||||
|
// Ping the unsplash download endpoint (again, unsplash api guidelines)
|
||||||
|
err = doGet(strings.Replace(photo.Links.DownloadLocation, unsplashAPIURL, "", 1))
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
log.Debugf("Pinged unsplash download endpoint for photo %s", image.ID)
|
||||||
|
|
||||||
// Save it as a file in vikunja
|
// Save it as a file in vikunja
|
||||||
file, err := files.Create(resp.Body, "", 0, auth)
|
file, err := files.Create(resp.Body, "", 0, auth)
|
||||||
|
@ -296,8 +317,13 @@ func Pingback(f *files.File) {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Do the ping
|
// Do the ping
|
||||||
if _, err := http.Get("https://views.unsplash.com/v?app_id=" + config.BackgroundsUnsplashApplicationID.GetString() + "&photo_id=" + unsplashPhoto.UnsplashID); err != nil {
|
pingbackByPhotoID(unsplashPhoto.UnsplashID)
|
||||||
|
}
|
||||||
|
|
||||||
|
func pingbackByPhotoID(photoID string) {
|
||||||
|
if _, err := http.Get("https://views.unsplash.com/v?app_id=" + config.BackgroundsUnsplashApplicationID.GetString() + "&photo_id=" + photoID); err != nil {
|
||||||
log.Errorf("Unsplash Pingback Failed: %s", err.Error())
|
log.Errorf("Unsplash Pingback Failed: %s", err.Error())
|
||||||
}
|
}
|
||||||
log.Debugf("Pinged unsplash for photo %s", unsplashPhoto.UnsplashID)
|
log.Debugf("Pinged unsplash for photo %s", photoID)
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue