mirror of
https://github.com/photoprism/photoprism.git
synced 2025-10-07 09:41:16 +08:00
144 lines
3.6 KiB
Go
144 lines
3.6 KiB
Go
/*
|
|
Package workers provides index, sync, and metadata optimization background workers.
|
|
|
|
Copyright (c) 2018 - 2025 PhotoPrism UG. All rights reserved.
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under Version 3 of the GNU Affero General Public License (the "AGPL"):
|
|
<https://docs.photoprism.app/license/agpl>
|
|
|
|
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.
|
|
|
|
The AGPL is supplemented by our Trademark and Brand Guidelines,
|
|
which describe how our Brand Assets may be used:
|
|
<https://www.photoprism.app/trademark>
|
|
|
|
Feel free to send an email to hello@photoprism.app if you have questions,
|
|
want to support our work, or just want to say hello.
|
|
|
|
Additional information can be found in our Developer Guide:
|
|
<https://docs.photoprism.app/developer-guide/>
|
|
*/
|
|
package workers
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/go-co-op/gocron/v2"
|
|
|
|
"github.com/photoprism/photoprism/internal/config"
|
|
"github.com/photoprism/photoprism/internal/entity"
|
|
"github.com/photoprism/photoprism/internal/event"
|
|
"github.com/photoprism/photoprism/internal/mutex"
|
|
)
|
|
|
|
var log = event.Log
|
|
var stop = make(chan bool, 1)
|
|
|
|
// Start starts the execution of background workers and scheduled tasks based on the current configuration.
|
|
func Start(conf *config.Config) {
|
|
if scheduler, err := gocron.NewScheduler(gocron.WithLocation(conf.DefaultTimezone())); err != nil {
|
|
log.Errorf("scheduler: %s (start)", err)
|
|
return
|
|
} else if scheduler != nil {
|
|
Scheduler = scheduler
|
|
|
|
// Schedule backup job.
|
|
if err = NewJob("backup", conf.BackupSchedule(), NewBackup(conf).StartScheduled); err != nil {
|
|
log.Errorf("scheduler: %s (backup)", err)
|
|
}
|
|
|
|
// Schedule indexing job.
|
|
if err = NewJob("index", conf.IndexSchedule(), NewIndex(conf).StartScheduled); err != nil {
|
|
log.Errorf("scheduler: %s (index)", err)
|
|
}
|
|
|
|
// Start the scheduler.
|
|
Scheduler.Start()
|
|
}
|
|
|
|
// Start the other background workers.
|
|
interval := conf.WakeupInterval()
|
|
|
|
// Other workers can be disabled in safe mode by setting the execution interval to a value < 1.
|
|
if interval.Seconds() <= 0 {
|
|
log.Warnf("config: disabled metadata, share & sync background workers")
|
|
return
|
|
}
|
|
|
|
ticker := time.NewTicker(interval)
|
|
|
|
go func() {
|
|
for {
|
|
select {
|
|
case <-stop:
|
|
ticker.Stop()
|
|
mutex.MetaWorker.Cancel()
|
|
mutex.ShareWorker.Cancel()
|
|
mutex.SyncWorker.Cancel()
|
|
return
|
|
case <-ticker.C:
|
|
RunMeta(conf)
|
|
RunShare(conf)
|
|
RunSync(conf)
|
|
}
|
|
}
|
|
}()
|
|
}
|
|
|
|
// Shutdown stops the background workers and scheduled tasks.
|
|
func Shutdown() {
|
|
log.Info("shutting down workers")
|
|
|
|
stop <- true
|
|
|
|
if Scheduler != nil {
|
|
if err := Scheduler.Shutdown(); err != nil {
|
|
log.Warnf("scheduler: %s (shutdown)", err)
|
|
}
|
|
}
|
|
}
|
|
|
|
// RunMeta runs the metadata worker once.
|
|
func RunMeta(conf *config.Config) {
|
|
if !mutex.WorkersRunning() {
|
|
go func() {
|
|
worker := NewMeta(conf)
|
|
|
|
delay := time.Minute
|
|
interval := entity.MetadataUpdateInterval
|
|
|
|
if err := worker.Start(delay, interval, false); err != nil {
|
|
log.Warnf("metadata: %s", err)
|
|
}
|
|
}()
|
|
}
|
|
}
|
|
|
|
// RunShare runs the share worker once.
|
|
func RunShare(conf *config.Config) {
|
|
if !mutex.ShareWorker.Running() {
|
|
go func() {
|
|
worker := NewShare(conf)
|
|
if err := worker.Start(); err != nil {
|
|
log.Warnf("share: %s", err)
|
|
}
|
|
}()
|
|
}
|
|
}
|
|
|
|
// RunSync runs the sync worker once.
|
|
func RunSync(conf *config.Config) {
|
|
if !mutex.SyncWorker.Running() {
|
|
go func() {
|
|
worker := NewSync(conf)
|
|
if err := worker.Start(); err != nil {
|
|
log.Warnf("sync: %s", err)
|
|
}
|
|
}()
|
|
}
|
|
}
|