package config import ( "crypto/tls" "encoding/hex" "fmt" "hash/crc32" "net/http" "net/url" "os" "path/filepath" "runtime" "strings" "sync" "time" "github.com/dustin/go-humanize" "github.com/jinzhu/gorm" _ "github.com/jinzhu/gorm/dialects/mysql" _ "github.com/jinzhu/gorm/dialects/sqlite" "github.com/klauspost/cpuid/v2" "github.com/pbnjay/memory" "github.com/sirupsen/logrus" "github.com/urfave/cli" "github.com/photoprism/photoprism/internal/customize" "github.com/photoprism/photoprism/internal/entity" "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/face" "github.com/photoprism/photoprism/internal/hub" "github.com/photoprism/photoprism/internal/hub/places" "github.com/photoprism/photoprism/internal/i18n" "github.com/photoprism/photoprism/internal/mutex" "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/internal/ttl" "github.com/photoprism/photoprism/pkg/clean" "github.com/photoprism/photoprism/pkg/fs" "github.com/photoprism/photoprism/pkg/rnd" ) var log = event.Log var once sync.Once var LowMem = false var TotalMem uint64 var crc32Castagnoli = crc32.MakeTable(crc32.Castagnoli) // Config holds database, cache and all parameters of photoprism type Config struct { once sync.Once cliCtx *cli.Context options *Options settings *customize.Settings db *gorm.DB hub *hub.Config token string serial string env string start bool } func init() { TotalMem = memory.TotalMemory() // Check available memory if not running in unsafe mode. if Env(EnvUnsafe) { // Disable features with high memory requirements? LowMem = TotalMem < MinMem } // Init public thumb sizes for use in client apps. for i := len(thumb.Names) - 1; i >= 0; i-- { name := thumb.Names[i] t := thumb.Sizes[name] if t.Public { Thumbs = append(Thumbs, ThumbSize{Size: string(name), Usage: t.Usage, Width: t.Width, Height: t.Height}) } } } func initLogger() { once.Do(func() { log.SetFormatter(&logrus.TextFormatter{ DisableColors: false, FullTimestamp: true, }) if Env(EnvProd) { log.SetLevel(logrus.WarnLevel) } else if Env(EnvTrace) { log.SetLevel(logrus.TraceLevel) } else if Env(EnvDebug) { log.SetLevel(logrus.DebugLevel) } else { log.SetLevel(logrus.InfoLevel) } }) } // NewConfig initialises a new configuration file func NewConfig(ctx *cli.Context) *Config { start := false if ctx != nil { start = ctx.Command.Name == "start" } // Initialize logger. initLogger() // Initialize options from config file and CLI context. c := &Config{ cliCtx: ctx, options: NewOptions(ctx), token: rnd.GenerateToken(8), env: os.Getenv("DOCKER_ENV"), start: start, } // Overwrite values with options.yml from config path. if optionsYaml := c.OptionsYaml(); fs.FileExists(optionsYaml) { if err := c.options.Load(optionsYaml); err != nil { log.Warnf("config: failed loading values from %s (%s)", clean.Log(optionsYaml), err) } else { log.Debugf("config: overriding config with values from %s", clean.Log(optionsYaml)) } } Ext().Init(c) return c } // Unsafe checks if unsafe settings are allowed. func (c *Config) Unsafe() bool { return c.options.Unsafe } // Restart checks if the application should be restarted, e.g. after an update or a config changes. func (c *Config) Restart() bool { return mutex.Restart.Load() } // CliContext returns the cli context if set. func (c *Config) CliContext() *cli.Context { if c.cliCtx == nil { log.Warnf("config: cli context not set - you may have found a bug") } return c.cliCtx } // CliGlobalString returns a global cli string flag value if set. func (c *Config) CliGlobalString(name string) string { if c.cliCtx == nil { return "" } return c.cliCtx.GlobalString(name) } // Options returns the raw config options. func (c *Config) Options() *Options { if c.options == nil { log.Warnf("config: options should not be nil - you may have found a bug") c.options = NewOptions(nil) } return c.options } // Propagate updates config options in other packages as needed. func (c *Config) Propagate() { FlushCache() log.SetLevel(c.LogLevel()) // Set thumbnail generation parameters. thumb.StandardRGB = c.ThumbSRGB() thumb.SizePrecached = c.ThumbSizePrecached() thumb.SizeUncached = c.ThumbSizeUncached() thumb.Filter = c.ThumbFilter() thumb.JpegQuality = c.JpegQuality() thumb.CachePublic = c.HttpCachePublic() // Set cache expiration defaults. ttl.Default = c.HttpCacheMaxAge() ttl.Video = c.HttpVideoMaxAge() // Set geocoding parameters. places.UserAgent = c.UserAgent() entity.GeoApi = c.GeoApi() // Set minimum password length. entity.PasswordLength = c.PasswordLength() // Set path for user assets. entity.UsersPath = c.UsersPath() // Set API preview and download default tokens. entity.PreviewToken.Set(c.PreviewToken(), entity.TokenConfig) entity.DownloadToken.Set(c.DownloadToken(), entity.TokenConfig) entity.CheckTokens = !c.Public() // Set face recognition parameters. face.ScoreThreshold = c.FaceScore() face.OverlapThreshold = c.FaceOverlap() face.ClusterScoreThreshold = c.FaceClusterScore() face.ClusterSizeThreshold = c.FaceClusterSize() face.ClusterCore = c.FaceClusterCore() face.ClusterDist = c.FaceClusterDist() face.MatchDist = c.FaceMatchDist() // Set default theme and locale. customize.DefaultTheme = c.DefaultTheme() customize.DefaultLocale = c.DefaultLocale() c.Settings().Propagate() c.Hub().Propagate() } // Init creates directories, parses additional config files, opens a database connection and initializes dependencies. func (c *Config) Init() error { start := time.Now() // Create configured directory paths. if err := c.CreateDirectories(); err != nil { return err } // Init storage directories with a random serial. if err := c.InitSerial(); err != nil { return err } // Detect case-insensitive file system. if insensitive, err := c.CaseInsensitive(); err != nil { return err } else if insensitive { log.Infof("config: case-insensitive file system detected") fs.IgnoreCase() } // Detect CPU. if cpuName := cpuid.CPU.BrandName; cpuName != "" { log.Debugf("config: running on %s, %s memory detected", clean.Log(cpuid.CPU.BrandName), humanize.Bytes(TotalMem)) } // Exit if less than 128 MB RAM was detected. if TotalMem < 128*Megabyte { return fmt.Errorf("config: %s of memory detected, %d GB required", humanize.Bytes(TotalMem), MinMem/Gigabyte) } // Show warning if less than 1 GB RAM was detected. if LowMem { log.Warnf(`config: less than %d GB of memory detected, please upgrade if server becomes unstable or unresponsive`, MinMem/Gigabyte) log.Warnf("config: tensorflow as well as indexing and conversion of RAW images have been disabled automatically") } // Show swap info. if TotalMem < RecommendedMem { log.Infof("config: make sure your server has enough swap configured to prevent restarts when there are memory usage spikes") } // Show wakeup interval warning if face recognition is enabled // and the worker runs less than once per hour. if !c.DisableFaces() && !c.Unsafe() && c.WakeupInterval() > time.Hour { log.Warnf("config: the wakeup interval is %s, but must be 1h or less for face recognition to work", c.WakeupInterval().String()) } // Set HTTPS proxy for outgoing connections. if httpsProxy := c.HttpsProxy(); httpsProxy != "" { http.DefaultTransport.(*http.Transport).TLSClientConfig = &tls.Config{ InsecureSkipVerify: c.HttpsProxyInsecure(), } _ = os.Setenv("HTTPS_PROXY", httpsProxy) } // Set HTTP user agent. places.UserAgent = c.UserAgent() c.initSettings() c.initHub() // Propagate configuration. c.Propagate() // Connect to database. if err := c.connectDb(); err != nil { return err } else if !c.Sponsor() { log.Info(MsgSponsor) log.Info(MsgSignUp) } // Show log message. log.Debugf("config: successfully initialized [%s]", time.Since(start)) return nil } // readSerial reads and returns the current storage serial. func (c *Config) readSerial() string { storageName := filepath.Join(c.StoragePath(), serialName) backupName := filepath.Join(c.BackupPath(), serialName) if fs.FileExists(storageName) { if data, err := os.ReadFile(storageName); err == nil && len(data) == 16 { return string(data) } else { log.Tracef("config: could not read %s (%s)", clean.Log(storageName), err) } } if fs.FileExists(backupName) { if data, err := os.ReadFile(backupName); err == nil && len(data) == 16 { return string(data) } else { log.Tracef("config: could not read %s (%s)", clean.Log(backupName), err) } } return "" } // InitSerial initializes storage directories with a random serial. func (c *Config) InitSerial() (err error) { if c.Serial() != "" { return nil } c.serial = rnd.GenerateUID('z') storageName := filepath.Join(c.StoragePath(), serialName) backupName := filepath.Join(c.BackupPath(), serialName) if err = os.WriteFile(storageName, []byte(c.serial), fs.ModeFile); err != nil { return fmt.Errorf("could not create %s: %s", storageName, err) } if err = os.WriteFile(backupName, []byte(c.serial), fs.ModeFile); err != nil { return fmt.Errorf("could not create %s: %s", backupName, err) } return nil } // Serial returns the random storage serial. func (c *Config) Serial() string { if c.serial == "" { c.serial = c.readSerial() } return c.serial } // SerialChecksum returns the CRC32 checksum of the storage serial. func (c *Config) SerialChecksum() string { var result []byte crc := crc32.New(crc32Castagnoli) if _, err := crc.Write([]byte(c.Serial())); err != nil { log.Warnf("config: %s", err) } return hex.EncodeToString(crc.Sum(result)) } // Name returns the app name. func (c *Config) Name() string { if c.options.Name == "" { return "PhotoPrism" } return c.options.Name } // About returns the app about string. func (c *Config) About() string { if c.options.About == "" { return "PhotoPrism®" } return c.options.About } // Edition returns the edition nane. func (c *Config) Edition() string { if c.options.Edition == "" { return "ce" } return c.options.Edition } // Version returns the application version. func (c *Config) Version() string { return c.options.Version } // VersionChecksum returns the application version checksum. func (c *Config) VersionChecksum() uint32 { return crc32.ChecksumIEEE([]byte(c.Version())) } // UserAgent returns an HTTP user agent string based on the app config and version. func (c *Config) UserAgent() string { return fmt.Sprintf("%s/%s (%s)", c.Name(), c.Version(), strings.Join(append(c.Flags(), c.Serial()), "; ")) } // Copyright returns the application copyright. func (c *Config) Copyright() string { return c.options.Copyright } // BaseUri returns the site base URI for a given resource. func (c *Config) BaseUri(res string) string { if c.SiteUrl() == "" { return res } u, err := url.Parse(c.SiteUrl()) if err != nil { return res } return strings.TrimRight(u.EscapedPath(), "/") + res } // ApiUri returns the api URI. func (c *Config) ApiUri() string { return c.BaseUri(ApiUri) } // CdnUrl returns the optional content delivery network URI without trailing slash. func (c *Config) CdnUrl(res string) string { return strings.TrimRight(c.options.CdnUrl, "/") + res } // CdnDomain returns the content delivery network domain name if specified. func (c *Config) CdnDomain() string { if c.options.CdnUrl == "" { return "" } else if u, err := url.Parse(c.options.CdnUrl); err != nil { return "" } else { return u.Hostname() } } // CdnVideo checks if videos should be streamed using the configured CDN. func (c *Config) CdnVideo() bool { if c.options.CdnUrl == "" { return false } return c.options.CdnVideo } // ContentUri returns the content delivery URI. func (c *Config) ContentUri() string { return c.CdnUrl(c.ApiUri()) } // VideoUri returns the video streaming URI. func (c *Config) VideoUri() string { if c.CdnVideo() { return c.ContentUri() } return c.ApiUri() } // StaticUri returns the static content URI. func (c *Config) StaticUri() string { return c.CdnUrl(c.BaseUri(StaticUri)) } // StaticAssetUri returns the resource URI of the static file asset. func (c *Config) StaticAssetUri(res string) string { return c.StaticUri() + "/" + res } // SiteUrl returns the public server URL (default is "http://localhost:2342/"). func (c *Config) SiteUrl() string { if c.options.SiteUrl == "" { return "http://localhost:2342/" } return strings.TrimRight(c.options.SiteUrl, "/") + "/" } // SiteHttps checks if the site URL uses HTTPS. func (c *Config) SiteHttps() bool { if c.options.SiteUrl == "" { return false } return strings.HasPrefix(c.options.SiteUrl, "https://") } // SiteDomain returns the public server domain. func (c *Config) SiteDomain() string { if u, err := url.Parse(c.SiteUrl()); err != nil { return "localhost" } else { return u.Hostname() } } // SiteAuthor returns the site author / copyright. func (c *Config) SiteAuthor() string { return c.options.SiteAuthor } // SiteTitle returns the main site title (default is application name). func (c *Config) SiteTitle() string { if c.options.SiteTitle == "" { return c.Name() } return c.options.SiteTitle } // SiteCaption returns a short site caption. func (c *Config) SiteCaption() string { return c.options.SiteCaption } // SiteDescription returns a long site description. func (c *Config) SiteDescription() string { return c.options.SiteDescription } // SitePreview returns the site preview image URL for sharing. func (c *Config) SitePreview() string { if c.options.SitePreview == "" { return fmt.Sprintf("https://i.photoprism.app/prism?cover=64&style=centered%%20dark&caption=none&title=%s", url.QueryEscape(c.AppName())) } if !strings.HasPrefix(c.options.SitePreview, "http") { return c.SiteUrl() + strings.TrimPrefix(c.options.SitePreview, "/") } return c.options.SitePreview } // LegalInfo returns the legal info text for the page footer. func (c *Config) LegalInfo() string { if s := c.CliGlobalString("imprint"); s != "" { log.Warnf("config: option 'imprint' is deprecated, please use 'legal-info'") return s } return c.options.LegalInfo } // LegalUrl returns the legal info url. func (c *Config) LegalUrl() string { if s := c.CliGlobalString("imprint-url"); s != "" { log.Warnf("config: option 'imprint-url' is deprecated, please use 'legal-url'") return s } return c.options.LegalUrl } // Prod checks if production mode is enabled, hides non-essential log messages. func (c *Config) Prod() bool { return c.options.Prod } // Debug checks if debug mode is enabled, shows non-essential log messages. func (c *Config) Debug() bool { if c.Prod() { return false } else if c.Trace() { return true } return c.options.Debug } // Trace checks if trace mode is enabled, shows all log messages. func (c *Config) Trace() bool { if c.Prod() { return false } return c.options.Trace || c.options.LogLevel == logrus.TraceLevel.String() } // Test checks if test mode is enabled. func (c *Config) Test() bool { return c.options.Test } // Demo checks if demo mode is enabled. func (c *Config) Demo() bool { return c.options.Demo } // Sponsor reports if you have chosen to support our mission. func (c *Config) Sponsor() bool { if Sponsor || c.options.Sponsor { return true } else if c.hub != nil { Sponsor = c.Hub().Sponsor() } return Sponsor } // Experimental checks if experimental features should be enabled. func (c *Config) Experimental() bool { return c.options.Experimental } // ReadOnly checks if photo directories are write protected. func (c *Config) ReadOnly() bool { return c.options.ReadOnly } // DetectNSFW checks if NSFW photos should be detected and flagged. func (c *Config) DetectNSFW() bool { return c.options.DetectNSFW } // UploadNSFW checks if NSFW photos can be uploaded. func (c *Config) UploadNSFW() bool { return c.options.UploadNSFW } // LogLevel returns the Logrus log level. func (c *Config) LogLevel() logrus.Level { // Normalize string. c.options.LogLevel = strings.ToLower(strings.TrimSpace(c.options.LogLevel)) if c.Trace() { c.options.LogLevel = logrus.TraceLevel.String() } else if c.Debug() && c.options.LogLevel != logrus.TraceLevel.String() { c.options.LogLevel = logrus.DebugLevel.String() } if logLevel, err := logrus.ParseLevel(c.options.LogLevel); err == nil { return logLevel } else { return logrus.InfoLevel } } // SetLogLevel sets the Logrus log level. func (c *Config) SetLogLevel(level logrus.Level) { log.SetLevel(level) } // Shutdown services and workers. func (c *Config) Shutdown() { mutex.CancelAll() if err := c.CloseDb(); err != nil { log.Errorf("could not close database connection: %s", err) } else { log.Debug("closed database connection") } } // Workers returns the number of workers e.g. for indexing files. func (c *Config) Workers() int { // Use one worker on systems with less than the recommended amount of memory. if TotalMem < RecommendedMem { return 1 } // NumCPU returns the number of logical CPU cores. cores := runtime.NumCPU() // Limit to physical cores to avoid high load on HT capable CPUs. if cores > cpuid.CPU.PhysicalCores { cores = cpuid.CPU.PhysicalCores } // Limit number of workers when using SQLite3 to avoid database locking issues. if c.DatabaseDriver() == SQLite3 && (cores >= 8 && c.options.Workers <= 0 || c.options.Workers > 4) { return 4 } // Return explicit value if set and not too large. if c.options.Workers > runtime.NumCPU() { return runtime.NumCPU() } else if c.options.Workers > 0 { return c.options.Workers } // Use half the available cores by default. if cores > 1 { return cores / 2 } return 1 } // WakeupInterval returns the duration between background worker runs // required for face recognition and index maintenance(1-86400s). func (c *Config) WakeupInterval() time.Duration { if c.options.WakeupInterval <= 0 { if c.Unsafe() { // Worker can be disabled only in unsafe mode. return time.Duration(0) } else { // Default to 15 minutes if no interval is set. return DefaultWakeupInterval } } // Do not run more than once per minute. if c.options.WakeupInterval < MinWakeupInterval/time.Second { return MinWakeupInterval } else if c.options.WakeupInterval < MinWakeupInterval { c.options.WakeupInterval = c.options.WakeupInterval * time.Second } // Do not run less than once per day. if c.options.WakeupInterval > MaxWakeupInterval { return MaxWakeupInterval } return c.options.WakeupInterval } // AutoIndex returns the auto index delay duration. func (c *Config) AutoIndex() time.Duration { if c.options.AutoIndex < 0 { return time.Duration(0) } else if c.options.AutoIndex == 0 || c.options.AutoIndex > 604800 { return time.Duration(DefaultAutoIndexDelay) * time.Second } return time.Duration(c.options.AutoIndex) * time.Second } // AutoImport returns the auto import delay duration. func (c *Config) AutoImport() time.Duration { if c.options.AutoImport < 0 || c.ReadOnly() { return time.Duration(0) } else if c.options.AutoImport == 0 || c.options.AutoImport > 604800 { return time.Duration(DefaultAutoImportDelay) * time.Second } return time.Duration(c.options.AutoImport) * time.Second } // GeoApi returns the preferred geocoding api (places, or none). func (c *Config) GeoApi() string { if c.options.DisablePlaces { return "" } return "places" } // OriginalsLimit returns the maximum size of originals in MB. func (c *Config) OriginalsLimit() int { if c.options.OriginalsLimit <= 0 || c.options.OriginalsLimit > 100000 { return -1 } return c.options.OriginalsLimit } // OriginalsByteLimit returns the maximum size of originals in bytes. func (c *Config) OriginalsByteLimit() int64 { if result := c.OriginalsLimit(); result <= 0 { return -1 } else { return int64(result) * 1024 * 1024 } } // ResolutionLimit returns the maximum resolution of originals in megapixels (width x height). func (c *Config) ResolutionLimit() int { result := c.options.ResolutionLimit // Disabling or increasing the limit is at your own risk. // Only sponsors receive support in case of problems. if result == 0 { return DefaultResolutionLimit } else if result < 0 { return -1 } else if result > 900 { result = 900 } return result } // UpdateHub renews backend api credentials with an optional activation code. func (c *Config) UpdateHub() { if c.hub == nil { return } if token := os.Getenv(EnvVar("CONNECT")); token != "" && !c.Hub().Sponsor() { _ = c.ResyncHub(token) } else { _ = c.ResyncHub("") } } // ResyncHub renews backend api credentials for maps and places with an optional token. func (c *Config) ResyncHub(token string) error { if c.hub == nil { return fmt.Errorf("hub is not initialized") } if err := c.hub.ReSync(token); err != nil { log.Debugf("config: %s, see https://docs.photoprism.app/getting-started/troubleshooting/firewall/", err) if token != "" { return i18n.Error(i18n.ErrAccountConnect) } } else if err = c.hub.Save(); err != nil { log.Debugf("config: %s while saving api keys for maps and places", err) } else { c.hub.Propagate() } return nil } // initHub initializes PhotoPrism hub config. func (c *Config) initHub() { if c.hub != nil { return } else if h := hub.NewConfig(c.Version(), c.HubConfigFile(), c.serial, c.env, c.UserAgent(), c.options.PartnerID); h != nil { c.hub = h } update := c.start if err := c.hub.Load(); err != nil { update = true } if update { c.UpdateHub() } c.hub.Propagate() ticker := time.NewTicker(time.Hour * 24) go func() { for { select { case <-ticker.C: c.UpdateHub() } } }() } // Hub returns the PhotoPrism hub config. func (c *Config) Hub() *hub.Config { c.initHub() return c.hub }