astra
/
photoprism-client-go
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adding sample auth code that will most likely change and api implementation 

Signed-off-by: Kris Nóva <kris@nivenly.com>
main
Kris Nóva 2021-01-31 00:08:52 -08:00
parent ef15a0ac15
commit 95794522e0
7 changed files with 279 additions and 278 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,2 +1,5 @@
# photoprism-client-go # Photoprism Client Go
Go client for the Photoprism Application
Go client for the Photoprism Application.
Bugs: Kris Nóva <kris@nivenly.com>

5
api/v1/client.go
View File

@ -0,0 +1,5 @@
package api
type V1Client struct {
//
}

60
api/v1/file.go
View File

@ -0,0 +1,60 @@
package api
import "time"
type Files []File
// File represents an image or sidecar file that belongs to a photo.
type File struct {
ID uint `gorm:"primary_key" json:"-" yaml:"-"`
Photo *Photo `json:"-" yaml:"-"`
PhotoID uint `gorm:"index;" json:"-" yaml:"-"`
PhotoUID string `gorm:"type:VARBINARY(42);index;" json:"PhotoUID" yaml:"PhotoUID"`
InstanceID string `gorm:"type:VARBINARY(42);index;" json:"InstanceID,omitempty" yaml:"InstanceID,omitempty"`
FileUID string `gorm:"type:VARBINARY(42);unique_index;" json:"UID" yaml:"UID"`
FileName string `gorm:"type:VARBINARY(755);unique_index:idx_files_name_root;" json:"Name" yaml:"Name"`
FileRoot string `gorm:"type:VARBINARY(16);default:'/';unique_index:idx_files_name_root;" json:"Root" yaml:"Root,omitempty"`
OriginalName string `gorm:"type:VARBINARY(755);" json:"OriginalName" yaml:"OriginalName,omitempty"`
FileHash string `gorm:"type:VARBINARY(128);index" json:"Hash" yaml:"Hash,omitempty"`
FileSize int64 `json:"Size" yaml:"Size,omitempty"`
FileCodec string `gorm:"type:VARBINARY(32)" json:"Codec" yaml:"Codec,omitempty"`
FileType string `gorm:"type:VARBINARY(32)" json:"Type" yaml:"Type,omitempty"`
FileMime string `gorm:"type:VARBINARY(64)" json:"Mime" yaml:"Mime,omitempty"`
FilePrimary bool `json:"Primary" yaml:"Primary,omitempty"`
FileSidecar bool `json:"Sidecar" yaml:"Sidecar,omitempty"`
FileMissing bool `json:"Missing" yaml:"Missing,omitempty"`
FilePortrait bool `json:"Portrait" yaml:"Portrait,omitempty"`
FileVideo bool `json:"Video" yaml:"Video,omitempty"`
FileDuration time.Duration `json:"Duration" yaml:"Duration,omitempty"`
FileWidth int `json:"Width" yaml:"Width,omitempty"`
FileHeight int `json:"Height" yaml:"Height,omitempty"`
FileOrientation int `json:"Orientation" yaml:"Orientation,omitempty"`
FileProjection string `gorm:"type:VARBINARY(16);" json:"Projection,omitempty" yaml:"Projection,omitempty"`
FileAspectRatio float32 `gorm:"type:FLOAT;" json:"AspectRatio" yaml:"AspectRatio,omitempty"`
FileMainColor string `gorm:"type:VARBINARY(16);index;" json:"MainColor" yaml:"MainColor,omitempty"`
FileColors string `gorm:"type:VARBINARY(9);" json:"Colors" yaml:"Colors,omitempty"`
FileLuminance string `gorm:"type:VARBINARY(9);" json:"Luminance" yaml:"Luminance,omitempty"`
FileDiff uint32 `json:"Diff" yaml:"Diff,omitempty"`
FileChroma uint8 `json:"Chroma" yaml:"Chroma,omitempty"`
FileError string `gorm:"type:VARBINARY(512)" json:"Error" yaml:"Error,omitempty"`
ModTime int64 `json:"ModTime" yaml:"-"`
CreatedAt time.Time `json:"CreatedAt" yaml:"-"`
CreatedIn int64 `json:"CreatedIn" yaml:"-"`
UpdatedAt time.Time `json:"UpdatedAt" yaml:"-"`
UpdatedIn int64 `json:"UpdatedIn" yaml:"-"`
DeletedAt *time.Time `sql:"index" json:"DeletedAt,omitempty" yaml:"-"`
//Share []FileShare `json:"-" yaml:"-"`
//Sync []FileSync `json:"-" yaml:"-"`
}
type FileInfos struct {
FileWidth int
FileHeight int
FileOrientation int
FileAspectRatio float32
FileMainColor string
FileColors string
FileLuminance string
FileDiff uint32
FileChroma uint8
}

