photoprism/internal/entity/label.go

220 lines
5.7 KiB
Go
Raw Normal View History

package entity
import (
"sync"
"time"
"github.com/gosimple/slug"
"github.com/jinzhu/gorm"
"github.com/photoprism/photoprism/internal/classify"
"github.com/photoprism/photoprism/internal/event"
"github.com/photoprism/photoprism/pkg/rnd"
"github.com/photoprism/photoprism/pkg/txt"
)
var labelMutex = sync.Mutex{}
type Labels []Label
// Label is used for photo, album and location categorization
type Label struct {
ID uint `gorm:"primary_key" json:"ID" yaml:"-"`
LabelUID string `gorm:"type:VARBINARY(42);unique_index;" json:"UID" yaml:"UID"`
LabelSlug string `gorm:"type:VARBINARY(255);unique_index;" json:"Slug" yaml:"-"`
CustomSlug string `gorm:"type:VARBINARY(255);index;" json:"CustomSlug" yaml:"-"`
LabelName string `gorm:"type:VARCHAR(255);" json:"Name" yaml:"Name"`
LabelPriority int `json:"Priority" yaml:"Priority,omitempty"`
LabelFavorite bool `json:"Favorite" yaml:"Favorite,omitempty"`
LabelDescription string `gorm:"type:TEXT;" json:"Description" yaml:"Description,omitempty"`
LabelNotes string `gorm:"type:TEXT;" json:"Notes" yaml:"Notes,omitempty"`
LabelCategories []*Label `gorm:"many2many:categories;association_jointable_foreignkey:category_id" json:"-" yaml:"-"`
PhotoCount int `gorm:"default:1" json:"PhotoCount" yaml:"-"`
CreatedAt time.Time `json:"CreatedAt" yaml:"-"`
UpdatedAt time.Time `json:"UpdatedAt" yaml:"-"`
DeletedAt *time.Time `sql:"index" json:"DeletedAt,omitempty" yaml:"-"`
New bool `gorm:"-" json:"-" yaml:"-"`
}
// BeforeCreate creates a random UID if needed before inserting a new row to the database.
func (m *Label) BeforeCreate(scope *gorm.Scope) error {
if rnd.IsUID(m.LabelUID, 'l') {
return nil
}
return scope.SetColumn("LabelUID", rnd.PPID('l'))
}
// NewLabel returns a new label.
func NewLabel(name string, priority int) *Label {
labelName := txt.Clip(name, txt.ClipDefault)
if labelName == "" {
labelName = "Unknown"
}
labelName = txt.Title(labelName)
labelSlug := slug.Make(txt.Clip(labelName, txt.ClipSlug))
result := &Label{
LabelSlug: labelSlug,
CustomSlug: labelSlug,
LabelName: labelName,
LabelPriority: priority,
PhotoCount: 1,
}
return result
}
// Save updates the existing or inserts a new label.
func (m *Label) Save() error {
labelMutex.Lock()
defer labelMutex.Unlock()
return Db().Save(m).Error
}
// Create inserts the label to the database.
func (m *Label) Create() error {
labelMutex.Lock()
defer labelMutex.Unlock()
return Db().Create(m).Error
}
// Delete removes the label from the database.
func (m *Label) Delete() error {
Db().Where("label_id = ? OR category_id = ?", m.ID, m.ID).Delete(&Category{})
Db().Where("label_id = ?", m.ID).Delete(&PhotoLabel{})
return Db().Delete(m).Error
}
// Deleted returns true if the label is deleted.
func (m *Label) Deleted() bool {
return m.DeletedAt != nil
}
// Restore restores the label in the database.
func (m *Label) Restore() error {
if m.Deleted() {
return UnscopedDb().Model(m).Update("DeletedAt", nil).Error
}
return nil
}
// Update a label property in the database.
func (m *Label) Update(attr string, value interface{}) error {
return UnscopedDb().Model(m).UpdateColumn(attr, value).Error
}
// FirstOrCreateLabel returns the existing label, inserts a new label or nil in case of errors.
func FirstOrCreateLabel(m *Label) *Label {
result := Label{}
if err := UnscopedDb().Where("label_slug = ? OR custom_slug = ?", m.LabelSlug, m.CustomSlug).First(&result).Error; err == nil {
return &result
} else if createErr := m.Create(); createErr == nil {
if m.LabelPriority >= 0 {
event.EntitiesCreated("labels", []*Label{m})
event.Publish("count.labels", event.Data{
"count": 1,
})
}
return m
} else if err := UnscopedDb().Where("label_slug = ? OR custom_slug = ?", m.LabelSlug, m.CustomSlug).First(&result).Error; err == nil {
return &result
} else {
2020-12-14 13:31:18 +01:00
log.Errorf("label: %s (find or create %s)", createErr, m.LabelSlug)
}
return nil
}
// FindLabel returns an existing row if exists.
func FindLabel(s string) *Label {
labelSlug := slug.Make(txt.Clip(s, txt.ClipSlug))
result := Label{}
if err := Db().Where("label_slug = ? OR custom_slug = ?", labelSlug, labelSlug).First(&result).Error; err == nil {
return &result
}
return nil
}
// AfterCreate sets the New column used for database callback
func (m *Label) AfterCreate(scope *gorm.Scope) error {
m.New = true
return nil
}
// SetName changes the label name.
func (m *Label) SetName(name string) {
newName := txt.Clip(name, txt.ClipDefault)
if newName == "" {
return
}
m.LabelName = txt.Title(newName)
m.CustomSlug = slug.Make(txt.Clip(name, txt.ClipSlug))
}
// UpdateClassify updates a label if necessary
func (m *Label) UpdateClassify(label classify.Label) error {
save := false
db := Db()
if m.LabelPriority != label.Priority {
m.LabelPriority = label.Priority
save = true
}
if m.CustomSlug == "" {
m.CustomSlug = m.LabelSlug
save = true
} else if m.LabelSlug == "" {
m.LabelSlug = m.CustomSlug
save = true
}
if m.CustomSlug == m.LabelSlug && label.Title() != m.LabelName {
m.SetName(label.Title())
save = true
}
if save {
if err := db.Save(m).Error; err != nil {
return err
}
}
// Add categories
for _, category := range label.Categories {
sn := FirstOrCreateLabel(NewLabel(txt.Title(category), -3))
if sn == nil {
continue
}
if sn.Deleted() {
continue
}
if err := db.Model(m).Association("LabelCategories").Append(sn).Error; err != nil {
return err
}
}
return nil
}
// Links returns all share links for this entity.
func (m *Label) Links() Links {
return FindLinks("", m.LabelUID)
}