package config import ( "encoding/hex" "fmt" "hash/crc32" "io/ioutil" "os" "path/filepath" "runtime" "strings" "sync" "time" "github.com/photoprism/photoprism/pkg/fs" "github.com/photoprism/photoprism/pkg/txt" "github.com/photoprism/photoprism/internal/entity" "github.com/jinzhu/gorm" _ "github.com/jinzhu/gorm/dialects/mysql" _ "github.com/jinzhu/gorm/dialects/sqlite" "github.com/photoprism/photoprism/internal/event" "github.com/photoprism/photoprism/internal/hub" "github.com/photoprism/photoprism/internal/hub/places" "github.com/photoprism/photoprism/internal/mutex" "github.com/photoprism/photoprism/internal/thumb" "github.com/photoprism/photoprism/pkg/rnd" "github.com/sirupsen/logrus" "github.com/urfave/cli" ) var log = event.Log var once sync.Once // Config holds database, cache and all parameters of photoprism type Config struct { once sync.Once db *gorm.DB options *Options settings *Settings hub *hub.Config token string serial string } func init() { // Init public thumb sizes for use in client apps. for i := len(thumb.DefaultTypes) - 1; i >= 0; i-- { size := thumb.DefaultTypes[i] t := thumb.Types[size] if t.Public { Thumbs = append(Thumbs, Thumb{Size: size, Use: t.Use, Width: t.Width, Height: t.Height}) } } } func initLogger(debug bool) { once.Do(func() { log.SetFormatter(&logrus.TextFormatter{ DisableColors: false, FullTimestamp: true, }) if debug { log.SetLevel(logrus.DebugLevel) } else { log.SetLevel(logrus.InfoLevel) } }) } // NewConfig initialises a new configuration file func NewConfig(ctx *cli.Context) *Config { initLogger(ctx.GlobalBool("debug")) c := &Config{ options: NewOptions(ctx), token: rnd.Token(8), } if configFile := c.ConfigFile(); c.options.ConfigFile == "" && fs.FileExists(configFile) { if err := c.options.Load(configFile); err != nil { log.Warnf("config: %s", err) } else { log.Debugf("config: options loaded from %s", txt.Quote(configFile)) } } return c } // Options returns the raw config options. func (c *Config) Options() *Options { if c.options == nil { log.Warnf("config: options should not be nil - bug?") c.options = NewOptions(nil) } return c.options } // Propagate updates config options in other packages as needed. func (c *Config) Propagate() { log.SetLevel(c.LogLevel()) thumb.Size = c.ThumbSize() thumb.SizeUncached = c.ThumbSizeUncached() thumb.Filter = c.ThumbFilter() thumb.JpegQuality = c.JpegQuality() places.UserAgent = c.UserAgent() entity.GeoApi = c.GeoApi() 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 { if err := c.CreateDirectories(); err != nil { return err } if err := c.initStorage(); err != nil { return err } if insensitive, err := c.CaseInsensitive(); err != nil { return err } else if insensitive { log.Infof("config: case-insensitive file system detected") fs.IgnoreCase() } c.initSettings() c.initHub() c.Propagate() return c.connectDb() } // initStorage initializes storage directories with a random serial. func (c *Config) initStorage() error { if c.serial != "" { return nil } const serialName = "serial" c.serial = rnd.PPID('z') storageName := filepath.Join(c.StoragePath(), serialName) backupName := filepath.Join(c.BackupPath(), serialName) if data, err := ioutil.ReadFile(storageName); err == nil { c.serial = string(data) } else if data, err := ioutil.ReadFile(backupName); err == nil { c.serial = string(data) } else if err := ioutil.WriteFile(storageName, []byte(c.serial), os.ModePerm); err != nil { return fmt.Errorf("failed creating %s: %s", storageName, err) } else if err := ioutil.WriteFile(backupName, []byte(c.serial), os.ModePerm); err != nil { return fmt.Errorf("failed creating %s: %s", backupName, err) } return nil } // Serial returns the random storage serial. func (c *Config) Serial() string { if err := c.initStorage(); err != nil { log.Errorf("config: %s", err) } return c.serial } // SerialChecksum returns the CRC32 checksum of the storage serial. func (c *Config) SerialChecksum() string { var result []byte hash := crc32.New(crc32.MakeTable(crc32.Castagnoli)) if _, err := hash.Write([]byte(c.Serial())); err != nil { log.Warnf("config: %s", err) } return hex.EncodeToString(hash.Sum(result)) } // Name returns the application name ("PhotoPrism"). func (c *Config) Name() string { return c.options.Name } // Version returns the application version. func (c *Config) Version() string { return c.options.Version } // UserAgent returns a HTTP user agent string based on app name & version. func (c *Config) UserAgent() string { return fmt.Sprintf("%s/%s", c.Name(), c.Version()) } // Copyright returns the application copyright. func (c *Config) Copyright() string { return c.options.Copyright } // 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 c.options.SiteUrl } // SitePreview returns the site preview image URL for sharing. func (c *Config) SitePreview() string { if c.options.SitePreview == "" { return c.SiteUrl() + "static/img/preview.jpg" } if !strings.HasPrefix(c.options.SitePreview, "http") { return c.SiteUrl() + c.options.SitePreview } return c.options.SitePreview } // 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 } // SiteAuthor returns the site author / copyright. func (c *Config) SiteAuthor() string { return c.options.SiteAuthor } // Debug tests if debug mode is enabled. func (c *Config) Debug() bool { return c.options.Debug } // Demo tests if demo mode is enabled. func (c *Config) Demo() bool { return c.options.Demo } // Public tests if app runs in public mode and requires no authentication. func (c *Config) Public() bool { if c.Demo() { return true } return c.options.Public } // Experimental tests if experimental features should be enabled. func (c *Config) Experimental() bool { return c.options.Experimental } // ReadOnly tests if photo directories are write protected. func (c *Config) ReadOnly() bool { return c.options.ReadOnly } // DetectNSFW tests if NSFW photos should be detected and flagged. func (c *Config) DetectNSFW() bool { return c.options.DetectNSFW } // UploadNSFW tests if NSFW photos can be uploaded. func (c *Config) UploadNSFW() bool { return c.options.UploadNSFW } // AdminPassword returns the initial admin password. func (c *Config) AdminPassword() string { return c.options.AdminPassword } // LogLevel returns the logrus log level. func (c *Config) LogLevel() logrus.Level { if c.Debug() { c.options.LogLevel = "debug" } if logLevel, err := logrus.ParseLevel(c.options.LogLevel); err == nil { return logLevel } else { return logrus.InfoLevel } } // Shutdown services and workers. func (c *Config) Shutdown() { mutex.MainWorker.Cancel() mutex.ShareWorker.Cancel() mutex.SyncWorker.Cancel() mutex.MetaWorker.Cancel() if err := c.CloseDb(); err != nil { log.Errorf("could not close database connection: %s", err) } else { log.Info("closed database connection") } } // Workers returns the number of workers e.g. for indexing files. func (c *Config) Workers() int { numCPU := runtime.NumCPU() // Limit number of workers when using SQLite to avoid database locking issues. if c.DatabaseDriver() == SQLite && numCPU > 4 && c.options.Workers <= 0 { return 4 } if c.options.Workers > 0 && c.options.Workers <= numCPU { return c.options.Workers } if numCPU > 1 { return numCPU - 1 } return 1 } // WakeupInterval returns the background worker wakeup interval duration. func (c *Config) WakeupInterval() time.Duration { if c.options.WakeupInterval <= 0 || c.options.WakeupInterval > 86400 { return 15 * time.Minute } return time.Duration(c.options.WakeupInterval) * time.Second } // AutoIndex returns the auto indexing 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 > 86400 { return c.WakeupInterval() } return time.Duration(c.options.AutoIndex) * time.Second } // AutoImport returns the auto importing 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 > 86400 { return c.AutoIndex() } return time.Duration(c.options.AutoImport) * time.Second } // GeoApi returns the preferred geo coding api (none or places). func (c *Config) GeoApi() string { if c.options.DisablePlaces { return "" } return "places" } // OriginalsLimit returns the file size limit for originals. func (c *Config) OriginalsLimit() int64 { if c.options.OriginalsLimit <= 0 || c.options.OriginalsLimit > 100000 { return -1 } // Megabyte. return c.options.OriginalsLimit * 1024 * 1024 } // UpdateHub updates backend api credentials for maps & places. func (c *Config) UpdateHub() { if err := c.hub.Refresh(); err != nil { log.Debugf("config: %s", err) } else if err := c.hub.Save(); err != nil { log.Debugf("config: %s", err) } else { c.hub.Propagate() } } // initHub initializes PhotoPrism hub config. func (c *Config) initHub() { c.hub = hub.NewConfig(c.Version(), c.HubConfigFile(), c.serial) if err := c.hub.Load(); err == nil { // Do nothing. } else if err := c.hub.Refresh(); err != nil { log.Debugf("config: %s", err) } else if err := c.hub.Save(); err != nil { log.Debugf("config: %s", err) } 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 { if c.hub == nil { c.initHub() } return c.hub }