21
api/v1/meta.go
View File

@ -0,0 +1,21 @@
package api
import "net/http"
type Meta struct {
requested bool
response *http.Response
}
// TODO We need an http.Client and an object interface{}
func (m *Meta) Request() error {
m.requested = true
return nil
}
func (m *Meta) Response() *http.Response {
if !m.requested {
return nil
}
return m.response
}

396
api/v1/photo.go
View File

@ -1,274 +1,153 @@
package api package api
import ( import (
"net/http" "fmt"
"time"
"github.com/gin-gonic/gin"
"github.com/photoprism/photoprism/internal/acl"
"github.com/photoprism/photoprism/internal/entity"
"github.com/photoprism/photoprism/internal/event"
"github.com/photoprism/photoprism/internal/form"
"github.com/photoprism/photoprism/internal/i18n"
"github.com/photoprism/photoprism/internal/photoprism"
"github.com/photoprism/photoprism/internal/query"
"github.com/photoprism/photoprism/pkg/fs"
"github.com/photoprism/photoprism/pkg/txt"
) )
// GET /api/v1/photos/:uid // Photo represents a photo, all its properties, and link to all its images and sidecar files.
type Photo struct {
Meta
ID uint `gorm:"primary_key" yaml:"-"`
UUID string `gorm:"type:VARBINARY(42);index;" json:"DocumentID,omitempty" yaml:"DocumentID,omitempty"`
TakenAt time.Time `gorm:"type:datetime;index:idx_photos_taken_uid;" json:"TakenAt" yaml:"TakenAt"`
TakenAtLocal time.Time `gorm:"type:datetime;" yaml:"-"`
TakenSrc string `gorm:"type:VARBINARY(8);" json:"TakenSrc" yaml:"TakenSrc,omitempty"`
PhotoUID string `gorm:"type:VARBINARY(42);unique_index;index:idx_photos_taken_uid;" json:"UID" yaml:"UID"`
PhotoType string `gorm:"type:VARBINARY(8);default:'image';" json:"Type" yaml:"Type"`
TypeSrc string `gorm:"type:VARBINARY(8);" json:"TypeSrc" yaml:"TypeSrc,omitempty"`
PhotoTitle string `gorm:"type:VARCHAR(255);" json:"Title" yaml:"Title"`
TitleSrc string `gorm:"type:VARBINARY(8);" json:"TitleSrc" yaml:"TitleSrc,omitempty"`
PhotoDescription string `gorm:"type:TEXT;" json:"Description" yaml:"Description,omitempty"`
DescriptionSrc string `gorm:"type:VARBINARY(8);" json:"DescriptionSrc" yaml:"DescriptionSrc,omitempty"`
PhotoPath string `gorm:"type:VARBINARY(500);index:idx_photos_path_name;" json:"Path" yaml:"-"`
PhotoName string `gorm:"type:VARBINARY(255);index:idx_photos_path_name;" json:"Name" yaml:"-"`
OriginalName string `gorm:"type:VARBINARY(755);" json:"OriginalName" yaml:"OriginalName,omitempty"`
PhotoStack int8 `json:"Stack" yaml:"Stack,omitempty"`
PhotoFavorite bool `json:"Favorite" yaml:"Favorite,omitempty"`
PhotoPrivate bool `json:"Private" yaml:"Private,omitempty"`
PhotoScan bool `json:"Scan" yaml:"Scan,omitempty"`
PhotoPanorama bool `json:"Panorama" yaml:"Panorama,omitempty"`
TimeZone string `gorm:"type:VARBINARY(64);" json:"TimeZone" yaml:"-"`
PlaceID string `gorm:"type:VARBINARY(42);index;default:'zz'" json:"PlaceID" yaml:"-"`
PlaceSrc string `gorm:"type:VARBINARY(8);" json:"PlaceSrc" yaml:"PlaceSrc,omitempty"`
CellID string `gorm:"type:VARBINARY(42);index;default:'zz'" json:"CellID" yaml:"-"`
CellAccuracy int `json:"CellAccuracy" yaml:"CellAccuracy,omitempty"`
PhotoAltitude int `json:"Altitude" yaml:"Altitude,omitempty"`
PhotoLat float32 `gorm:"type:FLOAT;index;" json:"Lat" yaml:"Lat,omitempty"`
PhotoLng float32 `gorm:"type:FLOAT;index;" json:"Lng" yaml:"Lng,omitempty"`
PhotoCountry string `gorm:"type:VARBINARY(2);index:idx_photos_country_year_month;default:'zz'" json:"Country" yaml:"-"`
PhotoYear int `gorm:"index:idx_photos_country_year_month;" json:"Year" yaml:"Year"`
PhotoMonth int `gorm:"index:idx_photos_country_year_month;" json:"Month" yaml:"Month"`
PhotoDay int `json:"Day" yaml:"Day"`
PhotoIso int `json:"Iso" yaml:"ISO,omitempty"`
PhotoExposure string `gorm:"type:VARBINARY(64);" json:"Exposure" yaml:"Exposure,omitempty"`
PhotoFNumber float32 `gorm:"type:FLOAT;" json:"FNumber" yaml:"FNumber,omitempty"`
PhotoFocalLength int `json:"FocalLength" yaml:"FocalLength,omitempty"`
PhotoQuality int `gorm:"type:SMALLINT" json:"Quality" yaml:"-"`
PhotoResolution int `gorm:"type:SMALLINT" json:"Resolution" yaml:"-"`
PhotoColor uint8 `json:"Color" yaml:"-"`
CameraID uint `gorm:"index:idx_photos_camera_lens;default:1" json:"CameraID" yaml:"-"`
CameraSerial string `gorm:"type:VARBINARY(255);" json:"CameraSerial" yaml:"CameraSerial,omitempty"`
CameraSrc string `gorm:"type:VARBINARY(8);" json:"CameraSrc" yaml:"-"`
LensID uint `gorm:"index:idx_photos_camera_lens;default:1" json:"LensID" yaml:"-"`
//Details *Details `gorm:"association_autoupdate:false;association_autocreate:false;association_save_reference:false" json:"Details" yaml:"Details"`
//Camera *Camera `gorm:"association_autoupdate:false;association_autocreate:false;association_save_reference:false" json:"Camera" yaml:"-"`
//Lens *Lens `gorm:"association_autoupdate:false;association_autocreate:false;association_save_reference:false" json:"Lens" yaml:"-"`
//Cell *Cell `gorm:"association_autoupdate:false;association_autocreate:false;association_save_reference:false" json:"Cell" yaml:"-"`
//Place *Place `gorm:"association_autoupdate:false;association_autocreate:false;association_save_reference:false" json:"Place" yaml:"-"`
//Keywords []Keyword `json:"-" yaml:"-"`
//Albums []Album `json:"-" yaml:"-"`
//Files []File `yaml:"-"`
//Labels []PhotoLabel `yaml:"-"`
CreatedAt time.Time `yaml:"CreatedAt,omitempty"`
UpdatedAt time.Time `yaml:"UpdatedAt,omitempty"`
EditedAt *time.Time `yaml:"EditedAt,omitempty"`
CheckedAt *time.Time `sql:"index" yaml:"-"`
DeletedAt *time.Time `sql:"index" yaml:"DeletedAt,omitempty"`
}
// GET /api/v1/photos/:uuid
// //
// Parameters: // Parameters:
// uid: string PhotoUID as returned by the API // uuid: string PhotoUID as returned by the API
func GetPhoto(router *gin.RouterGroup) { func (c *V1Client) GetPhoto(uuid string) (*Photo, error) {
router.GET("/photos/:uid", func(c *gin.Context) { if uuid == "" {
s := Auth(SessionID(c), acl.ResourcePhotos, acl.ActionRead) return nil, fmt.Errorf("missing uuid for GetPhoto [GET /api/v1/photos/:uuid]")
}
if s.Invalid() { photo := &Photo{
AbortUnauthorized(c) UUID: uuid,
return }
} return photo, nil
p, err := query.PhotoPreloadByUID(c.Param("uid"))
if err != nil {
AbortEntityNotFound(c)
return
}
c.IndentedJSON(http.StatusOK, p)
})
} }
// PUT /api/v1/photos/:uid // PUT /api/v1/photos/:uid
func UpdatePhoto(router *gin.RouterGroup) { func (c *V1Client) UpdatePhoto(update *Photo) (*Photo, error) {
router.PUT("/photos/:uid", func(c *gin.Context) { if update.UUID == "" {
s := Auth(SessionID(c), acl.ResourcePhotos, acl.ActionUpdate) return nil, fmt.Errorf("missing uuid for UpdatePhoto [PUT /api/v1/photos/:uid]")
}
if s.Invalid() { ref := *update
AbortUnauthorized(c) updated := &ref
return // TODO Execute Request()
} return updated, nil
uid := c.Param("uid")
m, err := query.PhotoByUID(uid)
if err != nil {
AbortEntityNotFound(c)
return
}
// TODO: Proof-of-concept for form handling - might need refactoring
// 1) Init form with model values
f, err := form.NewPhoto(m)
if err != nil {
Abort(c, http.StatusInternalServerError, i18n.ErrSaveFailed)
return
}
// 2) Update form with values from request
if err := c.BindJSON(&f); err != nil {
Abort(c, http.StatusBadRequest, i18n.ErrBadRequest)
return
} else if f.PhotoPrivate {
FlushCoverCache()
}
// 3) Save model with values from form
if err := entity.SavePhotoForm(m, f); err != nil {
Abort(c, http.StatusInternalServerError, i18n.ErrSaveFailed)
return
}
PublishPhotoEvent(EntityUpdated, uid, c)
event.SuccessMsg(i18n.MsgChangesSaved)
p, err := query.PhotoPreloadByUID(uid)
if err != nil {
AbortEntityNotFound(c)
return
}
SavePhotoAsYaml(p)
c.JSON(http.StatusOK, p)
})
} }
// GET /api/v1/photos/:uid/dl // GET /api/v1/photos/:uuid/dl
// //
// Parameters: // Parameters:
// uid: string PhotoUID as returned by the API // uuid: string PhotoUUID as returned by the API
func GetPhotoDownload(router *gin.RouterGroup) { func (c *V1Client) GetPhotoDownload(uuid string) (*File, error) {
router.GET("/photos/:uid/dl", func(c *gin.Context) { if uuid == "" {
if InvalidDownloadToken(c) { return nil, fmt.Errorf("missing uuid for GetPhotoDownload [GET /api/v1/photos/:uuid/dl]")
c.Data(http.StatusForbidden, "image/svg+xml", brokenIconSvg) }
return file := &File{}
} return file, nil
f, err := query.FileByPhotoUID(c.Param("uid"))
if err != nil {
c.Data(http.StatusNotFound, "image/svg+xml", photoIconSvg)
return
}
fileName := photoprism.FileName(f.FileRoot, f.FileName)
if !fs.FileExists(fileName) {
log.Errorf("photo: file %s is missing", txt.Quote(f.FileName))
c.Data(http.StatusNotFound, "image/svg+xml", photoIconSvg)
// Set missing flag so that the file doesn't show up in search results anymore.
logError("photo", f.Update("FileMissing", true))
return
}
c.FileAttachment(fileName, f.DownloadName(DownloadName(c), 0))
})
} }
// GET /api/v1/photos/:uid/yaml // GET /api/v1/photos/:uuid/yaml
// //
// Parameters: // Parameters:
// uid: string PhotoUID as returned by the API // uuid: string PhotoUUID as returned by the API
func GetPhotoYaml(router *gin.RouterGroup) { func (c *V1Client) GetPhotoYaml(uuid string) (*Photo, error) {
router.GET("/photos/:uid/yaml", func(c *gin.Context) { if uuid == "" {
s := Auth(SessionID(c), acl.ResourcePhotos, acl.ActionExport) return nil, fmt.Errorf("missing uuid for GetPhotoYAML [GET /api/v1/photos/:uuid/yaml]")
}
if s.Invalid() { photo := &Photo{}
AbortUnauthorized(c) return photo, nil
return
}
p, err := query.PhotoPreloadByUID(c.Param("uid"))
if err != nil {
c.AbortWithStatus(http.StatusNotFound)
return
}
data, err := p.Yaml()
if err != nil {
c.AbortWithStatus(http.StatusInternalServerError)
return
}
if c.Query("download") != "" {
AddDownloadHeader(c, c.Param("uid")+fs.YamlExt)
}
c.Data(http.StatusOK, "text/x-yaml; charset=utf-8", data)
})
} }
// POST /api/v1/photos/:uid/approve // POST /api/v1/photos/:uuid/approve
// //
// Parameters: // Parameters:
// uid: string PhotoUID as returned by the API // uuid: string PhotoUUID as returned by the API
func ApprovePhoto(router *gin.RouterGroup) { func (c *V1Client) ApprovePhoto(uuid string) (*Photo, error) {
router.POST("/photos/:uid/approve", func(c *gin.Context) { if uuid == "" {
s := Auth(SessionID(c), acl.ResourcePhotos, acl.ActionUpdate) return nil, fmt.Errorf("missing uuid for ApprovePhoto [POST /api/v1/photos/:uuid/approve]")
}
if s.Invalid() { photo := &Photo{}
AbortUnauthorized(c) return photo, nil
return
}
id := c.Param("uid")
m, err := query.PhotoByUID(id)
if err != nil {
AbortEntityNotFound(c)
return
}
if err := m.Approve(); err != nil {
log.Errorf("photo: %s", err.Error())
AbortSaveFailed(c)
return
}
SavePhotoAsYaml(m)
PublishPhotoEvent(EntityUpdated, id, c)
c.JSON(http.StatusOK, gin.H{"photo": m})
})
} }
// POST /api/v1/photos/:uid/like // POST /api/v1/photos/:uid/like
// //
// Parameters: // Parameters:
// uid: string PhotoUID as returned by the API // uid: string PhotoUID as returned by the API
func LikePhoto(router *gin.RouterGroup) { func (c *V1Client) LikePhoto(uuid string) error {
router.POST("/photos/:uid/like", func(c *gin.Context) { if uuid == "" {
s := Auth(SessionID(c), acl.ResourcePhotos, acl.ActionLike) return fmt.Errorf("missing uuid for LikePhoto [POST /api/v1/photos/:uid/like]")
}
if s.Invalid() { return nil
AbortUnauthorized(c)
return
}
id := c.Param("uid")
m, err := query.PhotoByUID(id)
if err != nil {
AbortEntityNotFound(c)
return
}
if err := m.SetFavorite(true); err != nil {
log.Errorf("photo: %s", err.Error())
AbortSaveFailed(c)
return
}
SavePhotoAsYaml(m)
PublishPhotoEvent(EntityUpdated, id, c)
c.JSON(http.StatusOK, gin.H{"photo": m})
})
} }
// DELETE /api/v1/photos/:uid/like // DELETE /api/v1/photos/:uuid/like
// //
// Parameters: // Parameters:
// uid: string PhotoUID as returned by the API // uuid: string PhotoUUID as returned by the API
func DislikePhoto(router *gin.RouterGroup) { func (c *V1Client) DislikePhoto(uuid string) error {
router.DELETE("/photos/:uid/like", func(c *gin.Context) { if uuid == "" {
s := Auth(SessionID(c), acl.ResourcePhotos, acl.ActionLike) return fmt.Errorf("missing uuid for DislikePhoto [DELETE /api/v1/photos/:uuid/like]")
}
if s.Invalid() { return nil
AbortUnauthorized(c)
return
}
id := c.Param("uid")
m, err := query.PhotoByUID(id)
if err != nil {
AbortEntityNotFound(c)
return
}
if err := m.SetFavorite(false); err != nil {
log.Errorf("photo: %s", err.Error())
AbortSaveFailed(c)
return
}
SavePhotoAsYaml(m)
PublishPhotoEvent(EntityUpdated, id, c)
c.JSON(http.StatusOK, gin.H{"photo": m})
})
} }
// POST /api/v1/photos/:uid/files/:file_uid/primary // POST /api/v1/photos/:uid/files/:file_uid/primary
@ -276,35 +155,12 @@ func DislikePhoto(router *gin.RouterGroup) {
// Parameters: // Parameters:
// uid: string PhotoUID as returned by the API // uid: string PhotoUID as returned by the API
// file_uid: string File UID as returned by the API // file_uid: string File UID as returned by the API
func PhotoPrimary(router *gin.RouterGroup) { func (c *V1Client) PhotoPrimary(uuid, fileuuid string) error {
router.POST("/photos/:uid/files/:file_uid/primary", func(c *gin.Context) { if uuid == "" {
s := Auth(SessionID(c), acl.ResourcePhotos, acl.ActionUpdate) return fmt.Errorf("missing uuid for PhotoPrimary [POST /api/v1/photos/:uid/files/:file_uid/primary]")
}
if s.Invalid() { if fileuuid == "" {
AbortUnauthorized(c) return fmt.Errorf("missing fileuuid for PhotoPrimary [POST /api/v1/photos/:uid/files/:file_uid/primary]")
return }
} return nil
uid := c.Param("uid")
fileUID := c.Param("file_uid")
err := query.SetPhotoPrimary(uid, fileUID)
if err != nil {
AbortEntityNotFound(c)
return
}
PublishPhotoEvent(EntityUpdated, uid, c)
event.SuccessMsg(i18n.MsgChangesSaved)
p, err := query.PhotoPreloadByUID(uid)
if err != nil {
AbortEntityNotFound(c)
return
}
c.JSON(http.StatusOK, p)
})
} }

65
client.go
View File

@ -1,10 +1,65 @@
package photoprism_client_go package photoprism
type PhotoprismClient struct { import "github.com/kris-nova/client-go/api/v1"
//
type Client struct {
v1client *api.V1Client
} }
func New() *PhotoprismClient { type ClientAuthenticator interface {
p := &PhotoprismClient{} getKey() string
getSecret() string
}
// -- [ ClientAuthLogin ] --
// TODO We probably want to base64 encode this
type ClientAuthLogin struct {
user string
pass string
}
func NewClientAuthLogin(user, pass string) ClientAuthenticator {
return &ClientAuthLogin{
user: user,
pass: pass,
}
}
func (c *ClientAuthLogin) getKey() string {
return c.user
}
func (c *ClientAuthLogin) getSecret() string {
return c.pass
}
// -- [ ClientAuthToken ] --
// TODO We probably want to base64 encode this
type ClientAuthToken struct {
key string
secret string
}
func NewClientAuthToken(key, secret string) ClientAuthenticator {
return &ClientAuthToken{
key: key,
secret: secret,
}
}
func (c *ClientAuthToken) getKey() string {
return c.key
}
func (c *ClientAuthToken) getSecret() string {
return c.secret
}
func New(auth ClientAuthenticator) *Client {
p := &Client{}
return p return p
} }
func (c *Client) V1() *api.V1Client {
return c.v1client
}

3
examples/download_photo.go
View File

@ -25,7 +25,8 @@ func main() {
if pass == "" { if pass == "" {
halt(2, "Missing PHOTOPRISM_PASS") halt(2, "Missing PHOTOPRISM_PASS")
} }
photoclient := photoprism.New() login := photoprism.NewClientAuthLogin("username", "password")
photoclient := photoprism.New(login)
photo, err := photoclient.V1().GetPhoto("123") photo, err := photoclient.V1().GetPhoto("123")
if err != nil { if err != nil {
halt(3, "Error fetching photo: %v", err) halt(3, "Error fetching photo: %v", err)