sftpgo/internal/dataprovider/scheduler.go

// Copyright (C) 2019 Nicola Murino
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, version 3.
//
// 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.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

package dataprovider

import (
	"fmt"
	"sync/atomic"
	"time"

	"github.com/robfig/cron/v3"

	"github.com/drakkan/sftpgo/v2/internal/logger"
	"github.com/drakkan/sftpgo/v2/internal/metric"
	"github.com/drakkan/sftpgo/v2/internal/util"
)

var (
	scheduler              *cron.Cron
	lastUserCacheUpdate    atomic.Int64
	lastIPListsCacheUpdate atomic.Int64
	// used for bolt and memory providers, so we avoid iterating all users/rules
	// to find recently modified ones
	lastUserUpdate atomic.Int64
	lastRuleUpdate atomic.Int64
)

func stopScheduler() {
	if scheduler != nil {
		scheduler.Stop()
		scheduler = nil
	}
}

func startScheduler() error {
	stopScheduler()

	scheduler = cron.New(cron.WithLocation(time.UTC), cron.WithLogger(cron.DiscardLogger))
	_, err := scheduler.AddFunc("@every 55s", checkDataprovider)
	if err != nil {
		return fmt.Errorf("unable to schedule dataprovider availability check: %w", err)
	}
	err = addScheduledCacheUpdates()
	if err != nil {
		return err
	}
	if currentNode != nil {
		_, err = scheduler.AddFunc("@every 30m", func() {
			err := provider.cleanupNodes()
			if err != nil {
				providerLog(logger.LevelError, "unable to cleanup nodes: %v", err)
			} else {
				providerLog(logger.LevelDebug, "cleanup nodes ok")
			}
		})
	}
	if err != nil {
		return fmt.Errorf("unable to schedule nodes cleanup: %w", err)
	}
	scheduler.Start()
	return nil
}

func addScheduledCacheUpdates() error {
	lastUserCacheUpdate.Store(util.GetTimeAsMsSinceEpoch(time.Now()))
	lastIPListsCacheUpdate.Store(util.GetTimeAsMsSinceEpoch(time.Now()))
	_, err := scheduler.AddFunc("@every 10m", checkCacheUpdates)
	if err != nil {
		return fmt.Errorf("unable to schedule cache updates: %w", err)
	}
	return nil
}

func checkDataprovider() {
	if currentNode != nil {
		if err := provider.updateNodeTimestamp(); err != nil {
			providerLog(logger.LevelError, "unable to update node timestamp: %v", err)
		} else {
			providerLog(logger.LevelDebug, "node timestamp updated")
		}
	}
	err := provider.checkAvailability()
	if err != nil {
		providerLog(logger.LevelError, "check availability error: %v", err)
	}
	metric.UpdateDataProviderAvailability(err)
}

func checkCacheUpdates() {
	checkUserCache()
	checkIPListEntryCache()
	cachedUserPasswords.cleanup()
	cachedAdminPasswords.cleanup()
	cachedAPIKeys.cleanup()
}

func checkUserCache() {
	lastCheck := lastUserCacheUpdate.Load()
	providerLog(logger.LevelDebug, "start user cache check, update time %v", util.GetTimeFromMsecSinceEpoch(lastCheck))
	checkTime := util.GetTimeAsMsSinceEpoch(time.Now())
	if config.IsShared == 1 {
		lastCheck -= 5000
	}
	users, err := provider.getRecentlyUpdatedUsers(lastCheck)
	if err != nil {
		providerLog(logger.LevelError, "unable to get recently updated users: %v", err)
		return
	}
	for idx := range users {
		user := users[idx]
		providerLog(logger.LevelDebug, "invalidate caches for user %q", user.Username)
		if user.DeletedAt > 0 {
			deletedAt := util.GetTimeFromMsecSinceEpoch(user.DeletedAt)
			if deletedAt.Add(30 * time.Minute).Before(time.Now()) {
				providerLog(logger.LevelDebug, "removing user %q deleted at %s", user.Username, deletedAt)
				go provider.deleteUser(user, false) //nolint:errcheck
			}
			webDAVUsersCache.remove(user.Username)
			cachedUserPasswords.Remove(user.Username)
			delayedQuotaUpdater.resetUserQuota(user.Username)
		} else {
			webDAVUsersCache.swap(&user, "")
		}
	}
	lastUserCacheUpdate.Store(checkTime)
	providerLog(logger.LevelDebug, "end user cache check, new update time %v", util.GetTimeFromMsecSinceEpoch(lastUserCacheUpdate.Load()))
}

func checkIPListEntryCache() {
	if config.IsShared != 1 {
		return
	}
	hasMemoryLists := false
	for _, l := range inMemoryLists {
		if l.isInMemory.Load() {
			hasMemoryLists = true
			break
		}
	}
	if !hasMemoryLists {
		return
	}
	providerLog(logger.LevelDebug, "start IP list cache check, update time %v", util.GetTimeFromMsecSinceEpoch(lastIPListsCacheUpdate.Load()))
	checkTime := util.GetTimeAsMsSinceEpoch(time.Now())
	entries, err := provider.getRecentlyUpdatedIPListEntries(lastIPListsCacheUpdate.Load() - 5000)
	if err != nil {
		providerLog(logger.LevelError, "unable to get recently updated IP list entries: %v", err)
		return
	}
	for idx := range entries {
		e := entries[idx]
		providerLog(logger.LevelDebug, "update cache for IP list entry %q", e.getName())
		if e.DeletedAt > 0 {
			deletedAt := util.GetTimeFromMsecSinceEpoch(e.DeletedAt)
			if deletedAt.Add(30 * time.Minute).Before(time.Now()) {
				providerLog(logger.LevelDebug, "removing IP list entry %q deleted at %s", e.getName(), deletedAt)
				go provider.deleteIPListEntry(e, false) //nolint:errcheck
			}
			for _, l := range inMemoryLists {
				l.removeEntry(&e)
			}
		} else {
			for _, l := range inMemoryLists {
				l.updateEntry(&e)
			}
		}
	}
	lastIPListsCacheUpdate.Store(checkTime)
	providerLog(logger.LevelDebug, "end IP list entries cache check, new update time %v", util.GetTimeFromMsecSinceEpoch(lastIPListsCacheUpdate.Load()))
}

func setLastUserUpdate() {
	lastUserUpdate.Store(util.GetTimeAsMsSinceEpoch(time.Now()))
}

func getLastUserUpdate() int64 {
	return lastUserUpdate.Load()
}

func setLastRuleUpdate() {
	lastRuleUpdate.Store(util.GetTimeAsMsSinceEpoch(time.Now()))
}

func getLastRuleUpdate() int64 {
	return lastRuleUpdate.Load()
}